motion 0.2.0 → 0.4.1

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,44 +89,48 @@ 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
 
@@ -120,12 +138,12 @@ module Motion
     attr_reader :server_version, :client_version
 
     def initialize(server_version, client_version)
-      super(<<~MSG)
-        The client version (#{client_version}) is newer than the server version
-        (#{server_version}). Please upgrade the Motion gem.
-
-        Fix: Run `bundle update motion`
-      MSG
+      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
@@ -136,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,6 +1,7 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require "active_support/core_ext/object/blank"
 
 require "motion"
 
@@ -21,6 +22,8 @@ module Motion
     end
 
     def add_state_to_html(component, html)
+      return if html.blank?
+
       key, state = serializer.serialize(component)
 
       transform_root(component, html) do |root|
@@ -35,7 +38,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/revision_calculator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "digest"
+require "motion"
+
+module Motion
+  class RevisionCalculator
+    attr_reader :revision_paths
+
+    def initialize(revision_paths:)
+      @revision_paths = revision_paths
+    end
+
+    def perform
+      derive_file_hash
+    end
+
+    private
+
+    def derive_file_hash
+      digest = Digest::MD5.new
+
+      files.each do |file|
+        digest << file # include filename as well as contents
+        digest << File.read(file)
+      end
+
+      digest.hexdigest
+    end
+
+    def existent_paths
+      @existent_paths ||=
+        begin
+          revision_paths.all_paths.flat_map(&:existent)
+        rescue
+          raise BadRevisionPathsError
+        end
+    end
+
+    def existent_files(path)
+      Dir["#{path}/**/*", path].reject { |f| File.directory?(f) }.uniq
+    end
+
+    def files
+      @files ||= existent_paths.flat_map { |path| existent_files(path) }.sort
+    end
+  end
+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"
@@ -32,8 +33,12 @@ module Motion
       @revision = revision
     end
 
+    def weak_digest(component)
+      dump(component).hash
+    end
+
     def serialize(component)
-      state = dump(component)
+      state = deflate(dump(component))
       state_with_revision = "#{revision}#{NULL_BYTE}#{state}"
 
       [
@@ -45,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
@@ -66,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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.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-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !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.
@@ -55,13 +69,18 @@ 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/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
 - lib/motion/component/rendering.rb
 - lib/motion/component_connection.rb
 - lib/motion/configuration.rb
@@ -71,6 +90,7 @@ files:
 - lib/motion/log_helper.rb
 - lib/motion/markup_transformer.rb
 - lib/motion/railtie.rb
+- lib/motion/revision_calculator.rb
 - lib/motion/serializer.rb
 - lib/motion/test_helpers.rb
 - lib/motion/version.rb
@@ -82,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.2.0'`).
+  NPM package as well (`bin/yarn add '@unabridged/motion@0.4.1'`).
 rdoc_options: []
 require_paths:
 - lib