stimulus_reflex 3.5.0.pre9 → 3.5.0.rc1

data/lib/install/bundle.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+hash = gemfile_hash
+
+# run bundle only when gems are waiting to be added or removed
+add = add_gem_list.exist? ? add_gem_list.readlines.map(&:chomp) : []
+remove = remove_gem_list.exist? ? remove_gem_list.readlines.map(&:chomp) : []
+
+if add.present? || remove.present?
+  lines = gemfile_path.readlines
+
+  remove.each do |name|
+    index = lines.index { |line| line =~ /gem ['"]#{name}['"]/ }
+    if index
+      if /^[^#]*gem ['"]#{name}['"]/.match?(lines[index])
+        lines[index] = "# #{lines[index]}"
+        say "✅ #{name} gem has been disabled"
+      else
+        say "⏩ #{name} gem is already disabled. Skipping."
+      end
+    end
+  end
+
+  add.each do |package|
+    matches = package.match(/(.+)@(.+)/)
+    name, version = matches[1], matches[2]
+
+    index = lines.index { |line| line =~ /gem ['"]#{name}['"]/ }
+    if index
+      if !lines[index].match(/^[^#]*gem ['"]#{name}['"].*#{version}['"]/)
+        lines[index] = "\ngem \"#{name}\", \"#{version}\"\n"
+        say "✅ #{name} gem has been installed"
+      else
+        say "⏩ #{name} gem is already installed. Skipping."
+      end
+    else
+      lines << "\ngem \"#{name}\", \"#{version}\"\n"
+    end
+  end
+
+  gemfile_path.write lines.join
+
+  bundle_command("install --quiet", "BUNDLE_IGNORE_MESSAGES" => "1") if hash != gemfile_hash
+else
+  say "⏩ No rubygems depedencies to install. Skipping."
+end
+
+FileUtils.cp(development_working_path, development_path)
+say "✅ development environment configuration installed"
+
+FileUtils.cp(action_cable_initializer_working_path, action_cable_initializer_path)
+say "✅ Action Cable initializer installed"
+
+complete_step :bundle

data/lib/install/compression.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+initializer = action_cable_initializer_working_path.read
+
+if gemfile.match?(/gem ['"]permessage_deflate['"]/)
+  say "⏩ permessage_deflate already present in Gemfile. Skipping."
+else
+  add_gem "permessage_deflate@>= 0.1"
+end
+
+# add permessage_deflate config to Action Cable initializer
+if initializer.exclude? "PermessageDeflate.configure"
+  create_or_append(action_cable_initializer_working_path, verbose: false) do
+    <<~RUBY
+      module ActionCable
+        module Connection
+          class ClientSocket
+            alias_method :old_initialize, :initialize
+            def initialize(env, event_target, event_loop, protocols)
+              old_initialize(env, event_target, event_loop, protocols)
+              @driver.add_extension(
+                PermessageDeflate.configure(
+                  level: Zlib::BEST_COMPRESSION,
+                  max_window_bits: 13
+                )
+              )
+            end
+          end
+        end
+      end
+    RUBY
+  end
+
+  say "✅ Action Cable initializer patched to deflate websocket traffic"
+else
+  say "⏩ Action Cable initializer is already patched to deflate websocket traffic. Skipping."
+end
+
+complete_step :compression

data/lib/install/config.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+return if pack_path_missing?
+
+step_path = "/app/javascript/config/"
+index_src = fetch(step_path, "index.js.tt")
+index_path = config_path / "index.js"
+friendly_index_path = index_path.relative_path_from(Rails.root).to_s
+stimulus_reflex_src = fetch(step_path, "stimulus_reflex.js.tt")
+stimulus_reflex_path = config_path / "stimulus_reflex.js"
+friendly_stimulus_reflex_path = stimulus_reflex_path.relative_path_from(Rails.root).to_s
+cable_ready_src = fetch(step_path, "cable_ready.js.tt")
+cable_ready_path = config_path / "cable_ready.js"
+
+empty_directory config_path unless config_path.exist?
+
+if index_path.exist?
+  say "⏩ #{friendly_index_path} already exists. Skipping"
+else
+  backup(index_path, delete: true) do
+    copy_file(index_src, index_path)
+  end
+  say "✅ Created #{friendly_index_path}"
+end
+
+index_pattern = /import ['"](\.\.\/|\.\/)?config['"]/
+index_commented_pattern = /\s*\/\/\s*#{index_pattern}/
+index_import = "import \"#{prefix}config\"\n"
+
+if pack.match?(index_pattern)
+  if pack.match?(index_commented_pattern)
+    lines = pack_path.readlines
+    matches = lines.select { |line| line =~ index_commented_pattern }
+    lines[lines.index(matches.last).to_i] = index_import
+    pack_path.write lines.join
+
+    say "✅ Uncommented StimulusReflex and CableReady configs imports in #{friendly_pack_path}"
+  else
+    say "⏩ StimulusReflex and CableReady configs are already being imported in #{friendly_pack_path}. Skipping"
+  end
+else
+  lines = pack_path.readlines
+  matches = lines.select { |line| line =~ /^import / }
+  lines.insert lines.index(matches.last).to_i + 1, index_import
+  pack_path.write lines.join
+
+  say "✅ StimulusReflex and CableReady configs will be imported in #{friendly_pack_path}"
+end
+
+# create entrypoint/config/cable_ready.js and make sure it's imported in application.js
+copy_file(cable_ready_src, cable_ready_path) unless cable_ready_path.exist?
+
+# create entrypoint/config/stimulus_reflex.js and make sure it's imported in application.js
+copy_file(stimulus_reflex_src, stimulus_reflex_path) unless stimulus_reflex_path.exist?
+
+if stimulus_reflex_path.read.include?("StimulusReflex.debug =")
+  say "⏩ Development environment options are already set in #{friendly_stimulus_reflex_path}. Skipping"
+else
+  if ["webpacker", "shakapacker"].include?(bundler)
+    append_file(stimulus_reflex_path, <<~JS, verbose: false)
+
+      if (process.env.RAILS_ENV === 'development') {
+        StimulusReflex.debug = true
+      }
+    JS
+  elsif bundler == "vite"
+    append_file(stimulus_reflex_path, <<~JS, verbose: false) unless stimulus_reflex_path.read.include?("StimulusReflex.debug")
+
+      if (import.meta.env.MODE === "development") {
+        StimulusReflex.debug = true
+      }
+    JS
+  else
+    append_file(stimulus_reflex_path, <<~JS, verbose: false)
+
+      // consider removing these options in production
+      StimulusReflex.debug = true
+      // end remove
+    JS
+  end
+
+  say "✅ Set useful development environment options in #{friendly_stimulus_reflex_path}"
+end
+
+complete_step :config

data/lib/install/development.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+# mutate working copy of development.rb to avoid bundle alerts
+FileUtils.cp(development_path, development_working_path)
+
+# add default_url_options to development.rb for Action Mailer
+if defined?(ActionMailer)
+  lines = development_working_path.readlines
+  if lines.find { |line| line.include?("config.action_mailer.default_url_options") }
+    say "⏩ Action Mailer default_url_options already defined. Skipping."
+  else
+    index = lines.index { |line| line =~ /^Rails.application.configure do/ }
+    lines.insert index + 1, "  config.action_mailer.default_url_options = {host: \"localhost\", port: 3000}\n\n"
+    development_working_path.write lines.join
+
+    say "✅ Action Mailer default_url_options defined"
+  end
+end
+
+# add default_url_options to development.rb for Action Controller
+lines = development_working_path.readlines
+if lines.find { |line| line.include?("config.action_controller.default_url_options") }
+  say "⏩ Action Controller default_url_options already defined. Skipping."
+else
+  index = lines.index { |line| line =~ /^Rails.application.configure do/ }
+  lines.insert index + 1, "  config.action_controller.default_url_options = {host: \"localhost\", port: 3000}\n"
+  development_working_path.write lines.join
+
+  say "✅ Action Controller default_url_options defined"
+end
+
+# halt with instructions if using cookie store, otherwise, nudge towards Redis
+lines = development_working_path.readlines
+
+if (index = lines.index { |line| line =~ /^[^#]*config.session_store/ })
+  if /^[^#]*cookie_store/.match?(lines[index])
+    write_redis_recommendation(development_working_path, lines, index, gemfile)
+    halt "StimulusReflex does not support session cookies. See https://docs.stimulusreflex.com/hello-world/setup#session-storage"
+    return
+  elsif /^[^#]*redis_session_store/.match?(lines[index])
+    say "⏩ Already using redis-session-store for session storage. Skipping."
+  else
+    write_redis_recommendation(development_working_path, lines, index, gemfile)
+    say "🤷 We recommend using redis-session-store for session storage. See https://docs.stimulusreflex.com/hello-world/setup#session-storage"
+  end
+# no session store defined, so let's opt-in to redis-session-store
+else
+  # add redis-session-store to Gemfile
+  if !gemfile.match?(/gem ['"]redis-session-store['"]/)
+    if ActionCable::VERSION::MAJOR >= 7
+      add_gem "redis-session-store@~> 0.11.5"
+    else
+      add_gem "redis-session-store@0.11.4"
+    end
+  end
+
+  index = lines.index { |line| line =~ /^Rails.application.configure do/ }
+  lines.insert index + 1, <<~RUBY
+
+    config.session_store :redis_session_store,
+      serializer: :json,
+      on_redis_down: ->(*a) { Rails.logger.error("Redis down! \#{a.inspect}") },
+      redis: {
+        expire_after: 120.minutes,
+        key_prefix: "session:",
+        url: ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" }
+      }
+  RUBY
+  development_working_path.write lines.join
+  say "✅ Using redis-session-store for session storage"
+end
+
+# switch to redis for caching if using memory store, otherwise nudge with a comment
+lines = development_working_path.readlines
+
+if (index = lines.index { |line| line =~ /^[^#]*config.cache_store = :memory_store/ })
+  lines[index] = <<~RUBY
+    config.cache_store = :redis_cache_store, {
+      url: ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" }
+    }
+  RUBY
+  development_working_path.write lines.join
+  say "✅ Using Redis for caching"
+elsif lines.index { |line| line =~ /^[^#]*config.cache_store = :redis_cache_store/ }
+  say "⏩ Already using Redis for caching. Skipping."
+else
+  if !lines.index { |line| line.include?("We couldn't identify your cache store") }
+    lines.insert find_index(lines), <<~RUBY
+
+      # We couldn't identify your cache store, but recommend using Redis:
+
+      # config.cache_store = :redis_cache_store, {
+      #   url: ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" }
+      # }
+    RUBY
+    development_working_path.write lines.join
+  end
+  say "🤷 We couldn't identify your cache store, but recommend using Redis. See https://docs.stimulusreflex.com/appendices/deployment#use-redis-as-your-cache-store"
+end
+
+if Rails.root.join("tmp", "caching-dev.txt").exist?
+  say "⏩ Already caching in development. Skipping."
+else
+  system "rails dev:cache"
+  say "✅ Enabled caching in development"
+end
+
+complete_step :development

data/lib/install/esbuild.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+return if pack_path_missing?
+
+# verify that all critical dependencies are up to date; if not, queue for later
+lines = package_json.readlines
+
+if !lines.index { |line| line =~ /^\s*["']esbuild-rails["']: ["']\^1.0.3["']/ }
+  add_package "esbuild-rails@^1.0.3"
+else
+  say "⏩ esbuild-rails npm package is already present. Skipping."
+end
+
+# copy esbuild.config.mjs to app root
+esbuild_src = fetch("/", "esbuild.config.mjs.tt")
+esbuild_path = Rails.root.join("esbuild.config.mjs")
+
+if esbuild_path.exist?
+  if esbuild_path.read == esbuild_src.read
+    say "⏩ esbuild.config.mjs already present in app root. Skipping."
+  else
+    backup(esbuild_path) do
+      template(esbuild_src, esbuild_path, verbose: false, entrypoint: entrypoint)
+    end
+    say "✅ updated esbuild.config.mjs in app root"
+  end
+else
+  template(esbuild_src, esbuild_path, entrypoint: entrypoint)
+  say "✅ Created esbuild.config.mjs in app root"
+end
+
+step_path = "/app/javascript/controllers/"
+application_controller_src = fetch(step_path, "application_controller.js.tt")
+application_controller_path = controllers_path / "application_controller.js"
+application_js_src = fetch(step_path, "application.js.tt")
+application_js_path = controllers_path / "application.js"
+index_src = fetch(step_path, "index.js.esbuild.tt")
+index_path = controllers_path / "index.js"
+friendly_index_path = index_path.relative_path_from(Rails.root).to_s
+
+# create entrypoint/controllers, if necessary
+empty_directory controllers_path unless controllers_path.exist?
+
+# copy application_controller.js, if necessary
+copy_file(application_controller_src, application_controller_path) unless application_controller_path.exist?
+
+# configure Stimulus application superclass to import Action Cable consumer
+friendly_application_js_path = application_js_path.relative_path_from(Rails.root).to_s
+
+if application_js_path.exist?
+  backup(application_js_path) do
+    if application_js_path.read.include?("import consumer")
+      say "⏩ #{friendly_application_js_path} is already present. Skipping."
+    else
+      inject_into_file application_js_path, "import consumer from \"../channels/consumer\"\n", after: "import { Application } from \"@hotwired/stimulus\"\n", verbose: false
+      inject_into_file application_js_path, "application.consumer = consumer\n", after: "application.debug = false\n", verbose: false
+      say "✅ #{friendly_application_js_path} has been updated to import the Action Cable consumer"
+    end
+  end
+else
+  copy_file(application_js_src, application_js_path)
+  say "✅ #{friendly_application_js_path} has been created"
+end
+
+if index_path.exist?
+  if index_path.read == index_src.read
+    say "⏩ #{friendly_index_path} already present. Skipping."
+  else
+    backup(index_path, delete: true) do
+      copy_file(index_src, index_path, verbose: false)
+    end
+
+    say "✅ #{friendly_index_path} has been updated"
+  end
+else
+  copy_file(index_src, index_path)
+  say "✅ #{friendly_index_path} has been created"
+end
+
+controllers_pattern = /import ['"].\/controllers['"]/
+controllers_commented_pattern = /\s*\/\/\s*#{controllers_pattern}/
+
+if pack.match?(controllers_pattern)
+  if pack.match?(controllers_commented_pattern)
+    proceed = if options.key? "uncomment"
+      options["uncomment"]
+    else
+      !no?("✨ Stimulus seems to be commented out in your application.js. Do you want to import your controllers? (Y/n)")
+    end
+
+    if proceed
+      # uncomment_lines only works with Ruby comments 🙄
+      lines = pack_path.readlines
+      matches = lines.select { |line| line =~ controllers_commented_pattern }
+      lines[lines.index(matches.last).to_i] = "import \".\/controllers\"\n" # standard:disable Style/RedundantStringEscape
+      pack_path.write lines.join
+      say "✅ Uncommented Stimulus controllers import in #{friendly_pack_path}"
+    else
+      say "🤷 your Stimulus controllers are not being imported in your application.js. We trust that you have a reason for this."
+    end
+  else
+    say "⏩ Stimulus controllers are already being imported in #{friendly_pack_path}. Skipping."
+  end
+else
+  lines = pack_path.readlines
+  matches = lines.select { |line| line =~ /^import / }
+  lines.insert lines.index(matches.last).to_i + 1, "import \".\/controllers\"\n" # standard:disable Style/RedundantStringEscape
+  pack_path.write lines.join
+  say "✅ Stimulus controllers imported in #{friendly_pack_path}"
+end
+
+complete_step :esbuild

data/lib/install/example.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+proceed = false
+if !Rails.root.join("app/reflexes/example_reflex.rb").exist?
+  proceed = if options.key? "example"
+    options["example"]
+  else
+    !no?("✨ Generate an example Reflex with a quick demo? You can remove it later with a single command. (Y/n)")
+  end
+else
+  say "⏩ app/reflexes/example_reflex.rb already exists."
+end
+
+if proceed
+  generate("stimulus_reflex", "example")
+else
+  say "⏩ Skipping."
+end
+
+complete_step :example

data/lib/install/importmap.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+return if pack_path_missing?
+
+if !importmap_path.exist?
+  halt "#{friendly_importmap_path} is missing. You need a valid importmap config file to proceed."
+  return
+end
+
+importmap = importmap_path.read
+
+backup(importmap_path) do
+  if !importmap.include?("pin_all_from \"#{entrypoint}/controllers\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin_all_from "#{entrypoint}/controllers", under: "controllers"
+    RUBY
+    say "✅ pin_all_from controllers"
+  else
+    say "⏩ pin_all_from controllers already pinned. Skipping."
+  end
+
+  if !importmap.include?("pin_all_from \"#{entrypoint}/channels\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin_all_from "#{entrypoint}/channels", under: "channels"
+    RUBY
+    say "✅ pin_all_from channels"
+  else
+    say "⏩ pin_all_from channels already pinned. Skipping."
+  end
+
+  if !importmap.include?("pin_all_from \"#{entrypoint}/config\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin_all_from "#{entrypoint}/config", under: "config"
+    RUBY
+    say "✅ pin_all_from config"
+  else
+    say "⏩ pin_all_from config already pinned. Skipping."
+  end
+
+  if !importmap.include?("pin \"@rails/actioncable\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin "@rails/actioncable", to: "actioncable.esm.js", preload: true
+    RUBY
+    say "✅ pin @rails/actioncable"
+  else
+    say "⏩ @rails/actioncable already pinned. Skipping."
+  end
+
+  if !importmap.include?("pin \"@hotwired/stimulus\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin "@hotwired/stimulus", to: "stimulus.js", preload: true
+    RUBY
+    say "✅ pin @hotwired/stimulus"
+  else
+    say "⏩ @hotwired/stimulus already pinned. Skipping."
+  end
+
+  if !importmap.include?("pin \"morphdom\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin "morphdom", to: "https://ga.jspm.io/npm:morphdom@2.6.1/dist/morphdom.js", preload: true
+    RUBY
+    say "✅ pin morphdom"
+  else
+    say "⏩ morphdom already pinned. Skipping."
+  end
+
+  if !importmap.include?("pin \"cable_ready\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin "cable_ready", to: "cable_ready.js", preload: true
+    RUBY
+    say "✅ pin cable_ready"
+  else
+    say "⏩ cable_ready already pinned. Skipping."
+  end
+
+  if !importmap.include?("pin \"stimulus_reflex\"")
+    append_file(importmap_path, <<~RUBY, verbose: false)
+      pin "stimulus_reflex", to: "stimulus_reflex.js", preload: true
+    RUBY
+    say "✅ pin stimulus_reflex"
+  else
+    say "⏩ stimulus_reflex already pinned. Skipping."
+  end
+end
+
+application_controller_src = fetch("/", "app/javascript/controllers/application_controller.js.tt")
+application_controller_path = controllers_path / "application_controller.js"
+application_js_src = fetch("/", "app/javascript/controllers/application.js.tt")
+application_js_path = controllers_path / "application.js"
+index_src = fetch("/", "app/javascript/controllers/index.js.importmap.tt")
+index_path = controllers_path / "index.js"
+
+# create entrypoint/controllers, as well as the index, application and application_controller
+empty_directory controllers_path unless controllers_path.exist?
+
+copy_file(application_controller_src, application_controller_path) unless application_controller_path.exist?
+
+# configure Stimulus application superclass to import Action Cable consumer
+backup(application_js_path) do
+  if application_js_path.exist?
+    friendly_application_js_path = application_js_path.relative_path_from(Rails.root).to_s
+    if application_js_path.read.include?("import consumer")
+      say "⏩ #{friendly_application_js_path} is present. Skipping."
+    else
+      inject_into_file application_js_path, "import consumer from \"../channels/consumer\"\n", after: "import { Application } from \"@hotwired/stimulus\"\n", verbose: false
+      inject_into_file application_js_path, "application.consumer = consumer\n", after: "application.debug = false\n", verbose: false
+      say "✅ #{friendly_application_js_path} has been updated to import the Action Cable consumer"
+    end
+  else
+    copy_file(application_js_src, application_js_path)
+    say "✅ #{friendly_application_js_path} has been created"
+  end
+end
+
+if index_path.exist?
+  friendly_index_path = index_path.relative_path_from(Rails.root).to_s
+
+  if index_path.read == index_src.read
+    say "⏩ #{friendly_index_path} is present. Skipping"
+  else
+    backup(index_path, delete: true) do
+      copy_file(index_src, index_path, verbose: false)
+    end
+    say "✅ #{friendly_index_path} has been updated"
+  end
+else
+  copy_file(index_src, index_path)
+  say "✅ #{friendly_index_path} has been created."
+end
+
+complete_step :importmap

data/lib/install/initializers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/installer"
+
+sr_initializer_src = fetch("/", "config/initializers/stimulus_reflex.rb")
+sr_initializer_path = Rails.root.join("config/initializers/stimulus_reflex.rb")
+
+cr_initializer_src = fetch("/", "config/initializers/cable_ready.rb")
+cr_initializer_path = Rails.root.join("config/initializers/cable_ready.rb")
+
+if !sr_initializer_path.exist?
+  copy_file(sr_initializer_src, sr_initializer_path, verbose: false)
+  say "✅ StimulusReflex initializer created at config/initializers/stimulus_reflex.rb"
+else
+  say "⏩ config/initializers/stimulus_reflex.rb already exists. Skipping."
+end
+
+if !cr_initializer_path.exist?
+  copy_file(cr_initializer_src, cr_initializer_path, verbose: false)
+  say "✅ CableReady initializer created at config/initializers/cable_ready.rb"
+else
+  say "⏩ config/initializers/cable_ready.rb already exists. Skipping."
+end
+
+complete_step :initializers