live_record 0.3.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 509801a74ef9c87f3520ed9312e6cf8cb8c6861f4c250dc2075e7ba8822882c2
-  data.tar.gz: 220bc5c24e415c54c215b94b983b41bb7ced614090d82d89d347c4544c52ea95
+  metadata.gz: d893afc1c4b65f1decccc6176b8f6e9e5818a2b2e7ac21c5f2b903e6672e0f66
+  data.tar.gz: 4d52d78b3675ce187cfce06daff4cf22e0240508f66f84f808c30be0dbd17e8d
 SHA512:
-  metadata.gz: 949adea6b2fecd574a8fa9c69a4168f87c2231d3e4cf5b3e4920c6d19c155533d320b8bc0393fd93ca4eb2e8354a472c623f948eb199a836cacca041c7cdd4a0
-  data.tar.gz: 4822d238761d68875d963456ff7c11248368f9a91dfd40ea3f7f98e7d677104a7bc53166af8fcb05b0938bfebdd5f3d152329e44b9252d1e961ba2dc4530a6d4
+  metadata.gz: ced22fae06d98ca59e4912db8b462998a26ac43708c6da7a8ef0c8fdd8efaed31fd0ac3597e39377ced20fda8a2afff7d2825d1849900b340938ed2ad2a1d8bc
+  data.tar.gz: 70f8f687b78ef517e488f7a534caee2a6b83e29fd6e6f3f5d6a35b33d62b1a5f6dd0bce6bb3ab45c22a46bcc19c41354badea4c3506a9b75e0ec43b344ca8912

data/README.md

@@ -157,7 +157,7 @@
 1. Add the following to your `Gemfile`:
 
     ```ruby
-    gem 'live_record', '~> 0.3.6'
+    gem 'live_record', '~> 1.0.0'
     ```
 
 2. Run:
@@ -491,6 +491,24 @@
       LiveRecord.Model.all.Book.unsubscribe(subscription);
       ```
 
+## Setup (if as standalone Node JS module)
+
+```bash
+# bash
+npm install @jrpolidario/live_record --save
+```
+
+```js
+// js
+import { ActionCable } from 'actioncable'
+import { LiveRecord } from '@jrpolidario/live_record'
+
+const cable = ActionCable.createConsumer('wss://RAILS-API-PATH.com/cable')
+LiveRecord.init(cable)
+// LiveRecord.Model.create(...)
+// LiveRecord.Model.create(...)
+```
+
 ### Ransack Search Queries (Optional)
 
   * If you need more complex queries to pass into the `.subscribe(where: { ... })` or `.autoload({where: {...}})` above, [ransack](https://github.com/activerecord-hackery/ransack) gem is supported.
@@ -602,6 +620,9 @@ end
 
 ## JS API
 
+### `LiveRecord.init(CABLE)`
+  * `CABLE` (ActionCable consumer Object, Required)
+
 ### `LiveRecord.Model.all`
   * Object of which properties are the models
 
@@ -783,8 +804,8 @@ end
 * see [developer_guide.md](developer_guide.md)
 
 ## Changelog
-* 0.3.6
-  * set up as a Node module
+* 1.0.0
+  * extracted as a Node module (JS code is now modularised, and now requires a major version increment; thus 1.0.0)
 * 0.3.4
   * now supports Rails `~> 5.2` after being tested to work
   * update dependency to Rails (and other dev gems) to use semantic versioning: `~> 5.0`, instead of `>= 5.0, < 5.3`

data/app/assets/javascripts/live_record/init.coffee

@@ -0,0 +1,5 @@
+#= require_self
+
+# cable is an ActionCable consumer
+this.LiveRecord.init ||= (cable) ->
+  this.cable = cable

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

@@ -79,7 +79,7 @@ this.LiveRecord.Model.create = (config) ->
     if config.callbacks.afterReload && !config.reload
       throw new Error('`afterReload` callback only works with `reload: true`')
 
-    subscription = App.cable.subscriptions.create(
+    subscription = LiveRecord.cable.subscriptions.create(
       {
         channel: 'LiveRecord::AutoloadsChannel'
         model_name: Model.modelName
@@ -162,7 +162,7 @@ this.LiveRecord.Model.create = (config) ->
     if config.callbacks.afterReload && !config.reload
       throw new Error('`afterReload` callback only works with `reload: true`')
 
-    subscription = App.cable.subscriptions.create(
+    subscription = LiveRecord.cable.subscriptions.create(
       {
         channel: 'LiveRecord::PublicationsChannel'
         model_name: Model.modelName
@@ -230,7 +230,7 @@ this.LiveRecord.Model.create = (config) ->
     index = @subscriptions.indexOf(subscription)
     throw new Error('`subscription` argument does not exist in ' + @modelName + ' subscriptions list') if index == -1
 
-    App.cable.subscriptions.remove(subscription)
+    LiveRecord.cable.subscriptions.remove(subscription)
 
     @subscriptions.splice(index, 1)
     subscription
@@ -246,7 +246,7 @@ this.LiveRecord.Model.create = (config) ->
     config.reload ||= false
 
     # listen for record changes (update / destroy)
-    subscription = App['live_record_' + @modelName() + '_' + @id()] = App.cable.subscriptions.create(
+    subscription = App['live_record_' + @modelName() + '_' + @id()] = LiveRecord.cable.subscriptions.create(
       {
         channel: 'LiveRecord::ChangesChannel'
         model_name: @modelName()
@@ -323,7 +323,7 @@ this.LiveRecord.Model.create = (config) ->
 
   Model.prototype.unsubscribe = ->
     return if @subscription == undefined
-    App.cable.subscriptions.remove(@subscription)
+    LiveRecord.cable.subscriptions.remove(@subscription)
     delete this['subscription']
 
   Model.prototype.isSubscribed = ->

data/lib/assets/compiled/live_record.js

@@ -79,6 +79,14 @@
     }
   };
 
+}).call(this);
+(function() {
+  var base;
+
+  (base = this.LiveRecord).init || (base.init = function(cable) {
+    return this.cable = cable;
+  });
+
 }).call(this);
 (function() {
   var base;
@@ -182,7 +190,7 @@
       if (config.callbacks.afterReload && !config.reload) {
         throw new Error('`afterReload` callback only works with `reload: true`');
       }
-      subscription = App.cable.subscriptions.create({
+      subscription = LiveRecord.cable.subscriptions.create({
         channel: 'LiveRecord::AutoloadsChannel',
         model_name: Model.modelName,
         where: config.where
@@ -279,7 +287,7 @@
       if (config.callbacks.afterReload && !config.reload) {
         throw new Error('`afterReload` callback only works with `reload: true`');
       }
-      subscription = App.cable.subscriptions.create({
+      subscription = LiveRecord.cable.subscriptions.create({
         channel: 'LiveRecord::PublicationsChannel',
         model_name: Model.modelName,
         where: config.where
@@ -362,7 +370,7 @@
       if (index === -1) {
         throw new Error('`subscription` argument does not exist in ' + this.modelName + ' subscriptions list');
       }
-      App.cable.subscriptions.remove(subscription);
+      LiveRecord.cable.subscriptions.remove(subscription);
       this.subscriptions.splice(index, 1);
       return subscription;
     };
@@ -383,7 +391,7 @@
         return this.subscription;
       }
       config.reload || (config.reload = false);
-      subscription = App['live_record_' + this.modelName() + '_' + this.id()] = App.cable.subscriptions.create({
+      subscription = App['live_record_' + this.modelName() + '_' + this.id()] = LiveRecord.cable.subscriptions.create({
         channel: 'LiveRecord::ChangesChannel',
         model_name: this.modelName(),
         record_id: this.id()
@@ -463,7 +471,7 @@
       if (this.subscription === void 0) {
         return;
       }
-      App.cable.subscriptions.remove(this.subscription);
+      LiveRecord.cable.subscriptions.remove(this.subscription);
       return delete this['subscription'];
     };
     Model.prototype.isSubscribed = function() {

data/lib/live_record/generators/install_generator.rb

@@ -49,6 +49,12 @@ module LiveRecord
         end
       end
 
+      def update_cable_javascript
+        in_root do
+          insert_into_file 'app/assets/javascripts/cable.js', "\n  LiveRecord.init(App.cable);", after: "App.cable = ActionCable.createConsumer();"
+        end
+      end
+
       private
 
       def self.next_migration_number(dir)
@@ -68,4 +74,4 @@ module LiveRecord
       end
     end
   end
-end
+end

data/lib/live_record/version.rb

@@ -1,3 +1,3 @@
 module LiveRecord
-  VERSION = '0.3.6'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrpolidario/live_record",
-  "version": "0.3.6",
+  "version": "1.0.0",
   "description": "Auto-syncs records in client-side JS (through a Model DSL) from changes (updates/destroy) in the backend Rails server through ActionCable.\\n Also supports streaming newly created records to client-side JS.\\n Supports lost connection restreaming for both new records (create), and record-changes (updates/destroy).\\n Auto-updates DOM elements mapped to a record attribute, from changes (updates/destroy).",
   "main": "lib/assets/compiled/live_record.js",
   "repository": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_record
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Jules Roman B. Polidario
@@ -302,7 +302,6 @@ extra_rdoc_files: []
 files:
 - ".blade.yml"
 - ".gitignore"
-- ".npmignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -313,6 +312,7 @@ files:
 - app/assets/javascripts/live_record/helpers/case_converter.coffee
 - app/assets/javascripts/live_record/helpers/load_records.coffee
 - app/assets/javascripts/live_record/helpers/spaceship.coffee
+- app/assets/javascripts/live_record/init.coffee
 - app/assets/javascripts/live_record/model.coffee
 - app/assets/javascripts/live_record/model/all.coffee
 - app/assets/javascripts/live_record/model/create.coffee