motion 0.1.2 → 0.4.0

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
@@ -24,42 +33,42 @@ 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)
         raise BlockNotAllowedError, self if block_given?
-        clear_awaiting_forced_rerender!
 
-        html = view_context.capture { without_new_instance_variables { super } }
+        html =
+          _run_action_callbacks(context: :render) {
+            _clear_awaiting_forced_rerender!
+
+            view_context.capture { _without_new_instance_variables { super } }
+          }
+
+        raise RenderAborted, self if html == false
 
         Motion.markup_transformer.add_state_to_html(self, html)
       end
 
       private
 
-      def clear_awaiting_forced_rerender!
+      def _clear_awaiting_forced_rerender!
         return unless awaiting_forced_rerender?
 
         remove_instance_variable(RERENDER_MARKER_IVAR)
       end
 
-      def without_new_instance_variables
+      def _without_new_instance_variables
         existing_instance_variables = instance_variables
 
         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/component_connection.rb

@@ -24,13 +24,13 @@ module Motion
       timing("Connected") do
         @render_hash = component.render_hash
 
-        component.connected
+        component.process_connect
       end
     end
 
     def close
       timing("Disconnected") do
-        component.disconnected
+        component.process_disconnect
       end
 
       true
@@ -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/configuration.rb

@@ -59,18 +59,23 @@ module Motion
       Rails.application.key_generator.generate_key("motion:secret")
     end
 
+    option :revision_paths do
+      require "rails"
+
+      Rails.application.config.paths.dup.tap do |paths|
+        paths.add "bin", glob: "*"
+        paths.add "Gemfile.lock"
+      end
+    end
+
     option :revision do
-      warn <<~MSG # TODO: Better message (Focus on "How do I fix this?")
-        Motion is automatically inferring the application's revision from git.
-        Depending on your deployment, this may not work for you in production.
-        If it does, add "config.revision = `git rev-parse HEAD`.chomp" to your
-        Motion initializer. If it does not, do something else (probably read an
-        env var or something).
-      MSG
-
-      `git rev-parse HEAD`.chomp
+      RevisionCalculator.new(revision_paths: revision_paths).perform
     end
 
+    # TODO: Is this always the correct key?
+    WARDEN_ENV = "warden"
+    private_constant :WARDEN_ENV
+
     option :renderer_for_connection_proc do
       ->(websocket_connection) do
         require "rack"
@@ -89,13 +94,15 @@ module Motion
         controller.renderer.new(
           websocket_connection.env.slice(
             Rack::HTTP_COOKIE,
-            Rack::RACK_SESSION
+            Rack::RACK_SESSION,
+            WARDEN_ENV
           )
         )
       end
     end
 
-    option(:stimulus_controller_identifier) { "motion" }
+    option(:error_notification_proc) { nil }
+
     option(:key_attribute) { "data-motion-key" }
     option(:state_attribute) { "data-motion-state" }
 

data/lib/motion/errors.rb

@@ -10,6 +10,7 @@ module Motion
 
     def initialize(component, message = nil)
       super(message)
+
       @component = component
     end
   end
@@ -20,13 +21,13 @@ module Motion
     attr_reader :motion
 
     def initialize(component, motion)
-      super(component, <<~MSG)
-        No component motion handler mapped for motion '#{motion}' in component #{component.class}.
-
-        Fix: Add the following to #{component.class}:
-
-        map_motion :#{motion}
-      MSG
+      super(
+        component,
+        "No component motion handler mapped for motion `#{motion}` in " \
+        "component `#{component.class}`.\n" \
+        "\n" \
+        "Hint: Consider adding `map_motion :#{motion}` to `#{component.class}`."
+      )
 
       @motion = motion
     end
@@ -34,20 +35,32 @@ module Motion
 
   class BlockNotAllowedError < ComponentRenderingError
     def initialize(component)
-      super(component, <<~MSG)
-        Motion does not support rendering with a block.
-
-        Fix: Use a plain component and wrap with a motion component.
-      MSG
+      super(
+        component,
+        "Motion does not support rendering with a block.\n" \
+        "\n" \
+        "Hint: Try wrapping a plain component with a motion component."
+      )
     end
   end
 
   class MultipleRootsError < ComponentRenderingError
     def initialize(component)
-      super(component, <<~MSG)
-        The template for #{component.class} can only have one root element.
+      super(
+        component,
+        "The template for #{component.class} can only have one root " \
+        "element.\n" \
+        "\n" \
+        "Hint: Wrap all elements in a single element, such as `<div>` or " \
+        "`<section>`."
+      )
+    end
+  end
 
-        Fix: Wrap all elements in a single element, such as <div> or <section>.
+  class RenderAborted < ComponentRenderingError
+    def initialize(component)
+      super(component, <<~MSG)
+        Rendering #{component.class} was aborted by a callback.
       MSG
     end
   end
@@ -56,18 +69,19 @@ module Motion
 
   class UnrepresentableStateError < InvalidComponentStateError
     def initialize(component, cause)
-      super(component, <<~MSG)
-        Some state prevented #{component.class} from being serialized into a
-        string. Motion components must be serializable using Marshal.dump. Many
-        types of objects are not serializable including procs, references to
-        anonymous classes, and more. See the documentation for Marshal.dump for
-        more information.
-
-        Fix: Ensure that any exotic state variables in #{component.class} are
-        removed or replaced.
-
-        The specific (but probably useless) error from Marshal was: #{cause}
-      MSG
+      super(
+        component,
+        "Some state prevented `#{component.class}` from being serialized " \
+        "into a string. Motion components must be serializable using " \
+        "`Marshal.dump`. Many types of objects are not serializable " \
+        "including procs, references to anonymous classes, and more. See the " \
+        "documentation for `Marshal.dump` for more information.\n" \
+        "\n" \
+        "The specific error from `Marshal.dump` was: #{cause}\n" \
+        "\n" \
+        "Hint: Ensure that any exotic state variables in " \
+        "`#{component.class}` are removed or replaced."
+      )
     end
   end
 
@@ -75,57 +89,64 @@ module Motion
 
   class InvalidSerializedStateError < SerializedComponentError
     def initialize
-      super(<<~MSG)
-        The serialized state of your component is not valid.
-
-        Fix: Ensure that you have not tampered with the DOM.
-      MSG
+      super(
+        "The serialized state of your component is not valid.\n" \
+        "\n" \
+        "Hint: Ensure that you have not tampered with the contents of data " \
+        "attributes added by Motion in the DOM or changed the value of " \
+        "`Motion.config.secret`."
+      )
     end
   end
 
-  class IncorrectRevisionError < SerializedComponentError
-    attr_reader :expected_revision,
-      :actual_revision
-
-    def initialize(expected_revision, actual_revision)
-      super(<<~MSG)
-        Cannot mount a component from another version of the application.
-
-        Expected revision `#{expected_revision}`;
-        Got `#{actual_revision}`
-
-        Read more: https://github.com/unabridged/motion/wiki/IncorrectRevisionError
-
-        Fix:
-          * Avoid tampering with Motion DOM elements and data attributes (e.g. data-motion-state).
-          * In production, enforce a page refresh for pages with Motion components on deploy.
-      MSG
-
-      @expected_revision = expected_revision
-      @actual_revision = actual_revision
+  class UpgradeNotImplementedError < ComponentError
+    attr_reader :previous_revision,
+      :current_revision
+
+    def initialize(component, previous_revision, current_revision)
+      super(
+        component,
+        "Cannot upgrade `#{component.class}` from a previous revision of the " \
+        "application (#{previous_revision}) to the current revision of the " \
+        "application (#{current_revision})\n" \
+        "\n" \
+        "By default, Motion does not allow components from other revisions " \
+        "of the application to be mounted because new code with old state " \
+        "can lead to unpredictable and unsafe behavior.\n" \
+        "\n" \
+        "Hint: If you would like to allow this component to surive " \
+        "deployments, consider providing an alternative implimentation for " \
+        "`#{component.class}.upgrade_from`."
+      )
+
+      @previous_revision = previous_revision
+      @current_revision = current_revision
     end
   end
 
   class AlreadyConfiguredError < Error
     def initialize
-      super(<<~MSG)
-        Motion is already configured.
-
-        Fix: Move all Motion config to config/initializers/motion.rb.
-      MSG
+      super(
+        "Motion is already configured.\n" \
+        "\n" \
+        "Hint: Move all Motion config to `config/initializers/motion.rb`."
+      )
     end
   end
 
   class IncompatibleClientError < Error
-    attr_reader :expected_version,
-      :actual_version
-
-    def initialize(expected_version, actual_version)
-      super(<<~MSG)
-        Expected client version #{expected_version}, but got #{actual_version}.
-
-        Fix: Run `bin/yarn add @unabridged/motion@#{expected_version}`
-      MSG
+    attr_reader :server_version, :client_version
+
+    def initialize(server_version, client_version)
+      super(
+        "The client version (#{client_version}) is newer than the server " \
+        "version (#{server_version}). Please upgrade the Motion gem.\n" \
+        "\n" \
+        "Hint: Run `bundle add motion --version \">= #{client_version}\"`."
+      )
+
+      @server_version = server_version
+      @client_version = client_version
     end
   end
 
@@ -133,16 +154,26 @@ module Motion
     attr_reader :minimum_bytes
 
     def initialize(minimum_bytes)
-      super(<<~MSG)
-        The secret that you provided is not long enough. It must have at least
-        #{minimum_bytes} bytes.
-      MSG
+      super(
+        "The secret that you provided is not long enough. It must be at " \
+        "least #{minimum_bytes} bytes long."
+      )
     end
   end
 
   class BadRevisionError < Error
     def initialize
-      super("The revision cannot contain a NULL byte")
+      super("The revision cannot contain a NULL byte.")
+    end
+  end
+
+  class BadRevisionPathsError < Error
+    def initialize
+      super(
+        "Revision paths must be a `Rails::Paths::Root` object or an object " \
+        "that responds to `all_paths.flat_map(&:existent)` and returns an " \
+        "Array of strings representing full paths."
+      )
     end
   end
 end

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

@@ -29,6 +29,8 @@ module Motion
       error_info = error ? ":\n#{indent(format_exception(error))}" : ""
 
       logger.error("[#{tag}] #{message}#{error_info}")
+
+      Motion.notify_error(error, message)
     end
 
     def info(message)

data/lib/motion/markup_transformer.rb

@@ -1,41 +1,32 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require "active_support/core_ext/object/blank"
 
 require "motion"
 
 module Motion
   class MarkupTransformer
-    STIMULUS_CONTROLLER_ATTRIBUTE = "data-controller"
-
     attr_reader :serializer,
-      :stimulus_controller_identifier,
       :key_attribute,
       :state_attribute
 
     def initialize(
       serializer: Motion.serializer,
-      stimulus_controller_identifier:
-        Motion.config.stimulus_controller_identifier,
       key_attribute: Motion.config.key_attribute,
       state_attribute: Motion.config.state_attribute
     )
       @serializer = serializer
-      @stimulus_controller_identifier = stimulus_controller_identifier
       @key_attribute = key_attribute
       @state_attribute = state_attribute
     end
 
     def add_state_to_html(component, html)
+      return if html.blank?
+
       key, state = serializer.serialize(component)
 
       transform_root(component, html) do |root|
-        root[STIMULUS_CONTROLLER_ATTRIBUTE] =
-          values(
-            stimulus_controller_identifier,
-            root[STIMULUS_CONTROLLER_ATTRIBUTE]
-          )
-
         root[key_attribute] = key
         root[state_attribute] = state
       end
@@ -47,19 +38,13 @@ 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
 
       fragment.to_html.html_safe
     end
-
-    def values(*values, delimiter: " ")
-      values
-        .compact
-        .flat_map { |value| value.split(delimiter) }
-        .uniq
-        .join(delimiter)
-    end
   end
 end