anycable-rails 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1459676363d0523338a496163a296330e1bfbe363cc95b7e4433122163402a06
-  data.tar.gz: d3c074189aa5858f2b7ffbc455c68b7bf96885e493cc8ed6bfce86c9a870a375
+  metadata.gz: 4b2017a00c28bf2656e223a5ba109d66044d4554c061cd4903b52485ff656906
+  data.tar.gz: c99be090e2e7517a9e4d680e5602a2d35331be05f39e9816813518e8726887cc
 SHA512:
-  metadata.gz: 51ab9db5efba8e737e6608d958e550933c7ddc20e9cee8a9a830bce94403d2895a158a643f27a026fd9cb1ff486ece078f823158f2ac2fabe6cabe33fc9948ea
-  data.tar.gz: 61b4563345b1e26ee1da6a7b61325040dca72942165f3508d1615dd06912fc2ab6ffbd8732fe9b9ebf04076a15707f51ae028d6479d90d97bc9f9590ff7c4929
+  metadata.gz: e3d265c017a5dbed395324ea17d9e91bdbb94aa5d8678d2df882a1d756b893eaa53272fe654ae98bcc79472e4358e9b4e45121632de3bcdc68c3d84f9d8736bc
+  data.tar.gz: 6184f438d860d7ee83537a2115367a84002ac833e9b58c2e767a68003039cc6ef6f0f907c76d1c599ac60729d104e5bb556012a5dc58b0eb9e0bb69c35175113

data/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 ## master
 
+## 1.1.0 🚸 (2021-06-01)
+
+- No changes since 1.1.0.rc1.1.
+
+## 1.1.0.rc1.1 (2021-05-12)
+
+- Fixed config loading regression introduced in 1.1.0.rc1.
+
+## 1.1.0.rc1 (2021-05-12)
+
+- Adding `anycable` or `grpc` gem as an explicit dependency is required.
+
+Now, `anycable-rails` depends on `anycable-core`, which doesn't include gRPC server implementation.
+You should either add `anycable` or `grpc` (>= 1.37) gem as an explicit dependency.
+
+- Add option to embed AnyCable RPC into a Rails server process. ([@palkan][])
+
+Set `embedded: true` in the configuration to launch RPC along with `rails s` (only for Rails 6.1+).
+
+- **Ruby >= 2.6** is required.
+- **Rails >= 6.0** is required.
+
+## 1.0.7 (2021-03-05)
+
+- Ruby 3 compatibility. ([@palkan][])
+
+## 1.0.6 (2021-02-25)
+
+- Keep an explicit list of instance vars to ignore in compatibility checks. ([@palkan][])
+
+You can ignore custom vars by adding them to the list: `AnyCable::Compatibility::IGNORE_INSTANCE_VARS << :@my_var`.
+
 ## 1.0.5 (2021-02-24)
 
 - Fixed bug with compatibility false negatives in development. ([@palkan][])

data/README.md

@@ -1,4 +1,3 @@
-[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/anycable/anycable/master?grs=github)
 [![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)
@@ -12,8 +11,6 @@ With AnyCable you can use channels, client-side JS, broadcasting - (almost) all
 
 You can even use Action Cable in development and not be afraid of [compatibility issues](#compatibility).
 
-**Important** This is a readme for the upcoming v1.0 release. For v0.6.x see the readme from the [0-6-stable](https://github.com/anycable/anycable-rails/tree/0-6-stable) branch.
-
 💾 [Example Application](https://github.com/anycable/anycable_rails_demo)
 
 📑 [Documentation](https://docs.anycable.io/#/rails/getting_started).
@@ -23,15 +20,16 @@ You can even use Action Cable in development and not be afraid of [compatibility
 
 ## Requirements
 
-- Ruby >= 2.5
-- Rails >= 5.2
+- Ruby >= 2.6
+- Rails >= 6.0
 - Redis (see [other options](https://github.com/anycable/anycable/issues/2) for broadcasting)
 
 ## Usage
 
-Add `anycable-rails` gem to your Gemfile:
+Add `anycable-rails` and `anycable` gems to your Gemfile:
 
 ```ruby
+gem "anycable"
 gem "anycable-rails"
 
 # when using Redis broadcast adapter
@@ -65,7 +63,7 @@ and specify AnyCable WebSocket server URL:
 # For development it's likely the localhost
 
 # config/environments/development.rb
-config.action_cable.url = "ws://localhost:3334/cable"
+config.action_cable.url = "ws://localhost:8080/cable"
 
 # For production it's likely to have a sub-domain and secure connection
 
@@ -86,7 +84,7 @@ $ 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):
 
 ```sh
-anycable-go --host=localhost --port=3334
+anycable-go --host=localhost --port=8080
 ```
 
 See [documentation](https://docs.anycable.io/#/rails/getting_started) for more information on AnyCable + Rails usage.
@@ -99,10 +97,6 @@ See [documentation](https://docs.anycable.io/#/rails/compatibility).
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/anycable/anycable-rails](https://github.com/anycable/anycable-rails).
 
-## Development
-
-If you are familiar with Docker, you can use [DIP](https://github.com/bibendi/dip) to start developing the gem quickly.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

@@ -27,7 +27,7 @@ module ActionCable
 
       class << self
         def call(socket, **options)
-          new(socket, nil, options)
+          new(socket, nil, **options)
         end
       end
 

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

@@ -18,7 +18,7 @@ end)
 
 ActionCable::Channel::ConnectionStub.prepend(Module.new do
   def socket
-    @socket ||= AnyCable::Socket.new(env: {})
+    @socket ||= AnyCable::Socket.new(env: AnyCable::Env.new(url: "http://test.host", headers: {}))
   end
 
   alias_method :anycable_socket, :socket

data/lib/anycable/rails/compatibility.rb

@@ -4,6 +4,11 @@ module AnyCable
   class CompatibilityError < StandardError; end
 
   module Compatibility # :nodoc:
+    IGNORE_INSTANCE_VARS = %i[
+      @active_periodic_timers
+      @_streams
+    ]
+
     ActionCable::Channel::Base.prepend(Module.new do
       def stream_from(broadcasting, callback = nil, coder: nil)
         if coder.present? && coder != ActiveSupport::JSON
@@ -23,8 +28,6 @@ module AnyCable
       %w[run_callbacks perform_action].each do |mid|
         module_eval <<~CODE, __FILE__, __LINE__ + 1
           def #{mid}(*)
-            # allocate @_streams
-            streams
             __anycable_check_ivars__ { super }
           end
         CODE
@@ -33,7 +36,7 @@ module AnyCable
       def __anycable_check_ivars__
         was_ivars = instance_variables
         res = yield
-        diff = instance_variables - was_ivars
+        diff = instance_variables - was_ivars - IGNORE_INSTANCE_VARS
 
         if self.class.respond_to?(:channel_state_attributes)
           diff.delete(:@__istate__)

data/lib/anycable/rails/config.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 require "anycable/config"
+# Make sure Rails extensions for Anyway Config are loaded
+# See https://github.com/anycable/anycable-rails/issues/63
+require "anyway/rails"
 
 # Extend AnyCable configuration with:
 # - `access_logs_disabled` (defaults to true) — whether to print Started/Finished logs
 # - `persistent_session_enabled` (defaults to false) — whether to store session changes in the connection state
+# - `embedded` (defaults to false) — whether to run RPC server inside a Rails server process
 AnyCable::Config.attr_config(
   access_logs_disabled: true,
-  persistent_session_enabled: false
+  persistent_session_enabled: false,
+  embedded: false
 )
 AnyCable::Config.ignore_options :access_logs_disabled, :persistent_session_enabled

data/lib/anycable/rails/middlewares/log_tagging.rb

@@ -9,8 +9,8 @@ module AnyCable
       #
       # See https://github.com/grpc/grpc-go/blob/master/Documentation/grpc-metadata.md
       class LogTagging < AnyCable::Middleware
-        def call(_request, call, _method)
-          sid = call.metadata["sid"]
+        def call(_method, _request, metadata)
+          sid = metadata["sid"]
           return yield unless sid
 
           AnyCable.logger.tagged("AnyCable sid=#{sid}") { yield }

data/lib/anycable/rails/railtie.rb

@@ -59,6 +59,16 @@ module AnyCable
           end
         end
       end
+
+      # Since Rails 6.1
+      if respond_to?(:server)
+        server do
+          next unless AnyCable.config.embedded?
+
+          require "anycable/cli"
+          AnyCable::CLI.embed!
+        end
+      end
     end
   end
 end

data/lib/anycable/rails/version.rb

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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: anycable
+  name: anycable-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ammeter
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +189,8 @@ metadata:
   documentation_uri: https://docs.anycable.io/#/using_with_rails
   homepage_uri: https://anycable.io/
   source_code_uri: http://github.com/anycable/anycable-rails
-post_install_message: 
+  funding_uri: https://github.com/sponsors/anycable
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -211,15 +198,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Rails adapter for AnyCable
 test_files: []