anycable-rails 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49d905b11d3ffb0c71c238ece809817adbbf336f489e1a317a692e9c50db0a5f
-  data.tar.gz: e632e101cb3e710548703da397843ef4c6f7df00f4afb2ba09a2a54a680ebd5c
+  metadata.gz: 1459676363d0523338a496163a296330e1bfbe363cc95b7e4433122163402a06
+  data.tar.gz: d3c074189aa5858f2b7ffbc455c68b7bf96885e493cc8ed6bfce86c9a870a375
 SHA512:
-  metadata.gz: 1b6763e1152e6a2ce712053f6d6bc798c40af7f6fa01fc38f52e8105c924ac451c916ac7775e30dc83445f30b6956da4ddac1d83cda5360032b3c585f68bd0a5
-  data.tar.gz: d656c094dd40d392f2f1aaf093577e887d264dc75778b5a84da1563d24ce33c272ab34fdd526ec8d5ba22b5c5d570f0f86ba26b61821edbb21e2356446dd208b
+  metadata.gz: 51ab9db5efba8e737e6608d958e550933c7ddc20e9cee8a9a830bce94403d2895a158a643f27a026fd9cb1ff486ece078f823158f2ac2fabe6cabe33fc9948ea
+  data.tar.gz: 61b4563345b1e26ee1da6a7b61325040dca72942165f3508d1615dd06912fc2ab6ffbd8732fe9b9ebf04076a15707f51ae028d6479d90d97bc9f9590ff7c4929

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## master
 
+## 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][])
+
 ## 1.0.0 (2020-07-01)
 
 - Support `rescue_from` in connections (Rails 6.1). ([@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

@@ -2,7 +2,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/v1/#/ruby/rails)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/#/rails/getting_started)
 
 # AnyCable Rails
 
@@ -14,9 +14,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,17 +83,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/#/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
 

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,7 +21,7 @@ module ActionCable
 
       attr_reader :socket
 
-      alias anycable_socket socket
+      alias_method :anycable_socket, :socket
 
       delegate :env, :session, to: :request
 
@@ -31,7 +31,7 @@ module ActionCable
         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
@@ -211,3 +218,5 @@ if ActionCable::Connection::Base.respond_to?(:rescue_from)
     end
   end)
 end
+
+require "anycable/rails/actioncable/testing" if ::Rails.env.test?

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

@@ -23,6 +23,8 @@ 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
@@ -34,6 +36,7 @@ module AnyCable
         diff = instance_variables - was_ivars
 
         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))
@@ -59,14 +59,6 @@ module AnyCable
           end
         end
       end
-
-      initializer "anycable.testing" do |app|
-        next unless ::Rails.env.test?
-
-        ActiveSupport.on_load(:action_cable) do
-          require "anycable/rails/actioncable/testing"
-        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.0"
+    VERSION = "1.0.5"
   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.0
+  version: 1.0.5
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2021-02-24 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