action_cable_notifications 0.1.10 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93a9012143b6b7d56623ffc5fa9f1af2b7d6e903
-  data.tar.gz: 33e6cc435a5e149a7899a83c97aced3c3815d841
+  metadata.gz: 6f1c452c20e07a93aa050d60b61d6a5c2fdba4a1
+  data.tar.gz: da28fc564086ef82612b56f209bd365df1d80127
 SHA512:
-  metadata.gz: 90f782dc30ebf6f14d961e020e1965b713305eba0b6ab7775441bc180afb6ad3b857ad84f629b190a9a41078f9df6b11ead947c867cbad79b15380286255bae9
-  data.tar.gz: c6f608b919a1ac36263908afbf0132dbb7044c3f214b706600c625c5ffefc5be1182eb6afd49256d1da7404ef9c317f4778feb02f591f873b5f0fc188d5c5c79
+  metadata.gz: a769b28967a738637247207f4113cbebe510a2526a44099daed32be698e2207ce93b7b566b46f9344dab5092a62207bbb4f17f54246b9dc7e01b416388489cff
+  data.tar.gz: 50f9b8030b96f4aeaf82a7a5f8b030c627c577525128e9b8e6697425b883adab7585591c3879cce64a5498a2d99bbf1c14483f6254274a69fa604159922be118

data/app/assets/javascripts/action_cable_notifications/application.js

@@ -11,4 +11,4 @@
 // about supported directives.
 //
 //= require lodash
-//= require_tree .
+//= require ./cable_notifications

data/app/assets/javascripts/action_cable_notifications/cable_notifications.coffee

@@ -0,0 +1,13 @@
+#= export CableNotifications
+#= require_self
+#= require './store'
+#= require './collection'
+
+@CableNotifications =
+  stores: []
+
+  # Register a new store
+  registerStore: (store, callbacks) ->
+    new_store = new CableNotifications.Store(store, callbacks)
+    @stores.push new_store
+    new_store

data/app/assets/javascripts/action_cable_notifications/collection.coffee

@@ -0,0 +1,40 @@
+class CableNotifications.Collection
+  constructor: (@store, @name) ->
+    @data = []
+    @channelInfo = null
+
+  # Private methods
+  #######################################
+
+  find: (selector={}) ->
+    _.find(@data, selector)
+
+  findIndex: (selector={}) ->
+    _.findIndex(@data, selector)
+
+  insert: (record) ->
+    @data.push (record)
+
+  remove: (selector={}) ->
+    index = @findIndex(selector)
+    if index < 0
+      console.warn("Couldn't find a matching record: #{selector}")
+    else
+      record = @data.splice(index, 1)
+
+  update: (selector={}, fields, options) ->
+    record = @find(selector)
+    if !record
+      if options.upsert
+        @insert(fields)
+      else
+        console.warn("Couldn't find a matching record: #{selector}")
+    else
+      _.extend(record, fields)
+
+  # http://docs.meteor.com/#/full/upsert
+  upsert: (selector={}, fields) ->
+    @update(selector, fields, {upsert: true})
+
+  filter: (selector={}) ->
+    _.filter(@data, selector)

data/app/assets/javascripts/action_cable_notifications/default_callbacks.coffee

@@ -0,0 +1,62 @@
+# Default callbacks for internal storage of received packets
+class CableNotifications.Store.DefaultCallbacks
+  constructor: (@collections) ->
+
+  # Helper function
+  processPacketHelper = (packet, collection) ->
+    index = -1
+    record = null
+
+    local_collection = @collections[collection || packet.collection].data
+    if !local_collection
+      console.warn("[update_many]: Collection #{collection_name} doesn't exist")
+    else
+      index = _.find(local_collection, (record) -> record.id == packet.id)
+      if (index >= 0)
+        record = local_collection[index]
+
+    return {
+      collection: local_collection
+      index: index
+      record: record
+    }
+
+  # Callbacks
+  ##################################################
+
+  collection_remove: (packet, collection) ->
+    console.warn 'Method not implemented: collection_remove '
+
+  create: (packet, collection) ->
+    data = processPacketHelper(packet, collection)
+    if data.record
+      console.warn 'Expected not to find a document already present for an add: ' + data.record
+    else
+      data.collection.push(packet.data)
+
+  update: (packet, collection) ->
+    data = processPacketHelper(packet, collection)
+    if !data.record
+      console.warn 'Expected to find a document to change'
+    else if !_.isEmpty(packet.data)
+      _.extend(data.record, packet.data)
+
+  update_many: (packet, collection) ->
+    collection_name = collection || packet.collection
+    local_collection = @collections[collection_name].data
+    if !local_collection
+      console.warn("[update_many]: Collection #{collection_name} doesn't exist")
+    else
+      _.each packet.data, (fields) ->
+        record = _.findIndex(local_collection, (r) -> r.id == fields.id)
+        if record>=0
+          _.extend(local_collection[record], fields)
+        else
+          local_collection.push(fields)
+
+  destroy: (packet, collection) ->
+    data = processPacketHelper(packet, collection)
+    if !data.record
+      console.warn 'Expected to find a document to remove'
+    else
+      data.collection.splice(data.index, 1)

data/app/assets/javascripts/action_cable_notifications/store.coffee

@@ -0,0 +1,54 @@
+#= require_self
+#= require './default_callbacks'
+
+class CableNotifications.Store
+  constructor: (@name, @callbacks) ->
+    @collections = {}
+    @channels = {}
+
+    if !@callbacks
+      @callbacks = new CableNotifications.Store.DefaultCallbacks(@collections)
+
+    this
+
+  # Private methods
+  #######################################
+
+  packetReceived = (channelInfo, collection) ->
+    (packet) ->
+      @storePacket(packet, collection)
+      channelInfo.callbacks.received?.apply channelInfo.channel, arguments
+
+  # Public methods
+  #######################################
+
+  # Register a new collection
+  registerCollection: (collection) ->
+    if @collections[collection]
+      console.warn '[registerCollection]: Collection already exists'
+    else
+      @collections[collection] = new CableNotifications.Collection(this, collection)
+    @collections[collection]
+
+  # Sync store using ActionCable received events
+  # collection parameter overrides the collection name specified in the incoming packets for this channel
+  syncToChannel: (channel, collection) ->
+    channelId = JSON.parse(channel.identifier)?.channel
+
+    if !channelId
+      console.warn "[syncToChannel]: Channel specified doesn't have an identifier"
+    else
+      @channels[channelId] =
+        channel: channel
+        callbacks: {
+          received: channel.received
+        }
+
+      channel.received = packetReceived(@channels[channelId], collection).bind(this)
+    channel
+
+  # Dispatch received packet to registered stores
+  # collection overrides the collection name specified in the incoming packet
+  storePacket: (packet, collection) ->
+    if packet && packet.msg
+      @callbacks[packet.msg]?(packet, collection)

data/app/assets/javascripts/action_cable_notifications.js

@@ -1 +1 @@
-//= require_tree ./action_cable_notifications
+//= require ./action_cable_notifications/application

data/lib/action_cable_notifications/callbacks.rb

@@ -59,7 +59,7 @@ module ActionCableNotifications
         if options.present?
           {
             collection: self.model_name.collection,
-            msg: 'collection_add',
+            msg: 'update_many',
             data: self.scoped_collection(options[:scope])
           }
         end

data/lib/action_cable_notifications/streams.rb

@@ -3,14 +3,20 @@ module ActionCableNotifications
     extend ActiveSupport::Concern
 
     included do
+      attr_accessor :stream_notification_options
       # Actions to be done when the module is included
     end
 
+    def get_initial_values
+      transmit self.stream_notification_options[:model].notify_initial self.stream_notification_options[:broadcasting]
+    end
+
     private
 
     def stream_notifications_for(model, options = {}, &block)
       # Default options
       options = {
+        model: model,
         actions: [:create, :update, :destroy],
         broadcasting: model.model_name.collection,
         callback: nil,
@@ -20,6 +26,9 @@ module ActionCableNotifications
         scope: :all             # Default collection scope
         }.merge(options)
 
+      # Sets channel options
+      self.stream_notification_options = options
+
       # Checks if model already includes notification callbacks
       if !model.respond_to? :ActionCableNotificationsOptions
         model.send('include', ActionCableNotifications::Callbacks)
@@ -37,7 +46,7 @@ module ActionCableNotifications
       # Transmit initial state if required
       if options[:include_initial]
         # XXX: Check if data should be transmitted
-        transmit model.notify_initial options[:broadcasting]
+        get_initial_values
       end
 
     end

data/lib/action_cable_notifications/version.rb

@@ -1,3 +1,3 @@
 module ActionCableNotifications
-  VERSION = '0.1.10'
+  VERSION = '0.1.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.14
 platform: ruby
 authors:
 - ByS Sistemas de Control
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -72,7 +72,10 @@ files:
 - app/assets/config/action_cable_notifications_manifest.js
 - app/assets/javascripts/action_cable_notifications.js
 - app/assets/javascripts/action_cable_notifications/application.js
-- app/assets/javascripts/action_cable_notifications/sync_to_store.coffee
+- app/assets/javascripts/action_cable_notifications/cable_notifications.coffee
+- app/assets/javascripts/action_cable_notifications/collection.coffee
+- app/assets/javascripts/action_cable_notifications/default_callbacks.coffee
+- app/assets/javascripts/action_cable_notifications/store.coffee
 - app/assets/stylesheets/action_cable_notifications/application.css
 - app/controllers/action_cable_notifications/application_controller.rb
 - app/helpers/action_cable_notifications/application_helper.rb

data/app/assets/javascripts/action_cable_notifications/sync_to_store.coffee

@@ -1,107 +0,0 @@
-class CableNotifications
-
-  #
-  # Private variables
-  #####################################
-
-  registered_stores = {}
-
-  #
-  # Public variables
-  #####################################
-
-  collections: null
-
-  #
-  # Private methods
-  #####################################
-
-  processPacketHelper = (packet, collection) ->
-    local_collection = @collections[collection || packet.collection]
-    index = null
-    record = null
-
-    index = _.findIndex(local_collection, (record) -> record.id == packet.id)
-    if (index >= 0)
-      record = local_collection[index]
-
-    return {
-      collection: local_collection
-      index: index
-      record: record
-    }
-
-  # Default callbacks for internal storage of received packets
-  # Need to set include_initial: true in broadcasting options
-  default_callbacks =
-    initialize: (collection) ->
-      @collections[collection] = []
-
-    collection_add: (packet, collection) ->
-      for index, row of packet.data
-        @collections[collection || packet.collection].push( row )
-
-    collection_remove: (packet, collection) ->
-      console.warn 'Method not implemented: collection_remove '
-
-    create: (packet, collection) ->
-      data = processPacketHelper(packet, collection)
-      if data.record
-        console.warn 'Expected not to find a document already present for an add: ' + data.record
-      else
-        data.collection.push(packet.data)
-
-    update: (packet, collection) ->
-      data = processPacketHelper(packet, collection)
-      if !data.record
-        console.warn 'Expected to find a document to change'
-      else if !_.isEmpty(packet.data)
-        _.extend(data.record, packet.data)
-
-    update_many: (packet, collection) ->
-      local_collection = @collections[collection || packet.collection]
-      _.each packet.data, (fields) ->
-        record = _.findIndex(local_collection, (r) -> r.id == fields.id)
-        if record
-          _.extend(local_collection[index], fields)
-
-    destroy: (packet, collection) ->
-      data = processPacketHelper(packet, collection)
-      if !data.record
-        console.warn 'Expected to find a document to remove'
-      else
-        data.collection.splice(data.index, 1)
-
-  #
-  # Public methods
-  #####################################
-  constructor: ->
-    @collections = {}
-
-    # Binds local methods and callbacks to this class
-    for name, callback of default_callbacks
-      default_callbacks[name] = callback.bind(this)
-
-    processPacketHelper = processPacketHelper.bind(this)
-
-  # Registers a new store
-  registerStore: (collection, callbacks) ->
-    if callbacks
-      registered_stores[collection] = callbacks
-    else
-      registered_stores[collection] = default_callbacks
-
-    # Initialize registered store
-    registered_stores[collection].initialize?(collection)
-
-  # Dispatch received packet to registered stores
-  storePacket: (packet, collection) ->
-    if packet && packet.msg
-      for store, callbacks of registered_stores
-        callbacks[packet.msg]?(packet, collection)
-
-
-# Export to global namespace
-#######################################
-@App = {} unless @App
-@App.cable_notifications = new CableNotifications()