stimulus_reflex 3.4.1 → 3.5.0.pre3

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (3.4.1)
-      cable_ready (>= 4.5)
+    stimulus_reflex (3.5.0.pre3)
+      cable_ready (= 5.0.0.pre4)
       nokogiri
       rack
       rails (>= 5.2)
@@ -11,60 +11,60 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.1)
-      actionpack (= 6.1.1)
-      activesupport (= 6.1.1)
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.1)
-      actionpack (= 6.1.1)
-      activejob (= 6.1.1)
-      activerecord (= 6.1.1)
-      activestorage (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       mail (>= 2.7.1)
-    actionmailer (6.1.1)
-      actionpack (= 6.1.1)
-      actionview (= 6.1.1)
-      activejob (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.1)
-      actionview (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.1)
-      actionpack (= 6.1.1)
-      activerecord (= 6.1.1)
-      activestorage (= 6.1.1)
-      activesupport (= 6.1.1)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       nokogiri (>= 1.8.5)
-    actionview (6.1.1)
-      activesupport (= 6.1.1)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.1)
-      activesupport (= 6.1.1)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.1)
-      activesupport (= 6.1.1)
-    activerecord (6.1.1)
-      activemodel (= 6.1.1)
-      activesupport (= 6.1.1)
-    activestorage (6.1.1)
-      actionpack (= 6.1.1)
-      activejob (= 6.1.1)
-      activerecord (= 6.1.1)
-      activesupport (= 6.1.1)
-      marcel (~> 0.3.1)
-      mimemagic (~> 0.3.2)
-    activesupport (6.1.1)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -72,35 +72,36 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
-    cable_ready (4.5.0)
+    cable_ready (5.0.0.pre4)
       rails (>= 5.2)
       thread-local (>= 1.1.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.7)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.9.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.2)
     method_source (0.9.2)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
-    minitest (5.14.3)
-    nio4r (2.5.4)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    mini_mime (1.1.1)
+    minitest (5.14.4)
+    mocha (1.13.0)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -111,50 +112,50 @@ GEM
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.1)
-      actioncable (= 6.1.1)
-      actionmailbox (= 6.1.1)
-      actionmailer (= 6.1.1)
-      actionpack (= 6.1.1)
-      actiontext (= 6.1.1)
-      actionview (= 6.1.1)
-      activejob (= 6.1.1)
-      activemodel (= 6.1.1)
-      activerecord (= 6.1.1)
-      activestorage (= 6.1.1)
-      activesupport (= 6.1.1)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       bundler (>= 1.15.0)
-      railties (= 6.1.1)
+      railties (= 6.1.4.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.1)
-      actionpack (= 6.1.1)
-      activesupport (= 6.1.1)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 0.13)
       thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.3)
-    redis (4.2.5)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rubocop (1.7.0)
+    rake (13.0.6)
+    redis (4.4.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     sprockets (4.0.2)
@@ -164,31 +165,34 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    standard (0.11.0)
-      rubocop (= 1.7.0)
-      rubocop-performance (= 1.9.2)
+    standard (1.1.5)
+      rubocop (= 1.18.3)
+      rubocop-performance (= 1.11.4)
     standardrb (1.0.0)
       standard
     thor (1.1.0)
     thread-local (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    websocket-driver (0.7.3)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  arm64-darwin-20
+  x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.0)
+  mocha
   pry
   pry-nav
   rake
-  standardrb
+  standardrb (~> 1.0)
   stimulus_reflex!
 
 BUNDLED WITH
-   2.1.4
+   2.2.4

data/LATEST

@@ -0,0 +1 @@
+3.4.1

data/README.md

@@ -7,11 +7,11 @@
     <a href="https://www.npmjs.com/package/stimulus_reflex">
       <img alt="downloads" src="https://img.shields.io/npm/dm/stimulus_reflex.svg?color=blue" target="_blank" />
     </a>
-    <a href="https://github.com/hopsoft/stimulus_reflex/blob/master/LICENSE">
+    <a href="https://github.com/stimulusreflex/stimulus_reflex/blob/master/LICENSE">
       <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-brightgreen.svg" target="_blank" />
     </a>
     <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/" target="_blank">
-      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-1726-brightgreen.svg?style=flat" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-2190-brightgreen.svg?style=flat" />
     </a>
     <a href="https://docs.stimulusreflex.com/" target="_blank">
       <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
@@ -30,14 +30,14 @@
     <a href="https://www.codacy.com/manual/hopsoft/stimulus_reflex/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=hopsoft/stimulus_reflex&amp;utm_campaign=Badge_Grade" target="_blank">
       <img alt="Code Quality" src="https://app.codacy.com/project/badge/Grade/d1d72a7060f5467b8696884351cf477f"/>
     </a>
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/hopsoft/stimulus_reflex/workflows/Prettier-Standard/badge.svg">
-      <img src="https://github.com/hopsoft/stimulus_reflex/workflows/Prettier-Standard/badge.svg" alt="Prettier-Standard" style="max-width:100%;">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/workflows/Prettier-Standard/badge.svg">
+      <img src="https://github.com/stimulusreflex/stimulus_reflex/workflows/Prettier-Standard/badge.svg" alt="Prettier-Standard" style="max-width:100%;">
     </a>
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/hopsoft/stimulus_reflex/workflows/StandardRB/badge.svg">
-      <img src="https://github.com/hopsoft/stimulus_reflex/workflows/StandardRB/badge.svg" alt="StandardRB" style="max-width:100%;">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/workflows/StandardRB/badge.svg">
+      <img src="https://github.com/stimulusreflex/stimulus_reflex/workflows/StandardRB/badge.svg" alt="StandardRB" style="max-width:100%;">
     </a>
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/hopsoft/stimulus_reflex/workflows/Tests/badge.svg">
-      <img src="https://github.com/hopsoft/stimulus_reflex/workflows/Tests/badge.svg" alt="Tests">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/workflows/Tests/badge.svg">
+      <img src="https://github.com/stimulusreflex/stimulus_reflex/workflows/Tests/badge.svg" alt="Tests">
     </a>
   </p>
 </p>
@@ -69,13 +69,14 @@ This project strives to live up to the vision outlined in [The Rails Doctrine](h
 
 ## ✨ Demos
 
-- [StimulusReflex Expo](http://expo.stimulusreflex.com) - part showcase, part learning tool
 - [Build a Twitter Clone in 10 Minutes](https://youtu.be/F5hA79vKE_E) (video)
+- [BeastMode](https://beastmode.leastbad.com/) - faceted search, with filtering, sorting and pagination
+- [StimulusReflex Patterns](https://www.stimulusreflexpatterns.com/patterns/) - single-file SR apps hosted on Glitch
 - [BoxDrop](https://dropbox-clone-rails.herokuapp.com/) - a Dropbox-inspired [concept demo](https://github.com/marcoroth/boxdrop/)
 
 ## 👩‍👩‍👧 Discord Community
 
-Please join over 1000 of us on [Discord](https://discord.gg/XveN625) for support getting started, as well as active discussions around Rails, StimulusJS and CableReady.
+Please join over 1500 of us on [Discord](https://discord.gg/stimulus-reflex) for support getting started, as well as active discussions around Rails, StimulusJS and CableReady.
 
 ![](https://img.shields.io/discord/629472241427415060)
 
@@ -89,7 +90,7 @@ Please note that we are not actively providing support on Stack Overflow. If you
 
 ## 🚀 Installation and upgrading
 
-CLI and manual setup procedures are fully detailed in the [official docs](https://docs.stimulusreflex.com/setup). For information on upgrading existing projects to v3.4, read [this](https://docs.stimulusreflex.com/setup#upgrading-to-v-3-4-0).
+CLI and manual setup procedures are fully detailed in the [official docs](https://docs.stimulusreflex.com/setup). For information on upgrading existing projects to v3.4, read [this](https://docs.stimulusreflex.com/hello-world/setup#upgrading-to-v-3-4-0).
 
 ## 🙏 Contributing
 
@@ -104,15 +105,15 @@ and [Prettier-Standard](https://github.com/sheerun/prettier-standard) for JavaSc
 
 Please run `./bin/standardize` prior to submitting pull requests.
 
-View the [wiki](https://github.com/hopsoft/stimulus_reflex/wiki/Editor-Configuration) to see recommendations for configuring your editor to work best with the project.
+View the [wiki](https://github.com/stimulusreflex/stimulus_reflex/wiki/Editor-Configuration) to see recommendations for configuring your editor to work best with the project.
 
 ## 📦 Releasing
 
 1. Bump version number at `lib/stimulus_reflex/version.rb`
-1. Run `rake build`
-1. Run `rake release`
-1. Run `yarn publish --no-git-tag-version`
-1. Commit and push changes to the `package.json` file
+2. Run `rake build`
+3. Run `rake release`
+4. Run `yarn publish --no-git-tag-version`
+5. Commit and push changes to the `package.json` file
 
 ## 📝 License
 

data/app/channels/stimulus_reflex/channel.rb

@@ -1,65 +1,38 @@
 # frozen_string_literal: true
 
 class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.constantize
+  attr_reader :reflex_data
+
   def stream_name
-    ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
-    [
-      params[:channel],
-      ids.select(&:present?).join(";")
-    ].select(&:present?).join(":")
+    [params[:channel], connection.connection_identifier].join(":")
   end
 
   def subscribed
     super
-    fix_environment!
     stream_from stream_name
   end
 
   def receive(data)
-    url = data["url"].to_s
-    selectors = (data["selectors"] || []).select(&:present?)
-    selectors = data["selectors"] = ["body"] if selectors.blank?
-    target = data["target"].to_s
-    reflex_name, method_name = target.split("#")
-    reflex_name = reflex_name.camelize
-    reflex_name = reflex_name.end_with?("Reflex") ? reflex_name : "#{reflex_name}Reflex"
-    arguments = (data["args"] || []).map { |arg| object_with_indifferent_access arg }
-    element = StimulusReflex::Element.new(data)
-    permanent_attribute_name = data["permanentAttributeName"]
-    form_data = Rack::Utils.parse_nested_query(data["formData"])
-    params = form_data.deep_merge(data["params"] || {})
-
+    @reflex_data = StimulusReflex::ReflexData.new(data)
     begin
       begin
-        reflex_class = reflex_name.constantize.tap { |klass| raise ArgumentError.new("#{reflex_name} is not a StimulusReflex::Reflex") unless is_reflex?(klass) }
-        reflex = reflex_class.new(self,
-          url: url,
-          element: element,
-          selectors: selectors,
-          method_name: method_name,
-          params: params,
-          client_attributes: {
-            reflex_id: data["reflexId"],
-            xpath_controller: data["xpathController"],
-            xpath_element: data["xpathElement"],
-            reflex_controller: data["reflexController"],
-            permanent_attribute_name: permanent_attribute_name
-          })
-        delegate_call_to_reflex reflex, method_name, arguments
-      rescue => invoke_error
-        message = exception_message_with_backtrace(invoke_error)
-        body = "Reflex #{target} failed: #{message} [#{url}]"
+        reflex = StimulusReflex::ReflexFactory.create_reflex_from_data(self, @reflex_data)
+        delegate_call_to_reflex reflex
+      rescue => exception
+        error = exception_with_backtrace(exception)
+        error_message = "\e[31mReflex #{reflex_data.target} failed: #{error[:message]} [#{reflex_data.url}]\e[0m\n#{error[:stack]}"
 
         if reflex
-          reflex.rescue_with_handler(invoke_error)
-          reflex.broadcast_message subject: "error", body: body, data: data, error: invoke_error
+          reflex.rescue_with_handler(exception)
+          reflex.logger&.error error_message
+          reflex.error data: data, body: "#{exception} #{exception.backtrace.first.split(":in ")[0] if Rails.env.development?}"
         else
-          puts "\e[31m#{body}\e[0m"
+          reflex.logger&.error error_message
 
           if body.to_s.include? "No route matches"
             initializer_path = Rails.root.join("config", "initializers", "stimulus_reflex.rb")
 
-            puts <<~NOTE
+            reflex.logger&.warn <<~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.
@@ -81,67 +54,63 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
       end
 
       if reflex.halted?
-        reflex.broadcast_message subject: "halted", data: data
+        reflex.halted data: data
       else
         begin
-          reflex.broadcast(selectors, data)
-        rescue => render_error
-          reflex.rescue_with_handler(render_error)
-          message = exception_message_with_backtrace(render_error)
-          body = "Reflex failed to re-render: #{message} [#{url}]"
-          reflex.broadcast_message subject: "error", body: body, data: data, error: render_error
-          puts "\e[31m#{body}\e[0m"
+          reflex.broadcast(reflex_data.selectors, data)
+        rescue => exception
+          reflex.rescue_with_handler(exception)
+          error = exception_with_backtrace(exception)
+          reflex.error data: data, body: "#{exception} #{exception.backtrace.first.split(":in ")[0] if Rails.env.development?}"
+          reflex.logger&.error "\e[31mReflex failed to re-render: #{error[:message]} [#{reflex_data.url}]\e[0m\n#{error[:stack]}"
         end
       end
     ensure
       if reflex
         commit_session(reflex)
-        reflex.logger.print
+        report_failed_basic_auth(reflex) if reflex.controller?
+        reflex.logger&.log_all_operations
       end
     end
   end
 
   private
 
-  def object_with_indifferent_access(object)
-    return object.with_indifferent_access if object.respond_to?(:with_indifferent_access)
-    object.map! { |obj| object_with_indifferent_access obj } if object.is_a?(Array)
-    object
-  end
-
-  def is_reflex?(reflex_class)
-    reflex_class.ancestors.include? StimulusReflex::Reflex
-  end
-
-  def delegate_call_to_reflex(reflex, method_name, arguments = [])
+  def delegate_call_to_reflex(reflex)
+    method_name = reflex_data.method_name
+    arguments = reflex_data.arguments
     method = reflex.method(method_name)
-    required_params = method.parameters.select { |(kind, _)| kind == :req }
-    optional_params = method.parameters.select { |(kind, _)| kind == :opt }
 
-    if arguments.size == 0 && required_params.size == 0
+    policy = StimulusReflex::ReflexMethodInvocationPolicy.new(method, arguments)
+
+    if policy.no_arguments?
       reflex.process(method_name)
-    elsif arguments.size >= required_params.size && arguments.size <= required_params.size + optional_params.size
+    elsif policy.arguments?
       reflex.process(method_name, *arguments)
     else
-      raise ArgumentError.new("wrong number of arguments (given #{arguments.inspect}, expected #{required_params.inspect}, optional #{optional_params.inspect})")
+      raise ArgumentError.new("wrong number of arguments (given #{arguments.inspect}, expected #{policy.required_params.inspect}, optional #{policy.optional_params.inspect})")
     end
   end
 
   def commit_session(reflex)
     store = reflex.request.session.instance_variable_get("@by")
     store.commit_session reflex.request, reflex.controller.response
-  rescue => e
-    message = "Failed to commit session! #{exception_message_with_backtrace(e)}"
-    puts "\e[31m#{message}\e[0m"
+  rescue => exception
+    error = exception_with_backtrace(exception)
+    reflex.logger&.error "\e[31mFailed to commit session! #{error[:message]}\e[0m\n#{error[:backtrace]}"
   end
 
-  def exception_message_with_backtrace(exception)
-    "#{exception}\n#{exception.backtrace.first}"
+  def report_failed_basic_auth(reflex)
+    if reflex.controller.response.status == 401
+      reflex.logger&.error "\e[31mReflex failed to process controller action \"#{reflex.controller.class}##{reflex.controller.action_name}\" due to HTTP basic auth. Consider adding \"unless: -> { @stimulus_reflex }\" to the before_action or method responible for authentication.\e[0m"
+    end
   end
 
-  def fix_environment!
-    ([ApplicationController] + ApplicationController.descendants).each do |controller|
-      controller.renderer.instance_variable_set(:@env, connection.env.merge(controller.renderer.instance_variable_get(:@env)))
-    end
+  def exception_with_backtrace(exception)
+    {
+      message: exception.to_s,
+      backtrace: exception.backtrace.first.split(":in ")[0],
+      stack: exception.backtrace.join("\n")
+    }
   end
 end

data/lib/generators/USAGE

@@ -11,4 +11,4 @@ Example:
         app/reflexes/application_reflex.rb
         app/reflexes/user_reflex.rb
 
-    Don't forget to setup the application: https://docs.stimulusreflex.com/setup
+    Don't forget to setup the application: https://docs.stimulusreflex.com/hello-world/setup

data/lib/generators/stimulus_reflex/{config_generator.rb → initializer_generator.rb}

@@ -3,11 +3,11 @@
 require "rails/generators"
 
 module StimulusReflex
-  class ConfigGenerator < Rails::Generators::Base
-    desc "Creates an StimulusReflex configuration file in config/initializers"
+  class InitializerGenerator < Rails::Generators::Base
+    desc "Creates a StimulusReflex initializer in config/initializers"
     source_root File.expand_path("templates", __dir__)
 
-    def copy_config_file
+    def copy_initializer_file
       copy_file "config/initializers/stimulus_reflex.rb"
     end
   end

data/lib/generators/stimulus_reflex/stimulus_reflex_generator.rb

@@ -7,20 +7,21 @@ class StimulusReflexGenerator < Rails::Generators::NamedBase
 
   argument :name, type: :string, required: true, banner: "NAME"
   argument :actions, type: :array, default: [], banner: "action action"
+  class_options skip_stimulus: false, skip_app_reflex: false, skip_reflex: false, skip_app_controller: false
 
   def execute
     actions.map!(&:underscore)
 
     copy_application_files if behavior == :invoke
 
-    template "app/reflexes/%file_name%_reflex.rb"
-    template "app/javascript/controllers/%file_name%_controller.js"
+    template "app/reflexes/%file_name%_reflex.rb" unless options[:skip_reflex]
+    template "app/javascript/controllers/%file_name%_controller.js" unless options[:skip_stimulus]
   end
 
   private
 
   def copy_application_files
-    template "app/reflexes/application_reflex.rb"
-    template "app/javascript/controllers/application_controller.js"
+    template "app/reflexes/application_reflex.rb" unless options[:skip_app_reflex]
+    template "app/javascript/controllers/application_controller.js" unless options[:skip_app_controller]
   end
 end

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

@@ -17,12 +17,13 @@ class <%= class_name %>Reflex < 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:
   #
   #   before_reflex do
   #     # throw :abort # this will prevent the Reflex from continuing
-  #     # learn more about callbacks at https://docs.stimulusreflex.com/lifecycle
+  #     # learn more about callbacks at https://docs.stimulusreflex.com/rtfm/lifecycle
   #   end
   #
   #   def example(argument=true)
@@ -30,7 +31,7 @@ class <%= class_name %>Reflex < ApplicationReflex
   #     # Any declared instance variables will be made available to the Rails controller and view.
   #   end
   #
-  # Learn more at: https://docs.stimulusreflex.com/reflexes#reflex-classes
+  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
 
 <% actions.each do |action| -%>
   def <%= action %>

data/lib/generators/stimulus_reflex/templates/app/reflexes/application_reflex.rb.tt

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
 class ApplicationReflex < StimulusReflex::Reflex
-  # Put application-wide Reflex behavior and callbacks in this file. 
+  # Put application-wide Reflex behavior and callbacks in this file.
   #
-  # Example:
+  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
   #
-  #   # If your ActionCable connection is: `identified_by :current_user`
+  # If your ActionCable connection is: `identified_by :current_user`
   #   delegate :current_user, to: :connection
   #
-  # Learn more at: https://docs.stimulusreflex.com/reflexes#reflex-classes
+  # 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
 end