stimulus_reflex 3.4.0.pre0 → 3.4.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81b721f2742cc09bd39632481e120723205409806d86a0e98e99954fc10b4974
-  data.tar.gz: ca698e3f7b6f3c2fe740429313b166605ad3bab37a74dae4b4fadc4f7e983a21
+  metadata.gz: a1744cbfb7c9c5508487beb3d0087c77b6cc532386ef503709aa0c0097b4f56e
+  data.tar.gz: 99ce8b8d1ad3190d5cd90e49182b39ec959a39f3accb4784f2d0cccbfb7e6fe4
 SHA512:
-  metadata.gz: 88c0a588d1e9e538bf53ad2a40cfcd504d4715ee9cef23c0aaf8a41909c8cd28243030e02ea9b9daf9c4dc56874e1c7f34decf082e21ea18195cf9523c830dc6
-  data.tar.gz: c021b8e46203b36abb2386ad50f999bd05c396e0bec0ba943a667ceccc213ea24d6f3ac310c0eff922c518165b3879dcbd3ddae320c78b78821529514ee5d021
+  metadata.gz: faccf3117f5cb17303725bab3ba659a77314e44908a1b5d1d5184e171b2635c44a10a42f7e19cbfefa6231a6488d1364b6b463a04e3438e1b92aff237545d515
+  data.tar.gz: 126a3dc45916880d97b6ab1971dfb2a433b1d8e1c27b3c7a1c32a5d0b55ee0ae7c50bfdb9b10901525520b0ae1e975a083125a26305147e62252464a872b15db

data/CHANGELOG.md

@@ -2,7 +2,81 @@
 
 ## [Unreleased](https://github.com/hopsoft/stimulus_reflex/tree/HEAD)
 
-[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.3.0...HEAD)
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.4.0.pre4...HEAD)
+
+**Closed issues:**
+
+- SR doesn't seem to handle redirects / 302s [\#376](https://github.com/hopsoft/stimulus_reflex/issues/376)
+
+**Merged pull requests:**
+
+- Move package.json to root of project [\#380](https://github.com/hopsoft/stimulus_reflex/pull/380) ([hopsoft](https://github.com/hopsoft))
+- make element.reflexController a dictionary [\#379](https://github.com/hopsoft/stimulus_reflex/pull/379) ([existentialmutt](https://github.com/existentialmutt))
+- fixed bug preventing callbacks for multiple morphs [\#378](https://github.com/hopsoft/stimulus_reflex/pull/378) ([leastbad](https://github.com/leastbad))
+- Handles to mitigate race conditions when running reflexes in quick succession on the same element [\#377](https://github.com/hopsoft/stimulus_reflex/pull/377) ([existentialmutt](https://github.com/existentialmutt))
+- Exit with nonzero status code [\#375](https://github.com/hopsoft/stimulus_reflex/pull/375) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v3.4.0.pre4](https://github.com/hopsoft/stimulus_reflex/tree/v3.4.0.pre4) (2020-11-19)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.4.0.pre3...v3.4.0.pre4)
+
+**Fixed bugs:**
+
+- Fix fatal error in `stimulus\_reflex:install` task with Rails 5.2 [\#371](https://github.com/hopsoft/stimulus_reflex/pull/371) ([Matt-Yorkley](https://github.com/Matt-Yorkley))
+- fix nothing morphs and error messages [\#368](https://github.com/hopsoft/stimulus_reflex/pull/368) ([leastbad](https://github.com/leastbad))
+
+**Closed issues:**
+
+- `stimulus\_reflex:install` fails to complete in Rails 5.2 [\#367](https://github.com/hopsoft/stimulus_reflex/issues/367)
+- Form data still not captured [\#366](https://github.com/hopsoft/stimulus_reflex/issues/366)
+- Console exception when reflex does not update a page that didn't trigger the reflex [\#363](https://github.com/hopsoft/stimulus_reflex/issues/363)
+- Improve server-side logging options [\#264](https://github.com/hopsoft/stimulus_reflex/issues/264)
+
+**Merged pull requests:**
+
+- use puts instead of ActionCable.logger to sidestep silenced AC logs [\#373](https://github.com/hopsoft/stimulus_reflex/pull/373) ([leastbad](https://github.com/leastbad))
+- Improve logged post\_install.js message [\#372](https://github.com/hopsoft/stimulus_reflex/pull/372) ([forsbergplustwo](https://github.com/forsbergplustwo))
+- Pass additional reflex-related data to reflex from data [\#370](https://github.com/hopsoft/stimulus_reflex/pull/370) ([joshleblanc](https://github.com/joshleblanc))
+- fix: rip out microbundle [\#369](https://github.com/hopsoft/stimulus_reflex/pull/369) ([ParamagicDev](https://github.com/ParamagicDev))
+- Add tests for broadcasters [\#364](https://github.com/hopsoft/stimulus_reflex/pull/364) ([julianrubisch](https://github.com/julianrubisch))
+- Do not run sanity check on `rails generate stimulus\_reflex:config` [\#362](https://github.com/hopsoft/stimulus_reflex/pull/362) ([RolandStuder](https://github.com/RolandStuder))
+- fix: revert CR and @rails/actioncable to dependencies [\#361](https://github.com/hopsoft/stimulus_reflex/pull/361) ([ParamagicDev](https://github.com/ParamagicDev))
+- xpath fix [\#360](https://github.com/hopsoft/stimulus_reflex/pull/360) ([leastbad](https://github.com/leastbad))
+
+## [v3.4.0.pre3](https://github.com/hopsoft/stimulus_reflex/tree/v3.4.0.pre3) (2020-11-11)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.4.0.pre2...v3.4.0.pre3)
+
+**Merged pull requests:**
+
+- Allow to supress warnings for sanity checks [\#359](https://github.com/hopsoft/stimulus_reflex/pull/359) ([RolandStuder](https://github.com/RolandStuder))
+- serializeForm: only append given input if element is submit button [\#357](https://github.com/hopsoft/stimulus_reflex/pull/357) ([marcoroth](https://github.com/marcoroth))
+- Update package.json to 3.4.0-pre2 [\#356](https://github.com/hopsoft/stimulus_reflex/pull/356) ([marcoroth](https://github.com/marcoroth))
+- Fix elementToXPath import [\#355](https://github.com/hopsoft/stimulus_reflex/pull/355) ([julianrubisch](https://github.com/julianrubisch))
+- Add guard clause to return valid empty form data [\#354](https://github.com/hopsoft/stimulus_reflex/pull/354) ([julianrubisch](https://github.com/julianrubisch))
+- simplify xpath functions [\#353](https://github.com/hopsoft/stimulus_reflex/pull/353) ([leastbad](https://github.com/leastbad))
+- pass reflex id to reflex [\#352](https://github.com/hopsoft/stimulus_reflex/pull/352) ([joshleblanc](https://github.com/joshleblanc))
+
+## [v3.4.0.pre2](https://github.com/hopsoft/stimulus_reflex/tree/v3.4.0.pre2) (2020-11-06)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.4.0.pre1...v3.4.0.pre2)
+
+**Closed issues:**
+
+- Regression in version 3.4.0-pre1: Cannot find module `cable\_ready` [\#350](https://github.com/hopsoft/stimulus_reflex/issues/350)
+
+**Merged pull requests:**
+
+- move `cable\_ready` to development dependencies [\#351](https://github.com/hopsoft/stimulus_reflex/pull/351) ([marcoroth](https://github.com/marcoroth))
+- Fix serializeForm initialization [\#349](https://github.com/hopsoft/stimulus_reflex/pull/349) ([marcoroth](https://github.com/marcoroth))
+
+## [v3.4.0.pre1](https://github.com/hopsoft/stimulus_reflex/tree/v3.4.0.pre1) (2020-11-03)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.4.0.pre0...v3.4.0.pre1)
+
+## [v3.4.0.pre0](https://github.com/hopsoft/stimulus_reflex/tree/v3.4.0.pre0) (2020-11-02)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.3.0...v3.4.0.pre0)
 
 **Implemented enhancements:**
 
@@ -334,8 +408,7 @@
 
 **Fixed bugs:**
 
--  Pluralize the generated class name, so that will match with the file name [\#178](https://github.com/hopsoft/stimulus_reflex/pull/178) ([darkrubyist](https://github.com/darkrubyist))
-- Remove unneeded registerConsumer logic [\#158](https://github.com/hopsoft/stimulus_reflex/pull/158) ([hopsoft](https://github.com/hopsoft))
+-  Pluralize the generated class name, so that will match with the file name [\#178](https://github.com/hopsoft/stimulus_reflex/pull/178) ([dark88888](https://github.com/dark88888))
 
 **Closed issues:**
 
@@ -389,6 +462,7 @@
 **Fixed bugs:**
 
 - Unable to register the ActionCable Consumer [\#156](https://github.com/hopsoft/stimulus_reflex/issues/156)
+- Remove unneeded registerConsumer logic [\#158](https://github.com/hopsoft/stimulus_reflex/pull/158) ([hopsoft](https://github.com/hopsoft))
 
 **Closed issues:**
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (3.4.0.pre0)
+    stimulus_reflex (3.4.0.pre5)
       cable_ready (>= 4.3.0)
       nokogiri
       rack
@@ -68,12 +68,12 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.1)
     builder (3.2.4)
-    cable_ready (4.3.0)
+    cable_ready (4.4.0)
       rails (>= 5.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
     crass (1.0.6)
-    erubi (1.9.0)
+    erubi (1.10.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.5)
@@ -93,7 +93,7 @@ GEM
     nio4r (2.5.4)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
+    parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.12.2)
@@ -132,19 +132,19 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.2.2)
-    regexp_parser (1.8.2)
+    redis (4.2.5)
+    regexp_parser (2.0.0)
     rexml (3.2.4)
-    rubocop (1.0.0)
+    rubocop (1.2.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.0)
+    rubocop-ast (1.2.0)
       parser (>= 2.7.1.5)
     rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
@@ -157,14 +157,14 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    standard (0.8.1)
-      rubocop (= 1.0.0)
+    standard (0.9.0)
+      rubocop (= 1.2.0)
       rubocop-performance (= 1.8.1)
     standardrb (1.0.0)
       standard
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     websocket-driver (0.7.3)

data/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="assets/stimulus-reflex-logo-with-copy.svg" width="360" />
+  <img src="https://gitcdn.link/repo/hopsoft/stimulus_reflex/master/assets/stimulus-reflex-logo-with-copy.svg" 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" />
@@ -11,7 +11,7 @@
       <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-1322-brightgreen.svg?style=flat" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-1506-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" />
@@ -54,7 +54,7 @@ And, it's fast.
 
 It works seamlessly with the Rails tooling you already know and love.
 
-- Server-rendered HTML, delivered in miliseconds over the wire via Websockets
+- Server-rendered HTML, delivered in milliseconds over the wire via Websockets
 - ERB templates and partials, with first-class [ViewComponent](https://github.com/github/view_component) support
 - [Russian doll caching](https://edgeguides.rubyonrails.org/caching_with_rails.html#russian-doll-caching) and [ActiveJob](https://guides.rubyonrails.org/active_job_basics.html)
 - [StimulusJS](https://stimulusjs.org/) and [Turbolinks](https://www.youtube.com/watch?v=SWEts0rlezA)
@@ -77,7 +77,7 @@ This project strives to live up to the vision outlined in [The Rails Doctrine](h
 
 ## 👩‍👩‍👧 Discord Community
 
-Please join over 600 of us on [Discord](https://discord.gg/XveN625) for support getting started, as well as active discussions around Rails, StimulusJS and CableReady.
+Please join over 700 of us on [Discord](https://discord.gg/XveN625) for support getting started, as well as active discussions around Rails, StimulusJS and CableReady.
 
 ![](https://img.shields.io/discord/629472241427415060)
 
@@ -113,9 +113,8 @@ View the [wiki](https://github.com/hopsoft/stimulus_reflex/wiki/Editor-Configura
 1. Bump version number at `lib/stimulus_reflex/version.rb`
 1. Run `rake build`
 1. Run `rake release`
-1. Change directories `cd ./javascript`
-1. Run `yarn publish` - NOTE: this will throw a fatal error because the tag already exists but the package will still publish
-
+1. Run `yarn publish --no-git-tag-version`
+1. Commit and push changes to the `package.json` file
 
 ## 📝 License
 

data/Rakefile

@@ -6,7 +6,7 @@ require "rails/test_unit/runner"
 task default: [:test]
 
 task :test do |task|
-  return 1 unless system("cd javascript && yarn run test")
+  return 1 unless system("yarn run test")
   Rails::TestUnit::Runner.run
 end
 

data/app/channels/stimulus_reflex/channel.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.constantize
+  def stream_name
+    ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
+    [
+      params[:channel],
+      ids.select(&:present?).join(";")
+    ].select(&:present?).join(":")
+  end
+
+  def subscribed
+    super
+    fix_environment!
+    stream_from stream_name
+  end
+
+  def receive(data)
+    url = data["url"].to_s
+    selectors = (data["selectors"] || []).select(&:present?)
+    selectors = data["selectors"] = ["body"] if selectors.blank?
+    target = data["target"].to_s
+    reflex_name, method_name = target.split("#")
+    reflex_name = reflex_name.camelize
+    reflex_name = reflex_name.end_with?("Reflex") ? reflex_name : "#{reflex_name}Reflex"
+    arguments = (data["args"] || []).map { |arg| object_with_indifferent_access arg }
+    element = StimulusReflex::Element.new(data)
+    permanent_attribute_name = data["permanentAttributeName"]
+    form_data = Rack::Utils.parse_nested_query(data["formData"])
+    params = form_data.deep_merge(data["params"] || {})
+
+    begin
+      begin
+        reflex_class = reflex_name.constantize.tap { |klass| raise ArgumentError.new("#{reflex_name} is not a StimulusReflex::Reflex") unless is_reflex?(klass) }
+        reflex = reflex_class.new(self,
+          url: url,
+          element: element,
+          selectors: selectors,
+          method_name: method_name,
+          params: params,
+          client_attributes: {
+            reflex_id: data["reflexId"],
+            xpath: data["xpath"],
+            c_xpath: data["cXpath"],
+            reflex_controller: data["reflexController"],
+            permanent_attribute_name: permanent_attribute_name
+          })
+        delegate_call_to_reflex reflex, method_name, arguments
+      rescue => invoke_error
+        message = exception_message_with_backtrace(invoke_error)
+        body = "Reflex #{target} failed: #{message} [#{url}]"
+        if reflex
+          reflex.rescue_with_handler(invoke_error)
+          reflex.broadcast_message subject: "error", body: body, data: data, error: invoke_error
+        else
+          puts "\e[31m#{body}\e[0m"
+        end
+        return
+      end
+
+      if reflex.halted?
+        reflex.broadcast_message subject: "halted", data: data
+      else
+        begin
+          reflex.broadcast(selectors, data)
+        rescue => render_error
+          reflex.rescue_with_handler(render_error)
+          message = exception_message_with_backtrace(render_error)
+          body = "Reflex failed to re-render: #{message} [#{url}]"
+          reflex.broadcast_message subject: "error", body: body, data: data, error: render_error
+          puts "\e[31m#{body}\e[0m"
+        end
+      end
+    ensure
+      if reflex
+        commit_session(reflex)
+        reflex.logger.print
+      end
+    end
+  end
+
+  private
+
+  def object_with_indifferent_access(object)
+    return object.with_indifferent_access if object.respond_to?(:with_indifferent_access)
+    object.map! { |obj| object_with_indifferent_access obj } if object.is_a?(Array)
+    object
+  end
+
+  def is_reflex?(reflex_class)
+    reflex_class.ancestors.include? StimulusReflex::Reflex
+  end
+
+  def delegate_call_to_reflex(reflex, method_name, arguments = [])
+    method = reflex.method(method_name)
+    required_params = method.parameters.select { |(kind, _)| kind == :req }
+    optional_params = method.parameters.select { |(kind, _)| kind == :opt }
+
+    if arguments.size == 0 && required_params.size == 0
+      reflex.process(method_name)
+    elsif arguments.size >= required_params.size && arguments.size <= required_params.size + optional_params.size
+      reflex.process(method_name, *arguments)
+    else
+      raise ArgumentError.new("wrong number of arguments (given #{arguments.inspect}, expected #{required_params.inspect}, optional #{optional_params.inspect})")
+    end
+  end
+
+  def commit_session(reflex)
+    store = reflex.request.session.instance_variable_get("@by")
+    store.commit_session reflex.request, reflex.controller.response
+  rescue => e
+    message = "Failed to commit session! #{exception_message_with_backtrace(e)}"
+    puts "\e[31m#{message}\e[0m"
+  end
+
+  def exception_message_with_backtrace(exception)
+    "#{exception}\n#{exception.backtrace.first}"
+  end
+
+  def fix_environment!
+    ([ApplicationController] + ApplicationController.descendants).each do |controller|
+      controller.renderer.instance_variable_set(:@env, connection.env.merge(controller.renderer.instance_variable_get(:@env)))
+    end
+  end
+end

data/bin/standardize

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 
 bundle exec standardrb --fix
-cd ./javascript && yarn run prettier-standard:format
+yarn run prettier-standard:format

data/lib/generators/stimulus_reflex/templates/config/initializers/stimulus_reflex.rb

@@ -1,9 +1,20 @@
 # frozen_string_literal: true
 
 StimulusReflex.configure do |config|
-  # Enable/disable whether startup should be aborted when the sanity checks fail
-  # config.exit_on_failed_sanity_checks = true
+  # Enable/disable exiting / warning when the sanity checks fail options:
+  # `:exit` or `:warn` or `:ignore`
+
+  # config.on_failed_sanity_checks = :exit
 
   # Override the parent class that the StimulusReflex ActionCable channel inherits from
+
   # config.parent_channel = "ApplicationCable::Channel"
+
+  # Customize server-side Reflex logging format, with optional colorization:
+  # Available tokens: session_id, session_id_full, reflex_info, operation, reflex_id, reflex_id_full, mode, selector, operation_counter, connection_id, connection_id_full, timestamp
+  # Available colors: green, yellow, blue, magenta, cyan, white
+  # You can also use attributes from your ActionCable Connection's identifiers that resolve to valid ActiveRecord models
+  # eg. if your connection is `identified_by :current_user` and your User model has an email attribute, you can access r.email (it will display `-` if the user isn't logged in)
+
+  # config.logging = proc { "[#{session_id}] #{operation_counter.magenta} #{reflex_info.green} -> #{selector.cyan} via #{mode} Morph (#{operation.yellow})" }
 end

data/lib/stimulus_reflex.rb

@@ -17,6 +17,8 @@ require "stimulus_reflex/broadcasters/broadcaster"
 require "stimulus_reflex/broadcasters/nothing_broadcaster"
 require "stimulus_reflex/broadcasters/page_broadcaster"
 require "stimulus_reflex/broadcasters/selector_broadcaster"
+require "stimulus_reflex/utils/colorize"
+require "stimulus_reflex/logger"
 
 module StimulusReflex
   class Engine < Rails::Engine

data/lib/stimulus_reflex/broadcasters/broadcaster.rb

@@ -4,12 +4,13 @@ module StimulusReflex
   class Broadcaster
     include CableReady::Broadcaster
 
-    attr_reader :reflex, :logger
+    attr_reader :reflex, :logger, :operations
     delegate :permanent_attribute_name, :stream_name, to: :reflex
 
     def initialize(reflex)
       @reflex = reflex
-      @logger = Rails.logger
+      @logger = Rails.logger if defined?(Rails.logger)
+      @operations = []
     end
 
     def nothing?
@@ -26,6 +27,7 @@ module StimulusReflex
 
     def broadcast_message(subject:, body: nil, data: {}, error: nil)
       logger.error "\e[31m#{body}\e[0m" if subject == "error"
+      operations << ["document", :dispatch_event]
       cable_ready[stream_name].dispatch_event(
         name: "stimulus-reflex:server-message",
         detail: {
@@ -48,5 +50,10 @@ module StimulusReflex
     def to_sym
       raise NotImplementedError
     end
+
+    # abstract method to be implemented by subclasses
+    def to_s
+      raise NotImplementedError
+    end
   end
 end

data/lib/stimulus_reflex/broadcasters/nothing_broadcaster.rb

@@ -13,5 +13,9 @@ module StimulusReflex
     def to_sym
       :nothing
     end
+
+    def to_s
+      "Nothing"
+    end
   end
 end