live_record 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e46da08f168efb9e1ebfb51f075548aaaa42cd
-  data.tar.gz: fbb81c2b262d59fa5b05e7a8b1a84bb20962538f
+  metadata.gz: e2a60a5fbaf627b89846d36f65ea5a685b766d3c
+  data.tar.gz: e617a00065338ef2d909b3de3e7ec16782e611e8
 SHA512:
-  metadata.gz: 2c3a0ffcac47a14e301671222403391380ece8577cf2a62ec1477b604155a31fb660b5fcc2e3106ebf2e94245c77e38b32aaf83d7c5e0d24ca1617fdd19370e3
-  data.tar.gz: 95949617075641208bbf35ace36222c43f4d11bb415110ea1da45ef05281191b28dc80e4136dadf9ff71f6f4f4836ae14b102403ae2e53973e49fbdae5992338
+  metadata.gz: 4952880f039e019e7721b83e1d4b77618de2d37c5d80cf133b7c714df5d293d9a4e85120e89a0a63193d59188d2c99b3aec7a558c271dfb1919b3c0c90426cd3
+  data.tar.gz: f9550bc5a31b21c9999d5a53c63a74608eea74e0619fe696c68c127142bc28c7576b2052121ce25111cf4139dc76fa61c35904898f2eacae0720c6c7e95f7b18

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/jrpolidario/live_record.svg?branch=master)](https://travis-ci.org/jrpolidario/live_record)
+[![Gem Version](https://badge.fury.io/rb/live_record.svg)](https://badge.fury.io/rb/live_record)
 
 ## About
 
@@ -25,7 +26,7 @@
 
 * say we have a `Book` model which has the following attributes:
   * `title:string`
-  * `author:text`
+  * `author:string`
   * `is_enabled:boolean`
 * on the JS client-side:
 
@@ -60,27 +61,27 @@
   // the store is accessible through
   LiveRecord.Model.all.Book.all;
 
-  // all records in the JS store are automatically subscribed to the backend LiveRecordChannel, which meant syncing (update / destroy) changes from the backend
-
-  // because the `book` above is already created in the store, you'll notice that it should automatically sync itself including all other possible whitelisted attributes
-  console.log(book.attributes);
-  // at this point then, console.log above will show the following on your browser console:
-  // {id: 1, title: 'Harry Potter', author: 'J.K. Rowling', is_enabled: true, created_at: '2017-08-02T12:39:49.238Z', updated_at: '2017-08-02T12:39:49.238Z'}
+  // all records in the JS store are automatically subscribed to the backend LiveRecord::ChangesChannel, which meant syncing (update / destroy) changes from the backend
 
   // All attributes automatically updates itself so you'll be sure that the following line (for example) is always up-to-date
   console.log(book.updated_at())
 
   // you can also add a callback that will be invoked whenever the Book object has been updated (see all supported callbacks further below)
+  // i.e. you might want to update DOM elements when the attributes have changed
   book.addCallback('after:update', function() {
-    // let's say you update the DOM elements here when the attributes have changed
     // `this` refers to the Book record that has been updated
-    console.log(this);
+
+    console.log(this.attributes);
+    // this book record should have been updated with all other possible whitelisted attributes even if you just initally passed in only the ID; thus console.log above would output below
+    // {id: 1, title: 'Harry Potter', author: 'J.K. Rowling', is_enabled: true, created_at: '2017-08-02T12:39:49.238Z', updated_at: '2017-08-02T12:39:49.238Z'}
+
+    console.log(this.changes)
+    // from above, you can also access what has changed, and would have an example output below
+    // {title: ['Harry Potter', 'New Title'], updated_at: ['2017-08-02T12:39:49.238Z', 2017-08-02T13:00:00.047Z]}
   });
 
   // or you can add a Model-wide callback that will be invoked whenever ANY Book object has been updated
   LiveRecord.Model.all.Book.addCallback('after:update', function() {
-    // let's say you update the DOM elements here when the attributes have changed
-    // `this` refers to the Book record that has been updated
     console.log(this);
   })
   ```
@@ -91,6 +92,7 @@
   # 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)
       # Add attributes to this array that you would like `current_user` to have access to when syncing this particular `book`
@@ -112,7 +114,7 @@
 1. Add the following to your `Gemfile`:
 
     ```ruby
-    gem 'live_record', '~> 0.2.0'
+    gem 'live_record', '~> 0.2.1'
     ```
 
 2. Run:
@@ -160,6 +162,7 @@
     # app/models/book.rb (example 1)
     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)
         # Add attributes to this array that you would like current_user to have access to when syncing.
@@ -175,6 +178,7 @@
     # app/models/book.rb (example 1)
     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),
@@ -369,7 +373,7 @@
       # app/models/book.rb
       class Book < ApplicationRecord
         include LiveRecord::Model::Callbacks
-        has_many :live_record_updates, as: :recordable
+        has_many :live_record_updates, as: :recordable, dependent: :destroy
 
         def self.live_record_whitelisted_attributes(book, current_user)
           [:title, :is_enabled]
@@ -438,6 +442,9 @@
 
 ## JS API
 
+### `LiveRecord.Model.all`
+  * Object of which properties are the models
+
 ### `LiveRecord.Model.create(CONFIG)`
   * `CONFIG` (Object)
     * `modelName`: (String, Required)
@@ -456,7 +463,10 @@
   * creates a `MODEL` and stores it into `LiveRecord.Model.all` array
   * returns the newly created `MODEL`
 
-### `MODEL`.subscribe(CONFIG)
+### `MODEL.all`
+  * Object of which properties are IDs of the records
+
+### `MODEL.subscribe(CONFIG)`
   * `CONFIG` (Object, Optional)
     * `where`: (Object)
       * `ATTRIBUTENAME_OPERATOR`: (Any Type)
@@ -465,7 +475,7 @@
       * `on:disconnect`: (function Object)
       * `before:create`: (function Object)
       * `after:create`: (function Object)
-  * subscribes to the `PublicationsChannel`, which then automatically receives new records from the backend.
+  * 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.
   * `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`
@@ -483,8 +493,8 @@
     * `in` in Array; i.e. `id_in: [2, 56, 19, 68]`
     * `not_in` in Array; i.e. `id_not_in: [2, 56, 19, 68]`
 
-### `MODEL`.unsubscribe(SUBSCRIPTION)
-  * unsubscribes to the `PublicationsChannel`, thereby will not be receiving new records anymore.
+### `MODEL.unsubscribe(SUBSCRIPTION)`
+  * unsubscribes to the `LiveRecord::PublicationsChannel`, thereby will not be receiving new records anymore.
 
 ### `new LiveRecord.Model.all.MODELNAME(ATTRIBUTES)`
   * `ATTRIBUTES` (Object)
@@ -500,11 +510,11 @@
   * returns the attribute value of corresponding to `ATTRIBUTENAME`. (i.e. `bookInstance.id()`, `bookInstance.created_at()`)
 
 ### `MODELINSTANCE.subscribe()`
-  * subscribes to the `LiveRecordChannel`. This instance should already be subscribed by default after being stored, unless there is a `on:response_error` or manually `unsubscribed()` which then you should manually call this `subscribe()` function after correctly handling the response error, or whenever desired.
+  * subscribes to the `LiveRecord::ChangesChannel`. This instance should already be subscribed by default after being stored, unless there is a `on:response_error` or manually `unsubscribed()` which then you should manually call this `subscribe()` function after correctly handling the response error, or whenever desired.
   * returns the `subscription` object (the ActionCable subscription object itself)
 
 ### `MODELINSTANCE.unsubscribe()`
-  * unsubscribes to the `LiveRecordChannel`, thereby will not be receiving changes (updates/destroy) anymore.
+  * unsubscribes to the `LiveRecord::ChangesChannel`, thereby will not be receiving changes (updates/destroy) anymore.
 
 ### `MODELINSTANCE.isSubscribed()`
   * returns `true` or `false` accordingly if the instance is subscribed
@@ -513,7 +523,7 @@
   * the `subscription` object (the ActionCable subscription object itself)
 
 ### `MODELINSTANCE.create()`
-  * stores the instance to the store, and then `subscribe()` to the `LiveRecordChannel` for syncing
+  * stores the instance to the store, and then `subscribe()` to the `LiveRecord::ChangesChannel` for syncing
   * returns the instance
 
 ### `MODELINSTANCE.update(ATTRIBUTES)`
@@ -525,6 +535,11 @@
   * removes the instance from the store, and then `unsubscribe()`
   * returns the instance
 
+### `MODELINSTANCE.changes`
+  * you can **ONLY** access this inside the function callback for `before:update` and `after:update`, and is automatically cleared after
+  * returns an object having the same format as [Rails's own `changes`](https://apidock.com/rails/ActiveModel/Dirty/changes)
+  * i.e. `{title: ['Harry Potter', 'New Title'], updated_at: ['2017-08-02T12:39:49.238Z', 2017-08-02T13:00:00.047Z]}`
+
 ### `MODELINSTANCE.addCallback(CALLBACKKEY, CALLBACKFUNCTION)`
   * `CALLBACKKEY` (String) see supported callbacks above
   * `CALLBACKFUNCTION` (function Object)
@@ -537,7 +552,7 @@
 
 ## FAQ
 * How to remove the view templates being overriden by LiveRecord when generating a controller or scaffold?
-  * amongst other things, `rails generate live_record:install` will override the default scaffold view templates: **show.html.erb** and **index.html.erb**; to revert back, just simply delete the following files (though you'll need to manually update or regenerate the view files that were already generated prior to deleting to the following files):
+  * amongst other things, `rails generate live_record:install` will override the default scaffold view templates: **show.html.erb** and **index.html.erb**; to revert back, just simply delete the following files (though you'll need to manually update or regenerate the view files that were already generated prior to deleting the following files):
     * **lib/templates/erb/scaffold/index.html.erb**
     * **lib/templates/erb/scaffold/show.html.erb**
 

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

@@ -14,8 +14,6 @@ LiveRecord.Model.create = (config) ->
     this
 
   Model.modelName = config.modelName
-
-  Model.store = {}
   
   Model.all = {}
 
@@ -120,7 +118,9 @@ LiveRecord.Model.create = (config) ->
       # handler for received() callback above
       onAction:
         update: (data) ->
+          @record()._setChangesFrom(data.attributes)
           @record().update(data.attributes)
+          @record()._unsetChanges()
 
         destroy: (data) ->
           @record().destroy()
@@ -242,6 +242,16 @@ LiveRecord.Model.create = (config) ->
     for callback in this._callbacks[callbackKey]
       callback.apply(this, args)
 
+  Model.prototype._setChangesFrom = (attributes) ->
+    this.changes = {}
+
+    for attributeName, attributeValue of attributes
+      unless this.attributes[attributeName] && this.attributes[attributeName] == attributeValue
+        this.changes[attributeName] = [this.attributes[attributeName], attributeValue]
+
+  Model.prototype._unsetChanges = () ->
+    delete this['changes']
+
   # AFTER MODEL INITIALISATION
 
   # add callbacks from arguments

data/lib/live_record/version.rb

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

data/spec/features/live_record_syncing_spec.rb

@@ -122,7 +122,7 @@ RSpec.feature 'LiveRecord Syncing', type: :feature do
       Thread.new do
         sleep(2)
 
-        # temporarily stop all current publication_channel connections
+        # temporarily stop all current changes_channel connections
         ObjectSpace.each_object(LiveRecord::ChangesChannel) do |changes_channel|
           changes_channel.connection.close
         end

metadata

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