stimulus_reflex 3.5.0.pre8 → 3.5.0.pre10

data/lib/tasks/stimulus_reflex/stimulus_reflex.rake

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+include Rails.application.routes.url_helpers
+
+SR_STEPS = {
+  "action_cable" => "Action Cable",
+  "webpacker" => "Install StimulusReflex using Webpacker",
+  "shakapacker" => "Install StimulusReflex using Shakapacker",
+  "npm_packages" => "StimulusReflex and CableReady and related npm packages",
+  "reflexes" => "Create app/reflexes and related files",
+  "importmap" => "Install StimulusReflex using importmaps",
+  "esbuild" => "Install StimulusReflex using esbuild",
+  "config" => "Client initialization",
+  "initializers" => "StimulusReflex and CableReady initializers",
+  "example" => "Create an Example Reflex",
+  "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 available to channels, controllers, jobs and models",
+  "updatable" => "Include CableReady::Updatable in Active Record model classes",
+  "yarn" => "Resolve npm dependency changes",
+  "bundle" => "Resolve gem dependency changes and install configuration changes",
+  "vite" => "Install StimulusReflex using Vite",
+  "compression" => "Compress WebSocket traffic with gzip"
+}
+
+SR_BUNDLERS = {
+  "webpacker" => ["npm_packages", "webpacker", "config", "action_cable", "reflexes", "development", "initializers", "broadcaster", "updatable", "example", "spring", "yarn", "bundle"],
+  "esbuild" => ["npm_packages", "esbuild", "config", "action_cable", "reflexes", "development", "initializers", "broadcaster", "updatable", "example", "spring", "yarn", "bundle"],
+  "vite" => ["npm_packages", "vite", "config", "action_cable", "reflexes", "development", "initializers", "broadcaster", "updatable", "example", "spring", "yarn", "bundle"],
+  "shakapacker" => ["npm_packages", "shakapacker", "config", "action_cable", "reflexes", "development", "initializers", "broadcaster", "updatable", "example", "spring", "yarn", "bundle"],
+  "importmap" => ["config", "action_cable", "importmap", "reflexes", "development", "initializers", "broadcaster", "updatable", "example", "spring", "bundle"]
+}
+
+def run_install_template(template, force: false, trace: false)
+  puts "--- [#{template}] ----"
+
+  if Rails.root.join("tmp/stimulus_reflex_installer/halt").exist?
+    FileUtils.rm(Rails.root.join("tmp/stimulus_reflex_installer/halt"))
+    puts "StimulusReflex installation halted. Please fix the issues above and try again."
+    exit
+  end
+  if Rails.root.join("tmp/stimulus_reflex_installer/#{template}").exist? && !force
+    puts "👍 #{SR_STEPS[template]}"
+    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 :stimulus_reflex do
+  desc "✨ Install StimulusReflex and CableReady ✨"
+  task :install do
+    FileUtils.mkdir_p(Rails.root.join("tmp/stimulus_reflex_installer/templates"))
+    FileUtils.mkdir_p(Rails.root.join("tmp/stimulus_reflex_installer/working"))
+    install_complete = Rails.root.join("tmp/stimulus_reflex_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/stimulus_reflex_installer/options")
+    options_path.write(options.to_yaml)
+
+    if install_complete.exist?
+      puts "✨ \e[38;5;220mStimulusReflex\e[0m and \e[38;5;220mCableReady\e[0m are already installed ✨"
+      puts
+      puts "To restart the installation process, run: \e[38;5;231mrails stimulus_reflex:install:restart\e[0m"
+      puts
+      puts "To get started, check out \e[4;97mhttps://docs.stimulusreflex.com/hello-world/quickstart\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/stimulus_reflex_installer/entrypoint")
+    if cached_entrypoint.exist?
+      entrypoint = File.read(cached_entrypoint)
+      puts "✨ Resuming \e[38;5;220mStimulusReflex\e[0m and \e[38;5;220mCableReady\e[0m installation ✨"
+      puts
+      puts "If you have any setup issues, please consult \e[4;97mhttps://docs.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 stimulus_reflex:install:restart\e[0m to restart the installation process"
+      puts
+    else
+      puts "✨ Installing \e[38;5;220mStimulusReflex\e[0m and \e[38;5;220mCableReady\e[0m ✨"
+      puts
+      puts "If you have any setup issues, please consult \e[4;97mhttps://docs.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 StimulusReflex."
+          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 StimulusReflex."
+        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 "StimulusReflex installation supports: esbuild, webpacker, vite, shakapacker and importmap."
+        puts "Please run \e[1;94mrails stimulus_reflex:install [bundler]\e[0m to install StimulusReflex and CableReady."
+        exit
+      end
+    end
+
+    File.write("tmp/stimulus_reflex_installer/bundler", bundler)
+    FileUtils.touch("tmp/stimulus_reflex_installer/backups")
+    File.write("tmp/stimulus_reflex_installer/template_src", File.expand_path("../../generators/stimulus_reflex/templates/", __dir__))
+
+    `bin/spring stop` if defined?(Spring)
+
+    # do the things
+    SR_BUNDLERS[bundler].each do |template|
+      run_install_template(template, trace: !!options["trace"])
+    end
+
+    puts
+    puts "🎉 \e[1;92mStimulusReflex and CableReady have been successfully installed!\e[22m 🎉"
+    puts
+    puts "👉 \e[4;97mhttps://docs.stimulusreflex.com/hello-world/quickstart\e[0m"
+    puts
+    puts "Join over 2000 StimulusReflex developers on Discord: \e[4;97mhttps://discord.gg/stimulus-reflex\e[0m"
+    puts
+
+    backups = File.readlines("tmp/stimulus_reflex_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/stimulus_reflex_installer.diff"
+      puts "🏮 A diff of all changes has been saved to \e[1mtmp/stimulus_reflex_installer.diff\e[22m"
+      puts
+    end
+
+    if Rails.root.join("app/reflexes/example_reflex.rb").exist?
+      launch = Rails.root.join("bin/dev").exist? ? "bin/dev" : "rails s"
+      puts "🚀 Launch \e[1;94m#{launch}\e[0m to access the example at ⚡ \e[4;97mhttp://localhost:3000/example\e[0m ⚡"
+      puts "Once you're finished with the example, you can remove it with \e[1;94mrails destroy stimulus_reflex example\e[0m"
+      puts
+    end
+
+    FileUtils.touch(install_complete)
+    `pkill -f spring` if Rails.root.join("tmp/stimulus_reflex_installer/kill_spring").exist?
+    exit
+  end
+
+  namespace :install do
+    desc "Restart StimulusReflex and CableReady installation"
+    task :restart do
+      FileUtils.rm_rf Rails.root.join("tmp/stimulus_reflex_installer")
+      system "rails stimulus_reflex:install #{ARGV.join(" ")}"
+      exit
+    end
+
+    desc <<~DESC
+      Run specific StimulusReflex install steps
+
+      #{SR_STEPS.sort.map { |step, description| "#{step.ljust(20)} #{description}" }.join("\n")}
+    DESC
+    task :step do
+      def warning(step = nil, force_exit = true)
+        return if step.to_s.include?("=")
+        if step
+          puts "⚠️  #{step} is not a valid step. Valid steps are: #{SR_STEPS.keys.join(", ")}"
+        else
+          puts "❌ You must specify a step to re-run. Valid steps are: #{SR_STEPS.keys.join(", ")}"
+          puts "Example: \e[1;94mrails stimulus_reflex:install:step initializers\e[0m"
+        end
+        exit if force_exit
+      end
+
+      warning if ARGV.empty?
+
+      ARGV.each do |step|
+        SR_STEPS.include?(step) ? run_install_template(step, force: true) : warning(step, false)
+      end
+
+      run_install_template(:bundle, force: true)
+      run_install_template(:yarn, force: true)
+
+      exit
+    end
+  end
+end

data/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "stimulus_reflex",
+  "version": "3.5.0-pre10",
+  "description": "Build reactive applications with the Rails tooling you already know and love.",
+  "keywords": [
+    "ruby",
+    "rails",
+    "websockets",
+    "actioncable",
+    "turbolinks",
+    "reactive",
+    "cable",
+    "ujs",
+    "ssr",
+    "stimulus",
+    "reflex",
+    "stimulus_reflex",
+    "dom",
+    "morphdom"
+  ],
+  "homepage": "https://docs.stimulusreflex.com",
+  "bugs": "https://github.com/stimulusreflex/stimulus_reflex/issues",
+  "repository": "https://github.com/stimulusreflex/stimulus_reflex",
+  "license": "MIT",
+  "author": "Nathan Hopkins <natehop@gmail.com>",
+  "contributors": [
+    "Andrew Mason <andrewmcodes@protonmail.com>",
+    "Julian Rubisch <julian@julianrubisch.at>",
+    "Marco Roth <marco.roth@intergga.ch>",
+    "Nathan Hopkins <natehop@gmail.com>"
+  ],
+  "main": "./dist/stimulus_reflex.js",
+  "module": "./dist/stimulus_reflex.js",
+  "browser": "./dist/stimulus_reflex.js",
+  "import": "./dist/stimulus_reflex.js",
+  "unpkg": "./dist/stimulus_reflex.umd.js",
+  "umd": "./dist/stimulus_reflex.umd.js",
+  "files": [
+    "dist/*",
+    "javascript/*"
+  ],
+  "scripts": {
+    "lint": "yarn run format --check",
+    "format": "yarn run prettier-standard ./javascript/**/*.js rollup.config.mjs",
+    "build": "yarn rollup -c",
+    "build:watch": "yarn rollup -wc",
+    "watch": "yarn build:watch",
+    "test": "web-test-runner javascript/test/**/*.test.js",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "peerDependencies": {
+    "@hotwired/stimulus": ">= 3.0"
+  },
+  "dependencies": {
+    "@hotwired/stimulus": ">= 3.0, < 4",
+    "@rails/actioncable": ">= 6.0, < 8",
+    "cable_ready": "5.0.0-pre10"
+  },
+  "devDependencies": {
+    "@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.0",
+    "prettier-standard": "^16.4.1",
+    "rollup": "^3.17.1",
+    "vitepress": "^1.0.0-alpha.47"
+  }
+}

data/rollup.config.mjs

@@ -0,0 +1,86 @@
+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: {
+      beautify: true,
+      indent_level: 2
+    }
+  })
+}
+
+const minify = () => {
+  return terser({
+    mangle: true,
+    compress: true
+  })
+}
+
+const esConfig = {
+  format: 'es',
+  inlineDynamicImports: true
+}
+
+const umdConfig = {
+  name: 'StimulusReflex',
+  format: 'umd',
+  exports: 'named',
+  globals: {
+    '@rails/actioncable': 'ActionCable',
+    morphdom: 'morphdom',
+    cable_ready: 'CableReady',
+    '@hotwired/stimulus': 'Stimulus'
+  }
+}
+
+const baseName = 'stimulus_reflex'
+const distFolders = ['dist', 'app/assets/javascripts']
+
+const output = distFolders
+  .map(distFolder => [
+    {
+      ...umdConfig,
+      file: `${distFolder}/${baseName}.umd.js`,
+      plugins: [pretty()]
+    },
+    {
+      ...umdConfig,
+      file: `${distFolder}/${baseName}.umd.min.js`,
+      sourcemap: true,
+      plugins: [pretty()]
+    },
+    {
+      ...esConfig,
+      file: `${distFolder}/${baseName}.js`,
+      format: 'es',
+      plugins: [pretty()]
+    },
+    {
+      ...esConfig,
+      file: `${distFolder}/${baseName}.min.js`,
+      sourcemap: true,
+      plugins: [minify()]
+    }
+  ])
+  .flat()
+
+export default [
+  {
+    external: [
+      'morphdom',
+      '@hotwired/stimulus',
+      'cable_ready',
+      '@rails/actioncable'
+    ],
+    input: 'javascript/index.js',
+    output,
+    plugins: [resolve(), json()],
+    watch: {
+      include: 'javascript/**'
+    }
+  }
+]

data/stimulus_reflex.gemspec

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require File.expand_path("lib/stimulus_reflex/version", __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name = "stimulus_reflex"
+  gem.license = "MIT"
+  gem.version = StimulusReflex::VERSION
+  gem.authors = ["Nathan Hopkins"]
+  gem.email = ["natehop@gmail.com"]
+  gem.homepage = "https://github.com/stimulusreflex/stimulus_reflex"
+  gem.summary = "Build reactive applications with the Rails tooling you already know and love."
+  gem.post_install_message = <<~MESSAGE
+    Finish installation by running:
+
+    rake stimulus_reflex:install
+
+    Get support for StimulusReflex and CableReady on Discord:
+
+    https://discord.gg/stimulus-reflex
+
+  MESSAGE
+
+  gem.metadata = {
+    "bug_tracker_uri" => "https://github.com/stimulusreflex/stimulus_reflex/issues",
+    "changelog_uri" => "https://github.com/stimulusreflex/stimulus_reflex/CHANGELOG.md",
+    "documentation_uri" => "https://docs.stimulusreflex.com",
+    "homepage_uri" => gem.homepage,
+    "source_code_uri" => gem.homepage
+  }
+
+  gem.files = Dir[
+    "lib/**/*.{rb,rake,tt}",
+    "app/**/*.rb",
+    "app/assets/javascripts/*",
+    "bin/*",
+    "[A-Z]*"
+  ]
+
+  gem.required_ruby_version = ">= 2.7.0"
+
+  rails_version = [">= 5.2", "< 8"]
+  gem.add_dependency "actioncable", *rails_version
+  gem.add_dependency "actionpack", *rails_version
+  gem.add_dependency "actionview", *rails_version
+  gem.add_dependency "activesupport", *rails_version
+  gem.add_dependency "railties", *rails_version
+
+  gem.add_dependency "cable_ready", ">= 5.0.0.pre10"
+  gem.add_dependency "nokogiri", "~> 1.0"
+  gem.add_dependency "rack", "~> 2.0"
+  gem.add_dependency "redis", ">= 4.0", "< 6.0"
+
+  gem.add_development_dependency "bundler", "~> 2.0"
+  gem.add_development_dependency "magic_frozen_string_literal", "~> 1.2"
+  gem.add_development_dependency "mocha", "~> 1.13"
+  gem.add_development_dependency "rails", *rails_version
+  gem.add_development_dependency "rake", "~> 13.0"
+  gem.add_development_dependency "standard", "~> 1.24"
+end

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({})]
+}