cable_ready 4.2.0 → 4.3.0.pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e576813856258661e5734171c7b318a2cb175555380b930ecd7e39070c8ccf0c
-  data.tar.gz: 3a1523ab640bade41097d06b92e9ee30280c6cab87b5a76b0d213107e096d289
+  metadata.gz: 97d1c34cd35126aebacd48f7aca392baa47991f89677ea1f22fc7c6c7cdc3ff8
+  data.tar.gz: ea3aac6324f788063497cd88100200e5168cebb5b6e74b9a5ce8b5c32c65df6c
 SHA512:
-  metadata.gz: 5a28688ca371e11cb503f6fcd7e390911488885ee50bae435963eaa42f4d641568766470121d7b7c7bf2d90d1a74dd48faa52c9a22a860fa1d91d26cf059b17f
-  data.tar.gz: 74a88801ef990880f5d8d2724f9f37cdf510a195979474d1f78ea15d73b2dfe4e9ff26c99dca4638cf916d5f5162c6aad4ad9b5c711157f7c93138459f311dc1
+  metadata.gz: d625cb0b81b01dfd7a4dfa6bf452fdb5b56ea1e231bb56441801818ff1d31b78a58b032c0af0d33be8e447660b419c1693b291fea6eb5aa10b094611fbc19b89
+  data.tar.gz: f39ea747112802ee20f11557820e65894596e940adb146fca7bbc6d21aeb92380393144188826f943111ca28f4a06ace7fa6999d258b38af7df2ff1cc5ff0f4e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cable_ready (4.2.0)
+    cable_ready (4.3.0.pre0)
       rails (>= 5.2)
 
 GEM
@@ -62,7 +62,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.0)
+    ast (2.4.1)
     builder (3.2.4)
     coderay (1.1.3)
     concurrent-ruby (1.1.6)
@@ -70,7 +70,7 @@ GEM
     erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
     loofah (2.5.0)
       crass (~> 1.0.2)
@@ -126,27 +126,32 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.83.0)
+    rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
-    sprockets (4.0.0)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    standard (0.4.6)
-      rubocop (~> 0.83.0)
-      rubocop-performance (~> 1.5.2)
+    standard (0.4.7)
+      rubocop (~> 0.85.0)
+      rubocop-performance (~> 1.6.0)
     standardrb (1.0.0)
       standard
     thor (1.0.1)
@@ -156,7 +161,7 @@ GEM
     unicode-display_width (1.7.0)
     websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
+    websocket-extensions (0.1.5)
     zeitwerk (2.3.0)
 
 PLATFORMS

data/lib/cable_ready/broadcaster.rb

@@ -7,7 +7,11 @@ module CableReady
     extend ::ActiveSupport::Concern
 
     def cable_ready
-      @cable_ready_channels ||= CableReady::Channels.new
+      CableReady::Channels.instance
+    end
+
+    def dom_id(record, prefix = nil)
+      "##{ActionView::RecordIdentifier.dom_id(record, prefix)}"
     end
   end
 end

data/lib/cable_ready/channel.rb

@@ -2,234 +2,39 @@
 
 module CableReady
   class Channel
-    attr_reader :name, :operations
+    attr_reader :identifier, :operations, :available_operations
 
-    # Example Operations Payload:
-    #
-    # {
-    #   # Cookies .....................................................................................................
-    #
-    #   set_cookie: [
-    #     {cookie: "example=value; path=/; expires=Sat, 07 Mar 2020 16:19:19 GMT"},
-    #     ...
-    #   ]
-    #
-    #   # DOM Events ..................................................................................................
-    #
-    #   dispatch_event: [{
-    #     name:     "string",
-    #     detail:   "object",
-    #     selector: "string",
-    #   }, ...],
-    #
-    #   # Element Mutations ...........................................................................................
-    #
-    #   morph: [{
-    #     selector:      "string",
-    #     html:          "string"
-    #     children_only:  true|false,
-    #     permanent_attribute_name: "string",
-    #     focus_selector: "string",
-    #   }, ...],
-    #
-    #   inner_html: [{
-    #     selector:      "string",
-    #     focus_selector: "string",
-    #     html:          "string"
-    #   }, ...],
-    #
-    #   outer_html: [{
-    #     selector:      "string",
-    #     focus_selector: "string",
-    #     html:          "string"
-    #   }, ...],
-    #
-    #   text_content: [{
-    #     selector: "string",
-    #     text:     "string"
-    #   }, ...]
-    #
-    #   insert_adjacent_html: [{
-    #     selector:      "string",
-    #     focus_selector: "string",
-    #     position:      "string",
-    #     html:          "string"
-    #   }, ...],
-    #
-    #   insert_adjacent_text: [{
-    #     selector: "string",
-    #     position: "string",
-    #     text:     "string"
-    #   }, ...],
-    #
-    #   remove: [{
-    #     selector:      "string",
-    #     focus_selector: "string,
-    #   }, ...],
-    #
-    #   set_property: [{
-    #     name:     "string",
-    #     selector: "string",
-    #     value:    "string"
-    #   }, ...],
-    #
-    #   set_value: [{
-    #     selector: "string",
-    #     value:    "string"
-    #   }, ...],
-    #
-    #   # Attribute Mutations .........................................................................................
-    #
-    #   set_attribute: [{
-    #     selector: "string",
-    #     name:     "string",
-    #     value:    "string"
-    #   }, ...],
-    #
-    #   remove_attribute: [{
-    #     selector: "string",
-    #     name:     "string"
-    #   }, ...],
-    #
-    #   # CSS Class Mutations .........................................................................................
-    #
-    #   add_css_class: [{
-    #     selector: "string",
-    #     name:     "string"
-    #   }, ...],
-    #
-    #   remove_css_class: [{
-    #     selector: "string",
-    #     name:     "string"
-    #   }, ...],
-    #
-    #   # Style Mutations ...........................................................................................
-    #
-    #   set_style: [{
-    #     selector: "string",
-    #     name:     "string",
-    #     value:    "string"
-    #   }, ...],
-    #
-    #   # Dataset Mutations ...........................................................................................
-    #
-    #   set_dataset_property: [{
-    #     selector: "string",
-    #     name:     "string",
-    #     value:    "string"
-    #   }, ...],
-    # }
-    def initialize(name)
-      @name = name
-      @operations = stub
+    def initialize(identifier, available_operations)
+      @identifier = identifier
+      @available_operations = available_operations
+      reset
+      available_operations.each do |available_operation, implementation|
+        define_singleton_method available_operation, &implementation
+      end
     end
 
-    def clear
-      @operations = stub
-    end
-
-    def broadcast
+    def broadcast(clear)
       operations.select! { |_, list| list.present? }
       operations.deep_transform_keys! { |key| key.to_s.camelize(:lower) }
-      ActionCable.server.broadcast name, "cableReady" => true, "operations" => operations
-      clear
-    end
-
-    def set_cookie(value)
-      add_operation(:set_cookie, {cookie: value})
-    end
-
-    def dispatch_event(options = {})
-      add_operation(:dispatch_event, options)
-    end
-
-    def morph(options = {})
-      add_operation(:morph, options)
-    end
-
-    def inner_html(options = {})
-      add_operation(:inner_html, options)
-    end
-
-    def outer_html(options = {})
-      add_operation(:outer_html, options)
-    end
-
-    def text_content(options = {})
-      add_operation(:text_content, options)
-    end
-
-    def insert_adjacent_html(options = {})
-      add_operation(:insert_adjacent_html, options)
-    end
-
-    def insert_adjacent_text(options = {})
-      add_operation(:insert_adjacent_text, options)
+      ActionCable.server.broadcast identifier, "cableReady" => true, "operations" => operations
+      reset if clear
     end
 
-    def remove(options = {})
-      add_operation(:remove, options)
-    end
-
-    def set_property(options = {})
-      add_operation(:set_property, options)
-    end
-
-    def set_value(options = {})
-      add_operation(:set_value, options)
-    end
-
-    def set_attribute(options = {})
-      add_operation(:set_attribute, options)
-    end
-
-    def remove_attribute(options = {})
-      add_operation(:remove_attribute, options)
-    end
-
-    def add_css_class(options = {})
-      add_operation(:add_css_class, options)
-    end
-
-    def remove_css_class(options = {})
-      add_operation(:remove_css_class, options)
-    end
-
-    def set_style(options = {})
-      add_operation(:set_style, options)
-    end
-
-    def set_dataset_property(options = {})
-      add_operation(:set_dataset_property, options)
+    def broadcast_to(model, clear)
+      operations.select! { |_, list| list.present? }
+      operations.deep_transform_keys! { |key| key.to_s.camelize(:lower) }
+      identifier.broadcast_to model, "cableReady" => true, "operations" => operations
+      reset if clear
     end
 
     private
 
     def add_operation(key, options)
-      operations[key] ||= []
       operations[key] << options
     end
 
-    def stub
-      {
-        add_css_class: [],
-        dispatch_event: [],
-        inner_html: [],
-        insert_adjacent_html: [],
-        insert_adjacent_text: [],
-        morph: [],
-        outer_html: [],
-        remove: [],
-        remove_attribute: [],
-        remove_css_class: [],
-        set_attribute: [],
-        set_cookie: [],
-        set_dataset_property: [],
-        set_style: [],
-        set_property: [],
-        set_value: [],
-        text_content: []
-      }
+    def reset
+      @operations = Hash.new { |hash, operation| hash[operation] = [] }
     end
   end
 end

data/lib/cable_ready/channels.rb

@@ -4,21 +4,65 @@ require_relative "channel"
 
 module CableReady
   class Channels
+    include Singleton
+    attr_accessor :operations
+
+    def self.configure
+      yield CableReady::Channels.instance if block_given?
+    end
+
     def initialize
       @channels = {}
+      @operations = {}
+      %i[
+        add_css_class
+        dispatch_event
+        inner_html
+        insert_adjacent_html
+        insert_adjacent_text
+        morph
+        outer_html
+        remove
+        remove_attribute
+        remove_css_class
+        set_attribute
+        set_cookie
+        set_dataset_property
+        set_property
+        set_style
+        set_styles
+        set_value
+      ].each do |operation|
+        add_operation operation
+      end
     end
 
-    def [](channel_name)
-      @channels[channel_name] ||= CableReady::Channel.new(channel_name)
+    def add_operation(operation, &implementation)
+      @operations[operation] = implementation || ->(options = {}) { add_operation(operation, options) }
     end
 
-    def clear
-      @channels = {}
+    def [](identifier)
+      @channels[identifier] ||= CableReady::Channel.new(identifier, operations)
+    end
+
+    def broadcast(*identifiers, clear: true)
+      @channels.values
+        .reject { |channel| identifiers.any? && identifiers.exclude?(channel.identifier) }
+        .select { |channel| channel.identifier.is_a?(String) }
+        .tap do |channels|
+          channels.each { |channel| @channels[channel.identifier].broadcast(clear) }
+          channels.each { |channel| @channels.except!(channel.identifier) if clear }
+        end
     end
 
-    def broadcast
-      @channels.values.map(&:broadcast)
-      clear
+    def broadcast_to(model, *identifiers, clear: true)
+      @channels.values
+        .reject { |channel| identifiers.any? && identifiers.exclude?(channel.identifier) }
+        .reject { |channel| channel.identifier.is_a?(String) }
+        .tap do |channels|
+          channels.each { |channel| @channels[channel.identifier].broadcast_to(model, clear) }
+          channels.each { |channel| @channels.except!(channel.identifier) if clear }
+        end
     end
   end
 end

data/lib/cable_ready/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableReady
-  VERSION = "4.2.0"
+  VERSION = "4.3.0.pre0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0.pre0
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,9 +120,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: