motion 0.3.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7645381b6b2749a4a9ba90a15c93916636e1b9edfd7b3a6a1bf7d47429fedb3f
-  data.tar.gz: 46c929b8aa2d1de8c714eb8b8db1db8524aec892576a13ad1582b7fa858565f7
+  metadata.gz: 68e4222065f95cc117a8fc9233e8b421f05cdc8bbb58b966c618b82487723be7
+  data.tar.gz: c9c1927a3ae081faeb6d346246a05e8dbfdc8f2da91185073fdf18d8abf7ab83
 SHA512:
-  metadata.gz: b8c99a480f51e9d818f5d22de3efbf8923155943d1815188e19332c54b8f24b909bc371abc7282d3a9caac754cf1b0aee4bb3193dad75b7f1d86a9112ed13983
-  data.tar.gz: a12e9213ba0ae38cbc5d839ae1408a5aab064be055896300f19a2296ebcd74b49922b96636bc52bd7b7aef62be9868ea47437544938f20facaad45534744bc4e
+  metadata.gz: 218b161a0c04029315fcda296545156ddda990cd6ab98b664c3896ee1d15f93a1092bb1c0f4b50a550b848d5242d929b178fecde05b34b723c5354c016dd00ad
+  data.tar.gz: ed56e7e3f78851fa7e8ee6643a334016d3013ac00c813e766a2f4190d5698f6c976dce5dfef4465e882bcbed3df33aff63b8952687830e30ea61769bc9e9f89c

data/lib/generators/motion/templates/motion.js

@@ -1,5 +1,5 @@
-import { createClient } from '@unabridged/motion';
-import consumer from './channels/consumer';
+import { createClient } from '@unabridged/motion'
+import consumer from './channels/consumer'
 
 export default createClient({
 
@@ -11,7 +11,7 @@ export default createClient({
   // Motion can log information about the lifecycle of components to the
   // browser's console. It is recommended to turn this feature off outside of
   // development.
-  logging: process.env["RAILS_ENV"] === "development",
+  logging: process.env.RAILS_ENV === 'development'
 
   // This function will be called for every motion, and the return value will be
   // made available at `Motion::Event#extra_data`:
@@ -30,8 +30,8 @@ export default createClient({
   // The data attributes used by Motion can be customized, but these values must
   // also be updated in the Ruby initializer:
   //
-  //    keyAttribute: "data-motion-key",
-  //    stateAttribute: "data-motion-state",
-  //    motionAttribute: "data-motion",
+  //    keyAttribute: 'data-motion-key',
+  //    stateAttribute: 'data-motion-state',
+  //    motionAttribute: 'data-motion',
 
-});
+})

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"
@@ -18,41 +19,43 @@ module Motion
   autoload :Serializer, "motion/serializer"
   autoload :TestHelpers, "motion/test_helpers"
 
-  def self.configure(&block)
-    raise AlreadyConfiguredError if @config
+  class << self
+    def configure(&block)
+      raise AlreadyConfiguredError if @config
 
-    @config = Configuration.new(&block)
-  end
+      @config = Configuration.new(&block)
+    end
 
-  def self.config
-    @config ||= Configuration.default
-  end
+    def config
+      @config ||= Configuration.default
+    end
 
-  singleton_class.alias_method :configuration, :config
+    alias_method :configuration, :config
 
-  def self.serializer
-    @serializer ||= Serializer.new
-  end
+    def serializer
+      @serializer ||= Serializer.new
+    end
 
-  def self.markup_transformer
-    @markup_transformer ||= MarkupTransformer.new
-  end
+    def markup_transformer
+      @markup_transformer ||= MarkupTransformer.new
+    end
 
-  def self.build_renderer_for(websocket_connection)
-    config.renderer_for_connection_proc.call(websocket_connection)
-  end
+    def build_renderer_for(websocket_connection)
+      config.renderer_for_connection_proc.call(websocket_connection)
+    end
 
-  def self.notify_error(error, message)
-    config.error_notification_proc&.call(error, message)
-  end
+    def notify_error(error, message)
+      config.error_notification_proc&.call(error, message)
+    end
 
-  # This method only exists for testing. Changing configuration while Motion is
-  # in use is not supported. It is only safe to call this method when no
-  # components are currently mounted.
-  def self.reset_internal_state_for_testing!(new_configuration = nil)
-    @config = new_configuration
-    @serializer = nil
-    @markup_transformer = nil
+    # This method only exists for testing. Changing configuration while Motion
+    # is in use is not supported. It is only safe to call this method when no
+    # components are currently mounted.
+    def reset_internal_state_for_testing!(new_configuration = nil)
+      @config = new_configuration
+      @serializer = nil
+      @markup_transformer = nil
+    end
   end
 end
 

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/broadcasts.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 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"
 
@@ -12,6 +11,9 @@ module Motion
     module Broadcasts
       extend ActiveSupport::Concern
 
+      DEFAULT = {}.freeze
+      private_constant :DEFAULT
+
       # Analogous to `module_function` (available on both class and instance)
       module ModuleFunctions
         def stream_from(broadcast, handler)
@@ -37,14 +39,6 @@ module Motion
         end
       end
 
-      included do
-        class_attribute :_broadcast_handlers,
-          instance_reader: false,
-          instance_writer: false,
-          instance_predicate: false,
-          default: {}.freeze
-      end
-
       class_methods do
         include ModuleFunctions
 
@@ -56,6 +50,15 @@ module Motion
           serialize_broadcasting([name, model])
         end
 
+        attr_writer :_broadcast_handlers
+
+        def _broadcast_handlers
+          return @_broadcast_handlers if defined?(@_broadcast_handlers)
+          return superclass._broadcast_handlers if superclass.respond_to?(:_broadcast_handlers)
+
+          DEFAULT
+        end
+
         private
 
         # This definition is copied from ActionCable::Channel::Broadcasting

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/lifecycle.rb

@@ -105,8 +105,7 @@ module Motion
 
         run_callbacks(:action, &block)
       ensure
-        # `@_action_callback_context = nil` would still appear in the state
-        remove_instance_variable(:@_action_callback_context)
+        @_action_callback_context = nil
       end
     end
   end

data/lib/motion/component/motions.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
-require "active_support/core_ext/class/attribute"
 require "active_support/core_ext/hash/except"
 
 require "motion"
@@ -11,6 +10,9 @@ module Motion
     module Motions
       extend ActiveSupport::Concern
 
+      DEFAULT = {}.freeze
+      private_constant :DEFAULT
+
       # Analogous to `module_function` (available on both class and instance)
       module ModuleFunctions
         def map_motion(motion, handler = motion)
@@ -28,16 +30,17 @@ module Motion
         end
       end
 
-      included do
-        class_attribute :_motion_handlers,
-          instance_reader: false,
-          instance_writer: false,
-          instance_predicate: false,
-          default: {}.freeze
-      end
-
       class_methods do
         include ModuleFunctions
+
+        attr_writer :_motion_handlers
+
+        def _motion_handlers
+          return @_motion_handlers if defined?(@_motion_handlers)
+          return superclass._motion_handlers if superclass.respond_to?(:_motion_handlers)
+
+          DEFAULT
+        end
       end
 
       include ModuleFunctions

data/lib/motion/component/periodic_timers.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
-require "active_support/core_ext/class/attribute"
 require "active_support/core_ext/hash/except"
 
 require "motion"
@@ -11,6 +10,9 @@ module Motion
     module PeriodicTimers
       extend ActiveSupport::Concern
 
+      DEFAULT = {}.freeze
+      private_constant :DEFAULT
+
       # Analogous to `module_function` (available on both class and instance)
       module ModuleFunctions
         def every(interval, handler, name: handler)
@@ -32,16 +34,17 @@ module Motion
         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
+
+        attr_writer :_periodic_timers
+
+        def _periodic_timers
+          return @_periodic_timers if defined?(@_periodic_timers)
+          return superclass._periodic_timers if superclass.respond_to?(:_periodic_timers)
+
+          DEFAULT
+        end
       end
 
       include ModuleFunctions

data/lib/motion/component/rendering.rb

@@ -5,18 +5,37 @@ require "motion"
 module Motion
   module Component
     module Rendering
-      # Use the presence/absence of the ivar instead of true/false to avoid
-      # extra serialized state (Note that in this scheme, the presence of
-      # the ivar will never be serialized).
-      RERENDER_MARKER_IVAR = :@__awaiting_forced_rerender__
-      private_constant :RERENDER_MARKER_IVAR
+      STATE_EXCLUDED_IVARS = %i[
+        @_action_callback_context
+        @_awaiting_forced_rerender
+        @_routes
+
+        @view_context
+        @lookup_context
+        @view_renderer
+        @view_flow
+        @virtual_path
+        @variant
+        @current_template
+        @output_buffer
+
+        @helpers
+        @controller
+        @request
+        @tag_builder
+
+        @asset_resolver_strategies
+        @assets_environment
+      ].freeze
+
+      private_constant :STATE_EXCLUDED_IVARS
 
       def rerender!
-        instance_variable_set(RERENDER_MARKER_IVAR, true)
+        @_awaiting_forced_rerender = true
       end
 
       def awaiting_forced_rerender?
-        instance_variable_defined?(RERENDER_MARKER_IVAR)
+        @_awaiting_forced_rerender
       end
 
       # * This can be overwritten.
@@ -34,7 +53,7 @@ module Motion
           _run_action_callbacks(context: :render) {
             _clear_awaiting_forced_rerender!
 
-            view_context.capture { _without_new_instance_variables { super } }
+            view_context.capture { super }
           }
 
         raise RenderAborted, self if html == false
@@ -45,18 +64,19 @@ module Motion
       private
 
       def _clear_awaiting_forced_rerender!
-        return unless awaiting_forced_rerender?
-
-        remove_instance_variable(RERENDER_MARKER_IVAR)
+        @_awaiting_forced_rerender = false
       end
 
-      def _without_new_instance_variables
-        existing_instance_variables = instance_variables
+      def marshal_dump
+        (instance_variables - STATE_EXCLUDED_IVARS)
+          .map { |ivar| [ivar, instance_variable_get(ivar)] }
+          .to_h
+      end
 
-        yield
-      ensure
-        (instance_variables - existing_instance_variables)
-          .each(&method(:remove_instance_variable))
+      def marshal_load(instance_variables)
+        instance_variables.each do |ivar, value|
+          instance_variable_set(ivar, value)
+        end
       end
     end
   end

data/lib/motion/component_connection.rb

@@ -41,7 +41,7 @@ module Motion
     end
 
     def process_motion(motion, event = nil)
-      timing("Proccessed #{motion}") do
+      timing("Processed #{motion}") do
         component.process_motion(motion, event)
       end
 
@@ -53,7 +53,7 @@ module Motion
     end
 
     def process_broadcast(broadcast, message)
-      timing("Proccessed broadcast to #{broadcast}") do
+      timing("Processed broadcast to #{broadcast}") do
         component.process_broadcast broadcast, message
       end
 
@@ -65,7 +65,7 @@ module Motion
     end
 
     def process_periodic_timer(timer)
-      timing("Proccessed periodic timer #{timer}") do
+      timing("Processed periodic timer #{timer}") do
         component.process_periodic_timer timer
       end
 

data/lib/motion/event.rb

@@ -18,7 +18,7 @@ module Motion
       raw["type"]
     end
 
-    alias name type
+    alias_method :name, :type
 
     def details
       raw.fetch("details", {})
@@ -34,14 +34,12 @@ module Motion
       @target = Motion::Element.from_raw(raw["target"])
     end
 
-    def current_target
-      return @current_target if defined?(@current_target)
+    def element
+      return @element if defined?(@element)
 
-      @current_target = Motion::Element.from_raw(raw["currentTarget"])
+      @element = Motion::Element.from_raw(raw["element"])
     end
 
-    alias element current_target
-
     def form_data
       element&.form_data
     end

data/lib/motion/serializer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "digest"
+require "lz4-ruby"
 require "active_support/message_encryptor"
 
 require "motion"
@@ -37,7 +38,7 @@ module Motion
     end
 
     def serialize(component)
-      state = dump(component)
+      state = deflate(dump(component))
       state_with_revision = "#{revision}#{NULL_BYTE}#{state}"
 
       [
@@ -49,7 +50,7 @@ module Motion
     def deserialize(serialized_component)
       state_with_revision = decrypt_and_verify(serialized_component)
       serialized_revision, state = state_with_revision.split(NULL_BYTE, 2)
-      component = load(state)
+      component = load(inflate(state))
 
       if revision == serialized_revision
         component
@@ -70,6 +71,14 @@ module Motion
       Marshal.load(state)
     end
 
+    def deflate(dumped_component)
+      LZ4.compress(dumped_component)
+    end
+
+    def inflate(deflated_state)
+      LZ4.uncompress(deflated_state)
+    end
+
     def encrypt_and_sign(cleartext)
       encryptor.encrypt_and_sign(cleartext)
     end

data/lib/motion/test_helpers.rb

@@ -16,14 +16,18 @@ module Motion
       component.motions.include?(motion_name.to_s)
     end
 
-    def run_motion(component, motion_name)
+    def run_motion(component, motion_name, event = motion_event)
       if block_given?
         c = component.dup
-        c.process_motion(motion_name.to_s)
+        c.process_motion(motion_name.to_s, event)
         yield c
       else
-        component.process_motion(motion_name.to_s)
+        component.process_motion(motion_name.to_s, event)
       end
     end
+
+    def motion_event(attributes = {})
+      Motion::Event.new(ActiveSupport::JSON.decode(attributes.to_json))
+    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.4"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: motion
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Alec Larsen
 - Drew Ulmer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -31,14 +31,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: lz4-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
 description: |
   Motion extends Github's `view_component` to allow you to build reactive,
   real-time frontend UI components in your Rails application using pure Ruby.
@@ -59,9 +73,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 +102,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.4'`).
 rdoc_options: []
 require_paths:
 - lib
@@ -94,15 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Reactive frontend UI components for Rails in pure Ruby.
 test_files: []