motion 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7839c6a006522aecfde98e996d77d5af65d3f50a3472d54a84bb9c59c13b2a88
-  data.tar.gz: 3011e0696be6a98232276b35310953939cca6f88d13e85c253f2004b98cc059e
+  metadata.gz: 63f815dc74ec8255bd6b7b07fae885691253e7903397ec2b6f1e79cc675c7261
+  data.tar.gz: 758239f08e068912a6e213773c0cc3d86338ecec6f738650f19f1a9d83656995
 SHA512:
-  metadata.gz: 7195a8b10a5785ea41b46958b886d06ed8e19cd376879d3c1a1d7c14e5ef7be403df16b55f59d1276c1b7111d4268b6280f8d7326cc3e5f6e31aac555376e6c6
-  data.tar.gz: 3f2df4a07139f7ac39fb2733ae3f7ccaf20d9cffd8a8e7c34b1b7e6dd9112fc69de20129e592fe4dacf7dfff5a0c12f15aab896dcea854ab093c795ab69df71d
+  metadata.gz: dfc01de3b79448af437bc4a0386ab2a9800e75ecb7d0231dc565d2bb6e3a21699fc9d7e6b58932824f0dc9ced1c59ae4426e40b9486198f7d082dcf0a5d7ee68
+  data.tar.gz: 86223b046b0957a69d4d7301a0a6c5d85a51cdacd4b088eaa4b65fdd57643043bde5970aaa5de55fd093257b66f5cd2e06c320b891c02f7ec255ba1b3d7a824b

data/lib/motion/action_cable_extentions.rb

@@ -4,10 +4,16 @@ require "motion"
 
 module Motion
   module ActionCableExtentions
+    autoload :DeclarativeNotifications,
+      "motion/action_cable_extentions/declarative_notifications"
+
     autoload :DeclarativeStreams,
       "motion/action_cable_extentions/declarative_streams"
 
     autoload :LogSuppression,
       "motion/action_cable_extentions/log_suppression"
+
+    autoload :Synchronization,
+      "motion/action_cable_extentions/synchronization"
   end
 end

data/lib/motion/action_cable_extentions/declarative_notifications.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "motion"
+
+module Motion
+  module ActionCableExtentions
+    # Provides a `periodically_notify(broadcasts, to:)` API that can be used to
+    # declaratively specify when a handler should be called.
+    module DeclarativeNotifications
+      include Synchronization
+
+      def initialize(*)
+        super
+
+        # The current set of declarative notifications
+        @_declarative_notifications = {}
+
+        # The active timers for the declarative notifications
+        @_declarative_notifications_timers = {}
+
+        # The method we are routing declarative notifications to
+        @_declarative_notifications_target = nil
+      end
+
+      def declarative_notifications
+        @_declarative_notifications
+      end
+
+      def periodically_notify(notifications, via:)
+        (@_declarative_notifications.to_a - notifications.to_a)
+          .each do |notification, _interval|
+            _shutdown_declarative_notifcation_timer(notification)
+          end
+
+        (notifications.to_a - @_declarative_notifications.to_a)
+          .each do |notification, interval|
+            _setup_declarative_notifcation_timer(notification, interval)
+          end
+
+        @_declarative_notifications = notifications
+        @_declarative_notifications_target = via
+      end
+
+      private
+
+      def stop_periodic_timers
+        super
+
+        @_declarative_notifications.clear
+        @_declarative_notifications_timers.clear
+        @_declarative_notifications_target = nil
+      end
+
+      # The only public interface in ActionCable for defining periodic timers is
+      # exposed at the class level. Looking at the source though, it is easy to
+      # see that new timers can be setup with `start_periodic_timer`. To ensure
+      # that we do not leak any timers, it is important to store these instances
+      # in `active_periodic_timers` so that ActionCable cleans them up for us
+      # when the channel shuts down. Also, periodic timers are not supported by
+      # the testing adapter, so we have to skip all of this in unit tests (it
+      # _will_ be covered in systems tests though).
+      #
+      # See `ActionCable::Channel::PeriodicTimers` for details.
+      def _setup_declarative_notifcation_timer(notification, interval)
+        return if connection.is_a?(ActionCable::Channel::ConnectionStub) ||
+          @_declarative_notifications_timers.include?(notification)
+
+        callback = proc do
+          synchronize_entrypoint! do
+            _handle_declarative_notifcation(notification)
+          end
+        end
+
+        timer = start_periodic_timer(callback, every: interval)
+
+        @_declarative_notifications_timers[notification] = timer
+        active_periodic_timers << timer
+      end
+
+      def _shutdown_declarative_notifcation_timer(notification, *)
+        timer = @_declarative_notifications_timers.delete(notification)
+        return unless timer
+
+        timer.shutdown
+        active_periodic_timers.delete(timer)
+      end
+
+      def _handle_declarative_notifcation(notification)
+        return unless @_declarative_notifications_target &&
+          @_declarative_notifications.include?(notification)
+
+        send(@_declarative_notifications_target, notification)
+      end
+    end
+  end
+end

data/lib/motion/action_cable_extentions/declarative_streams.rb

@@ -6,19 +6,13 @@ module Motion
   module ActionCableExtentions
     # Provides a `streaming_from(broadcasts, to:)` API that can be used to
     # declaratively specify what `broadcasts` the channel is interested in
-    # receiving and `to` what method they should be routed. Additionally,
-    # this module extends the "at most one executor at a time" property that
-    # naturally comes with actions to the streams that it sets up as well.
+    # receiving and `to` what method they should be routed.
     module DeclarativeStreams
+      include Synchronization
+
       def initialize(*)
         super
 
-        # Allowing actions to be bound to streams (as this module provides)
-        # introduces the possibiliy of multiple threads accessing user code at
-        # the same time. Protect user code with a Monitor so we only have to
-        # worry about that here.
-        @_declarative_stream_monitor = Monitor.new
-
         # Streams that we are currently interested in
         @_declarative_streams = Set.new
 
@@ -30,19 +24,6 @@ module Motion
         @_declarative_stream_proxies = Set.new
       end
 
-      # Synchronize all ActionCable entry points (after initialization).
-      def subscribe_to_channel(*)
-        @_declarative_stream_monitor.synchronize { super }
-      end
-
-      def unsubscribe_from_channel(*)
-        @_declarative_stream_monitor.synchronize { super }
-      end
-
-      def perform_action(*)
-        @_declarative_stream_monitor.synchronize { super }
-      end
-
       # Clean up declarative streams when all streams are stopped.
       def stop_all_streams
         super
@@ -73,32 +54,17 @@ module Motion
         # TODO: I feel like the fact that we have to specify the coder here is
         # a bug in ActionCable. It should be the default for this karg.
         stream_from(broadcast, coder: ActiveSupport::JSON) do |message|
-          _handle_incoming_broadcast_to_declarative_stream(broadcast, message)
-        rescue Exception => exception # rubocop:disable Lint/RescueException
-          # It is very, very important that we do not allow an exception to
-          # escape here as the internals of ActionCable will stop processing
-          # the broadcast.
-
-          _handle_exception_in_declarative_stream(broadcast, exception)
+          synchronize_entrypoint! do
+            _handle_incoming_broadcast_to_declarative_stream(broadcast, message)
+          end
         end
       end
 
       def _handle_incoming_broadcast_to_declarative_stream(broadcast, message)
-        @_declarative_stream_monitor.synchronize do
-          return unless @_declarative_stream_target &&
-            @_declarative_streams.include?(broadcast)
-
-          send(@_declarative_stream_target, broadcast, message)
-        end
-      end
+        return unless @_declarative_stream_target &&
+          @_declarative_streams.include?(broadcast)
 
-      def _handle_exception_in_declarative_stream(broadcast, exception)
-        logger.error(
-          "There was an exception while handling a broadcast to #{broadcast}" \
-          "on #{self.class}:\n" \
-          "  #{exception.class}: #{exception.message}\n" \
-          "#{exception.backtrace.map { |line| "    #{line}" }.join("\n")}"
-        )
+        send(@_declarative_stream_target, broadcast, message)
       end
     end
   end

data/lib/motion/action_cable_extentions/synchronization.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "motion"
+
+module Motion
+  module ActionCableExtentions
+    module Synchronization
+      def initialize(*)
+        super
+
+        @_monitor = Monitor.new
+      end
+
+      # Additional entrypoints added by other modules should wrap any entry
+      # points that they add with this.
+      def synchronize_entrypoint!(&block)
+        @_monitor.synchronize(&block)
+      end
+
+      # Synchronize all standard ActionCable entry points.
+      def subscribe_to_channel(*)
+        synchronize_entrypoint! { super }
+      end
+
+      def unsubscribe_from_channel(*)
+        synchronize_entrypoint! { super }
+      end
+
+      def perform_action(*)
+        synchronize_entrypoint! { super }
+      end
+    end
+  end
+end

data/lib/motion/channel.rb

@@ -6,6 +6,7 @@ require "motion"
 
 module Motion
   class Channel < ActionCable::Channel::Base
+    include ActionCableExtentions::DeclarativeNotifications
     include ActionCableExtentions::DeclarativeStreams
     include ActionCableExtentions::LogSuppression
 
@@ -56,10 +57,19 @@ module Motion
       synchronize
     end
 
+    def process_periodic_timer(timer)
+      component_connection.process_periodic_timer(timer)
+      synchronize
+    end
+
     private
 
     def synchronize
-      streaming_from(component_connection.broadcasts, to: :process_broadcast)
+      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))

data/lib/motion/component.rb

@@ -7,6 +7,7 @@ require "motion"
 require "motion/component/broadcasts"
 require "motion/component/lifecycle"
 require "motion/component/motions"
+require "motion/component/periodic_timers"
 require "motion/component/rendering"
 
 module Motion
@@ -16,6 +17,7 @@ module Motion
     include Broadcasts
     include Lifecycle
     include Motions
+    include PeriodicTimers
     include Rendering
   end
 end

data/lib/motion/component/broadcasts.rb

@@ -3,6 +3,7 @@
 require "active_support/concern"
 require "active_support/core_ext/class/attribute"
 require "active_support/core_ext/object/to_param"
+require "active_support/core_ext/hash/except"
 
 require "motion"
 
@@ -11,6 +12,31 @@ module Motion
     module Broadcasts
       extend ActiveSupport::Concern
 
+      # Analogous to `module_function` (available on both class and instance)
+      module ModuleFunctions
+        def stream_from(broadcast, handler)
+          self._broadcast_handlers =
+            _broadcast_handlers.merge(broadcast.to_s => handler.to_sym).freeze
+        end
+
+        def stop_streaming_from(broadcast)
+          self._broadcast_handlers =
+            _broadcast_handlers.except(broadcast.to_s).freeze
+        end
+
+        def stream_for(model, handler)
+          stream_from(broadcasting_for(model), handler)
+        end
+
+        def stop_streaming_for(model)
+          stop_streaming_from(broadcasting_for(model))
+        end
+
+        def broadcasts
+          _broadcast_handlers.keys
+        end
+      end
+
       included do
         class_attribute :_broadcast_handlers,
           instance_reader: false,
@@ -20,26 +46,19 @@ module Motion
       end
 
       class_methods do
+        include ModuleFunctions
+
         def broadcast_to(model, message)
           ActionCable.server.broadcast(broadcasting_for(model), message)
         end
 
-        def stream_from(broadcast, handler)
-          self._broadcast_handlers =
-            _broadcast_handlers.merge(broadcast.to_s => handler.to_sym).freeze
-        end
-
-        def stream_for(model, handler)
-          stream_from(broadcasting_for(model), handler)
-        end
-
         def broadcasting_for(model)
           serialize_broadcasting([name, model])
         end
 
         private
 
-        # Taken from ActionCable::Channel::Broadcasting
+        # This definition is copied from ActionCable::Channel::Broadcasting
         def serialize_broadcasting(object)
           if object.is_a?(Array)
             object.map { |m| serialize_broadcasting(m) }.join(":")
@@ -51,31 +70,24 @@ module Motion
         end
       end
 
-      def broadcasts
-        _broadcast_handlers.keys
-      end
+      include ModuleFunctions
 
       def process_broadcast(broadcast, message)
         return unless (handler = _broadcast_handlers[broadcast])
 
-        send(handler, message)
-      end
-
-      def broadcast_to(model, message)
-        self.class.broadcast_to(model, message)
+        if method(handler).arity.zero?
+          send(handler)
+        else
+          send(handler, message)
+        end
       end
 
-      def stream_from(broadcast, handler)
-        self._broadcast_handlers =
-          _broadcast_handlers.merge(broadcast.to_s => handler.to_sym).freeze
-      end
+      private
 
-      def stream_for(model, handler)
-        stream_from(self.class.broadcasting_for(model), handler)
+      def broadcasting_for(model)
+        self.class.broadcasting_for(model)
       end
 
-      private
-
       attr_writer :_broadcast_handlers
 
       def _broadcast_handlers

data/lib/motion/component/motions.rb

@@ -2,6 +2,7 @@
 
 require "active_support/concern"
 require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/hash/except"
 
 require "motion"
 
@@ -10,6 +11,23 @@ module Motion
     module Motions
       extend ActiveSupport::Concern
 
+      # Analogous to `module_function` (available on both class and instance)
+      module ModuleFunctions
+        def map_motion(motion, handler = motion)
+          self._motion_handlers =
+            _motion_handlers.merge(motion.to_s => handler.to_sym).freeze
+        end
+
+        def unmap_motion(motion)
+          self._motion_handlers =
+            _motion_handlers.except(motion.to_s).freeze
+        end
+
+        def motions
+          _motion_handlers.keys
+        end
+      end
+
       included do
         class_attribute :_motion_handlers,
           instance_reader: false,
@@ -19,15 +37,10 @@ module Motion
       end
 
       class_methods do
-        def map_motion(motion, handler = motion)
-          self._motion_handlers =
-            _motion_handlers.merge(motion.to_s => handler.to_sym).freeze
-        end
+        include ModuleFunctions
       end
 
-      def motions
-        _motion_handlers.keys
-      end
+      include ModuleFunctions
 
       def process_motion(motion, event = nil)
         unless (handler = _motion_handlers[motion])
@@ -41,11 +54,6 @@ module Motion
         end
       end
 
-      def map_motion(motion, handler = motion)
-        self._motion_handlers =
-          _motion_handlers.merge(motion.to_s => handler.to_sym).freeze
-      end
-
       private
 
       attr_writer :_motion_handlers

data/lib/motion/component/periodic_timers.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/hash/except"
+
+require "motion"
+
+module Motion
+  module Component
+    module PeriodicTimers
+      extend ActiveSupport::Concern
+
+      # Analogous to `module_function` (available on both class and instance)
+      module ModuleFunctions
+        def every(interval, handler, name: handler)
+          periodic_timer(name, handler, every: interval)
+        end
+
+        def periodic_timer(name, handler = name, every:)
+          self._periodic_timers =
+            _periodic_timers.merge(name.to_s => [handler.to_sym, every]).freeze
+        end
+
+        def stop_periodic_timer(name)
+          self._periodic_timers =
+            _periodic_timers.except(name.to_s).freeze
+        end
+
+        def periodic_timers
+          _periodic_timers.transform_values { |_handler, interval| interval }
+        end
+      end
+
+      included do
+        class_attribute :_periodic_timers,
+          instance_reader: false,
+          instance_writer: false,
+          instance_predicate: false,
+          default: {}.freeze
+      end
+
+      class_methods do
+        include ModuleFunctions
+      end
+
+      include ModuleFunctions
+
+      def process_periodic_timer(name)
+        return unless (handler, _interval = _periodic_timers[name])
+
+        send(handler)
+      end
+
+      private
+
+      attr_writer :_periodic_timers
+
+      def _periodic_timers
+        return @_periodic_timers if defined?(@_periodic_timers)
+
+        self.class._periodic_timers
+      end
+    end
+  end
+end

data/lib/motion/component/rendering.rb

@@ -24,16 +24,7 @@ module Motion
       # * If it doesn't change every time the component's state changes,
       #   things may fall out of sync unless you also call `#rerender!`
       def render_hash
-        # TODO: This implementation is trivially correct, but very wasteful.
-        #
-        # Is something with Ruby's built-in `hash` Good Enough(TM)?
-        #
-        #  instance_variables
-        #    .map { |ivar| instance_variable_get(ivar).hash }
-        #    .reduce(0, &:^)
-
-        key, _state = Motion.serializer.serialize(self)
-        key
+        Motion.serializer.weak_digest(self)
       end
 
       def render_in(view_context)

data/lib/motion/component_connection.rb

@@ -64,6 +64,18 @@ module Motion
       false
     end
 
+    def process_periodic_timer(timer)
+      timing("Proccessed periodic timer #{timer}") do
+        component.process_periodic_timer timer
+      end
+
+      true
+    rescue => error
+      handle_error(error, "processing periodic timer #{timer}")
+
+      false
+    end
+
     def if_render_required(&block)
       timing("Rendered") do
         next_render_hash = component.render_hash
@@ -83,6 +95,10 @@ module Motion
       component.broadcasts
     end
 
+    def periodic_timers
+      component.periodic_timers
+    end
+
     private
 
     attr_reader :log_helper

data/lib/motion/event.rb

@@ -34,8 +34,16 @@ module Motion
       @target = Motion::Element.from_raw(raw["target"])
     end
 
+    def current_target
+      return @current_target if defined?(@current_target)
+
+      @current_target = Motion::Element.from_raw(raw["currentTarget"])
+    end
+
+    alias element current_target
+
     def form_data
-      target&.form_data
+      element&.form_data
     end
   end
 end

data/lib/motion/markup_transformer.rb

@@ -21,6 +21,8 @@ module Motion
     end
 
     def add_state_to_html(component, html)
+      return html if html.blank?
+
       key, state = serializer.serialize(component)
 
       transform_root(component, html) do |root|
@@ -35,7 +37,9 @@ module Motion
       fragment = Nokogiri::HTML::DocumentFragment.parse(html)
       root, *unexpected_others = fragment.children
 
-      raise MultipleRootsError, component if unexpected_others.any?(&:present?)
+      if !root || unexpected_others.any?(&:present?)
+        raise MultipleRootsError, component
+      end
 
       yield root
 

data/lib/motion/serializer.rb

@@ -32,6 +32,10 @@ module Motion
       @revision = revision
     end
 
+    def weak_digest(component)
+      dump(component).hash
+    end
+
     def serialize(component)
       state = dump(component)
       state_with_revision = "#{revision}#{NULL_BYTE}#{state}"

data/lib/motion/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alec Larsen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -55,13 +55,16 @@ files:
 - lib/generators/motion/templates/motion.rb
 - lib/motion.rb
 - lib/motion/action_cable_extentions.rb
+- lib/motion/action_cable_extentions/declarative_notifications.rb
 - 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/channel.rb
 - lib/motion/component.rb
 - lib/motion/component/broadcasts.rb
 - lib/motion/component/lifecycle.rb
 - lib/motion/component/motions.rb
+- lib/motion/component/periodic_timers.rb
 - lib/motion/component/rendering.rb
 - lib/motion/component_connection.rb
 - lib/motion/configuration.rb
@@ -82,7 +85,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.2.0'`).
+  NPM package as well (`bin/yarn add '@unabridged/motion@0.2.1'`).
 rdoc_options: []
 require_paths:
 - lib