stimulus_reflex 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f261317eba89f3aca406db338af66069b57121ef68188dd32c22a8b263c84c0d
-  data.tar.gz: 16ead06810e664961d5d0bea297a82bfd109616c363eecb63e2211efbe0718e0
+  metadata.gz: 225d5ebaf25744294ea11566c1b1ea792b19141ec56d10a2017eb39407a1b346
+  data.tar.gz: 2d4afe1de7f8fd3e4f4d12fb29f4c51088713b69303b4c905c8a6cb1ad0385a9
 SHA512:
-  metadata.gz: 43c62ef1ddec489d525dd429a78ee0113b215918ac4fa95192cf75fafe356b42705e775b29ccfa2ddf193833b3bc42d5e736828d97234353e2ae06bdd929bd63
-  data.tar.gz: 0b5870db51f39af566c2eda1a574783dba205b9f37d1c07083d82a5df6ef6a0a63dde0b43ee0881492155715e945926452f529677b7951d10f27228471a80097
+  metadata.gz: c5bd0958b9eaabe325c8c65d81bead836dfb182f43059ea786a941eb9268920efbad8be79498e53bd97529bdea13fc2f24a382ceebf97a81c8ebcf70523d753d
+  data.tar.gz: 49c2bea2d9f35a3722c7e3cd4824441623a4660e46d0754a12906dcfe552c0474222af076f4bc096b89da45f1a3f3b4a0521270ab9f9856e069ad96325e1a9b5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (2.1.2)
+    stimulus_reflex (2.1.3)
       cable_ready (>= 4.0.7)
       nokogiri
       rack

data/README.md

@@ -1,4 +1,4 @@
-[![Lines of Code](http://img.shields.io/badge/lines_of_code-465-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-516-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2b24fdbd1ae37a24bedb/maintainability)](https://codeclimate.com/github/hopsoft/stimulus_reflex/maintainability)
 ![Prettier-Standard](https://github.com/hopsoft/stimulus_reflex/workflows/Prettier-Standard/badge.svg)
 ![StandardRB](https://github.com/hopsoft/stimulus_reflex/workflows/StandardRB/badge.svg)

data/Rakefile

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rails/test_unit/runner"
 
 task default: [:test]
 
-task :test do
-  exec "cd javascript && yarn run test"
+task :test do |task|
+  return 1 unless system("cd javascript && yarn run test")
+  Rails::TestUnit::Runner.run
+end
+
+task :test_ruby do |task|
+  Rails::TestUnit::Runner.run
 end

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/standardize

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 
 bundle exec standardrb --fix
-cd ./javascript && yarn run prettier-standard stimulus_reflex.js test/*.js
+cd ./javascript && yarn run prettier-standard --lint javascript/*.js test/*.js

data/lib/generators/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generate boilerplate files to help get you up and running with StimulusReflex
+
+Example:
+    rails generate stimulus_reflex User
+
+    This will create, but not overwrite the following files:
+
+        app/javascript/controllers/application_controller.js
+        app/javascript/controllers/user_controller.js
+        app/reflexes/application_reflex.rb
+        app/reflexes/user_reflex.rb
+
+    Don't forget to setup the application: https://docs.stimulusreflex.com/setup

data/lib/generators/stimulus_reflex_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+class StimulusReflexGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def initialize_reflexes
+    copy_reflex_files
+  end
+
+  def initialize_controllers
+    copy_controller_files
+  end
+
+  private
+
+  CONTROLLER_BASE_PATH = "app/javascript/controllers"
+  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
+end

data/lib/generators/templates/application_controller.js

@@ -0,0 +1,59 @@
+import { Controller } from 'stimulus'
+import StimulusReflex from 'stimulus_reflex'
+
+/* This is your application's ApplicationController.
+ * All StimulusReflex controllers should inherit from this class.
+ *
+ * Example:
+ *
+ *   import ApplicationController from './application_controller'
+ *
+ *   export default class extends ApplicationController { ... }
+ *
+ * Learn more at: https://docs.stimulusreflex.com
+ */
+export default class extends Controller {
+  connect () {
+    StimulusReflex.register(this)
+  }
+
+  /* Application wide lifecycle methods.
+   * Use these methods to handle lifecycle concerns for the entire application.
+   * Using the lifecycle is optional, so feel free to delete these stubs if you don't need them.
+   *
+   * 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. "ExampleReflex#demo"
+   *
+   *   error - error message from the server
+   */
+
+  beforeReflex (element, reflex) {
+    // document.body.classList.add('wait')
+  }
+
+  reflexSuccess (element, reflex, error) {
+    // show success message etc...
+  }
+
+  reflexError (element, reflex, error) {
+    // show error message etc...
+  }
+
+  afterReflex (element, reflex) {
+    // document.body.classList.remove('wait')
+
+    const focusElement = this.element.querySelector('[autofocus]')
+    if (focusElement) {
+      focusElement.focus()
+
+      // shenanigans to ensure that the cursor is placed at the end of the existing value
+      const value = focusElement.value
+      focusElement.value = ''
+      focusElement.value = value
+    }
+  }
+}

data/lib/generators/templates/application_reflex.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class ApplicationReflex < StimulusReflex::Reflex
+  # Put application wide Reflex behavior in this file.
+  #
+  # Example:
+  #
+  #   # If your ActionCable connection is: `identified_by :current_user`
+  #   delegate :current_user, to: :channel
+  #
+  # Learn more at: https://docs.stimulusreflex.com
+end

data/lib/generators/templates/custom_controller.js

@@ -0,0 +1,37 @@
+import ApplicationController from './application_controller'
+
+/* This is the custom StimulusReflex controller for <%= @name.classify %>Reflex.
+ * Learn more at: https://docs.stimulusreflex.com
+ */
+export default class extends ApplicationController {
+  /* Reflex specific lifecycle methods.
+   * Use methods similar to this example to handle lifecycle concerns for a specific Reflex method.
+   * Using the lifecycle is optional, so feel free to delete these stubs if you don't need them.
+   *
+   * Example:
+   *
+   *   <a href="#" data-reflex="<%= @name.classify %>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"
+   *
+   *   error - error message from the server
+   */
+
+  // beforeUpdate(element, reflex) {
+  //  element.innerText = 'Updating...'
+  // }
+
+  // updateSuccess(element, reflex) {
+  //   element.innerText = 'Updated Successfully.'
+  // }
+
+  // updateError(element, reflex, error) {
+  //   console.error('updateError', error);
+  //   element.innerText = 'Updated Failed!'
+  // }
+}

data/lib/generators/templates/custom_reflex.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class <%= @name.classify %>Reflex < ApplicationReflex
+  # Add Reflex methods in this file.
+  #
+  # All Reflex instances expose the following properties:
+  #
+  #   - connection - the ActionCable connection
+  #   - channel - the ActionCable channel
+  #   - request - an ActionDispatch::Request proxy for the socket connection
+  #   - 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
+  #
+  # Example:
+  #
+  #   def example(argument=true)
+  #     # Your logic here...
+  #     # Any declared instance variables will be made available to the Rails controller and view.
+  #   end
+  #
+  # Learn more at: https://docs.stimulusreflex.com
+end

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 "generators/stimulus_reflex_generator"
 
 module StimulusReflex
   class Engine < Rails::Engine

data/lib/stimulus_reflex/channel.rb

@@ -19,7 +19,7 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
   def receive(data)
     url = data["url"].to_s
     selectors = (data["selectors"] || []).select(&:present?)
-    selectors = ["body"] if selectors.blank?
+    selectors = data["selectors"] = ["body"] if selectors.blank?
     target = data["target"].to_s
     reflex_name, method_name = target.split("#")
     reflex_name = reflex_name.classify
@@ -100,15 +100,14 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
 
   def broadcast_morphs(selectors, data, html)
     document = Nokogiri::HTML(html)
+    selectors = selectors.select { |s| document.css(s).present? }
     selectors.each do |selector|
-      match = document.css(selector)
-      next if match.blank?
       cable_ready[stream_name].morph(
         selector: selector,
-        html: match.inner_html,
+        html: document.css(selector).inner_html,
         children_only: true,
         permanent_attribute_name: "data-reflex-permanent",
-        stimulus_reflex: data
+        stimulus_reflex: data.merge(last: selector == selectors.last)
       )
     end
     cable_ready.broadcast

data/lib/stimulus_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusReflex
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end

data/lib/tasks/stimulus_reflex/install.rake

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+namespace :stimulus_reflex do
+  desc "Install StimulusReflex in this application"
+  task install: :environment do
+    system "bundle exec rails webpacker:install:stimulus"
+    system "yarn add stimulus_reflex"
+
+    FileUtils.mkdir_p Rails.root.join("app/javascript/controllers"), verbose: true
+    FileUtils.mkdir_p Rails.root.join("app/reflexes"), verbose: true
+
+    filepath = Rails.root.join("app/javascript/controllers/index.js")
+    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
+      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
+    File.open(filepath, "w") { |f| f.write lines.join }
+
+    system "bundle exec rails generate stimulus_reflex example"
+  end
+end

data/test/generators/stimulus_reflex_generator_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators/test_case"
+require_relative "../test_helper"
+
+class StimulusReflexGeneratorTest < Rails::Generators::TestCase
+  tests StimulusReflexGenerator
+  destination File.expand_path("../../tmp", __FILE__)
+  setup :prepare_destination
+
+  test "creates 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
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../lib/stimulus_reflex"

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class ApplicationReflex < StimulusReflex::Reflex
+  # Put application wide Reflex behavior in this file.
+  #
+  # Example:
+  #
+  #   # If your ActionCable connection is: `identified_by :current_user`
+  #   delegate :current_user, to: :channel
+  #
+  # Learn more at: https://docs.stimulusreflex.com
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class DemoReflex < ApplicationReflex
+  # Add Reflex methods in this file.
+  #
+  # All Reflex instances expose the following properties:
+  #
+  #   - connection - the ActionCable connection
+  #   - channel - the ActionCable channel
+  #   - request - an ActionDispatch::Request proxy for the socket connection
+  #   - 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
+  #
+  # Example:
+  #
+  #   def example(argument=true)
+  #     # Your logic here...
+  #     # Any declared instance variables will be made available to the Rails controller and view.
+  #   end
+  #
+  # Learn more at: https://docs.stimulusreflex.com
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Nathan Hopkins
-- Ron Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2019-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -140,7 +139,6 @@ dependencies:
 description: 
 email:
 - natehop@gmail.com
-- brasco@thebrascode.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -153,13 +151,25 @@ files:
 - Rakefile
 - bin/console
 - bin/loc
+- bin/rake
 - bin/setup
 - bin/standardize
+- lib/generators/USAGE
+- lib/generators/stimulus_reflex_generator.rb
+- lib/generators/templates/application_controller.js
+- lib/generators/templates/application_reflex.rb
+- lib/generators/templates/custom_controller.js
+- lib/generators/templates/custom_reflex.rb
 - lib/stimulus_reflex.rb
 - lib/stimulus_reflex/channel.rb
 - lib/stimulus_reflex/element.rb
 - lib/stimulus_reflex/reflex.rb
 - lib/stimulus_reflex/version.rb
+- lib/tasks/stimulus_reflex/install.rake
+- test/generators/stimulus_reflex_generator_test.rb
+- test/test_helper.rb
+- test/tmp/app/reflexes/application_reflex.rb
+- test/tmp/app/reflexes/demo_reflex.rb
 homepage: https://github.com/hopsoft/stimulus_reflex
 licenses:
 - MIT
@@ -182,5 +192,9 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Build reactive Single Page Applications (SPAs) with Rails and Stimulus
-test_files: []
+summary: Build reactive applications with the Rails tooling you already know and love.
+test_files:
+- test/test_helper.rb
+- test/generators/stimulus_reflex_generator_test.rb
+- test/tmp/app/reflexes/demo_reflex.rb
+- test/tmp/app/reflexes/application_reflex.rb