model_updates 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5cb133f1b8f65abb2d507c21b386305040af2e0
-  data.tar.gz: c7d89af1f90f0a65637ba16cb070b71ff27eb422
+  metadata.gz: 7ce52aac9e4372e8367b4f38870755ac6504f7a9
+  data.tar.gz: '09643ad37dda2f57123e4d09d7638ec1a23f5300'
 SHA512:
-  metadata.gz: ba0a40d206e4f5de631469bd8265b52c61ed5fbe4d149e2bbb0b0abb1eaa82bbc1d76768d63512d37f1715dcced6317aeadb9e05b717fd4ef17325405d3dac89
-  data.tar.gz: 9beab92f2e0173da0b9ae5c265199feb898265ab9e4d0f596cc9b5e1f657604ca62f5a260322b08d695f10ebb42f6de52dc8afde5dc439b245e029b8fb266084
+  metadata.gz: c42fe2e6821234087a1b764dc62a4144b10541f356bf985f00e7b7afd39d8f2f4cc6f683b29361ed589553c7944c9fe246694fc98b4093dd07fc7baf3e12a320
+  data.tar.gz: '009db022e778a84744276567092167ecf3de57fb0134a3e216e264c39b5306421b7b0b1f11327d3d3888fd78d14bbdc7ce86955a1771f9cd3b06c3908454f81e'

data/README.md

@@ -170,6 +170,38 @@ You can refresh elements with a simple call like this:
 ModelUpdates.update()
 ```
 
+## Events
+
+Call an event on a specific model:
+```ruby
+user = User.find(user_id)
+user.model_updates_call("changed-password", new_password: "test")
+```
+
+Connect to a specific model:
+```js
+ModelUpdates.connectModel("User", userId, "changed-password", function(args) {
+  console.log("User changed his password to: " + args.new_password)
+})
+```
+
+Call an event on a model class:
+```ruby
+User.model_updates_call("changed-password", new_password: "test")
+```
+
+Connect to events called on a models class:
+```js
+ModelUpdates.connectModelClass("User", "changed-password", function(args) {
+  console.log("Someone his password to: " + args.new_password)
+})
+```
+
+Call this at the end of your JavaScript, which will actually connect to all the defined events in a batched way:
+```js
+ModelUpdates.connectEvents()
+```
+
 ### Debugging
 
 In case you want to enable debug output from ModelUpdates from JavaScript:

data/app/assets/javascripts/model_updates.js

@@ -1,6 +1,7 @@
 //= require model_updates/model_updates_class
 //= require model_updates/activator
 //= require model_updates/create
+//= require model_updates/events
 //= require model_updates/formatters
 //= require model_updates/update
 

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

@@ -3,10 +3,26 @@ ModelUpdates.Activator = class Activator {
     ModelUpdates.debug("Activator constructor")
 
     this.modelSubscriptions = {}
+    this.callbacks = {}
     this.connectedUpdates = {}
     this.connectedDestroyes = {}
   }
 
+  connectUpdate(model, id, callback) {
+    if (!this.modelSubscriptions[model])
+      this.modelSubscriptions[model] = {}
+
+    this.modelSubscriptions[model][id] = true
+
+    if (!this.callbacks[model])
+      this.callbacks[model] = {}
+
+    if (!this.callbacks[model][id])
+      this.callbacks[model][id] = []
+
+    this.callbacks[model][id].push(callback)
+  }
+
   update() {
     ModelUpdates.debug("Update was called")
     this.updateFoundElements()

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

@@ -0,0 +1,88 @@
+ModelUpdates.Events = class Events {
+  constructor() {
+    this.modelCallbacks = {}
+    this.modelClassCallbacks = {}
+    this.resetCallbackData()
+  }
+
+  connectModel(args, callback) {
+    if (!this.modelCallbacks[args.model])
+      this.modelCallbacks[args.model] = {}
+
+    if (!this.callbackData["connect_model"][args.model])
+      this.callbackData["connect_model"][args.model] = []
+
+    if (!this.modelCallbacks[args.model][args.id]) {
+      this.modelCallbacks[args.model][args.id] = []
+      this.callbackData["connect_model"][args.model].push(args.id)
+    }
+
+    this.modelCallbacks[args.model][args.id].push(args)
+  }
+
+  connectModelClass(args, callback) {
+    if (!this.modelClassCallbacks[args.model])
+      this.modelClassCallbacks[args.model] = []
+
+    this.modelClassCallbacks[args.model].push(args)
+    this.callbackData["connect_model_class"].push(args.model)
+  }
+
+  connect() {
+    ModelUpdates.debug("Connecting: " + JSON.stringify(this.callbackData))
+
+    var events = this
+    App.cable.subscriptions.create(
+      {channel: "ModelUpdates::EventsChannel", callback_data: this.callbackData},
+      {
+        received: function(json) {
+          ModelUpdates.debug("Incoming event: " + JSON.stringify(json))
+
+          if (json.callback_type == "model") {
+            events.callModelCallbacks(json)
+          } else if(json.callback_type == "model_class") {
+            events.callModelClassCallbacks(json)
+          } else {
+            console.log("Didnt know how to handle: " + JSON.stringify(json))
+          }
+        }
+      }
+    )
+
+    this.resetCallbackData()
+  }
+
+  callModelCallbacks(args) {
+    var modelClass = args.model
+    var modelId = args.id
+    var callbacks = this.modelCallbacks[modelClass][modelId]
+
+    for(var callbackNumber in callbacks) {
+      var callback = callbacks[callbackNumber]
+
+      if (!callback.name || callback.name == args.event_name) {
+        callback.callback(args)
+      }
+    }
+  }
+
+  callModelClassCallbacks(args) {
+    var modelClass = args.model
+    var callbacks = this.modelClassCallbacks[modelClass]
+
+    for(var callbackNumber in callbacks) {
+      var callback = callbacks[callbackNumber]
+
+      if (!callback.name || callback.name == args.event_name) {
+        callback.callback(args)
+      }
+    }
+  }
+
+  resetCallbackData() {
+    this.callbackData = {
+      "connect_model_class": [],
+      "connect_model": {}
+    }
+  }
+}

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

@@ -1,4 +1,24 @@
 class ModelUpdates {
+  static connectChanged(model, id, callback) {
+    ModelUpdates.current().activator().connectUpdate(model, id, callback)
+  }
+
+  static connectModel(modelName, modelId, eventName, callback) {
+    ModelUpdates.current().events().connectModel({"model": modelName, "id": modelId, "name": eventName, "callback": function(args) {
+      callback(args.args)
+    }})
+  }
+
+  static connectModelClass(modelName, eventName, callback) {
+    ModelUpdates.current().events().connectModelClass({"model": modelName, "name": eventName, "callback": function(args) {
+      callback(args.args)
+    }})
+  }
+
+  static connectEvents() {
+    ModelUpdates.current().events().connect()
+  }
+
   static debug(message) {
     if (ModelUpdates.configuration.debug) {
       console.log("ModelUpdates: " + message)
@@ -24,6 +44,13 @@ class ModelUpdates {
     return this.activatorElement
   }
 
+  events() {
+    if (!this.eventsElement)
+      this.eventsElement = new ModelUpdates.Events()
+
+    return this.eventsElement
+  }
+
   update() {
     ModelUpdates.debug("Instance method update called")
     this.activator().update()

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

@@ -6,6 +6,19 @@ ModelUpdates.Update = class Update {
       {channel: "ModelUpdates::UpdateChannel", ids: args.ids},
       {
         received: function(json) {
+          if (ModelUpdates.current().activator().callbacks[json.model] && ModelUpdates.current().activator().callbacks[json.model][json.id]) {
+            var callbacks = ModelUpdates.current().activator().callbacks[json.model][json.id]
+
+            ModelUpdates.debug("Found callbacks for " + json.model + "(" + json.id + ")")
+
+            for(var key in callbacks) {
+              var callback = callbacks[key]
+              ModelUpdates.debug("Calling callback")
+              callback.apply(json)
+            }
+          } else {
+            console.log("No callbacks for " + json.model + "(" + json.id + ")")
+          }
 
           if (json.type == "destroy") {
             var elements = $(".model-updates[data-model-updates-model='" + json.model + "'][data-model-updates-id='" + json.id + "'][data-model-updates-remove-on-destroy='true']")

data/app/channels/model_updates/events_channel.rb

@@ -0,0 +1,37 @@
+class ModelUpdates::EventsChannel < ApplicationCable::Channel
+  def subscribed
+    connect_models if params[:callback_data][:connect_model].present?
+    connect_model_classes if params[:callback_data][:connect_model_class].present?
+  end
+
+private
+
+  def connect_models
+    params[:callback_data][:connect_model].each do |model_class_name, ids|
+      models = model_class_name.safe_constantize.accessible_by(current_ability).where(id: ids)
+      models.find_each do |model|
+        stream_model(model: model)
+      end
+    end
+  end
+
+  def connect_model_classes
+    params[:callback_data][:connect_model_class].each do |model_class_name|
+      stream_model_class(model_class: model_class_name.safe_constantize)
+    end
+  end
+
+  def stream_model(model:)
+    channel_name = "model_updates_events_model_#{model.class.name}_model_#{model.id}"
+    stream_from(channel_name, coder: ActiveSupport::JSON) do |data|
+      transmit data
+    end
+  end
+
+  def stream_model_class(model_class:)
+    channel_name = "model_updates_events_class_#{model_class.name}"
+    stream_from(channel_name, coder: ActiveSupport::JSON) do |data|
+      transmit data
+    end
+  end
+end

data/lib/model_updates/model_extensions.rb

@@ -73,6 +73,27 @@ module ModelUpdates::ModelExtensions
         )
       end
     end
+
+    def model_updates_call(event_name, args = {})
+      ActionCable.server.broadcast(
+        "model_updates_events_class_#{name}",
+        event_name: event_name,
+        model: name,
+        callback_type: "model_class",
+        args: args
+      )
+    end
+  end
+
+  def model_updates_call(event_name, args = {})
+    ActionCable.server.broadcast(
+      "model_updates_events_model_#{self.class.name}_model_#{id}",
+      event_name: event_name,
+      id: id,
+      model: self.class.name,
+      callback_type: "model",
+      args: args
+    )
   end
 
   def model_updates_attrs(key, more = {})

data/lib/model_updates/version.rb

@@ -1,3 +1,3 @@
 module ModelUpdates
-  VERSION = "0.0.11".freeze
+  VERSION = "0.0.12".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_updates
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,18 +52,13 @@ files:
 - app/assets/javascripts/model_updates.js
 - app/assets/javascripts/model_updates/activator.es6
 - app/assets/javascripts/model_updates/create.es6
+- app/assets/javascripts/model_updates/events.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/events_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
-- app/mailers/model_updates/application_mailer.rb
-- app/models/model_updates/application_record.rb
-- app/views/layouts/model_updates/application.html.erb
 - config/routes.rb
 - lib/model_updates.rb
 - lib/model_updates/attribute_generator.rb

data/app/assets/stylesheets/model_updates/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/model_updates/application_controller.rb

@@ -1,5 +0,0 @@
-module ModelUpdates; end
-
-class ModelUpdates::ApplicationController < ActionController::Base
-  protect_from_forgery with: :exception
-end

data/app/helpers/model_updates/application_helper.rb

@@ -1,2 +0,0 @@
-module ModelUpdates::ApplicationHelper
-end

data/app/jobs/model_updates/application_job.rb

@@ -1,2 +0,0 @@
-class ModelUpdates::ApplicationJob < ActiveJob::Base
-end

data/app/mailers/model_updates/application_mailer.rb

@@ -1,4 +0,0 @@
-class ModelUpdates::ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
-  layout "mailer"
-end

data/app/models/model_updates/application_record.rb

@@ -1,3 +0,0 @@
-class ModelUpdates::ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end

data/app/views/layouts/model_updates/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Model updates</title>
-  <%= stylesheet_link_tag    "model_updates/application", media: "all" %>
-  <%= javascript_include_tag "model_updates/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>