stimulus_reflex 3.4.0.pre3 → 3.4.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 344e0b60c7f18f467821263a5758cc37843cfae000430754ed89d34214363ff3
-  data.tar.gz: a49f8d18df8d0e2f4d664a70690fd562fd7d4fcc9db3f22d7821f96f67dee03d
+  metadata.gz: 1d3b9110da6cd9d446b19c1bd8ac2978b1d8b0c5ca88d1a1cf9fb849400a1757
+  data.tar.gz: 5512ece82357de04c62f9c4fcff9bba59bf6dec9f9234effeb06772084e96d38
 SHA512:
-  metadata.gz: cd85f6455c20f2cad48a8e4c7bda0fe6e46e50fa6bb39d2c67c128a899edd96d815798b913b928ae08c75fb8f55421483249f6acec34e26428a7114fa7e3eb67
-  data.tar.gz: 3fbb2e6be0b867db5c05997aa0727642e0298d0c13ad14e31c3f811ca4e6b4188db5154ea0c7ada5aeca8a3fb456c6998e35d0f4616e3fa03c636fc710b33056
+  metadata.gz: 928a0b20cc704cb30a1a9c7ccfe7672cc44c2e8cce2f9387b87ddc531981b2521e926992271233fb18e7787121bcda84e4f90c64823d32f5c2824ad302ba24e4
+  data.tar.gz: da166747c83c5dfee363e6a9475826cb32d3ba850f997481539cfdd475e390614e7726083bdf7e18762f410d4b74ff8b031922a66647498937d065479e939002

data/CHANGELOG.md

@@ -2,7 +2,34 @@
 
 ## [Unreleased](https://github.com/hopsoft/stimulus_reflex/tree/HEAD)
 
-[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.4.0.pre2...HEAD)
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.4.0.pre3...HEAD)
+
+**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:**
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (3.4.0.pre3)
+    stimulus_reflex (3.4.0.pre4)
+      cable_ready (>= 4.3.0)
       nokogiri
       rack
       rails (>= 5.2)
@@ -72,7 +73,7 @@ GEM
     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)
@@ -131,7 +132,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.2.2)
+    redis (4.2.4)
     regexp_parser (1.8.2)
     rexml (3.2.4)
     rubocop (1.2.0)
@@ -176,7 +177,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  cable_ready (>= 4.3.0)
   pry
   pry-nav
   rake

data/app/channels/stimulus_reflex/channel.rb

@@ -37,9 +37,14 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
           element: element,
           selectors: selectors,
           method_name: method_name,
-          permanent_attribute_name: permanent_attribute_name,
           params: params,
-          reflex_id: data["reflexId"])
+          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)
@@ -48,7 +53,7 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
           reflex.rescue_with_handler(invoke_error)
           reflex.broadcast_message subject: "error", body: body, data: data, error: invoke_error
         else
-          logger.error "\e[31m#{body}\e[0m"
+          puts "\e[31m#{body}\e[0m"
         end
         return
       end
@@ -63,10 +68,14 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
           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
-      commit_session reflex if reflex
+      if reflex
+        commit_session(reflex)
+        reflex.logger.print
+      end
     end
   end
 
@@ -101,7 +110,7 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
     store.commit_session reflex.request, reflex.controller.response
   rescue => e
     message = "Failed to commit session! #{exception_message_with_backtrace(e)}"
-    logger.error "\e[31m#{message}\e[0m"
+    puts "\e[31m#{message}\e[0m"
   end
 
   def exception_message_with_backtrace(exception)

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

@@ -3,8 +3,18 @@
 StimulusReflex.configure do |config|
   # 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

data/lib/stimulus_reflex/broadcasters/page_broadcaster.rb

@@ -8,9 +8,10 @@ module StimulusReflex
 
       return unless page_html.present?
 
-      document = Nokogiri::HTML(page_html)
+      document = Nokogiri::HTML.parse(page_html)
       selectors = selectors.select { |s| document.css(s).present? }
       selectors.each do |selector|
+        @operations << [selector, :morph]
         html = document.css(selector).inner_html
         cable_ready[stream_name].morph(
           selector: selector,
@@ -32,5 +33,9 @@ module StimulusReflex
     def page?
       true
     end
+
+    def to_s
+      "Page"
+    end
   end
 end

data/lib/stimulus_reflex/broadcasters/selector_broadcaster.rb

@@ -11,6 +11,7 @@ module StimulusReflex
           fragment = Nokogiri::HTML.fragment(html)
           match = fragment.at_css(selector)
           if match.present?
+            @operations << [selector, :morph]
             cable_ready[stream_name].morph(
               selector: selector,
               html: match.inner_html,
@@ -21,6 +22,7 @@ module StimulusReflex
               })
             )
           else
+            @operations << [selector, :inner_html]
             cable_ready[stream_name].inner_html(
               selector: selector,
               html: fragment.to_html,
@@ -40,6 +42,10 @@ module StimulusReflex
       @morphs ||= []
     end
 
+    def append_morph(selectors, html)
+      morphs << [selectors, html]
+    end
+
     def to_sym
       :selector
     end
@@ -47,5 +53,9 @@ module StimulusReflex
     def selector?
       true
     end
+
+    def to_s
+      "Selector"
+    end
   end
 end

data/lib/stimulus_reflex/configuration.rb

@@ -14,11 +14,14 @@ module StimulusReflex
   end
 
   class Configuration
-    attr_accessor :on_failed_sanity_checks, :parent_channel
+    attr_accessor :on_failed_sanity_checks, :parent_channel, :logging
+
+    DEFAULT_LOGGING = proc { "[#{session_id}] #{operation_counter.magenta} #{reflex_info.green} -> #{selector.cyan} via #{mode} Morph (#{operation.yellow})" }
 
     def initialize
       @on_failed_sanity_checks = :exit
       @parent_channel = "ApplicationCable::Channel"
+      @logging = DEFAULT_LOGGING
     end
   end
 end

data/lib/stimulus_reflex/logger.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module StimulusReflex
+  class Logger
+    attr_accessor :reflex, :current_operation
+
+    def initialize(reflex)
+      @reflex = reflex
+      @current_operation = 1
+    end
+
+    def print
+      return unless config_logging.instance_of?(Proc)
+
+      puts
+      reflex.broadcaster.operations.each do
+        puts instance_eval(&config_logging) + "\e[0m"
+        @current_operation += 1
+      end
+      puts
+    end
+
+    private
+
+    def config_logging
+      return @config_logging if @config_logging
+
+      StimulusReflex.config.logging.binding.eval("using StimulusReflex::Utils::Colorize")
+      @config_logging = StimulusReflex.config.logging
+    end
+
+    def session_id_full
+      session = reflex.request&.session
+      session.nil? ? "-" : session.id
+    end
+
+    def session_id
+      session_id_full.to_s[0..7]
+    end
+
+    def reflex_info
+      reflex.class.to_s + "#" + reflex.method_name
+    end
+
+    def reflex_id_full
+      reflex.reflex_id
+    end
+
+    def reflex_id
+      reflex_id_full[0..7]
+    end
+
+    def mode
+      reflex.broadcaster.to_s
+    end
+
+    def selector
+      reflex.broadcaster.operations[current_operation - 1][0]
+    end
+
+    def operation
+      reflex.broadcaster.operations[current_operation - 1][1].to_s
+    end
+
+    def operation_counter
+      current_operation.to_s + "/" + reflex.broadcaster.operations.size.to_s
+    end
+
+    def connection_id_full
+      identifier = reflex.connection&.connection_identifier
+      identifier.empty? ? "-" : identifier
+    end
+
+    def connection_id
+      connection_id_full[0..7]
+    end
+
+    def timestamp
+      Time.now.strftime("%Y-%m-%d %H:%M:%S")
+    end
+
+    def method_missing method
+      return send(method.to_sym) if private_instance_methods.include?(method.to_sym)
+
+      reflex.connection.identifiers.each do |identifier|
+        ident = reflex.connection.send(identifier)
+        return ident.send(method) if ident.respond_to?(:attributes) && ident.attributes.key?(method.to_s)
+      end
+      "-"
+    end
+
+    def respond_to_missing? method
+      return true if private_instance_methods.include?(method.to_sym)
+
+      reflex.connection.identifiers.each do |identifier|
+        ident = reflex.connection.send(identifier)
+        return true if ident.respond_to?(:attributes) && ident.attributes.key?(method.to_s)
+      end
+      false
+    end
+
+    def private_instance_methods
+      StimulusReflex::Logger.private_instance_methods(false)
+    end
+  end
+end

data/lib/stimulus_reflex/reflex.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+ClientAttributes = Struct.new(:reflex_id, :reflex_controller, :xpath, :c_xpath, :permanent_attribute_name, keyword_init: true)
+
 class StimulusReflex::Reflex
   include ActiveSupport::Rescuable
   include ActiveSupport::Callbacks
@@ -43,24 +45,25 @@ class StimulusReflex::Reflex
     end
   end
 
-  attr_reader :channel, :url, :element, :selectors, :method_name, :broadcaster, :permanent_attribute_name, :reflex_id
+  attr_reader :channel, :url, :element, :selectors, :method_name, :broadcaster, :client_attributes, :logger
 
   alias_method :action_name, :method_name # for compatibility with controller libraries like Pundit that expect an action name
 
   delegate :connection, :stream_name, to: :channel
   delegate :flash, :session, to: :request
   delegate :broadcast, :broadcast_message, to: :broadcaster
+  delegate :reflex_id, :reflex_controller, :xpath, :c_xpath, :permanent_attribute_name, to: :client_attributes
 
-  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, permanent_attribute_name: nil, params: {}, reflex_id: nil)
+  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, params: {}, client_attributes: {})
     @channel = channel
     @url = url
     @element = element
     @selectors = selectors
     @method_name = method_name
     @params = params
-    @permanent_attribute_name = permanent_attribute_name
     @broadcaster = StimulusReflex::PageBroadcaster.new(self)
-    @reflex_id = reflex_id
+    @logger = StimulusReflex::Logger.new(self)
+    @client_attributes = ClientAttributes.new(client_attributes)
     self.params
   end
 
@@ -105,7 +108,7 @@ class StimulusReflex::Reflex
     else
       raise StandardError.new("Cannot call :selector morph after :nothing morph") if broadcaster.nothing?
       @broadcaster = StimulusReflex::SelectorBroadcaster.new(self) unless broadcaster.selector?
-      broadcaster.morphs << [selectors, html]
+      broadcaster.append_morph(selectors, html)
     end
   end
 

data/lib/stimulus_reflex/sanity_checker.rb

@@ -3,12 +3,21 @@
 class StimulusReflex::SanityChecker
   JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
 
-  def self.check!
-    return if StimulusReflex.config.on_failed_sanity_checks == :ignore
+  class << self
+    def check!
+      return if StimulusReflex.config.on_failed_sanity_checks == :ignore
+      return if called_by_generate_config?
+
+      instance = new
+      instance.check_caching_enabled
+      instance.check_javascript_package_version
+    end
+
+    private
 
-    instance = new
-    instance.check_caching_enabled
-    instance.check_javascript_package_version
+    def called_by_generate_config?
+      ARGV.include? "stimulus_reflex:config"
+    end
   end
 
   def check_caching_enabled