StimulusReflex 3.5 installer

README.md

@@ -1,18 +1,15 @@
 <p align="center">
-  <img src="https://github.com/stimulusreflex/stimulus_reflex/blob/7dae7694577c6237601afa0a9ab81120c2a1dfb7/assets/stimulus-reflex-logo-with-copy.png" width="360" />
+  <img src="https://github.com/stimulusreflex/stimulus_reflex/blob/main/assets/stimulus-reflex-logo-with-copy.png?raw=1" width="360" />
   <h1 align="center">Welcome to StimulusReflex 👋</h1>
   <p align="center">
     <img src="https://img.shields.io/gem/v/stimulus_reflex.svg?color=red" />
     <img src="https://img.shields.io/npm/v/stimulus_reflex.svg?color=blue" />
     <a href="https://www.npmjs.com/package/stimulus_reflex">
       <img alt="downloads" src="https://img.shields.io/npm/dm/stimulus_reflex.svg?color=blue" target="_blank" />
     </a>
-    <a href="https://github.com/stimulusreflex/stimulus_reflex/blob/main/LICENSE">
+    <a href="https://github.com/stimulusreflex/stimulus_reflex/blob/main/LICENSE.txt">
       <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-brightgreen.svg" target="_blank" />
     </a>
-    <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/" target="_blank">
-      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-2190-brightgreen.svg?style=flat" />
-    </a>
     <a href="https://docs.stimulusreflex.com/" target="_blank">
       <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
     </a>
@@ -27,16 +24,13 @@
       <img alt="JavaScript Code Style" src="https://img.shields.io/badge/JavaScript_Code_Style-prettier_standard-ff69b4.svg" />
     </a>
     <br />
-    <a href="https://www.codacy.com/manual/hopsoft/stimulus_reflex/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=hopsoft/stimulus_reflex&amp;utm_campaign=Badge_Grade" target="_blank">
-      <img alt="Code Quality" src="https://app.codacy.com/project/badge/Grade/d1d72a7060f5467b8696884351cf477f"/>
-    </a>
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/workflows/Prettier-Standard/badge.svg">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/actions/workflows/prettier-standard.yml">
       <img src="https://github.com/stimulusreflex/stimulus_reflex/workflows/Prettier-Standard/badge.svg" alt="Prettier-Standard" style="max-width:100%;">
     </a>
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/workflows/StandardRB/badge.svg">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/actions/workflows/standardrb.yml">
       <img src="https://github.com/stimulusreflex/stimulus_reflex/workflows/StandardRB/badge.svg" alt="StandardRB" style="max-width:100%;">
     </a>
-    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/workflows/Tests/badge.svg">
+    <a target="_blank" rel="noopener noreferrer" href="https://github.com/stimulusreflex/stimulus_reflex/actions/workflows/tests.yml">
       <img src="https://github.com/stimulusreflex/stimulus_reflex/workflows/Tests/badge.svg" alt="Tests">
     </a>
   </p>
@@ -72,7 +66,7 @@ This project strives to live up to the vision outlined in [The Rails Doctrine](h
 - [Build a Twitter Clone in 10 Minutes](https://youtu.be/F5hA79vKE_E) (video)
 - [BeastMode](https://beastmode.leastbad.com/) - faceted search, with filtering, sorting and pagination
 - [StimulusReflex Patterns](https://www.stimulusreflexpatterns.com/patterns/) - single-file SR apps hosted on Glitch
-- [BoxDrop](https://dropbox-clone-rails.herokuapp.com/) - a Dropbox-inspired [concept demo](https://github.com/marcoroth/boxdrop/)
+- [Boxdrop](https://www.boxdrop.io) - a Dropbox-inspired [concept demo](https://github.com/marcoroth/boxdrop/)
 
 ## 👩‍👩‍👧 Discord Community
 
@@ -84,7 +78,7 @@ Stop by #newcomers and introduce yourselves!
 
 ## 💙 Support
 
-Your best bet is to ask for help on Discord before filing an issue on Github. We are happy to help, and we ask people who need help to come with all relevant code to look at. A git repo is preferred, but Gists are fine, too. If you need an MVCE template, try [this](https://github.com/leastbad/stimulus_reflex_harness).
+Your best bet is to ask for help on Discord before filing an issue on GitHub. We are happy to help, and we ask people who need help to come with all relevant code to look at. A git repo is preferred, but Gists are fine, too. If you need a template for reproducing your issue, try [this](https://github.com/leastbad/stimulus_reflex_harness).
 
 Please note that we are not actively providing support on Stack Overflow. If you post there, we likely won't see it.
 

lib/generators/stimulus_reflex/stimulus_reflex_generator.rb

@@ -1,27 +1,92 @@
 # frozen_string_literal: true
 
 require "rails/generators"
+require "stimulus_reflex/version"
 
 class StimulusReflexGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("templates", __dir__)
 
   argument :name, type: :string, required: true, banner: "NAME"
   argument :actions, type: :array, default: [], banner: "action action"
-  class_options skip_stimulus: false, skip_app_reflex: false, skip_reflex: false, skip_app_controller: false
+  class_options skip_stimulus: false, skip_reflex: false
 
   def execute
     actions.map!(&:underscore)
 
-    copy_application_files if behavior == :invoke
+    cached_entrypoint = Rails.root.join("tmp/stimulus_reflex_installer/entrypoint")
+    if cached_entrypoint.exist?
+      entrypoint = File.read(cached_entrypoint)
+    else
+      entrypoint = [
+        Rails.root.join("app/javascript"),
+        Rails.root.join("app/frontend")
+      ].find(&:exist?) || "app/javascript"
+      puts "Where do JavaScript files live in your app? Our best guess is: \e[1#{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?
+    end
 
-    template "app/reflexes/%file_name%_reflex.rb" unless options[:skip_reflex]
-    template "app/javascript/controllers/%file_name%_controller.js" unless options[:skip_stimulus]
+    if !options[:skip_stimulus] && entrypoint.blank?
+      puts "❌ You must specify a valid JavaScript entrypoint."
+      exit
+    end
+
+    reflex_entrypoint = Rails.env.test? ? "tmp/app/reflexes" : "app/reflexes"
+    reflex_src = fetch("/app/reflexes/%file_name%_reflex.rb.tt")
+    reflex_path = Rails.root.join(reflex_entrypoint, "#{file_name}_reflex.rb")
+    stimulus_controller_src = fetch("/app/javascript/controllers/%file_name%_controller.js.tt")
+    stimulus_controller_path = Rails.root.join(entrypoint, "controllers/#{file_name}_controller.js")
+
+    template(reflex_src, reflex_path) unless options[:skip_reflex]
+    template(stimulus_controller_src, stimulus_controller_path) unless options[:skip_stimulus]
+
+    if file_name == "example"
+      controller_src = fetch("/app/controllers/examples_controller.rb.tt")
+      controller_path = Rails.root.join("app/controllers/examples_controller.rb")
+      template(controller_src, controller_path)
+
+      view_src = fetch("/app/views/examples/show.html.erb.tt")
+      view_path = Rails.root.join("app/views/examples/show.html.erb")
+      template(view_src, view_path)
+
+      example_path = Rails.root.join("app/views/examples")
+      FileUtils.remove_dir(example_path) if behavior == :revoke && example_path.exist? && Dir.empty?(example_path)
+
+      route "resource :example, constraints: -> { Rails.env.development? }"
+
+      importmap_path = Rails.root.join("config/importmap.rb")
+
+      if importmap_path.exist?
+        importmap = importmap_path.read
+
+        if behavior == :revoke
+          if importmap.include?("pin \"fireworks-js\"")
+            importmap_path.write importmap_path.readlines.reject { |line| line.include?("pin \"fireworks-js\"") }.join
+            say "✅ unpin fireworks-js"
+          else
+            say "⏩ fireworks-js not pinned. Skipping."
+          end
+        end
+
+        if behavior == :invoke
+          if importmap.include?("pin \"fireworks-js\"")
+            say "⏩ fireworks-js already pinnned. Skipping."
+          else
+            append_file(importmap_path, <<~RUBY, verbose: false)
+              pin "fireworks-js", to: "https://ga.jspm.io/npm:fireworks-js@2.10.0/dist/index.es.js"
+            RUBY
+            say "✅ pin fireworks-js"
+          end
+        end
+      end
+    end
   end
 
   private
 
-  def copy_application_files
-    template "app/reflexes/application_reflex.rb" unless options[:skip_app_reflex]
-    template "app/javascript/controllers/application_controller.js" unless options[:skip_app_controller]
+  def fetch(file)
+    source_paths.first + file
   end
 end

lib/generators/stimulus_reflex/templates/app/controllers/examples_controller.rb.tt

@@ -0,0 +1,9 @@
+class ExamplesController < ApplicationController
+  layout false
+
+  def show
+    respond_to do |format|
+      format.html
+    end
+  end
+end

lib/generators/stimulus_reflex/templates/app/javascript/channels/consumer.js.tt

@@ -0,0 +1,6 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `bin/rails generate channel` command.
+
+import { createConsumer } from '@rails/actioncable'
+
+export default createConsumer()

lib/generators/stimulus_reflex/templates/app/javascript/channels/index.js.esbuild.tt

@@ -0,0 +1,4 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+import './**/*_channel.js'

lib/generators/stimulus_reflex/templates/app/javascript/channels/index.js.importmap.tt

@@ -0,0 +1,2 @@
+// app/channels/index.js
+// Importmaps don't require anything here

lib/generators/stimulus_reflex/templates/app/javascript/channels/index.js.shakapacker.tt

@@ -0,0 +1,5 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+const channels = require.context('.', true, /_channel\.js$/)
+channels.keys().forEach(channels)

lib/generators/stimulus_reflex/templates/app/javascript/channels/index.js.vite.tt

@@ -0,0 +1 @@
+const channels = import.meta.globEager('./**/*_channel.js')

lib/generators/stimulus_reflex/templates/app/javascript/channels/index.js.webpacker.tt

@@ -0,0 +1,5 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+const channels = require.context('.', true, /_channel\.js$/)
+channels.keys().forEach(channels)

lib/generators/stimulus_reflex/templates/app/javascript/config/cable_ready.js.tt

@@ -0,0 +1,4 @@
+import consumer from '../channels/consumer'
+import CableReady from 'cable_ready'
+
+CableReady.initialize({ consumer })

lib/generators/stimulus_reflex/templates/app/javascript/config/index.js.tt

@@ -0,0 +1,2 @@
+import './cable_ready'
+import './stimulus_reflex'

lib/generators/stimulus_reflex/templates/app/javascript/config/mrujs.js.tt

@@ -0,0 +1,9 @@
+import CableReady from "cable_ready"
+import mrujs from "mrujs"
+import { CableCar } from "mrujs/plugins"
+
+mrujs.start({
+  plugins: [
+    new CableCar(CableReady)
+  ]
+})

lib/generators/stimulus_reflex/templates/app/javascript/config/stimulus_reflex.js.tt

@@ -0,0 +1,5 @@
+import { application } from "../controllers/application"
+import controller from "../controllers/application_controller"
+import StimulusReflex from "stimulus_reflex"
+
+StimulusReflex.initialize(application, { controller, isolate: true })