anycable-rails 1.1.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b2017a00c28bf2656e223a5ba109d66044d4554c061cd4903b52485ff656906
-  data.tar.gz: c99be090e2e7517a9e4d680e5602a2d35331be05f39e9816813518e8726887cc
+  metadata.gz: 59a60ff31ba3907089d78beaedf01b69a66ff2e7da83175dcd8e19d78bd6e9aa
+  data.tar.gz: 1b9a709873bf7409502c2e114b9b90ae32ce94a724d5a3091d22ea8a7c86cd76
 SHA512:
-  metadata.gz: e3d265c017a5dbed395324ea17d9e91bdbb94aa5d8678d2df882a1d756b893eaa53272fe654ae98bcc79472e4358e9b4e45121632de3bcdc68c3d84f9d8736bc
-  data.tar.gz: 6184f438d860d7ee83537a2115367a84002ac833e9b58c2e767a68003039cc6ef6f0f907c76d1c599ac60729d104e5bb556012a5dc58b0eb9e0bb69c35175113
+  metadata.gz: 80d3114d9eb008e7dce61d772a71608f87c0c24eb60dbed31f857abbdb7271d7a13a4a1103609910e6eef51d576a761e92f8a40cc134f3ab95b314f247e60551
+  data.tar.gz: cbd7a8c52da4ddd60023f536d99be251dee6158c0639744c0235b9876d4efcba9ab983ad9f06a0605cd187afaa34f2b2c1975c7b949a188e26d44860553cd88e

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ## master
 
+## 1.1.4 (2021-11-11)
+
+- Added `Connection#state_attr_accessor`. ([@palkan][])
+
+## 1.1.3 (2021-10-11)
+
+- Relax Action Cable dependency. ([@palkan][])
+
+Action Cable 5.1 is allowed (though not recommended).
+
+## 1.1.2 (2021-06-23)
+
+- Bring back dependency on `anycable` (instead of `anycable-core`). ([@palkan][])
+
+Make it easier to get started by adding just a single gem.
+
+## 1.1.1 (2021-06-08)
+
+- Updated documentation links in the generator. ([@palkan][])
+
 ## 1.1.0 🚸 (2021-06-01)
 
 - No changes since 1.1.0.rc1.1.

data/README.md

@@ -1,7 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/anycable-rails.svg)](https://rubygems.org/gems/anycable-rails)
 [![Build](https://github.com/anycable/anycable-rails/workflows/Build/badge.svg)](https://github.com/anycable/anycable-rails/actions)
 [![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/anycable/Lobby)
-[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/#/rails/getting_started)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/rails/getting_started)
 
 # AnyCable Rails
 
@@ -13,7 +13,9 @@ You can even use Action Cable in development and not be afraid of [compatibility
 
 💾 [Example Application](https://github.com/anycable/anycable_rails_demo)
 
-📑 [Documentation](https://docs.anycable.io/#/rails/getting_started).
+📑 [Documentation](https://docs.anycable.io/rails/getting_started).
+
+> [AnyCable Pro](https://docs.anycable.io/pro) has been launched 🚀
 
 <a href="https://evilmartians.com/">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
@@ -21,15 +23,14 @@ You can even use Action Cable in development and not be afraid of [compatibility
 ## Requirements
 
 - Ruby >= 2.6
-- Rails >= 6.0
+- Rails >= 6.0 (Rails 5.1 could work but we're no longer enforce compatibility on CI)
 - Redis (see [other options](https://github.com/anycable/anycable/issues/2) for broadcasting)
 
 ## Usage
 
-Add `anycable-rails` and `anycable` gems to your Gemfile:
+Add `anycable-rails` gem to your Gemfile:
 
 ```ruby
-gem "anycable"
 gem "anycable-rails"
 
 # when using Redis broadcast adapter
@@ -81,17 +82,17 @@ $ bundle exec anycable
 $ RAILS_ENV=production bundle exec anycable
 ```
 
-And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/#/v1/anycable-go/getting_started):
+And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/anycable-go/getting_started):
 
 ```sh
 anycable-go --host=localhost --port=8080
 ```
 
-See [documentation](https://docs.anycable.io/#/rails/getting_started) for more information on AnyCable + Rails usage.
+See [documentation](https://docs.anycable.io/rails/getting_started) for more information on AnyCable + Rails usage.
 
 ## Action Cable Compatibility
 
-See [documentation](https://docs.anycable.io/#/rails/compatibility).
+See [documentation](https://docs.anycable.io/rails/compatibility).
 
 ## Contributing
 

data/lib/anycable/rails/actioncable/connection.rb

@@ -9,7 +9,6 @@ require "anycable/rails/session_proxy"
 
 module ActionCable
   module Connection
-    # rubocop: disable Metrics/ClassLength
     class Base # :nodoc:
       # We store logger tags in the connection state to be able
       # to re-use them in the subsequent calls
@@ -71,7 +70,7 @@ module ActionCable
 
       def invalid_request_message
         "You're trying to connect to Action Cable server while using AnyCable. " \
-        "See https://docs.anycable.io/#/troubleshooting?id=server-raises-an-argumenterror-exception-when-client-tries-to-connect"
+        "See https://docs.anycable.io/troubleshooting?id=server-raises-an-argumenterror-exception-when-client-tries-to-connect"
       end
 
       def handle_open
@@ -98,7 +97,6 @@ module ActionCable
         true
       end
 
-      # rubocop:disable Metrics/MethodLength
       def handle_channel_command(identifier, command, data)
         channel = subscriptions.fetch(identifier)
         case command

data/lib/anycable/rails/actioncable/testing.rb

@@ -5,7 +5,7 @@
 # Trigger autoload (if constant is defined)
 begin
   ActionCable::Channel::TestCase # rubocop:disable Lint/Void
-  ActionCable::Connection::TestCase # rubocop:disable Lint/Void
+  ActionCable::Connection::TestCase
 rescue NameError
   return
 end

data/lib/anycable/rails/channel_state.rb

@@ -44,10 +44,54 @@ module AnyCable
         @__istate__ ||= connection.socket.istate
       end
     end
+
+    module ConnectionState
+      module ClassMethods
+        def state_attr_accessor(*names)
+          names.each do |name|
+            connection_state_attributes << name
+            class_eval <<~RUBY, __FILE__, __LINE__ + 1
+              def #{name}
+                return @#{name} if instance_variable_defined?(:@#{name})
+                @#{name} = AnyCable::Rails.deserialize(__cstate__["#{name}"], json: true) if anycable_socket
+              end
+
+              def #{name}=(val)
+                __cstate__["#{name}"] = AnyCable::Rails.serialize(val, json: true) if anycable_socket
+                instance_variable_set(:@#{name}, val)
+              end
+            RUBY
+          end
+        end
+
+        def connection_state_attributes
+          return @connection_state_attributes if instance_variable_defined?(:@connection_state_attributes)
+
+          @connection_state_attributes =
+            if superclass.respond_to?(:connection_state_attributes)
+              superclass.connection_state_attributes.dup
+            else
+              []
+            end
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Make it possible to provide istate explicitly for a connection instance
+      attr_writer :__cstate__
+
+      def __cstate__
+        @__cstate__ ||= socket.cstate
+      end
+    end
   end
 end
 
 ActiveSupport.on_load(:action_cable) do
   # `state_attr_accessor` must be available in Action Cable
+  ::ActionCable::Connection::Base.include(AnyCable::Rails::ConnectionState)
   ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
 end

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.1.0"
+    VERSION = "1.1.4"
   end
 end

data/lib/generators/anycable/setup/setup_generator.rb

@@ -8,7 +8,7 @@ module AnyCableRailsGenerators
     namespace "anycable:setup"
     source_root File.expand_path("templates", __dir__)
 
-    DOCS_ROOT = "https://docs.anycable.io/#"
+    DOCS_ROOT = "https://docs.anycable.io"
     DEVELOPMENT_METHODS = %w[skip local docker].freeze
     SERVER_SOURCES = %w[skip brew binary].freeze
 
@@ -118,7 +118,7 @@ module AnyCableRailsGenerators
     def stimulus_reflex
       return unless stimulus_reflex?
 
-      say_status :help, "⚠️  Please, check out the documentation on using AnyCable with Stimulus Reflex: https://docs.anycable.io/#/rails/stimulus_reflex"
+      say_status :help, "⚠️  Please, check out the documentation on using AnyCable with Stimulus Reflex: #{DOCS_ROOT}/rails/stimulus_reflex"
     end
 
     def rubocop_compatibility
@@ -126,7 +126,7 @@ module AnyCableRailsGenerators
 
       say_status :info, "🤖 Running static compatibility checks with RuboCop"
       res = run "bundle exec rubocop -r 'anycable/rails/compatibility/rubocop' --only AnyCable/InstanceVars,AnyCable/PeriodicalTimers,AnyCable/InstanceVars"
-      say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See https://docs.anycable.io/#/rails/compatibility" unless res
+      say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See #{DOCS_ROOT}/rails/compatibility" unless res
     end
 
     def finish

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.4
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: anycable-core
+  name: anycable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Rails adapter for AnyCable