cable_ready 4.5.0 → 5.0.0

data/lib/install/vite.rb

@@ -0,0 +1,66 @@
+# 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"
+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"
+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"
+
+# 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,93 @@
+# 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"
+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"
+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"
+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"
+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"
+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"
+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"
+
+# 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

data/lib/tasks/cable_ready/cable_ready.rake

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+CR_STEPS = {
+  "action_cable" => "Action Cable",
+  "webpacker" => "Install CableReady using Webpacker",
+  "shakapacker" => "Install CableReady using Shakapacker",
+  "npm_packages" => "Install CableReady npm package",
+  "importmap" => "Install CableReady using importmaps",
+  "esbuild" => "Install CableReady using esbuild",
+  "config" => "Client initialization",
+  "initializers" => "Generate and configure initializer",
+  "development" => "development environment configuration",
+  "spring" => "Disable spring gem. Spring has been removed from Rails 7",
+  "mrujs" => "Swap out Rails UJS for mrujs",
+  "broadcaster" => "Make CableReady::Broadcaster available to channels, controllers, jobs and models",
+  "updatable" => "Include CableReady::Updatable in Active Record model classes",
+  "vite" => "Install CableReady using Vite",
+  "compression" => "Compress WebSocket traffic with gzip"
+}
+
+CR_BUNDLERS = {
+  "webpacker" => ["npm_packages", "webpacker", "config", "action_cable", "development", "initializers", "broadcaster", "updatable", "spring", "yarn", "bundle"],
+  "esbuild" => ["npm_packages", "esbuild", "config", "action_cable", "development", "initializers", "broadcaster", "updatable", "spring", "yarn", "bundle"],
+  "vite" => ["npm_packages", "vite", "config", "action_cable", "development", "initializers", "broadcaster", "updatable", "spring", "yarn", "bundle"],
+  "shakapacker" => ["npm_packages", "shakapacker", "config", "action_cable", "development", "initializers", "broadcaster", "updatable", "spring", "yarn", "bundle"],
+  "importmap" => ["config", "action_cable", "importmap", "development", "initializers", "broadcaster", "updatable", "spring", "bundle"]
+}
+
+def run_install_template(template, force: false, trace: false)
+  puts "--- [#{template}] ----"
+
+  if Rails.root.join("tmp/cable_ready_installer/halt").exist?
+    FileUtils.rm(Rails.root.join("tmp/cable_ready_installer/halt"))
+    puts "CableReady installation halted. Please fix the issues above and try again."
+    exit
+  end
+  if Rails.root.join("tmp/cable_ready_installer/#{template}").exist? && !force
+    puts "👍 Step #{template} already completed. Skipping."
+    return
+  end
+
+  system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/#{template}.rb", __dir__)} SKIP_SANITY_CHECK=true #{"--trace" if trace}"
+
+  puts
+end
+
+namespace :cable_ready do
+  desc "✨ Install CableReady ✨"
+  task :install do
+    FileUtils.mkdir_p(Rails.root.join("tmp/cable_ready_installer/templates"))
+    FileUtils.mkdir_p(Rails.root.join("tmp/cable_ready_installer/working"))
+    install_complete = Rails.root.join("tmp/cable_ready_installer/complete")
+
+    bundler = nil
+    options = {}
+
+    ARGV.each do |arg|
+      # make sure we have a valid build tool specified, or proceed to automatic detection
+      if ["webpacker", "esbuild", "vite", "shakapacker", "importmap"].include?(arg)
+        bundler = arg
+      else
+        kv = arg.split("=")
+        if kv.length == 2
+          kv[1] = if kv[1] == "true"
+            true
+          else
+            (kv[1] == "false") ? false : kv[1]
+          end
+          options[kv[0]] = kv[1]
+        end
+      end
+    end
+
+    options_path = Rails.root.join("tmp/cable_ready_installer/options")
+    options_path.write(options.to_yaml)
+
+    if defined?(StimulusReflex)
+      puts "✨ \e[38;5;220mStimulusReflex\e[0m is present in this project ✨"
+      puts
+      puts "CableReady will be installed with StimulusReflex. Just run: \e[38;5;231mrails stimulus_reflex:install\e[0m"
+      puts
+      puts "Get help on Discord: \e[4;97mhttps://discord.gg/stimulus-reflex\e[0m. \e[38;5;196mWe are here for you.\e[0m 💙"
+      puts
+      exit
+    end
+
+    if install_complete.exist?
+      puts "✨ \e[38;5;220mCableReady\e[0m is already installed ✨"
+      puts
+      puts "To restart the installation process, run: \e[38;5;231mrails cable_ready:install:restart\e[0m"
+      puts
+      puts "To get started, check out \e[4;97mhttps://cableready.stimulusreflex.com/guide/cableready-101\e[0m"
+      puts "or get help on Discord: \e[4;97mhttps://discord.gg/stimulus-reflex\e[0m. \e[38;5;196mWe are here for you.\e[0m 💙"
+      puts
+      exit
+    end
+
+    # if there is an installation in progress, continue where we left off
+    cached_entrypoint = Rails.root.join("tmp/cable_ready_installer/entrypoint")
+
+    if cached_entrypoint.exist?
+      entrypoint = File.read(cached_entrypoint)
+      puts "✨ Resuming \e[38;5;220mCableReady\e[0m installation ✨"
+      puts
+      puts "If you have any setup issues, please consult \e[4;97mhttps://cableready.stimulusreflex.com/hello-world/setup\e[0m"
+      puts "or get help on Discord: \e[4;97mhttps://discord.gg/stimulus-reflex\e[0m. \e[38;5;196mWe are here for you.\e[0m 💙"
+      puts
+      puts "Resuming installation into \e[1m#{entrypoint}\e[22m"
+      puts "Run \e[1;94mrails cable_ready:install:restart\e[0m to restart the installation process"
+      puts
+    else
+      puts "✨ Installing \e[38;5;220mCableReady\e[0m ✨"
+      puts
+      puts "If you have any setup issues, please consult \e[4;97mhttps://cableready.stimulusreflex.com/hello-world/setup\e[0m"
+      puts "or get help on Discord: \e[4;97mhttps://discord.gg/stimulus-reflex\e[0m. \e[38;5;196mWe are here for you.\e[0m 💙"
+      if Rails.root.join(".git").exist?
+        puts
+        puts "We recommend running \e[1;94mgit commit\e[0m before proceeding. A diff will be generated at the end."
+      end
+
+      if options.key? "entrypoint"
+        entrypoint = options["entrypoint"]
+      else
+        entrypoint = [
+          "app/javascript",
+          "app/frontend"
+        ].find { |path| File.exist?(Rails.root.join(path)) } || "app/javascript"
+
+        puts
+        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 = $stdin.gets.chomp
+        entrypoint = input unless input.blank?
+      end
+      File.write(cached_entrypoint, entrypoint)
+    end
+
+    # verify their bundler before starting, unless they explicitly specified on CLI
+    if !bundler
+      # auto-detect build tool based on existing packages and configuration
+      if Rails.root.join("config/importmap.rb").exist?
+        bundler = "importmap"
+      elsif Rails.root.join("package.json").exist?
+        package_json = File.read(Rails.root.join("package.json"))
+        bundler = "webpacker" if package_json.include?('"@rails/webpacker":')
+        bundler = "esbuild" if package_json.include?('"esbuild":')
+        bundler = "vite" if package_json.include?('"vite":')
+        bundler = "shakapacker" if package_json.include?('"shakapacker":')
+        if !bundler
+          puts "❌ You must be using a node-based bundler such as esbuild, webpacker, vite or shakapacker (package.json) or importmap (config/importmap.rb) to use CableReady."
+          exit
+        end
+      else
+        puts "❌ You must be using a node-based bundler such as esbuild, webpacker, vite or shakapacker (package.json) or importmap (config/importmap.rb) to use CableReady."
+        exit
+      end
+
+      puts
+      puts "It looks like you're using \e[1m#{bundler}\e[22m as your bundler. Is that correct? (Y/n)"
+      print "> "
+      input = $stdin.gets.chomp
+      if input.downcase == "n"
+        puts
+        puts "CableReady installation supports: esbuild, webpacker, vite, shakapacker and importmap."
+        puts "Please run \e[1;94mrails cable_ready:install [bundler]\e[0m to install CableReady."
+        exit
+      end
+    end
+
+    File.write("tmp/cable_ready_installer/bundler", bundler)
+    FileUtils.touch("tmp/cable_ready_installer/backups")
+    File.write("tmp/cable_ready_installer/template_src", File.expand_path("../../generators/cable_ready/templates/", __dir__))
+
+    # do the things
+    CR_BUNDLERS[bundler].each do |template|
+      run_install_template(template, trace: !!options["trace"])
+    end
+
+    puts
+    puts "🎉 \e[1;92mCableReady has been successfully installed!\e[22m 🎉"
+    puts
+    puts "👉 \e[4;97mhttps://cableready.stimulusreflex.com/guide/cableready-101\e[0m"
+    puts
+    puts "Join over 2000 CableReady developers on Discord: \e[4;97mhttps://discord.gg/stimulus-reflex\e[0m"
+    puts
+
+    backups = File.readlines("tmp/cable_ready_installer/backups").map(&:chomp)
+
+    if backups.any?
+      puts "🙆  The following files were modified during installation:"
+      puts
+      backups.each { |backup| puts "  #{backup}" }
+      puts
+      puts "Each of these files has been backed up with a .bak extension. Please review the changes carefully."
+      puts "If you're happy with the changes, you can delete the .bak files."
+      puts
+    end
+
+    if Rails.root.join(".git").exist?
+      system "git diff > tmp/cable_ready_installer.diff"
+      puts "🏮 A diff of all changes has been saved to \e[1mtmp/cable_ready_installer.diff\e[22m"
+      puts
+    end
+
+    FileUtils.touch(install_complete)
+    `pkill -f spring` if Rails.root.join("tmp/cable_ready_installer/kill_spring").exist?
+    exit
+  end
+
+  namespace :install do
+    desc "Restart CableReady installation"
+    task :restart do
+      FileUtils.rm_rf Rails.root.join("tmp/cable_ready_installer")
+      system "rails cable_ready:install #{ARGV.join(" ")}"
+      exit
+    end
+
+    desc <<~DESC
+      Run specific CableReady install steps
+
+      #{CR_STEPS.sort.map { |step, description| "#{step.ljust(20)} #{description}" }.join("\n")}
+    DESC
+
+    task :step do
+      def warning(step = nil)
+        return if step.to_s.include?("=")
+        if step
+          puts "⚠️ #{step} is not a valid step. Valid steps are: #{CR_STEPS.keys.join(", ")}"
+        else
+          puts "❌ You must specify a step to re-run. Valid steps are: #{CR_STEPS.keys.join(", ")}"
+          puts "Example: \e[1;94mrails cable_ready:install:step initializers\e[0m"
+        end
+      end
+
+      warning if ARGV.empty?
+
+      ARGV.each do |step|
+        CR_STEPS.include?(step) ? run_install_template(step, force: true) : warning(step)
+      end
+
+      run_install_template(:bundle, force: true)
+      run_install_template(:yarn, force: true)
+      exit
+    end
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cable_ready",
-  "version": "4.4.6",
+  "version": "5.0.0",
   "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",
@@ -13,24 +13,53 @@
     "client-side",
     "dom"
   ],
-  "homepage": "https://cableready.stimulusreflex.com/",
-  "bugs": {
-    "url": "https://github.com/hopsoft/cable_ready/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com:hopsoft/cable_ready.git"
-  },
+  "homepage": "https://cableready.stimulusreflex.com",
+  "bugs": "https://github.com/stimulusreflex/cable_ready/issues",
+  "repository": "https://github.com/stimulusreflex/cable_ready",
   "license": "MIT",
   "author": "Nathan Hopkins <natehop@gmail.com>",
-  "main": "./javascript/cable_ready.js",
+  "contributors": [
+    "Andrew Mason <andrewmcodes@protonmail.com>",
+    "Julian Rubisch <julian@julianrubisch.at>",
+    "Marco Roth <marco.roth@intergga.ch>",
+    "Nathan Hopkins <natehop@gmail.com>"
+  ],
+  "main": "./dist/cable_ready.js",
+  "module": "./dist/cable_ready.js",
+  "browser": "./dist/cable_ready.js",
+  "import": "./dist/cable_ready.js",
+  "unpkg": "./dist/cable_ready.umd.js",
+  "umd": "./dist/cable_ready.umd.js",
+  "files": [
+    "dist/*",
+    "javascript/*"
+  ],
   "scripts": {
-    "prettier-standard-check": "yarn run prettier-standard --check ./javascript/**/*.js"
+    "lint": "yarn run format --check",
+    "format": "yarn run prettier-standard ./javascript/**/*.js rollup.config.mjs",
+    "build": "yarn rollup -c",
+    "watch": "yarn rollup -wc",
+    "test": "web-test-runner javascript/test/**/*.test.js",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs && cp ./docs/_redirects ./docs/.vitepress/dist",
+    "docs:preview": "vitepress preview docs"
   },
   "dependencies": {
-    "morphdom": "^2.6.1"
+    "morphdom": "2.6.1"
   },
   "devDependencies": {
-    "prettier-standard": "^16.1.0"
+    "@open-wc/testing": "^3.1.7",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@web/dev-server-esbuild": "^0.3.3",
+    "@web/dev-server-rollup": "^0.3.21",
+    "@web/test-runner": "^0.15.1",
+    "prettier-standard": "^16.4.1",
+    "rollup": "^3.19.1",
+    "sinon": "^15.0.2",
+    "vite": "^4.1.4",
+    "vitepress": "^1.0.0-alpha.56",
+    "vitepress-plugin-search": "^1.0.4-alpha.19"
   }
 }

data/rollup.config.mjs

@@ -0,0 +1,57 @@
+import resolve from '@rollup/plugin-node-resolve'
+import json from '@rollup/plugin-json'
+import terser from '@rollup/plugin-terser'
+
+const pretty = () => {
+  return terser({
+    mangle: false,
+    compress: false,
+    format: {
+      comments: 'all',
+      beautify: true,
+      indent_level: 2
+    }
+  })
+}
+
+const esConfig = {
+  format: 'es',
+  inlineDynamicImports: true
+}
+
+const umdConfig = {
+  name: 'CableReady',
+  format: 'umd',
+  exports: 'named',
+  globals: { morphdom: 'morphdom' }
+}
+
+const baseName = 'cable_ready'
+const distFolders = ['dist', 'app/assets/javascripts']
+
+const output = distFolders
+  .map(distFolder => [
+    {
+      ...esConfig,
+      file: `${distFolder}/${baseName}.js`,
+      plugins: [pretty()]
+    },
+    {
+      ...umdConfig,
+      file: `${distFolder}/${baseName}.umd.js`,
+      plugins: [pretty()]
+    }
+  ])
+  .flat()
+
+export default [
+  {
+    external: ['morphdom'],
+    input: 'javascript/index.js',
+    output,
+    plugins: [resolve(), json()],
+    watch: {
+      include: 'javascript/**'
+    }
+  }
+]

data/web-test-runner.config.mjs

@@ -0,0 +1,12 @@
+import rollupJson from '@rollup/plugin-json'
+import { fromRollup } from '@web/dev-server-rollup'
+
+const json = fromRollup(rollupJson)
+
+export default {
+  nodeResolve: true,
+  mimeTypes: {
+    '**/*.json': 'js'
+  },
+  plugins: [json({})]
+}