cable_ready 5.0.0.pre8 → 5.0.0.pre10

data/lib/install/mrujs.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+return if pack_path_missing?
+
+mrujs_path = config_path / "mrujs.js"
+
+proceed = false
+
+if !File.exist?(mrujs_path)
+  proceed = if options.key? "mrujs"
+    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 !importmap_path.exist?
+      halt "#{friendly_importmap_path} is missing. You need a valid importmap config file to proceed."
+      return
+    end
+
+    importmap = importmap_path.read
+
+    if !importmap.include?("pin \"mrujs\"")
+      append_file(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)
+        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"
+    end
+
+    # queue @rails/ujs for removal
+    if package_json.read.include?('"@rails/ujs":')
+      drop_package "@rails/ujs"
+    end
+  end
+
+  step_path = "/app/javascript/config/"
+  mrujs_src = 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 = index_path.read
+  friendly_index_path = index_path.relative_path_from(Rails.root).to_s
+  mrujs_pattern = /import ['"].\/mrujs['"]/
+  mrujs_import = "import '.\/mrujs'\n" # standard:disable Style/RedundantStringEscape
+
+  if !index.match?(mrujs_pattern)
+    append_file(index_path, mrujs_import, verbose: false)
+  end
+  say "✅ mrujs imported in #{friendly_index_path}"
+
+  # remove @rails/ujs from application.js
+  rails_ujs_pattern = /import Rails from ['"]@rails\/ujs['"]/
+
+  lines = 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}"
+  end
+
+  # set Action View to generate remote forms when using form_with
+  application_path = Rails.root.join("config/application.rb")
+  application_pattern = /^[^#]*config\.action_view\.form_with_generates_remote_forms = true/
+  defaults_pattern = /config\.load_defaults \d\.\d/
+
+  lines = application_path.readlines
+  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
+          <<-RUBY
+  \n#{lines[index]}
+      # form_with helper will generate remote forms by default (mrujs)
+      config.action_view.form_with_generates_remote_forms = true
+          RUBY
+        end
+      else
+        insert_into_file application_path, after: "class Application < Rails::Application" do
+          <<-RUBY
+
+      # form_with helper will generate remote forms by default (mrujs)
+      config.action_view.form_with_generates_remote_forms = true
+          RUBY
+        end
+      end
+    end
+    say "✅ form_with_generates_remote_forms set to true in config/application.rb"
+  end
+
+  # remove turbolinks from Gemfile because it's incompatible with mrujs (and unnecessary)
+  turbolinks_pattern = /^[^#]*gem ["']turbolinks["']/
+
+  lines = gemfile_path.readlines
+  if lines.index { |line| line =~ turbolinks_pattern }
+    remove_gem :turbolinks
+  else
+    say "✅ turbolinks is not present in Gemfile"
+  end
+end
+
+complete_step :mrujs

data/lib/install/npm_packages.rb

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

data/lib/install/shakapacker.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+return if pack_path_missing?
+
+# verify that all critical dependencies are up to date; if not, queue for later
+lines = package_json.readlines
+if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
+  add_package "@hotwired/stimulus@^3.2"
+end
+
+if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus-webpack-helpers["']: ["']\^1.0.1["']/ }
+  add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
+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"
+
+# create entrypoint/controllers, as well as the index, application and application_controller
+empty_directory controllers_path unless 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?
+
+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"]
+    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
+      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}"
+    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}"
+  end
+else
+  lines = 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}"
+end
+
+complete_step :shakapacker

data/lib/install/spring.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+spring_pattern = /^[^#]*gem ["']spring["']/
+
+proceed = false
+lines = gemfile_path.readlines
+
+if lines.index { |line| line =~ spring_pattern }
+  proceed = if options.key? "spring"
+    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
+else
+  say "⏩ Spring is not installed."
+end
+
+if proceed
+  spring_watcher_pattern = /^[^#]*gem ["']spring-watcher-listen["']/
+  bin_rails_pattern = /^[^#]*load File.expand_path\("spring", __dir__\)/
+
+  if (index = lines.index { |line| line =~ spring_pattern })
+    remove_gem :spring
+
+    bin_spring = Rails.root.join("bin/spring")
+    if bin_spring.exist?
+      run "bin/spring binstub --remove --all"
+      say "✅ Removed spring binstubs"
+    end
+
+    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
+        bin_rails_content[index] = "# #{bin_rails_content[index]}"
+        bin_rails.write bin_rails_content.join
+      end
+      say "✅ Removed spring from bin/rails"
+    end
+    create_file "tmp/cable_ready_installer/kill_spring", verbose: false
+  else
+    say "✅ spring has been successfully removed"
+  end
+
+  if lines.index { |line| line =~ spring_watcher_pattern }
+    remove_gem "spring-watcher-listen"
+  end
+else
+  say "⏩ Skipping."
+end
+
+complete_step :spring

data/lib/install/updatable.rb

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

data/lib/install/vite.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+return if pack_path_missing?
+
+# verify that all critical dependencies are up to date; if not, queue for later
+lines = package_json.readlines
+if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
+  add_package "@hotwired/stimulus@^3.2"
+end
+
+if !lines.index { |line| line =~ /^\s*["']stimulus-vite-helpers["']: ["']\^3["']/ }
+  add_package "stimulus-vite-helpers@^3"
+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"
+
+# create entrypoint/controllers, as well as the index, application and application_controller
+empty_directory controllers_path unless 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?
+
+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"]
+    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
+      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}"
+    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}"
+  end
+else
+  lines = 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}"
+end
+
+complete_step :vite

data/lib/install/webpacker.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+return if pack_path_missing?
+
+# verify that all critical dependencies are up to date; if not, queue for later
+lines = package_json.readlines
+if !lines.index { |line| line =~ /^\s*["']webpack["']: ["']\^4.46.0["']/ }
+  add_package "webpack@^4.46.0"
+end
+
+if !lines.index { |line| line =~ /^\s*["']webpack-cli["']: ["']\^3.3.12["']/ }
+  add_package "webpack-cli@^3.3.12"
+end
+
+if !lines.index { |line| line =~ /^\s*["']@rails\/webpacker["']: ["']\^5.4.3["']/ }
+  add_package "@rails/webpacker@^5.4.3"
+end
+
+if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus["']:/ }
+  add_package "@hotwired/stimulus@^3.2"
+end
+
+if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus-webpack-helpers["']: ["']\^1.0.1["']/ }
+  add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"
+end
+
+if !lines.index { |line| line =~ /^\s*["']webpack-dev-server["']: ["']\^3.11.3["']/ }
+  add_dev_package "webpack-dev-server@^3.11.3"
+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"
+
+# create entrypoint/controllers, as well as the index, application and application_controller
+empty_directory controllers_path unless 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?
+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"]
+    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
+      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}"
+    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}"
+  end
+else
+  lines = 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}"
+end
+
+# ensure webpacker is installed in the Gemfile
+add_gem "webpacker@5.4.3"
+
+complete_step :webpacker

data/lib/install/yarn.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "cable_ready/installer"
+
+if !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) : []
+
+json = JSON.parse(package_json.read)
+
+if add.present? || dev.present? || drop.present?
+
+  add.each do |package|
+    matches = package.match(/(.+)@(.+)/)
+    name, version = matches[1], matches[2]
+    json["dependencies"] = {} unless json["dependencies"]
+    json["dependencies"][name] = version
+  end
+
+  dev.each do |package|
+    matches = package.match(/(.+)@(.+)/)
+    name, version = matches[1], matches[2]
+    json["devDependencies"] = {} unless json["devDependencies"]
+    json["devDependencies"][name] = version
+  end
+
+  drop.each do |package|
+    json["dependencies"].delete(package)
+    json["devDependencies"].delete(package)
+  end
+
+  package_json.write JSON.pretty_generate(json)
+
+  system "yarn install --silent"
+else
+  say "⏩ No yarn depdencies to add or remove. Skipping."
+
+end
+
+if 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)
+  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