stimulus_reflex 3.4.2 → 3.5.0.pre0

data/lib/stimulus_reflex/{sanity_checker.rb → utils/sanity_checker.rb}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 class StimulusReflex::SanityChecker
+  LATEST_VERSION_FORMAT = /^(\d+\.\d+\.\d+)$/
   NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
   JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
 
@@ -13,6 +14,8 @@ class StimulusReflex::SanityChecker
       instance = new
       instance.check_caching_enabled
       instance.check_javascript_package_version
+      instance.check_default_url_config
+      instance.check_new_version_available
     end
 
     private
@@ -24,44 +27,80 @@ class StimulusReflex::SanityChecker
     end
 
     def called_by_generate_config?
-      ARGV.include? "stimulus_reflex:config"
+      ARGV.include? "stimulus_reflex:initializer"
     end
   end
 
   def check_caching_enabled
     unless caching_enabled?
       warn_and_exit <<~WARN
-        Stimulus Reflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
+        StimulusReflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
         To enable caching in development, run:
-            rails dev:cache
+          rails dev:cache
       WARN
     end
 
     unless not_null_store?
       warn_and_exit <<~WARN
-        Stimulus Reflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
+        StimulusReflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
         But your config.cache_store is set to :null_store, so it won't work.
       WARN
     end
   end
 
+  def check_default_url_config
+    unless default_url_config_set?
+      warn_and_exit <<~WARN
+        StimulusReflex strongly suggests that you set default_url_options in your environment files.
+        Otherwise, ActionController and ActionMailer will default to example.com when rendering route helpers.
+        You can set your URL options in config/environments/#{Rails.env}.rb
+          config.action_controller.default_url_options = {host: "localhost", port: 3000}
+          config.action_mailer.default_url_options = {host: "localhost", port: 3000}
+        Please update every environment with the appropriate URL. Typically, no port is necessary in production.
+      WARN
+    end
+  end
+
   def check_javascript_package_version
     if javascript_package_version.nil?
       warn_and_exit <<~WARN
-        Can't locate the stimulus_reflex NPM package.
+        Can't locate the stimulus_reflex npm package.
         Either add it to your package.json as a dependency or use "yarn link stimulus_reflex" if you are doing development.
       WARN
     end
 
     unless javascript_version_matches?
       warn_and_exit <<~WARN
-        The Stimulus Reflex javascript package version (#{javascript_package_version}) does not match the Rubygem version (#{gem_version}).
-        To update the Stimulus Reflex npm package:
-            yarn upgrade stimulus_reflex@#{gem_version}
+        The stimulus_reflex npm package version (#{javascript_package_version}) does not match the Rubygem version (#{gem_version}).
+        To update the stimulus_reflex npm package:
+          yarn upgrade stimulus_reflex@#{gem_version}
       WARN
     end
   end
 
+  def check_new_version_available
+    return unless Rails.env.development?
+    return if StimulusReflex.config.on_new_version_available == :ignore
+    return unless using_stable_release
+    begin
+      latest_version = URI.open("https://raw.githubusercontent.com/stimulusreflex/stimulus_reflex/master/LATEST", open_timeout: 1, read_timeout: 1).read.strip
+      if latest_version != StimulusReflex::VERSION
+        puts <<~WARN
+
+          There is a new version of StimulusReflex available!
+          Current: #{StimulusReflex::VERSION} Latest: #{latest_version}
+
+          If you upgrade, it is very important that you update BOTH Gemfile and package.json
+          Then, run `bundle install && yarn install` to update to #{latest_version}.
+
+        WARN
+        exit if StimulusReflex.config.on_new_version_available == :exit
+      end
+    rescue
+      puts "StimulusReflex #{StimulusReflex::VERSION} update check skipped: connection timeout"
+    end
+  end
+
   private
 
   def caching_enabled?
@@ -72,10 +111,20 @@ class StimulusReflex::SanityChecker
     Rails.application.config.cache_store != :null_store
   end
 
+  def default_url_config_set?
+    Rails.application.config.action_controller.default_url_options
+  end
+
   def javascript_version_matches?
     javascript_package_version == gem_version
   end
 
+  def using_stable_release
+    stable = StimulusReflex::VERSION.match?(LATEST_VERSION_FORMAT)
+    puts "StimulusReflex #{StimulusReflex::VERSION} update check skipped: pre-release build" unless stable
+    stable
+  end
+
   def gem_version
     @_gem_version ||= StimulusReflex::VERSION.gsub(".pre", "-pre")
   end
@@ -118,7 +167,6 @@ class StimulusReflex::SanityChecker
   def exit_with_info
     puts
 
-    # bundle exec rails generate stimulus_reflex:config
     if File.exist?(initializer_path)
       puts <<~INFO
         If you know what you are doing and you want to start the application anyway,
@@ -139,7 +187,7 @@ class StimulusReflex::SanityChecker
 
         Then open your initializer at
 
-        <RAILS_ROOT>/config/initializers/stimulus_reflex.rb
+        #{initializer_path}
 
         and then add the following directive:
 

data/lib/stimulus_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusReflex
-  VERSION = "3.4.2"
+  VERSION = "3.5.0.pre0"
 end

data/lib/stimulus_reflex.rb

@@ -1,27 +1,33 @@
 # frozen_string_literal: true
 
 require "uri"
+require "open-uri"
 require "rack"
 require "rails/engine"
 require "active_support/all"
 require "action_dispatch"
 require "action_cable"
+require "action_view"
 require "nokogiri"
 require "cable_ready"
 require "stimulus_reflex/version"
 require "stimulus_reflex/cable_ready_channels"
+require "stimulus_reflex/concern_enhancer"
 require "stimulus_reflex/configuration"
 require "stimulus_reflex/callbacks"
+require "stimulus_reflex/request_parameters"
 require "stimulus_reflex/reflex"
+require "stimulus_reflex/reflex_data"
 require "stimulus_reflex/reflex_factory"
 require "stimulus_reflex/element"
-require "stimulus_reflex/sanity_checker"
 require "stimulus_reflex/broadcasters/broadcaster"
 require "stimulus_reflex/broadcasters/nothing_broadcaster"
 require "stimulus_reflex/broadcasters/page_broadcaster"
 require "stimulus_reflex/broadcasters/selector_broadcaster"
+require "stimulus_reflex/policies/reflex_invocation_policy"
 require "stimulus_reflex/utils/colorize"
-require "stimulus_reflex/logger"
+require "stimulus_reflex/utils/logger"
+require "stimulus_reflex/utils/sanity_checker"
 
 module StimulusReflex
   class Engine < Rails::Engine

data/lib/tasks/stimulus_reflex/install.rake

@@ -44,14 +44,16 @@ namespace :stimulus_reflex do
     end
 
     initialize_line = lines.find { |line| line.start_with?("StimulusReflex.initialize") }
-    lines << "StimulusReflex.initialize(application, { consumer, controller, isolate: true })\n" unless initialize_line
+    lines << "application.consumer = consumer\n"
+    lines << "StimulusReflex.initialize(application, { controller, isolate: true })\n" unless initialize_line
     lines << "StimulusReflex.debug = process.env.RAILS_ENV === 'development'\n" unless initialize_line
     File.open(filepath, "w") { |f| f.write lines.join }
 
     filepath = Rails.root.join("config/environments/development.rb")
     lines = File.open(filepath, "r") { |f| f.readlines }
     unless lines.find { |line| line.include?("config.session_store") }
-      lines.insert 3, "  config.session_store :cache_store\n\n"
+      matches = lines.select { |line| line =~ /\A(Rails.application.configure do)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "  config.session_store :cache_store\n\n"
       File.open(filepath, "w") { |f| f.write lines.join }
     end
 
@@ -61,7 +63,7 @@ namespace :stimulus_reflex do
       lines.delete_at 1
       lines.insert 1, "  adapter: redis\n"
       lines.insert 2, "  url: <%= ENV.fetch(\"REDIS_URL\") { \"redis://localhost:6379/1\" } %>\n"
-      lines.insert 3, "  channel_prefix: " + File.basename(Rails.root.to_s).underscore + "_development\n"
+      lines.insert 3, "  channel_prefix: " + File.basename(Rails.root.to_s).tr("\\", "").tr("-. ", "_").underscore + "_development\n"
       File.open(filepath, "w") { |f| f.write lines.join }
     end
 
@@ -71,7 +73,7 @@ namespace :stimulus_reflex do
 
     puts
     puts "StimulusReflex and CableReady have been successfully installed!"
-    puts "Go to https://docs.stimulusreflex.com/quickstart if you need help getting started."
+    puts "Go to https://docs.stimulusreflex.com/hello-world/quickstart if you need help getting started."
     puts
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stimulus_reflex",
-  "version": "3.4.2",
+  "version": "3.4.1",
   "description": "Build reactive applications with the Rails tooling you already know and love.",
   "keywords": [
     "ruby",
@@ -20,11 +20,11 @@
   ],
   "homepage": "https://docs.stimulusreflex.com/",
   "bugs": {
-    "url": "https://github.com/hopsoft/stimulus_reflex/issues"
+    "url": "https://github.com/stimulusreflex/stimulus_reflex/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com:hopsoft/stimulus_reflex.git"
+    "url": "git+https://github.com:stimulusreflex/stimulus_reflex.git"
   },
   "license": "MIT",
   "author": "Nathan Hopkins <natehop@gmail.com>",
@@ -34,14 +34,14 @@
     "postinstall": "node ./javascript/scripts/post_install.js",
     "prettier-standard:check": "yarn run prettier-standard --check ./javascript/*.js ./javascript/**/*.js",
     "prettier-standard:format": "yarn run prettier-standard ./javascript/*.js ./javascript/**/*.js",
-    "test": "yarn run mocha --require @babel/register --require esm ./javascript/test"
+    "test": "yarn run mocha --require @babel/register --require jsdom-global/register --require esm ./javascript/test"
   },
   "peerDependencies": {
     "stimulus": ">= 1.1"
   },
   "dependencies": {
     "@rails/actioncable": ">= 6.0",
-    "cable_ready": "^4.5.0"
+    "cable_ready": "5.0.0-pre0"
   },
   "devDependencies": {
     "@babel/core": "^7.6.2",
@@ -50,6 +50,7 @@
     "assert": "^2.0.0",
     "esm": "^3.2.25",
     "jsdom": "^16.0.1",
+    "jsdom-global": "^3.0.2",
     "mocha": "^8.0.1",
     "prettier-standard": "^16.1.0",
     "stimulus": ">= 1.1"

data/stimulus_reflex.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version = StimulusReflex::VERSION
   gem.authors = ["Nathan Hopkins"]
   gem.email = ["natehop@gmail.com"]
-  gem.homepage = "https://github.com/hopsoft/stimulus_reflex"
+  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
     Friendly reminder: When updating the stimulus_reflex gem,
@@ -18,8 +18,8 @@ Gem::Specification.new do |gem|
   MESSAGE
 
   gem.metadata = {
-    "bug_tracker_uri" => "https://github.com/hopsoft/stimulus_reflex/issues",
-    "changelog_uri" => "https://github.com/hopsoft/stimulus_reflex/CHANGELOG.md",
+    "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
@@ -32,11 +32,11 @@ Gem::Specification.new do |gem|
   gem.add_dependency "nokogiri"
   gem.add_dependency "rails", ">= 5.2"
   gem.add_dependency "redis"
-  gem.add_dependency "cable_ready", "~> 4.5"
+  gem.add_dependency "cable_ready", "5.0.0.pre0"
 
   gem.add_development_dependency "bundler", "~> 2.0"
   gem.add_development_dependency "pry-nav"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "standardrb"
+  gem.add_development_dependency "standardrb", "~> 1.0"
 end

data/test/broadcasters/broadcaster_test_case.rb

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

data/test/broadcasters/nothing_broadcaster_test.rb

@@ -13,7 +13,8 @@ class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCa
           {
             "name" => "stimulus-reflex:server-message",
             "detail" => {
-              "reflexId" => nil,
+              "reflexId" => "666",
+              "payload" => {},
               "stimulusReflex" => {
                 "some" => :data,
                 "morph" => :nothing,
@@ -22,14 +23,15 @@ class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCa
                   "body" => nil
                 }
               }
-            }
+            },
+            "reflexId" => "666"
           }
         ]
       }
     }
 
     assert_broadcast_on @reflex.stream_name, expected do
-      broadcaster.broadcast nil, some: :data
+      broadcaster.broadcast nil, {:some => :data, "reflexId" => "666"}
     end
   end
 end

data/test/broadcasters/page_broadcaster_test.rb

@@ -12,7 +12,7 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
   test "performs a page morph on body" do
     class << @reflex.controller.response
       def body
-        "<html><head></head><body>New Content</body></html>"
+        "<html><head></head><body><div>New Content</div><div>Another Content</div></body></html>"
       end
     end
 
@@ -24,13 +24,15 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
         "morph" => [
           {
             "selector" => "body",
-            "html" => "New Content",
+            "html" => "<div>New Content</div><div>Another Content</div>",
+            "payload" => {},
             "childrenOnly" => true,
             "permanentAttributeName" => nil,
             "stimulusReflex" => {
               "some" => :data,
               "morph" => :page
-            }
+            },
+            "reflexId" => "666"
           }
         ]
       }
@@ -57,12 +59,14 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
           {
             "selector" => "#foo",
             "html" => "New Content",
+            "payload" => {},
             "childrenOnly" => true,
             "permanentAttributeName" => nil,
             "stimulusReflex" => {
               "some" => :data,
               "morph" => :page
-            }
+            },
+            "reflexId" => "666"
           }
         ]
       }

data/test/broadcasters/selector_broadcaster_test.rb

@@ -1,57 +1,173 @@
 # frozen_string_literal: true
 
-# require_relative "broadcaster_test_case"
-
-# class StimulusReflex::SelectorBroadcasterTest < StimulusReflex::BroadcasterTestCase
-# test "morphs the contents of an element if the selector(s) are present in both original and morphed html fragments" do
-# broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
-# broadcaster.append_morph("#foo", "<div id=\"foo\"><span>bar</span></div>")
-
-# expected = {
-# "cableReady" => true,
-# "operations" => {
-# "morph" => [
-# {
-# "selector" => "#foo",
-# "html" => "<span>bar</span>",
-# "childrenOnly" => true,
-# "permanentAttributeName" => nil,
-# "stimulusReflex" => {
-# "some" => :data,
-# "morph" => :selector
-# }
-# }
-# ]
-# }
-# }
-
-# assert_broadcast_on @reflex.stream_name, expected do
-# broadcaster.broadcast nil, some: :data
-# end
-# end
-
-# test "replaces the contents of an element and ignores permanent-attributes if the selector(s) aren't present in the replacing html fragment" do
-# broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
-# broadcaster.append_morph("#foo", "<div id=\"baz\"><span>bar</span></div>")
-
-# expected = {
-# "cableReady" => true,
-# "operations" => {
-# "innerHtml" => [
-# {
-# "selector" => "#foo",
-# "html" => "<div id=\"baz\"><span>bar</span></div>",
-# "stimulusReflex" => {
-# "some" => :data,
-# "morph" => :selector
-# }
-# }
-# ]
-# }
-# }
-
-# assert_broadcast_on @reflex.stream_name, expected do
-# broadcaster.broadcast nil, some: :data
-# end
-# end
-# end
+require_relative "broadcaster_test_case"
+
+module StimulusReflex
+  class SelectorBroadcasterTest < StimulusReflex::BroadcasterTestCase
+    test "morphs the contents of an element if the selector(s) are present in both original and morphed html fragments" do
+      broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
+      broadcaster.append_morph("#foo", '<div id="foo"><div>bar</div><div>baz</div></div>')
+
+      expected = {
+        "cableReady" => true,
+        "operations" => {
+          "morph" => [
+            {
+              "selector" => "#foo",
+              "html" => "<div>bar</div><div>baz</div>",
+              "payload" => {},
+              "childrenOnly" => true,
+              "permanentAttributeName" => nil,
+              "stimulusReflex" => {
+                "some" => "data",
+                "morph" => "selector"
+              },
+              "reflexId" => "666"
+            }
+          ]
+        }
+      }
+
+      assert_broadcast_on @reflex.stream_name, expected do
+        broadcaster.broadcast nil, some: :data
+      end
+    end
+
+    test "replaces the contents of an element and ignores permanent-attributes if the selector(s) aren't present in the replacing html fragment" do
+      broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
+      broadcaster.append_morph("#foo", '<div id="baz"><span>bar</span></div>')
+
+      expected = {
+        "cableReady" => true,
+        "operations" => {
+          "innerHtml" => [
+            {
+              "selector" => "#foo",
+              "html" => '<div id="baz"><span>bar</span></div>',
+              "payload" => {},
+              "stimulusReflex" => {
+                "some" => "data",
+                "morph" => "selector"
+              },
+              "reflexId" => "666"
+            }
+          ]
+        }
+      }
+
+      assert_broadcast_on @reflex.stream_name, expected do
+        broadcaster.broadcast nil, some: :data
+      end
+    end
+
+    test "morphs the contents of an element to an empty string if no content specified" do
+      broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
+      broadcaster.append_morph("#foo", nil)
+
+      expected = {
+        "cableReady" => true,
+        "operations" => {
+          "innerHtml" => [
+            {
+              "selector" => "#foo",
+              "html" => "",
+              "payload" => {},
+              "stimulusReflex" => {
+                "some" => "data",
+                "morph" => "selector"
+              },
+              "reflexId" => "666"
+            }
+          ]
+        }
+      }
+
+      assert_broadcast_on @reflex.stream_name, expected do
+        broadcaster.broadcast nil, some: :data
+      end
+    end
+
+    test "morphs the contents of an element to an empty string if empty specified" do
+      broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
+      broadcaster.append_morph("#foo", "")
+
+      expected = {
+        "cableReady" => true,
+        "operations" => {
+          "innerHtml" => [
+            {
+              "selector" => "#foo",
+              "html" => "",
+              "payload" => {},
+              "stimulusReflex" => {
+                "some" => "data",
+                "morph" => "selector"
+              },
+              "reflexId" => "666"
+            }
+          ]
+        }
+      }
+
+      assert_broadcast_on @reflex.stream_name, expected do
+        broadcaster.broadcast nil, some: :data
+      end
+    end
+
+    test "morphs the contents of an element to an empty string if no content specified, hash form" do
+      broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
+      broadcaster.append_morph({"#foo": nil}, nil)
+
+      expected = {
+        "cableReady" => true,
+        "operations" => {
+          "innerHtml" => [
+            {
+              "selector" => "#foo",
+              "html" => "",
+              "payload" => {},
+              "stimulusReflex" => {
+                "some" => "data",
+                "morph" => "selector"
+              },
+              "reflexId" => "666"
+            }
+          ]
+        }
+      }
+
+      assert_broadcast_on @reflex.stream_name, expected do
+        broadcaster.broadcast nil, some: :data
+      end
+    end
+
+    test "morphs the contents of an element to specified HTML, hash form" do
+      broadcaster = StimulusReflex::SelectorBroadcaster.new(@reflex)
+      broadcaster.append_morph({"#foo": '<div id="foo"><div>bar</div><div>baz</div></div>'}, nil)
+
+      expected = {
+        "cableReady" => true,
+        "operations" => {
+          "morph" => [
+            {
+              "selector" => "#foo",
+              "html" => "<div>bar</div><div>baz</div>",
+              "payload" => {},
+              "childrenOnly" => true,
+              "permanentAttributeName" => nil,
+              "stimulusReflex" => {
+                "some" => "data",
+                "morph" => "selector"
+              },
+              "reflexId" => "666"
+            }
+          ]
+        }
+      }
+
+      assert_broadcast_on @reflex.stream_name, expected do
+        broadcaster.broadcast nil, some: :data
+      end
+    end
+  end
+end