stimulus_reflex 3.4.0.pre0 → 3.4.0.pre5

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 :exit_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
-      @exit_on_failed_sanity_checks = true
+      @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,23 +45,25 @@ class StimulusReflex::Reflex
     end
   end
 
-  attr_reader :channel, :url, :element, :selectors, :method_name, :broadcaster, :permanent_attribute_name
+  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: {})
+  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)
+    @logger = StimulusReflex::Logger.new(self)
+    @client_attributes = ClientAttributes.new(client_attributes)
     self.params
   end
 
@@ -104,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,10 +3,21 @@
 class StimulusReflex::SanityChecker
   JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
 
-  def self.check!
-    instance = new
-    instance.check_caching_enabled
-    instance.check_javascript_package_version
+  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
+
+    def called_by_generate_config?
+      ARGV.include? "stimulus_reflex:config"
+    end
   end
 
   def check_caching_enabled
@@ -80,19 +91,50 @@ class StimulusReflex::SanityChecker
     Rails.root.join("node_modules", "stimulus_reflex", "package.json")
   end
 
+  def initializer_path
+    @_initializer_path ||= Rails.root.join("config", "initializers", "stimulus_reflex.rb")
+  end
+
   def warn_and_exit(text)
     puts "WARNING:"
     puts text
-    exit_with_info if StimulusReflex.config.exit_on_failed_sanity_checks
+    exit_with_info if StimulusReflex.config.on_failed_sanity_checks == :exit
   end
 
   def exit_with_info
     puts
-    puts <<~INFO
-      If you know what you are doing and you want to start the application anyway,
-      you can add the following directive to an initializer:
-            StimulusReflex.config.exit_on_failed_sanity_checks = false
-    INFO
-    exit
+
+    # bundle exec rails generate stimulus_reflex:config
+    if File.exist?(initializer_path)
+      puts <<~INFO
+        If you know what you are doing and you want to start the application anyway,
+        you can add the following directive to the StimulusReflex initializer,
+        which is located at #{initializer_path}
+
+          StimulusReflex.configure do |config|
+            config.on_failed_sanity_checks = :warn
+          end
+
+      INFO
+    else
+      puts <<~INFO
+        If you know what you are doing and you want to start the application anyway,
+        you can create a StimulusReflex initializer with the command:
+      
+        bundle exec rails generate stimulus_reflex:config
+      
+        Then open your initializer at
+      
+        <RAILS_ROOT>/config/initializers/stimulus_reflex.rb
+      
+        and then add the following directive:
+
+          StimulusReflex.configure do |config|
+            config.on_failed_sanity_checks = :warn
+          end
+
+      INFO
+    end
+    exit false
   end
 end

data/lib/stimulus_reflex/utils/colorize.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module StimulusReflex
+  module Utils
+    module Colorize
+      COLORS = {
+        red: "31",
+        green: "32",
+        yellow: "33",
+        blue: "34",
+        magenta: "35",
+        cyan: "36",
+        white: "37"
+      }
+
+      refine String do
+        COLORS.each do |name, code|
+          define_method(name) { "\e[#{code}m#{self}\e[0m" }
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_reflex/version.rb

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

data/lib/tasks/stimulus_reflex/install.rake

@@ -8,7 +8,7 @@ namespace :stimulus_reflex do
   task install: :environment do
     system "bundle exec rails webpacker:install:stimulus"
     gem_version = StimulusReflex::VERSION.gsub(".pre", "-pre")
-    system "yarn add cable_ready stimulus_reflex@#{gem_version}"
+    system "yarn add stimulus_reflex@#{gem_version}"
     main_folder = defined?(Webpacker) ? Webpacker.config.source_path.to_s.gsub("#{Rails.root}/", "") : "app/javascript"
 
     FileUtils.mkdir_p Rails.root.join("#{main_folder}/controllers"), verbose: true
@@ -60,11 +60,12 @@ namespace :stimulus_reflex do
       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"
+      lines.insert 3, "  channel_prefix: " + File.basename(Rails.root.to_s).underscore + "_development\n"
       File.open(filepath, "w") { |f| f.write lines.join }
     end
 
     system "bundle exec rails generate stimulus_reflex example"
+    puts "Generating default StimulusReflex configuration file into your application config/initializers directory"
     system "bundle exec rails generate stimulus_reflex:config"
     system "rails dev:cache" unless Rails.root.join("tmp", "caching-dev.txt").exist?
   end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stimulus_reflex",
-  "version": "3.3.0",
+  "version": "3.4.0-pre4",
   "description": "Build reactive applications with the Rails tooling you already know and love.",
   "keywords": [
     "ruby",
@@ -28,34 +28,28 @@
   },
   "license": "MIT",
   "author": "Nathan Hopkins <natehop@gmail.com>",
-  "source": "javascript/stimulus_reflex.js",
-  "main": "javascript/dist/stimulus_reflex.js",
-  "module": "javascript/dist/stimulus_reflex.module.js",
-  "esmodule": "javascript/dist/stimulus_reflex.modern.js",
+  "main": "./javascript/stimulus_reflex.js",
+  "module": "./javascript/stimulus_reflex.js",
   "scripts": {
-    "prepare": "yarn build",
-    "postinstall": "node javascript/scripts/post_install.js",
-    "prettier-standard:check": "yarn run prettier-standard --check *.js **/*.js",
-    "prettier-standard:format": "yarn run prettier-standard *.js **/*.js",
-    "test": "yarn run mocha --require @babel/register --require esm ./javascript/test",
-    "build": "microbundle --target browser --format modern,es,cjs --no-strict",
-    "dev": "microbundle watch --target browser --format modern,es,cjs --no-strict"
+    "postinstall": "node ./javascript/scripts/post_install.js",
+    "prettier-standard:check": "yarn run prettier-standard --check ./javascript/*.js ./javascript/**/*.js",
+    "prettier-standard:format": "yarn run prettier-standard ./javascript/*.js ./javascript/**/*.js",
+    "test": "yarn run mocha --require @babel/register --require esm ./javascript/test"
   },
   "peerDependencies": {
-    "@rails/actioncable": ">= 6.0",
-    "cable_ready": ">= 4.3.0",
     "stimulus": ">= 1.1"
   },
+  "dependencies": {
+    "@rails/actioncable": ">= 6.0",
+    "cable_ready": ">= 4.3.0"
+  },
   "devDependencies": {
     "@babel/core": "^7.6.2",
     "@babel/preset-env": "^7.6.2",
     "@babel/register": "^7.6.2",
-    "@rails/actioncable": "^6.0.3-3",
     "assert": "^2.0.0",
-    "cable_ready": "^4.4.0-pre2",
     "esm": "^3.2.25",
     "jsdom": "^16.0.1",
-    "microbundle": "^0.12.3",
     "mocha": "^8.0.1",
     "prettier-standard": "^16.1.0",
     "stimulus": "^1.1.1"

data/stimulus_reflex.gemspec

@@ -23,14 +23,14 @@ Gem::Specification.new do |gem|
     "source_code_uri" => gem.homepage
   }
 
-  gem.files = Dir["lib/**/*", "bin/*", "[A-Z]*"]
+  gem.files = Dir["app/**/*", "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.3.0"
   gem.add_dependency "redis"
+  gem.add_dependency "cable_ready", ">= 4.3.0"
 
   gem.add_development_dependency "bundler", "~> 2.0"
   gem.add_development_dependency "pry-nav"

data/test/broadcasters/broadcaster_test.rb

@@ -0,0 +1,15 @@
+require_relative "../test_helper"
+
+class StimulusReflex::BroadcasterTest < ActiveSupport::TestCase
+  setup do
+    @reflex = Minitest::Mock.new
+    @reflex.expect :stream_name, "TestStream"
+  end
+
+  test "raises a NotImplementedError if called directly" do
+    broadcaster = StimulusReflex::Broadcaster.new(@reflex)
+
+    assert_raises(NotImplementedError) { broadcaster.broadcast }
+    assert_raises(NotImplementedError) { broadcaster.broadcast_message(subject: "Test") }
+  end
+end