cable_ready 4.5.0 → 5.0.0.pre0

data/lib/cable_ready/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableReady
-  VERSION = "4.5.0"
+  VERSION = "5.0.0.pre0"
 end

data/lib/generators/cable_ready/channel_generator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+class CableReady::ChannelGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :stream_from, type: :string
+  class_option :stream_for, type: :string
+  class_option :stimulus, type: :boolean
+
+  def check_options
+    raise "Can't specify --stream-from and --stream-for at the same time" if options.key?(:stream_from) && options.key?(:stream_for)
+  end
+
+  def create_channel
+    generate "channel", file_name
+  end
+
+  def enhance_channels
+    if using_broadcast_to?
+      gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_for #{resource}.find(params[:id])\n"
+      template "app/javascript/controllers/%file_name%_controller.js" if using_stimulus?
+    else
+      prepend_to_file "app/javascript/channels/#{file_name}_channel.js", "import CableReady from 'cable_ready'\n"
+      inject_into_file "app/javascript/channels/#{file_name}_channel.js", after: "// Called when there's incoming data on the websocket for this channel\n" do
+        <<-JS
+    if (data.cableReady) CableReady.perform(data.operations)
+        JS
+      end
+
+      gsub_file "app/channels/#{file_name}_channel.rb", /# stream_from.*\n/, "stream_from \"#{identifier}\"\n"
+    end
+  end
+
+  private
+
+  def option_given?
+    options.key?(:stream_from) || options.key?(:stream_for)
+  end
+
+  def using_broadcast_to?
+    @using_broadcast_to ||= option_given? ? options.key?(:stream_for) : yes?("Are you streaming to a resource using broadcast_to? (y/N)")
+  end
+
+  def using_stimulus?
+    @using_stimulus ||= options.fetch(:stimulus) {
+      yes?("Are you going to use a Stimulus controller to subscribe to this channel? (y/N)")
+    }
+  end
+
+  def resource
+    return @resource if @resource
+
+    stream_for = options.fetch(:stream_for) {
+      ask("Which resource are you streaming for?", default: class_name)
+    }
+
+    stream_for = file_name if stream_for == "stream_for"
+    @resource = stream_for.camelize
+  end
+
+  def identifier
+    return @identifier if @identifier
+
+    stream_from = options.fetch(:stream_from) {
+      ask("What is the stream identifier that goes into stream_from?", default: file_name)
+    }
+
+    stream_from = file_name if stream_from == "stream_from"
+    @identifier = stream_from.underscore
+  end
+end

data/lib/generators/cable_ready/initializer_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module CableReady
+  class InitializerGenerator < Rails::Generators::Base
+    desc "Creates a CableReady initializer template in config/initializers"
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_initializer_file
+      copy_file "config/initializers/cable_ready.rb"
+    end
+  end
+end

data/lib/generators/cable_ready/stream_from_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "fileutils"
+
+module CableReady
+  class StreamFromGenerator < Rails::Generators::Base
+    desc "Initializes CableReady with a reference to the shared ActionCable consumer"
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_controller_file
+      main_folder = defined?(Webpacker) ? Webpacker.config.source_path.to_s.gsub("#{Rails.root}/", "") : "app/javascript"
+
+      filepath = [
+        "#{main_folder}/controllers/index.js",
+        "#{main_folder}/controllers/index.ts",
+        "#{main_folder}/packs/application.js",
+        "#{main_folder}/packs/application.ts"
+      ]
+        .select { |path| File.exist?(path) }
+        .map { |path| Rails.root.join(path) }
+        .first
+
+      lines = File.open(filepath, "r") { |f| f.readlines }
+
+      unless lines.find { |line| line.start_with?("import CableReady") }
+        matches = lines.select { |line| line =~ /\A(require|import)/ }
+        lines.insert lines.index(matches.last).to_i + 1, "import CableReady from 'cable_ready'\n"
+        File.open(filepath, "w") { |f| f.write lines.join }
+      end
+
+      unless lines.find { |line| line.start_with?("import consumer") }
+        matches = lines.select { |line| line =~ /\A(require|import)/ }
+        lines.insert lines.index(matches.last).to_i + 1, "import consumer from '../channels/consumer'\n"
+        File.open(filepath, "w") { |f| f.write lines.join }
+      end
+
+      unless lines.find { |line| line.include?("CableReady.initialize({ consumer })") }
+        append_to_file filepath, "CableReady.initialize({ consumer })"
+      end
+    end
+  end
+end

data/lib/generators/cable_ready/templates/config/initializers/cable_ready.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+CableReady.configure do |config|
+  # Enable/disable exiting / warning when the sanity checks fail options:
+  # `:exit` or `:warn` or `:ignore`
+
+  # config.on_failed_sanity_checks = :exit
+
+  # Enable/disable exiting / warning when there's a new CableReady release
+  # `:exit` or `:warn` or `:ignore`
+
+  # config.on_new_version_available = :ignore
+
+  # Define your own custom operations
+  # https://cableready.stimulusreflex.com/customization#custom-operations
+
+  # config.add_operation_name :jazz_hands
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cable_ready",
-  "version": "4.4.6",
+  "version": "4.5.0",
   "description": "CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.",
   "keywords": [
     "ruby",
@@ -15,17 +15,20 @@
   ],
   "homepage": "https://cableready.stimulusreflex.com/",
   "bugs": {
-    "url": "https://github.com/hopsoft/cable_ready/issues"
+    "url": "https://github.com/stimulusreflex/cable_ready/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com:hopsoft/cable_ready.git"
+    "url": "git+https://github.com:stimulusreflex/cable_ready.git"
   },
   "license": "MIT",
   "author": "Nathan Hopkins <natehop@gmail.com>",
-  "main": "./javascript/cable_ready.js",
+  "main": "./javascript/index.js",
   "scripts": {
-    "prettier-standard-check": "yarn run prettier-standard --check ./javascript/**/*.js"
+    "lint": "yarn run prettier-standard:check",
+    "format": "yarn run prettier-standard:format",
+    "prettier-standard:check": "yarn run prettier-standard --check ./javascript/**/*.js",
+    "prettier-standard:format": "yarn run prettier-standard ./javascript/**/*.js"
   },
   "dependencies": {
     "morphdom": "^2.6.1"

data/tags

@@ -11,28 +11,35 @@ CableReady	lib/cable_ready/channel.rb	/^module CableReady$/;"	m
 CableReady	lib/cable_ready/channels.rb	/^module CableReady$/;"	m
 CableReady	lib/cable_ready/config.rb	/^module CableReady$/;"	m
 CableReady	lib/cable_ready/version.rb	/^module CableReady$/;"	m
+CableReady	lib/generators/cable_ready/channel_generator.rb	/^class CableReady::ChannelGenerator < Rails::Generators::NamedBase$/;"	c
+CableReady	test/lib/generators/cable_ready/channel_generator_test.rb	/^class CableReady::ChannelGeneratorTest < Rails::Generators::TestCase$/;"	c
 Channel	lib/cable_ready/channel.rb	/^  class Channel$/;"	c	class:CableReady
 Channels	lib/cable_ready/channels.rb	/^  class Channels$/;"	c	class:CableReady
+ClassMethods	test/support/generator_test_helpers.rb	/^  module ClassMethods$/;"	m	class:GeneratorTestHelpers
 Config	lib/cable_ready/config.rb	/^  class Config$/;"	c	class:CableReady
 Engine	lib/cable_ready.rb	/^  class Engine < Rails::Engine$/;"	c	class:CableReady
+GeneratorTestHelpers	test/support/generator_test_helpers.rb	/^module GeneratorTestHelpers$/;"	m
 []	lib/cable_ready/channels.rb	/^    def [](identifier)$/;"	f	class:CableReady.Channels
-add_operation_definition	lib/cable_ready/config.rb	/^    def add_operation_definition(name)$/;"	f	class:CableReady.Config
 add_operation_method	lib/cable_ready/channel.rb	/^    def add_operation_method(name)$/;"	f	class:CableReady.Channel
+add_operation_name	lib/cable_ready/config.rb	/^    def add_operation_name(name)$/;"	f	class:CableReady.Config
 broadcast	lib/cable_ready/channel.rb	/^    def broadcast(clear: true)$/;"	f	class:CableReady.Channel
 broadcast	lib/cable_ready/channels.rb	/^    def broadcast(*identifiers, clear: true)$/;"	f	class:CableReady.Channels
 broadcast_to	lib/cable_ready/channel.rb	/^    def broadcast_to(model, clear: true)$/;"	f	class:CableReady.Channel
 broadcast_to	lib/cable_ready/channels.rb	/^    def broadcast_to(model, *identifiers, clear: true)$/;"	f	class:CableReady.Channels
 broadcastable_operations	lib/cable_ready/channel.rb	/^    def broadcastable_operations$/;"	f	class:CableReady.Channel
 cable_ready	lib/cable_ready/broadcaster.rb	/^    def cable_ready$/;"	f	class:CableReady.Broadcaster
+check_options	lib/generators/cable_ready/channel_generator.rb	/^  def check_options$/;"	f	class:CableReady
 config	lib/cable_ready.rb	/^  def self.config$/;"	F	class:CableReady
 configure	lib/cable_ready.rb	/^  def self.configure$/;"	F	class:CableReady
 const.bubbles	javascript/utils.js	/^  const init = { bubbles: true, cancelable: true, detail: detail }$/;"	p
 const.cancelable	javascript/utils.js	/^  const init = { bubbles: true, cancelable: true, detail: detail }$/;"	p
 const.detail	javascript/utils.js	/^  const init = { bubbles: true, cancelable: true, detail: detail }$/;"	p
-const.pushState	javascript/cable_ready.js	/^  pushState: config => {$/;"	p
-const.value	javascript/callbacks.js	/^    const ignore = { value: true }$/;"	p
+const.value	javascript/morph_callbacks.js	/^    const ignore = { value: true }$/;"	p
+create_channel	lib/generators/cable_ready/channel_generator.rb	/^  def create_channel$/;"	f	class:CableReady
+create_sample_app	test/support/generator_test_helpers.rb	/^    def create_sample_app$/;"	f	class:GeneratorTestHelpers.ClassMethods
 default_operation_names	lib/cable_ready/config.rb	/^    def default_operation_names$/;"	f	class:CableReady.Config
 dom_id	lib/cable_ready/broadcaster.rb	/^    def dom_id(record, prefix = nil)$/;"	f	class:CableReady.Broadcaster
+enhance_channels	lib/generators/cable_ready/channel_generator.rb	/^  def enhance_channels$/;"	f	class:CableReady
 export.INPUT	javascript/enums.js	/^  INPUT: true,$/;"	p
 export.OPTION	javascript/enums.js	/^  OPTION: true$/;"	p
 export.SELECT	javascript/enums.js	/^  SELECT: true$/;"	p
@@ -55,8 +62,19 @@ export.textarea	javascript/enums.js	/^  textarea: true,$/;"	p
 export.time	javascript/enums.js	/^  time: true,$/;"	p
 export.url	javascript/enums.js	/^  url: true,$/;"	p
 export.week	javascript/enums.js	/^  week: true$/;"	p
+finalizer_for	lib/cable_ready/channel.rb	/^    def self.finalizer_for(identifier)$/;"	F	class:CableReady.Channel
+identifier	lib/generators/cable_ready/channel_generator.rb	/^  def identifier$/;"	f	class:CableReady
+included	test/support/generator_test_helpers.rb	/^  def self.included(base)$/;"	F	class:GeneratorTestHelpers
 initialize	lib/cable_ready/channel.rb	/^    def initialize(identifier)$/;"	f	class:CableReady.Channel
 initialize	lib/cable_ready/channels.rb	/^    def initialize$/;"	f	class:CableReady.Channels
 initialize	lib/cable_ready/config.rb	/^    def initialize$/;"	f	class:CableReady.Config
+observers	lib/cable_ready/config.rb	/^    def observers$/;"	f	class:CableReady.Config
 operation_names	lib/cable_ready/config.rb	/^    def operation_names$/;"	f	class:CableReady.Config
+option_given?	lib/generators/cable_ready/channel_generator.rb	/^  def option_given?$/;"	f	class:CableReady
+prepare_destination	test/support/generator_test_helpers.rb	/^    def prepare_destination$/;"	f	class:GeneratorTestHelpers.ClassMethods
+remove_sample_app	test/support/generator_test_helpers.rb	/^    def remove_sample_app$/;"	f	class:GeneratorTestHelpers.ClassMethods
 reset	lib/cable_ready/channel.rb	/^    def reset$/;"	f	class:CableReady.Channel
+resource	lib/generators/cable_ready/channel_generator.rb	/^  def resource$/;"	f	class:CableReady
+sample_app_path	test/support/generator_test_helpers.rb	/^    def sample_app_path$/;"	f	class:GeneratorTestHelpers.ClassMethods
+using_broadcast_to?	lib/generators/cable_ready/channel_generator.rb	/^  def using_broadcast_to?$/;"	f	class:CableReady
+using_stimulus?	lib/generators/cable_ready/channel_generator.rb	/^  def using_stimulus?$/;"	f	class:CableReady

data/test/lib/cable_ready/cable_car_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "../../../lib/cable_ready"
+
+class CableReady::CableCarTest < ActiveSupport::TestCase
+  setup do
+    @cable_car = CableReady::CableCar.instance
+  end
+
+  test "dispatch should return json-ifiable payload" do
+    CableReady::CableCar.instance.reset!
+    dispatch = CableReady::CableCar.instance.inner_html(selector: "#users", html: "<span>winning</span>").dispatch
+    assert_equal({"innerHtml" => [{"selector" => "#users", "html" => "<span>winning</span>"}]}, dispatch)
+  end
+
+  test "dispatch should clear operations" do
+    CableReady::CableCar.instance.reset!
+    CableReady::CableCar.instance.inner_html(selector: "#users", html: "<span>winning</span>").dispatch
+    assert_equal({}, CableReady::CableCar.instance.instance_variable_get(:@enqueued_operations))
+  end
+
+  test "dispatch should maintain operations if clear is false" do
+    CableReady::CableCar.instance.reset!
+    CableReady::CableCar.instance.inner_html(selector: "#users", html: "<span>winning</span>").dispatch(clear: false)
+    assert_equal({"inner_html" => [{"selector" => "#users", "html" => "<span>winning</span>"}]}, CableReady::CableCar.instance.instance_variable_get(:@enqueued_operations))
+  end
+end

data/test/lib/cable_ready/identifiable_test.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "../../../lib/cable_ready"
+
+class User
+  include ActiveModel::Model
+
+  attr_accessor :id
+end
+
+class CableReady::IdentifiableTest < ActiveSupport::TestCase
+  include CableReady::Identifiable
+
+  test "should handle nil" do
+    assert_equal "#", dom_id(nil)
+  end
+
+  test "should work with strings" do
+    assert_equal "#users", dom_id("users")
+    assert_equal "#users", dom_id("users  ")
+    assert_equal "#users", dom_id("  users  ")
+  end
+
+  test "should work with symbols" do
+    assert_equal "#users", dom_id(:users)
+    assert_equal "#active_users", dom_id(:active_users)
+  end
+
+  test "should just return one hash" do
+    assert_equal "#users", dom_id("users")
+    assert_equal "#users", dom_id("#users")
+    assert_equal "#users", dom_id("##users")
+  end
+
+  test "should strip prefixes" do
+    assert_equal "#active_users", dom_id("  users ", "     active    ")
+    assert_equal "#all_active_users", dom_id(" users  ", "  all_active ")
+  end
+
+  test "should not include provided prefix if prefix is nil" do
+    assert_equal "#users", dom_id("users", nil)
+  end
+
+  test "should work with ActiveRecord::Relation" do
+    relation = mock("ActiveRecord::Relation")
+
+    relation.stubs(:is_a?).with(ActiveRecord::Relation).returns(true).at_least_once
+    relation.stubs(:is_a?).with(ActiveRecord::Base).never
+    relation.stubs(:model_name).returns(OpenStruct.new(plural: "users"))
+
+    assert_equal "#users", dom_id(relation)
+    assert_equal "#users", dom_id(relation, nil)
+    assert_equal "#active_users", dom_id(relation, "active")
+  end
+
+  test "should work with ActiveRecord::Base" do
+    User.any_instance.stubs(:is_a?).with(ActiveRecord::Relation).returns(false)
+    User.any_instance.stubs(:is_a?).with(ActiveRecord::Base).returns(true)
+
+    assert_equal "#new_user", dom_id(User.new(id: nil))
+
+    user = User.new(id: 42)
+
+    assert_equal "#user_42", dom_id(user)
+    assert_equal "#user_42", dom_id(user, nil)
+    assert_equal "#all_active_user_42", dom_id(user, "all_active")
+
+    user = User.new(id: 99)
+
+    assert_equal "#user_99", dom_id(user)
+    assert_equal "#user_99", dom_id(user, nil)
+    assert_equal "#all_active_user_99", dom_id(user, "all_active")
+  end
+end

data/test/lib/cable_ready/operation_builder_test.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "../../../lib/cable_ready"
+
+class CableReady::OperationBuilderTest < ActiveSupport::TestCase
+  setup do
+    @operation_builder = CableReady::OperationBuilder.new("test")
+  end
+
+  test "should create enqueued operations" do
+    assert_not_nil @operation_builder.instance_variable_get(:@enqueued_operations)
+  end
+
+  test "should add observer to cable ready" do
+    assert_not_nil CableReady.config.instance_variable_get(:@observer_peers)[@operation_builder]
+  end
+
+  test "should remove observer when destroyed" do
+    @operation_builder = nil
+    assert_nil CableReady.config.instance_variable_get(:@observer_peers)[@operation_builder]
+  end
+
+  test "should add operation method" do
+    @operation_builder.add_operation_method("foobar")
+    assert @operation_builder.respond_to?(:foobar)
+  end
+
+  test "added operation method should add keys" do
+    @operation_builder.add_operation_method("foobar")
+    @operation_builder.foobar({name: "passed_option"})
+
+    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
+
+    assert_equal 1, operations["foobar"].size
+    assert_equal({"name" => "passed_option"}, operations["foobar"].first)
+  end
+
+  test "should json-ify operations" do
+    @operation_builder.add_operation_method("foobar")
+    @operation_builder.foobar({name: "passed_option"})
+    assert_equal("{\"foobar\":[{\"name\":\"passed_option\"}]}", @operation_builder.to_json)
+  end
+
+  test "should apply! many operations" do
+    @operation_builder.apply!(foobar: [{name: "passed_option"}])
+
+    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
+    assert_equal 1, operations["foobar"].size
+    assert_equal({"name" => "passed_option"}, operations["foobar"].first)
+  end
+
+  test "should apply! many operations from a string" do
+    @operation_builder.apply!(JSON.generate({foobar: [{name: "passed_option"}]}))
+
+    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
+    assert_equal 1, operations["foobar"].size
+    assert_equal({"name" => "passed_option"}, operations["foobar"].first)
+  end
+
+  test "operations payload should omit empty operations" do
+    @operation_builder.add_operation_method("foobar")
+    payload = @operation_builder.operations_payload
+    assert_equal({}, payload)
+  end
+
+  test "operations payload should camelize keys" do
+    @operation_builder.add_operation_method("foo_bar")
+    @operation_builder.foo_bar({beep_boop: "passed_option"})
+    assert_equal({"fooBar" => [{"beepBoop" => "passed_option"}]}, @operation_builder.operations_payload)
+  end
+
+  test "should take first argument as selector" do
+    @operation_builder.add_operation_method("inner_html")
+
+    @operation_builder.inner_html("#smelly", html: "<span>I rock</span>")
+
+    operations = {
+      "innerHtml" => [{"html" => "<span>I rock</span>", "selector" => "#smelly"}]
+    }
+
+    assert_equal(operations, @operation_builder.operations_payload)
+  end
+
+  test "should use previously passed selector in next operation" do
+    @operation_builder.add_operation_method("inner_html")
+    @operation_builder.add_operation_method("set_focus")
+
+    @operation_builder.set_focus("#smelly").inner_html(html: "<span>I rock</span>")
+
+    operations = {
+      "setFocus" => [{"selector" => "#smelly"}],
+      "innerHtml" => [{"html" => "<span>I rock</span>", "selector" => "#smelly"}]
+    }
+
+    assert_equal(operations, @operation_builder.operations_payload)
+  end
+
+  test "should clear previous_selector after calling reset!" do
+    @operation_builder.add_operation_method("inner_html")
+    @operation_builder.inner_html(selector: "#smelly", html: "<span>I rock</span>")
+
+    @operation_builder.reset!
+
+    @operation_builder.inner_html(html: "<span>winning</span>")
+
+    assert_equal({"innerHtml" => [{"html" => "<span>winning</span>"}]}, @operation_builder.operations_payload)
+  end
+
+  test "should use previous_selector if present and should use `selector` if explicitly provided" do
+    @operation_builder.add_operation_method("inner_html")
+    @operation_builder.add_operation_method("set_focus")
+
+    @operation_builder.set_focus("#smelly").inner_html(html: "<span>I rock</span>").inner_html(html: "<span>I rock too</span>", selector: "#smelly2")
+
+    operations = {
+      "setFocus" => [
+        {"selector" => "#smelly"}
+      ],
+      "innerHtml" => [
+        {"html" => "<span>I rock</span>", "selector" => "#smelly"},
+        {"html" => "<span>I rock too</span>", "selector" => "#smelly2"}
+      ]
+    }
+
+    assert_equal(operations, @operation_builder.operations_payload)
+  end
+end