cable_ready 5.0.0.pre3 → 5.0.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 373a72dbd75eb888edac2ccf0d86cfd3cf2733efa69691ce6860886efdac64f9
-  data.tar.gz: 247ea517c6fe32417a06daaefd726ed10a4f2303ca1bdd6cb7e8bd175cbcb2ca
+  metadata.gz: c2b77b47c0eb8de63edb60db0cb235067ffd3ca9006ad0b2ea61f0b48d187203
+  data.tar.gz: 324b35591eed716da4e7fefda9bf063d9dd8809d5462102936d7c5dd7221caf1
 SHA512:
-  metadata.gz: a03bab6e32acfe5660bebcb08a4b5f782a92b1cf297fdf74627b804f435f55873991202fcf8c715a5644598f5d00af8fa9b4069fb6dcb254c4d4524d3d68820c
-  data.tar.gz: a3ca97dfb6d81aa0d7c12e9db9722b1b2eec834cc15be0b066493ccdc1da99031557fe4c0ffd915f40ed9dd09de8d4ac8e28be4b4c3d0dc7bafbd8240b7ab862
+  metadata.gz: d3117dd4df1af91c451d3e22c84b96f2f430af511437145c03b1212217b87be1b0ce71e58d507ec4a10c268653f04518823ab66e02fd4153f91b3b506fcb985f
+  data.tar.gz: 5416faffa9ba9a6550989f1d21fb7d54adfa1f50fe5d4f96040aaff4de1c0f22dcc4c3128731ae5602dd56733429a9f9164003777ebd9a0629d88f3c9c23a187

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [v5.0.0.pre3](https://github.com/stimulusreflex/cable_ready/tree/v5.0.0.pre3) (2021-08-22)
+
+[Full Changelog](https://github.com/stimulusreflex/cable_ready/compare/v5.0.0.pre2...v5.0.0.pre3)
+
+**Implemented enhancements:**
+
+- redirect\_to operation [\#144](https://github.com/stimulusreflex/cable_ready/pull/144) ([leastbad](https://github.com/leastbad))
+- RFC simplifed JSON payload + named batches [\#142](https://github.com/stimulusreflex/cable_ready/pull/142) ([leastbad](https://github.com/leastbad))
+
+**Merged pull requests:**
+
+- Bump path-parse from 1.0.6 to 1.0.7 [\#143](https://github.com/stimulusreflex/cable_ready/pull/143) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v5.0.0.pre2](https://github.com/stimulusreflex/cable_ready/tree/v5.0.0.pre2) (2021-07-21)
 
 [Full Changelog](https://github.com/stimulusreflex/cable_ready/compare/v5.0.0.pre1...v5.0.0.pre2)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cable_ready (5.0.0.pre3)
+    cable_ready (5.0.0.pre4)
       rails (>= 5.2)
       thread-local (>= 1.1.0)
 
@@ -138,15 +138,13 @@ GEM
       mini_mime (>= 0.1.1)
     marcel (1.0.1)
     method_source (0.9.2)
-    mini_mime (1.1.0)
-    mini_portile2 (2.6.1)
+    mini_mime (1.1.1)
     minitest (5.14.4)
     mocha (1.13.0)
     multi_json (1.15.0)
     multipart-post (2.1.1)
     nio4r (2.5.8)
-    nokogiri (1.12.3)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     octokit (4.21.0)
       faraday (>= 0.9)
@@ -189,7 +187,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.1)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
     railties (6.1.4.1)
       actionpack (= 6.1.4.1)
@@ -227,6 +225,7 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
     standard (1.1.7)
       rubocop (= 1.18.4)
       rubocop-performance (= 1.11.4)
@@ -254,6 +253,7 @@ DEPENDENCIES
   pry
   pry-nav
   rake
+  sqlite3
   standardrb
 
 BUNDLED WITH

data/README.md

@@ -2,8 +2,12 @@
   <img src="https://gitcdn.link/repo/stimulusreflex/cable_ready/master/assets/cable-ready-logo-with-copy.svg" width="360" />
   <h1 align="center">Welcome to CableReady 👋</h1>
   <p align="center">
-    <img src="https://img.shields.io/gem/v/cable_ready.svg?color=red" />
-    <img src="https://img.shields.io/npm/v/cable_ready.svg?color=blue" />
+    <a href="https://rubygems.org/gems/cable_ready"> 
+      <img src="https://img.shields.io/gem/v/cable_ready.svg?color=red" />
+    </a>  
+    <a href="https://www.npmjs.com/package/cable_ready"> 
+      <img src="https://img.shields.io/npm/v/cable_ready.svg?color=blue" />
+    </a>
     <a href="https://www.npmjs.com/package/cable_ready">
       <img alt="downloads" src="https://img.shields.io/npm/dm/cable_ready.svg?color=blue" target="_blank" />
     </a>

data/app/helpers/cable_ready_helper.rb

@@ -4,8 +4,21 @@ module CableReadyHelper
   include CableReady::Compoundable
   include CableReady::StreamIdentifier
 
-  def stream_from(*keys)
+  def stream_from(*keys, html_options: {})
+    tag.stream_from(**build_options(*keys, html_options))
+  end
+
+  def updates_for(*keys, url: nil, debounce: nil, html_options: {}, &block)
+    options = build_options(*keys, html_options)
+    options[:url] = url if url
+    options[:debounce] = debounce if debounce
+    tag.updates_for(**options) { capture(&block) }
+  end
+
+  private
+
+  def build_options(*keys, html_options)
     keys.select!(&:itself)
-    tag.stream_from(identifier: signed_stream_identifier(compound(keys)))
+    {identifier: signed_stream_identifier(compound(keys))}.merge(html_options)
   end
 end

data/app/models/concerns/cable_ready/updatable/collection_updatable_callbacks.rb

@@ -0,0 +1,19 @@
+module CableReady
+  module Updatable
+    class CollectionUpdatableCallbacks
+      def initialize(operation)
+        @operation = operation
+      end
+
+      def after_commit(model)
+        update_collections(model)
+      end
+
+      private
+
+      def update_collections(model)
+        model.class.cable_ready_collections.broadcast_for!(model, @operation)
+      end
+    end
+  end
+end

data/app/models/concerns/cable_ready/updatable/collections_registry.rb

@@ -0,0 +1,33 @@
+module CableReady
+  module Updatable
+    class CollectionsRegistry
+      def initialize
+        @registered_collections = []
+      end
+
+      def register(collection)
+        @registered_collections << collection
+      end
+
+      def broadcast_for!(model, operation)
+        @registered_collections.select { |c| c[:options][:on].include?(operation) }
+          .each do |collection|
+          resource = find_resource_for_update(collection, model)
+          next if resource.nil?
+
+          collection[:klass].cable_ready_update_collection(resource, collection[:name]) if collection[:options][:if].call(resource)
+        end
+      end
+
+      private
+
+      def find_resource_for_update(collection, model)
+        raise ArgumentError, "Could not find inverse_of for #{collection[:name]}" unless collection[:inverse_association]
+
+        resource = model
+        resource = resource.send(collection[:through_association].underscore) if collection[:through_association]
+        resource.send(collection[:inverse_association].underscore)
+      end
+    end
+  end
+end

data/app/models/concerns/cable_ready/updatable/model_updatable_callbacks.rb

@@ -0,0 +1,28 @@
+module CableReady
+  module Updatable
+    class ModelUpdatableCallbacks
+      def initialize(operation, enabled_operations = %i[create update destroy])
+        @operation = operation
+        @enabled_operations = enabled_operations
+      end
+
+      def after_commit(model)
+        return unless @enabled_operations.include?(@operation)
+
+        send("broadcast_#{@operation}", model)
+      end
+
+      private
+
+      def broadcast_create(model)
+        ActionCable.server.broadcast(model.class, {})
+      end
+      alias_method :broadcast_destroy, :broadcast_create
+
+      def broadcast_update(model)
+        ActionCable.server.broadcast(model.class, {})
+        ActionCable.server.broadcast(model.to_global_id, {})
+      end
+    end
+  end
+end

data/app/models/concerns/cable_ready/updatable.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module CableReady
+  module Updatable
+    extend ::ActiveSupport::Concern
+
+    included do |base|
+      if base < ActiveRecord::Base
+        include ExtendHasMany
+
+        after_commit CollectionUpdatableCallbacks.new(:create), on: :create
+        after_commit CollectionUpdatableCallbacks.new(:update), on: :update
+        after_commit CollectionUpdatableCallbacks.new(:destroy), on: :destroy
+
+        def self.enable_updates(*options)
+          options = options.extract_options!
+          options = {
+            on: [:create, :update, :destroy],
+            if: -> { true }
+          }.merge(options)
+
+          enabled_operations = Array(options[:on])
+
+          after_commit(ModelUpdatableCallbacks.new(:create, enabled_operations), {on: :create, if: options[:if]})
+          after_commit(ModelUpdatableCallbacks.new(:update, enabled_operations), {on: :update, if: options[:if]})
+          after_commit(ModelUpdatableCallbacks.new(:destroy, enabled_operations), {on: :destroy, if: options[:if]})
+        end
+      end
+    end
+
+    private
+
+    module ClassMethods
+      def has_many(name, scope = nil, **options, &extension)
+        option = options.delete(:enable_updates)
+        broadcast = option.present?
+        result = super
+        enrich_association_with_updates(name, option) if broadcast
+        result
+      end
+
+      def cable_ready_collections
+        @cable_ready_collections ||= CollectionsRegistry.new
+      end
+
+      def cable_ready_update_collection(resource, name)
+        identifier = resource.to_global_id.to_s + ":" + name.to_s
+        ActionCable.server.broadcast(identifier, {})
+      end
+
+      def enrich_association_with_updates(name, option)
+        reflection = reflect_on_association(name)
+
+        inverse_of = reflection.inverse_of&.name&.to_s
+        through_association = nil
+
+        if reflection.through_reflection?
+          inverse_of = reflection.through_reflection.inverse_of&.name&.to_s
+          through_association = reflection.through_reflection.name.to_s.singularize
+        end
+
+        options = {
+          on: [:create, :update, :destroy],
+          if: ->(resource) { true }
+        }
+
+        case option
+        when TrueClass
+          # proceed!
+        when FalseClass
+          options[:on] = []
+        when Array
+          options[:on] = option
+        when Symbol
+          options[:on] = [option]
+        when Hash
+          option[:on] = Array(option[:on]) if option[:on]
+          options = options.merge!(option)
+        when Proc
+          options[:if] = option
+        else
+          raise ArgumentError, "Invalid enable_updates option #{option}"
+        end
+
+        reflection.klass.send(:include, CableReady::Updatable) unless reflection.klass.respond_to?(:cable_ready_collections)
+
+        reflection.klass.cable_ready_collections.register({
+          klass: self,
+          foreign_key: reflection.foreign_key,
+          name: name,
+          inverse_association: inverse_of,
+          through_association: through_association,
+          options: options
+        })
+      end
+    end
+  end
+end

data/app/models/concerns/extend_has_many.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ExtendHasMany
+  extend ::ActiveSupport::Concern
+
+  class_methods do
+    def has_many(*args, &block)
+      options = args.extract_options!
+      options[:extend] = Array(options[:extend]).push(ClassMethods)
+      super(*args, **options, &block)
+    end
+  end
+end

data/lib/cable_ready/channels.rb

@@ -13,7 +13,7 @@ module CableReady
 
     def [](*keys)
       keys.select!(&:itself)
-      identifier = keys.many? || (keys.one? && keys.first.is_a?(ActiveRecord::Base)) ? compound(keys) : keys.pop
+      identifier = keys.many? || (keys.one? && keys.first.respond_to?(:to_global_id)) ? compound(keys) : keys.pop
       @channels[identifier] ||= CableReady::Channel.new(identifier)
     end
 

data/lib/cable_ready/compoundable.rb

@@ -4,7 +4,7 @@ module CableReady
   module Compoundable
     def compound(keys)
       keys.map { |key|
-        key.class < ActiveRecord::Base ? key.to_global_id.to_s : key.to_s
+        key.respond_to?(:to_global_id) ? key.to_global_id.to_s : key.to_s
       }.join(":")
     end
   end

data/lib/cable_ready/version.rb

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

data/lib/generators/cable_ready/{stream_from_generator.rb → helpers_generator.rb}

@@ -4,7 +4,7 @@ require "rails/generators"
 require "fileutils"
 
 module CableReady
-  class StreamFromGenerator < Rails::Generators::Base
+  class HelpersGenerator < Rails::Generators::Base
     desc "Initializes CableReady with a reference to the shared ActionCable consumer"
     source_root File.expand_path("templates", __dir__)
 

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/models/global_idable_entity.rb

@@ -0,0 +1,16 @@
+class GlobalIdableEntity
+  include GlobalID::Identification
+  include CableReady::Updatable
+
+  def id
+    "fake-id"
+  end
+
+  def self.find(id)
+    new if id == "fake-id"
+  end
+
+  def fake_update
+    ModelUpdatableCallbacks.new(:update).after_commit(self)
+  end
+end

data/test/dummy/app/models/post.rb

@@ -0,0 +1,4 @@
+class Post < ApplicationRecord
+  include CableReady::Updatable
+  belongs_to :user
+end

data/test/dummy/app/models/section.rb

@@ -0,0 +1,6 @@
+class Section < ApplicationRecord
+  include CableReady::Updatable
+  enable_updates if: -> { updates_enabled }
+
+  attribute :updates_enabled, :boolean, default: false
+end

data/test/dummy/app/models/team.rb

@@ -0,0 +1,6 @@
+class Team < ApplicationRecord
+  include CableReady::Updatable
+  enable_updates
+
+  has_many :users, enable_updates: true
+end

data/test/dummy/app/models/topic.rb

@@ -0,0 +1,4 @@
+class Topic < ApplicationRecord
+  include CableReady::Updatable
+  enable_updates on: :create
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,7 @@
+class User < ApplicationRecord
+  include CableReady::Updatable
+  enable_updates
+
+  has_many :posts, enable_updates: true
+  belongs_to :team, optional: true, touch: true
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require "cable_ready"
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,76 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp', 'caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end