stimulus_reflex 3.4.2 → 3.5.0.pre0

data/test/element_test.rb

@@ -0,0 +1,181 @@
+# 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
+end

data/test/reflex_test.rb

@@ -10,7 +10,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
 

data/test/test_helper.rb

@@ -5,6 +5,7 @@ ENV["RAILS_ENV"] ||= "test"
 require "minitest/mock"
 require "rails"
 require "active_model"
+require "active_record"
 require "action_controller"
 require "pry"
 require_relative "../lib/stimulus_reflex"
@@ -29,40 +30,6 @@ class SessionMock
   end
 end
 
-class ApplicationReflex < StimulusReflex::Reflex
-  def application_reflex
-  end
-
-  private
-
-  def private_application_reflex
-  end
-end
-
-class PostReflex < ApplicationReflex
-  def post_reflex
-  end
-
-  private
-
-  def private_post_reflex
-  end
-end
-
-class NoReflex
-  def no_reflex
-  end
-end
-
-module CounterConcern
-  def increment
-  end
-end
-
-class CounterReflex < ApplicationReflex
-  include CounterConcern
-end
-
 class ActionDispatch::Request
   def session
     @session ||= SessionMock.new
@@ -72,6 +39,9 @@ end
 class TestModel
   include ActiveModel::Model
   attr_accessor :id
+  def is_a?(klass)
+    klass == ActiveRecord::Base
+  end
 end
 
 StimulusReflex.configuration.parent_channel = "ActionCable::Channel::Base"

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 and callbacks in this file. 
+  #
+  # Example:
+  #
+  #   # If your ActionCable connection is: `identified_by :current_user`
+  #   delegate :current_user, to: :connection
+  #
+  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class UserReflex < ApplicationReflex
+  # Add Reflex methods in this file.
+  #
+  # All Reflex instances include CableReady::Broadcaster and 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
+  #   - flash       - the ActionDispatch::Flash::FlashHash for the current request
+  #   - url         - the URL of the page that triggered the reflex
+  #   - params      - parameters from the element's closest form (if any)
+  #   - element     - a Hash like object that represents the HTML element that triggered the reflex
+  #     - signed    - use a signed Global ID to map dataset attribute to a model eg. element.signed[:foo]
+  #     - 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/rtfm/lifecycle
+  #   end
+  #
+  #   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/rtfm/reflex-classes
+
+  def update
+  end
+
+  def do_stuff
+  end
+
+  def do_more_stuff
+  end
+end