stimulus_reflex 3.3.0.pre6 → 3.4.0.pre3

data/lib/generators/stimulus_reflex/config_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module StimulusReflex
+  class ConfigGenerator < Rails::Generators::Base
+    desc "Creates an StimulusReflex configuration file in config/initializers"
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_config_file
+      copy_file "config/initializers/stimulus_reflex.rb"
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+StimulusReflex.configure do |config|
+  # Enable/disable exiting / warning when the sanity checks fail options:
+  # `:exit` or `:warn` or `:ignore`
+  # config.on_failed_sanity_checks = :exit
+
+  # Override the parent class that the StimulusReflex ActionCable channel inherits from
+  # config.parent_channel = "ApplicationCable::Channel"
+end

data/lib/stimulus_reflex.rb

@@ -9,15 +9,14 @@ require "action_cable"
 require "nokogiri"
 require "cable_ready"
 require "stimulus_reflex/version"
+require "stimulus_reflex/configuration"
 require "stimulus_reflex/reflex"
 require "stimulus_reflex/element"
-require "stimulus_reflex/channel"
 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 "generators/stimulus_reflex_generator"
 
 module StimulusReflex
   class Engine < Rails::Engine

data/lib/stimulus_reflex/broadcasters/broadcaster.rb

@@ -24,22 +24,18 @@ module StimulusReflex
       false
     end
 
-    def enqueue_message(subject:, body: nil, data: {})
+    def broadcast_message(subject:, body: nil, data: {}, error: nil)
       logger.error "\e[31m#{body}\e[0m" if subject == "error"
       cable_ready[stream_name].dispatch_event(
         name: "stimulus-reflex:server-message",
         detail: {
           reflexId: data["reflexId"],
           stimulus_reflex: data.merge(
-            broadcaster: to_sym,
-            server_message: {subject: subject, body: body}
+            morph: to_sym,
+            server_message: {subject: subject, body: error&.to_s}
           )
         }
       )
-    end
-
-    def broadcast_message(subject:, body: nil, data: {})
-      enqueue_message subject: subject, body: body, data: data
       cable_ready.broadcast
     end
 

data/lib/stimulus_reflex/broadcasters/page_broadcaster.rb

@@ -3,7 +3,7 @@
 module StimulusReflex
   class PageBroadcaster < Broadcaster
     def broadcast(selectors, data)
-      reflex.controller.process reflex.url_params[:action]
+      reflex.controller.process reflex.params[:action]
       page_html = reflex.controller.response.body
 
       return unless page_html.present?
@@ -18,7 +18,7 @@ module StimulusReflex
           children_only: true,
           permanent_attribute_name: permanent_attribute_name,
           stimulus_reflex: data.merge({
-            broadcaster: to_sym
+            morph: to_sym
           })
         )
       end

data/lib/stimulus_reflex/broadcasters/selector_broadcaster.rb

@@ -17,7 +17,7 @@ module StimulusReflex
               children_only: true,
               permanent_attribute_name: permanent_attribute_name,
               stimulus_reflex: data.merge({
-                broadcaster: to_sym
+                morph: to_sym
               })
             )
           else
@@ -25,7 +25,7 @@ module StimulusReflex
               selector: selector,
               html: fragment.to_html,
               stimulus_reflex: data.merge({
-                broadcaster: to_sym
+                morph: to_sym
               })
             )
           end

data/lib/stimulus_reflex/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module StimulusReflex
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias_method :config, :configuration
+  end
+
+  class Configuration
+    attr_accessor :on_failed_sanity_checks, :parent_channel
+
+    def initialize
+      @on_failed_sanity_checks = :exit
+      @parent_channel = "ApplicationCable::Channel"
+    end
+  end
+end

data/lib/stimulus_reflex/element.rb

@@ -11,6 +11,14 @@ class StimulusReflex::Element < OpenStruct
     @data_attributes.transform_keys! { |key| key.delete_prefix "data-" }
   end
 
+  def signed
+    @signed ||= ->(accessor) { GlobalID::Locator.locate_signed(dataset[accessor]) }
+  end
+
+  def unsigned
+    @unsigned ||= ->(accessor) { GlobalID::Locator.locate(dataset[accessor]) }
+  end
+
   def dataset
     @dataset ||= OpenStruct.new(data_attributes.merge(data_attributes.transform_keys(&:underscore)))
   end

data/lib/stimulus_reflex/reflex.rb

@@ -43,13 +43,15 @@ class StimulusReflex::Reflex
     end
   end
 
-  attr_reader :channel, :url, :element, :selectors, :method_name, :broadcaster, :permanent_attribute_name
+  attr_reader :channel, :url, :element, :selectors, :method_name, :broadcaster, :permanent_attribute_name, :reflex_id
+
+  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 :session, to: :request
+  delegate :flash, :session, to: :request
   delegate :broadcast, :broadcast_message, to: :broadcaster
 
-  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, permanent_attribute_name: nil, params: {})
+  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, permanent_attribute_name: nil, params: {}, reflex_id: nil)
     @channel = channel
     @url = url
     @element = element
@@ -58,6 +60,7 @@ class StimulusReflex::Reflex
     @params = params
     @permanent_attribute_name = permanent_attribute_name
     @broadcaster = StimulusReflex::PageBroadcaster.new(self)
+    @reflex_id = reflex_id
     self.params
   end
 
@@ -66,21 +69,26 @@ class StimulusReflex::Reflex
       uri = URI.parse(url)
       path = ActionDispatch::Journey::Router::Utils.normalize_path(uri.path)
       query_hash = Rack::Utils.parse_nested_query(uri.query)
-      req = ActionDispatch::Request.new(
-        connection.env.merge(
-          Rack::MockRequest.env_for(uri.to_s).merge(
-            "rack.request.query_hash" => query_hash,
-            "rack.request.query_string" => uri.query,
-            "ORIGINAL_SCRIPT_NAME" => "",
-            "ORIGINAL_FULLPATH" => path,
-            Rack::SCRIPT_NAME => "",
-            Rack::PATH_INFO => path,
-            Rack::REQUEST_PATH => path,
-            Rack::QUERY_STRING => uri.query
-          )
-        )
+      mock_env = Rack::MockRequest.env_for(uri.to_s)
+
+      mock_env.merge!(
+        "rack.request.query_hash" => query_hash,
+        "rack.request.query_string" => uri.query,
+        "ORIGINAL_SCRIPT_NAME" => "",
+        "ORIGINAL_FULLPATH" => path,
+        Rack::SCRIPT_NAME => "",
+        Rack::PATH_INFO => path,
+        Rack::REQUEST_PATH => path,
+        Rack::QUERY_STRING => uri.query
       )
+
+      env = connection.env.merge(mock_env)
+      req = ActionDispatch::Request.new(env)
+
       path_params = Rails.application.routes.recognize_path_with_request(req, url, req.env[:extras] || {})
+      path_params[:controller] = path_params[:controller].force_encoding("UTF-8")
+      path_params[:action] = path_params[:action].force_encoding("UTF-8")
+
       req.env.merge(ActionDispatch::Http::Parameters::PARAMETERS_KEY => path_params)
       req.env["action_dispatch.request.parameters"] = req.parameters.merge(@params)
       req.tap { |r| r.session.send :load! }
@@ -112,10 +120,6 @@ class StimulusReflex::Reflex
     end
   end
 
-  def url_params
-    @url_params ||= Rails.application.routes.recognize_path_with_request(request, request.path, request.env[:extras] || {})
-  end
-
   def process(name, *args)
     reflex_invoked = false
     result = run_callbacks(:process) {

data/lib/stimulus_reflex/sanity_checker.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 class StimulusReflex::SanityChecker
-  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
   JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
 
   def self.check!
+    return if StimulusReflex.config.on_failed_sanity_checks == :ignore
+
     instance = new
     instance.check_caching_enabled
     instance.check_javascript_package_version
@@ -12,25 +13,32 @@ class StimulusReflex::SanityChecker
 
   def check_caching_enabled
     unless caching_enabled?
-      puts <<~WARN
-        WARNING: Stimulus Reflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
+      warn_and_exit <<~WARN
+        Stimulus Reflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
         To enable caching in development, run:
             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.
+        But your config.cache_store is set to :null_store, so it won't work.
+      WARN
+    end
   end
 
   def check_javascript_package_version
     if javascript_package_version.nil?
-      puts <<~WARN
-        WARNING: Can't locate the stimulus_reflex NPM package.
+      warn_and_exit <<~WARN
+        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?
-      puts <<~WARN
-        WARNING: The Stimulus Reflex javascript package version (#{javascript_package_version}) does not match the Rubygem version (#{gem_version}).
+      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}
       WARN
@@ -40,8 +48,11 @@ class StimulusReflex::SanityChecker
   private
 
   def caching_enabled?
-    Rails.application.config.action_controller.perform_caching &&
-      Rails.application.config.cache_store != :null_store
+    Rails.application.config.action_controller.perform_caching
+  end
+
+  def not_null_store?
+    Rails.application.config.cache_store != :null_store
   end
 
   def javascript_version_matches?
@@ -53,14 +64,11 @@ class StimulusReflex::SanityChecker
   end
 
   def javascript_package_version
-    return @_js_version if defined?(@_js_version)
-    @_js_version = find_javascript_package_version
+    @_js_version ||= find_javascript_package_version
   end
 
   def find_javascript_package_version
-    if (match = search_file(yarn_lock_path, regex: /^stimulus_reflex/))
-      match[NODE_VERSION_FORMAT, 1]
-    elsif (match = search_file(yarn_link_path, regex: /version/))
+    if (match = search_file(package_json_path, regex: /version/))
       match[JSON_VERSION_FORMAT, 1]
     end
   end
@@ -70,11 +78,54 @@ class StimulusReflex::SanityChecker
     File.foreach(path).grep(regex).first
   end
 
-  def yarn_lock_path
-    Rails.root.join("yarn.lock")
+  def package_json_path
+    Rails.root.join("node_modules", "stimulus_reflex", "package.json")
   end
 
-  def yarn_link_path
-    Rails.root.join("node_modules", "stimulus_reflex", "package.json")
+  def initializer_path
+    @_initializer_path ||= Rails.root.join("config", "initializers", "stimulus_reflex.rb")
+  end
+
+  def warn_and_exit(text)
+    puts "WARNING:"
+    puts text
+    exit_with_info if StimulusReflex.config.on_failed_sanity_checks == :exit
+  end
+
+  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,
+        you can add the following directive to the StimulusReflex initializer,
+        which is located at #{initializer_path}
+
+          StimulusReflex.configure do |config|
+            config.on_failed_sanity_checks = :warn
+          end
+
+      INFO
+    else
+      puts <<~INFO
+        If you know what you are doing and you want to start the application anyway,
+        you can create a StimulusReflex initializer with the command:
+      
+        bundle exec rails generate stimulus_reflex:config
+      
+        Then open your initializer at
+      
+        <RAILS_ROOT>/config/initializers/stimulus_reflex.rb
+      
+        and then add the following directive:
+
+          StimulusReflex.configure do |config|
+            config.on_failed_sanity_checks = :warn
+          end
+
+      INFO
+    end
+    exit
   end
 end

data/lib/stimulus_reflex/version.rb

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

data/lib/tasks/stimulus_reflex/install.rake

@@ -6,18 +6,20 @@ require "stimulus_reflex/version"
 namespace :stimulus_reflex do
   desc "Install StimulusReflex in this application"
   task install: :environment do
+    system "bundle add cable_ready"
     system "bundle exec rails webpacker:install:stimulus"
     gem_version = StimulusReflex::VERSION.gsub(".pre", "-pre")
-    system "yarn add stimulus_reflex@#{gem_version}"
+    system "yarn add cable_ready stimulus_reflex@#{gem_version}"
+    main_folder = defined?(Webpacker) ? Webpacker.config.source_path.to_s.gsub("#{Rails.root}/", "") : "app/javascript"
 
-    FileUtils.mkdir_p Rails.root.join("app/javascript/controllers"), verbose: true
+    FileUtils.mkdir_p Rails.root.join("#{main_folder}/controllers"), verbose: true
     FileUtils.mkdir_p Rails.root.join("app/reflexes"), verbose: true
 
-    filepath = %w[
-      app/javascript/controllers/index.js
-      app/javascript/controllers/index.ts
-      app/javascript/packs/application.js
-      app/javascript/packs/application.ts
+    filepath = [
+      "#{main_folder}/controllers/index.js",
+      "#{main_folder}/controllers/index.ts",
+      "#{main_folder}/packs/application.js",
+      "#{main_folder}/packs/application.ts"
     ]
       .select { |path| File.exist?(path) }
       .map { |path| Rails.root.join(path) }
@@ -42,7 +44,8 @@ namespace :stimulus_reflex do
     end
 
     initialize_line = lines.find { |line| line.start_with?("StimulusReflex.initialize") }
-    lines << "StimulusReflex.initialize(application, { consumer, controller, debug: false })\n" unless initialize_line
+    lines << "StimulusReflex.initialize(application, { consumer, 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")
@@ -63,6 +66,7 @@ namespace :stimulus_reflex do
     end
 
     system "bundle exec rails generate stimulus_reflex example"
+    system "bundle exec rails generate stimulus_reflex:config"
     system "rails dev:cache" unless Rails.root.join("tmp", "caching-dev.txt").exist?
   end
 end

data/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "stimulus_reflex",
+  "version": "3.4.0-pre2",
+  "description": "Build reactive applications with the Rails tooling you already know and love.",
+  "keywords": [
+    "ruby",
+    "rails",
+    "websockets",
+    "actioncable",
+    "turbolinks",
+    "reactive",
+    "cable",
+    "ujs",
+    "ssr",
+    "stimulus",
+    "reflex",
+    "stimulus_reflex",
+    "dom",
+    "morphdom"
+  ],
+  "homepage": "https://docs.stimulusreflex.com/",
+  "bugs": {
+    "url": "https://github.com/hopsoft/stimulus_reflex/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com:hopsoft/stimulus_reflex.git"
+  },
+  "license": "MIT",
+  "author": "Nathan Hopkins <natehop@gmail.com>",
+  "source": "javascript/stimulus_reflex.js",
+  "main": "javascript/dist/stimulus_reflex.js",
+  "module": "javascript/dist/stimulus_reflex.module.js",
+  "esmodule": "javascript/dist/stimulus_reflex.modern.js",
+  "scripts": {
+    "prepare": "yarn build",
+    "postinstall": "node javascript/scripts/post_install.js",
+    "prettier-standard:check": "yarn run prettier-standard --check *.js **/*.js",
+    "prettier-standard:format": "yarn run prettier-standard *.js **/*.js",
+    "test": "yarn run mocha --require @babel/register --require esm ./javascript/test",
+    "build": "microbundle --target browser --format modern,es,cjs --no-strict",
+    "dev": "microbundle watch --target browser --format modern,es,cjs --no-strict"
+  },
+  "peerDependencies": {
+    "@rails/actioncable": ">= 6.0",
+    "cable_ready": ">= 4.3.0",
+    "stimulus": ">= 1.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.6.2",
+    "@babel/preset-env": "^7.6.2",
+    "@babel/register": "^7.6.2",
+    "@rails/actioncable": "^6.0.3-3",
+    "assert": "^2.0.0",
+    "cable_ready": "^4.4.0-pre2",
+    "esm": "^3.2.25",
+    "jsdom": "^16.0.1",
+    "microbundle": "^0.12.3",
+    "mocha": "^8.0.1",
+    "prettier-standard": "^16.1.0",
+    "stimulus": "^1.1.1"
+  }
+}