cable_ready 5.0.3 → 5.0.4

data/lib/install/broadcaster.rb

@@ -2,14 +2,14 @@
 
 require "cable_ready/installer"
 
-proceed = if options.key? "broadcaster"
-  options["broadcaster"]
+proceed = if CableReady::Installer.options.key? "broadcaster"
+  CableReady::Installer.options["broadcaster"]
 else
   !no?("✨ Make CableReady::Broadcaster available to channels, controllers, jobs and models? (Y/n)")
 end
 
 unless proceed
-  complete_step :broadcaster
+  CableReady::Installer.complete_step :broadcaster
 
   puts "⏩ Skipping."
   return
@@ -20,7 +20,7 @@ channel_path = Rails.root.join("app/channels/application_cable/channel.rb")
 if channel_path.exist?
   lines = channel_path.readlines
   if !lines.index { |line| line =~ /^\s*include CableReady::Broadcaster/ }
-    backup(channel_path) do
+    CableReady::Installer.backup(channel_path) do
       index = lines.index { |line| line.include?("class Channel < ActionCable::Channel::Base") }
       lines.insert index + 1, "    include CableReady::Broadcaster\n"
       channel_path.write lines.join
@@ -37,7 +37,7 @@ controller_path = Rails.root.join("app/controllers/application_controller.rb")
 if controller_path.exist?
   lines = controller_path.readlines
   if !lines.index { |line| line =~ /^\s*include CableReady::Broadcaster/ }
-    backup(controller_path) do
+    CableReady::Installer.backup(controller_path) do
       index = lines.index { |line| line.include?("class ApplicationController < ActionController::Base") }
       lines.insert index + 1, "  include CableReady::Broadcaster\n"
       controller_path.write lines.join
@@ -55,7 +55,7 @@ if defined?(ActiveJob)
   if job_path.exist?
     lines = job_path.readlines
     if !lines.index { |line| line =~ /^\s*include CableReady::Broadcaster/ }
-      backup(job_path) do
+      CableReady::Installer.backup(job_path) do
         index = lines.index { |line| line.include?("class ApplicationJob < ActiveJob::Base") }
         lines.insert index + 1, "  include CableReady::Broadcaster\n"
         job_path.write lines.join
@@ -72,9 +72,9 @@ end
 
 # include CableReady::Broadcaster in StateMachines, if present
 if defined?(StateMachines)
-  lines = action_cable_initializer_working_path.read
+  lines = CableReady::Installer.action_cable_initializer_working_path.read
   if !lines.include?("StateMachines::Machine.prepend(CableReady::Broadcaster)")
-    inject_into_file action_cable_initializer_working_path, after: "CableReady.configure do |config|\n", verbose: false do
+    inject_into_file CableReady::Installer.action_cable_initializer_working_path, after: "CableReady.configure do |config|\n", verbose: false do
       <<-RUBY
 
   StateMachines::Machine.prepend(CableReady::Broadcaster)
@@ -91,13 +91,13 @@ else
 end
 
 # include CableReady::Broadcaster in Active Record model classes
-if Rails.root.join(application_record_path).exist?
-  lines = application_record_path.readlines
+if Rails.root.join(CableReady::Installer.application_record_path).exist?
+  lines = CableReady::Installer.application_record_path.readlines
   if !lines.index { |line| line =~ /^\s*include CableReady::Broadcaster/ }
-    backup(application_record_path) do
+    CableReady::Installer.backup(CableReady::Installer.application_record_path) do
       index = lines.index { |line| line.include?("class ApplicationRecord < ActiveRecord::Base") }
       lines.insert index + 1, "  include CableReady::Broadcaster\n"
-      application_record_path.write lines.join
+      CableReady::Installer.application_record_path.write lines.join
     end
 
     puts "✅ include CableReady::Broadcaster in Active Record model classes"
@@ -106,4 +106,4 @@ if Rails.root.join(application_record_path).exist?
   end
 end
 
-complete_step :broadcaster
+CableReady::Installer.complete_step :broadcaster

data/lib/install/bundle.rb

@@ -2,14 +2,14 @@
 
 require "cable_ready/installer"
 
-hash = gemfile_hash
+hash = CableReady::Installer.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) : []
+add = CableReady::Installer.add_gem_list.exist? ? CableReady::Installer.add_gem_list.readlines.map(&:chomp) : []
+remove = CableReady::Installer.remove_gem_list.exist? ? CableReady::Installer.remove_gem_list.readlines.map(&:chomp) : []
 
 if add.present? || remove.present?
-  lines = gemfile_path.readlines
+  lines = CableReady::Installer.gemfile_path.readlines
 
   remove.each do |name|
     index = lines.index { |line| line =~ /gem ['"]#{name}['"]/ }
@@ -40,15 +40,15 @@ if add.present? || remove.present?
     end
   end
 
-  gemfile_path.write lines.join
+  CableReady::Installer.gemfile_path.write lines.join
 
-  bundle_command("install --quiet", "BUNDLE_IGNORE_MESSAGES" => "1") if hash != gemfile_hash
+  bundle_command("install --quiet", "BUNDLE_IGNORE_MESSAGES" => "1") if hash != CableReady::Installer.gemfile_hash
 end
 
-FileUtils.cp(development_working_path, development_path)
+FileUtils.cp(CableReady::Installer.development_working_path, CableReady::Installer.development_path)
 say "✅ development environment configuration installed"
 
-FileUtils.cp(action_cable_initializer_working_path, action_cable_initializer_path)
+FileUtils.cp(CableReady::Installer.action_cable_initializer_working_path, CableReady::Installer.action_cable_initializer_path)
 say "✅ Action Cable initializer installed"
 
-complete_step :bundle
+CableReady::Installer.complete_step :bundle

data/lib/install/compression.rb

@@ -2,26 +2,26 @@
 
 require "cable_ready/installer"
 
-initializer = action_cable_initializer_working_path.read
+initializer = CableReady::Installer.action_cable_initializer_working_path.read
 
 proceed = false
 
 if initializer.exclude? "PermessageDeflate.configure"
-  proceed = if options.key? "compression"
-    options["compression"]
+  proceed = if CableReady::Installer.options.key? "compression"
+    CableReady::Installer.options["compression"]
   else
     !no?("✨ Configure Action Cable to compress your WebSocket traffic with gzip? (Y/n)")
   end
 end
 
 if proceed
-  if !gemfile.match?(/gem ['"]permessage_deflate['"]/)
-    add_gem "permessage_deflate@>= 0.1"
+  if !CableReady::Installer.gemfile.match?(/gem ['"]permessage_deflate['"]/)
+    CableReady::Installer.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
+    CableReady::Installer.create_or_append(CableReady::Installer.action_cable_initializer_working_path, verbose: false) do
       <<~RUBY
         module ActionCable
           module Connection
@@ -48,4 +48,4 @@ if proceed
   end
 end
 
-complete_step :compression
+CableReady::Installer.complete_step :compression

data/lib/install/config.rb

@@ -2,38 +2,38 @@
 
 require "cable_ready/installer"
 
-return if pack_path_missing?
+return if CableReady::Installer.pack_path_missing?
 
 step_path = "/app/javascript/config/"
-index_src = fetch(step_path, "index.js.tt")
-index_path = config_path / "index.js"
-cable_ready_src = fetch(step_path, "cable_ready.js.tt")
-cable_ready_path = config_path / "cable_ready.js"
+index_src = CableReady::Installer.fetch(step_path, "index.js.tt")
+index_path = CableReady::Installer.config_path / "index.js"
+cable_ready_src = CableReady::Installer.fetch(step_path, "cable_ready.js.tt")
+cable_ready_path = CableReady::Installer.config_path / "cable_ready.js"
 
-empty_directory config_path unless config_path.exist?
+empty_directory CableReady::Installer.config_path unless CableReady::Installer.config_path.exist?
 
-copy_file(index_src, index_path) unless index_path.exist?
+CableReady::Installer.copy_file(index_src, index_path) unless index_path.exist?
 
 index_pattern = /import ['"](\.\.\/|\.\/)?config['"]/
 index_commented_pattern = /\s*\/\/\s*#{index_pattern}/
-index_import = "import \"#{prefix}config\"\n"
+index_import = "import \"#{CableReady::Installer.prefix}config\"\n"
 
-if pack.match?(index_pattern)
-  if pack.match?(index_commented_pattern)
-    lines = pack_path.readlines
+if CableReady::Installer.pack.match?(index_pattern)
+  if CableReady::Installer.pack.match?(index_commented_pattern)
+    lines = CableReady::Installer.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
+    CableReady::Installer.pack_path.write lines.join
   end
 else
-  lines = pack_path.readlines
+  lines = CableReady::Installer.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
+  CableReady::Installer.pack_path.write lines.join
 end
-say "✅ CableReady configs will be imported in #{friendly_pack_path}"
+say "✅ CableReady configs will be imported in #{CableReady::Installer.friendly_pack_path}"
 
 # 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?
+CableReady::Installer.copy_file(cable_ready_src, cable_ready_path) unless cable_ready_path.exist?
 
-complete_step :config
+CableReady::Installer.complete_step :config

data/lib/install/development.rb

@@ -3,32 +3,32 @@
 require "cable_ready/installer"
 
 # mutate working copy of development.rb to avoid bundle alerts
-FileUtils.cp(development_path, development_working_path)
+FileUtils.cp(CableReady::Installer.development_path, CableReady::Installer.development_working_path)
 
 # add default_url_options to development.rb for Action Mailer
 if defined?(ActionMailer)
-  lines = development_working_path.readlines
+  lines = CableReady::Installer.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
+    CableReady::Installer.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
+lines = CableReady::Installer.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
+  CableReady::Installer.development_working_path.write lines.join
 
   say "✅ Action Controller default_url_options defined"
 end
 
-complete_step :development
+CableReady::Installer.complete_step :development

data/lib/install/esbuild.rb

@@ -2,47 +2,47 @@
 
 require "cable_ready/installer"
 
-return if pack_path_missing?
+return if CableReady::Installer.pack_path_missing?
 
 # verify that all critical dependencies are up to date; if not, queue for later
-lines = package_json.readlines
+lines = CableReady::Installer.package_json.readlines
 
 if !lines.index { |line| line =~ /^\s*["']esbuild-rails["']: ["']\^1.0.3["']/ }
-  add_package "esbuild-rails@^1.0.3"
+  CableReady::Installer.add_package "esbuild-rails@^1.0.3"
 end
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
-  add_package "@hotwired/stimulus@^3.2"
+  CableReady::Installer.add_package "@hotwired/stimulus@^3.2"
 end
 # copy esbuild.config.mjs to app root
-esbuild_src = fetch("/", "esbuild.config.mjs.tt")
+esbuild_src = CableReady::Installer.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 present in app root"
   else
-    backup(esbuild_path) do
-      template(esbuild_src, esbuild_path, verbose: false, entrypoint: entrypoint)
+    CableReady::Installer.backup(esbuild_path) do
+      template(esbuild_src, esbuild_path, verbose: false, entrypoint: CableReady::Installer.entrypoint)
     end
   end
 else
-  template(esbuild_src, esbuild_path, entrypoint: entrypoint)
+  template(esbuild_src, esbuild_path, entrypoint: CableReady::Installer.entrypoint)
 end
 
 step_path = "/app/javascript/controllers/"
-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"
+application_js_src = CableReady::Installer.fetch(step_path, "application.js.tt")
+application_js_path = CableReady::Installer.controllers_path / "application.js"
+index_src = CableReady::Installer.fetch(step_path, "index.js.esbuild.tt")
+index_path = CableReady::Installer.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?
+empty_directory CableReady::Installer.controllers_path unless CableReady::Installer.controllers_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
+  CableReady::Installer.backup(application_js_path) do
     if application_js_path.read.include?("import consumer")
       say "✅ #{friendly_application_js_path} is present"
     else
@@ -52,12 +52,12 @@ if application_js_path.exist?
     end
   end
 else
-  copy_file(application_js_src, application_js_path)
+  CableReady::Installer.copy_file(application_js_src, application_js_path)
 end
 
 if index_path.exist?
   if index_path.read != index_src.read
-    backup(index_path, delete: true) do
+    CableReady::Installer.backup(index_path, delete: true) do
       copy_file(index_src, index_path, verbose: false)
     end
   end
@@ -69,33 +69,33 @@ say "✅ #{friendly_index_path} has been created"
 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"]
+if CableReady::Installer.pack.match?(controllers_pattern)
+  if CableReady::Installer.pack.match?(controllers_commented_pattern)
+    proceed = if CableReady::Installer.options.key? "uncomment"
+      CableReady::Installer.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
+      lines = CableReady::Installer.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 "✅ Stimulus controllers imported in #{friendly_pack_path}"
+      CableReady::Installer.pack_path.write lines.join
+      say "✅ Stimulus controllers imported in #{CableReady::Installer.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 imported in #{friendly_pack_path}"
+    say "✅ Stimulus controllers imported in #{CableReady::Installer.friendly_pack_path}"
   end
 else
-  lines = pack_path.readlines
+  lines = CableReady::Installer.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}"
+  CableReady::Installer.pack_path.write lines.join
+  say "✅ Stimulus controllers imported in #{CableReady::Installer.friendly_pack_path}"
 end
 
-complete_step :esbuild
+CableReady::Installer.complete_step :esbuild

data/lib/install/importmap.rb

@@ -2,69 +2,69 @@
 
 require "cable_ready/installer"
 
-return if pack_path_missing?
+return if CableReady::Installer.pack_path_missing?
 
-if !importmap_path.exist?
-  halt "#{friendly_importmap_path} is missing. You need a valid importmap config file to proceed."
+if !CableReady::Installer.importmap_path.exist?
+  CableReady::Installer.halt "#{friendly_CableReady::Installer.importmap_path} is missing. You need a valid importmap config file to proceed."
   return
 end
 
-importmap = importmap_path.read
+importmap = CableReady::Installer.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"
+CableReady::Installer.backup(CableReady::Installer.importmap_path) do
+  if !importmap.include?("pin_all_from \"#{CableReady::Installer.entrypoint}/controllers\"")
+    append_file(CableReady::Installer.importmap_path, <<~RUBY, verbose: false)
+      pin_all_from "#{CableReady::Installer.entrypoint}/controllers", under: "controllers"
     RUBY
     say "✅ pin controllers folder"
   end
 
-  if !importmap.include?("pin_all_from \"#{entrypoint}/channels\"")
-    append_file(importmap_path, <<~RUBY, verbose: false)
-      pin_all_from "#{entrypoint}/channels", under: "channels"
+  if !importmap.include?("pin_all_from \"#{CableReady::Installer.entrypoint}/channels\"")
+    append_file(CableReady::Installer.importmap_path, <<~RUBY, verbose: false)
+      pin_all_from "#{CableReady::Installer.entrypoint}/channels", under: "channels"
     RUBY
     say "✅ pin channels folder"
   end
 
-  if !importmap.include?("pin_all_from \"#{entrypoint}/config\"")
-    append_file(importmap_path, <<~RUBY, verbose: false)
-      pin_all_from "#{entrypoint}/config", under: "config"
+  if !importmap.include?("pin_all_from \"#{CableReady::Installer.entrypoint}/config\"")
+    append_file(CableReady::Installer.importmap_path, <<~RUBY, verbose: false)
+      pin_all_from "#{CableReady::Installer.entrypoint}/config", under: "config"
     RUBY
     say "✅ pin config folder"
   end
 
   if !importmap.include?("pin \"@rails/actioncable\"")
-    append_file(importmap_path, <<~RUBY, verbose: false)
+    append_file(CableReady::Installer.importmap_path, <<~RUBY, verbose: false)
       pin "@rails/actioncable", to: "actioncable.esm.js", preload: true
     RUBY
     say "✅ pin Action Cable"
   end
 
   if !importmap.include?("pin \"cable_ready\"")
-    append_file(importmap_path, <<~RUBY, verbose: false)
+    append_file(CableReady::Installer.importmap_path, <<~RUBY, verbose: false)
       pin "cable_ready", to: "cable_ready.js", preload: true
     RUBY
     say "✅ pin CableReady"
   end
 
   if !importmap.include?("pin \"morphdom\"")
-    append_file(importmap_path, <<~RUBY, verbose: false)
+    append_file(CableReady::Installer.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"
   end
 end
 
-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"
+application_js_src = CableReady::Installer.fetch("/", "app/javascript/controllers/application.js.tt")
+application_js_path = CableReady::Installer.controllers_path / "application.js"
+index_src = CableReady::Installer.fetch("/", "app/javascript/controllers/index.js.importmap.tt")
+index_path = CableReady::Installer.controllers_path / "index.js"
 
 # create entrypoint/controllers, as well as the index, application and application_controller
-empty_directory controllers_path unless controllers_path.exist?
+empty_directory CableReady::Installer.controllers_path unless CableReady::Installer.controllers_path.exist?
 
 # configure Stimulus application superclass to import Action Cable consumer
-backup(application_js_path) do
+CableReady::Installer.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")
@@ -84,7 +84,7 @@ if index_path.exist?
   if index_path.read == index_src.read
     say "✅ #{friendly_index_path} is present"
   else
-    backup(index_path, delete: true) do
+    CableReady::Installer.backup(index_path, delete: true) do
       copy_file(index_src, index_path, verbose: false)
     end
     say "✅ #{friendly_index_path} has been created"
@@ -93,4 +93,4 @@ else
   copy_file(index_src, index_path)
 end
 
-complete_step :importmap
+CableReady::Installer.complete_step :importmap

data/lib/install/initializers.rb

@@ -2,7 +2,7 @@
 
 require "cable_ready/installer"
 
-cr_initializer_src = fetch("/", "config/initializers/cable_ready.rb")
+cr_initializer_src = CableReady::Installer.fetch("/", "config/initializers/cable_ready.rb")
 cr_initializer_path = Rails.root.join("config/initializers/cable_ready.rb")
 
 if !cr_initializer_path.exist?
@@ -12,4 +12,4 @@ else
   say "⏩ config/initializers/cable_ready.rb already exists. Skipping."
 end
 
-complete_step :initializers
+CableReady::Installer.complete_step :initializers

data/lib/install/mrujs.rb

@@ -2,63 +2,63 @@
 
 require "cable_ready/installer"
 
-return if pack_path_missing?
+return if CableReady::Installer.pack_path_missing?
 
-mrujs_path = config_path / "mrujs.js"
+mrujs_path = CableReady::Installer.config_path / "mrujs.js"
 
 proceed = false
 
 if !File.exist?(mrujs_path)
-  proceed = if options.key? "mrujs"
-    options["mrujs"]
+  proceed = if CableReady::Installer.options.key? "mrujs"
+    CableReady::Installer.options["mrujs"]
   else
     !no?("✨ Would you like to install and enable mrujs? It's a modern, drop-in replacement for rails-ujs (Y/n)")
   end
 end
 
 if proceed
-  if bundler == "importmap"
+  if CableReady::Installer.bundler == "importmap"
 
-    if !importmap_path.exist?
-      halt "#{friendly_importmap_path} is missing. You need a valid importmap config file to proceed."
+    if !CableReady::Installer.importmap_path.exist?
+      CableReady::Installer.halt "#{friendly_CableReady::Installer.importmap_path} is missing. You need a valid importmap config file to proceed."
       return
     end
 
-    importmap = importmap_path.read
+    importmap = CableReady::Installer.importmap_path.read
 
     if !importmap.include?("pin \"mrujs\"")
-      append_file(importmap_path, <<~RUBY, verbose: false)
+      append_file(CableReady::Installer.importmap_path, <<~RUBY, verbose: false)
         pin "mrujs", to: "https://ga.jspm.io/npm:mrujs@0.10.1/dist/index.module.js"
       RUBY
       say "✅ pin mrujs"
     end
 
     if !importmap.include?("pin \"mrujs/plugins\"")
-      append_file(importmap_path, <<~RUBY, verbose: false)
+      append_file(CableReady::Installer.importmap_path, <<~RUBY, verbose: false)
         pin "mrujs/plugins", to: "https://ga.jspm.io/npm:mrujs@0.10.1/plugins/dist/plugins.module.js"
       RUBY
       say "✅ pin mrujs plugins"
     end
   else
     # queue mrujs for installation
-    if !package_json.read.include?('"mrujs":')
-      add_package "mrujs@^0.10.1"
+    if !CableReady::Installer.package_json.read.include?('"mrujs":')
+      CableReady::Installer.add_package "mrujs@^0.10.1"
     end
 
     # queue @rails/ujs for removal
-    if package_json.read.include?('"@rails/ujs":')
-      drop_package "@rails/ujs"
+    if CableReady::Installer.package_json.read.include?('"@rails/ujs":')
+      CableReady::Installer.drop_package "@rails/ujs"
     end
   end
 
   step_path = "/app/javascript/config/"
-  mrujs_src = fetch(step_path, "mrujs.js.tt")
+  mrujs_src = CableReady::Installer.fetch(step_path, "mrujs.js.tt")
 
   # create entrypoint/config/mrujs.js if necessary
   copy_file(mrujs_src, mrujs_path) unless mrujs_path.exist?
 
   # import mrujs config in entrypoint/config/index.js
-  index_path = config_path / "index.js"
+  index_path = CableReady::Installer.config_path / "index.js"
   index = index_path.read
   friendly_index_path = index_path.relative_path_from(Rails.root).to_s
   mrujs_pattern = /import ['"].\/mrujs['"]/
@@ -72,10 +72,10 @@ if proceed
   # remove @rails/ujs from application.js
   rails_ujs_pattern = /import Rails from ['"]@rails\/ujs['"]/
 
-  lines = pack_path.readlines
+  lines = CableReady::Installer.pack_path.readlines
   if lines.index { |line| line =~ rails_ujs_pattern }
     gsub_file pack_path, rails_ujs_pattern, "", verbose: false
-    say "✅ @rails/ujs removed from #{friendly_pack_path}"
+    say "✅ @rails/ujs removed from #{CableReady::Installer.friendly_pack_path}"
   end
 
   # set Action View to generate remote forms when using form_with
@@ -84,7 +84,7 @@ if proceed
   defaults_pattern = /config\.load_defaults \d\.\d/
 
   lines = application_path.readlines
-  backup(application_path) do
+  CableReady::Installer.backup(application_path) do
     if !lines.index { |line| line =~ application_pattern }
       if (index = lines.index { |line| line =~ /^[^#]*#{defaults_pattern}/ })
         gsub_file application_path, /\s*#{defaults_pattern}\n/, verbose: false do
@@ -110,12 +110,12 @@ if proceed
   # remove turbolinks from Gemfile because it's incompatible with mrujs (and unnecessary)
   turbolinks_pattern = /^[^#]*gem ["']turbolinks["']/
 
-  lines = gemfile_path.readlines
+  lines = CableReady::Installer.gemfile_path.readlines
   if lines.index { |line| line =~ turbolinks_pattern }
-    remove_gem :turbolinks
+    CableReady::Installer.remove_gem :turbolinks
   else
     say "✅ turbolinks is not present in Gemfile"
   end
 end
 
-complete_step :mrujs
+CableReady::Installer.complete_step :mrujs

data/lib/install/npm_packages.rb

@@ -2,12 +2,12 @@
 
 require "cable_ready/installer"
 
-lines = package_json.readlines
+lines = CableReady::Installer.package_json.readlines
 
-if !lines.index { |line| line =~ /^\s*["']cable_ready["']: ["'].*#{cr_npm_version}["']/ }
-  add_package "cable_ready@#{cr_npm_version}"
+if !lines.index { |line| line =~ /^\s*["']cable_ready["']: ["'].*#{CableReady::Installer.cr_npm_version}["']/ }
+  CableReady::Installer.add_package "cable_ready@#{CableReady::Installer.cr_npm_version}"
 else
   say "⏩ cable_ready npm package is already present"
 end
 
-complete_step :npm_packages
+CableReady::Installer.complete_step :npm_packages