stimulus_reflex 3.4.0 → 3.5.0.pre2

data/lib/stimulus_reflex/utils/sanity_checker.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+class StimulusReflex::SanityChecker
+  LATEST_VERSION_FORMAT = /^(\d+\.\d+\.\d+)$/
+  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
+  JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
+
+  class << self
+    def check!
+      return if ENV["SKIP_SANITY_CHECK"]
+      return if StimulusReflex.config.on_failed_sanity_checks == :ignore
+      return if called_by_installer?
+      return if called_by_generate_config?
+      return if called_by_rake?
+
+      instance = new
+      instance.check_caching_enabled
+      instance.check_package_versions_match
+      # instance.check_default_url_config
+      instance.check_new_version_available
+    end
+
+    private
+
+    def called_by_installer?
+      Rake.application.top_level_tasks.include? "stimulus_reflex:install"
+    rescue
+      false
+    end
+
+    def called_by_generate_config?
+      ARGV.include? "stimulus_reflex:initializer"
+    end
+
+    def called_by_rake?
+      File.basename($PROGRAM_NAME) == "rake"
+    end
+  end
+
+  def check_caching_enabled
+    if caching_not_enabled?
+      warn_and_exit <<~WARN
+        👉 StimulusReflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
+
+        To enable caching in development, run:
+
+          rails dev:cache
+      WARN
+    end
+
+    if using_null_store?
+      warn_and_exit <<~WARN
+        👉 StimulusReflex requires caching to be enabled.
+        
+        Caching allows the session to be modified during ActionCable requests. Your config.cache_store is set to :null_store, so it won't work.
+      WARN
+    end
+  end
+
+  def check_default_url_config
+    return if StimulusReflex.config.on_missing_default_urls == :ignore
+    if default_url_config_set? == false
+      puts <<~WARN
+        👉 StimulusReflex strongly suggests that you set default_url_options in your environment files. Otherwise, ActionController #{"and ActionMailer " if defined?(ActionMailer)}will default to example.com when rendering route helpers.
+
+        You can set your URL options in config/environments/#{Rails.env}.rb
+
+          config.action_controller.default_url_options = {host: "localhost", port: 3000}
+          #{"config.action_mailer.default_url_options = {host: \"localhost\", port: 3000}\n" if defined?(ActionMailer)}
+        Please update every environment with the appropriate URL. Typically, no port is necessary in production.
+
+      WARN
+    end
+  end
+
+  def check_package_versions_match
+    if npm_version.nil?
+      warn_and_exit <<~WARN
+        👉 Can't locate the stimulus_reflex npm package.
+
+          yarn add stimulus_reflex@#{gem_version}
+
+        Either add it to your package.json as a dependency or use "yarn link stimulus_reflex" if you are doing development.
+      WARN
+    end
+
+    if package_version_mismatch?
+      warn_and_exit <<~WARN
+        👉 The stimulus_reflex npm package version (#{npm_version}) does not match the Rubygem version (#{gem_version}).
+
+        To update the stimulus_reflex npm package:
+
+          yarn upgrade stimulus_reflex@#{gem_version}
+      WARN
+    end
+  end
+
+  def check_new_version_available
+    return if StimulusReflex.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/stimulus_reflex/master/LATEST", open_timeout: 1, read_timeout: 1).read.strip
+      if latest_version != StimulusReflex::VERSION
+        puts <<~WARN
+
+          👉 There is a new version of StimulusReflex available!
+          Current: #{StimulusReflex::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 StimulusReflex.config.on_new_version_available == :exit
+      end
+    rescue
+      puts "👉 StimulusReflex #{StimulusReflex::VERSION} update check skipped: connection timeout"
+    end
+  end
+
+  def caching_not_enabled?
+    Rails.application.config.action_controller.perform_caching == false
+  end
+
+  def using_null_store?
+    Rails.application.config.cache_store == :null_store
+  end
+
+  def default_url_config_set?
+    if defined?(ActionMailer)
+      Rails.application.config.action_controller.default_url_options.blank? && Rails.application.config.action_mailer.default_url_options.blank?
+    else
+      Rails.application.config.action_controller.default_url_options.blank?
+    end
+  end
+
+  def package_version_mismatch?
+    npm_version != gem_version
+  end
+
+  def using_preview_release?
+    preview = StimulusReflex::VERSION.match?(LATEST_VERSION_FORMAT) == false
+    puts "👉 StimulusReflex #{StimulusReflex::VERSION} update check skipped: pre-release build" if preview
+    preview
+  end
+
+  def gem_version
+    @_gem_version ||= StimulusReflex::VERSION.gsub(".pre", "-pre")
+  end
+
+  def npm_version
+    @_npm_version ||= find_npm_version
+  end
+
+  def find_npm_version
+    if (match = search_file(package_json_path, regex: /version/))
+      match[JSON_VERSION_FORMAT, 1]
+    elsif (match = search_file(yarn_lock_path, regex: /^stimulus_reflex/))
+      match[NODE_VERSION_FORMAT, 1]
+    end
+  end
+
+  def search_file(path, regex:)
+    return if File.exist?(path) == false
+    File.foreach(path).grep(regex).first
+  end
+
+  def package_json_path
+    Rails.root.join("node_modules", "stimulus_reflex", "package.json")
+  end
+
+  def yarn_lock_path
+    Rails.root.join("yarn.lock")
+  end
+
+  def initializer_missing?
+    File.exist?(Rails.root.join("config", "initializers", "stimulus_reflex.rb")) == false
+  end
+
+  def warn_and_exit(text)
+    puts
+    puts "Heads up! 🔥"
+    puts
+    puts text
+    puts
+    if StimulusReflex.config.on_failed_sanity_checks == :exit
+      puts <<~INFO
+        To ignore any warnings and start the application anyway, you can set the SKIP_SANITY_CHECK environment variable:
+
+          SKIP_SANITY_CHECK=true rails
+
+        To do this permanently, add the following directive to the StimulusReflex initializer:
+
+          StimulusReflex.configure do |config|
+            config.on_failed_sanity_checks = :warn
+          end
+
+      INFO
+      if initializer_missing?
+        puts <<~INFO
+          You can create a StimulusReflex initializer with the command:
+
+            bundle exec rails generate stimulus_reflex:initializer
+
+        INFO
+      end
+      exit false if Rails.env.test? == false
+    end
+  end
+end

data/lib/stimulus_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusReflex
-  VERSION = "3.4.0"
+  VERSION = "3.5.0.pre2"
 end

data/lib/tasks/stimulus_reflex/install.rake

@@ -4,7 +4,7 @@ require "fileutils"
 require "stimulus_reflex/version"
 
 namespace :stimulus_reflex do
-  desc "Install StimulusReflex in this application"
+  desc "✨ Install StimulusReflex in this application"
   task install: :environment do
     system "rails dev:cache" unless Rails.root.join("tmp", "caching-dev.txt").exist?
     gem_version = StimulusReflex::VERSION.gsub(".pre", "-pre")
@@ -25,8 +25,8 @@ namespace :stimulus_reflex do
       .map { |path| Rails.root.join(path) }
       .first
 
-    puts "Updating #{filepath}"
-    lines = File.open(filepath, "r") { |f| f.readlines }
+    puts "✨ Updating #{filepath}"
+    lines = File.readlines(filepath)
 
     unless lines.find { |line| line.start_with?("import StimulusReflex") }
       matches = lines.select { |line| line =~ /\A(require|import)/ }
@@ -44,34 +44,73 @@ namespace :stimulus_reflex do
     end
 
     initialize_line = lines.find { |line| line.start_with?("StimulusReflex.initialize") }
-    lines << "StimulusReflex.initialize(application, { consumer, controller, isolate: true })\n" unless initialize_line
+    lines << "application.consumer = consumer\n"
+    lines << "StimulusReflex.initialize(application, { controller, isolate: true })\n" unless initialize_line
     lines << "StimulusReflex.debug = process.env.RAILS_ENV === 'development'\n" unless initialize_line
-    File.open(filepath, "w") { |f| f.write lines.join }
+    File.write(filepath, lines.join)
 
+    puts
+    puts "✨ Updating config/environments/development.rb"
     filepath = Rails.root.join("config/environments/development.rb")
-    lines = File.open(filepath, "r") { |f| f.readlines }
+    lines = File.readlines(filepath)
     unless lines.find { |line| line.include?("config.session_store") }
-      lines.insert 3, "  config.session_store :cache_store\n\n"
-      File.open(filepath, "w") { |f| f.write lines.join }
+      matches = lines.select { |line| line =~ /\A(Rails.application.configure do)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "  config.session_store :cache_store\n\n"
+      puts
+      puts "✨ Using :cache_store for session storage. We recommend switching to Redis for cache and session storage."
+      puts
+      puts "https://docs.stimulusreflex.com/appendices/deployment#use-redis-as-your-cache-store"
+      File.write(filepath, lines.join)
+    end
+
+    if defined?(ActionMailer)
+      lines = File.readlines(filepath)
+      unless lines.find { |line| line.include?("config.action_mailer.default_url_options") }
+        matches = lines.select { |line| line =~ /\A(Rails.application.configure do)/ }
+        lines.insert lines.index(matches.last).to_i + 1, "  config.action_mailer.default_url_options = {host: \"localhost\", port: 3000}\n\n"
+        File.write(filepath, lines.join)
+      end
     end
 
+    lines = File.readlines(filepath)
+    unless lines.find { |line| line.include?("config.action_controller.default_url_options") }
+      matches = lines.select { |line| line =~ /\A(Rails.application.configure do)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "  config.action_controller.default_url_options = {host: \"localhost\", port: 3000}\n"
+      File.write(filepath, lines.join)
+    end
+
+    puts
+    puts "✨ Updating config/cable.yml to use Redis in development"
     filepath = Rails.root.join("config/cable.yml")
-    lines = File.open(filepath, "r") { |f| f.readlines }
+    lines = File.readlines(filepath)
     if lines[1].include?("adapter: async")
       lines.delete_at 1
       lines.insert 1, "  adapter: redis\n"
       lines.insert 2, "  url: <%= ENV.fetch(\"REDIS_URL\") { \"redis://localhost:6379/1\" } %>\n"
-      lines.insert 3, "  channel_prefix: " + File.basename(Rails.root.to_s).underscore + "_development\n"
-      File.open(filepath, "w") { |f| f.write lines.join }
+      lines.insert 3, "  channel_prefix: " + File.basename(Rails.root.to_s).tr("\\", "").tr("-. ", "_").underscore + "_development\n"
+      File.write(filepath, lines.join)
     end
 
+    puts
+    puts "✨ Generating default StimulusReflex and CableReady configuration files"
+    puts
+    system "bundle exec rails generate stimulus_reflex:initializer"
+    system "bundle exec rails generate cable_ready:initializer"
+    system "bundle exec rails generate cable_ready:stream_from"
+
+    puts
+    puts "✨ Generating ApplicationReflex class and Stimulus controllers, plus an example Reflex class and controller"
+    puts
     system "bundle exec rails generate stimulus_reflex example"
-    puts "Generating default StimulusReflex configuration file into your application config/initializers directory"
-    system "bundle exec rails generate stimulus_reflex:config"
 
     puts
-    puts "StimulusReflex and CableReady have been successfully installed!"
-    puts "Go to https://docs.stimulusreflex.com/quickstart if you need help getting started."
+    puts "🎉 StimulusReflex and CableReady have been successfully installed! 🎉"
+    puts
+    puts "https://docs.stimulusreflex.com/hello-world/quickstart"
+    puts
+    puts "😊 The fastest way to get support is to say hello on Discord:"
+    puts
+    puts "https://discord.gg/stimulus-reflex"
     puts
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stimulus_reflex",
-  "version": "3.4.0-pre9",
+  "version": "3.5.0-pre1",
   "description": "Build reactive applications with the Rails tooling you already know and love.",
   "keywords": [
     "ruby",
@@ -20,28 +20,28 @@
   ],
   "homepage": "https://docs.stimulusreflex.com/",
   "bugs": {
-    "url": "https://github.com/hopsoft/stimulus_reflex/issues"
+    "url": "https://github.com/stimulusreflex/stimulus_reflex/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com:hopsoft/stimulus_reflex.git"
+    "url": "git+https://github.com:stimulusreflex/stimulus_reflex.git"
   },
   "license": "MIT",
   "author": "Nathan Hopkins <natehop@gmail.com>",
+  "sideEffects": false,
   "main": "./javascript/stimulus_reflex.js",
   "module": "./javascript/stimulus_reflex.js",
   "scripts": {
-    "postinstall": "node ./javascript/scripts/post_install.js",
     "prettier-standard:check": "yarn run prettier-standard --check ./javascript/*.js ./javascript/**/*.js",
     "prettier-standard:format": "yarn run prettier-standard ./javascript/*.js ./javascript/**/*.js",
-    "test": "yarn run mocha --require @babel/register --require esm ./javascript/test"
+    "test": "yarn run mocha --require @babel/register --require jsdom-global/register --require esm ./javascript/test"
   },
   "peerDependencies": {
     "stimulus": ">= 1.1"
   },
   "dependencies": {
     "@rails/actioncable": ">= 6.0",
-    "cable_ready": ">= 4.4"
+    "cable_ready": "5.0.0-pre2"
   },
   "devDependencies": {
     "@babel/core": "^7.6.2",
@@ -50,6 +50,7 @@
     "assert": "^2.0.0",
     "esm": "^3.2.25",
     "jsdom": "^16.0.1",
+    "jsdom-global": "^3.0.2",
     "mocha": "^8.0.1",
     "prettier-standard": "^16.1.0",
     "stimulus": ">= 1.1"

data/stimulus_reflex.gemspec

@@ -8,18 +8,18 @@ Gem::Specification.new do |gem|
   gem.version = StimulusReflex::VERSION
   gem.authors = ["Nathan Hopkins"]
   gem.email = ["natehop@gmail.com"]
-  gem.homepage = "https://github.com/hopsoft/stimulus_reflex"
+  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
-    Friendly reminder: When updating the stimulus_reflex gem,
-    don't forget to update your npm package as well.
+    Get support for StimulusReflex and CableReady on Discord:
+
+    https://discord.gg/stimulus-reflex
 
-    See https://www.npmjs.com/package/stimulus_reflex
   MESSAGE
 
   gem.metadata = {
-    "bug_tracker_uri" => "https://github.com/hopsoft/stimulus_reflex/issues",
-    "changelog_uri" => "https://github.com/hopsoft/stimulus_reflex/CHANGELOG.md",
+    "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
@@ -32,11 +32,11 @@ Gem::Specification.new do |gem|
   gem.add_dependency "nokogiri"
   gem.add_dependency "rails", ">= 5.2"
   gem.add_dependency "redis"
-  gem.add_dependency "cable_ready", ">= 4.4"
+  gem.add_dependency "cable_ready", "5.0.0.pre2"
 
   gem.add_development_dependency "bundler", "~> 2.0"
   gem.add_development_dependency "pry-nav"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "standardrb"
+  gem.add_development_dependency "standardrb", "~> 1.0"
 end

data/test/broadcasters/broadcaster_test_case.rb

@@ -10,6 +10,6 @@ class StimulusReflex::BroadcasterTestCase < ActionCable::Channel::TestCase
     def connection.env
       @env ||= {}
     end
-    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com")
+    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com", client_attributes: {reflex_id: "666"})
   end
 end

data/test/broadcasters/nothing_broadcaster_test.rb

@@ -13,7 +13,8 @@ class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCa
           {
             "name" => "stimulus-reflex:server-message",
             "detail" => {
-              "reflexId" => nil,
+              "reflexId" => "666",
+              "payload" => {},
               "stimulusReflex" => {
                 "some" => :data,
                 "morph" => :nothing,
@@ -22,14 +23,15 @@ class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCa
                   "body" => nil
                 }
               }
-            }
+            },
+            "reflexId" => "666"
           }
         ]
       }
     }
 
     assert_broadcast_on @reflex.stream_name, expected do
-      broadcaster.broadcast nil, some: :data
+      broadcaster.broadcast nil, {:some => :data, "reflexId" => "666"}
     end
   end
 end