cable_ready 5.0.0.pre8 → 5.0.0.pre10

data/test/lib/cable_ready/identifiable_test.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-require_relative "../../../lib/cable_ready"
-
-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

@@ -1,189 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-require_relative "../../../lib/cable_ready"
-
-class Death
-  def to_html
-    "I rock"
-  end
-
-  def to_dom_id
-    "death"
-  end
-
-  def to_operation_options
-    [:html, :dom_id, :spaz]
-  end
-end
-
-class Life
-  def to_operation_options
-    {
-      html: "You go, girl",
-      dom_id: "life"
-    }
-  end
-end
-
-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.size
-    assert_equal({"name" => "passed_option", "operation" => "foobar"}, operations.first)
-  end
-
-  test "should json-ify operations" do
-    @operation_builder.add_operation_method("foobar")
-    @operation_builder.foobar({name: "passed_option"})
-    assert_equal("[{\"name\":\"passed_option\",\"operation\":\"foobar\"}]", @operation_builder.to_json)
-  end
-
-  test "should apply! many operations" do
-    @operation_builder.apply!({name: "passed_option"})
-
-    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
-    assert_equal 1, operations.size
-    assert_equal({"name" => "passed_option"}, operations.first)
-  end
-
-  test "should apply! many operations from a string" do
-    @operation_builder.apply!(JSON.generate({name: "passed_option"}))
-
-    operations = @operation_builder.instance_variable_get(:@enqueued_operations)
-    assert_equal 1, operations.size
-    assert_equal({"name" => "passed_option"}, operations.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([{"operation" => "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 = [{"operation" => "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 = [
-      {"operation" => "setFocus", "selector" => "#smelly"},
-      {"operation" => "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([{"operation" => "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 = [
-      {"operation" => "setFocus", "selector" => "#smelly"},
-      {"operation" => "innerHtml", "html" => "<span>I rock</span>", "selector" => "#smelly"},
-      {"operation" => "innerHtml", "html" => "<span>I rock too</span>", "selector" => "#smelly2"}
-    ]
-
-    assert_equal(operations, @operation_builder.operations_payload)
-  end
-
-  test "should pull html option from Death object" do
-    @operation_builder.add_operation_method("inner_html")
-    death = Death.new
-
-    @operation_builder.inner_html(html: death)
-
-    operations = [{"operation" => "innerHtml", "html" => "I rock"}]
-
-    assert_equal(operations, @operation_builder.operations_payload)
-  end
-
-  test "should pull html option with selector from Death object" do
-    @operation_builder.add_operation_method("inner_html")
-    death = Death.new
-
-    @operation_builder.inner_html(death, html: death)
-
-    operations = [{"operation" => "innerHtml", "html" => "I rock", "selector" => "#death"}]
-
-    assert_equal(operations, @operation_builder.operations_payload)
-  end
-
-  test "should pull html and dom_id options from Death object" do
-    @operation_builder.add_operation_method("inner_html")
-    death = Death.new
-
-    @operation_builder.inner_html(death)
-
-    operations = [{"operation" => "innerHtml", "html" => "I rock", "domId" => "death"}]
-
-    assert_equal(operations, @operation_builder.operations_payload)
-  end
-
-  test "should pull html and dom_id options from Life object" do
-    @operation_builder.add_operation_method("inner_html")
-    life = Life.new
-
-    @operation_builder.inner_html(life)
-
-    operations = [{"operation" => "innerHtml", "html" => "You go, girl", "domId" => "life"}]
-
-    assert_equal(operations, @operation_builder.operations_payload)
-  end
-end

data/test/lib/cable_ready/updatable_test.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class CableReady::UpdatableTest < ActiveSupport::TestCase
-  test "includes the module automatically in associated models" do
-    user = User.create(name: "John Doe")
-
-    post = user.posts.build
-    assert post.class < CableReady::Updatable
-  end
-
-  test "updates the collection when an item is added" do
-    mock_server = mock("server")
-    mock_server.expects(:broadcast).with(User, {}).once
-    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {changed: ["id", "title", "user_id", "created_at", "updated_at"]}).once
-
-    ActionCable.stubs(:server).returns(mock_server)
-    user = User.create(name: "John Doe")
-
-    user.posts.create(title: "Lorem")
-  end
-
-  test "updates the collection when an item is destroyed" do
-    user = User.create(name: "John Doe")
-    post = user.posts.create(title: "Lorem")
-
-    mock_server = mock("server")
-    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {changed: ["id", "title", "user_id", "created_at", "updated_at"]}).once
-
-    ActionCable.stubs(:server).returns(mock_server)
-
-    post.destroy
-  end
-
-  test "updates the collection when an item is updated" do
-    user = User.create(name: "John Doe")
-    post = user.posts.create(title: "Lorem")
-
-    mock_server = mock("server")
-    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {changed: ["title", "updated_at"]}).once
-
-    ActionCable.stubs(:server).returns(mock_server)
-
-    post.update(title: "Ipsum")
-  end
-
-  test "updates the model when it is updated" do
-    user = User.create(name: "John Doe")
-
-    mock_server = mock("server")
-    mock_server.expects(:broadcast).with(User, {}).once
-    mock_server.expects(:broadcast).with(user.to_global_id, {changed: ["name", "updated_at"]}).once
-
-    ActionCable.stubs(:server).returns(mock_server)
-
-    user.update(name: "Jane Doe")
-  end
-
-  test "updates the parent when it is touched" do
-    team = Team.create
-    user = team.users.create(name: "Ada Lovelace")
-
-    mock_server = mock("server")
-    mock_server.expects(:broadcast).with(User, {}).once
-    mock_server.expects(:broadcast).with(user.to_global_id, {changed: ["name", "updated_at"]}).once
-    mock_server.expects(:broadcast).with("gid://dummy/Team/1:users", {changed: ["name", "updated_at"]}).once
-    mock_server.expects(:broadcast).with(Team, {}).once
-    mock_server.expects(:broadcast).with(team.to_global_id, {changed: ["id", "created_at", "updated_at"]}).once
-
-    ActionCable.stubs(:server).returns(mock_server)
-
-    user.update(name: "Jane Doe")
-  end
-
-  test "respects :on to specify persistence methods" do
-    mock_server = mock("server")
-
-    ActionCable.stubs(:server).returns(mock_server)
-
-    mock_server.expects(:broadcast).with(Topic, {}).once
-    topic = Topic.create(title: "Reactive Rails with Hotwire")
-
-    mock_server.expects(:broadcast).with(topic.to_global_id, {}).never
-    topic.update(title: "Reactive Rails with CableReady")
-  end
-
-  test "respects :if on enable_updates" do
-    mock_server = mock("server")
-
-    ActionCable.stubs(:server).returns(mock_server)
-
-    section = Section.create
-    section.updates_enabled = true
-
-    mock_server.expects(:broadcast).with(Section, {}).once
-    mock_server.expects(:broadcast).with(section.to_global_id, {changed: ["title", "updated_at", "updates_enabled"]}).once
-    section.update(title: "First Section")
-  end
-
-  test "updates any GlobalID-able entity" do
-    entity = GlobalIdableEntity.new
-
-    mock_server = mock("server")
-    mock_server.expects(:broadcast).with(GlobalIdableEntity, {}).once
-    mock_server.expects(:broadcast).with(entity.to_global_id, {}).once
-
-    ActionCable.stubs(:server).returns(mock_server)
-
-    entity.fake_update
-  end
-end

data/test/lib/generators/cable_ready/channel_generator_test.rb

@@ -1,157 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-require "generators/cable_ready/channel_generator"
-
-class CableReady::ChannelGeneratorTest < Rails::Generators::TestCase
-  include ::GeneratorTestHelpers
-
-  tests CableReady::ChannelGenerator
-  destination File.expand_path("../../../../tmp/dummy", __dir__)
-
-  prepare_destination
-  create_sample_app
-
-  MiniTest.after_run do
-    remove_sample_app
-  end
-
-  test "should generate channel with the same resource name and stimulus controller" do
-    run_generator ["user", "--stream-for=user", "--stimulus"]
-
-    assert_file "app/channels/user_channel.rb" do |content|
-      assert_match(/class\ UserChannel\ </, content)
-      assert_match(/stream_for\ User\.find\(params\[:id\]\)/, content)
-    end
-
-    assert_file "app/javascript/channels/user_channel.js", /"UserChannel"/
-    assert_file "app/javascript/controllers/user_controller.js", /'UserChannel'/
-  end
-
-  test "should generate channel with different resource name" do
-    run_generator ["my_name", "--stream-for=under_scored_resource_name", "--no-stimulus"]
-
-    assert_file "app/channels/my_name_channel.rb" do |content|
-      assert_match(/class\ MyNameChannel\ </, content)
-      assert_match(/stream_for\ UnderScoredResourceName\.find\(params\[:id\]\)/, content)
-    end
-
-    assert_file "app/javascript/channels/my_name_channel.js", /"MyNameChannel"/
-    assert_no_file "app/javascript/controllers/my_name_controller.js"
-  end
-
-  test "should not generate stimulus controller if not requested" do
-    run_generator ["comment", "--stream-for=comment", "--no-stimulus"]
-
-    assert_file "app/channels/comment_channel.rb"
-    assert_file "app/javascript/channels/comment_channel.js"
-    assert_no_file "app/javascript/controllers/comment_controller.js"
-  end
-
-  test "should run the generator when streaming from identifier" do
-    run_generator ["page", "--stream-from=page"]
-
-    assert_file "app/channels/page_channel.rb" do |content|
-      assert_match(/PageChannel/, content)
-      assert_match(/stream_from\ "page"/, content)
-    end
-
-    assert_file "app/javascript/channels/page_channel.js" do |content|
-      assert_match(/"PageChannel"/, content)
-      assert_match(/import\ CableReady/, content)
-      assert_match(/if\ \(data\.cableReady\)\ CableReady\.perform\(data\.operations\)/, content)
-    end
-  end
-
-  test "should run the generator when streaming without resource and different identifier" do
-    run_generator ["my_page", "--stream-from=ThisIsMyPage"]
-
-    assert_file "app/channels/my_page_channel.rb" do |content|
-      assert_match(/MyPageChannel/, content)
-      assert_match(/stream_from\ "this_is_my_page"/, content)
-    end
-
-    assert_file "app/javascript/channels/my_page_channel.js" do |content|
-      assert_match(/"MyPageChannel"/, content)
-      assert_match(/import\ CableReady/, content)
-      assert_match(/if\ \(data\.cableReady\)\ CableReady\.perform\(data\.operations\)/, content)
-    end
-  end
-
-  test "should run the generator and use the NAME for --stream-from if nothing passed" do
-    run_generator ["house", "--stream-from"]
-
-    assert_file "app/channels/house_channel.rb" do |content|
-      assert_match(/HouseChannel/, content)
-      assert_match(/stream_from\ "house"/, content)
-    end
-
-    assert_file "app/javascript/channels/house_channel.js" do |content|
-      assert_match(/"HouseChannel"/, content)
-      assert_match(/import\ CableReady/, content)
-      assert_match(/if\ \(data\.cableReady\)\ CableReady\.perform\(data\.operations\)/, content)
-    end
-  end
-
-  test "should run the generator and use the NAME for --stream-for if nothing passed" do
-    run_generator ["option", "--stream-for", "--stimulus"]
-
-    assert_file "app/channels/option_channel.rb" do |content|
-      assert_match(/class\ OptionChannel\ </, content)
-      assert_match(/stream_for\ Option\.find\(params\[:id\]\)/, content)
-    end
-
-    assert_file "app/javascript/channels/option_channel.js", /"OptionChannel"/
-    assert_file "app/javascript/controllers/option_controller.js", /'OptionChannel'/
-  end
-
-  test "should run not generate anything if passed stream_from and stream_for" do
-    assert_raises "Can't specify --stream-from and --stream-for at the same time" do
-      run_generator ["error", "--stream-from=1", "--stream-for=2"]
-    end
-  end
-
-  # some tests without generator options to simulate the inputs passed via cli
-
-  test "should generate channel with the same resource name and stimulus controller (without options)" do
-    CableReady::ChannelGenerator.any_instance.stubs(:using_broadcast_to?).returns(true)
-    CableReady::ChannelGenerator.any_instance.stubs(:resource).returns("Post")
-    CableReady::ChannelGenerator.any_instance.stubs(:using_stimulus?).returns(true)
-
-    run_generator ["post"]
-
-    assert_file "app/channels/post_channel.rb" do |content|
-      assert_match(/class\ PostChannel\ </, content)
-      assert_match(/stream_for\ Post\.find\(params\[:id\]\)/, content)
-    end
-
-    assert_file "app/javascript/channels/post_channel.js", /PostChannel/
-    assert_file "app/javascript/controllers/post_controller.js", /'PostChannel'/
-  end
-
-  test "should not generate stimulus controller if not requested (without options)" do
-    CableReady::ChannelGenerator.any_instance.stubs(:using_broadcast_to?).returns(true)
-    CableReady::ChannelGenerator.any_instance.stubs(:resource).returns("Admin")
-    CableReady::ChannelGenerator.any_instance.stubs(:using_stimulus?).returns(false)
-
-    run_generator ["admin"]
-
-    assert_file "app/channels/admin_channel.rb"
-    assert_file "app/javascript/channels/admin_channel.js"
-    assert_no_file "app/javascript/controllers/admin_controller.js"
-  end
-
-  test "should run the generator when streaming from identifier (without options)" do
-    CableReady::ChannelGenerator.any_instance.stubs(:using_broadcast_to?).returns(false)
-    CableReady::ChannelGenerator.any_instance.stubs(:identifier).returns("index_identifier")
-
-    run_generator ["index"]
-
-    assert_file "app/channels/index_channel.rb" do |content|
-      assert_match(/IndexChannel/, content)
-      assert_match(/stream_from\ "index_identifier"/, content)
-    end
-
-    assert_file "app/javascript/channels/index_channel.js", /"IndexChannel"/
-  end
-end

data/test/support/generator_test_helpers.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module GeneratorTestHelpers
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    def sample_app_path
-      File.expand_path("../../tmp/dummy", __dir__)
-    end
-
-    def prepare_destination
-      FileUtils.rm_rf(sample_app_path) if Dir.exist?(sample_app_path)
-      FileUtils.mkdir_p(sample_app_path)
-    end
-
-    def create_sample_app
-      FileUtils.cd(sample_app_path) do
-        system "rails new . --minimal --skip-active-record --skip-test-unit --skip-spring --skip-bundle --quiet --force"
-      end
-    end
-
-    def remove_sample_app
-      FileUtils.rm_rf(destination_root)
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
-
-require_relative "../test/dummy/config/environment"
-ActiveRecord::Migrator.migrations_paths = [File.expand_path("../test/dummy/db/migrate", __dir__)]
-
-require "mocha"
-require "rails"
-require "rails/test_help"
-require "rails/generators"
-require "minitest/mock"
-require "mocha/minitest"
-require "pry"
-
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }