anycable-rails 1.0.1 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c1f822cbb79135290b3c404544d937f0f083751657057b7bdd4445a33a95f1
-  data.tar.gz: ae4f5e42da49c8f668ee2cf56a434e30872d04cee9bc3596f914fb2e48404ac1
+  metadata.gz: 474cfd55dac8443341c7717845af042cd80889e3d865cdef3a6e41d089f02348
+  data.tar.gz: e744ee509ebc1ee82cb112150f346970fe52b55dfb134745b927f94c5670198e
 SHA512:
-  metadata.gz: 55bb99bacfdbd2b29120e29598aedc467f56325096602c7713bc2bfee9c4c40f826089ee4dd4d76e80d7171bdd1989db0d21c002edae0e429174509d24f8d836
-  data.tar.gz: 2ee8318ebd5c27dd95b21bd784c75d0d78da08538f1dd466235b889485d2229a4f35202b036a422466f38422905fbda16f84a028ecb3772e0669ce2bfc203dda
+  metadata.gz: 4092bd45059bbb6062df44dc78b4ba2ff1bf8a2f3ef65448f7baf3886c35b91b4e0feb315e86e92cf746735f945b007d7550bd01c5bdd1a0dc6b32178d1a1c68
+  data.tar.gz: e63aa37233adf6f31eff249c2b9f1beeb1ea41d7f50152061cb8b3769cefc9be863c380df710dcf6715c4b2070fda26a569f3a2b7d8bca63cecc5fc8c3b0c97f

data/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 ## master
 
+## 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][])
+
+## 1.0.2 (2020-09-08)
+
+- Added missing channel state support to `#unsubscribed` callbacks. ([@palkan][])
+
 ## 1.0.1 (2020-07-07)
 
 - Fixed patching Action Cable testing classes. ([@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,8 +1,7 @@
-[![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)
-[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/v1/#/ruby/rails)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/#/rails/getting_started)
 
 # AnyCable Rails
 
@@ -14,9 +13,9 @@ You can even use Action Cable in development and not be afraid of [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_demo) -->
+💾 [Example Application](https://github.com/anycable/anycable_rails_demo)
 
-📑 [Documentation](https://docs.anycable.io/v1/#/ruby/rails).
+📑 [Documentation](https://docs.anycable.io/#/rails/getting_started).
 
 <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>
@@ -83,26 +82,22 @@ $ 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/#/v1/anycable-go/getting_started):
 
 ```sh
 anycable-go --host=localhost --port=3334
 ```
 
-See [documentation](https://docs.anycable.io/v1/#/ruby/rails) 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/v1/#/ruby/compatibility).
+See [documentation](https://docs.anycable.io/#/rails/compatibility).
 
 ## Contributing
 
 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,17 +21,17 @@ 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
 
-      def initialize(socket, env, identifiers: "{}", subscriptions: [])
+      def initialize(socket, env, identifiers: "{}", subscriptions: nil)
         if env
           # If env is set, then somehow we're in the context of Action Cable
           # Return and print a warning in #process
@@ -51,8 +51,15 @@ module ActionCable
         @socket = socket
         @subscriptions = ActionCable::Connection::Subscriptions.new(self)
 
-        # Initialize channels if any
-        subscriptions.each { |id| @subscriptions.fetch(id) }
+        return unless subscriptions
+
+        # Initialize channels (for disconnect)
+        subscriptions.each do |id|
+          channel = @subscriptions.fetch(id)
+          next unless socket.istate[id]
+
+          channel.__istate__ = ActiveSupport::JSON.decode(socket.istate[id])
+        end
       end
 
       def process
@@ -64,7 +71,7 @@ module ActionCable
 
       def invalid_request_message
         "You're trying to connect to Action Cable server while using AnyCable. " \
-        "See https://docs.anycable.io/v1/#/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

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

@@ -12,8 +12,6 @@ end
 
 ActionCable::Channel::ChannelStub.prepend(Module.new do
   def subscribe_to_channel
-    # allocate @streams
-    streams
     handle_subscribe
   end
 end)

data/lib/anycable/rails/channel_state.rb

@@ -10,11 +10,11 @@ module AnyCable
             class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{name}
                 return @#{name} if instance_variable_defined?(:@#{name})
-                @#{name} = AnyCable::Rails.deserialize(connection.socket.istate["#{name}"], json: true) if connection.anycable_socket
+                @#{name} = AnyCable::Rails.deserialize(__istate__["#{name}"], json: true) if connection.anycable_socket
               end
 
               def #{name}=(val)
-                connection.socket.istate["#{name}"] = AnyCable::Rails.serialize(val, json: true) if connection.anycable_socket
+                __istate__["#{name}"] = AnyCable::Rails.serialize(val, json: true) if connection.anycable_socket
                 instance_variable_set(:@#{name}, val)
               end
             RUBY
@@ -36,6 +36,13 @@ module AnyCable
       def self.included(base)
         base.extend ClassMethods
       end
+
+      # Make it possible to provide istate explicitly for a channel instance
+      attr_writer :__istate__
+
+      def __istate__
+        @__istate__ ||= connection.socket.istate
+      end
     end
   end
 end

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,9 +36,10 @@ 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__)
           diff.delete_if { |ivar| self.class.channel_state_attributes.include?(:"#{ivar.to_s.sub(/^@/, "")}") }
         end
 

data/lib/anycable/rails/rack.rb

@@ -38,16 +38,16 @@ module AnyCable
         config = ::Rails.application.config
 
         ActionDispatch::MiddlewareStack.new do |middleware|
-          middleware.use(config.session_store, config.session_options)
+          middleware.use(config.session_store, config.session_options) if config.session_store
         end
       end
 
       def self.app
         @rack_app || app_build_lock.synchronize do
-          @rack_app ||= begin
-            stack = default_middleware_stack
-            @middleware = middleware.merge_into(stack)
-            middleware.build { [-1, {}, []] }
+          @rack_app ||= default_middleware_stack.yield_self do |stack|
+                          middleware.merge_into(stack)
+                        end.yield_self do |stack|
+            stack.build { [-1, {}, []] }
           end
         end
       end

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))

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.1"
+    VERSION = "1.0.7"
   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/v1/#"
+    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/v1/#/ruby/stimulus_reflex"
+      say_status :help, "⚠️  Please, check out the documentation on using AnyCable with Stimulus Reflex: https://docs.anycable.io/#/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/v1/#/ruby/compatibility" unless res
+      say_status :help, "⚠️  Please, take a look at the icompatibilities above and fix them. See https://docs.anycable.io/#/rails/compatibility" unless res
     end
 
     def finish

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.7
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actioncable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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