cable_ready 5.0.0.pre1 → 5.0.0.pre5

data/test/lib/cable_ready/operation_builder_test.rb

@@ -3,6 +3,29 @@
 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")
@@ -32,42 +55,42 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     operations = @operation_builder.instance_variable_get(:@enqueued_operations)
 
-    assert_equal 1, operations["foobar"].size
-    assert_equal({"name" => "passed_option"}, operations["foobar"].first)
+    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("{\"foobar\":[{\"name\":\"passed_option\"}]}", @operation_builder.to_json)
+    assert_equal("[{\"name\":\"passed_option\",\"operation\":\"foobar\"}]", @operation_builder.to_json)
   end
 
   test "should apply! many operations" do
-    @operation_builder.apply!(foobar: [{name: "passed_option"}])
+    @operation_builder.apply!({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)
+    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({foobar: [{name: "passed_option"}]}))
+    @operation_builder.apply!(JSON.generate({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)
+    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)
+    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)
+    assert_equal([{"operation" => "fooBar", "beepBoop" => "passed_option"}], @operation_builder.operations_payload)
   end
 
   test "should take first argument as selector" do
@@ -75,9 +98,7 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @operation_builder.inner_html("#smelly", html: "<span>I rock</span>")
 
-    operations = {
-      "innerHtml" => [{"html" => "<span>I rock</span>", "selector" => "#smelly"}]
-    }
+    operations = [{"operation" => "innerHtml", "html" => "<span>I rock</span>", "selector" => "#smelly"}]
 
     assert_equal(operations, @operation_builder.operations_payload)
   end
@@ -88,10 +109,10 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @operation_builder.set_focus("#smelly").inner_html(html: "<span>I rock</span>")
 
-    operations = {
-      "setFocus" => [{"selector" => "#smelly"}],
-      "innerHtml" => [{"html" => "<span>I rock</span>", "selector" => "#smelly"}]
-    }
+    operations = [
+      {"operation" => "setFocus", "selector" => "#smelly"},
+      {"operation" => "innerHtml", "html" => "<span>I rock</span>", "selector" => "#smelly"}
+    ]
 
     assert_equal(operations, @operation_builder.operations_payload)
   end
@@ -104,7 +125,7 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @operation_builder.inner_html(html: "<span>winning</span>")
 
-    assert_equal({"innerHtml" => [{"html" => "<span>winning</span>"}]}, @operation_builder.operations_payload)
+    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
@@ -113,15 +134,55 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @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"}
-      ]
-    }
+    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

data/test/lib/cable_ready/updatable_test.rb

@@ -0,0 +1,112 @@
+# 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", {}).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", {}).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", {}).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, {}).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, {}).once
+    mock_server.expects(:broadcast).with("gid://dummy/Team/1:users", {}).once
+    mock_server.expects(:broadcast).with(Team, {}).once
+    mock_server.expects(:broadcast).with(team.to_global_id, {}).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, {}).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/test_helper.rb

@@ -3,10 +3,13 @@
 # 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/generators"
 require "rails/test_help"
+require "rails/generators"
 require "minitest/mock"
 require "mocha/minitest"
 require "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 5.0.0.pre1
+  version: 5.0.0.pre5
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - natehop@gmail.com
@@ -154,6 +168,11 @@ files:
 - app/channels/cable_ready/stream.rb
 - app/helpers/cable_ready_helper.rb
 - app/jobs/cable_ready_broadcast_job.rb
+- app/models/concerns/cable_ready/updatable.rb
+- app/models/concerns/cable_ready/updatable/collection_updatable_callbacks.rb
+- app/models/concerns/cable_ready/updatable/collections_registry.rb
+- app/models/concerns/cable_ready/updatable/model_updatable_callbacks.rb
+- app/models/concerns/extend_has_many.rb
 - bin/console
 - bin/loc
 - bin/setup
@@ -171,12 +190,59 @@ files:
 - lib/cable_ready/stream_identifier.rb
 - lib/cable_ready/version.rb
 - lib/generators/cable_ready/channel_generator.rb
+- lib/generators/cable_ready/helpers_generator.rb
 - lib/generators/cable_ready/initializer_generator.rb
-- lib/generators/cable_ready/stream_from_generator.rb
 - lib/generators/cable_ready/templates/config/initializers/cable_ready.rb
+- test/dummy/app/channels/application_cable/channel.rb
+- test/dummy/app/channels/application_cable/connection.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/jobs/application_job.rb
+- test/dummy/app/mailers/application_mailer.rb
+- test/dummy/app/models/application_record.rb
+- test/dummy/app/models/global_idable_entity.rb
+- test/dummy/app/models/post.rb
+- test/dummy/app/models/section.rb
+- test/dummy/app/models/team.rb
+- test/dummy/app/models/topic.rb
+- test/dummy/app/models/user.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/application_controller_renderer.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/cable_ready.rb
+- test/dummy/config/initializers/content_security_policy.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/permissions_policy.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/puma.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/migrate/20210902154139_create_users.rb
+- test/dummy/db/migrate/20210902154153_create_posts.rb
+- test/dummy/db/migrate/20210904081930_create_topics.rb
+- test/dummy/db/migrate/20210904093607_create_sections.rb
+- test/dummy/db/migrate/20210913191735_create_teams.rb
+- test/dummy/db/migrate/20210913191759_add_team_reference_to_users.rb
+- test/dummy/db/schema.rb
+- test/dummy/test/models/post_test.rb
+- test/dummy/test/models/section_test.rb
+- test/dummy/test/models/team_test.rb
+- test/dummy/test/models/topic_test.rb
+- test/dummy/test/models/user_test.rb
 - test/lib/cable_ready/cable_car_test.rb
+- test/lib/cable_ready/compoundable_test.rb
+- test/lib/cable_ready/helper_test.rb
 - test/lib/cable_ready/identifiable_test.rb
 - test/lib/cable_ready/operation_builder_test.rb
+- test/lib/cable_ready/updatable_test.rb
 - test/lib/generators/cable_ready/channel_generator_test.rb
 - test/support/generator_test_helpers.rb
 - test/test_helper.rb
@@ -204,9 +270,56 @@ signing_key:
 specification_version: 4
 summary: Out-of-Band Server Triggered DOM Operations
 test_files:
+- test/dummy/db/migrate/20210904093607_create_sections.rb
+- test/dummy/db/migrate/20210913191759_add_team_reference_to_users.rb
+- test/dummy/db/migrate/20210904081930_create_topics.rb
+- test/dummy/db/migrate/20210913191735_create_teams.rb
+- test/dummy/db/migrate/20210902154153_create_posts.rb
+- test/dummy/db/migrate/20210902154139_create_users.rb
+- test/dummy/db/schema.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/application.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/content_security_policy.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/permissions_policy.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/application_controller_renderer.rb
+- test/dummy/config/initializers/cable_ready.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/puma.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/app/channels/application_cable/channel.rb
+- test/dummy/app/channels/application_cable/connection.rb
+- test/dummy/app/jobs/application_job.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/models/user.rb
+- test/dummy/app/models/section.rb
+- test/dummy/app/models/post.rb
+- test/dummy/app/models/team.rb
+- test/dummy/app/models/topic.rb
+- test/dummy/app/models/application_record.rb
+- test/dummy/app/models/global_idable_entity.rb
+- test/dummy/app/mailers/application_mailer.rb
+- test/dummy/test/models/section_test.rb
+- test/dummy/test/models/post_test.rb
+- test/dummy/test/models/user_test.rb
+- test/dummy/test/models/team_test.rb
+- test/dummy/test/models/topic_test.rb
 - test/support/generator_test_helpers.rb
 - test/lib/generators/cable_ready/channel_generator_test.rb
 - test/lib/cable_ready/cable_car_test.rb
+- test/lib/cable_ready/helper_test.rb
 - test/lib/cable_ready/identifiable_test.rb
+- test/lib/cable_ready/compoundable_test.rb
 - test/lib/cable_ready/operation_builder_test.rb
+- test/lib/cable_ready/updatable_test.rb
 - test/test_helper.rb