stimulus_reflex 3.3.0.pre1 → 3.3.0.pre6

data/lib/stimulus_reflex/sanity_checker.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+class StimulusReflex::SanityChecker
+  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
+  JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
+
+  def self.check!
+    instance = new
+    instance.check_caching_enabled
+    instance.check_javascript_package_version
+  end
+
+  def check_caching_enabled
+    unless caching_enabled?
+      puts <<~WARN
+        WARNING: Stimulus Reflex 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
+  end
+
+  def check_javascript_package_version
+    if javascript_package_version.nil?
+      puts <<~WARN
+        WARNING: Can't locate the stimulus_reflex NPM package.
+        Either add it to your package.json as a dependency or use "yarn link stimulus_reflex" if you are doing development.
+      WARN
+    end
+
+    unless javascript_version_matches?
+      puts <<~WARN
+        WARNING: The Stimulus Reflex javascript package version (#{javascript_package_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
+
+  private
+
+  def caching_enabled?
+    Rails.application.config.action_controller.perform_caching &&
+      Rails.application.config.cache_store != :null_store
+  end
+
+  def javascript_version_matches?
+    javascript_package_version == gem_version
+  end
+
+  def gem_version
+    @_gem_version ||= StimulusReflex::VERSION.gsub(".pre", "-pre")
+  end
+
+  def javascript_package_version
+    return @_js_version if defined?(@_js_version)
+    @_js_version = find_javascript_package_version
+  end
+
+  def find_javascript_package_version
+    if (match = search_file(yarn_lock_path, regex: /^stimulus_reflex/))
+      match[NODE_VERSION_FORMAT, 1]
+    elsif (match = search_file(yarn_link_path, regex: /version/))
+      match[JSON_VERSION_FORMAT, 1]
+    end
+  end
+
+  def search_file(path, regex:)
+    return unless File.exist?(path)
+    File.foreach(path).grep(regex).first
+  end
+
+  def yarn_lock_path
+    Rails.root.join("yarn.lock")
+  end
+
+  def yarn_link_path
+    Rails.root.join("node_modules", "stimulus_reflex", "package.json")
+  end
+end

data/lib/stimulus_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusReflex
-  VERSION = "3.3.0.pre1"
+  VERSION = "3.3.0.pre6"
 end

data/lib/tasks/stimulus_reflex/install.rake

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require "stimulus_reflex/version"
 
 namespace :stimulus_reflex do
   desc "Install StimulusReflex in this application"
   task install: :environment do
     system "bundle exec rails webpacker:install:stimulus"
-    system "yarn add stimulus_reflex"
+    gem_version = StimulusReflex::VERSION.gsub(".pre", "-pre")
+    system "yarn add stimulus_reflex@#{gem_version}"
 
     FileUtils.mkdir_p Rails.root.join("app/javascript/controllers"), verbose: true
     FileUtils.mkdir_p Rails.root.join("app/reflexes"), verbose: true
@@ -50,6 +52,16 @@ namespace :stimulus_reflex do
       File.open(filepath, "w") { |f| f.write lines.join }
     end
 
+    filepath = Rails.root.join("config/cable.yml")
+    lines = File.open(filepath, "r") { |f| f.readlines }
+    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: " + Rails.application.class.module_parent.to_s.underscore + "_development\n"
+      File.open(filepath, "w") { |f| f.write lines.join }
+    end
+
     system "bundle exec rails generate stimulus_reflex example"
     system "rails dev:cache" unless Rails.root.join("tmp", "caching-dev.txt").exist?
   end

data/test/generators/stimulus_reflex_generator_test.rb

@@ -11,7 +11,7 @@ class StimulusReflexGeneratorTest < Rails::Generators::TestCase
   test "creates singular named controller and reflex files" do
     run_generator %w[demo]
     assert_file "app/javascript/controllers/application_controller.js"
-    assert_file "app/javascript/controllers/demo_controller.js", /DemoReflex/
+    assert_file "app/javascript/controllers/demo_controller.js", /Demo/
     assert_file "app/reflexes/application_reflex.rb"
     assert_file "app/reflexes/demo_reflex.rb", /DemoReflex/
   end
@@ -19,7 +19,7 @@ class StimulusReflexGeneratorTest < Rails::Generators::TestCase
   test "creates plural named controller and reflex files" do
     run_generator %w[posts]
     assert_file "app/javascript/controllers/application_controller.js"
-    assert_file "app/javascript/controllers/posts_controller.js", /PostsReflex/
+    assert_file "app/javascript/controllers/posts_controller.js", /Posts/
     assert_file "app/reflexes/application_reflex.rb"
     assert_file "app/reflexes/posts_reflex.rb", /PostsReflex/
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex
 version: !ruby/object:Gem::Version
-  version: 3.3.0.pre1
+  version: 3.3.0.pre6
 platform: ruby
 authors:
 - Nathan Hopkins
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - natehop@gmail.com
 executables: []
@@ -162,22 +176,18 @@ files:
 - lib/generators/templates/app/reflexes/%file_name%_reflex.rb.tt
 - lib/generators/templates/app/reflexes/application_reflex.rb.tt
 - lib/stimulus_reflex.rb
-- lib/stimulus_reflex/broadcaster.rb
+- lib/stimulus_reflex/broadcasters/broadcaster.rb
+- lib/stimulus_reflex/broadcasters/nothing_broadcaster.rb
+- lib/stimulus_reflex/broadcasters/page_broadcaster.rb
+- lib/stimulus_reflex/broadcasters/selector_broadcaster.rb
 - lib/stimulus_reflex/channel.rb
 - lib/stimulus_reflex/element.rb
-- lib/stimulus_reflex/morph_mode.rb
-- lib/stimulus_reflex/morph_mode/nothing_morph_mode.rb
-- lib/stimulus_reflex/morph_mode/page_morph_mode.rb
-- lib/stimulus_reflex/morph_mode/selector_morph_mode.rb
 - lib/stimulus_reflex/reflex.rb
+- lib/stimulus_reflex/sanity_checker.rb
 - lib/stimulus_reflex/version.rb
 - lib/tasks/stimulus_reflex/install.rake
-- stimulus_reflex.gemspec
-- tags
 - test/generators/stimulus_reflex_generator_test.rb
 - test/test_helper.rb
-- test/tmp/app/reflexes/application_reflex.rb
-- test/tmp/app/reflexes/demo_reflex.rb
 homepage: https://github.com/hopsoft/stimulus_reflex
 licenses:
 - MIT
@@ -206,12 +216,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.6
+signing_key: 
 specification_version: 4
 summary: Build reactive applications with the Rails tooling you already know and love.
 test_files:
-- test/test_helper.rb
 - test/generators/stimulus_reflex_generator_test.rb
-- test/tmp/app/reflexes/demo_reflex.rb
-- test/tmp/app/reflexes/application_reflex.rb
+- test/test_helper.rb

data/lib/stimulus_reflex/broadcaster.rb

@@ -1,53 +0,0 @@
-module StimulusReflex
-  module Broadcaster
-    include CableReady::Broadcaster
-
-    def render_page_and_broadcast_morph(reflex, selectors, data = {})
-      html = render_page(reflex)
-      broadcast_morphs selectors, data, html if html.present?
-    end
-
-    def render_page(reflex)
-      reflex.controller.process reflex.url_params[:action]
-      reflex.controller.response.body
-    end
-
-    def broadcast_morphs(selectors, data, html)
-      document = Nokogiri::HTML(html)
-      selectors = selectors.select { |s| document.css(s).present? }
-      selectors.each do |selector|
-        cable_ready[stream_name].morph(
-          selector: selector,
-          html: document.css(selector).inner_html,
-          children_only: true,
-          permanent_attribute_name: data["permanent_attribute_name"],
-          stimulus_reflex: data.merge({
-            last: selector == selectors.last,
-            morph_mode: "page"
-          })
-        )
-      end
-      cable_ready.broadcast
-    end
-
-    def broadcast_message(subject:, body: nil, data: {})
-      message = {
-        subject: subject,
-        body: body
-      }
-
-      logger.error "\e[31m#{body}\e[0m" if subject == "error"
-
-      data[:morph_mode] = "page"
-      data[:server_message] = message
-      data[:morph_mode] = "selector" if subject == "selector"
-      data[:morph_mode] = "nothing" if subject == "nothing"
-
-      cable_ready[stream_name].dispatch_event(
-        name: "stimulus-reflex:server-message",
-        detail: {stimulus_reflex: data}
-      )
-      cable_ready.broadcast
-    end
-  end
-end

data/lib/stimulus_reflex/morph_mode.rb

@@ -1,19 +0,0 @@
-module StimulusReflex
-  class MorphMode
-    include StimulusReflex::Broadcaster
-
-    attr_accessor :stream_name
-
-    def page?
-      false
-    end
-
-    def nothing?
-      false
-    end
-
-    def selector?
-      false
-    end
-  end
-end

data/lib/stimulus_reflex/morph_mode/page_morph_mode.rb

@@ -1,15 +0,0 @@
-module StimulusReflex
-  class PageMorphMode < MorphMode
-    def broadcast(reflex, selectors, data)
-      render_page_and_broadcast_morph reflex, selectors, data
-    end
-
-    def to_sym
-      :page
-    end
-
-    def page?
-      true
-    end
-  end
-end

data/lib/stimulus_reflex/morph_mode/selector_morph_mode.rb

@@ -1,15 +0,0 @@
-module StimulusReflex
-  class SelectorMorphMode < MorphMode
-    def broadcast(reflex, selectors, data)
-      broadcast_message subject: "selector", data: data
-    end
-
-    def to_sym
-      :selector
-    end
-
-    def selector?
-      true
-    end
-  end
-end

data/stimulus_reflex.gemspec

@@ -1,39 +0,0 @@
-require File.expand_path("../lib/stimulus_reflex/version", __FILE__)
-
-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/hopsoft/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.
-
-    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",
-    "documentation_uri" => "https://docs.stimulusreflex.com",
-    "homepage_uri" => gem.homepage,
-    "source_code_uri" => gem.homepage
-  }
-
-  gem.files = Dir["lib/**/*", "bin/*", "[A-Z]*"]
-  gem.test_files = Dir["test/**/*.rb"]
-
-  gem.add_dependency "rack"
-  gem.add_dependency "nokogiri"
-  gem.add_dependency "rails", ">= 5.2"
-  gem.add_dependency "cable_ready", ">= 4.1.2"
-
-  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"
-end

data/tags

@@ -1,42 +0,0 @@
-!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
-!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
-!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
-!_TAG_PROGRAM_NAME	Exuberant Ctags	//
-!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
-!_TAG_PROGRAM_VERSION	5.8	//
-ApplicationReflex	lib/generators/templates/application_reflex.rb	/^class ApplicationReflex < StimulusReflex::Reflex$/;"	c
-ApplicationReflex	test/tmp/app/reflexes/application_reflex.rb	/^class ApplicationReflex < StimulusReflex::Reflex$/;"	c
-DemoReflex	test/tmp/app/reflexes/demo_reflex.rb	/^class DemoReflex < ApplicationReflex$/;"	c
-Engine	lib/stimulus_reflex.rb	/^  class Engine < Rails::Engine$/;"	c	class:StimulusReflex
-StimulusReflex	lib/stimulus_reflex.rb	/^module StimulusReflex$/;"	m
-StimulusReflex	lib/stimulus_reflex/channel.rb	/^class StimulusReflex::Channel < ActionCable::Channel::Base$/;"	c
-StimulusReflex	lib/stimulus_reflex/element.rb	/^class StimulusReflex::Element$/;"	c
-StimulusReflex	lib/stimulus_reflex/reflex.rb	/^class StimulusReflex::Reflex$/;"	c
-StimulusReflex	lib/stimulus_reflex/version.rb	/^module StimulusReflex$/;"	m
-StimulusReflexGenerator	lib/generators/stimulus_reflex_generator.rb	/^class StimulusReflexGenerator < Rails::Generators::NamedBase$/;"	c
-StimulusReflexGeneratorTest	test/generators/stimulus_reflex_generator_test.rb	/^class StimulusReflexGeneratorTest < Rails::Generators::TestCase$/;"	c
-broadcast_error	lib/stimulus_reflex/channel.rb	/^  def broadcast_error(message, data = {})$/;"	f	class:StimulusReflex
-broadcast_morphs	lib/stimulus_reflex/channel.rb	/^  def broadcast_morphs(selectors, data, html)$/;"	f	class:StimulusReflex
-build_request	lib/stimulus_reflex/channel.rb	/^  def build_request$/;"	f	class:StimulusReflex
-commit_session	lib/stimulus_reflex/channel.rb	/^  def commit_session(request, response)$/;"	f	class:StimulusReflex
-copy_controller_files	lib/generators/stimulus_reflex_generator.rb	/^  def copy_controller_files$/;"	f	class:StimulusReflexGenerator
-copy_reflex_files	lib/generators/stimulus_reflex_generator.rb	/^  def copy_reflex_files$/;"	f	class:StimulusReflexGenerator
-dataset	lib/stimulus_reflex/element.rb	/^  def dataset$/;"	f	class:StimulusReflex
-delegate_call_to_reflex	lib/stimulus_reflex/channel.rb	/^  def delegate_call_to_reflex(reflex, method_name, arguments = [])$/;"	f	class:StimulusReflex
-exception_message_with_backtrace	lib/stimulus_reflex/channel.rb	/^  def exception_message_with_backtrace(exception)$/;"	f	class:StimulusReflex
-export.reflexAttribute	javascript/schema.js	/^  reflexAttribute: 'data-reflex',$/;"	p
-export.reflexPermanentAttribute	javascript/schema.js	/^  reflexPermanentAttribute: 'data-reflex-permanent',$/;"	p
-export.reflexRootAttribute	javascript/schema.js	/^  reflexRootAttribute: 'data-reflex-root'$/;"	p
-findConsumer	javascript/consumer.js	/^function findConsumer (object, depth = 0) {$/;"	f
-initialize	lib/stimulus_reflex/element.rb	/^  def initialize(attrs = {})$/;"	f	class:StimulusReflex
-initialize	lib/stimulus_reflex/reflex.rb	/^  def initialize(channel, url: nil, element: nil, selectors: [])$/;"	f	class:StimulusReflex
-initialize_controllers	lib/generators/stimulus_reflex_generator.rb	/^  def initialize_controllers$/;"	f	class:StimulusReflexGenerator
-initialize_reflexes	lib/generators/stimulus_reflex_generator.rb	/^  def initialize_reflexes$/;"	f	class:StimulusReflexGenerator
-is_reflex?	lib/stimulus_reflex/channel.rb	/^  def is_reflex?(reflex_class)$/;"	f	class:StimulusReflex
-receive	lib/stimulus_reflex/channel.rb	/^  def receive(data)$/;"	f	class:StimulusReflex
-render_page	lib/stimulus_reflex/channel.rb	/^  def render_page(reflex)$/;"	f	class:StimulusReflex
-render_page_and_broadcast_morph	lib/stimulus_reflex/channel.rb	/^  def render_page_and_broadcast_morph(reflex, selectors, data = {})$/;"	f	class:StimulusReflex
-request	lib/stimulus_reflex/reflex.rb	/^  def request$/;"	f	class:StimulusReflex
-stream_name	lib/stimulus_reflex/channel.rb	/^  def stream_name$/;"	f	class:StimulusReflex
-subscribed	lib/stimulus_reflex/channel.rb	/^  def subscribed$/;"	f	class:StimulusReflex
-url_params	lib/stimulus_reflex/reflex.rb	/^  def url_params$/;"	f	class:StimulusReflex

data/test/tmp/app/reflexes/application_reflex.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-class ApplicationReflex < StimulusReflex::Reflex
-  # Put application wide Reflex behavior in this file.
-  #
-  # Example:
-  #
-  #   # If your ActionCable connection is: `identified_by :current_user`
-  #   delegate :current_user, to: :connection
-  #
-  # Learn more at: https://docs.stimulusreflex.com
-end

data/test/tmp/app/reflexes/demo_reflex.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-class DemoReflex < ApplicationReflex
-  # Add Reflex methods in this file.
-  #
-  # All Reflex instances expose the following properties:
-  #
-  #   - connection - the ActionCable connection
-  #   - channel - the ActionCable channel
-  #   - request - an ActionDispatch::Request proxy for the socket connection
-  #   - session - the ActionDispatch::Session store for the current visitor
-  #   - url - the URL of the page that triggered the reflex
-  #   - element - a Hash like object that represents the HTML element that triggered the reflex
-  #   - params - parameters from the element's closest form (if any)
-  #
-  # Example:
-  #
-  #   def example(argument=true)
-  #     # Your logic here...
-  #     # Any declared instance variables will be made available to the Rails controller and view.
-  #   end
-  #
-  # Learn more at: https://docs.stimulusreflex.com
-
-end