motion 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7645381b6b2749a4a9ba90a15c93916636e1b9edfd7b3a6a1bf7d47429fedb3f
-  data.tar.gz: 46c929b8aa2d1de8c714eb8b8db1db8524aec892576a13ad1582b7fa858565f7
+  metadata.gz: 54eb6afb0f21c0333d46c1a21602739146fa1e2a021d3ffda048c9763dc85e66
+  data.tar.gz: c3d9476c0e34869f5d4e46121316dee4f2c78d91b0a9b51d05c14a0b4d4e63ac
 SHA512:
-  metadata.gz: b8c99a480f51e9d818f5d22de3efbf8923155943d1815188e19332c54b8f24b909bc371abc7282d3a9caac754cf1b0aee4bb3193dad75b7f1d86a9112ed13983
-  data.tar.gz: a12e9213ba0ae38cbc5d839ae1408a5aab064be055896300f19a2296ebcd74b49922b96636bc52bd7b7aef62be9868ea47437544938f20facaad45534744bc4e
+  metadata.gz: b17d8159ba7eae3b144a6380385e68eb9a2b49b0733926d9e285bf60c8f0767646d30841ee90d62d4b3a359f5c5f9beb62d4793c6d48dff6f1887c9fd7367a70
+  data.tar.gz: 0c47ed993c63378f0d562e341a44539bda1578c34d42ae8449c1dfd9dedabf7481e9e5f272c0869416893533fe31b5901368ebcc2e53c0752db120afb0e84c50

data/lib/motion.rb

@@ -5,6 +5,7 @@ require "motion/errors"
 
 module Motion
   autoload :ActionCableExtentions, "motion/action_cable_extentions"
+  autoload :Callback, "motion/callback"
   autoload :Channel, "motion/channel"
   autoload :Component, "motion/component"
   autoload :ComponentConnection, "motion/component_connection"

data/lib/motion/callback.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "motion"
+
+module Motion
+  class Callback
+    attr_reader :broadcast
+
+    NAMESPACE = "motion:callback"
+    private_constant :NAMESPACE
+
+    def self.broadcast_for(component, method)
+      [
+        NAMESPACE,
+        component.stable_instance_identifier_for_callbacks,
+        method
+      ].join(":")
+    end
+
+    def initialize(component, method)
+      @broadcast = self.class.broadcast_for(component, method)
+
+      component.stream_from(broadcast, method)
+    end
+
+    def ==(other)
+      other.is_a?(Callback) &&
+        other.broadcast == broadcast
+    end
+
+    def call(message = nil)
+      ActionCable.server.broadcast(broadcast, message)
+    end
+  end
+end

data/lib/motion/channel.rb

@@ -65,15 +65,15 @@ module Motion
     private
 
     def synchronize
+      component_connection.if_render_required do |component|
+        transmit(renderer.render(component))
+      end
+
       streaming_from component_connection.broadcasts,
         to: :process_broadcast
 
       periodically_notify component_connection.periodic_timers,
         via: :process_periodic_timer
-
-      component_connection.if_render_required do |component|
-        transmit(renderer.render(component))
-      end
     end
 
     def handle_error(error, context)

data/lib/motion/component.rb

@@ -5,6 +5,7 @@ require "active_support/concern"
 require "motion"
 
 require "motion/component/broadcasts"
+require "motion/component/callbacks"
 require "motion/component/lifecycle"
 require "motion/component/motions"
 require "motion/component/periodic_timers"
@@ -15,6 +16,7 @@ module Motion
     extend ActiveSupport::Concern
 
     include Broadcasts
+    include Callbacks
     include Lifecycle
     include Motions
     include PeriodicTimers

data/lib/motion/component/callbacks.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+require "motion"
+
+module Motion
+  module Component
+    module Callbacks
+      def bind(method)
+        Callback.new(self, method)
+      end
+
+      def stable_instance_identifier_for_callbacks
+        @_stable_instance_identifier_for_callbacks ||= SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/motion/component/rendering.rb

@@ -11,6 +11,15 @@ module Motion
       RERENDER_MARKER_IVAR = :@__awaiting_forced_rerender__
       private_constant :RERENDER_MARKER_IVAR
 
+      # Some changes to Motion's state are specifically supported during render.
+      ALLOWED_NEW_IVARS_DURING_RENDER = %i[
+        @_broadcast_handlers
+        @_stable_instance_identifier_for_callbacks
+        @_motion_handlers
+        @_periodic_timers
+      ].freeze
+      private_constant :ALLOWED_NEW_IVARS_DURING_RENDER
+
       def rerender!
         instance_variable_set(RERENDER_MARKER_IVAR, true)
       end
@@ -55,8 +64,11 @@ module Motion
 
         yield
       ensure
-        (instance_variables - existing_instance_variables)
-          .each(&method(:remove_instance_variable))
+        (
+          instance_variables -
+          existing_instance_variables -
+          ALLOWED_NEW_IVARS_DURING_RENDER
+        ).each(&method(:remove_instance_variable))
       end
     end
   end

data/lib/motion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Motion
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alec Larsen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -59,9 +59,11 @@ files:
 - lib/motion/action_cable_extentions/declarative_streams.rb
 - lib/motion/action_cable_extentions/log_suppression.rb
 - lib/motion/action_cable_extentions/synchronization.rb
+- lib/motion/callback.rb
 - lib/motion/channel.rb
 - lib/motion/component.rb
 - lib/motion/component/broadcasts.rb
+- lib/motion/component/callbacks.rb
 - lib/motion/component/lifecycle.rb
 - lib/motion/component/motions.rb
 - lib/motion/component/periodic_timers.rb
@@ -86,7 +88,7 @@ metadata:
   source_code_uri: https://github.com/unabridged/motion
 post_install_message: |
   Friendly reminder: When updating the motion gem, don't forget to update the
-  NPM package as well (`bin/yarn add '@unabridged/motion@0.3.0'`).
+  NPM package as well (`bin/yarn add '@unabridged/motion@0.4.0'`).
 rdoc_options: []
 require_paths:
 - lib