stimulus_reflex 3.5.0.pre6 → 3.5.0.pre9

data/rollup.config.js

@@ -0,0 +1,85 @@
+import resolve from '@rollup/plugin-node-resolve'
+import commonjs from '@rollup/plugin-commonjs'
+import json from '@rollup/plugin-json'
+import { terser } from 'rollup-plugin-terser'
+
+const pretty = () => {
+  return terser({
+    mangle: false,
+    compress: false,
+    format: {
+      beautify: true,
+      indent_level: 2
+    }
+  })
+}
+
+const minify = () => {
+  return terser({
+    mangle: true,
+    compress: true
+  })
+}
+
+const esConfig = {
+  format: 'es',
+  inlineDynamicImports: true
+}
+
+const umdConfig = {
+  name: 'StimulusReflex',
+  format: 'umd',
+  exports: 'named',
+  globals: {
+    morphdom: 'morphdom',
+    cable_ready: 'CableReady',
+    '@hotwired/stimulus': 'Stimulus'
+  }
+}
+
+const distFolders = ['dist', 'app/assets/javascripts']
+
+const output = distFolders
+  .map(distFolder => [
+    {
+      ...umdConfig,
+      file: `${distFolder}/stimulus_reflex.umd.js`,
+      plugins: [pretty()]
+    },
+    {
+      ...umdConfig,
+      file: `${distFolder}/stimulus_reflex.umd.min.js`,
+      sourcemap: true,
+      plugins: [pretty()]
+    },
+    {
+      ...esConfig,
+      file: `${distFolder}/stimulus_reflex.js`,
+      format: 'es',
+      plugins: [pretty()]
+    },
+    {
+      ...esConfig,
+      file: `${distFolder}/stimulus_reflex.min.js`,
+      sourcemap: true,
+      plugins: [minify()]
+    }
+  ])
+  .flat()
+
+export default [
+  {
+    external: [
+      'morphdom',
+      '@hotwired/stimulus',
+      'cable_ready',
+      '@rails/actioncable'
+    ],
+    input: 'javascript/index.js',
+    output,
+    plugins: [commonjs(), resolve(), json()],
+    watch: {
+      include: 'javascript/**'
+    }
+  }
+]

data/stimulus_reflex.gemspec

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require File.expand_path("lib/stimulus_reflex/version", __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name = "stimulus_reflex"
+  gem.license = "MIT"
+  gem.version = StimulusReflex::VERSION
+  gem.authors = ["Nathan Hopkins"]
+  gem.email = ["natehop@gmail.com"]
+  gem.homepage = "https://github.com/stimulusreflex/stimulus_reflex"
+  gem.summary = "Build reactive applications with the Rails tooling you already know and love."
+  gem.post_install_message = <<~MESSAGE
+    Finish installation by running:
+
+    rake stimulus_reflex:install
+
+    Get support for StimulusReflex and CableReady on Discord:
+
+    https://discord.gg/stimulus-reflex
+
+  MESSAGE
+
+  gem.metadata = {
+    "bug_tracker_uri" => "https://github.com/stimulusreflex/stimulus_reflex/issues",
+    "changelog_uri" => "https://github.com/stimulusreflex/stimulus_reflex/CHANGELOG.md",
+    "documentation_uri" => "https://docs.stimulusreflex.com",
+    "homepage_uri" => gem.homepage,
+    "source_code_uri" => gem.homepage
+  }
+
+  gem.files = Dir[
+    "lib/**/*.rb",
+    "app/**/*.rb",
+    "app/assets/javascripts/*",
+    "bin/*",
+    "[A-Z]*"
+  ]
+
+  gem.test_files = Dir["test/**/*.rb"]
+
+  gem.required_ruby_version = ">= 2.7.0"
+
+  rails_version = ">= 5.2"
+  gem.add_dependency "actioncable", rails_version
+  gem.add_dependency "actionpack", rails_version
+  gem.add_dependency "actionview", rails_version
+  gem.add_dependency "activesupport", rails_version
+  gem.add_dependency "railties", rails_version
+
+  gem.add_dependency "cable_ready", ">= 5.0.0.pre9"
+  gem.add_dependency "nokogiri"
+  gem.add_dependency "rack"
+  gem.add_dependency "redis"
+
+  gem.add_development_dependency "bundler", "~> 2.0"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "rails", rails_version
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "standardrb", "~> 1.0"
+end

data/test/broadcasters/broadcaster_test_case.rb

@@ -34,6 +34,6 @@ class StimulusReflex::BroadcasterTestCase < ActionCable::Channel::TestCase
     def connection.env
       @env ||= {}
     end
-    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com", client_attributes: {reflex_id: "666"})
+    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com", client_attributes: {reflex_id: "666", version: StimulusReflex::VERSION})
   end
 end

data/test/broadcasters/nothing_broadcaster_test.rb

@@ -11,6 +11,7 @@ class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCa
       "operations" => [
         {
           "name" => "stimulus-reflex:morph-nothing",
+          "selector" => nil,
           "payload" => {},
           "stimulusReflex" => {
             "some" => "data",
@@ -19,7 +20,8 @@ class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCa
           "reflexId" => "666",
           "operation" => "dispatchEvent"
         }
-      ]
+      ],
+      "version" => CableReady::VERSION
     }
 
     assert_broadcast_on @reflex.stream_name, expected do

data/test/broadcasters/page_broadcaster_test.rb

@@ -34,7 +34,8 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
           "reflexId" => "666",
           "operation" => "morph"
         }
-      ]
+      ],
+      "version" => CableReady::VERSION
     }
 
     assert_broadcast_on @reflex.stream_name, expected do
@@ -67,7 +68,8 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
           "reflexId" => "666",
           "operation" => "morph"
         }
-      ]
+      ],
+      "version" => CableReady::VERSION
     }
 
     assert_broadcast_on @reflex.stream_name, expected do

data/test/broadcasters/selector_broadcaster_test.rb

@@ -24,7 +24,8 @@ module StimulusReflex
             "reflexId" => "666",
             "operation" => "morph"
           }
-        ]
+        ],
+        "version" => CableReady::VERSION
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -50,7 +51,8 @@ module StimulusReflex
             "reflexId" => "666",
             "operation" => "innerHtml"
           }
-        ]
+        ],
+        "version" => CableReady::VERSION
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -76,7 +78,8 @@ module StimulusReflex
             "reflexId" => "666",
             "operation" => "innerHtml"
           }
-        ]
+        ],
+        "version" => CableReady::VERSION
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -102,7 +105,8 @@ module StimulusReflex
             "reflexId" => "666",
             "operation" => "innerHtml"
           }
-        ]
+        ],
+        "version" => CableReady::VERSION
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -128,7 +132,8 @@ module StimulusReflex
             "reflexId" => "666",
             "operation" => "innerHtml"
           }
-        ]
+        ],
+        "version" => CableReady::VERSION
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -156,7 +161,8 @@ module StimulusReflex
             "reflexId" => "666",
             "operation" => "morph"
           }
-        ]
+        ],
+        "version" => CableReady::VERSION
       }
 
       assert_broadcast_on @reflex.stream_name, expected do

data/test/callbacks_test.rb

@@ -29,7 +29,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = BeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = BeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 6, reflex.instance_variable_get("@count")
   end
@@ -45,7 +45,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = BeforeBlockCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = BeforeBlockCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 6, reflex.instance_variable_get("@count")
   end
@@ -65,7 +65,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = AfterCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = AfterCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 1, reflex.instance_variable_get("@count")
   end
@@ -81,7 +81,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = AfterBlockCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = AfterBlockCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 1, reflex.instance_variable_get("@count")
   end
@@ -103,7 +103,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = AroundCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = AroundCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 14, reflex.instance_variable_get("@count")
   end
@@ -131,7 +131,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = CallbackOrderReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = CallbackOrderReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 3, reflex.instance_variable_get("@count")
   end
@@ -171,7 +171,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = IfCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = IfCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 23, reflex.instance_variable_get("@count")
   end
@@ -203,7 +203,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = IfProcCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = IfProcCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 23, reflex.instance_variable_get("@count")
   end
@@ -243,7 +243,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = UnlessCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = UnlessCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 23, reflex.instance_variable_get("@count")
   end
@@ -275,7 +275,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = UnlessProcCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = UnlessProcCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 23, reflex.instance_variable_get("@count")
   end
@@ -309,7 +309,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = OnlyCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :decrement)
+    reflex = OnlyCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :decrement, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:decrement)
     assert_equal(-8, reflex.instance_variable_get("@count"))
   end
@@ -343,11 +343,11 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = ExceptCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = ExceptCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 6, reflex.instance_variable_get("@count")
 
-    reflex = ExceptCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :decrement)
+    reflex = ExceptCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :decrement, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:decrement)
     assert_equal(-8, reflex.instance_variable_get("@count"))
   end
@@ -381,7 +381,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = SkipBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = SkipBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 6, reflex.instance_variable_get("@count")
   end
@@ -415,7 +415,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = SkipAfterCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = SkipAfterCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 1, reflex.instance_variable_get("@count")
   end
@@ -453,7 +453,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = SkipAroundCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = SkipAroundCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 7, reflex.instance_variable_get("@count")
   end
@@ -482,7 +482,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = InheritedSkipApplicationReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = InheritedSkipApplicationReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 6, reflex.instance_variable_get("@count")
   end
@@ -507,7 +507,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = SimplePrependBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = SimplePrependBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 3, reflex.instance_variable_get("@count")
   end
@@ -527,7 +527,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = BlockPrependBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = BlockPrependBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 3, reflex.instance_variable_get("@count")
   end
@@ -557,7 +557,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = InheritedPrependBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = InheritedPrependBeforeCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 9, reflex.instance_variable_get("@count")
   end
@@ -586,7 +586,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = SimplePrependAroundCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = SimplePrependAroundCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 26, reflex.instance_variable_get("@count")
   end
@@ -611,7 +611,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = SimplePrependAfterCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = SimplePrependAfterCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 9, reflex.instance_variable_get("@count")
   end
@@ -643,7 +643,7 @@ class CallbacksTest < ActionCable::Channel::TestCase
       end
     end
 
-    reflex = AppendCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment)
+    reflex = AppendCallbackReflex.new(subscribe, url: "https://test.stimulusreflex.com", method_name: :increment, client_attributes: {version: StimulusReflex::VERSION})
     reflex.process(:increment)
     assert_equal 25, reflex.instance_variable_get("@count")
   end

data/test/reflex_test.rb

@@ -11,7 +11,7 @@ class StimulusReflex::ReflexTest < ActionCable::Channel::TestCase
     def connection.env
       @env ||= {}
     end
-    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com", client_attributes: {reflex_id: "666"})
+    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com", client_attributes: {reflex_id: "666", version: StimulusReflex::VERSION})
     @reflex.controller_class.view_paths << Rails.root.join("test/views")
   end
 
@@ -33,7 +33,7 @@ class StimulusReflex::ReflexTest < ActionCable::Channel::TestCase
 
   test "params behave like ActionController::Parameters" do
     ActionDispatch::Request.any_instance.stubs(:parameters).returns({"a" => "1", "b" => "2", "c" => "3"})
-    reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com")
+    reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com", client_attributes: {version: StimulusReflex::VERSION})
 
     deleted_param = reflex.params.delete("a")
 

data/test/tmp/app/reflexes/application_reflex.rb

@@ -3,17 +3,10 @@
 class ApplicationReflex < StimulusReflex::Reflex
   # Put application-wide Reflex behavior and callbacks in this file.
   #
-  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
+  # Example:
   #
-  # If your ActionCable connection is: `identified_by :current_user`
+  #   # If your ActionCable connection is: `identified_by :current_user`
   #   delegate :current_user, to: :connection
   #
-  # If you need to localize your Reflexes, you can set the I18n locale here:
-  #
-  #   before_reflex do
-  #     I18n.locale = :fr
-  #   end
-  #
-  # For code examples, considerations and caveats, see:
-  # https://docs.stimulusreflex.com/rtfm/patterns#internationalization
+  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
 end

data/test/tmp/app/reflexes/{demo_reflex.rb → user_reflex.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class DemoReflex < ApplicationReflex
+class UserReflex < ApplicationReflex
   # Add Reflex methods in this file.
   #
   # All Reflex instances include CableReady::Broadcaster and expose the following properties:
@@ -17,7 +17,6 @@ class DemoReflex < ApplicationReflex
   #     - unsigned  - use an unsigned Global ID to map dataset attribute to a model  eg. element.unsigned[:foo]
   #   - cable_ready - a special cable_ready that can broadcast to the current visitor (no brackets needed)
   #   - reflex_id   - a UUIDv4 that uniquely identies each Reflex
-  #   - tab_id      - a UUIDv4 that uniquely identifies the browser tab
   #
   # Example:
   #
@@ -32,4 +31,13 @@ class DemoReflex < ApplicationReflex
   #   end
   #
   # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
+
+  def update
+  end
+
+  def do_stuff
+  end
+
+  def do_more_stuff
+  end
 end

data/web-test-runner.config.mjs

@@ -0,0 +1,12 @@
+import rollupJson from '@rollup/plugin-json'
+import { fromRollup } from '@web/dev-server-rollup'
+
+const json = fromRollup(rollupJson)
+
+export default {
+  nodeResolve: true,
+  mimeTypes: {
+    '**/*.json': 'js'
+  },
+  plugins: [json({})]
+}