cable_ready 4.1.2 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b524261f179ef36351139f62eac34d6e3f4ad90b5626eb71ebc9bd368524aa
-  data.tar.gz: be0dffbea3c713678a1e4887930556ced3435090f84bdf7e8d8b7f626ff9ddc9
+  metadata.gz: 8c64f56b02d7ac814d1909149267d2a10903fa8cc1fd4996af065135ef4fca5a
+  data.tar.gz: 47d94429d8fba53a4cb3b9f5f105bf53da68830d1d4d512c2cc7e017936ddb1d
 SHA512:
-  metadata.gz: b283d70fd3de8232d790a0bf9567bbb1ed61966a3fdf97b67fc76da447ce8b3a7f1d8330a5bfe66c6089bef76a9cde7b5a009c4f22f4850a2b665fe6ed0919b1
-  data.tar.gz: a424e5a43efb594c4bb40544072a841f5578a5bda7ea20f54e8db62ff4371779474a76c9a9066d6c44b1b88bddcfb07142d41445c4a5b6d8ce0efedbaebebfa3
+  metadata.gz: b5fef3ec938193b59e0ff8c7bd7e1c6737f48ba1e48d467daaeb9839c2ced7aa65304aa35db9519ac07eecb7629c1a58a6b7c614ff404b89fb4725510e9f58d0
+  data.tar.gz: bb409409c7ad06fbd3a7e46aa8277b030f4e27414b20aaed4cd18c7b21be8440f891ab9cf57570636bea0733220f4a4d1116893ff0044001fa1297943d121deb

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in cable_ready.gemspec

data/Gemfile.lock

@@ -1,79 +1,78 @@
 PATH
   remote: .
   specs:
-    cable_ready (4.1.2)
+    cable_ready (4.3.0)
       rails (>= 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.2)
-      actionpack (= 6.0.2.2)
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       mail (>= 2.7.1)
-    actionmailer (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       nokogiri (>= 1.8.5)
-    actionview (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activestorage (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
       marcel (~> 0.3.1)
-    activesupport (6.0.2.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
     builder (3.2.4)
-    coderay (1.1.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    loofah (2.5.0)
+    loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -81,84 +80,88 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.2)
-    mimemagic (0.3.4)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.1.1)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-nav (0.3.0)
       pry (>= 0.9.10, < 0.13.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.2.2)
-      actioncable (= 6.0.2.2)
-      actionmailbox (= 6.0.2.2)
-      actionmailer (= 6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actiontext (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       bundler (>= 1.3.0)
-      railties (= 6.0.2.2)
+      railties (= 6.0.3.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
       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.80.1)
-      jaro_winkler (~> 1.5.1)
+    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, < 1.7)
-    rubocop-performance (1.5.2)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      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.2.4)
-      rubocop (~> 0.80.1)
-      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)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    websocket-driver (0.7.1)
+    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/README.md

@@ -11,7 +11,7 @@
       <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-brightgreen.svg" target="_blank" />
     </a>
     <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/" target="_blank">
-      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-344-brightgreen.svg?style=flat" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-375-brightgreen.svg?style=flat" />
     </a>
     <a href="https://cableready.stimulusreflex.com" target="_blank">
       <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 task default: [:test]

data/lib/cable_ready.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/engine"
 require "active_support/all"
 require "cable_ready/version"

data/lib/cable_ready/broadcaster.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "channels"
 
 module CableReady
@@ -5,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

@@ -1,222 +1,40 @@
+# frozen_string_literal: true
+
 module CableReady
   class Channel
-    attr_reader :name, :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_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
-    end
+    attr_reader :identifier, :operations, :available_operations
 
-    def clear
-      @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 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)
+      ActionCable.server.broadcast identifier, "cableReady" => true, "operations" => operations
+      reset if clear
     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)
-    end
-
-    def remove(options = {})
-      add_operation(:remove, 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_value: [],
-        text_content: []
-      }
+    def reset
+      @operations = Hash.new { |hash, operation| hash[operation] = [] }
     end
   end
 end

data/lib/cable_ready/channels.rb

@@ -1,22 +1,71 @@
+# frozen_string_literal: true
+
 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
+        console_log
+        dispatch_event
+        inner_html
+        insert_adjacent_html
+        insert_adjacent_text
+        morph
+        notification
+        outer_html
+        remove
+        remove_attribute
+        remove_css_class
+        set_attribute
+        set_cookie
+        set_dataset_property
+        set_property
+        set_style
+        set_styles
+        set_value
+        text_content
+      ].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,3 +1,5 @@
+# frozen_string_literal: true
+
 module CableReady
-  VERSION = "4.1.2"
+  VERSION = "4.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.3.0
 platform: ruby
 authors:
 - Nathan Hopkins
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - natehop@gmail.com
 executables: []
@@ -104,12 +104,11 @@ files:
 - lib/cable_ready/channels.rb
 - lib/cable_ready/version.rb
 - tags
-- yarn.lock
 homepage: https://github.com/hopsoft/cable_ready
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,8 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Out-of-Band Server Triggered DOM Operations
 test_files: []

data/yarn.lock

@@ -1,3 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-