stimulus_reflex 3.3.0.pre5 → 3.3.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc5d928ba770cb4cb0e167431b216953d3d024f60797ceeba8cb1e941c321f2f
-  data.tar.gz: 21ecfef7c3b45524547905728b8dffe13317f76e07685f1c41e9eb59ad20f1aa
+  metadata.gz: 7c8542f86c6a95d6528f7c9838c8ca9084c7ebb938e0d1271837e3dfd1d34219
+  data.tar.gz: 2881c8a442b7854dda4c6ac1625d9b8466997c5175bcc4ee319aa0bfb5a95153
 SHA512:
-  metadata.gz: d89100f1ae64da55040f3ed0435832f593b67ff78631def4bfbf2a02c6eb577b6803ad9ae84760d123e2b5e85a9e52a1d1923a5949b4c76ccdcb82489671d0e4
-  data.tar.gz: 7d1c3c338457b2f7c8895726cc381c273aec9c7b65158409dc6e2d7d146cd8d1c51102783dda302e241a207a8c09fd0ebd92b850d96f3bbf0c2e884700bf55e7
+  metadata.gz: 9efb56d48030a6b2264f9db47330baee93d47407b90e021c49a77ff6339d382a767089ec02b6c2adad40ce965332fe1457e8e30dadfdf8f38e9a9c15d8f16d58
+  data.tar.gz: 52d7ee2200946cfec45758f224acbb354e2aee5eab4ad4a7cddcdcbc3d4ba34afba461876c63bfe8dffaabde2f9527f5093ad9560b789158510b8acf74b7242a

data/CHANGELOG.md

@@ -2,7 +2,27 @@
 
 ## [Unreleased](https://github.com/hopsoft/stimulus_reflex/tree/HEAD)
 
-[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.3.0.pre4...HEAD)
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.3.0.pre5...HEAD)
+
+**Implemented enhancements:**
+
+- Support for token-based authentication [\#243](https://github.com/hopsoft/stimulus_reflex/pull/243) ([leastbad](https://github.com/leastbad))
+
+**Closed issues:**
+
+- Authorization [\#292](https://github.com/hopsoft/stimulus_reflex/issues/292)
+- Params incorrect for form submitted for nested resource  [\#290](https://github.com/hopsoft/stimulus_reflex/issues/290)
+- Use set I18n.locale in Reflexes with Selector Morphs  [\#280](https://github.com/hopsoft/stimulus_reflex/issues/280)
+
+**Merged pull requests:**
+
+- fixes and tweaks to client logging subsystem [\#313](https://github.com/hopsoft/stimulus_reflex/pull/313) ([leastbad](https://github.com/leastbad))
+- add ready event after setupDeclarativeReflexes [\#312](https://github.com/hopsoft/stimulus_reflex/pull/312) ([leastbad](https://github.com/leastbad))
+- Refactor sanity checks on boot [\#311](https://github.com/hopsoft/stimulus_reflex/pull/311) ([excid3](https://github.com/excid3))
+
+## [v3.3.0.pre5](https://github.com/hopsoft/stimulus_reflex/tree/v3.3.0.pre5) (2020-09-18)
+
+[Full Changelog](https://github.com/hopsoft/stimulus_reflex/compare/v3.3.0.pre4...v3.3.0.pre5)
 
 **Implemented enhancements:**
 
@@ -486,7 +506,9 @@
 **Implemented enhancements:**
 
 - Custom Stimulus schema breaks Reflex [\#91](https://github.com/hopsoft/stimulus_reflex/issues/91)
+- Add schema support [\#94](https://github.com/hopsoft/stimulus_reflex/pull/94) ([hopsoft](https://github.com/hopsoft))
 - inherit stimulus schema [\#92](https://github.com/hopsoft/stimulus_reflex/pull/92) ([nickyvanurk](https://github.com/nickyvanurk))
+- Single source of truth [\#76](https://github.com/hopsoft/stimulus_reflex/pull/76) ([leastbad](https://github.com/leastbad))
 
 **Fixed bugs:**
 
@@ -505,7 +527,6 @@
 
 **Implemented enhancements:**
 
-- Single source of truth [\#76](https://github.com/hopsoft/stimulus_reflex/pull/76) ([leastbad](https://github.com/leastbad))
 - Add CodeFund sponsorship [\#75](https://github.com/hopsoft/stimulus_reflex/pull/75) ([coderberry](https://github.com/coderberry))
 
 **Fixed bugs:**
@@ -519,11 +540,9 @@
 **Implemented enhancements:**
 
 - Create Rails generators [\#3](https://github.com/hopsoft/stimulus_reflex/issues/3)
-- Add schema support [\#94](https://github.com/hopsoft/stimulus_reflex/pull/94) ([hopsoft](https://github.com/hopsoft))
 - Update installer [\#71](https://github.com/hopsoft/stimulus_reflex/pull/71) ([hopsoft](https://github.com/hopsoft))
 - Tweak generators [\#69](https://github.com/hopsoft/stimulus_reflex/pull/69) ([hopsoft](https://github.com/hopsoft))
 - add generators [\#67](https://github.com/hopsoft/stimulus_reflex/pull/67) ([andrewmcodes](https://github.com/andrewmcodes))
-- Add reflex name to the lifecycle args [\#62](https://github.com/hopsoft/stimulus_reflex/pull/62) ([hopsoft](https://github.com/hopsoft))
 
 **Fixed bugs:**
 
@@ -552,6 +571,7 @@
 - Client side call-backs? [\#34](https://github.com/hopsoft/stimulus_reflex/issues/34)
 - Scoped register\(\)? [\#26](https://github.com/hopsoft/stimulus_reflex/issues/26)
 - Add guard to verify same URL prior to morph [\#63](https://github.com/hopsoft/stimulus_reflex/pull/63) ([hopsoft](https://github.com/hopsoft))
+- Add reflex name to the lifecycle args [\#62](https://github.com/hopsoft/stimulus_reflex/pull/62) ([hopsoft](https://github.com/hopsoft))
 - Refactor some helper methods out of main file [\#61](https://github.com/hopsoft/stimulus_reflex/pull/61) ([hopsoft](https://github.com/hopsoft))
 - Documentation update [\#58](https://github.com/hopsoft/stimulus_reflex/pull/58) ([leastbad](https://github.com/leastbad))
 - \# Support for data-reflex-permanent [\#57](https://github.com/hopsoft/stimulus_reflex/pull/57) ([hopsoft](https://github.com/hopsoft))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (3.3.0.pre4)
+    stimulus_reflex (3.3.0.pre5)
       cable_ready (>= 4.1.2)
       nokogiri
       rack

data/lib/stimulus_reflex.rb

@@ -12,6 +12,7 @@ require "stimulus_reflex/version"
 require "stimulus_reflex/reflex"
 require "stimulus_reflex/element"
 require "stimulus_reflex/channel"
+require "stimulus_reflex/sanity_checker"
 require "stimulus_reflex/broadcasters/broadcaster"
 require "stimulus_reflex/broadcasters/nothing_broadcaster"
 require "stimulus_reflex/broadcasters/page_broadcaster"
@@ -20,68 +21,8 @@ require "generators/stimulus_reflex_generator"
 
 module StimulusReflex
   class Engine < Rails::Engine
-    NODE_VERSION_FORMAT = /(\d\.\d\.\d.*):/
-    JSON_VERSION_FORMAT = /(\d\.\d\.\d.*)\"/
-
-    initializer "stimulus_reflex.verify_caching_enabled" do
-      unless caching_enabled?
-        puts <<~WARN
-          Stimulus Reflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
-          To enable caching in development, run:
-
-            rails dev:cache
-        WARN
-        exit
-      end
-    end
-
-    initializer "stimulus_reflex.verify_npm_package_version" do
-      unless node_version_matches?
-        puts <<~WARN
-          The Stimulus Reflex javascript package version (#{node_package_version}) does not match the Rubygem version (#{gem_version}).
-          To update the Stimulus Reflex node module:
-
-            yarn upgrade stimulus_reflex@#{gem_version}
-        WARN
-        exit
-      end
-    end
-
-    private
-
-    def caching_enabled?
-      Rails.application.config.action_controller.perform_caching &&
-        Rails.application.config.cache_store != :null_store
-    end
-
-    def node_version_matches?
-      node_package_version == gem_version
-    end
-
-    def gem_version
-      StimulusReflex::VERSION.gsub(".pre", "-pre")
-    end
-
-    def node_package_version
-      match = File.foreach(yarn_lock_path).grep(/^stimulus_reflex/)
-      return match.first[NODE_VERSION_FORMAT, 1] if match.present?
-
-      match = File.foreach(yarn_link_path).grep(/version/)
-      return match.first[JSON_VERSION_FORMAT, 1] if match.present?
-
-      puts <<~WARN
-        Can't locate the stimulus_reflex NPM package. 
-        Either add it to your package.json as a dependency or use "yarn link stimulus_reflex" if you are doing development.
-      WARN
-      exit
-    end
-
-    def yarn_lock_path
-      Rails.root.join("yarn.lock")
-    end
-
-    def yarn_link_path
-      Rails.root.join("node_modules", "stimulus_reflex", "package.json")
+    initializer "stimulus_reflex.sanity_check" do
+      SanityChecker.check!
     end
   end
 end

data/lib/stimulus_reflex/broadcasters/page_broadcaster.rb

@@ -18,7 +18,7 @@ module StimulusReflex
           children_only: true,
           permanent_attribute_name: permanent_attribute_name,
           stimulus_reflex: data.merge({
-            broadast_type: to_sym
+            broadcaster: to_sym
           })
         )
       end

data/lib/stimulus_reflex/broadcasters/selector_broadcaster.rb

@@ -17,7 +17,7 @@ module StimulusReflex
               children_only: true,
               permanent_attribute_name: permanent_attribute_name,
               stimulus_reflex: data.merge({
-                broadast_type: to_sym
+                broadcaster: to_sym
               })
             )
           else
@@ -25,7 +25,7 @@ module StimulusReflex
               selector: selector,
               html: fragment.to_html,
               stimulus_reflex: data.merge({
-                broadast_type: to_sym
+                broadcaster: to_sym
               })
             )
           end

data/lib/stimulus_reflex/channel.rb

@@ -1,6 +1,16 @@
 # frozen_string_literal: true
 
-class StimulusReflex::Channel < ActionCable::Channel::Base
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+    def initialize(connection, identifier, params = {})
+      super
+      application_channel = Rails.root.join("app", "channels", "application_cable", "channel.rb")
+      require application_channel if File.exist?(application_channel)
+    end
+  end
+end
+
+class StimulusReflex::Channel < ApplicationCable::Channel
   def stream_name
     ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
     [
@@ -10,6 +20,7 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
   end
 
   def subscribed
+    super
     stream_from stream_name
   end
 

data/lib/stimulus_reflex/sanity_checker.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+class StimulusReflex::SanityChecker
+  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
+  JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
+
+  def self.check!
+    instance = new
+    instance.check_caching_enabled
+    instance.check_javascript_package_version
+  end
+
+  def check_caching_enabled
+    unless caching_enabled?
+      puts <<~WARN
+        WARNING: Stimulus Reflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
+        To enable caching in development, run:
+            rails dev:cache
+      WARN
+    end
+  end
+
+  def check_javascript_package_version
+    if javascript_package_version.nil?
+      puts <<~WARN
+        WARNING: Can't locate the stimulus_reflex NPM package.
+        Either add it to your package.json as a dependency or use "yarn link stimulus_reflex" if you are doing development.
+      WARN
+    end
+
+    unless javascript_version_matches?
+      puts <<~WARN
+        WARNING: The Stimulus Reflex javascript package version (#{javascript_package_version}) does not match the Rubygem version (#{gem_version}).
+        To update the Stimulus Reflex npm package:
+            yarn upgrade stimulus_reflex@#{gem_version}
+      WARN
+    end
+  end
+
+  private
+
+  def caching_enabled?
+    Rails.application.config.action_controller.perform_caching &&
+      Rails.application.config.cache_store != :null_store
+  end
+
+  def javascript_version_matches?
+    javascript_package_version == gem_version
+  end
+
+  def gem_version
+    @_gem_version ||= StimulusReflex::VERSION.gsub(".pre", "-pre")
+  end
+
+  def javascript_package_version
+    return @_js_version if defined?(@_js_version)
+    @_js_version = find_javascript_package_version
+  end
+
+  def find_javascript_package_version
+    if (match = search_file(yarn_lock_path, regex: /^stimulus_reflex/))
+      match[NODE_VERSION_FORMAT, 1]
+    elsif (match = search_file(yarn_link_path, regex: /version/))
+      match[JSON_VERSION_FORMAT, 1]
+    end
+  end
+
+  def search_file(path, regex:)
+    return unless File.exist?(path)
+    File.foreach(path).grep(regex).first
+  end
+
+  def yarn_lock_path
+    Rails.root.join("yarn.lock")
+  end
+
+  def yarn_link_path
+    Rails.root.join("node_modules", "stimulus_reflex", "package.json")
+  end
+end

data/lib/stimulus_reflex/version.rb

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

data/test/generators/stimulus_reflex_generator_test.rb

@@ -11,7 +11,7 @@ class StimulusReflexGeneratorTest < Rails::Generators::TestCase
   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/javascript/controllers/demo_controller.js", /Demo/
     assert_file "app/reflexes/application_reflex.rb"
     assert_file "app/reflexes/demo_reflex.rb", /DemoReflex/
   end
@@ -19,7 +19,7 @@ class StimulusReflexGeneratorTest < Rails::Generators::TestCase
   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/javascript/controllers/posts_controller.js", /Posts/
     assert_file "app/reflexes/application_reflex.rb"
     assert_file "app/reflexes/posts_reflex.rb", /PostsReflex/
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex
 version: !ruby/object:Gem::Version
-  version: 3.3.0.pre5
+  version: 3.3.0.pre6
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -183,6 +183,7 @@ files:
 - lib/stimulus_reflex/channel.rb
 - lib/stimulus_reflex/element.rb
 - lib/stimulus_reflex/reflex.rb
+- lib/stimulus_reflex/sanity_checker.rb
 - lib/stimulus_reflex/version.rb
 - lib/tasks/stimulus_reflex/install.rake
 - test/generators/stimulus_reflex_generator_test.rb