cable_ready 5.0.0.pre4 → 5.0.0.pre8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b77b47c0eb8de63edb60db0cb235067ffd3ca9006ad0b2ea61f0b48d187203
-  data.tar.gz: 324b35591eed716da4e7fefda9bf063d9dd8809d5462102936d7c5dd7221caf1
+  metadata.gz: 876c1dc40f4011627e0b86aeb608639bdb6b462f138a089393b13409138a64e6
+  data.tar.gz: df9910c1cf11d50168daa290bbf5894798a439449efc191a73d701a7dc2960ca
 SHA512:
-  metadata.gz: d3117dd4df1af91c451d3e22c84b96f2f430af511437145c03b1212217b87be1b0ce71e58d507ec4a10c268653f04518823ab66e02fd4153f91b3b506fcb985f
-  data.tar.gz: 5416faffa9ba9a6550989f1d21fb7d54adfa1f50fe5d4f96040aaff4de1c0f22dcc4c3128731ae5602dd56733429a9f9164003777ebd9a0629d88f3c9c23a187
+  metadata.gz: f6e759fb014ceeaec631f58f156b9e9cc68b3d1803b5ec895c08e1eaedaa075d3f7bd6822c9a3279a434ecf6c9315d99423f402630e416305420720fa2da2568
+  data.tar.gz: 3d1fbbe4b8607d547a2a160ef93e041e935ad3876ffb2cf76f448ece065cd7a22e2935a8fcc4163108d293ddaab708bf5f54348b09e4fcc88c44de2202e80b61

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## [v5.0.0.pre7](https://github.com/stimulusreflex/cable_ready/tree/v5.0.0.pre7) (2021-10-26)
+
+[Full Changelog](https://github.com/stimulusreflex/cable_ready/compare/v5.0.0.pre6...v5.0.0.pre7)
+
+**Merged pull requests:**
+
+- Add custom header to fetch [\#159](https://github.com/stimulusreflex/cable_ready/pull/159) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v5.0.0.pre6](https://github.com/stimulusreflex/cable_ready/tree/v5.0.0.pre6) (2021-10-14)
+
+[Full Changelog](https://github.com/stimulusreflex/cable_ready/compare/v5.0.0.pre5...v5.0.0.pre6)
+
+**Merged pull requests:**
+
+- Re-export consumer [\#158](https://github.com/stimulusreflex/cable_ready/pull/158) ([julianrubisch](https://github.com/julianrubisch))
+- Consolidate elements into a base class [\#157](https://github.com/stimulusreflex/cable_ready/pull/157) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v5.0.0.pre5](https://github.com/stimulusreflex/cable_ready/tree/v5.0.0.pre5) (2021-10-07)
+
+[Full Changelog](https://github.com/stimulusreflex/cable_ready/compare/v5.0.0.pre4...v5.0.0.pre5)
+
+**Implemented enhancements:**
+
+- error handling for updates\_for edge cases [\#155](https://github.com/stimulusreflex/cable_ready/pull/155) ([leastbad](https://github.com/leastbad))
+- post-pre4 updates [\#154](https://github.com/stimulusreflex/cable_ready/pull/154) ([leastbad](https://github.com/leastbad))
+
+**Fixed bugs:**
+
+- Given multiple updates\_for blocks with custom urls, only the first is re-fetched [\#153](https://github.com/stimulusreflex/cable_ready/issues/153)
+
+**Merged pull requests:**
+
+- Export elements [\#156](https://github.com/stimulusreflex/cable_ready/pull/156) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v5.0.0.pre4](https://github.com/stimulusreflex/cable_ready/tree/v5.0.0.pre4) (2021-10-01)
+
+[Full Changelog](https://github.com/stimulusreflex/cable_ready/compare/v5.0.0.pre3...v5.0.0.pre4)
+
+**Implemented enhancements:**
+
+- Receive morph updates from model/PORO callbacks [\#145](https://github.com/stimulusreflex/cable_ready/pull/145) ([leastbad](https://github.com/leastbad))
+
+**Closed issues:**
+
+- Uncaught TypeError: operations.forEach is not a function [\#149](https://github.com/stimulusreflex/cable_ready/issues/149)
+
+**Merged pull requests:**
+
+- Optionally debounce updates [\#151](https://github.com/stimulusreflex/cable_ready/pull/151) ([julianrubisch](https://github.com/julianrubisch))
+- Fix updates for lazy loading [\#150](https://github.com/stimulusreflex/cable_ready/pull/150) ([julianrubisch](https://github.com/julianrubisch))
+- Bump nokogiri from 1.12.3 to 1.12.5 [\#148](https://github.com/stimulusreflex/cable_ready/pull/148) ([dependabot[bot]](https://github.com/apps/dependabot))
+- \[Readme\] Make badges link to RubyGems and npm packages [\#147](https://github.com/stimulusreflex/cable_ready/pull/147) ([palkan](https://github.com/palkan))
+- Fix wrong CableReady import [\#146](https://github.com/stimulusreflex/cable_ready/pull/146) ([n-rodriguez](https://github.com/n-rodriguez))
+
 ## [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)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cable_ready (5.0.0.pre4)
+    cable_ready (5.0.0.pre8)
       rails (>= 5.2)
       thread-local (>= 1.1.0)
 
@@ -86,7 +86,7 @@ GEM
       faraday
     async-io (1.32.2)
       async
-    async-pool (0.3.8)
+    async-pool (0.3.9)
       async (>= 1.25)
     builder (3.2.4)
     coderay (1.1.3)
@@ -95,7 +95,7 @@ GEM
       fiber-local
     crass (1.0.6)
     erubi (1.10.0)
-    faraday (1.7.0)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -128,7 +128,7 @@ GEM
       rake (>= 10.0)
     globalid (0.5.2)
       activesupport (>= 5.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     loofah (2.12.0)
       crass (~> 1.0.2)
@@ -136,9 +136,9 @@ GEM
     magic_frozen_string_literal (1.2.0)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
-    method_source (0.9.2)
-    mini_mime (1.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
     minitest (5.14.4)
     mocha (1.13.0)
     multi_json (1.15.0)
@@ -149,23 +149,23 @@ GEM
     octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     protocol-hpack (1.4.2)
     protocol-http (0.22.5)
-    protocol-http1 (0.14.1)
+    protocol-http1 (0.14.2)
       protocol-http (~> 0.22)
     protocol-http2 (0.14.2)
       protocol-hpack (~> 1.4)
       protocol-http (~> 0.18)
-    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)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-nav (1.0.0)
+      pry (>= 0.9.10, < 0.15)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -199,18 +199,18 @@ GEM
     rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rubocop (1.18.4)
+    rubocop (1.22.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.10.0)
+    rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.11.4)
+    rubocop-performance (1.11.5)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
@@ -221,14 +221,14 @@ GEM
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.0)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
-    standard (1.1.7)
-      rubocop (= 1.18.4)
-      rubocop-performance (= 1.11.4)
+    standard (1.4.0)
+      rubocop (= 1.22.3)
+      rubocop-performance (= 1.11.5)
     standardrb (1.0.0)
       standard
     thor (1.1.0)
@@ -236,14 +236,14 @@ GEM
     timers (4.3.3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   cable_ready!
@@ -257,4 +257,4 @@ DEPENDENCIES
   standardrb
 
 BUNDLED WITH
-   2.2.19
+   2.2.27

data/README.md

@@ -2,10 +2,10 @@
   <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">
-    <a href="https://rubygems.org/gems/cable_ready"> 
+    <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"> 
+    </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">
@@ -82,11 +82,15 @@ Please run `./bin/standardize` prior submitting pull requests.
 
 ### 📦 Releasing
 
-1. Bump version number at `lib/cable_ready/version.rb`
-2. Run `rake build`
-3. Run `rake release`
-4. Run `yarn publish --no-git-tag-version`
-5. Commit and push changes to the `package.json` file
+1. Make sure that you run `yarn` and `bundle` to pick up the latest.
+1. Bump version number at `lib/cable_ready/version.rb`. Pre-release versions use `.preN`
+1. Run `rake build`
+1. Commit and push changes to github
+1. Run `rake release`
+1. Run `yarn publish --no-git-tag-version`
+1. Yarn will prompt you for the new version. Pre-release versions use `-preN`
+1. Run `GITHUB_CHANGELOG_GENERATOR_TOKEN=SECRET rake changelog`
+1. Commit and push changes to github
 
 ## 📝 License
 

data/Rakefile

@@ -16,6 +16,8 @@ Rake::TestTask.new(:test) do |t|
 end
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.user = "hopsoft"
+  config.user = "stimulusreflex"
   config.project = "cable_ready"
+  config.exclude_labels = %w[duplicate question invalid wontfix nodoc]
+  config.token = ENV["GITHUB_CHANGELOG_GENERATOR_TOKEN"]
 end

data/app/helpers/cable_ready_helper.rb

@@ -8,10 +8,11 @@ module CableReadyHelper
     tag.stream_from(**build_options(*keys, html_options))
   end
 
-  def updates_for(*keys, url: nil, debounce: nil, html_options: {}, &block)
+  def updates_for(*keys, url: nil, debounce: nil, only: nil, html_options: {}, &block)
     options = build_options(*keys, html_options)
     options[:url] = url if url
     options[:debounce] = debounce if debounce
+    options[:only] = only if only
     tag.updates_for(**options) { capture(&block) }
   end
 

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

@@ -15,7 +15,7 @@ module CableReady
           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)
+          collection[:klass].cable_ready_update_collection(resource, collection[:name], model) if collection[:options][:if].call(resource)
         end
       end
 

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

@@ -21,7 +21,7 @@ module CableReady
 
       def broadcast_update(model)
         ActionCable.server.broadcast(model.class, {})
-        ActionCable.server.broadcast(model.to_global_id, {})
+        ActionCable.server.broadcast(model.to_global_id, model.respond_to?(:previous_changes) ? {changed: model.previous_changes.keys} : {})
       end
     end
   end

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

@@ -43,9 +43,9 @@ module CableReady
         @cable_ready_collections ||= CollectionsRegistry.new
       end
 
-      def cable_ready_update_collection(resource, name)
+      def cable_ready_update_collection(resource, name, model)
         identifier = resource.to_global_id.to_s + ":" + name.to_s
-        ActionCable.server.broadcast(identifier, {})
+        ActionCable.server.broadcast(identifier, model.respond_to?(:previous_changes) ? {changed: model.previous_changes.keys} : {})
       end
 
       def enrich_association_with_updates(name, option)

data/lib/cable_ready/channel.rb

@@ -5,13 +5,23 @@ module CableReady
     attr_reader :identifier
 
     def broadcast(clear: true)
-      ActionCable.server.broadcast identifier, {"cableReady" => true, "operations" => operations_payload}
+      clients_received = ActionCable.server.broadcast identifier, {
+        "cableReady" => true,
+        "operations" => operations_payload,
+        "version" => CableReady::VERSION
+      }
       reset! if clear
+      clients_received
     end
 
     def broadcast_to(model, clear: true)
-      identifier.broadcast_to model, {"cableReady" => true, "operations" => operations_payload}
+      clients_received = identifier.broadcast_to model, {
+        "cableReady" => true,
+        "operations" => operations_payload,
+        "version" => CableReady::VERSION
+      }
       reset! if clear
+      clients_received
     end
 
     def broadcast_later(clear: true)

data/lib/cable_ready/sanity_checker.rb

@@ -2,8 +2,6 @@
 
 class CableReady::SanityChecker
   LATEST_VERSION_FORMAT = /^(\d+\.\d+\.\d+)$/
-  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
-  JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
 
   class << self
     def check!
@@ -13,7 +11,6 @@ class CableReady::SanityChecker
       return if called_by_rake?
 
       instance = new
-      instance.check_package_versions_match
       instance.check_new_version_available
     end
 
@@ -28,28 +25,6 @@ class CableReady::SanityChecker
     end
   end
 
-  def check_package_versions_match
-    if npm_version.nil?
-      warn_and_exit <<~WARN
-        👉 Can't locate the cable_ready npm package.
-
-          yarn add cable_ready@#{gem_version}
-
-        Either add it to your package.json as a dependency or use "yarn link cable_ready" if you are doing development.
-      WARN
-    end
-
-    if package_version_mismatch?
-      warn_and_exit <<~WARN
-        👉 The cable_ready npm package version (#{npm_version}) does not match the Rubygem version (#{gem_version}).
-
-        To update the cable_ready npm package:
-
-          yarn upgrade cable_ready@#{gem_version}
-      WARN
-    end
-  end
-
   def check_new_version_available
     return if CableReady.config.on_new_version_available == :ignore
     return if Rails.env.development? == false
@@ -75,45 +50,12 @@ class CableReady::SanityChecker
 
   private
 
-  def package_version_mismatch?
-    npm_version != gem_version
-  end
-
   def using_preview_release?
     preview = CableReady::VERSION.match?(LATEST_VERSION_FORMAT) == false
     puts "👉 CableReady #{CableReady::VERSION} update check skipped: pre-release build" if preview
     preview
   end
 
-  def gem_version
-    @_gem_version ||= CableReady::VERSION.gsub(".pre", "-pre")
-  end
-
-  def npm_version
-    @_npm_version ||= find_npm_version
-  end
-
-  def find_npm_version
-    if (match = search_file(package_json_path, regex: /version/))
-      match[JSON_VERSION_FORMAT, 1]
-    elsif (match = search_file(yarn_lock_path, regex: /^cable_ready/))
-      match[NODE_VERSION_FORMAT, 1]
-    end
-  end
-
-  def search_file(path, regex:)
-    return if File.exist?(path) == false
-    File.foreach(path).grep(regex).first
-  end
-
-  def package_json_path
-    Rails.root.join("node_modules", "cable_ready", "package.json")
-  end
-
-  def yarn_lock_path
-    Rails.root.join("yarn.lock")
-  end
-
   def initializer_missing?
     File.exist?(Rails.root.join("config", "initializers", "cable_ready.rb")) == false
   end

data/lib/cable_ready/version.rb

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

data/test/lib/cable_ready/updatable_test.rb

@@ -13,7 +13,7 @@ class CableReady::UpdatableTest < ActiveSupport::TestCase
   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
+    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {changed: ["id", "title", "user_id", "created_at", "updated_at"]}).once
 
     ActionCable.stubs(:server).returns(mock_server)
     user = User.create(name: "John Doe")
@@ -26,7 +26,7 @@ class CableReady::UpdatableTest < ActiveSupport::TestCase
     post = user.posts.create(title: "Lorem")
 
     mock_server = mock("server")
-    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {}).once
+    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {changed: ["id", "title", "user_id", "created_at", "updated_at"]}).once
 
     ActionCable.stubs(:server).returns(mock_server)
 
@@ -38,7 +38,7 @@ class CableReady::UpdatableTest < ActiveSupport::TestCase
     post = user.posts.create(title: "Lorem")
 
     mock_server = mock("server")
-    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {}).once
+    mock_server.expects(:broadcast).with("gid://dummy/User/1:posts", {changed: ["title", "updated_at"]}).once
 
     ActionCable.stubs(:server).returns(mock_server)
 
@@ -50,7 +50,7 @@ class CableReady::UpdatableTest < ActiveSupport::TestCase
 
     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(user.to_global_id, {changed: ["name", "updated_at"]}).once
 
     ActionCable.stubs(:server).returns(mock_server)
 
@@ -63,10 +63,10 @@ class CableReady::UpdatableTest < ActiveSupport::TestCase
 
     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(user.to_global_id, {changed: ["name", "updated_at"]}).once
+    mock_server.expects(:broadcast).with("gid://dummy/Team/1:users", {changed: ["name", "updated_at"]}).once
     mock_server.expects(:broadcast).with(Team, {}).once
-    mock_server.expects(:broadcast).with(team.to_global_id, {}).once
+    mock_server.expects(:broadcast).with(team.to_global_id, {changed: ["id", "created_at", "updated_at"]}).once
 
     ActionCable.stubs(:server).returns(mock_server)
 
@@ -94,7 +94,7 @@ class CableReady::UpdatableTest < ActiveSupport::TestCase
     section.updates_enabled = true
 
     mock_server.expects(:broadcast).with(Section, {}).once
-    mock_server.expects(:broadcast).with(section.to_global_id, {}).once
+    mock_server.expects(:broadcast).with(section.to_global_id, {changed: ["title", "updated_at", "updates_enabled"]}).once
     section.update(title: "First Section")
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 5.0.0.pre4
+  version: 5.0.0.pre8
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails