cable_ready 5.0.0.pre3 → 5.0.0.pre4

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.pre3
+  version: 5.0.0.pre4
 platform: ruby
 authors:
 - Nathan Hopkins
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-22 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,7 +136,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !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
 executables: []
@@ -154,11 +168,15 @@ 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
 - bin/standardize
-- cable_ready.gemspec
 - lib/cable_ready.rb
 - lib/cable_ready/broadcaster.rb
 - lib/cable_ready/cable_car.rb
@@ -172,22 +190,67 @@ 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
-- package.json
+- 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
-- yarn.lock
 homepage: https://github.com/stimulusreflex/cable_ready
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -202,14 +265,61 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+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/generators/cable_ready/channel_generator_test.rb
-- test/support/generator_test_helpers.rb
+- test/lib/cable_ready/updatable_test.rb
 - test/test_helper.rb

data/cable_ready.gemspec

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path("../lib/cable_ready/version", __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name = "cable_ready"
-  gem.license = "MIT"
-  gem.version = CableReady::VERSION
-  gem.authors = ["Nathan Hopkins"]
-  gem.email = ["natehop@gmail.com"]
-  gem.homepage = "https://github.com/stimulusreflex/cable_ready"
-  gem.summary = "Out-of-Band Server Triggered DOM Operations"
-
-  gem.files = Dir["lib/**/*.rb", "app/**/*.rb", "bin/*", "[A-Z]*"]
-  gem.test_files = Dir["test/**/*.rb"]
-
-  gem.add_dependency "rails", ">= 5.2"
-  gem.add_dependency "thread-local", ">= 1.1.0"
-
-  gem.add_development_dependency "github_changelog_generator"
-  gem.add_development_dependency "magic_frozen_string_literal"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "pry-nav"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "standardrb"
-  gem.add_development_dependency "mocha"
-end

data/package.json

@@ -1,41 +0,0 @@
-{
-  "name": "cable_ready",
-  "version": "5.0.0-pre2",
-  "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",
-    "rails",
-    "websockets",
-    "actioncable",
-    "cable",
-    "ssr",
-    "stimulus_reflex",
-    "client-side",
-    "dom"
-  ],
-  "homepage": "https://cableready.stimulusreflex.com/",
-  "bugs": {
-    "url": "https://github.com/stimulusreflex/cable_ready/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com:stimulusreflex/cable_ready.git"
-  },
-  "license": "MIT",
-  "author": "Nathan Hopkins <natehop@gmail.com>",
-  "main": "./javascript/index.js",
-  "module": "./javascript/index.js",
-  "sideEffects": false,
-  "scripts": {
-    "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"
-  },
-  "devDependencies": {
-    "prettier-standard": "^16.1.0"
-  }
-}