stimulus_reflex 3.1.4 → 3.2.0.pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a559b60e0f9fa9519b36dbdec1a217f15eecbf2a3bff051c20faf91d046c9e89
-  data.tar.gz: 04af4bf702cd97e692d2f0c0b6396e8c1d86821a53d7352854753b524aa7ba92
+  metadata.gz: ea3e0dabfb3b7b82b035f2b63db76ea575452a465e07bd992dd3d7a270e89dab
+  data.tar.gz: 1f26c53eaa26520dd2697c50996b690f6116476eb6235bf126c2fc31991b677c
 SHA512:
-  metadata.gz: 8b5f428fe17bddfeff38c20d400b0b7a25f211b000acd5a0c0578a46379762371ff11f67e81243e20d08fdbeeae585e48c65b2aeb17f7bb6bfc228da7ecd62ce
-  data.tar.gz: 22df1e093ae82f7454fbd60501622d6d083e69e5c00732dbf953221b9a113d901aa7d347ee82b19a74b9bed75e918c60749bc71caf0f8e9f038619e0464dcf6d
+  metadata.gz: ac488c852fa0af0083522553addc0423b99914981719ef988f03101ded5a7be2dfe448959ac0640a5082a0e40f12e303788ddde0fcd4086a4dcd831ba408a6d7
+  data.tar.gz: 8c80b5cae19be15c6dd3519565872b92de7729b19a7a768eebcfe342ebe66916231a11ddf0bed224da574f7ea4695fad8cf8f4fc98ecfbdc837eb620215ea78f

data/CHANGELOG.md

@@ -2,7 +2,37 @@
 
 ## [Unreleased](https://github.com/hopsoft/stimulus_reflex/tree/HEAD)
 
-[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.1.3...HEAD)
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.1.4...HEAD)
+
+**Implemented enhancements:**
+
+- Stimulate without a reflex target [\#179](https://github.com/hopsoft/stimulus_reflex/issues/179)
+- Reflex callbacks [\#155](https://github.com/hopsoft/stimulus_reflex/issues/155)
+- Replace camelize with homegrown version [\#184](https://github.com/hopsoft/stimulus_reflex/pull/184) ([jonathan-s](https://github.com/jonathan-s))
+- Replace uuid4 dependency with function in repo [\#181](https://github.com/hopsoft/stimulus_reflex/pull/181) ([jonathan-s](https://github.com/jonathan-s))
+- Allow channel exceptions to be rescuable [\#180](https://github.com/hopsoft/stimulus_reflex/pull/180) ([dark-panda](https://github.com/dark-panda))
+- add console log messages for every reflex call [\#163](https://github.com/hopsoft/stimulus_reflex/pull/163) ([marcoroth](https://github.com/marcoroth))
+- add reflex callbacks [\#160](https://github.com/hopsoft/stimulus_reflex/pull/160) ([seb1441](https://github.com/seb1441))
+
+**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 changelog rake task [\#150](https://github.com/hopsoft/stimulus_reflex/pull/150) ([andrewmcodes](https://github.com/andrewmcodes))
+
+**Closed issues:**
+
+-  The ActionCable connection is not open! `this.isActionCableConnectionOpen\(\)` must return true before calling `this.stimulate\(\)` [\#187](https://github.com/hopsoft/stimulus_reflex/issues/187)
+- Promises just resolve with last Partial DOM update [\#171](https://github.com/hopsoft/stimulus_reflex/issues/171)
+
+**Merged pull requests:**
+
+- Some housekeeping [\#189](https://github.com/hopsoft/stimulus_reflex/pull/189) ([hopsoft](https://github.com/hopsoft))
+- Allow to call stimulate without a reflex target [\#188](https://github.com/hopsoft/stimulus_reflex/pull/188) ([marcoroth](https://github.com/marcoroth))
+- Fix bug in super documentation [\#174](https://github.com/hopsoft/stimulus_reflex/pull/174) ([silva96](https://github.com/silva96))
+
+## [v3.1.4](https://github.com/hopsoft/stimulus_reflex/tree/v3.1.4) (2020-04-27)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.1.3...v3.1.4)
 
 **Implemented enhancements:**
 
@@ -62,7 +92,6 @@
 **Fixed bugs:**
 
 - Cannot read property 'removeEventListener' of undefined after updating to 3.1.0 [\#151](https://github.com/hopsoft/stimulus_reflex/issues/151)
-- remove changelog rake task [\#150](https://github.com/hopsoft/stimulus_reflex/pull/150) ([andrewmcodes](https://github.com/andrewmcodes))
 
 **Closed issues:**
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (3.1.4)
+    stimulus_reflex (3.2.0.pre0)
       cable_ready (>= 4.1.2)
       nokogiri
       rack
@@ -86,7 +86,7 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.2)
-    mimemagic (0.3.4)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.0)
@@ -94,7 +94,7 @@ GEM
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.1)
-    parser (2.7.1.1)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -133,14 +133,14 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     rexml (3.2.4)
-    rubocop (0.80.1)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
@@ -151,8 +151,8 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    standard (0.2.4)
-      rubocop (~> 0.80.1)
+    standard (0.3.0)
+      rubocop (~> 0.82.0)
       rubocop-performance (~> 1.5.2)
     standardrb (1.0.0)
       standard
@@ -160,7 +160,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
+    unicode-display_width (1.7.0)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)

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-684-brightgreen.svg?style=flat" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-805-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" />
@@ -68,6 +68,7 @@ This project strives to live up to the vision outlined in [The Rails Doctrine](h
 
 ## ✨ Demos
 
+- https://youtu.be/F5hA79vKE_E
 - http://expo.stimulusreflex.com
 
 ## 💙 Community

data/lib/generators/stimulus_reflex_generator.rb

@@ -5,6 +5,10 @@ require "rails/generators"
 class StimulusReflexGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("templates", __dir__)
 
+  def initialize_application_reflexes
+    copy_application_files if behavior == :invoke
+  end
+
   def initialize_reflexes
     copy_reflex_files
   end
@@ -19,12 +23,15 @@ class StimulusReflexGenerator < Rails::Generators::NamedBase
   REFLEX_BASE_PATH = "app/reflexes"
 
   def copy_reflex_files
-    template "application_reflex.rb", File.join(REFLEX_BASE_PATH, "application_reflex.rb")
     template "custom_reflex.rb", File.join(REFLEX_BASE_PATH, "#{name.underscore}_reflex.rb")
   end
 
   def copy_controller_files
-    template "application_controller.js", File.join(CONTROLLER_BASE_PATH, "application_controller.js")
     template "custom_controller.js", File.join(CONTROLLER_BASE_PATH, "#{name.underscore}_controller.js")
   end
+
+  def copy_application_files
+    template "application_reflex.rb", File.join(REFLEX_BASE_PATH, "application_reflex.rb")
+    template "application_controller.js", File.join(CONTROLLER_BASE_PATH, "application_controller.js")
+  end
 end

data/lib/generators/templates/custom_controller.js

@@ -1,6 +1,6 @@
 import ApplicationController from './application_controller'
 
-/* This is the custom StimulusReflex controller for <%= @name.classify %>Reflex.
+/* This is the custom StimulusReflex controller for <%= class_name %>Reflex.
  * Learn more at: https://docs.stimulusreflex.com
  */
 export default class extends ApplicationController {
@@ -10,14 +10,14 @@ export default class extends ApplicationController {
    *
    * Example:
    *
-   *   <a href="#" data-reflex="<%= @name.classify %>Reflex#example">Example</a>
+   *   <a href="#" data-reflex="<%= class_name %>Reflex#example">Example</a>
    *
    * Arguments:
    *
    *   element - the element that triggered the reflex
    *             may be different than the Stimulus controller's this.element
    *
-   *   reflex - the name of the reflex e.g. "<%= @name.classify %>Reflex#example"
+   *   reflex - the name of the reflex e.g. "<%= class_name %>Reflex#example"
    *
    *   error - error message from the server
    */

data/lib/generators/templates/custom_reflex.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class <%= @name.classify %>Reflex < ApplicationReflex
+class <%= class_name %>Reflex < ApplicationReflex
   # Add Reflex methods in this file.
   #
   # All Reflex instances expose the following properties:

data/lib/stimulus_reflex/channel.rb

@@ -28,16 +28,18 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
     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)
+      reflex = reflex_class.new(self, url: url, element: element, selectors: selectors, method_name: method_name)
       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)
     end
 
     begin
-      render_page_and_broadcast_morph reflex, selectors, data
+      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
     end
@@ -55,9 +57,9 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
     optional_params = method.parameters.select { |(kind, _)| kind == :opt }
 
     if arguments.size == 0 && required_params.size == 0
-      reflex.public_send method_name
+      reflex.process(method_name)
     elsif arguments.size >= required_params.size && arguments.size <= required_params.size + optional_params.size
-      reflex.public_send method_name, *arguments
+      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

data/lib/stimulus_reflex/reflex.rb

@@ -1,16 +1,58 @@
 # frozen_string_literal: true
 
 class StimulusReflex::Reflex
-  attr_reader :channel, :url, :element, :selectors
+  include ActiveSupport::Rescuable
+  include ActiveSupport::Callbacks
+
+  define_callbacks :process, skip_after_callbacks_if_terminated: true
+
+  class << self
+    def before_reflex(*args, &block)
+      add_callback(:before, *args, &block)
+    end
+
+    def after_reflex(*args, &block)
+      add_callback(:after, *args, &block)
+    end
+
+    def around_reflex(*args, &block)
+      add_callback(:around, *args, &block)
+    end
+
+    private
+
+    def add_callback(kind, *args, &block)
+      options = args.extract_options!
+      options.assert_valid_keys :if, :unless, :only, :except
+      set_callback(*[:process, kind, args, normalize_callback_options!(options)].flatten, &block)
+    end
+
+    def normalize_callback_options!(options)
+      normalize_callback_option! options, :only, :if
+      normalize_callback_option! options, :except, :unless
+      options
+    end
+
+    def normalize_callback_option!(options, from, to)
+      if (from = options.delete(from))
+        from_set = Array(from).map(&:to_s).to_set
+        from = proc { |reflex| from_set.include? reflex.method_name }
+        options[to] = Array(options[to]).unshift(from)
+      end
+    end
+  end
+
+  attr_reader :channel, :url, :element, :selectors, :method_name
 
   delegate :connection, to: :channel
   delegate :session, to: :request
 
-  def initialize(channel, url: nil, element: nil, selectors: [])
+  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil)
     @channel = channel
     @url = url
     @element = element
     @selectors = selectors
+    @method_name = method_name
   end
 
   def request
@@ -41,4 +83,21 @@ class StimulusReflex::Reflex
   def url_params
     @url_params ||= Rails.application.routes.recognize_path_with_request(request, request.path, request.env[:extras] || {})
   end
+
+  def process(name, *args)
+    result = run_callbacks(:process) { public_send(name, *args) }
+    @halted ||= result == false
+    result
+  end
+
+  # Indicates if the callback chain was halted via a throw(:abort) in a before_reflex callback.
+  # SEE: https://api.rubyonrails.org/classes/ActiveSupport/Callbacks.html
+  # IMPORTANT: The reflex will not re-render the page if the callback chain is halted
+  def halted?
+    !!@halted
+  end
+
+  def default_reflex
+    # noop default reflex to force page reloads
+  end
 end

data/lib/stimulus_reflex/version.rb

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

data/lib/tasks/stimulus_reflex/install.rake

@@ -18,13 +18,24 @@ namespace :stimulus_reflex do
     end
     puts "Updating #{filepath}"
     lines = File.open(filepath, "r") { |f| f.readlines }
-    import_line = lines.find { |line| line.start_with?("import StimulusReflex") }
-    initialize_line = lines.find { |line| line.start_with?("StimulusReflex.initialize") }
-    unless import_line
+
+    unless lines.find { |line| line.start_with?("import StimulusReflex") }
       matches = lines.select { |line| line =~ /\A(require|import)/ }
       lines.insert lines.index(matches.last).to_i + 1, "import StimulusReflex from 'stimulus_reflex'\n"
     end
-    lines << "StimulusReflex.initialize(application)\n" unless initialize_line
+
+    unless lines.find { |line| line.start_with?("import consumer") }
+      matches = lines.select { |line| line =~ /\A(require|import)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "import consumer from '../channels/consumer'\n"
+    end
+
+    unless lines.find { |line| line.start_with?("import controller") }
+      matches = lines.select { |line| line =~ /\A(require|import)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "import controller from './application_controller'\n"
+    end
+
+    initialize_line = lines.find { |line| line.start_with?("StimulusReflex.initialize") }
+    lines << "StimulusReflex.initialize(application, { consumer, controller, debug: false })\n" unless initialize_line
     File.open(filepath, "w") { |f| f.write lines.join }
 
     filepath = Rails.root.join("config/environments/development.rb")

data/test/generators/stimulus_reflex_generator_test.rb

@@ -8,11 +8,19 @@ class StimulusReflexGeneratorTest < Rails::Generators::TestCase
   destination File.expand_path("../../tmp", __FILE__)
   setup :prepare_destination
 
-  test "creates named controller and reflex files" do
+  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/reflexes/application_reflex.rb"
     assert_file "app/reflexes/demo_reflex.rb", /DemoReflex/
   end
+
+  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/reflexes/application_reflex.rb"
+    assert_file "app/reflexes/posts_reflex.rb", /PostsReflex/
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.2.0.pre0
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -197,11 +197,11 @@ 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.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Build reactive applications with the Rails tooling you already know and love.