anycable-rails 0.4.7 → 0.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7b9447d2754976500f75cf5544947ed086b3259
-  data.tar.gz: 306070a5d753988544515a876a271ddf7d1032cd
+  metadata.gz: 3dcb6dc5268c5322088c9da2d7925722eba8c12c
+  data.tar.gz: 218bc7ce31c10b0b42133cb6238d26a1b865010f
 SHA512:
-  metadata.gz: 2b3cdb613732eeec3f2a6c3c1bea1f14ac9cd4fd2037a026075dc0ddd41b6150abeb21bcc4fdd31f5af1f09a9860b7af60fc1a7de2485a7cff9aca97d335e713
-  data.tar.gz: 022af2cb8de1cb703c91e0f7fb8312098b40af99bf819b73088108822121a5c473001a2f5c10f9c6e802fcfb46c4bcb718ae7628fa16c3eb622d3c3558713e92
+  metadata.gz: 0a924c25ad9a6e4ae08560c78ce260c4941dc5886c33e9e023c323e38df6c47fad0c400635b983d459e9188147667eaa7b8ddfad47d9100b85d7e8e7225743a0
+  data.tar.gz: b18363482cf9b6c3a0012c70382383339101495fe2854cd478a06d129b891894832f27c4a61db9b60d6def737b68c4bcd3ab3cfb5a48341ad1c6de734ae9db26

data/.rubocop.yml

@@ -10,6 +10,8 @@ AllCops:
     - 'spec/dummy/**/*'
     - 'tmp/**/*'
     - 'bench/**/*'
+    - 'vendor/**/*'
+    - 'gemfiles/**/*'
     - 'lib/anycable/rpc/**/*'
     - 'Rakefile'
     - 'Gemfile'
@@ -27,9 +29,15 @@ Style/Documentation:
   Exclude:
     - 'spec/**/*.rb'
 
+Style/FormatString:
+  Enabled: false
+
 Style/StringLiterals: 
   Enabled: false
 
+Style/RegexpLiteral:
+  Enabled: false
+
 Style/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
 

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 cache: bundler
 
+notifications:
+  email: false
+
 rvm: 2.3.3
 
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## master
+
+- [#17](https://github.com/anycable/anycable-rails/issues/17) Refactor logging. ([@palkan][])
+
+Use Rails logger everywhere.
+
+Add access logs ([anycable/anycable#20](https://github.com/anycable/anycable/issues/20)).
+
 ## 0.4.7
 
 - Minor fixes. ([@palkan][])

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+
 gemspec
 
 local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local"

data/README.md

@@ -96,6 +96,27 @@ Don't forget to set cable url in your `config/environments/production.rb`:
 config.action_cable.url = "ws://localhost:3334/cable"
 ```
 
+### Logging
+
+Anycable uses `Rails.logger` as `Anycable.logger` by default, thus Anycable _debug_ mode (`ANYCABLE_DEBUG=1`) is not available, you should configure Rails logger instead, e.g.:
+
+```ruby
+# in Rails configuration
+if Anycable.config.debug
+  config.logger = Logger.new(STDOUT)
+  config.log_level = :debug
+end
+```
+
+You can also turn off access logging (`Started <request data>` / `Finished <request data>`):
+
+```ruby
+# in anycable.yml
+production:
+  access_logs_disabled: true
+```
+
+
 ## ActionCable Compatibility
 
 This is the compatibility list for the AnyCable gem, not for AnyCable servers (which may not support some of the features yet).

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: [:rubocop, :spec]

data/anycable-rails.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", "~> 5"
-  spec.add_dependency "anycable", "~>0.4.4"
+  spec.add_dependency "anycable", "0.5.0.rc1"
 
   spec.add_development_dependency "bundler", "~> 1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", ">= 3.4"
   spec.add_development_dependency "simplecov", ">= 0.3.8"
+  spec.add_development_dependency "rubocop", ">= 0.50"
   spec.add_development_dependency "pry-byebug"
 end

data/lib/anycable/rails.rb

@@ -2,33 +2,13 @@
 
 require "anycable"
 require "anycable/rails/version"
+require "anycable/rails/config"
 
 module Anycable
   # Rails handler for AnyCable
   module Rails
-    # Use this proxy to quack like a TaggedLoggerProxy
-    class LoggerProxy
-      def initialize(logger)
-        @logger = logger
-      end
-
-      def add_tags(*_tags)
-        @logger.warn "Tagged logger is not supported by AnyCable. Skip"
-      end
-
-      %i[debug info warn error fatal unknown].each do |severity|
-        define_method(severity) do |message|
-          @logger.send severity, message
-        end
-      end
-    end
-
     require "anycable/rails/engine"
     require "anycable/rails/actioncable/server"
     require "anycable/rails/actioncable/connection"
-
-    def self.logger
-      @logger ||= LoggerProxy.new(::Rails.logger)
-    end
   end
 end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "action_cable/connection"
 require "anycable/rails/refinements/subscriptions"
 require "anycable/rails/actioncable/channel"
@@ -11,7 +12,7 @@ module ActionCable
       attr_reader :socket
 
       class << self
-        def create(socket, **options)
+        def call(socket, **options)
           new(socket, **options)
         end
 
@@ -39,13 +40,18 @@ module ActionCable
       end
 
       def handle_open
+        logger.info started_request_message if access_logs?
+
         connect if respond_to?(:connect)
         send_welcome_message
       rescue ActionCable::Connection::Authorization::UnauthorizedError
+        logger.info finished_request_message('Rejected') if access_logs?
         close
       end
 
       def handle_close
+        logger.info finished_request_message if access_logs?
+
         subscriptions.unsubscribe_from_all
         disconnect if respond_to?(:disconnect)
       end
@@ -101,7 +107,32 @@ module ActionCable
       end
 
       def logger
-        Anycable::Rails.logger
+        Anycable.logger
+      end
+
+      private
+
+      def started_request_message
+        'Started "%s"%s for %s at %s' % [
+          request.filtered_path,
+          " [Anycable]",
+          request.ip,
+          Time.now.to_s
+        ]
+      end
+
+      def finished_request_message(reason = "Closed")
+        'Finished "%s"%s for %s at %s (%s)' % [
+          request.filtered_path,
+          " [Anycable]",
+          request.ip,
+          Time.now.to_s,
+          reason
+        ]
+      end
+
+      def access_logs?
+        Anycable.config.access_logs_disabled == false
       end
     end
   end

data/lib/anycable/rails/config.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Extend Anycable configuration with
+# `access_logs_disabled` options (defaults to false)
+Anycable::Config.attr_config access_logs_disabled: false

data/lib/anycable/rails/engine.rb

@@ -2,11 +2,32 @@
 
 module Anycable
   module Rails
+    # Use this proxy to quack like a TaggedLoggerProxy
+    class LoggerProxy
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def add_tags(*_tags)
+        @logger.warn "Tagged logger is not supported by AnyCable. Skip"
+      end
+
+      %i[debug info warn error fatal unknown].each do |severity|
+        define_method(severity) do |message|
+          @logger.send severity, message
+        end
+      end
+    end
+
     class Engine < ::Rails::Engine # :nodoc:
       initializer "disable built-in Action Cable mount" do |app|
         app.config.action_cable.mount_path = nil
       end
 
+      initializer "set up logger" do |_app|
+        Anycable.logger = LoggerProxy.new(::Rails.logger)
+      end
+
       initializer "release AR connections in RPC handler" do |_app|
         ActiveSupport.on_load(:active_record) do
           require "anycable/rails/activerecord/release_connection"

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Anycable
   module Rails
-    VERSION = "0.4.7"
+    VERSION = "0.5.0.rc1"
   end
 end

data/lib/generators/anycable/templates/script

@@ -4,9 +4,7 @@
 require ::File.expand_path('../../config/environment', __FILE__)
 require "anycable-rails"
 
-Anycable.configure do |config|
-  config.connection_factory = ActionCable.server.config.connection_class.call
-end
+Anycable.connection_factory = ActionCable.server.config.connection_class.call
 
 Rails.application.eager_load!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.5.0.rc1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,16 @@ dependencies:
   name: anycable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0.rc1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.8
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.50'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ files:
 - lib/anycable/rails/actioncable/connection.rb
 - lib/anycable/rails/actioncable/server.rb
 - lib/anycable/rails/activerecord/release_connection.rb
+- lib/anycable/rails/config.rb
 - lib/anycable/rails/engine.rb
 - lib/anycable/rails/refinements/subscriptions.rb
 - lib/anycable/rails/version.rb
@@ -157,12 +172,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Rails adapter for AnyCable