stimulus_reflex 3.5.0.pre1 → 3.5.0.pre5

data/lib/tasks/stimulus_reflex/install.rake

@@ -4,7 +4,7 @@ require "fileutils"
 require "stimulus_reflex/version"
 
 namespace :stimulus_reflex do
-  desc "Install StimulusReflex in this application"
+  desc "✨ Install StimulusReflex in this application"
   task install: :environment do
     system "rails dev:cache" unless Rails.root.join("tmp", "caching-dev.txt").exist?
     gem_version = StimulusReflex::VERSION.gsub(".pre", "-pre")
@@ -25,8 +25,8 @@ namespace :stimulus_reflex do
       .map { |path| Rails.root.join(path) }
       .first
 
-    puts "Updating #{filepath}"
-    lines = File.open(filepath, "r") { |f| f.readlines }
+    puts "✨ Updating #{filepath}"
+    lines = File.readlines(filepath)
 
     unless lines.find { |line| line.start_with?("import StimulusReflex") }
       matches = lines.select { |line| line =~ /\A(require|import)/ }
@@ -47,33 +47,70 @@ namespace :stimulus_reflex do
     lines << "application.consumer = consumer\n"
     lines << "StimulusReflex.initialize(application, { controller, isolate: true })\n" unless initialize_line
     lines << "StimulusReflex.debug = process.env.RAILS_ENV === 'development'\n" unless initialize_line
-    File.open(filepath, "w") { |f| f.write lines.join }
+    File.write(filepath, lines.join)
 
+    puts
+    puts "✨ Updating config/environments/development.rb"
     filepath = Rails.root.join("config/environments/development.rb")
-    lines = File.open(filepath, "r") { |f| f.readlines }
+    lines = File.readlines(filepath)
     unless lines.find { |line| line.include?("config.session_store") }
       matches = lines.select { |line| line =~ /\A(Rails.application.configure do)/ }
       lines.insert lines.index(matches.last).to_i + 1, "  config.session_store :cache_store\n\n"
-      File.open(filepath, "w") { |f| f.write lines.join }
+      puts
+      puts "✨ Using :cache_store for session storage. We recommend switching to Redis for cache and session storage."
+      puts
+      puts "https://docs.stimulusreflex.com/appendices/deployment#use-redis-as-your-cache-store"
+      File.write(filepath, lines.join)
+    end
+
+    if defined?(ActionMailer)
+      lines = File.readlines(filepath)
+      unless lines.find { |line| line.include?("config.action_mailer.default_url_options") }
+        matches = lines.select { |line| line =~ /\A(Rails.application.configure do)/ }
+        lines.insert lines.index(matches.last).to_i + 1, "  config.action_mailer.default_url_options = {host: \"localhost\", port: 3000}\n\n"
+        File.write(filepath, lines.join)
+      end
     end
 
+    lines = File.readlines(filepath)
+    unless lines.find { |line| line.include?("config.action_controller.default_url_options") }
+      matches = lines.select { |line| line =~ /\A(Rails.application.configure do)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "  config.action_controller.default_url_options = {host: \"localhost\", port: 3000}\n"
+      File.write(filepath, lines.join)
+    end
+
+    puts
+    puts "✨ Updating config/cable.yml to use Redis in development"
     filepath = Rails.root.join("config/cable.yml")
-    lines = File.open(filepath, "r") { |f| f.readlines }
+    lines = File.readlines(filepath)
     if lines[1].include?("adapter: async")
       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: " + File.basename(Rails.root.to_s).tr("\\", "").tr("-. ", "_").underscore + "_development\n"
-      File.open(filepath, "w") { |f| f.write lines.join }
+      File.write(filepath, lines.join)
     end
 
-    system "bundle exec rails generate stimulus_reflex example"
-    puts "Generating default StimulusReflex configuration file into your application config/initializers directory"
+    puts
+    puts "✨ Generating default StimulusReflex and CableReady configuration files"
+    puts
     system "bundle exec rails generate stimulus_reflex:initializer"
+    system "bundle exec rails generate cable_ready:initializer"
+    system "bundle exec rails generate cable_ready:helpers"
+
+    puts
+    puts "✨ Generating ApplicationReflex class and Stimulus controllers, plus an example Reflex class and controller"
+    puts
+    system "bundle exec rails generate stimulus_reflex example"
 
     puts
-    puts "StimulusReflex and CableReady have been successfully installed!"
-    puts "Go to https://docs.stimulusreflex.com/hello-world/quickstart if you need help getting started."
+    puts "🎉 StimulusReflex and CableReady have been successfully installed! 🎉"
+    puts
+    puts "https://docs.stimulusreflex.com/hello-world/quickstart"
+    puts
+    puts "😊 The fastest way to get support is to say hello on Discord:"
+    puts
+    puts "https://discord.gg/stimulus-reflex"
     puts
   end
 end

data/test/broadcasters/broadcaster_test.rb

@@ -7,6 +7,5 @@ class StimulusReflex::BroadcasterTest < StimulusReflex::BroadcasterTestCase
     broadcaster = StimulusReflex::Broadcaster.new(@reflex)
 
     assert_raises(NotImplementedError) { broadcaster.broadcast }
-    assert_raises(NotImplementedError) { broadcaster.broadcast_message(subject: "Test") }
   end
 end

data/test/broadcasters/broadcaster_test_case.rb

@@ -5,6 +5,30 @@ require_relative "../test_helper"
 class StimulusReflex::BroadcasterTestCase < ActionCable::Channel::TestCase
   tests StimulusReflex::Channel
 
+  def assert_broadcast_on(stream, data, &block)
+    serialized_msg = ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
+
+    new_messages = broadcasts(stream)
+    if block
+      old_messages = new_messages
+      clear_messages(stream)
+
+      yield
+      new_messages = broadcasts(stream)
+      clear_messages(stream)
+
+      (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
+    end
+
+    message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }
+
+    unless message
+      puts "\n\n#{ActiveSupport::JSON.decode(new_messages.first)}\n#{data}\n\n"
+    end
+
+    assert message, "No messages sent with #{data} to #{stream}"
+  end
+
   setup do
     stub_connection(session_id: SecureRandom.uuid)
     def connection.env

data/test/broadcasters/nothing_broadcaster_test.rb

@@ -3,35 +3,27 @@
 require_relative "broadcaster_test_case"
 
 class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCase
-  test "broadcasts a server message when called" do
+  test "broadcasts a nothing morph when called" do
     broadcaster = StimulusReflex::NothingBroadcaster.new(@reflex)
 
     expected = {
       "cableReady" => true,
-      "operations" => {
-        "dispatchEvent" => [
-          {
-            "name" => "stimulus-reflex:server-message",
-            "detail" => {
-              "reflexId" => "666",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => :data,
-                "morph" => :nothing,
-                "serverMessage" => {
-                  "subject" => "nothing",
-                  "body" => nil
-                }
-              }
-            },
-            "reflexId" => "666"
-          }
-        ]
-      }
+      "operations" => [
+        {
+          "name" => "stimulus-reflex:morph-nothing",
+          "payload" => {},
+          "stimulusReflex" => {
+            "some" => "data",
+            "morph" => "nothing"
+          },
+          "reflexId" => "666",
+          "operation" => "dispatchEvent"
+        }
+      ]
     }
 
     assert_broadcast_on @reflex.stream_name, expected do
-      broadcaster.broadcast nil, {:some => :data, "reflexId" => "666"}
+      broadcaster.broadcast nil, {some: :data}
     end
   end
 end

data/test/broadcasters/page_broadcaster_test.rb

@@ -20,22 +20,21 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
 
     expected = {
       "cableReady" => true,
-      "operations" => {
-        "morph" => [
-          {
-            "selector" => "body",
-            "html" => "<div>New Content</div><div>Another Content</div>",
-            "payload" => {},
-            "childrenOnly" => true,
-            "permanentAttributeName" => nil,
-            "stimulusReflex" => {
-              "some" => :data,
-              "morph" => :page
-            },
-            "reflexId" => "666"
-          }
-        ]
-      }
+      "operations" => [
+        {
+          "selector" => "body",
+          "html" => "<div>New Content</div><div>Another Content</div>",
+          "payload" => {},
+          "childrenOnly" => true,
+          "permanentAttributeName" => nil,
+          "stimulusReflex" => {
+            "some" => :data,
+            "morph" => :page
+          },
+          "reflexId" => "666",
+          "operation" => "morph"
+        }
+      ]
     }
 
     assert_broadcast_on @reflex.stream_name, expected do
@@ -54,22 +53,21 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
 
     expected = {
       "cableReady" => true,
-      "operations" => {
-        "morph" => [
-          {
-            "selector" => "#foo",
-            "html" => "New Content",
-            "payload" => {},
-            "childrenOnly" => true,
-            "permanentAttributeName" => nil,
-            "stimulusReflex" => {
-              "some" => :data,
-              "morph" => :page
-            },
-            "reflexId" => "666"
-          }
-        ]
-      }
+      "operations" => [
+        {
+          "selector" => "#foo",
+          "html" => "New Content",
+          "payload" => {},
+          "childrenOnly" => true,
+          "permanentAttributeName" => nil,
+          "stimulusReflex" => {
+            "some" => :data,
+            "morph" => :page
+          },
+          "reflexId" => "666",
+          "operation" => "morph"
+        }
+      ]
     }
 
     assert_broadcast_on @reflex.stream_name, expected do

data/test/broadcasters/selector_broadcaster_test.rb

@@ -10,22 +10,21 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "morph" => [
-            {
-              "selector" => "#foo",
-              "html" => "<div>bar</div><div>baz</div>",
-              "payload" => {},
-              "childrenOnly" => true,
-              "permanentAttributeName" => nil,
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "<div>bar</div><div>baz</div>",
+            "payload" => {},
+            "childrenOnly" => true,
+            "permanentAttributeName" => nil,
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "morph"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -39,20 +38,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => '<div id="baz"><span>bar</span></div>',
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => '<div id="baz"><span>bar</span></div>',
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -66,20 +64,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => "",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "",
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -93,20 +90,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => "",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "",
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -120,20 +116,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => "",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "",
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -147,22 +142,21 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "morph" => [
-            {
-              "selector" => "#foo",
-              "html" => "<div>bar</div><div>baz</div>",
-              "payload" => {},
-              "childrenOnly" => true,
-              "permanentAttributeName" => nil,
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "<div>bar</div><div>baz</div>",
+            "payload" => {},
+            "childrenOnly" => true,
+            "permanentAttributeName" => nil,
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "morph"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do

data/test/element_test.rb

@@ -178,4 +178,77 @@ class StimulusReflex::ElementTest < ActiveSupport::TestCase
     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
@@ -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,12 +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
@@ -42,6 +44,24 @@ class TestModel
   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/rtfm/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