stimulus_reflex 3.4.0.pre6 → 3.4.1

data/app/channels/stimulus_reflex/channel.rb

@@ -40,8 +40,8 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
           params: params,
           client_attributes: {
             reflex_id: data["reflexId"],
-            xpath: data["xpath"],
-            c_xpath: data["cXpath"],
+            xpath_controller: data["xpathController"],
+            xpath_element: data["xpathElement"],
             reflex_controller: data["reflexController"],
             permanent_attribute_name: permanent_attribute_name
           })
@@ -49,11 +49,33 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
       rescue => invoke_error
         message = exception_message_with_backtrace(invoke_error)
         body = "Reflex #{target} failed: #{message} [#{url}]"
+
         if reflex
           reflex.rescue_with_handler(invoke_error)
           reflex.broadcast_message subject: "error", body: body, data: data, error: invoke_error
         else
           puts "\e[31m#{body}\e[0m"
+
+          if body.to_s.include? "No route matches"
+            initializer_path = Rails.root.join("config", "initializers", "stimulus_reflex.rb")
+
+            puts <<~NOTE
+              \e[33mNOTE: StimulusReflex failed to locate a matching route and could not re-render the page.
+
+              If your app uses Rack middleware to rewrite part of the request path, you must enable those middleware modules in StimulusReflex.
+              The StimulusReflex initializer should be located at #{initializer_path}, or you can generate it with:
+
+                $ bundle exec rails generate stimulus_reflex:config
+
+              Configure any required middleware:
+
+                StimulusReflex.configure do |config|
+                  config.middleware.use FirstRackMiddleware
+                  config.middleware.use SecondRackMiddleware
+                end\e[0m
+
+            NOTE
+          end
         end
         return
       end

data/lib/generators/stimulus_reflex/templates/app/reflexes/%file_name%_reflex.rb.tt

@@ -16,6 +16,7 @@ class <%= class_name %>Reflex < ApplicationReflex
   #     - signed    - use a signed Global ID to map dataset attribute to a model eg. element.signed[:foo]
   #     - 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
   #
   # Example:
   #

data/lib/generators/stimulus_reflex/templates/config/initializers/stimulus_reflex.rb

@@ -12,9 +12,18 @@ StimulusReflex.configure do |config|
 
   # Customize server-side Reflex logging format, with optional colorization:
   # Available tokens: session_id, session_id_full, reflex_info, operation, reflex_id, reflex_id_full, mode, selector, operation_counter, connection_id, connection_id_full, timestamp
-  # Available colors: green, yellow, blue, magenta, cyan, white
+  # Available colors: red, green, yellow, blue, magenta, cyan, white
   # You can also use attributes from your ActionCable Connection's identifiers that resolve to valid ActiveRecord models
   # eg. if your connection is `identified_by :current_user` and your User model has an email attribute, you can access r.email (it will display `-` if the user isn't logged in)
+  # Learn more at: https://docs.stimulusreflex.com/troubleshooting#stimulusreflex-logging
 
   # config.logging = proc { "[#{session_id}] #{operation_counter.magenta} #{reflex_info.green} -> #{selector.cyan} via #{mode} Morph (#{operation.yellow})" }
+
+  # Optimized for speed, StimulusReflex doesn't enable Rack middleware by default.
+  # If you are using Page Morphs and your app uses Rack middleware to rewrite part of the request path, you must enable those middleware modules in StimulusReflex.
+  #
+  # Learn more about registering Rack middleware in Rails here: https://guides.rubyonrails.org/rails_on_rack.html#configuring-middleware-stack
+
+  # config.middleware.use FirstRackMiddleware
+  # config.middleware.use SecondRackMiddleware
 end

data/lib/stimulus_reflex.rb

@@ -11,6 +11,7 @@ require "cable_ready"
 require "stimulus_reflex/version"
 require "stimulus_reflex/cable_ready_channels"
 require "stimulus_reflex/configuration"
+require "stimulus_reflex/callbacks"
 require "stimulus_reflex/reflex"
 require "stimulus_reflex/element"
 require "stimulus_reflex/sanity_checker"
@@ -24,7 +25,7 @@ require "stimulus_reflex/logger"
 module StimulusReflex
   class Engine < Rails::Engine
     initializer "stimulus_reflex.sanity_check" do
-      SanityChecker.check!
+      SanityChecker.check! unless Rails.env.production?
     end
   end
 end

data/lib/stimulus_reflex/broadcasters/page_broadcaster.rb

@@ -23,6 +23,7 @@ module StimulusReflex
           })
         )
       end
+
       cable_ready.broadcast
     end
 

data/lib/stimulus_reflex/cable_ready_channels.rb

@@ -1,18 +1,28 @@
+# frozen_string_literal: true
+
 module StimulusReflex
   class CableReadyChannels
+    delegate :[], to: "cable_ready_channels"
+
     def initialize(stream_name)
-      @cable_ready_channels = CableReady::Channels.instance
-      @stimulus_reflex_channel = @cable_ready_channels[stream_name]
+      @stream_name = stream_name
+    end
+
+    def cable_ready_channels
+      CableReady::Channels.instance
+    end
+
+    def stimulus_reflex_channel
+      CableReady::Channels.instance[@stream_name]
     end
 
     def method_missing(name, *args)
-      return @stimulus_reflex_channel.send(name, *args) if @stimulus_reflex_channel.respond_to?(name)
-      @cable_ready_channels.send(name, *args)
+      return stimulus_reflex_channel.public_send(name, *args) if stimulus_reflex_channel.respond_to?(name)
+      super
     end
 
     def respond_to_missing?(name, include_all)
-      @stimulus_reflex_channel.respond_to?(name, include_all) ||
-        @cable_ready_channels.respond_to?(name, include_all)
+      stimulus_reflex_channel.respond_to?(name) || super
     end
   end
 end

data/lib/stimulus_reflex/callbacks.rb

@@ -0,0 +1,48 @@
+require "active_support/concern"
+
+module StimulusReflex
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveSupport::Callbacks
+      define_callbacks :process, skip_after_callbacks_if_terminated: true
+    end
+
+    class_methods do
+      def before_reflex(*args, &block)
+        add_callback(:before, *args, &block)
+      end
+
+      def after_reflex(*args, &block)
+        add_callback(:after, *args, &block)
+      end
+
+      def around_reflex(*args, &block)
+        add_callback(:around, *args, &block)
+      end
+
+      private
+
+      def add_callback(kind, *args, &block)
+        options = args.extract_options!
+        options.assert_valid_keys :if, :unless, :only, :except
+        set_callback(*[:process, kind, args, normalize_callback_options!(options)].flatten, &block)
+      end
+
+      def normalize_callback_options!(options)
+        normalize_callback_option! options, :only, :if
+        normalize_callback_option! options, :except, :unless
+        options
+      end
+
+      def normalize_callback_option!(options, from, to)
+        if (from = options.delete(from))
+          from_set = Array(from).map(&:to_s).to_set
+          from = proc { |reflex| from_set.include? reflex.method_name }
+          options[to] = Array(options[to]).unshift(from)
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_reflex/configuration.rb

@@ -14,7 +14,7 @@ module StimulusReflex
   end
 
   class Configuration
-    attr_accessor :on_failed_sanity_checks, :parent_channel, :logging
+    attr_accessor :on_failed_sanity_checks, :parent_channel, :logging, :middleware
 
     DEFAULT_LOGGING = proc { "[#{session_id}] #{operation_counter.magenta} #{reflex_info.green} -> #{selector.cyan} via #{mode} Morph (#{operation.yellow})" }
 
@@ -22,6 +22,7 @@ module StimulusReflex
       @on_failed_sanity_checks = :exit
       @parent_channel = "ApplicationCable::Channel"
       @logging = DEFAULT_LOGGING
+      @middleware = ActionDispatch::MiddlewareStack.new
     end
   end
 end

data/lib/stimulus_reflex/logger.rb

@@ -79,22 +79,22 @@ module StimulusReflex
       Time.now.strftime("%Y-%m-%d %H:%M:%S")
     end
 
-    def method_missing method
-      return send(method.to_sym) if private_instance_methods.include?(method.to_sym)
+    def method_missing(name, *args)
+      return send(name) if private_instance_methods.include?(name.to_sym)
 
       reflex.connection.identifiers.each do |identifier|
         ident = reflex.connection.send(identifier)
-        return ident.send(method) if ident.respond_to?(:attributes) && ident.attributes.key?(method.to_s)
+        return ident.send(name) if ident.respond_to?(:attributes) && ident.attributes.key?(name.to_s)
       end
       "-"
     end
 
-    def respond_to_missing? method
-      return true if private_instance_methods.include?(method.to_sym)
+    def respond_to_missing?(name, include_all)
+      return true if private_instance_methods.include?(name.to_sym)
 
       reflex.connection.identifiers.each do |identifier|
         ident = reflex.connection.send(identifier)
-        return true if ident.respond_to?(:attributes) && ident.attributes.key?(method.to_s)
+        return true if ident.respond_to?(:attributes) && ident.attributes.key?(name.to_s)
       end
       false
     end

data/lib/stimulus_reflex/reflex.rb

@@ -1,59 +1,33 @@
 # frozen_string_literal: true
 
-ClientAttributes = Struct.new(:reflex_id, :reflex_controller, :xpath, :c_xpath, :permanent_attribute_name, keyword_init: true)
+ClientAttributes = Struct.new(:reflex_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, keyword_init: true)
 
 class StimulusReflex::Reflex
   include ActiveSupport::Rescuable
-  include ActiveSupport::Callbacks
-
-  define_callbacks :process, skip_after_callbacks_if_terminated: true
-
-  class << self
-    def before_reflex(*args, &block)
-      add_callback(:before, *args, &block)
-    end
-
-    def after_reflex(*args, &block)
-      add_callback(:after, *args, &block)
-    end
-
-    def around_reflex(*args, &block)
-      add_callback(:around, *args, &block)
-    end
-
-    private
-
-    def add_callback(kind, *args, &block)
-      options = args.extract_options!
-      options.assert_valid_keys :if, :unless, :only, :except
-      set_callback(*[:process, kind, args, normalize_callback_options!(options)].flatten, &block)
-    end
-
-    def normalize_callback_options!(options)
-      normalize_callback_option! options, :only, :if
-      normalize_callback_option! options, :except, :unless
-      options
-    end
-
-    def normalize_callback_option!(options, from, to)
-      if (from = options.delete(from))
-        from_set = Array(from).map(&:to_s).to_set
-        from = proc { |reflex| from_set.include? reflex.method_name }
-        options[to] = Array(options[to]).unshift(from)
-      end
-    end
-  end
+  include StimulusReflex::Callbacks
 
   attr_reader :cable_ready, :channel, :url, :element, :selectors, :method_name, :broadcaster, :client_attributes, :logger
 
   alias_method :action_name, :method_name # for compatibility with controller libraries like Pundit that expect an action name
 
   delegate :connection, :stream_name, to: :channel
-  delegate :flash, :session, to: :request
+  delegate :controller_class, :flash, :session, to: :request
   delegate :broadcast, :broadcast_message, to: :broadcaster
-  delegate :reflex_id, :reflex_controller, :xpath, :c_xpath, :permanent_attribute_name, to: :client_attributes
+  delegate :reflex_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, to: :client_attributes
+  delegate :render, to: :controller_class
 
   def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, params: {}, client_attributes: {})
+    if is_a? CableReady::Broadcaster
+      message = <<~MSG
+
+        #{self.class.name} includes CableReady::Broadcaster, and you need to remove it.
+        Reflexes have their own CableReady interface. You can just assume that it's present.
+        See https://docs.stimulusreflex.com/rtfm/cableready#using-cableready-inside-a-reflex-action for more details.
+
+      MSG
+      raise TypeError.new(message.strip)
+    end
+
     @channel = channel
     @url = url
     @element = element
@@ -86,6 +60,14 @@ class StimulusReflex::Reflex
       )
 
       env = connection.env.merge(mock_env)
+
+      middleware = StimulusReflex.config.middleware
+
+      if middleware.any?
+        stack = middleware.build(Rails.application.routes)
+        stack.call(env)
+      end
+
       req = ActionDispatch::Request.new(env)
 
       path_params = Rails.application.routes.recognize_path_with_request(req, url, req.env[:extras] || {})
@@ -114,11 +96,11 @@ class StimulusReflex::Reflex
 
   def controller
     @controller ||= begin
-      request.controller_class.new.tap do |c|
+      controller_class.new.tap do |c|
         c.instance_variable_set :"@stimulus_reflex", true
         instance_variables.each { |name| c.instance_variable_set name, instance_variable_get(name) }
-        c.request = request
-        c.response = ActionDispatch::Response.new
+        c.set_request! request
+        c.set_response! controller_class.make_response!(request)
       end
     end
   end
@@ -146,4 +128,8 @@ class StimulusReflex::Reflex
   def params
     @_params ||= ActionController::Parameters.new(request.parameters)
   end
+
+  def dom_id(record_or_class, prefix = nil)
+    "#" + ActionView::RecordIdentifier.dom_id(record_or_class, prefix).to_s
+  end
 end

data/lib/stimulus_reflex/sanity_checker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 class StimulusReflex::SanityChecker
+  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
   JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
 
   class << self
@@ -86,6 +87,8 @@ class StimulusReflex::SanityChecker
   def find_javascript_package_version
     if (match = search_file(package_json_path, regex: /version/))
       match[JSON_VERSION_FORMAT, 1]
+    elsif (match = search_file(yarn_lock_path, regex: /^stimulus_reflex/))
+      match[NODE_VERSION_FORMAT, 1]
     end
   end
 
@@ -98,6 +101,10 @@ class StimulusReflex::SanityChecker
     Rails.root.join("node_modules", "stimulus_reflex", "package.json")
   end
 
+  def yarn_lock_path
+    Rails.root.join("yarn.lock")
+  end
+
   def initializer_path
     @_initializer_path ||= Rails.root.join("config", "initializers", "stimulus_reflex.rb")
   end

data/lib/stimulus_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusReflex
-  VERSION = "3.4.0.pre6"
+  VERSION = "3.4.1"
 end

data/lib/tasks/stimulus_reflex/install.rake

@@ -6,9 +6,10 @@ require "stimulus_reflex/version"
 namespace :stimulus_reflex do
   desc "Install StimulusReflex in this application"
   task install: :environment do
-    system "bundle exec rails webpacker:install:stimulus"
+    system "rails dev:cache" unless Rails.root.join("tmp", "caching-dev.txt").exist?
     gem_version = StimulusReflex::VERSION.gsub(".pre", "-pre")
     system "yarn add stimulus_reflex@#{gem_version}"
+    system "bundle exec rails webpacker:install:stimulus"
     main_folder = defined?(Webpacker) ? Webpacker.config.source_path.to_s.gsub("#{Rails.root}/", "") : "app/javascript"
 
     FileUtils.mkdir_p Rails.root.join("#{main_folder}/controllers"), verbose: true
@@ -39,7 +40,7 @@ namespace :stimulus_reflex do
 
     unless lines.find { |line| line.start_with?("import controller") }
       matches = lines.select { |line| line =~ /\A(require|import)/ }
-      lines.insert lines.index(matches.last).to_i + 1, "import controller from './application_controller'\n"
+      lines.insert lines.index(matches.last).to_i + 1, "import controller from '../controllers/application_controller'\n"
     end
 
     initialize_line = lines.find { |line| line.start_with?("StimulusReflex.initialize") }
@@ -67,6 +68,10 @@ namespace :stimulus_reflex do
     system "bundle exec rails generate stimulus_reflex example"
     puts "Generating default StimulusReflex configuration file into your application config/initializers directory"
     system "bundle exec rails generate stimulus_reflex:config"
-    system "rails dev:cache" unless Rails.root.join("tmp", "caching-dev.txt").exist?
+
+    puts
+    puts "StimulusReflex and CableReady have been successfully installed!"
+    puts "Go to https://docs.stimulusreflex.com/quickstart if you need help getting started."
+    puts
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stimulus_reflex",
-  "version": "3.4.0-pre5",
+  "version": "3.4.0",
   "description": "Build reactive applications with the Rails tooling you already know and love.",
   "keywords": [
     "ruby",
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@rails/actioncable": ">= 6.0",
-    "cable_ready": ">= 4.4"
+    "cable_ready": ">= 4.5.0"
   },
   "devDependencies": {
     "@babel/core": "^7.6.2",
@@ -52,6 +52,6 @@
     "jsdom": "^16.0.1",
     "mocha": "^8.0.1",
     "prettier-standard": "^16.1.0",
-    "stimulus": "^1.1.1"
+    "stimulus": ">= 1.1"
   }
 }

data/stimulus_reflex.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path("../lib/stimulus_reflex/version", __FILE__)
 
 Gem::Specification.new do |gem|
@@ -30,7 +32,7 @@ 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.4"
+  gem.add_dependency "cable_ready", ">= 4.5"
 
   gem.add_development_dependency "bundler", "~> 2.0"
   gem.add_development_dependency "pry-nav"