model_updates 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05326da852e8df75c3e5334f89cabc3f38177947
-  data.tar.gz: 063a04512f41a1f72cde419c73f3584914fb562e
+  metadata.gz: b6e5c02e29a478245a15cbca2daf7238ef762f83
+  data.tar.gz: 0c4c00c9c6404c72a3ea21b3168ddc5a19be18b9
 SHA512:
-  metadata.gz: '093382959d411617d46eec433757d6e2657c36be156f4dbf999f73810a08a6d0ba7bab3fc5b97a74045c5e5995eda1ec7551bda6349f2dc31a03852e5021c29a'
-  data.tar.gz: 8a00157e300e125093f08fa5b4487a2f3af50f979e2a527c1b5e795e5ee5b49ab9d4b68731013b98a5ba4668629af858dd5ca1506c130b2c4aecbfac5c66e68e
+  metadata.gz: c686af4abd42d5f9a6ca9f895c6c08f62fa461c060b419d282625b38e7ee9597653fbe55dff27b5a841822c9733614936728d49a61d37d777e2decacdf10a158
+  data.tar.gz: ea03a51dd7f1468e0950af0ffe6fb5ea6b3eee76e816d49c9d58fb5e2ac6eea8e3fc7780e7fd96394401c87ebac960ec7b583e0c07cfc914e0e8dd3b710a084e

data/README.md

@@ -34,6 +34,25 @@ class ApplicationRecord < ActiveRecord::Base
 end
 ```
 
+Add required CanCan access methods to your `ApplicationCable::Channel`:
+```ruby
+class ApplicationCable::Channel < ActionCable::Channel::Base
+private
+
+  delegate :authorize!, :can?, to: :current_ability
+
+  def current_ability
+    @_current_ability ||= PeakFlowAbility.new(user: current_user)
+  end
+
+  def current_user
+    @_current_user ||= env["warden"].user
+  end
+end
+```
+
+You can define `authorize!(ability, model)` yourself, if you aren't using CanCan.
+
 Choose which attributes should be broadcasted automatically:
 
 ```ruby
@@ -50,6 +69,14 @@ class Model < ApplicationRecord
 end
 ```
 
+Or destroys:
+```ruby
+class Model < ApplicationRecord
+  model_updates_broadcast_attributes attributes: [:updated_at]
+  model_updates_broadcast_destroyed
+end
+```
+
 ## Usage
 
 
@@ -109,6 +136,24 @@ ModelUpdates.Create.connect({model: "MyModel", onCreated: function(data) {
 })
 ```
 
+If you want an element automatically removed on destroy:
+```erb
+<div class="model-updates" data-model-updates-model="<%= model.class.name %>" data-model-updates-id="<%= model.id %>" data-model-updates-remove-on-destroy="true">
+  <%= model.updated_at %>
+</div>
+```
+
+You can also manually listen when a model gets destroyed:
+```js
+ModelUpdates.Destroy.connect({
+  "id": data.id,
+  "model": "BuildCommandExecution",
+  "onDestroyed": function(data) {
+    console.log("Model destroyed: " + data.id)
+  }
+})
+```
+
 ## Contributing
 
 Contribution directions go here.

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

@@ -1,23 +1,43 @@
 $(document).ready(function() {
   // Find all models that should be subscribed to
-  model_subscriptions = {}
+  modelSubscriptions = {}
+  modelDestroys = {}
 
   $(".model-updates").each(function() {
-    model_type = $(this).data("model-updates-model")
-    model_id = $(this).data("model-updates-id")
+    element = $(this)
 
-    if (!model_subscriptions[model_type])
-      model_subscriptions[model_type] = {}
+    model = element.data("model-updates-model")
+    id = element.data("model-updates-id")
 
-    model_subscriptions[model_type][model_id] = {}
+    if (!modelSubscriptions[model])
+      modelSubscriptions[model] = {}
+
+    if (element.data("model-updates-key"))
+      modelSubscriptions[model][id] = true
+
+    if (element.data("model-updates-remove-on-destroy")) {
+      if (!modelDestroys[model])
+        modelDestroys[model] = {}
+
+      modelDestroys[model][id] = true
+    }
   })
 
   // Subscribe to the found models
-  for(var model_type in model_subscriptions) {
-    for(var model_id in model_subscriptions[model_type]) {
+  for(var model in modelSubscriptions) {
+    for(var id in modelSubscriptions[model]) {
       ModelUpdates.Update.connect({
-        "id": model_id,
-        "model": model_type
+        "id": id,
+        "model": model
+      })
+    }
+  }
+
+  for(var model in modelDestroys) {
+    for(var id in modelDestroys[model]) {
+      ModelUpdates.Destroy.connect({
+        "id": id,
+        "model": model
       })
     }
   }

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

@@ -0,0 +1,18 @@
+ModelUpdates.Destroy = class Destroy {
+  static connect(args) {
+    ModelUpdates.debug("Connecting to destroy channel for " + args.model + "(" + args.id + ")")
+
+    App.cable.subscriptions.create(
+      {channel: "ModelUpdates::DestroyChannel", id: args.id, model: args.model},
+      {
+        received: function(json) {
+          var elements = $(".model-updates[data-model-updates-model='" + json.model + "'][data-model-updates-id='" + json.id + "'][data-model-updates-remove-on-destroy='true']")
+          elements.remove()
+
+          if (args.onDestroyed)
+            args.onDestroyed(json)
+        }
+      }
+    )
+  }
+}

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

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

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

@@ -1,12 +1,12 @@
 ModelUpdates.Update = class Update {
   static connect(args) {
-    ModelUpdates.debug("ModelUpdates: Connecting to " + args.model + "(" + args.id + ")")
+    ModelUpdates.debug("Connecting to update channel for " + 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 + ")")
+          ModelUpdates.debug("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 + "']")

data/app/assets/javascripts/model_updates.js

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

data/app/channels/model_updates/destroy_channel.rb

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

data/lib/model_updates/model_extensions.rb

@@ -11,7 +11,7 @@ module ModelUpdates::ModelExtensions
     def model_updates_broadcast_attributes(args)
       model_updates_data[:attributes] = args.fetch(:attributes)
 
-      after_save do
+      after_commit on: :update do |model|
         changes = {}
 
         args.fetch(:attributes).each do |attribute_name|
@@ -27,9 +27,9 @@ module ModelUpdates::ModelExtensions
 
         if changes.any?
           ModelUpdates::UpdateChannel.broadcast_to(
-            self,
+            model,
             id: id,
-            model: self.class.name,
+            model: model.class.name,
             changes: changes
           )
         end
@@ -41,7 +41,7 @@ module ModelUpdates::ModelExtensions
         channel_name = "ModelUpdatesCreate#{model.class.name}"
 
         attributes = {}
-        self.class.model_updates_data[:attributes].each do |attribute_name|
+        model.class.model_updates_data[:attributes].each do |attribute_name|
           attributes[attribute_name] = __send__(attribute_name)
         end
 
@@ -52,6 +52,22 @@ module ModelUpdates::ModelExtensions
         )
       end
     end
+
+    def model_updates_broadcast_destroyed
+      after_commit on: :destroy do |model|
+        attributes = {}
+        model.class.model_updates_data[:attributes].each do |attribute_name|
+          attributes[attribute_name] = __send__(attribute_name)
+        end
+
+        ModelUpdates::DestroyChannel.broadcast_to(
+          model,
+          id: id,
+          model: model.class.name,
+          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.6".freeze
+  VERSION = "0.0.7".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_updates
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - kaspernj
@@ -52,11 +52,13 @@ files:
 - 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/destroy.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/create_channel.rb
+- app/channels/model_updates/destroy_channel.rb
 - app/channels/model_updates/update_channel.rb
 - app/controllers/model_updates/application_controller.rb
 - app/helpers/model_updates/application_helper.rb