action_cable_notifications 0.1.27 → 0.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbf5459391f70a5ea26fcbe49d73d658ee0018e1
-  data.tar.gz: 139cee45492e3dbac434fa59428784ee779ffc14
+  metadata.gz: 6a2dc5fdc10bc32033f2ecf6d124718ab3949382
+  data.tar.gz: a8a4331d41f25160ca387f189df4ef087472ee91
 SHA512:
-  metadata.gz: f81b284758a85fb93d2c189ae4ec8b4f642ba4855309534017e0f3def93260851545d35a23a4ea5a1ba125c58c331c9df50cc29d9fa939e563786b272a1c9164
-  data.tar.gz: dbdf1d02cc3bc63458ddc7e460f8e47a48d58031a2b6008ca22943b1fc1a84fbda856962241dba5e43ad3b8773a1d018a4954aaf2563248935758f9b4641f885
+  metadata.gz: 1ab592b4eee5232708d9e768bd8d5dec672e77ad4ab28bfd6124bc5e99421dfc652235f4e0e659c5f71c76d6a64b7e261eea87422f38abf3b528c2d463a91e4f
+  data.tar.gz: 52f6f172a7090127f99e195e546c5f72fd0c56ecf68c2c9c5048e3660c60667ce39a150f8995dfd733223f68c1b3f75407a6b023563a85be933ab6120f197a38

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

@@ -28,6 +28,9 @@ class CableNotifications.Collection
       # Cleanup performed commands
       _.remove(@commandsCache, {performed: true})
 
+      # Clears the data array before fetching data
+      @data.splice(0,@data.length)
+
       # Fetch data from upstream server when connection is resumed
       @fetch()
 

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

@@ -18,6 +18,9 @@ class CableNotifications.Store.DefaultCallbacks
     _.each packet.data, (fields) ->
       collection.update({id: fields.id}, fields)
 
+  upsert: (packet, collection) ->
+    collection.upsert({id: packet.id}, packet.data)
+
   upsert_many: (packet, collection) ->
     _.each packet.data, (fields) ->
       collection.upsert({id: fields.id}, fields)

data/lib/action_cable_notifications/channel.rb

@@ -6,10 +6,7 @@ module ActionCableNotifications
     extend ActiveSupport::Concern
 
     included do
-      # class variables
-      class_attribute :ActionCableNotifications
 
-      self.ActionCableNotifications = {}
     end
 
     #
@@ -28,7 +25,7 @@ module ActionCableNotifications
     def action(data)
       data.deep_symbolize_keys!
 
-      channel_options = self.ActionCableNotifications[data[:collection]]
+      channel_options = @ActionCableNotificationsOptions[data[:collection]]
       if channel_options
         model = channel_options[:model]
         broadcasting = channel_options[:broadcasting]
@@ -65,8 +62,9 @@ module ActionCableNotifications
     end
 
     def initialize(*args)
-      super
       @collections = {}
+      @ActionCableNotificationsOptions = {}
+      super
     end
 
     def subscribed
@@ -97,16 +95,19 @@ module ActionCableNotifications
       # Default options
       options = {
         broadcasting: model.model_name.collection,
-        params: nil
+        params: params,
+        cache: false,
+        model_options: {},
+        channel_options: {}
       }.merge(options)
 
       # These options cannot be overridden
       options[:model] = model
-      options[:channel] = self
+      # options[:channel] = self
       model_name = model.model_name.collection
 
       # Sets channel options
-      self.ActionCableNotifications[model_name] = options
+      @ActionCableNotificationsOptions[model_name] = options
 
       # Checks if model already includes notification callbacks
       if !model.respond_to? :ActionCableNotificationsOptions
@@ -115,12 +116,12 @@ module ActionCableNotifications
 
       # Sets broadcast options if they are not already present in the model
       if not model.ActionCableNotificationsOptions.key? options[:broadcasting]
-        model.broadcast_notifications_from options[:broadcasting], options
+        model.broadcast_notifications_from options[:broadcasting], options[:model_options]
       end
 
       # Start streaming
       stream_from options[:broadcasting], coder: ActiveSupport::JSON do |packet|
-        transmit_packet(packet)
+        transmit_packet(packet, options)
       end
 
     end
@@ -130,9 +131,19 @@ module ActionCableNotifications
     #
     # @param [Hash] packet Packet with changes notifications
     #
-    def transmit_packet(packet)
+    def transmit_packet(packet, options={})
+      # Default options
+      options = {
+        cache: false
+      }.merge(options)
+
       packet = packet.as_json.deep_symbolize_keys!
-      if update_cache(packet)
+
+      if options[:cache]==true
+        if update_cache(packet)
+          transmit packet
+        end
+      else
         transmit packet
       end
     end

data/lib/action_cable_notifications/channel_actions.rb

@@ -12,17 +12,27 @@ module ActionCableNotifications
         params = data[:params] || {}
 
         # Get results using provided parameters and model configured scope
-        results = data[:model].
+        begin
+          results = data[:model].
                     select(params[:select] || []).
                     limit(params[:limit]).
                     where(params[:where] || {}).
                     scoped_collection(data[:model_options][:scope]).
                     to_a() rescue []
 
-        response = { collection: data[:model].model_name.collection,
-          msg: 'upsert_many',
-          data: results
-        }
+          response = {
+            collection: data[:model].model_name.collection,
+            msg: 'upsert_many',
+            data: results
+          }
+        rescue Exception => e
+          response = {
+            collection: data[:model].model_name.collection,
+            msg: 'error',
+            command: data[:command],
+            error: e.message
+          }
+        end
 
         # Send data to the client
         transmit_packet response
@@ -62,7 +72,7 @@ module ActionCableNotifications
           }
 
           # Send error notification to the client
-          transmit response
+          transmit_packet response
         end
 
       end
@@ -99,7 +109,7 @@ module ActionCableNotifications
           }
 
           # Send error notification to the client
-          transmit response
+          transmit_packet response
         end
 
       end
@@ -134,7 +144,7 @@ module ActionCableNotifications
           }
 
           # Send error notification to the client
-          transmit response
+          transmit_packet response
         end
 
       end

data/lib/action_cable_notifications/model.rb

@@ -8,13 +8,14 @@ module ActionCableNotifications
       self.ActionCableNotificationsOptions = {}
 
       # Register Callbacks
+      before_update :prepare_update
       after_update :notify_update
       after_create :notify_create
       after_destroy :notify_destroy
-    end
 
-    module ClassMethods
+    end
 
+    class_methods do
       #
       # Sets or removes notificacions options for Active Record model
       #
@@ -25,7 +26,9 @@ module ActionCableNotifications
         # Default options
         options = {
           actions: [:create, :update, :destroy],
-          scope: :all             # Default collection scope
+          track_scope_changes: true,
+          scope: :all,             # Default collection scope
+          records: []
           }.merge(options)
 
         self.ActionCableNotificationsOptions[broadcasting.to_s] = options
@@ -74,7 +77,7 @@ module ActionCableNotifications
       self.ActionCableNotificationsOptions.each do |broadcasting, options|
         if options[:actions].include? :create
           # Checks if record is within scope before broadcasting
-          if self.class.scoped_collection(options[:scope]).where(id: self.id)
+          if options[:scope]==:all or self.class.scoped_collection(options[:scope]).where(id: self.id).present?
             ActionCable.server.broadcast broadcasting,
               collection: self.model_name.collection,
               msg: 'create',
@@ -85,32 +88,74 @@ module ActionCableNotifications
       end
     end
 
+    def prepare_update
+      self.ActionCableNotificationsOptions.each do |broadcasting, options|
+        if options[:actions].include? :update
+          if options[:scope]==:all
+            options[:records].push self
+          else
+            record = self.class.scoped_collection(options[:scope]).where(id: self.id)
+            if record.present?
+              options[:records].push record.first
+            end
+          end
+        end
+      end
+    end
+
     #
-    # Broadcast notifications when a record is updated. Only changed
-    # field will be sent.
+    # Broadcast notifications when a record is updated. Only changed fields will be sent
+    # if they are within configured scope
     #
     def notify_update
-      changes = {}
-      self.changes.each do |k,v|
-        changes[k] = v[1]
-      end
-
-      if !changes.empty?
+      # Checks if there are changes in the model
+      if !self.changes.empty?
         self.ActionCableNotificationsOptions.each do |broadcasting, options|
           if options[:actions].include? :update
-            # Checks if record is within scope before broadcasting
-            if self.class.scoped_collection(options[:scope]).where(id: self.id)
-              # XXX: Performance required. For small data sets this should be
-              # fast enough, but for large data sets this could be slow. As
-              # clients should have a limited subset of the dataset loaded at a
-              # time, caching the results already sent to clients in server memory
-              # should not have a big impact in memory usage but can improve
-              # performance for large data sets where only a sub
+            # Checks if previous record was within scope
+            record = options[:records].detect{|r| r.id==self.id}
+            was_in_scope = record.present?
+            options[:records].delete(record) if was_in_scope
+
+            # Checks if current record is within scope
+            if options[:track_scope_changes]==true
+              is_in_scope = false
+              if options[:scope]==:all
+                record = self
+                is_in_scope = true
+              else
+                record = self.class.scoped_collection(options[:scope]).where(id: self.id)
+                if record.present?
+                  record = record.first
+                  is_in_scope = true
+                end
+              end
+            else
+              is_in_scope = was_in_scope
+            end
+
+            # Broadcasts notifications about model changes
+            if is_in_scope
+              # Get model changes and applies them to the scoped collection record
+              changes = {}
+              self.changes.each do |k,v|
+                if record.respond_to?(k)
+                  changes[k] = v[1]
+                end
+              end
+
+              if !changes.empty?
+                ActionCable.server.broadcast broadcasting,
+                  collection: self.model_name.collection,
+                  msg: 'upsert',
+                  id: self.id,
+                  data: changes
+              end
+            elsif was_in_scope # checks if needs to delete the record if its no longer in scope
               ActionCable.server.broadcast broadcasting,
                 collection: self.model_name.collection,
-                msg: 'update',
-                id: self.id,
-                data: changes
+                msg: 'destroy',
+                id: self.id
             end
           end
         end
@@ -122,9 +167,9 @@ module ActionCableNotifications
     #
     def notify_destroy
       self.ActionCableNotificationsOptions.each do |broadcasting, options|
-        if options[:actions].include? :destroy
+        if options[:scope]==:all or options[:actions].include? :destroy
           # Checks if record is within scope before broadcasting
-          if self.class.scoped_collection(options[:scope]).where(id: self.id)
+          if options[:scope]==:all or self.class.scoped_collection(options[:scope]).where(id: self.id).present?
             ActionCable.server.broadcast broadcasting,
               collection: self.model_name.collection,
               msg: 'destroy',

data/lib/action_cable_notifications/version.rb

@@ -1,3 +1,3 @@
 module ActionCableNotifications
-  VERSION = '0.1.27'
+  VERSION = '0.1.28'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.27
+  version: 0.1.28
 platform: ruby
 authors:
 - ByS Sistemas de Control
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rails engine that provides Automatic realtime notification broadcast
   for ActiveRecord models changes using Action Cable and websockets
 email: