cable_ready 5.0.3 → 5.0.5

data/lib/install/shakapacker.rb

@@ -2,30 +2,30 @@
 
 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*["']@hotwired\/stimulus["']:/ }
-  add_package "@hotwired/stimulus@^3.2"
+  CableReady::Installer.add_package "@hotwired/stimulus@^3.2"
 else
   say "⏩ @hotwired/stimulus npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus-webpack-helpers["']: ["']\^1.0.1["']/ }
-  add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
+  CableReady::Installer.add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
 else
   say "⏩ @hotwired/stimulus-webpack-helpers npm package is already present. Skipping."
 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.shakapacker.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.shakapacker.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?
 
 copy_file(application_js_src, application_js_path) unless application_js_path.exist?
 copy_file(index_src, index_path) unless index_path.exist?
@@ -33,33 +33,33 @@ copy_file(index_src, index_path) unless index_path.exist?
 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?("✨ Do you want to import your Stimulus controllers in application.js? (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"
-      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"
-  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 :shakapacker
+CableReady::Installer.complete_step :shakapacker

data/lib/install/spring.rb

@@ -5,11 +5,11 @@ require "cable_ready/installer"
 spring_pattern = /^[^#]*gem ["']spring["']/
 
 proceed = false
-lines = gemfile_path.readlines
+lines = CableReady::Installer.gemfile_path.readlines
 
 if lines.index { |line| line =~ spring_pattern }
-  proceed = if options.key? "spring"
-    options["spring"]
+  proceed = if CableReady::Installer.options.key? "spring"
+    CableReady::Installer.options["spring"]
   else
     !no?("✨ Would you like to disable the spring gem? \nIt's been removed from Rails 7, and is the frequent culprit behind countless mystery bugs. (Y/n)")
   end
@@ -22,7 +22,7 @@ if proceed
   bin_rails_pattern = /^[^#]*load File.expand_path\("spring", __dir__\)/
 
   if (index = lines.index { |line| line =~ spring_pattern })
-    remove_gem :spring
+    CableReady::Installer.remove_gem :spring
 
     bin_spring = Rails.root.join("bin/spring")
     if bin_spring.exist?
@@ -33,7 +33,7 @@ if proceed
     bin_rails = Rails.root.join("bin/rails")
     bin_rails_content = bin_rails.readlines
     if (index = bin_rails_content.index { |line| line =~ bin_rails_pattern })
-      backup(bin_rails) do
+      CableReady::Installer.backup(bin_rails) do
         bin_rails_content[index] = "# #{bin_rails_content[index]}"
         bin_rails.write bin_rails_content.join
       end
@@ -45,10 +45,10 @@ if proceed
   end
 
   if lines.index { |line| line =~ spring_watcher_pattern }
-    remove_gem "spring-watcher-listen"
+    CableReady::Installer.remove_gem "spring-watcher-listen"
   end
 else
   say "⏩ Skipping."
 end
 
-complete_step :spring
+CableReady::Installer.complete_step :spring

data/lib/install/updatable.rb

@@ -2,18 +2,18 @@
 
 require "cable_ready/installer"
 
-if application_record_path.exist?
-  lines = application_record_path.readlines
+if CableReady::Installer.application_record_path.exist?
+  lines = CableReady::Installer.application_record_path.readlines
 
   if !lines.index { |line| line =~ /^\s*include CableReady::Updatable/ }
-    proceed = if options.key? "updatable"
-      options["updatable"]
+    proceed = if CableReady::Installer.options.key? "updatable"
+      CableReady::Installer.options["updatable"]
     else
       !no?("✨ Include CableReady::Updatable in Active Record model classes? (Y/n)")
     end
 
     unless proceed
-      complete_step :updatable
+      CableReady::Installer.complete_step :updatable
 
       puts "⏩ Skipping."
       return
@@ -21,7 +21,7 @@ if application_record_path.exist?
 
     index = lines.index { |line| line.include?("class ApplicationRecord < ActiveRecord::Base") }
     lines.insert index + 1, "  include CableReady::Updatable\n"
-    application_record_path.write lines.join
+    CableReady::Installer.application_record_path.write lines.join
 
     say "✅ included CableReady::Updatable in ApplicationRecord"
   else
@@ -31,4 +31,4 @@ else
   say "⏩ ApplicationRecord doesn't exist. Skipping."
 end
 
-complete_step :updatable
+CableReady::Installer.complete_step :updatable

data/lib/install/vite.rb

@@ -2,30 +2,30 @@
 
 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*["']@hotwired\/stimulus["']:/ }
-  add_package "@hotwired/stimulus@^3.2"
+  CableReady::Installer.add_package "@hotwired/stimulus@^3.2"
 else
   say "⏩ @hotwired/stimulus npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']stimulus-vite-helpers["']: ["']\^3["']/ }
-  add_package "stimulus-vite-helpers@^3"
+  CableReady::Installer.add_package "stimulus-vite-helpers@^3"
 else
   say "⏩ @stimulus-vite-helpers npm package is already present. Skipping."
 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.vite.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.vite.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?
 
 copy_file(application_js_src, application_js_path) unless application_js_path.exist?
 copy_file(index_src, index_path) unless index_path.exist?
@@ -34,33 +34,33 @@ controllers_pattern = /import ['"](\.\.\/)?controllers['"]/
 controllers_commented_pattern = /\s*\/\/\s*#{controllers_pattern}/
 prefix = "..\/" # standard:disable Style/RedundantStringEscape
 
-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?("✨ Do you want to import your Stimulus controllers in application.js? (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 \"#{prefix}controllers\"\n"
-      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 \"#{prefix}controllers\"\n"
-  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 :vite
+CableReady::Installer.complete_step :vite

data/lib/install/webpacker.rb

@@ -2,54 +2,54 @@
 
 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*["']webpack["']: ["']\^4.46.0["']/ }
-  add_package "webpack@^4.46.0"
+  CableReady::Installer.add_package "webpack@^4.46.0"
 else
   say "⏩ webpack npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']webpack-cli["']: ["']\^3.3.12["']/ }
-  add_package "webpack-cli@^3.3.12"
+  CableReady::Installer.add_package "webpack-cli@^3.3.12"
 else
   say "⏩ webpack-cli npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@rails\/webpacker["']: ["']\^5.4.3["']/ }
-  add_package "@rails/webpacker@^5.4.3"
+  CableReady::Installer.add_package "@rails/webpacker@^5.4.3"
 else
   say "⏩ @rails/webpacker npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
-  add_package "@hotwired/stimulus@^3.2"
+  CableReady::Installer.add_package "@hotwired/stimulus@^3.2"
 else
   say "⏩ @hotwired/stimulus npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus-webpack-helpers["']: ["']\^1.0.1["']/ }
-  add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
+  CableReady::Installer.add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
 else
   say "⏩ @hotwired/stimulus-webpack-helpers npm package is already present. Skipping."
 end
 
 if !lines.index { |line| line =~ /^\s*["']webpack-dev-server["']: ["']\^3.11.3["']/ }
-  add_dev_package "webpack-dev-server@^3.11.3"
+  CableReady::Installer.add_dev_package "webpack-dev-server@^3.11.3"
 else
   say "⏩ @webpack-dev-server is already present. Skipping."
 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.webpacker.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.webpacker.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?
 
 # webpacker 5.4 did not colloquially feature a controllers/application.js file
 copy_file(application_js_src, application_js_path) unless application_js_path.exist?
@@ -68,26 +68,26 @@ if pack.match?(controllers_pattern)
 
     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"
-      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"
-  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
 
 # ensure webpacker is installed in the Gemfile
-add_gem "webpacker@5.4.3"
+CableReady::Installer.add_gem "webpacker@5.4.3"
 
-complete_step :webpacker
+CableReady::Installer.complete_step :webpacker

data/lib/install/yarn.rb

@@ -2,18 +2,18 @@
 
 require "cable_ready/installer"
 
-if !package_json.exist?
+if !CableReady::Installer.package_json.exist?
   say "⏩ No package.json file found. Skipping."
 
   return
 end
 
 # run yarn install only when packages are waiting to be added or removed
-add = package_list.exist? ? package_list.readlines.map(&:chomp) : []
-dev = dev_package_list.exist? ? dev_package_list.readlines.map(&:chomp) : []
-drop = drop_package_list.exist? ? drop_package_list.readlines.map(&:chomp) : []
+add = CableReady::Installer.package_list.exist? ? CableReady::Installer.package_list.readlines.map(&:chomp) : []
+dev = CableReady::Installer.dev_package_list.exist? ? CableReady::Installer.dev_package_list.readlines.map(&:chomp) : []
+drop = CableReady::Installer.drop_package_list.exist? ? CableReady::Installer.drop_package_list.readlines.map(&:chomp) : []
 
-json = JSON.parse(package_json.read)
+json = JSON.parse(CableReady::Installer.package_json.read)
 
 if add.present? || dev.present? || drop.present?
 
@@ -36,7 +36,7 @@ if add.present? || dev.present? || drop.present?
     json["devDependencies"].delete(package)
   end
 
-  package_json.write JSON.pretty_generate(json)
+  CableReady::Installer.package_json.write JSON.pretty_generate(json)
 
   system "yarn install --silent"
 else
@@ -44,13 +44,13 @@ else
 
 end
 
-if bundler == "esbuild" && json["scripts"]["build"] != "node esbuild.config.mjs"
+if CableReady::Installer.bundler == "esbuild" && json["scripts"]["build"] != "node esbuild.config.mjs"
   json["scripts"]["build:default"] = json["scripts"]["build"]
   json["scripts"]["build"] = "node esbuild.config.mjs"
-  package_json.write JSON.pretty_generate(json)
+  CableReady::Installer.package_json.write JSON.pretty_generate(json)
   say "✅ Your build script has been updated to use esbuild.config.mjs"
 else
   say "⏩ Your build script is already setup. Skipping."
 end
 
-complete_step :yarn
+CableReady::Installer.complete_step :yarn

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cable_ready",
-  "version": "5.0.3",
+  "version": "5.0.5",
   "description": "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.",
   "keywords": [
     "ruby",