cable_ready 5.0.3 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77c9ebacb73173f6208a3695b3f9305c70a87620216fc9441d92cc29fb2199af
-  data.tar.gz: c41f703f59647be24df6a357f91e0cb848da7a16d31701714f1a648ec1991f6c
+  metadata.gz: 370257c592bcb4dda3a9466cee960208bf00f23e9966d6bfbc74b5976f7aca93
+  data.tar.gz: a6d333775454cc46d636f0c0c0707449f9b31072307f8fbad7c8ccd565671de2
 SHA512:
-  metadata.gz: e741e3a8d4c500ed4ca9dc1a09590f373911f5bd87986e2a9de9fb8d461da06d65fb86d8b940a4007da79d38cb352907a2c09aefd642f2a808d9d511e7d6f230
-  data.tar.gz: 4a6b2d908138c58afb074642bf8e27c6f685eeace3ad2b43d182e31b61440fb251e059e7aa7cb508179e8c39c050f892e066f9c7d2c7516460284fda1d66bf87
+  metadata.gz: dca231343c358d9c33efe88ea21a05f1fec27f45c3d85cc34aed968aa6df7d6ae82beb754606504412ab18690f6b4a13811dee00f069748129bbaf8ed6ac8bd0
+  data.tar.gz: db45207f865f503508a0e0603e830c33f8c2b0c27e94af62d0f786fbdc6847242e1151ffafbe9524f186ea83b83bd2dc531e094df8776c690ae8b0d8a970ec07

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    cable_ready (5.0.2)
+    cable_ready (5.0.4)
       actionpack (>= 5.2)
       actionview (>= 5.2)
       activesupport (>= 5.2)
+      observer (~> 0.1)
       railties (>= 5.2)
       thread-local (>= 1.1.0)
 
@@ -114,6 +115,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
+    observer (0.1.2)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)

data/cable_ready.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "activesupport", rails_version
   gem.add_dependency "railties", rails_version
   gem.add_dependency "thread-local", ">= 1.1.0"
+  gem.add_dependency "observer", "~> 0.1"
 
   gem.add_development_dependency "magic_frozen_string_literal"
   gem.add_development_dependency "mocha"

data/lib/cable_ready/installer.rb

@@ -2,223 +2,250 @@
 
 require "cable_ready/version"
 
-### general utilities
+module CableReady
+  class Installer
+    include Thor::Base
+    include Thor::Actions
 
-def fetch(step_path, file)
-  relative_path = step_path + file
-  location = template_src + relative_path
+    source_root Dir.pwd
 
-  Pathname.new(location)
-end
+    ## Thor wrapper
 
-def complete_step(step)
-  create_file "tmp/cable_ready_installer/#{step}", verbose: false
-end
+    def self.create_file(...)
+      new.create_file(...)
+    end
 
-def create_or_append(path, *args, &block)
-  FileUtils.touch(path)
-  append_file(path, *args, &block)
-end
+    def self.append_file(...)
+      new.append_file(...)
+    end
 
-def current_template
-  ENV["LOCATION"].split("/").last.gsub(".rb", "")
-end
+    def self.copy_file(...)
+      new.copy_file(...)
+    end
 
-def pack_path_missing?
-  return false unless pack_path.nil?
-  halt "#{friendly_pack_path} is missing. You need a valid application pack file to proceed."
-end
+    def self.say(...)
+      new.say(...)
+    end
 
-def halt(message)
-  say "❌ #{message}", :red
-  create_file "tmp/cable_ready_installer/halt", verbose: false
-end
+    ### general utilities
 
-def backup(path, delete: false)
-  if !path.exist?
-    yield
-    return
-  end
+    def self.fetch(step_path, file)
+      relative_path = step_path + file
+      location = template_src + relative_path
 
-  backup_path = Pathname.new("#{path}.bak")
-  old_path = path.relative_path_from(Rails.root).to_s
-  filename = path.to_path.split("/").last
+      Pathname.new(location)
+    end
 
-  if backup_path.exist?
-    if backup_path.read == path.read
-      path.delete if delete
-      yield
-      return
+    def self.complete_step(step)
+      create_file "tmp/cable_ready_installer/#{step}", verbose: false
     end
-    backup_path.delete
-  end
 
-  copy_file(path, backup_path, verbose: false)
-  path.delete if delete
+    def self.create_or_append(path, *args, &block)
+      FileUtils.touch(path)
+      append_file(path, *args, &block)
+    end
 
-  yield
+    def self.current_template
+      ENV["LOCATION"].split("/").last.gsub(".rb", "")
+    end
 
-  if path.read != backup_path.read
-    create_or_append(backups_path, "#{old_path}\n", verbose: false)
-  end
-  say "📦 #{old_path} backed up as #{filename}.bak"
-end
+    def self.pack_path_missing?
+      return false unless pack_path.nil?
+      halt "#{friendly_pack_path} is missing. You need a valid application pack file to proceed."
+    end
 
-def add_gem(name)
-  create_or_append(add_gem_list, "#{name}\n", verbose: false)
-  say "☑️  Added #{name} to the Gemfile"
-end
+    def self.halt(message)
+      say "❌ #{message}", :red
+      create_file "tmp/cable_ready_installer/halt", verbose: false
+    end
 
-def remove_gem(name)
-  create_or_append(remove_gem_list, "#{name}\n", verbose: false)
-  say "❎ Removed #{name} from Gemfile"
-end
+    def self.backup(path, delete: false)
+      if !path.exist?
+        yield
+        return
+      end
+
+      backup_path = Pathname.new("#{path}.bak")
+      old_path = path.relative_path_from(Rails.root).to_s
+      filename = path.to_path.split("/").last
+
+      if backup_path.exist?
+        if backup_path.read == path.read
+          path.delete if delete
+          yield
+          return
+        end
+        backup_path.delete
+      end
+
+      copy_file(path, backup_path, verbose: false)
+      path.delete if delete
 
-def add_package(name)
-  create_or_append(package_list, "#{name}\n", verbose: false)
-  say "☑️  Enqueued #{name} to be added to dependencies"
-end
+      yield
 
-def add_dev_package(name)
-  create_or_append(dev_package_list, "#{name}\n", verbose: false)
-  say "☑️  Enqueued #{name} to be added to dev dependencies"
-end
+      if path.read != backup_path.read
+        create_or_append(backups_path, "#{old_path}\n", verbose: false)
+      end
+      say "📦 #{old_path} backed up as #{filename}.bak"
+    end
 
-def drop_package(name)
-  create_or_append(drop_package_list, "#{name}\n", verbose: false)
-  say "❎ Enqueued #{name} to be removed from dependencies"
-end
+    def self.add_gem(name)
+      create_or_append(add_gem_list, "#{name}\n", verbose: false)
+      say "☑️  Added #{name} to the Gemfile"
+    end
 
-def gemfile_hash
-  Digest::MD5.hexdigest(gemfile_path.read)
-end
+    def self.remove_gem(name)
+      create_or_append(remove_gem_list, "#{name}\n", verbose: false)
+      say "❎ Removed #{name} from Gemfile"
+    end
 
-### memoized values
+    def self.add_package(name)
+      create_or_append(package_list, "#{name}\n", verbose: false)
+      say "☑️  Enqueued #{name} to be added to dependencies"
+    end
 
-def cr_npm_version
-  @cr_npm_version ||= CableReady::VERSION.gsub(".pre", "-pre")
-end
+    def self.add_dev_package(name)
+      create_or_append(dev_package_list, "#{name}\n", verbose: false)
+      say "☑️  Enqueued #{name} to be added to dev dependencies"
+    end
 
-def package_json
-  @package_json ||= Rails.root.join("package.json")
-end
+    def self.drop_package(name)
+      create_or_append(drop_package_list, "#{name}\n", verbose: false)
+      say "❎ Enqueued #{name} to be removed from dependencies"
+    end
 
-def entrypoint
-  @entrypoint ||= File.read("tmp/cable_ready_installer/entrypoint")
-end
+    def self.gemfile_hash
+      Digest::MD5.hexdigest(gemfile_path.read)
+    end
 
-def bundler
-  @bundler ||= File.read("tmp/cable_ready_installer/bundler")
-end
+    ### memoized values
 
-def config_path
-  @config_path ||= Rails.root.join(entrypoint, "config")
-end
+    def self.cr_npm_version
+      @cr_npm_version ||= CableReady::VERSION.gsub(".pre", "-pre")
+    end
 
-def importmap_path
-  @importmap_path ||= Rails.root.join("config/importmap.rb")
-end
+    def self.package_json
+      @package_json ||= Rails.root.join("package.json")
+    end
 
-def friendly_importmap_path
-  @friendly_importmap_path ||= importmap_path.relative_path_from(Rails.root).to_s
-end
+    def self.entrypoint
+      @entrypoint ||= File.read("tmp/cable_ready_installer/entrypoint")
+    end
 
-def pack
-  @pack ||= pack_path.read
-end
+    def self.bundler
+      @bundler ||= File.read("tmp/cable_ready_installer/bundler")
+    end
 
-def friendly_pack_path
-  @friendly_pack_path ||= pack_path.relative_path_from(Rails.root).to_s
-end
+    def self.config_path
+      @config_path ||= Rails.root.join(entrypoint, "config")
+    end
 
-def pack_path
-  @pack_path ||= [
-    Rails.root.join(entrypoint, "application.js"),
-    Rails.root.join(entrypoint, "packs/application.js"),
-    Rails.root.join(entrypoint, "entrypoints/application.js")
-  ].find(&:exist?)
-end
+    def self.importmap_path
+      @importmap_path ||= Rails.root.join("config/importmap.rb")
+    end
 
-def package_list
-  @package_list ||= Rails.root.join("tmp/cable_ready_installer/npm_package_list")
-end
+    def self.friendly_importmap_path
+      @friendly_importmap_path ||= importmap_path.relative_path_from(Rails.root).to_s
+    end
 
-def dev_package_list
-  @dev_package_list ||= Rails.root.join("tmp/cable_ready_installer/npm_dev_package_list")
-end
+    def self.pack
+      @pack ||= pack_path.read
+    end
 
-def drop_package_list
-  @drop_package_list ||= Rails.root.join("tmp/cable_ready_installer/drop_npm_package_list")
-end
+    def self.friendly_pack_path
+      @friendly_pack_path ||= pack_path.relative_path_from(Rails.root).to_s
+    end
 
-def template_src
-  @template_src ||= File.read("tmp/cable_ready_installer/template_src")
-end
+    def self.pack_path
+      @pack_path ||= [
+        Rails.root.join(entrypoint, "application.js"),
+        Rails.root.join(entrypoint, "packs/application.js"),
+        Rails.root.join(entrypoint, "entrypoints/application.js")
+      ].find(&:exist?)
+    end
 
-def controllers_path
-  @controllers_path ||= Rails.root.join(entrypoint, "controllers")
-end
+    def self.package_list
+      @package_list ||= Rails.root.join("tmp/cable_ready_installer/npm_package_list")
+    end
 
-def gemfile_path
-  @gemfile_path ||= Rails.root.join("Gemfile")
-end
+    def self.dev_package_list
+      @dev_package_list ||= Rails.root.join("tmp/cable_ready_installer/npm_dev_package_list")
+    end
 
-def gemfile
-  @gemfile ||= gemfile_path.read
-end
+    def self.drop_package_list
+      @drop_package_list ||= Rails.root.join("tmp/cable_ready_installer/drop_npm_package_list")
+    end
 
-def prefix
-  # standard:disable Style/RedundantStringEscape
-  @prefix ||= {
-    "vite" => "..\/",
-    "webpacker" => "",
-    "shakapacker" => "",
-    "importmap" => "",
-    "esbuild" => ".\/"
-  }[bundler]
-  # standard:enable Style/RedundantStringEscape
-end
+    def self.template_src
+      @template_src ||= File.read("tmp/cable_ready_installer/template_src")
+    end
 
-def application_record_path
-  @application_record_path ||= Rails.root.join("app/models/application_record.rb")
-end
+    def self.controllers_path
+      @controllers_path ||= Rails.root.join(entrypoint, "controllers")
+    end
 
-def action_cable_initializer_path
-  @action_cable_initializer_path ||= Rails.root.join("config/initializers/action_cable.rb")
-end
+    def self.gemfile_path
+      @gemfile_path ||= Rails.root.join("Gemfile")
+    end
 
-def action_cable_initializer_working_path
-  @action_cable_initializer_working_path ||= Rails.root.join(working, "action_cable.rb")
-end
+    def self.gemfile
+      @gemfile ||= gemfile_path.read
+    end
 
-def development_path
-  @development_path ||= Rails.root.join("config/environments/development.rb")
-end
+    def self.prefix
+      # standard:disable Style/RedundantStringEscape
+      @prefix ||= {
+        "vite" => "..\/",
+        "webpacker" => "",
+        "shakapacker" => "",
+        "importmap" => "",
+        "esbuild" => ".\/"
+      }[bundler]
+      # standard:enable Style/RedundantStringEscape
+    end
 
-def development_working_path
-  @development_working_path ||= Rails.root.join(working, "development.rb")
-end
+    def self.application_record_path
+      @application_record_path ||= Rails.root.join("app/models/application_record.rb")
+    end
 
-def backups_path
-  @backups_path ||= Rails.root.join("tmp/cable_ready_installer/backups")
-end
+    def self.action_cable_initializer_path
+      @action_cable_initializer_path ||= Rails.root.join("config/initializers/action_cable.rb")
+    end
 
-def add_gem_list
-  @add_gem_list ||= Rails.root.join("tmp/cable_ready_installer/add_gem_list")
-end
+    def self.action_cable_initializer_working_path
+      @action_cable_initializer_working_path ||= Rails.root.join(working, "action_cable.rb")
+    end
 
-def remove_gem_list
-  @remove_gem_list ||= Rails.root.join("tmp/cable_ready_installer/remove_gem_list")
-end
+    def self.development_path
+      @development_path ||= Rails.root.join("config/environments/development.rb")
+    end
 
-def options_path
-  @options_path ||= Rails.root.join("tmp/cable_ready_installer/options")
-end
+    def self.development_working_path
+      @development_working_path ||= Rails.root.join(working, "development.rb")
+    end
 
-def options
-  @options ||= YAML.safe_load(File.read(options_path))
-end
+    def self.backups_path
+      @backups_path ||= Rails.root.join("tmp/cable_ready_installer/backups")
+    end
+
+    def self.add_gem_list
+      @add_gem_list ||= Rails.root.join("tmp/cable_ready_installer/add_gem_list")
+    end
+
+    def self.remove_gem_list
+      @remove_gem_list ||= Rails.root.join("tmp/cable_ready_installer/remove_gem_list")
+    end
 
-def working
-  @working ||= Rails.root.join("tmp/cable_ready_installer/working")
+    def self.options_path
+      @options_path ||= Rails.root.join("tmp/cable_ready_installer/options")
+    end
+
+    def self.options
+      @options ||= YAML.safe_load(File.read(options_path))
+    end
+
+    def self.working
+      @working ||= Rails.root.join("tmp/cable_ready_installer/working")
+    end
+  end
 end

data/lib/cable_ready/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableReady
-  VERSION = "5.0.3"
+  VERSION = "5.0.4"
 end

data/lib/install/action_cable.rb

@@ -6,11 +6,11 @@ require "cable_ready/installer"
 if defined?(ActionCable::Engine)
   say "✅ ActionCable::Engine is loaded and in scope"
 else
-  halt "ActionCable::Engine is not loaded, please add or uncomment `require \"action_cable/engine\"` to your `config/application.rb`"
+  CableReady::Installer.halt "ActionCable::Engine is not loaded, please add or uncomment `require \"action_cable/engine\"` to your `config/application.rb`"
   return
 end
 
-return if pack_path_missing?
+return if CableReady::Installer.pack_path_missing?
 
 # verify that the Action Cable pubsub config is created
 cable_config = Rails.root.join("config/cable.yml")
@@ -35,7 +35,7 @@ elsif yaml["development"]["adapter"] == "async"
     "url" => "<%= ENV.fetch(\"REDIS_URL\") { \"redis://localhost:6379/1\" } %>",
     "channel_prefix" => "#{app_name}_development"
   }
-  backup(cable_config) do
+  CableReady::Installer.backup(cable_config) do
     cable_config.write(yaml.to_yaml)
   end
   say "✅ config/cable.yml was updated to use the redis adapter in development"
@@ -44,24 +44,24 @@ else
 end
 
 if Rails::VERSION::MAJOR >= 7
-  add_gem "redis@~> 5"
+  CableReady::Installer.add_gem "redis@~> 5"
 else
-  add_gem "redis@~> 4"
+  CableReady::Installer.add_gem "redis@~> 4"
 end
 
 # install action-cable-redis-backport gem if using Action Cable < 7.1
 unless ActionCable::VERSION::MAJOR >= 7 && ActionCable::VERSION::MINOR >= 1
-  if !gemfile.match?(/gem ['"]action-cable-redis-backport['"]/)
-    add_gem "action-cable-redis-backport@~> 1"
+  if !CableReady::Installer.gemfile.match?(/gem ['"]action-cable-redis-backport['"]/)
+    CableReady::Installer.add_gem "action-cable-redis-backport@~> 1"
   end
 end
 
 # verify that the Action Cable channels folder and consumer class is available
 step_path = "/app/javascript/channels/"
-channels_path = Rails.root.join(entrypoint, "channels")
-consumer_src = fetch(step_path, "consumer.js.tt")
+channels_path = Rails.root.join(CableReady::Installer.entrypoint, "channels")
+consumer_src = CableReady::Installer.fetch(step_path, "consumer.js.tt")
 consumer_path = channels_path / "consumer.js"
-index_src = fetch(step_path, "index.js.#{bundler}.tt")
+index_src = CableReady::Installer.fetch(step_path, "index.js.#{CableReady::Installer.bundler}.tt")
 index_path = channels_path / "index.js"
 friendly_index_path = index_path.relative_path_from(Rails.root).to_s
 
@@ -73,7 +73,7 @@ if index_path.exist?
   if index_path.read == index_src.read
     say "✅ #{friendly_index_path} is present"
   else
-    backup(index_path) do
+    CableReady::Installer.backup(index_path) do
       copy_file(index_src, index_path, verbose: false)
     end
     say "✅ #{friendly_index_path} has been created"
@@ -85,43 +85,43 @@ end
 # import Action Cable channels into application pack
 channels_pattern = /import ['"](\.\.\/|\.\/)?channels['"]/
 channels_commented_pattern = /\s*\/\/\s*#{channels_pattern}/
-channel_import = "import \"#{prefix}channels\"\n"
+channel_import = "import \"#{CableReady::Installer.prefix}channels\"\n"
 
-if pack.match?(channels_pattern)
-  if pack.match?(channels_commented_pattern)
-    proceed = if options.key? "uncomment"
-      options["uncomment"]
+if CableReady::Installer.pack.match?(channels_pattern)
+  if CableReady::Installer.pack.match?(channels_commented_pattern)
+    proceed = if CableReady::Installer.options.key? "uncomment"
+      CableReady::Installer.options["uncomment"]
     else
       !no?("✨ Action Cable seems to be commented out in your application.js. Do you want to uncomment it? (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 =~ channels_commented_pattern }
       lines[lines.index(matches.last).to_i] = channel_import
-      pack_path.write lines.join
-      say "✅ channels imported in #{friendly_pack_path}"
+      CableReady::Installer.pack_path.write lines.join
+      say "✅ channels imported in #{CableReady::Installer.friendly_pack_path}"
     else
       say "🤷 your Action Cable channels are not being imported in your application.js. We trust that you have a reason for this."
     end
   else
-    say "✅ channels imported in #{friendly_pack_path}"
+    say "✅ channels 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, channel_import
-  pack_path.write lines.join
-  say "✅ channels imported in #{friendly_pack_path}"
+  CableReady::Installer.pack_path.write lines.join
+  say "✅ channels imported in #{CableReady::Installer.friendly_pack_path}"
 end
 
 # create working copy of Action Cable initializer in tmp
-if action_cable_initializer_path.exist?
-  FileUtils.cp(action_cable_initializer_path, action_cable_initializer_working_path)
+if CableReady::Installer.action_cable_initializer_path.exist?
+  FileUtils.cp(CableReady::Installer.action_cable_initializer_path, CableReady::Installer.action_cable_initializer_working_path)
 else
   # create Action Cable initializer if it doesn't already exist
-  create_file(action_cable_initializer_working_path, verbose: false) do
+  create_file(CableReady::Installer.action_cable_initializer_working_path, verbose: false) do
     <<~RUBY
       # frozen_string_literal: true
 
@@ -131,8 +131,8 @@ else
 end
 
 # silence notoriously chatty Action Cable logs
-if !action_cable_initializer_working_path.read.match?(/^[^#]*ActionCable.server.config.logger/)
-  append_file(action_cable_initializer_working_path, verbose: false) do
+if !CableReady::Installer.action_cable_initializer_working_path.read.match?(/^[^#]*ActionCable.server.config.logger/)
+  append_file(CableReady::Installer.action_cable_initializer_working_path, verbose: false) do
     <<~RUBY
       ActionCable.server.config.logger = Logger.new(nil)
 
@@ -141,4 +141,4 @@ if !action_cable_initializer_working_path.read.match?(/^[^#]*ActionCable.server.
   say "✅ Action Cable logger silenced for performance and legibility"
 end
 
-complete_step :action_cable
+CableReady::Installer.complete_step :action_cable