cable_ready 5.0.0.pre9 → 5.0.0.rc1

data/lib/cable_ready/identifiable.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "action_view"
+
 module CableReady
   module Identifiable
     def dom_id(record, prefix = nil)
@@ -9,9 +11,9 @@ module CableReady
 
       id = if record.respond_to?(:to_dom_id)
         record.to_dom_id
-      elsif record.is_a?(ActiveRecord::Relation)
+      elsif ar_relation?(record)
         [prefix, record.model_name.plural].compact.join("_")
-      elsif record.is_a?(ActiveRecord::Base)
+      elsif ar_base?(record)
         ActionView::RecordIdentifier.dom_id(record, prefix)
       else
         [prefix, record.to_s.strip].compact.join("_")
@@ -21,10 +23,26 @@ module CableReady
     end
 
     def identifiable?(obj)
-      obj.respond_to?(:to_dom_selector) ||
+      (
+        obj.respond_to?(:to_dom_selector) ||
         obj.respond_to?(:to_dom_id) ||
-        obj.is_a?(ActiveRecord::Relation) ||
-        obj.is_a?(ActiveRecord::Base)
+        ar_relation?(obj) ||
+        ar_base?(obj)
+      )
+    end
+
+    private
+
+    def ar_relation?(obj)
+      return false if defined?(ActiveRecord).nil? || defined?(ActiveRecord::Relation).nil?
+
+      obj.is_a?(ActiveRecord::Relation)
+    end
+
+    def ar_base?(obj)
+      return false if defined?(ActiveRecord).nil? || defined?(ActiveRecord::Base).nil?
+
+      obj.is_a?(ActiveRecord::Base)
     end
   end
 end

data/lib/cable_ready/importmap.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 pin "morphdom", to: "https://ga.jspm.io/npm:morphdom@2.6.1/dist/morphdom.js", preload: true
-pin "cable_ready", to: "cable_ready.min.js", preload: true
+pin "cable_ready", to: "cable_ready.js", preload: true

data/lib/cable_ready/installer.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require "cable_ready/version"
+
+### general utilities
+
+def fetch(step_path, file)
+  relative_path = step_path + file
+  location = template_src + relative_path
+
+  Pathname.new(location)
+end
+
+def complete_step(step)
+  create_file "tmp/cable_ready_installer/#{step}", verbose: false
+end
+
+def create_or_append(path, *args, &block)
+  FileUtils.touch(path)
+  append_file(path, *args, &block)
+end
+
+def current_template
+  ENV["LOCATION"].split("/").last.gsub(".rb", "")
+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 halt(message)
+  say "❌ #{message}", :red
+  create_file "tmp/cable_ready_installer/halt", verbose: false
+end
+
+def 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
+
+  yield
+
+  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 add_gem(name)
+  create_or_append(add_gem_list, "#{name}\n", verbose: false)
+  say "☑️  Added #{name} to the Gemfile"
+end
+
+def remove_gem(name)
+  create_or_append(remove_gem_list, "#{name}\n", verbose: false)
+  say "❎ Removed #{name} from Gemfile"
+end
+
+def add_package(name)
+  create_or_append(package_list, "#{name}\n", verbose: false)
+  say "☑️  Enqueued #{name} to be added to dependencies"
+end
+
+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
+
+def drop_package(name)
+  create_or_append(drop_package_list, "#{name}\n", verbose: false)
+  say "❎ Enqueued #{name} to be removed from dependencies"
+end
+
+def gemfile_hash
+  Digest::MD5.hexdigest(gemfile_path.read)
+end
+
+### memoized values
+
+def cr_npm_version
+  @cr_npm_version ||= CableReady::VERSION.gsub(".pre", "-pre")
+end
+
+def package_json
+  @package_json ||= Rails.root.join("package.json")
+end
+
+def entrypoint
+  @entrypoint ||= File.read("tmp/cable_ready_installer/entrypoint")
+end
+
+def bundler
+  @bundler ||= File.read("tmp/cable_ready_installer/bundler")
+end
+
+def config_path
+  @config_path ||= Rails.root.join(entrypoint, "config")
+end
+
+def importmap_path
+  @importmap_path ||= Rails.root.join("config/importmap.rb")
+end
+
+def friendly_importmap_path
+  @friendly_importmap_path ||= importmap_path.relative_path_from(Rails.root).to_s
+end
+
+def pack
+  @pack ||= pack_path.read
+end
+
+def friendly_pack_path
+  @friendly_pack_path ||= pack_path.relative_path_from(Rails.root).to_s
+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 package_list
+  @package_list ||= Rails.root.join("tmp/cable_ready_installer/npm_package_list")
+end
+
+def dev_package_list
+  @dev_package_list ||= Rails.root.join("tmp/cable_ready_installer/npm_dev_package_list")
+end
+
+def drop_package_list
+  @drop_package_list ||= Rails.root.join("tmp/cable_ready_installer/drop_npm_package_list")
+end
+
+def template_src
+  @template_src ||= File.read("tmp/cable_ready_installer/template_src")
+end
+
+def controllers_path
+  @controllers_path ||= Rails.root.join(entrypoint, "controllers")
+end
+
+def gemfile_path
+  @gemfile_path ||= Rails.root.join("Gemfile")
+end
+
+def gemfile
+  @gemfile ||= gemfile_path.read
+end
+
+def prefix
+  # standard:disable Style/RedundantStringEscape
+  @prefix ||= {
+    "vite" => "..\/",
+    "webpacker" => "",
+    "shakapacker" => "",
+    "importmap" => "",
+    "esbuild" => ".\/"
+  }[bundler]
+  # standard:enable Style/RedundantStringEscape
+end
+
+def application_record_path
+  @application_record_path ||= Rails.root.join("app/models/application_record.rb")
+end
+
+def action_cable_initializer_path
+  @action_cable_initializer_path ||= Rails.root.join("config/initializers/action_cable.rb")
+end
+
+def action_cable_initializer_working_path
+  @action_cable_initializer_working_path ||= Rails.root.join(working, "action_cable.rb")
+end
+
+def development_path
+  @development_path ||= Rails.root.join("config/environments/development.rb")
+end
+
+def development_working_path
+  @development_working_path ||= Rails.root.join(working, "development.rb")
+end
+
+def backups_path
+  @backups_path ||= Rails.root.join("tmp/cable_ready_installer/backups")
+end
+
+def add_gem_list
+  @add_gem_list ||= Rails.root.join("tmp/cable_ready_installer/add_gem_list")
+end
+
+def remove_gem_list
+  @remove_gem_list ||= Rails.root.join("tmp/cable_ready_installer/remove_gem_list")
+end
+
+def options_path
+  @options_path ||= Rails.root.join("tmp/cable_ready_installer/options")
+end
+
+def options
+  @options ||= YAML.safe_load(File.read(options_path))
+end
+
+def working
+  @working ||= Rails.root.join("tmp/cable_ready_installer/working")
+end

data/lib/cable_ready/operation_builder.rb

@@ -64,7 +64,7 @@ module CableReady
       rescue JSON::ParserError
         {}
       end
-      @enqueued_operations.push(operations)
+      @enqueued_operations.concat(Array.wrap(operations))
       self
     end
 

data/lib/cable_ready/sanity_checker.rb

@@ -10,8 +10,7 @@ class CableReady::SanityChecker
       return if called_by_generate_config?
       return if called_by_rake?
 
-      instance = new
-      instance.check_new_version_available
+      new
     end
 
     private
@@ -25,37 +24,8 @@ class CableReady::SanityChecker
     end
   end
 
-  def check_new_version_available
-    return if CableReady.config.on_new_version_available == :ignore
-    return if Rails.env.development? == false
-    return if using_preview_release?
-    begin
-      latest_version = URI.open("https://raw.githubusercontent.com/stimulusreflex/cable_ready/master/LATEST", open_timeout: 1, read_timeout: 1).read.strip
-      if latest_version != CableReady::VERSION
-        puts <<~WARN
-
-          👉 There is a new version of CableReady available!
-          Current: #{CableReady::VERSION} Latest: #{latest_version}
-
-          If you upgrade, it is very important that you update BOTH Gemfile and package.json
-          Then, run `bundle install && yarn install` to update to #{latest_version}.
-
-        WARN
-        exit if CableReady.config.on_new_version_available == :exit
-      end
-    rescue
-      puts "👉 CableReady #{CableReady::VERSION} update check skipped: connection timeout"
-    end
-  end
-
   private
 
-  def using_preview_release?
-    preview = CableReady::VERSION.match?(LATEST_VERSION_FORMAT) == false
-    puts "👉 CableReady #{CableReady::VERSION} update check skipped: pre-release build" if preview
-    preview
-  end
-
   def initializer_missing?
     File.exist?(Rails.root.join("config", "initializers", "cable_ready.rb")) == false
   end

data/lib/cable_ready/updatable/memory_cache_debounce_adapter.rb

@@ -0,0 +1,22 @@
+module CableReady
+  module Updatable
+    class MemoryCacheDebounceAdapter
+      include Singleton
+
+      delegate_missing_to :@store
+
+      def initialize
+        super
+        @store = ActiveSupport::Cache::MemoryStore.new(expires_in: 5.minutes, size: 8.megabytes)
+      end
+
+      def []=(key, value)
+        @store.write(key, value)
+      end
+
+      def [](key)
+        @store.read(key)
+      end
+    end
+  end
+end

data/lib/cable_ready/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableReady
-  VERSION = "5.0.0.pre9"
+  VERSION = "5.0.0.rc1"
 end

data/lib/cable_ready.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
 require "open-uri"
-require "active_record"
-require "action_view"
-require "active_support/all"
-require "thread/local"
-require "monitor"
-require "observer"
-require "singleton"
-require "cable_ready/version"
+require "active_support/message_verifier"
 require "cable_ready/identifiable"
 require "cable_ready/operation_builder"
 require "cable_ready/config"
@@ -20,8 +13,12 @@ require "cable_ready/channel"
 require "cable_ready/channels"
 require "cable_ready/cable_car"
 require "cable_ready/stream_identifier"
+require "cable_ready/version"
+require "cable_ready_helper"
 
 module CableReady
+  autoload :MemoryCacheDebounceAdapter, "cable_ready/updatable/memory_cache_debounce_adapter"
+
   class << self
     def config
       CableReady::Config.instance

data/lib/cable_ready_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# TODO: remove me once CableReady 5.0 was released
+
+require_relative "../app/helpers/cable_ready/view_helper"
+
+module CableReadyHelper
+  def self.included(base)
+    warn "NOTICE: `CableReadyHelper` was renamed to `CableReady::ViewHelper`. Please update your include accordingly."
+
+    base.include(::CableReady::ViewHelper)
+  end
+end

data/lib/generators/cable_ready/channel_generator.rb

@@ -7,32 +7,71 @@ class CableReady::ChannelGenerator < Rails::Generators::NamedBase
   class_option :stream_for, type: :string
   class_option :stimulus, type: :boolean
 
+  def destroy_not_supported
+    if behavior == :revoke
+      puts "Sorry, we don't support destroying generated channels.\nDelete the Action Cable channel class, as well as any corresponding JavaScript classes."
+      exit
+    end
+  end
+
   def check_options
-    raise "Can't specify --stream-from and --stream-for at the same time" if options.key?(:stream_from) && options.key?(:stream_for)
+    if options.key?(:stream_from) && options.key?(:stream_for)
+      puts "Can't specify --stream-from and --stream-for at the same time"
+      exit
+    end
   end
 
   def create_channel
-    generate "channel", file_name
+    generate "channel", file_name, "--skip"
   end
 
   def enhance_channels
+    @entrypoint = [
+      "app/javascript",
+      "app/frontend"
+    ].find { |path| File.exist?(Rails.root.join(path)) } || "app/javascript"
+    puts "Where do JavaScript files live in your app? Our best guess is: \e[1m#{@entrypoint}\e[22m 🤔"
+    puts "Press enter to accept this, or type a different path."
+    print "> "
+    input = Rails.env.test? ? "tmp/app/javascript" : $stdin.gets.chomp
+    @entrypoint = input unless input.blank?
+    @js_channel = "#{@entrypoint}/channels/#{file_name}_channel.js"
+
     if using_broadcast_to?
-      gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_for #{resource}.find(params[:id])\n"
-      template "app/javascript/controllers/%file_name%_controller.js" if using_stimulus?
-    else
-      prepend_to_file "app/javascript/channels/#{file_name}_channel.js", "import CableReady from 'cable_ready'\n"
-      inject_into_file "app/javascript/channels/#{file_name}_channel.js", after: "// Called when there's incoming data on the websocket for this channel\n" do
-        <<-JS
-    if (data.cableReady) CableReady.perform(data.operations)
-        JS
+      if using_stimulus?
+        template("#{@entrypoint}/controllers/%file_name%_controller.js")
+        Rails.root.join(@js_channel).delete
+      else
+        gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_for #{resource}.find(params[:id])\n", verbose: false
+        gsub_file @js_channel, /"#{resource}Channel"/, verbose: false do
+          <<-JS
+
+  {
+    channel: "#{resource}Channel",
+    id: 1
+  }
+          JS
+        end
+        doctor_javascript_channel_class
+        puts "\nDon't forget to update the id in the channel subscription: #{@js_channel}\nIt's currently set to 1; you'll want to change that to a dynamic value based on something in your DOM."
       end
-
-      gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_from \"#{identifier}\"\n"
+    else
+      gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_from \"#{identifier}\"\n", verbose: false
+      doctor_javascript_channel_class
     end
   end
 
   private
 
+  def doctor_javascript_channel_class
+    prepend_to_file @js_channel, "import CableReady from 'cable_ready'\n", verbose: false
+    inject_into_file @js_channel, after: "// Called when there's incoming data on the websocket for this channel\n", verbose: false do
+      <<-JS
+    if (data.cableReady) CableReady.perform(data.operations)
+      JS
+    end
+  end
+
   def option_given?
     options.key?(:stream_from) || options.key?(:stream_for)
   end

data/lib/generators/cable_ready/templates/config/initializers/cable_ready.rb

@@ -3,16 +3,25 @@
 CableReady.configure do |config|
   # Enable/disable exiting / warning when the sanity checks fail options:
   # `:exit` or `:warn` or `:ignore`
-
+  #
   # config.on_failed_sanity_checks = :exit
 
-  # Enable/disable exiting / warning when there's a new CableReady release
-  # `:exit` or `:warn` or `:ignore`
-
-  # config.on_new_version_available = :ignore
+  # Enable/disable assets compilation
+  # `true` or `false`
+  #
+  # config.precompile_assets = true
 
   # Define your own custom operations
   # https://cableready.stimulusreflex.com/customization#custom-operations
-
+  #
   # config.add_operation_name :jazz_hands
+
+  # Change the default Active Job queue used for broadcast_later and broadcast_later_to
+  #
+  # config.broadcast_job_queue = :default
+
+  # Specify a default debounce time for CableReady::Updatable callbacks
+  # Doing so is a best practice to avoid heavy ActionCable traffic
+  #
+  # config.updatable_debounce_time = 0.1.seconds
 end

data/lib/install/action_cable.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+# verify that Action Cable is installed
+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`"
+  return
+end
+
+return if pack_path_missing?
+
+# verify that the Action Cable pubsub config is created
+cable_config = Rails.root.join("config/cable.yml")
+
+if cable_config.exist?
+  say "✅ config/cable.yml is present"
+else
+  inside "config" do
+    template "cable.yml"
+  end
+end
+
+# verify that the Action Cable pubsub is set to use redis in development
+yaml = YAML.safe_load(cable_config.read)
+app_name = Rails.application.class.module_parent.name.underscore
+
+if yaml["development"]["adapter"] == "redis"
+  say "✅ config/cable.yml is configured to use the redis adapter in development"
+elsif yaml["development"]["adapter"] == "async"
+  yaml["development"] = {
+    "adapter" => "redis",
+    "url" => "<%= ENV.fetch(\"REDIS_URL\") { \"redis://localhost:6379/1\" } %>",
+    "channel_prefix" => "#{app_name}_development"
+  }
+  backup(cable_config) do
+    cable_config.write(yaml.to_yaml)
+  end
+  say "✅ config/cable.yml was updated to use the redis adapter in development"
+else
+  say "🤷 config/cable.yml should use the redis adapter - or something like it - in development. You have something else specified, and we trust that you know what you're doing."
+end
+
+if Rails::VERSION::MAJOR >= 7
+  add_gem "redis@~> 5"
+else
+  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"
+  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")
+consumer_path = channels_path / "consumer.js"
+index_src = fetch(step_path, "index.js.#{bundler}.tt")
+index_path = channels_path / "index.js"
+friendly_index_path = index_path.relative_path_from(Rails.root).to_s
+
+empty_directory channels_path unless channels_path.exist?
+
+copy_file(consumer_src, consumer_path) unless consumer_path.exist?
+
+if index_path.exist?
+  if index_path.read == index_src.read
+    say "✅ #{friendly_index_path} is present"
+  else
+    backup(index_path) do
+      copy_file(index_src, index_path, verbose: false)
+    end
+    say "✅ #{friendly_index_path} has been created"
+  end
+else
+  copy_file(index_src, index_path)
+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"
+
+if pack.match?(channels_pattern)
+  if pack.match?(channels_commented_pattern)
+    proceed = if options.key? "uncomment"
+      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
+      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}"
+    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}"
+  end
+else
+  lines = 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}"
+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)
+else
+  # create Action Cable initializer if it doesn't already exist
+  create_file(action_cable_initializer_working_path, verbose: false) do
+    <<~RUBY
+      # frozen_string_literal: true
+
+    RUBY
+  end
+  say "✅ Action Cable initializer created"
+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
+    <<~RUBY
+      ActionCable.server.config.logger = Logger.new(nil)
+
+    RUBY
+  end
+  say "✅ Action Cable logger silenced for performance and legibility"
+end
+
+complete_step :action_cable