model_updates 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2ffdae24565d3467a89c6be21d9c64ac0735957
-  data.tar.gz: 28861eb35b9775b6792ceb67f5321bca1abddd66
+  metadata.gz: 05326da852e8df75c3e5334f89cabc3f38177947
+  data.tar.gz: 063a04512f41a1f72cde419c73f3584914fb562e
 SHA512:
-  metadata.gz: c20c840d43c7c0fcc4758e1d85197dd2f891db26f8bc5387dad0c750713e07a10f27255b864f4344c57a702f4f6c430fa5174d02c1df2c24abedff0bc3e71420
-  data.tar.gz: 22183590cfd0b5443e715d1d7e7f6ded411e2f7ec05df1f2b4f8bd41ad230762794c7f92b2e5898489e08ca8a4ef9ecd6eb3d4edd4eec07e98ddfa92b84b5528
+  metadata.gz: '093382959d411617d46eec433757d6e2657c36be156f4dbf999f73810a08a6d0ba7bab3fc5b97a74045c5e5995eda1ec7551bda6349f2dc31a03852e5021c29a'
+  data.tar.gz: 8a00157e300e125093f08fa5b4487a2f3af50f979e2a527c1b5e795e5ee5b49ab9d4b68731013b98a5ba4668629af858dd5ca1506c130b2c4aecbfac5c66e68e

data/README.md

@@ -20,9 +20,6 @@ Or install it yourself as:
 $ gem install model_updates
 ```
 
-
-## Usage
-
 Include it in your JavaScript:
 
 ```javascript
@@ -45,7 +42,18 @@ class Model < ApplicationRecord
 end
 ```
 
-Do like this in your views if you are using HAML:
+If you also want creates broadcasted:
+```ruby
+class Model < ApplicationRecord
+  model_updates_broadcast_attributes attributes: [:updated_at]
+  model_updates_broadcast_created
+end
+```
+
+## Usage
+
+
+Do like this in your views if you are using HAML to receive automatic updates:
 
 ```haml
 .model-updates{data: {model_updates: model.model_updates_data_attrs(:updated_at)}}
@@ -93,6 +101,14 @@ data = {
 }
 ```
 
+You can receive create callbacks like this:
+
+```js
+ModelUpdates.Create.connect({model: "MyModel", onCreated: function(data) {
+  console.log("New MyModel was created with ID: " + data.id)
+})
+```
+
 ## Contributing
 
 Contribution directions go here.

data/app/assets/javascripts/model_updates.js

@@ -1,2 +1,5 @@
+//= require model_updates/model_updates_class
 //= require model_updates/activate_elements
+//= require model_updates/create
 //= require model_updates/formatters
+//= require model_updates/update

data/app/assets/javascripts/model_updates/activate_elements.js

@@ -15,41 +15,10 @@ $(document).ready(function() {
   // Subscribe to the found models
   for(var model_type in model_subscriptions) {
     for(var model_id in model_subscriptions[model_type]) {
-      console.log("Subscribing " + model_type + "(" + model_id + ")")
-
-      App.cable.subscriptions.create(
-        {channel: "ModelUpdates::ModelChannel", id: model_id, model: model_type},
-        {
-          received: function(json) {
-            console.log("Update from: " + json.model + "(" + json.id + ")")
-
-            for(key in json.changes) {
-              elements = $(".model-updates[data-model-updates-model='" + json.model + "'][data-model-updates-id='" + json.id + "'][data-model-updates-key='" + key + "']")
-              elements.each(function() {
-                element = $(this)
-
-                if (element.data("model-updates-callback")) {
-                  function_to_call = element.data("model-updates-callback")
-
-                  window[function_to_call]({
-                    changes: json.changes,
-                    element: element,
-                    id: json.id,
-                    key: key,
-                    model: json.model,
-                    value: json.changes[key]
-                  })
-                } else if(json.changes[key]) {
-                  element.text(json.changes[key])
-                } else {
-                  // Needs to check if it has a value, else it will print out "null" instead of nothing.
-                  element.text("")
-                }
-              })
-            }
-          }
-        }
-      )
+      ModelUpdates.Update.connect({
+        "id": model_id,
+        "model": model_type
+      })
     }
   }
 })

data/app/assets/javascripts/model_updates/create.es6

@@ -0,0 +1,12 @@
+ModelUpdates.Create = class Create {
+  static connect(args) {
+    App.cable.subscriptions.create(
+      {channel: "ModelUpdates::CreateChannel", model: args.model},
+      {
+        received: function(json) {
+          args.onCreated(json)
+        }
+      }
+    )
+  }
+}

data/app/assets/javascripts/model_updates/formatters.js

@@ -1,3 +1,8 @@
 function model_updates_date_time_formatter(data) {
-  element.text(moment(data.value).format("LLLL"))
+  if (data.value) {
+    newValue = moment(data.value).format("LLLL")
+    data.element.text(newValue)
+  } else {
+    data.element.text("")
+  }
 }

data/app/assets/javascripts/model_updates/model_updates_class.es6

@@ -0,0 +1,11 @@
+class ModelUpdates {
+  static debug(message) {
+    if (ModelUpdates.configuration.debug) {
+      console.log(message)
+    }
+  }
+}
+
+ModelUpdates.configuration = {
+  "debug": false
+}

data/app/assets/javascripts/model_updates/update.es6

@@ -0,0 +1,39 @@
+ModelUpdates.Update = class Update {
+  static connect(args) {
+    ModelUpdates.debug("ModelUpdates: Connecting to " + args.model + "(" + args.id + ")")
+
+    App.cable.subscriptions.create(
+      {channel: "ModelUpdates::UpdateChannel", id: args.id, model: args.model},
+      {
+        received: function(json) {
+          ModelUpdates.debug("ModelUpdates: Received update for " + json.model + "(" + json.id + ")")
+
+          for(var key in json.changes) {
+            var elements = $(".model-updates[data-model-updates-model='" + json.model + "'][data-model-updates-id='" + json.id + "'][data-model-updates-key='" + key + "']")
+            elements.each(function() {
+              var element = $(this)
+
+              if (element.data("model-updates-callback")) {
+                var function_to_call = element.data("model-updates-callback")
+
+                window[function_to_call]({
+                  changes: json.changes,
+                  element: element,
+                  id: json.id,
+                  key: key,
+                  model: json.model,
+                  value: json.changes[key]
+                })
+              } else if(json.changes[key]) {
+                element.text(json.changes[key])
+              } else {
+                // Needs to check if it has a value, else it will print out "null" instead of nothing.
+                element.text("")
+              }
+            })
+          }
+        }
+      }
+    )
+  }
+}

data/app/channels/model_updates/create_channel.rb

@@ -0,0 +1,12 @@
+class ModelUpdates::CreateChannel < ApplicationCable::Channel
+  def subscribed
+    model_class = params[:model].safe_constantize
+    channel_name = "ModelUpdatesCreate#{params[:model]}"
+
+    stream_from(channel_name, coder: ActiveSupport::JSON) do |data|
+      model = model_class.accessible_by(current_ability).find(data.fetch("id"))
+      next unless model
+      transmit data
+    end
+  end
+end

data/app/channels/model_updates/update_channel.rb

@@ -0,0 +1,7 @@
+class ModelUpdates::UpdateChannel < ApplicationCable::Channel
+  def subscribed
+    model = params[:model].safe_constantize.find(params[:id])
+    authorize! :read, model
+    stream_for model
+  end
+end

data/lib/model_updates.rb

@@ -1,4 +1,5 @@
 require "model_updates/engine"
+require "sprockets/es6"
 
 module ModelUpdates
   path = "#{File.dirname(__FILE__)}/model_updates"

data/lib/model_updates/model_extensions.rb

@@ -4,7 +4,13 @@ module ModelUpdates::ModelExtensions
   end
 
   module ClassMethods
+    def model_updates_data
+      @_model_updates ||= {}
+    end
+
     def model_updates_broadcast_attributes(args)
+      model_updates_data[:attributes] = args.fetch(:attributes)
+
       after_save do
         changes = {}
 
@@ -15,12 +21,12 @@ module ModelUpdates::ModelExtensions
             method_changed = "#{attribute_name}_changed?"
           end
 
-          next unless __send__(method_changed)
+          next if respond_to?(method_changed) && !__send__(method_changed)
           changes[attribute_name] = __send__(attribute_name)
         end
 
         if changes.any?
-          ModelUpdates::ModelChannel.broadcast_to(
+          ModelUpdates::UpdateChannel.broadcast_to(
             self,
             id: id,
             model: self.class.name,
@@ -29,6 +35,23 @@ module ModelUpdates::ModelExtensions
         end
       end
     end
+
+    def model_updates_broadcast_created
+      after_commit on: :create do |model|
+        channel_name = "ModelUpdatesCreate#{model.class.name}"
+
+        attributes = {}
+        self.class.model_updates_data[:attributes].each do |attribute_name|
+          attributes[attribute_name] = __send__(attribute_name)
+        end
+
+        ActionCable.server.broadcast(
+          channel_name,
+          id: id,
+          attributes: attributes
+        )
+      end
+    end
   end
 
   def model_updates_attrs(key, more = {})

data/lib/model_updates/version.rb

@@ -1,3 +1,3 @@
 module ModelUpdates
-  VERSION = "0.0.5".freeze
+  VERSION = "0.0.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_updates
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-es6
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 description: Rails gem to push updates to models into the frontend through ActionCable
 email:
 - kaspernj@gmail.com
@@ -37,9 +51,13 @@ files:
 - app/assets/config/model_updates_manifest.js
 - app/assets/javascripts/model_updates.js
 - app/assets/javascripts/model_updates/activate_elements.js
+- app/assets/javascripts/model_updates/create.es6
 - app/assets/javascripts/model_updates/formatters.js
+- app/assets/javascripts/model_updates/model_updates_class.es6
+- app/assets/javascripts/model_updates/update.es6
 - app/assets/stylesheets/model_updates/application.css
-- app/channels/model_updates/model_channel.rb
+- app/channels/model_updates/create_channel.rb
+- app/channels/model_updates/update_channel.rb
 - app/controllers/model_updates/application_controller.rb
 - app/helpers/model_updates/application_helper.rb
 - app/jobs/model_updates/application_job.rb

data/app/channels/model_updates/model_channel.rb

@@ -1,6 +0,0 @@
-class ModelUpdates::ModelChannel < ApplicationCable::Channel
-  def subscribed
-    model = params[:model].constantize.find(params[:id])
-    stream_for model
-  end
-end