stimulus_reflex 3.2.1 → 3.2.2.pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62a646413ff8f9185f010b897867e16adde1220617a6da72ae9529b81dabc05c
-  data.tar.gz: 767c899c2279c21e80f20eeafe7e22c331dacfec245100f74e31882e5d2f9dda
+  metadata.gz: dd9af85e63dfa792a38d7dd4a560f86c1bcca6898aa8f38882ccfea57e726dbd
+  data.tar.gz: d4fdcadaae536283af5db9e98551a5dbd1cd9aa3100bba806be82e5cf6aecd18
 SHA512:
-  metadata.gz: f3a87691efc93825c28ba4d00df05da5fd5570c6800465fff794dd9059bc00d439f12208cb6e7a51735992dadba165e8f96257fa64d24160f7b7cdbe04dc97fe
-  data.tar.gz: 8962938cdb8c3980a607ade364e733f809fcc88928bc60e631eb88daac6685b0b27c2c89aa3510d31fcec6b4db22ea7ee369148ea3be2926a5c4eb88f44da586
+  metadata.gz: a64205414cfc3630ecb2c537abe5f0deacd0737f5abcf9d33873d57b317d5bf0dfccee6ae09706fdf1e38a5ca7ea6d3159272abd4a293523f9451600ce8d43f7
+  data.tar.gz: 81792f053d071fe1fc63db27609a53b4147b9d0f02f85714ba8c81f7cf7e937f94aca5037845badcdbb7b24e78992152549a991a3a1db5a1e1563d9b1f574713

data/CHANGELOG.md

@@ -2,7 +2,45 @@
 
 ## [Unreleased](https://github.com/hopsoft/stimulus_reflex/tree/HEAD)
 
-[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.2.0...HEAD)
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.2.1...HEAD)
+
+**Implemented enhancements:**
+
+- Add a halted lifecycle event [\#190](https://github.com/hopsoft/stimulus_reflex/issues/190)
+- Allow extractElementAttributes to use a checkbox list [\#147](https://github.com/hopsoft/stimulus_reflex/issues/147)
+- reflex\_name restriction loosening [\#212](https://github.com/hopsoft/stimulus_reflex/pull/212) ([leastbad](https://github.com/leastbad))
+- Make element even more user friendly [\#210](https://github.com/hopsoft/stimulus_reflex/pull/210) ([hopsoft](https://github.com/hopsoft))
+- Form parameters [\#204](https://github.com/hopsoft/stimulus_reflex/pull/204) ([jasoncharnes](https://github.com/jasoncharnes))
+- Map hashes in incoming arguments using with\_indifferent\_access [\#203](https://github.com/hopsoft/stimulus_reflex/pull/203) ([jaredcwhite](https://github.com/jaredcwhite))
+- Combine dataset with data-attributes from parent elements on reflex call [\#200](https://github.com/hopsoft/stimulus_reflex/pull/200) ([marcoroth](https://github.com/marcoroth))
+- Setup mutation aware declarative reflexes [\#197](https://github.com/hopsoft/stimulus_reflex/pull/197) ([hopsoft](https://github.com/hopsoft))
+
+**Fixed bugs:**
+
+- Text area values are lost if re-sized [\#195](https://github.com/hopsoft/stimulus_reflex/issues/195)
+
+**Closed issues:**
+
+- Accessing dataset as before is returning nil [\#218](https://github.com/hopsoft/stimulus_reflex/issues/218)
+- Spurious console error using data-reflex-root and CSS attribute selector [\#207](https://github.com/hopsoft/stimulus_reflex/issues/207)
+- ActionController Parameters [\#199](https://github.com/hopsoft/stimulus_reflex/issues/199)
+
+**Merged pull requests:**
+
+- Bump activesupport from 6.0.3 to 6.0.3.1 [\#217](https://github.com/hopsoft/stimulus_reflex/pull/217) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump activestorage from 6.0.3 to 6.0.3.1 [\#216](https://github.com/hopsoft/stimulus_reflex/pull/216) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump actionpack from 6.0.3 to 6.0.3.1 [\#215](https://github.com/hopsoft/stimulus_reflex/pull/215) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update dataset handling and some minor refactoring to better naming [\#214](https://github.com/hopsoft/stimulus_reflex/pull/214) ([hopsoft](https://github.com/hopsoft))
+- Stimulus reflexData assignment after callback  [\#208](https://github.com/hopsoft/stimulus_reflex/pull/208) ([jasoncharnes](https://github.com/jasoncharnes))
+- Loosen Rails requirement to 5.2 with instructions [\#205](https://github.com/hopsoft/stimulus_reflex/pull/205) ([jasoncharnes](https://github.com/jasoncharnes))
+- Fix undefined is not an object for Object.keys in log.js [\#201](https://github.com/hopsoft/stimulus_reflex/pull/201) ([marcoroth](https://github.com/marcoroth))
+- Small typo/grammar fix in quickstart doc. [\#198](https://github.com/hopsoft/stimulus_reflex/pull/198) ([acoffman](https://github.com/acoffman))
+- Add halted lifecycle event [\#193](https://github.com/hopsoft/stimulus_reflex/pull/193) ([seb1441](https://github.com/seb1441))
+- 147 extract multiple checkbox values [\#175](https://github.com/hopsoft/stimulus_reflex/pull/175) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v3.2.1](https://github.com/hopsoft/stimulus_reflex/tree/v3.2.1) (2020-05-09)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.2.0...v3.2.1)
 
 **Merged pull requests:**
 

data/Gemfile.lock

@@ -1,65 +1,65 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (3.2.1)
+    stimulus_reflex (3.2.2.pre0)
       cable_ready (>= 4.1.2)
       nokogiri
       rack
-      rails (>= 6.0)
+      rails (>= 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3)
-      actionpack (= 6.0.3)
+    actioncable (6.0.3.1)
+      actionpack (= 6.0.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3)
-      actionpack (= 6.0.3)
-      activejob (= 6.0.3)
-      activerecord (= 6.0.3)
-      activestorage (= 6.0.3)
-      activesupport (= 6.0.3)
+    actionmailbox (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       mail (>= 2.7.1)
-    actionmailer (6.0.3)
-      actionpack (= 6.0.3)
-      actionview (= 6.0.3)
-      activejob (= 6.0.3)
+    actionmailer (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3)
-      actionview (= 6.0.3)
-      activesupport (= 6.0.3)
+    actionpack (6.0.3.1)
+      actionview (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3)
-      actionpack (= 6.0.3)
-      activerecord (= 6.0.3)
-      activestorage (= 6.0.3)
-      activesupport (= 6.0.3)
+    actiontext (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3)
-      activesupport (= 6.0.3)
+    actionview (6.0.3.1)
+      activesupport (= 6.0.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3)
-      activesupport (= 6.0.3)
+    activejob (6.0.3.1)
+      activesupport (= 6.0.3.1)
       globalid (>= 0.3.6)
-    activemodel (6.0.3)
-      activesupport (= 6.0.3)
-    activerecord (6.0.3)
-      activemodel (= 6.0.3)
-      activesupport (= 6.0.3)
-    activestorage (6.0.3)
-      actionpack (= 6.0.3)
-      activejob (= 6.0.3)
-      activerecord (= 6.0.3)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activestorage (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
       marcel (~> 0.3.1)
-    activesupport (6.0.3)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -77,7 +77,6 @@ GEM
       activesupport (>= 4.2.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -89,12 +88,12 @@ GEM
     mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.1)
-    parser (2.7.1.2)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -104,37 +103,36 @@ GEM
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3)
-      actioncable (= 6.0.3)
-      actionmailbox (= 6.0.3)
-      actionmailer (= 6.0.3)
-      actionpack (= 6.0.3)
-      actiontext (= 6.0.3)
-      actionview (= 6.0.3)
-      activejob (= 6.0.3)
-      activemodel (= 6.0.3)
-      activerecord (= 6.0.3)
-      activestorage (= 6.0.3)
-      activesupport (= 6.0.3)
+    rails (6.0.3.1)
+      actioncable (= 6.0.3.1)
+      actionmailbox (= 6.0.3.1)
+      actionmailer (= 6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actiontext (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       bundler (>= 1.3.0)
-      railties (= 6.0.3)
+      railties (= 6.0.3.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3)
-      actionpack (= 6.0.3)
-      activesupport (= 6.0.3)
+    railties (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
     rexml (3.2.4)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.83.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
@@ -151,8 +149,8 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    standard (0.4.0)
-      rubocop (~> 0.82.0)
+    standard (0.4.6)
+      rubocop (~> 0.83.0)
       rubocop-performance (~> 1.5.2)
     standardrb (1.0.0)
       standard
@@ -161,7 +159,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
     zeitwerk (2.3.0)

data/README.md

@@ -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-809-brightgreen.svg?style=flat" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-923-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" />

data/lib/generators/templates/custom_reflex.rb

@@ -11,6 +11,7 @@ class <%= class_name %>Reflex < ApplicationReflex
   #   - 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:
   #

data/lib/stimulus_reflex/channel.rb

@@ -22,31 +22,42 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
     target = data["target"].to_s
     reflex_name, method_name = target.split("#")
     reflex_name = reflex_name.classify
-    arguments = data["args"] || []
-    element = StimulusReflex::Element.new(data["attrs"])
+    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)
+    params = data["params"] || {}
 
     begin
-      reflex_class = reflex_name.constantize
-      raise ArgumentError.new("#{reflex_name} is not a StimulusReflex::Reflex") unless is_reflex?(reflex_class)
-      reflex = reflex_class.new(self, url: url, element: element, selectors: selectors, method_name: method_name)
+      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)
       delegate_call_to_reflex reflex, method_name, arguments
     rescue => invoke_error
       reflex.rescue_with_handler(invoke_error)
       message = exception_message_with_backtrace(invoke_error)
-      return broadcast_error("StimulusReflex::Channel Failed to invoke #{target}! #{url} #{message}", data)
+      return broadcast_message subject: "error", body: "StimulusReflex::Channel Failed to invoke #{target}! #{url} #{message}", data: data
     end
 
-    begin
-      render_page_and_broadcast_morph reflex, selectors, data unless reflex.halted?
-    rescue => render_error
-      reflex.rescue_with_handler(render_error)
-      message = exception_message_with_backtrace(render_error)
-      broadcast_error "StimulusReflex::Channel Failed to re-render #{url} #{message}", data
+    if reflex.halted?
+      broadcast_message subject: "halted", data: data
+    else
+      begin
+        render_page_and_broadcast_morph reflex, selectors, data
+      rescue => render_error
+        reflex.rescue_with_handler(render_error)
+        message = exception_message_with_backtrace(render_error)
+        broadcast_message subject: "error", body: "StimulusReflex::Channel Failed to re-render #{url} #{message}", data: data
+      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
@@ -107,11 +118,17 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
     cable_ready.broadcast
   end
 
-  def broadcast_error(message, data = {})
-    logger.error "\e[31m#{message}\e[0m"
+  def broadcast_message(subject:, body: nil, data: {})
+    message = {
+      subject: subject,
+      body: body
+    }
+
+    logger.error "\e[31m#{body}\e[0m" if subject == "error"
+
     cable_ready[stream_name].dispatch_event(
-      name: "stimulus-reflex:500",
-      detail: {stimulus_reflex: data.merge(error: message)}
+      name: "stimulus-reflex:server-message",
+      detail: {stimulus_reflex: data.merge(server_message: message)}
     )
     cable_ready.broadcast
   end

data/lib/stimulus_reflex/element.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-class StimulusReflex::Element
-  attr_reader :attributes
+class StimulusReflex::Element < OpenStruct
+  attr_reader :attributes, :data_attributes
 
-  delegate :[], to: :"@attributes"
-
-  def initialize(attrs = {})
-    @attributes = HashWithIndifferentAccess.new(attrs || {}).freeze
+  def initialize(data = {})
+    @attributes = HashWithIndifferentAccess.new(data["attrs"] || {})
+    @data_attributes = HashWithIndifferentAccess.new(data["dataset"] || {})
+    all_attributes = @attributes.merge(@data_attributes)
+    super all_attributes.merge(all_attributes.transform_keys(&:underscore))
+    @data_attributes.transform_keys! { |key| key.delete_prefix "data-" }
   end
 
   def dataset
-    @dataset ||= attributes.each_with_object(HashWithIndifferentAccess.new) { |(key, value), memo|
-      next unless key.start_with?("data-")
-      memo[key.delete_prefix("data-")] = value
-    }.freeze
+    @dataset ||= OpenStruct.new(data_attributes.merge(data_attributes.transform_keys(&:underscore)))
   end
 end

data/lib/stimulus_reflex/reflex.rb

@@ -47,12 +47,13 @@ class StimulusReflex::Reflex
   delegate :connection, to: :channel
   delegate :session, to: :request
 
-  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil)
+  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, params: {})
     @channel = channel
     @url = url
     @element = element
     @selectors = selectors
     @method_name = method_name
+    @params = params
   end
 
   def request
@@ -76,6 +77,7 @@ class StimulusReflex::Reflex
       )
       path_params = Rails.application.routes.recognize_path_with_request(req, url, req.env[:extras] || {})
       req.env.merge(ActionDispatch::Http::Parameters::PARAMETERS_KEY => path_params)
+      req.env["action_dispatch.request.parameters"] = @params
       req.tap { |r| r.session.send :load! }
     end
   end
@@ -103,4 +105,8 @@ class StimulusReflex::Reflex
   def default_reflex
     # noop default reflex to force page reloads
   end
+
+  def params
+    @_params ||= ActionController::Parameters.new(request.parameters)
+  end
 end

data/lib/stimulus_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusReflex
-  VERSION = "3.2.1"
+  VERSION = "3.2.2.pre0"
 end

data/stimulus_reflex.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rack"
   gem.add_dependency "nokogiri"
-  gem.add_dependency "rails", ">= 6.0"
+  gem.add_dependency "rails", ">= 5.2"
   gem.add_dependency "cable_ready", ">= 4.1.2"
 
   gem.add_development_dependency "bundler", "~> 2.0"

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

@@ -11,6 +11,7 @@ class DemoReflex < ApplicationReflex
   #   - 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:
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2.pre0
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: cable_ready
   requirement: !ruby/object:Gem::Requirement
@@ -197,9 +197,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: