anycable-rails 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efc1401fbddad0409e2a4d6931f88223d5ac2da86dd225cd692f5cc34045da01
-  data.tar.gz: e59813e4d3b0e0407ad638caace05d8680d57c66c17061cfb05106ec4a02d2a7
+  metadata.gz: 6502d9587bfab38ed0e12416741885869551926e2d8fae5282cca66ca59e97cf
+  data.tar.gz: 7c16519ba1a470e68fbcf0d5baaa261df245d64618277f8b4b2992821d543d1c
 SHA512:
-  metadata.gz: 8a8a91fe4fa20688a889f8f94d1415c1805e6bc95f1dc0dfe68a37a1d3846899252988066f60db03b034e6e78f552cb1626c5f6cff16c51c0d8c658b894cfc3b
-  data.tar.gz: 207fa60c6b8bc3e1f50c3078ec42402859fa609661aac170281f89d0c859da84dc4b37fe778eafb322c77936f96e9665acd557c5357cc05bac7222f18de4b241
+  metadata.gz: dbfe72bae1b477034e32f7bb85e3c936bef3caf03db7d54cfe126e2cccbd7cc24494ec8cd7718887f9a56a41d3dab10ec24cf30ca6c7de0bd162e1658aa143f9
+  data.tar.gz: ba01f329e4388d4257952592f214842214432e9c211261362bf530913ace6eb3b9bc74bf2bab3e8a9446b6d7e48b9dd54a82bc44f21276506b9c743403e0afae

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## master
 
+## 1.2.0 (2021-12-21) 🎄
+
+- Drop Rails 5 support.
+
+- Drop Ruby 2.6 support.
+
+## 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][])

data/README.md

@@ -15,21 +15,22 @@ You can even use Action Cable in development and not be afraid of [compatibility
 
 📑 [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>
 
 ## 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

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
@@ -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,65 @@ 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
+if ActiveSupport::VERSION::MAJOR < 6
+  # `state_attr_accessor` must be available in Action Cable
+  ActiveSupport.on_load(:action_cable) do
+    ::ActionCable::Connection::Base.include(AnyCable::Rails::ConnectionState)
+    ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
+  end
+else
   # `state_attr_accessor` must be available in Action Cable
-  ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
+  ActiveSupport.on_load(:action_cable_connection) do
+    ::ActionCable::Connection::Base.include(AnyCable::Rails::ConnectionState)
+  end
+
+  ActiveSupport.on_load(:action_cable_channel) do
+    ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
+  end
 end

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

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

@@ -24,6 +24,12 @@ module AnyCableRailsGenerators
     class_option :skip_procfile_dev,
       type: :boolean,
       desc: "Do not create Procfile.dev"
+    class_option :skip_jwt,
+      type: :boolean,
+      desc: "Do not install anycable-rails-jwt"
+    class_option :skip_install,
+      type: :boolean,
+      desc: "Do not run bundle install when adding new gems"
 
     include WithOSHelpers
 
@@ -59,7 +65,7 @@ module AnyCableRailsGenerators
         <<~SNIPPET
           # Specify AnyCable WebSocket server URL to use by JS client
           config.after_initialize do
-            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL") if AnyCable::Rails.enabled?
+            config.action_cable.url = ActionCable.server.config.url = ENV.fetch("CABLE_URL", "/cable") if AnyCable::Rails.enabled?
           end
         SNIPPET
       end
@@ -129,6 +135,16 @@ module AnyCableRailsGenerators
       say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See #{DOCS_ROOT}/rails/compatibility" unless res
     end
 
+    def jwt
+      return if options[:skip_jwt]
+
+      return unless options[:skip_jwt] == false || yes?("Do you want to use JWT for authentication? [Yn]")
+
+      opts = " --skip-install" if options[:skip_install]
+
+      run "bundle add anycable-rails-jwt#{opts}"
+    end
+
     def finish
       say_status :info, "✅ AnyCable has been configured successfully!"
     end
@@ -172,7 +188,7 @@ module AnyCableRailsGenerators
       say <<~YML
         ─────────────────────────────────────────
         ws:
-          image: anycable/anycable-go:1.0
+          image: anycable/anycable-go:1.2
           ports:
             - '8080:8080'
           environment:

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: anycable-core
+  name: anycable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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