live_record 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2a60a5fbaf627b89846d36f65ea5a685b766d3c
-  data.tar.gz: e617a00065338ef2d909b3de3e7ec16782e611e8
+  metadata.gz: fdfd93a26658fb2c904c1099d412baa3b340590a
+  data.tar.gz: 40bea540c784bb1d010b53765c7022528e9e4bb2
 SHA512:
-  metadata.gz: 4952880f039e019e7721b83e1d4b77618de2d37c5d80cf133b7c714df5d293d9a4e85120e89a0a63193d59188d2c99b3aec7a558c271dfb1919b3c0c90426cd3
-  data.tar.gz: f9550bc5a31b21c9999d5a53c63a74608eea74e0619fe696c68c127142bc28c7576b2052121ce25111cf4139dc76fa61c35904898f2eacae0720c6c7e95f7b18
+  metadata.gz: 033ea790203cfa5c9edeb48eb03af908197224c434b78f99ff2fad781ccf1af15c65ed61d146d844f20524082dcc695a239a84824baecacef619a3006c09bd98
+  data.tar.gz: 41573f26ab8d05431c6577344131105ff5c48d3b0fc4376eec2295483a11034a5a3796b8c50958295fb855e753cc6ddd3a52619a19123ec0b1ad6aeeb05074e3

data/README.md

@@ -40,7 +40,7 @@
 
   // now, we can just simply add a "create" callback, to apply our own logic whenever a new Book record is streamed from the backend
   LiveRecord.Model.all.Book.addCallback('after:create', function() {
-    // let's say you have a code here that adds this new Book on the page 
+    // let's say you have a code here that adds this new Book on the page
     // `this` refers to the Book record that has been created
     console.log(this);
   })
@@ -52,9 +52,9 @@
   // instantiate a Book object (only requirement is you pass the ID so it can be referenced when updates/destroy happen)
   var book = new LiveRecord.Model.all.Book({id: 1})
 
-  // ...or you can also initialise with other attributes 
+  // ...or you can also initialise with other attributes
   // var book = new LiveRecord.Model.all.Book({id: 1, title: 'Harry Potter', created_at: '2017-08-02T12:39:49.238Z'})
-  
+
   // then store this Book object into the JS store
   book.create();
 
@@ -114,7 +114,7 @@
 1. Add the following to your `Gemfile`:
 
     ```ruby
-    gem 'live_record', '~> 0.2.1'
+    gem 'live_record', '~> 0.2.2'
     ```
 
 2. Run:
@@ -159,7 +159,7 @@
     ### Example 1 - Simple Usage
 
     ```ruby
-    # app/models/book.rb (example 1)
+    # app/models/book.rb
     class Book < ApplicationRecord
       include LiveRecord::Model::Callbacks
       has_many :live_record_updates, as: :recordable, dependent: :destroy
@@ -175,11 +175,11 @@
     ### Example 2 - Advanced Usage
 
     ```ruby
-    # app/models/book.rb (example 1)
+    # app/models/book.rb
     class Book < ApplicationRecord
       include LiveRecord::Model::Callbacks
       has_many :live_record_updates, as: :recordable, dependent: :destroy
-      
+
       def self.live_record_whitelisted_attributes(book, current_user)
         # Notice that from above, you also have access to `book` (the record currently requested by the client to be synced),
         # and the `current_user`, the current user who is trying to sync the `book` record.
@@ -273,6 +273,9 @@
 
 8. Load the records into the JS Model-store through JSON REST (i.e.):
 
+    * Any record created/loaded in the JS-store is automatically synced whenever it is updated from the backend
+    * When reconnected after losing connection, the records in the store are synced automatically.
+
     ### Example 1 - Using Default Loader (Requires JQuery)
 
     > Your controller must also support responding with JSON in addition to HTML. If you used scaffold or controller generator, this should already work immediately.
@@ -289,13 +292,13 @@
     ```html
     <!-- app/views/books/index.html.erb -->
     <script>
-      // `loadRecords` you may also specify a URL to loadRecords (`url` defaults to `window.location.href` which is the current page) 
+      // `loadRecords` you may also specify a URL to loadRecords (`url` defaults to `window.location.href` which is the current page)
       LiveRecord.helpers.loadRecords({modelName: 'Book', url: '/some/url/that/returns_books_as_a_json'})
     </script>
     ```
 
     ```html
-    <!-- app/views/posts/index.html.erb -->
+    <!-- app/views/books/index.html.erb -->
     <script>
       // You may also pass in a callback for synchronous logic
       LiveRecord.helpers.loadRecords({
@@ -336,7 +339,7 @@
 
     ```js
     // subscribe
-    subscription = LiveRecord.Model.all.Book.subscribe();
+    var subscription = LiveRecord.Model.all.Book.subscribe();
 
     // ...or subscribe only to certain conditions (i.e. when `is_enabled` attribute value is `true`)
     // For the list of supported operators (like `..._eq`), see JS API `MODEL.subscribe(CONFIG)` below
@@ -344,24 +347,24 @@
 
     // now, we can just simply add a "create" callback, to apply our own logic whenever a new Book record is streamed from the backend
     LiveRecord.Model.all.Book.addCallback('after:create', function() {
-      // let's say you have a code here that adds this new Book on the page 
+      // let's say you have a code here that adds this new Book on the page
       // `this` refers to the Book record that has been created
       console.log(this);
     })
 
     // you may also add callbacks specific to this `subscription`, as you may want to have multiple subscriptions. Then, see JS API `MODEL.subscribe(CONFIG)` below for information
 
-    // then unsubscribe, as you wish
+    // you may also want to unsubscribe as you wish
     LiveRecord.Model.all.Book.unsubscribe(subscription);
     ```
 
     ### Ransack Search Queries (Optional)
-  
+
       * If you need more complex queries to pass into the `.subscribe(where: { ... })` above, [ransack](https://github.com/activerecord-hackery/ransack) gem is supported.
       * For example you can then do:
         ```js
         // querying upon the `belongs_to :user`
-        subscription = LiveRecord.Model.all.Book.subscribe({where: {user_is_admin_eq: true, is_enabled: true}});
+        subscription = LiveRecord.Model.all.Book.subscribe({where: {user_is_admin_eq: true, is_enabled_eq: true}});
 
         // or querying "OR" conditions
         subscription = LiveRecord.Model.all.Book.subscribe({where: {title_eq: 'I am Batman', content_eq: 'I am Batman', m: 'or'}});
@@ -392,9 +395,9 @@
       end
       ```
 
-    ### Reconnection Streaming (when client got disconnected)
+    ### Reconnection Streaming For New Records (when client got disconnected)
 
-    * Only requirement is that you should have a `created_at` attribute on your Models, which by default should already be there. However, to speed up queries, I highly suggest to add index on `created_at` with the following
+    * To be able to stream newly created records upon reconnection, the only requirement is that you should have a `created_at` attribute on your Models, which by default should already be there. However, to speed up queries, I highly suggest to add index on `created_at` with the following
 
     ```bash
     # this will create a file under db/migrate folder, then edit that file (see the ruby code below)
@@ -476,7 +479,7 @@
       * `before:create`: (function Object)
       * `after:create`: (function Object)
   * subscribes to the `LiveRecord::PublicationsChannel`, which then automatically receives new records from the backend.
-  * you can also pass in `callbacks` (see above). These callbacks is only applicable to this subscription, and is independent of the Model and Instance callbacks.
+  * you can also pass in `callbacks` (see above). These callbacks are only applicable to this subscription, and is independent of the Model and Instance callbacks.
   * `ATTRIBUTENAME_OPERATOR` means something like (for example): `is_enabled_eq`, where `is_enabled` is the `ATTRIBUTENAME` and `eq` is the `OPERATOR`.
     * you can have as many `ATTRIBUTENAME_OPERATOR` as you like, but keep in mind that the logic applied to them is "AND", and not "OR". For "OR" conditions, use `ransack`
 
@@ -569,6 +572,10 @@
 * MIT
 
 ## Changelog
-* 0.2
+* 0.2.2
+  * minor fix: "new records" subscription: `.modelName` was not being referenced properly, but should have not affected any functionalities.
+* 0.2.1
+  * you can now access what attributes have changed; see [`MODEL.changes`](#modelinstancechanges) above.
+* 0.2.0
   * Ability to subscribe to new records (supports lost connection auto-restreaming)
-    * See [9th step of Setup above](#setup)
+    * See [9th step of Setup above](#setup)

data/app/assets/javascripts/live_record/model/create.coffee

@@ -14,7 +14,7 @@ LiveRecord.Model.create = (config) ->
     this
 
   Model.modelName = config.modelName
-  
+
   Model.all = {}
 
   Model.subscriptions = []
@@ -61,7 +61,7 @@ LiveRecord.Model.create = (config) ->
     )
 
     subscription.liveRecord = {}
-    subscription.liveRecord.modelName = config.modelName
+    subscription.liveRecord.modelName = Model.modelName
     subscription.liveRecord.where = config.where
     subscription.liveRecord.callbacks = config.callbacks
 
@@ -206,7 +206,7 @@ LiveRecord.Model.create = (config) ->
     'before:destroy': [],
     'after:destroy': []
   }
-  
+
   Model.prototype._callbacks = {
     'on:connect': [],
     'on:disconnect': [],
@@ -268,4 +268,4 @@ LiveRecord.Model.create = (config) ->
   # add new Model to collection
   LiveRecord.Model.all[config.modelName] = Model
 
-  Model
+  Model

data/lib/live_record/version.rb

@@ -1,3 +1,3 @@
 module LiveRecord
-  VERSION = '0.2.1'.freeze
-end
+  VERSION = '0.2.2'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: live_record
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Jules Roman B. Polidario
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails