anycable-rails 1.0.3 → 1.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f7915a5f8edaf8e0053df398cef7ad663ce71ec69456e7f6c3e8d539d8724a8
-  data.tar.gz: 1349a0b4d6bff65540b940e8963578af24733ffdf3b51ed73cc3b11e85483d4a
+  metadata.gz: 1cf996e781322b7becc433bf984818a12961d26b0eb2b21429f3c40bdc076b51
+  data.tar.gz: 880681dd3742f032553906f730e5eec9618dedec32d05dff7b474e7a567f42a4
 SHA512:
-  metadata.gz: c4501650b155d991cdca302a1ba225ca6c09e00b637d6589f741512d3ef20b62589dd98f550be7599b75a05e3be0a6f8e7caa105c37d6b6923181f20730e5a21
-  data.tar.gz: f973cbb37b67a1abe9f4a4acfd73cd88f8dfad2673a9c919eda6720bc647242748311429ef46e00b1e5bc02f8bf892d52a72218cd1ac2f28c77323039f80a91d
+  metadata.gz: e02e9ee1686ef5474400961c271ce55aba57c29c9d9843e0c8f90f7343366ddc753aedfc29e4136d11bc9acbb3b27787052f10f9d3521fcbb9df2598a890cff7
+  data.tar.gz: 7bed57ab2cc71df212205b1c79ed926384804e1ce917f43bf028c7a855087b8fdbdbf9da10ec236d4c15ed8edae5a2ede8704a93540a4773520c4fe7f135129a

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 ## master
 
+## 1.1.0.rc1
+
+- 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][])
+
+See [#151](https://github.com/anycable/anycable-rails/issues/151).
+
+## 1.0.4 (2020-10-02)
+
+- Relax Rails dependencies. ([@palkan][])
+
+Only add `actioncable` and `globalid` as runtime dependencies, not the whole `rails`.
+
 ## 1.0.3 (2020-09-16)
 
 - Fixed bug with building a request object when session store is absent. ([@palkan][])

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2020 palkan
+Copyright 2017-2021 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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,8 +20,8 @@ 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
@@ -65,7 +62,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 +83,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 +96,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/channel.rb

@@ -5,7 +5,7 @@ require "action_cable/channel"
 module ActionCable
   module Channel
     class Base # :nodoc:
-      alias handle_subscribe subscribe_to_channel
+      alias_method :handle_subscribe, :subscribe_to_channel
 
       public :handle_subscribe, :subscription_rejected?
 

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

@@ -21,13 +21,13 @@ module ActionCable
 
       attr_reader :socket
 
-      alias anycable_socket socket
+      alias_method :anycable_socket, :socket
 
       delegate :env, :session, to: :request
 
       class << self
         def call(socket, **options)
-          new(socket, nil, options)
+          new(socket, nil, **options)
         end
       end
 

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

@@ -12,15 +12,13 @@ end
 
 ActionCable::Channel::ChannelStub.prepend(Module.new do
   def subscribe_to_channel
-    # allocate @streams
-    streams
     handle_subscribe
   end
 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
@@ -31,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

@@ -5,8 +5,10 @@ require "anycable/config"
 # 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

@@ -18,8 +18,8 @@ module AnyCable
           AnyCable.logger = ActiveSupport::TaggedLogging.new(::ActionCable.server.config.logger)
           # Broadcast server logs to STDOUT in development
           if ::Rails.env.development? &&
-              !ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, STDOUT)
-            console = ActiveSupport::Logger.new(STDOUT)
+              !ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, $stdout)
+            console = ActiveSupport::Logger.new($stdout)
             console.formatter = ::Rails.logger.formatter
             console.level = ::Rails.logger.level
             AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
@@ -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/session_proxy.rb

@@ -21,8 +21,8 @@ module AnyCable
         CODE
       end
 
-      alias include? has_key?
-      alias key? has_key?
+      alias_method :include?, :has_key?
+      alias_method :key?, :has_key?
 
       %i[update merge! to_hash].each do |mid|
         class_eval <<~CODE, __FILE__, __LINE__ + 1
@@ -33,7 +33,7 @@ module AnyCable
         CODE
       end
 
-      alias to_h to_hash
+      alias_method :to_h, :to_hash
 
       def keys
         rack_session.keys + socket_session.keys

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.0.3"
+    VERSION = "1.1.0.rc1"
   end
 end

data/lib/generators/anycable/setup/templates/config/initializers/anycable.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Add Warden middkeware to AnyCable stack to allow accessing
+# Add Warden middleware to AnyCable stack to allow accessing
 # Devise current user via `env["warden"].user`.
 #
 # See <%= DOCS_ROOT %>/ruby/authentication

metadata

@@ -1,43 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0.rc1
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2021-05-12 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.99
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.99
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ammeter
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +195,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
@@ -183,15 +204,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'
+      version: 1.3.1
 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: []