motion 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f50ecf7f319478fcd72dca2dd6e55c36a67d803e6235d24c39ac36537528bb88
-  data.tar.gz: 10c88dabd3104c7351a5d2eeb6623564214171c1b26fdf9b25aca3d8297c2a46
+  metadata.gz: 7839c6a006522aecfde98e996d77d5af65d3f50a3472d54a84bb9c59c13b2a88
+  data.tar.gz: 3011e0696be6a98232276b35310953939cca6f88d13e85c253f2004b98cc059e
 SHA512:
-  metadata.gz: 31a107b75a0e553febfec1f0b93cc878c4c727f5f61ba1d0e39b89c9c7c1a7b45d5ecf188a49b9e1293c2f4056974afb755c1cb2cd4594895e95c3166e38563f
-  data.tar.gz: 7ad03d82e4a4ca05338368db8cda1b12813662f3f3fe2937f576baeb47b8b7c99b41b5bfc4ec9b11eb42facbce155990b7f278c6171603b0bf972b9adb641c52
+  metadata.gz: 7195a8b10a5785ea41b46958b886d06ed8e19cd376879d3c1a1d7c14e5ef7be403df16b55f59d1276c1b7111d4268b6280f8d7326cc3e5f6e31aac555376e6c6
+  data.tar.gz: 3f2df4a07139f7ac39fb2733ae3f7ccaf20d9cffd8a8e7c34b1b7e6dd9112fc69de20129e592fe4dacf7dfff5a0c12f15aab896dcea854ab093c795ab69df71d

data/lib/generators/motion/component_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+module Motion
+  module Generators
+    class ComponentGenerator < Rails::Generators::NamedBase
+      desc "Creates a Motion-enabled component in your application."
+
+      argument :attributes, type: :array, default: [], banner: "attribute"
+
+      def generate_component
+        generate "component", class_name, *attributes.map(&:name)
+      end
+
+      def include_motion
+        inject_into_class component_path, "#{class_name}Component" do
+          "  include Motion::Component\n\n"
+        end
+      end
+
+      private
+
+      def component_path
+        @component_path ||=
+          File.join("app/components", class_path, "#{file_name}_component.rb")
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

data/lib/generators/motion/install_generator.rb

@@ -16,10 +16,17 @@ module Motion
         )
       end
 
-      def copy_stimlus_controller
+      def copy_client_initializer
         template(
-          "motion_controller.js",
-          "app/javascript/controllers/motion_controller.js"
+          "motion.js",
+          "app/javascript/motion.js"
+        )
+      end
+
+      def add_client_to_application_pack
+        append_to_file(
+          "app/javascript/packs/application.js",
+          'import "motion"'
         )
       end
     end

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

@@ -0,0 +1,30 @@
+import { createClient } from '@unabridged/motion';
+import consumer from './channels/consumer';
+
+export default createClient({
+
+  // To avoid creating a second websocket, make sure to reuse the application's
+  // ActionCable consumer. If you are not otherwise using ActionCable, you can
+  // remove this line and the corresponding import.
+  consumer,
+
+  // 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",
+
+  // This function will be called for every motion, and the return value will be
+  // made available at `Motion::Event#extra_data`:
+  //
+  //    getExtraDataForEvent(event) {},
+  //
+
+  // 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",
+  //
+
+});

data/lib/generators/motion/templates/motion.rb

@@ -1,22 +1,43 @@
 # frozen_string_literal: true
 
-# TODO: Explain all the options.
 Motion.configure do |config|
-  # config.secret = Rails.application.key_generator.generate_key "motion:secret"
+  # Motion needs to be able to uniquely identify the version of the running
+  # version of your application. By default, the commit hash from git is used,
+  # but depending on your deployment, this may not be available in production.
+  #
+  # If you are sure that git is available in your production enviorment, you can
+  # uncomment this line:
+  #
+  #     config.revision = `git rev-parse HEAD`.chomp
+  #
+  # If git is not available in your production enviorment, you must identify
+  # your application version some other way:
+  #
+  #     config.revision =
+  #       ENV.fetch("MY_DEPLOYMENT_NUMBER") { `git rev-parse HEAD`.chomp }
+  #
+  # Using a value that does not change on every deployment will likely lead to
+  # confusing errors if components are connected during a deployment.
 
-  # config.revision = `git rev-parse HEAD`.chomp
+  # This proc will be invoked by Motion in order to create a renderer for each
+  # websocket connection. By default, your `ApplicationController` will be used
+  # and the session/cookies **as they were when the websocket was first open**
+  # will be available:
+  #
+  #     config.renderer_for_connection_proc = ->(websocket_connection) do
+  #       ApplicationController.renderer.new(
+  #         websocket_connection.env.slice(
+  #           Rack::HTTP_COOKIE,
+  #           Rack::RACK_SESSION,
+  #         )
+  #       )
+  #     end
 
-  # config.renderer_for_connection_proc = ->(websocket_connection) do
-  #   ApplicationController.renderer.new(
-  #     websocket_connection.env.slice(
-  #       Rack::HTTP_COOKIE,
-  #       Rack::RACK_SESSION,
-  #     )
-  #   )
-  # end
-
-  # config.stimulus_controller_identifier = "motion"
-  # config.key_attribute = "data-motion-key"
-  # config.state_attribute = "data-motion-state"
-  # config.motion_attribute = "data-motion"
+  # The data attributes used by Motion can be customized, but these values must
+  # also be updated in the Ruby initializer:
+  #
+  #     config.key_attribute = "data-motion-key"
+  #     config.state_attribute = "data-motion-state"
+  #     config.motion_attribute = "data-motion"
+  #
 end

data/lib/motion/channel.rb

@@ -24,9 +24,7 @@ module Motion
     def subscribed
       state, client_version = params.values_at("state", "version")
 
-      # TODO: This is too restrictive. Introduce a protocol version and support
-      # older versions of the client that have a compatible protocol.
-      unless Motion::VERSION == client_version
+      if Gem::Version.new(Motion::VERSION) < Gem::Version.new(client_version)
         raise IncompatibleClientError.new(Motion::VERSION, client_version)
       end
 

data/lib/motion/configuration.rb

@@ -95,7 +95,6 @@ module Motion
       end
     end
 
-    option(:stimulus_controller_identifier) { "motion" }
     option(:key_attribute) { "data-motion-key" }
     option(:state_attribute) { "data-motion-state" }
 

data/lib/motion/errors.rb

@@ -117,15 +117,18 @@ module Motion
   end
 
   class IncompatibleClientError < Error
-    attr_reader :expected_version,
-      :actual_version
+    attr_reader :server_version, :client_version
 
-    def initialize(expected_version, actual_version)
+    def initialize(server_version, client_version)
       super(<<~MSG)
-        Expected client version #{expected_version}, but got #{actual_version}.
+        The client version (#{client_version}) is newer than the server version
+        (#{server_version}). Please upgrade the Motion gem.
 
-        Fix: Run `bin/yarn add @unabridged/motion@#{expected_version}`
+        Fix: Run `bundle update motion`
       MSG
+
+      @server_version = server_version
+      @client_version = client_version
     end
   end
 

data/lib/motion/markup_transformer.rb

@@ -6,22 +6,16 @@ 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
@@ -30,12 +24,6 @@ module Motion
       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
@@ -53,13 +41,5 @@ module Motion
 
       fragment.to_html.html_safe
     end
-
-    def values(*values, delimiter: " ")
-      values
-        .compact
-        .flat_map { |value| value.split(delimiter) }
-        .uniq
-        .join(delimiter)
-    end
   end
 end

data/lib/motion/railtie.rb

@@ -6,6 +6,7 @@ module Motion
   class MyRailtie < Rails::Railtie
     generators do
       require "generators/motion/install_generator"
+      require "generators/motion/component_generator"
     end
   end
 end

data/lib/motion/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Alec Larsen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -49,9 +49,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/motion/component_generator.rb
 - lib/generators/motion/install_generator.rb
+- lib/generators/motion/templates/motion.js
 - lib/generators/motion/templates/motion.rb
-- lib/generators/motion/templates/motion_controller.js
 - lib/motion.rb
 - lib/motion/action_cable_extentions.rb
 - lib/motion/action_cable_extentions/declarative_streams.rb
@@ -81,7 +82,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.1.2'`).
+  NPM package as well (`bin/yarn add '@unabridged/motion@0.2.0'`).
 rdoc_options: []
 require_paths:
 - lib

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

@@ -1,28 +0,0 @@
-import { Controller } from "@unabridged/motion";
-import consumer from "../channels/consumer";
-
-// If you change the name of this controller (determined by the file name),
-// make sure to update `Motion.config.stimulus_controller_identifier`.
-export default class extends Controller {
-  // To avoid creating a second websocket, make sure to reuse the application's
-  // ActionCable consumer.
-  getConsumer() {
-      return consumer;
-  }
-
-  // It is possible to additionally customize the behavior of the client by
-  // overriding these properties and methods:
-
-  // getExtraDataForEvent(event) {}        // `Motion::Event#extra_data`
-
-  // keyAttribute = "data-motion-key";     // `Motion.config.key_attribute`
-  // stateAttribute = "data-motion-state"; // `Motion.config.state_attribute`
-  // motionAttribute = "data-motion";      // `Motion.config.motion_attribute`
-
-  // beforeConnect() { /* by default, dispatches `motion:before-connect`    */ }
-  // connected()     { /* by default, dispatches `motion:connected`         */ }
-  // connectFailed() { /* by default, dispatches `motion:connect-failed`    */ }
-  // disconnected()  { /* by default, dispatches `motion:disconnected`      */ }
-  // beforeRender()  { /* by default, dispatches `motion:before-render`     */ }
-  // rendered()      { /* by default, dispatches `motion:rendered`          */ }
-}