cable_ready 5.0.0.pre9 → 5.0.0.pre10

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableReady
-  VERSION = "5.0.0.pre9"
+  VERSION = "5.0.0.pre10"
 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,6 +13,8 @@ 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
   class << self

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,20 @@
 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
 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

data/lib/install/broadcaster.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+proceed = if options.key? "broadcaster"
+  options["broadcaster"]
+else
+  !no?("✨ Make CableReady::Broadcaster available to channels, controllers, jobs and models? (Y/n)")
+end
+
+unless proceed
+  complete_step :broadcaster
+
+  puts "⏩ Skipping."
+  return
+end
+
+# include CableReady::Broadcaster in Action Cable Channel classes
+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
+      index = lines.index { |line| line.include?("class Channel < ActionCable::Channel::Base") }
+      lines.insert index + 1, "    include CableReady::Broadcaster\n"
+      channel_path.write lines.join
+    end
+
+    puts "✅ include CableReady::Broadcaster in Action Cable channels"
+  else
+    puts "⏩  already included CableReady::Broadcaster in Action Cable channels. Skipping"
+  end
+end
+
+# include CableReady::Broadcaster in Action Controller classes
+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
+      index = lines.index { |line| line.include?("class ApplicationController < ActionController::Base") }
+      lines.insert index + 1, "  include CableReady::Broadcaster\n"
+      controller_path.write lines.join
+    end
+
+    puts "✅ include CableReady::Broadcaster in Action Controller classes"
+  else
+    puts "⏩  already included CableReady::Broadcaster in Action Controller classes. Skipping"
+  end
+end
+
+# include CableReady::Broadcaster in Active Job classes, if present
+if defined?(ActiveJob)
+  job_path = Rails.root.join("app/jobs/application_job.rb")
+  if job_path.exist?
+    lines = job_path.readlines
+    if !lines.index { |line| line =~ /^\s*include CableReady::Broadcaster/ }
+      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
+      end
+
+      puts "✅ include CableReady::Broadcaster in Active Job classes"
+    else
+      puts "⏩  already included CableReady::Broadcaster in Active Job classes. Skipping"
+    end
+  end
+else
+  puts "⏩ Active Job not available. Skipping."
+end
+
+# include CableReady::Broadcaster in StateMachines, if present
+if defined?(StateMachines)
+  lines = 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
+      <<-RUBY
+
+  StateMachines::Machine.prepend(CableReady::Broadcaster)
+
+      RUBY
+    end
+
+    puts "✅ prepend CableReady::Broadcaster into StateMachines::Machine"
+  else
+    puts "⏩  already prepended CableReady::Broadcaster into StateMachines::Machine. Skipping"
+  end
+else
+  puts "⏩ StateMachines not available. Skipping."
+end
+
+# include CableReady::Broadcaster in Active Record model classes
+if Rails.root.join(application_record_path).exist?
+  lines = application_record_path.readlines
+  if !lines.index { |line| line =~ /^\s*include CableReady::Broadcaster/ }
+    backup(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
+    end
+
+    puts "✅ include CableReady::Broadcaster in Active Record model classes"
+  else
+    puts "⏩  already included CableReady::Broadcaster in Active Record model classes. Skipping"
+  end
+end
+
+complete_step :broadcaster

data/lib/install/bundle.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "cable_ready/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
+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,51 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+initializer = action_cable_initializer_working_path.read
+
+proceed = false
+
+if initializer.exclude? "PermessageDeflate.configure"
+  proceed = if options.key? "compression"
+    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"
+  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 WS traffic"
+  else
+    say "⏩ Action Cable initializer is already patched to deflate WS traffic. Skipping."
+  end
+end
+
+complete_step :compression

data/lib/install/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "cable_ready/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"
+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?
+
+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"
+
+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
+  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
+end
+say "✅ CableReady configs will be imported in #{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?
+
+complete_step :config

data/lib/install/development.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "cable_ready/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
+
+complete_step :development