cable_ready 5.0.0.pre2 → 5.0.0.pre6

data/test/dummy/db/schema.rb

@@ -0,0 +1,49 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2021_09_13_191759) do
+
+  create_table "posts", force: :cascade do |t|
+    t.string "title"
+    t.integer "user_id", null: false
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+    t.index ["user_id"], name: "index_posts_on_user_id"
+  end
+
+  create_table "sections", force: :cascade do |t|
+    t.string "title"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+
+  create_table "teams", force: :cascade do |t|
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+
+  create_table "topics", force: :cascade do |t|
+    t.string "title"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+
+  create_table "users", force: :cascade do |t|
+    t.string "name"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+    t.integer "team_id"
+    t.index ["team_id"], name: "index_users_on_team_id"
+  end
+
+  add_foreign_key "posts", "users"
+end

data/test/dummy/test/models/post_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class PostTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/models/section_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class SectionTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/models/team_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class TeamTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/models/topic_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class TopicTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/models/user_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class UserTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/lib/cable_ready/cable_car_test.rb

@@ -11,19 +11,19 @@ class CableReady::CableCarTest < ActiveSupport::TestCase
   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)
+    assert_equal([{"operation" => "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))
+    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))
+    assert_equal([{"operation" => "innerHtml", "selector" => "#users", "html" => "<span>winning</span>"}], CableReady::CableCar.instance.instance_variable_get(:@enqueued_operations))
   end
 
   test "selectors should accept any object which respond_to? to_dom_selector" do
@@ -34,7 +34,7 @@ class CableReady::CableCarTest < ActiveSupport::TestCase
       end
     end.new("users")
     dispatch = CableReady::CableCar.instance.inner_html(selector: my_object, html: "<span>winning</span>").dispatch
-    assert_equal({"innerHtml" => [{"selector" => ".users", "html" => "<span>winning</span>"}]}, dispatch)
+    assert_equal([{"operation" => "innerHtml", "selector" => ".users", "html" => "<span>winning</span>"}], dispatch)
   end
 
   test "selectors should accept any object which respond_to? to_dom_id" do
@@ -45,6 +45,6 @@ class CableReady::CableCarTest < ActiveSupport::TestCase
       end
     end.new("users")
     dispatch = CableReady::CableCar.instance.inner_html(selector: my_object, html: "<span>winning</span>").dispatch
-    assert_equal({"innerHtml" => [{"selector" => "#users", "html" => "<span>winning</span>"}]}, dispatch)
+    assert_equal([{"operation" => "innerHtml", "selector" => "#users", "html" => "<span>winning</span>"}], dispatch)
   end
 end

data/test/lib/cable_ready/compoundable_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "../../../lib/cable_ready"
+
+class CableReady::CompoundableTest < ActiveSupport::TestCase
+  include CableReady::Compoundable
+
+  test "compounds an ActiveRecord::Base" do
+    user = User.create(name: "Alan Turing")
+
+    assert_equal "gid://dummy/User/1", compound([user])
+  end
+
+  test "compounds any GlobalId-able entity" do
+    entity = GlobalIdableEntity.new
+
+    assert_equal "gid://dummy/GlobalIdableEntity/fake-id", compound([entity])
+  end
+
+  test "compounds any combination of globalid-able and strings" do
+    user = User.create(name: "Alan Turing")
+
+    assert_equal "gid://dummy/User/1:enigma", compound([user, :enigma])
+  end
+end

data/test/lib/cable_ready/helper_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class CableReady::HelperTest < ActionView::TestCase
+  include CableReadyHelper
+
+  # stream_from
+
+  test "stream_from renders html options" do
+    element = Nokogiri::HTML.fragment(stream_from("key", html_options: {class: "block", data: {controller: "modal"}}) {})
+
+    assert_equal "block", element.children.first["class"]
+    assert_equal "modal", element.children.first["data-controller"]
+  end
+
+  # updates_for
+
+  test "updates_for renders html options" do
+    element = Nokogiri::HTML.fragment(updates_for("key", html_options: {class: "block", data: {controller: "modal"}}) {})
+
+    assert_equal "block", element.children.first["class"]
+    assert_equal "modal", element.children.first["data-controller"]
+  end
+end

data/test/lib/cable_ready/identifiable_test.rb

@@ -3,12 +3,6 @@
 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
 

data/test/lib/cable_ready/operation_builder_test.rb

@@ -55,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
@@ -98,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
@@ -111,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
@@ -127,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
@@ -136,15 +134,11 @@ 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
@@ -155,11 +149,7 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @operation_builder.inner_html(html: death)
 
-    operations = {
-      "innerHtml" => [
-        {"html" => "I rock"}
-      ]
-    }
+    operations = [{"operation" => "innerHtml", "html" => "I rock"}]
 
     assert_equal(operations, @operation_builder.operations_payload)
   end
@@ -170,11 +160,7 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @operation_builder.inner_html(death, html: death)
 
-    operations = {
-      "innerHtml" => [
-        {"html" => "I rock", "selector" => "#death"}
-      ]
-    }
+    operations = [{"operation" => "innerHtml", "html" => "I rock", "selector" => "#death"}]
 
     assert_equal(operations, @operation_builder.operations_payload)
   end
@@ -185,11 +171,7 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @operation_builder.inner_html(death)
 
-    operations = {
-      "innerHtml" => [
-        {"html" => "I rock", "domId" => "death"}
-      ]
-    }
+    operations = [{"operation" => "innerHtml", "html" => "I rock", "domId" => "death"}]
 
     assert_equal(operations, @operation_builder.operations_payload)
   end
@@ -200,11 +182,7 @@ class CableReady::OperationBuilderTest < ActiveSupport::TestCase
 
     @operation_builder.inner_html(life)
 
-    operations = {
-      "innerHtml" => [
-        {"html" => "You go, girl", "domId" => "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"