stimulus_reflex 3.4.1 → 3.5.0.pre3

data/test/element_test.rb

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+
+class StimulusReflex::ElementTest < ActiveSupport::TestCase
+  element = StimulusReflex::Element.new({
+    "attrs" => {
+      "user" => "First User",
+      "user-id" => "1"
+    },
+    "dataset" => {
+      "dataset" => {
+        "data-post" => "The Post",
+        "data-post-id" => "2"
+      },
+      "datasetAll" => {}
+    }
+  })
+
+  test "should be able to access attributes on element itself" do
+    assert_equal "First User", element.user
+    assert_equal "First User", element["user"]
+    assert_equal "First User", element[:user]
+
+    assert_equal "1", element.user_id
+    assert_equal "1", element["user_id"]
+    assert_equal "1", element["user-id"]
+    assert_equal "1", element[:user_id]
+
+    assert_equal "The Post", element.data_post
+    assert_equal "The Post", element["data_post"]
+    assert_equal "The Post", element["data-post"]
+    assert_equal "The Post", element[:data_post]
+
+    assert_equal "2", element.data_post_id
+    assert_equal "2", element["data_post_id"]
+    assert_equal "2", element["data-post-id"]
+    assert_equal "2", element[:data_post_id]
+  end
+
+  test "should be able to access attributes via attributes" do
+    assert_equal "First User", element.attributes.user
+    assert_equal "First User", element.attributes["user"]
+    assert_equal "First User", element.attributes[:user]
+
+    assert_equal "1", element.attributes.user_id
+    assert_equal "1", element.attributes["user_id"]
+    assert_equal "1", element.attributes["user-id"]
+    assert_equal "1", element.attributes[:user_id]
+  end
+
+  test "should be able to access attributes via dataset" do
+    assert_equal "The Post", element.dataset.post
+    assert_equal "The Post", element.dataset["post"]
+    assert_equal "The Post", element.dataset[:post]
+
+    assert_equal "2", element.dataset.post_id
+    assert_equal "2", element.dataset["post-id"]
+    assert_equal "2", element.dataset["post_id"]
+    assert_equal "2", element.dataset[:post_id]
+  end
+
+  test "should be able to access attributes via data_attributes" do
+    assert_equal "The Post", element.data_attributes.post
+    assert_equal "The Post", element.data_attributes["post"]
+    assert_equal "The Post", element.data_attributes[:post]
+
+    assert_equal "2", element.data_attributes.post_id
+    assert_equal "2", element.data_attributes["post-id"]
+    assert_equal "2", element.data_attributes["post_id"]
+    assert_equal "2", element.data_attributes[:post_id]
+  end
+
+  test "should pluralize keys from datasetAll" do
+    data = {
+      "dataset" => {
+        "dataset" => {
+          "data-reflex" => "click",
+          "data-sex" => "male"
+        },
+        "datasetAll" => {
+          "data-reflex" => ["click"],
+          "data-post-id" => ["1", "2", "3", "4"],
+          "data-name" => ["steve", "bill", "steve", "mike"]
+        }
+      }
+    }
+
+    dataset_all_element = StimulusReflex::Element.new(data)
+
+    assert_equal "click", dataset_all_element.dataset.reflex
+    assert_equal "male", dataset_all_element.dataset.sex
+
+    assert_equal ["steve", "bill", "steve", "mike"], dataset_all_element.dataset.names
+    assert_equal ["1", "2", "3", "4"], dataset_all_element.dataset.post_ids
+    assert_equal ["click"], dataset_all_element.dataset.reflexes
+  end
+
+  test "should pluralize irregular words from datasetAll" do
+    data = {
+      "dataset" => {
+        "dataset" => {},
+        "datasetAll" => {
+          "data-cat" => ["cat"],
+          "data-child" => ["child"],
+          "data-women" => ["woman"],
+          "data-man" => ["man"],
+          "data-wolf" => ["wolf"],
+          "data-library" => ["library"],
+          "data-mouse" => ["mouse"]
+        }
+      }
+    }
+
+    pluralize_element = StimulusReflex::Element.new(data)
+
+    assert_equal ["cat"], pluralize_element.dataset.cats
+    assert_equal ["child"], pluralize_element.dataset.children
+    assert_equal ["woman"], pluralize_element.dataset.women
+    assert_equal ["man"], pluralize_element.dataset.men
+    assert_equal ["wolf"], pluralize_element.dataset.wolves
+    assert_equal ["library"], pluralize_element.dataset.libraries
+    assert_equal ["mouse"], pluralize_element.dataset.mice
+  end
+
+  test "should not pluralize plural key" do
+    data = {
+      "dataset" => {
+        "datasetAll" => {
+          "data-ids" => ["1", "2"]
+        }
+      }
+    }
+
+    assert_equal ["1", "2"], StimulusReflex::Element.new(data).dataset.ids
+    assert_nil StimulusReflex::Element.new(data).dataset.idss
+  end
+
+  test "should not build array with pluralized key" do
+    data = {
+      "dataset" => {
+        "dataset" => {
+          "data-ids" => "1"
+        }
+      }
+    }
+
+    assert_equal "1", StimulusReflex::Element.new(data).dataset.ids
+  end
+
+  test "should handle overlapping singluar and plural key names" do
+    data = {
+      "dataset" => {
+        "dataset" => {
+          "data-id" => "1",
+          "data-ids" => "2",
+          "data-post-id" => "9",
+          "data-post-ids" => "10",
+          "data-duplicate-value" => "19",
+          "data-duplicate-values" => "20"
+        },
+        "datasetAll" => {
+          "data-id" => ["3", "4"],
+          "data-post-ids" => ["11", "12"],
+          "data-duplicate-value" => ["20", "21", "22"]
+        }
+      }
+    }
+
+    overlapping_keys_element = StimulusReflex::Element.new(data)
+
+    assert_equal "1", overlapping_keys_element.dataset.id
+    assert_equal ["2", "3", "4"], overlapping_keys_element.dataset.ids
+
+    assert_equal "9", overlapping_keys_element.dataset.post_id
+    assert_equal ["10", "11", "12"], overlapping_keys_element.dataset.post_ids
+
+    assert_equal "19", overlapping_keys_element.dataset.duplicate_value
+    assert_equal ["20", "20", "21", "22"], overlapping_keys_element.dataset.duplicate_values
+  end
+
+  test "should return true for boolean data attributes" do
+    data = {
+      "dataset" => {
+        "dataset" => {
+          "data-short" => "t",
+          "data-long" => "true",
+          "data-num" => "1",
+          "data-empty" => ""
+        }
+      }
+    }
+
+    element_with_boolean_attributes = StimulusReflex::Element.new(data)
+
+    assert element_with_boolean_attributes.boolean[:short]
+    assert element_with_boolean_attributes.boolean[:long]
+    assert element_with_boolean_attributes.boolean[:num]
+    assert element_with_boolean_attributes.boolean[:empty]
+
+    assert element_with_boolean_attributes.dataset.boolean[:short]
+    assert element_with_boolean_attributes.dataset.boolean[:long]
+    assert element_with_boolean_attributes.dataset.boolean[:num]
+    assert element_with_boolean_attributes.dataset.boolean[:empty]
+  end
+
+  test "should return false for falsey data attributes" do
+    data = {
+      "dataset" => {
+        "dataset" => {
+          "data-short" => "f",
+          "data-long" => "false",
+          "data-num" => "0"
+        }
+      }
+    }
+
+    element_with_falsey_attributes = StimulusReflex::Element.new(data)
+
+    refute element_with_falsey_attributes.boolean[:short]
+    refute element_with_falsey_attributes.boolean[:long]
+    refute element_with_falsey_attributes.boolean[:num]
+
+    refute element_with_falsey_attributes.dataset.boolean[:short]
+    refute element_with_falsey_attributes.dataset.boolean[:long]
+    refute element_with_falsey_attributes.dataset.boolean[:num]
+  end
+
+  test "should return numeric values" do
+    data = {
+      "dataset" => {
+        "dataset" => {
+          "data-int" => "123",
+          "data-float" => "123.456",
+          "data-string" => "asdf"
+        }
+      }
+    }
+
+    element_with_numeric_attributes = StimulusReflex::Element.new(data)
+
+    assert_equal 123.0, element_with_numeric_attributes.numeric[:int]
+    assert_equal 123.456, element_with_numeric_attributes.numeric[:float]
+    assert_raises do
+      element_with_numeric_attributes.numeric[:string]
+    end
+
+    assert_equal 123.0, element_with_numeric_attributes.dataset.numeric[:int]
+    assert_equal 123.456, element_with_numeric_attributes.dataset.numeric[:float]
+    assert_raises do
+      element_with_numeric_attributes.dataset.numeric[:string]
+    end
+  end
+end

data/test/generators/stimulus_reflex_generator_test.rb

@@ -25,6 +25,14 @@ class StimulusReflexGeneratorTest < Rails::Generators::TestCase
     assert_file "app/reflexes/posts_reflex.rb", /PostsReflex/
   end
 
+  test "skips stimulus controller and reflex if option provided" do
+    run_generator %w[users --skip-stimulus --skip-reflex --skip-app-controller --skip-app-reflex]
+    assert_no_file "app/javascript/controllers/application_controller.js"
+    assert_no_file "app/javascript/controllers/users_controller.js"
+    assert_no_file "app/reflexes/application_reflex.rb"
+    assert_no_file "app/reflexes/users_reflex.rb"
+  end
+
   test "creates reflex with given reflex actions" do
     run_generator %w[User update do_stuff DoMoreStuff]
     assert_file "app/reflexes/user_reflex.rb" do |reflex|

data/test/reflex_test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "test_helper"
+require "mocha/minitest"
 
 class StimulusReflex::ReflexTest < ActionCable::Channel::TestCase
   tests StimulusReflex::Channel
@@ -10,7 +11,7 @@ class StimulusReflex::ReflexTest < ActionCable::Channel::TestCase
     def connection.env
       @env ||= {}
     end
-    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com")
+    @reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com", client_attributes: {reflex_id: "666"})
     @reflex.controller_class.view_paths << Rails.root.join("test/views")
   end
 
@@ -29,4 +30,14 @@ class StimulusReflex::ReflexTest < ActionCable::Channel::TestCase
   test "dom_id" do
     assert @reflex.dom_id(TestModel.new(id: 123)) == "#test_model_123"
   end
+
+  test "params behave like ActionController::Parameters" do
+    ActionDispatch::Request.any_instance.stubs(:parameters).returns({"a" => "1", "b" => "2", "c" => "3"})
+    reflex = StimulusReflex::Reflex.new(subscribe, url: "https://test.stimulusreflex.com")
+
+    deleted_param = reflex.params.delete("a")
+
+    assert deleted_param == "1"
+    assert reflex.params.to_unsafe_h == {"b" => "2", "c" => "3"}
+  end
 end

data/test/test_helper.rb

@@ -2,11 +2,14 @@
 
 ENV["RAILS_ENV"] ||= "test"
 
-require "minitest/mock"
+require "mocha"
 require "rails"
 require "active_model"
+require "active_record"
 require "action_controller"
+require "minitest/mock"
 require "pry"
+
 require_relative "../lib/stimulus_reflex"
 
 class TestApp < Rails::Application
@@ -38,6 +41,27 @@ end
 class TestModel
   include ActiveModel::Model
   attr_accessor :id
+  def is_a?(klass)
+    klass == ActiveRecord::Base
+  end
+
+  def to_gid_param
+    "xxxyyyzzz"
+  end
+end
+
+module ActionCable
+  module Channel
+    class ConnectionStub
+      def connection_identifier
+        connection_gid identifiers.map { |id| send(id.to_sym) if id }.compact
+      end
+
+      def connection_gid(ids)
+        ids.map { |o| o.respond_to?(:to_gid_param) ? o.to_gid_param : o.to_s }.sort.join(":")
+      end
+    end
+  end
 end
 
 StimulusReflex.configuration.parent_channel = "ActionCable::Channel::Base"

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

@@ -3,10 +3,17 @@
 class ApplicationReflex < StimulusReflex::Reflex
   # Put application-wide Reflex behavior and callbacks in this file.
   #
-  # Example:
+  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
   #
-  #   # If your ActionCable connection is: `identified_by :current_user`
+  # If your ActionCable connection is: `identified_by :current_user`
   #   delegate :current_user, to: :connection
   #
-  # Learn more at: https://docs.stimulusreflex.com/reflexes#reflex-classes
+  # If you need to localize your Reflexes, you can set the I18n locale here:
+  #
+  #   before_reflex do
+  #     I18n.locale = :fr
+  #   end
+  #
+  # For code examples, considerations and caveats, see:
+  # https://docs.stimulusreflex.com/rtfm/patterns#internationalization
 end

data/test/tmp/app/reflexes/{user_reflex.rb → demo_reflex.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class UserReflex < ApplicationReflex
+class DemoReflex < ApplicationReflex
   # Add Reflex methods in this file.
   #
   # All Reflex instances include CableReady::Broadcaster and expose the following properties:
@@ -17,12 +17,13 @@ class UserReflex < ApplicationReflex
   #     - unsigned  - use an unsigned Global ID to map dataset attribute to a model  eg. element.unsigned[:foo]
   #   - cable_ready - a special cable_ready that can broadcast to the current visitor (no brackets needed)
   #   - reflex_id   - a UUIDv4 that uniquely identies each Reflex
+  #   - tab_id      - a UUIDv4 that uniquely identifies the browser tab
   #
   # Example:
   #
   #   before_reflex do
   #     # throw :abort # this will prevent the Reflex from continuing
-  #     # learn more about callbacks at https://docs.stimulusreflex.com/lifecycle
+  #     # learn more about callbacks at https://docs.stimulusreflex.com/rtfm/lifecycle
   #   end
   #
   #   def example(argument=true)
@@ -30,14 +31,5 @@ class UserReflex < ApplicationReflex
   #     # Any declared instance variables will be made available to the Rails controller and view.
   #   end
   #
-  # Learn more at: https://docs.stimulusreflex.com/reflexes#reflex-classes
-
-  def update
-  end
-
-  def do_stuff
-  end
-
-  def do_more_stuff
-  end
+  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0.pre3
 platform: ruby
 authors:
 - Nathan Hopkins
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -70,16 +70,16 @@ dependencies:
   name: cable_ready
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 5.0.0.pre4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 5.0.0.pre4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standardrb
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,7 +150,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
 email:
 - natehop@gmail.com
 executables: []
@@ -161,6 +175,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LATEST
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -171,7 +186,7 @@ files:
 - bin/setup
 - bin/standardize
 - lib/generators/USAGE
-- lib/generators/stimulus_reflex/config_generator.rb
+- lib/generators/stimulus_reflex/initializer_generator.rb
 - lib/generators/stimulus_reflex/stimulus_reflex_generator.rb
 - lib/generators/stimulus_reflex/templates/app/javascript/controllers/%file_name%_controller.js.tt
 - lib/generators/stimulus_reflex/templates/app/javascript/controllers/application_controller.js.tt
@@ -183,44 +198,55 @@ files:
 - lib/stimulus_reflex/broadcasters/nothing_broadcaster.rb
 - lib/stimulus_reflex/broadcasters/page_broadcaster.rb
 - lib/stimulus_reflex/broadcasters/selector_broadcaster.rb
+- lib/stimulus_reflex/broadcasters/update.rb
 - lib/stimulus_reflex/cable_ready_channels.rb
 - lib/stimulus_reflex/callbacks.rb
+- lib/stimulus_reflex/concern_enhancer.rb
 - lib/stimulus_reflex/configuration.rb
+- lib/stimulus_reflex/dataset.rb
 - lib/stimulus_reflex/element.rb
-- lib/stimulus_reflex/logger.rb
+- lib/stimulus_reflex/policies/reflex_invocation_policy.rb
 - lib/stimulus_reflex/reflex.rb
-- lib/stimulus_reflex/sanity_checker.rb
+- lib/stimulus_reflex/reflex_data.rb
+- lib/stimulus_reflex/reflex_factory.rb
+- lib/stimulus_reflex/request_parameters.rb
+- lib/stimulus_reflex/utils/attribute_builder.rb
 - lib/stimulus_reflex/utils/colorize.rb
+- lib/stimulus_reflex/utils/logger.rb
+- lib/stimulus_reflex/utils/sanity_checker.rb
 - lib/stimulus_reflex/version.rb
 - lib/tasks/stimulus_reflex/install.rake
-- package.json
-- stimulus_reflex.gemspec
-- tags
 - test/broadcasters/broadcaster_test.rb
 - test/broadcasters/broadcaster_test_case.rb
 - test/broadcasters/nothing_broadcaster_test.rb
 - test/broadcasters/page_broadcaster_test.rb
 - test/broadcasters/selector_broadcaster_test.rb
+- test/callbacks_test.rb
+- test/concern_enhancer_test.rb
+- test/element_test.rb
 - test/generators/stimulus_reflex_generator_test.rb
 - test/reflex_test.rb
 - test/test_helper.rb
 - test/tmp/app/reflexes/application_reflex.rb
-- test/tmp/app/reflexes/user_reflex.rb
-- yarn.lock
-homepage: https://github.com/hopsoft/stimulus_reflex
+- test/tmp/app/reflexes/demo_reflex.rb
+homepage: https://github.com/stimulusreflex/stimulus_reflex
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/hopsoft/stimulus_reflex/issues
-  changelog_uri: https://github.com/hopsoft/stimulus_reflex/CHANGELOG.md
+  bug_tracker_uri: https://github.com/stimulusreflex/stimulus_reflex/issues
+  changelog_uri: https://github.com/stimulusreflex/stimulus_reflex/CHANGELOG.md
   documentation_uri: https://docs.stimulusreflex.com
-  homepage_uri: https://github.com/hopsoft/stimulus_reflex
-  source_code_uri: https://github.com/hopsoft/stimulus_reflex
-post_install_message: |
-  Friendly reminder: When updating the stimulus_reflex gem,
-  don't forget to update your npm package as well.
+  homepage_uri: https://github.com/stimulusreflex/stimulus_reflex
+  source_code_uri: https://github.com/stimulusreflex/stimulus_reflex
+post_install_message: |+
+  Finish installation by running:
+
+  rake stimulus_reflex:install
+
+  Get support for StimulusReflex and CableReady on Discord:
+
+  https://discord.gg/stimulus-reflex
 
-  See https://www.npmjs.com/package/stimulus_reflex
 rdoc_options: []
 require_paths:
 - lib
@@ -231,22 +257,25 @@ 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.4
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Build reactive applications with the Rails tooling you already know and love.
 test_files:
-- test/reflex_test.rb
-- test/test_helper.rb
 - test/generators/stimulus_reflex_generator_test.rb
-- test/tmp/app/reflexes/application_reflex.rb
-- test/tmp/app/reflexes/user_reflex.rb
-- test/broadcasters/broadcaster_test.rb
-- test/broadcasters/selector_broadcaster_test.rb
+- test/element_test.rb
 - test/broadcasters/page_broadcaster_test.rb
 - test/broadcasters/broadcaster_test_case.rb
+- test/broadcasters/broadcaster_test.rb
+- test/broadcasters/selector_broadcaster_test.rb
 - test/broadcasters/nothing_broadcaster_test.rb
+- test/reflex_test.rb
+- test/test_helper.rb
+- test/callbacks_test.rb
+- test/tmp/app/reflexes/demo_reflex.rb
+- test/tmp/app/reflexes/application_reflex.rb
+- test/concern_enhancer_test.rb