anycable-rails 0.5.5 → 0.6.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0589fdada6b17d8200e9f2c35b31a4303aa8f81110056a10bf0743914dd79aa7'
-  data.tar.gz: a67888ee7bbc93e8d05c0d864bb5e561b89e145b232b411d8b9399870e33b61a
+  metadata.gz: 23c007d1a03872b62769d01916c37dc08e65b209f7f2c03dc82506142dd9deba
+  data.tar.gz: 852a706ac6f822674f4f8ded679dd369b1fed46adfebf4687ff917e04d6b5dce
 SHA512:
-  metadata.gz: ac48f3cd8e58ced758e93f0d6e44f321b5bb4d7aca5e06541bad613b2a0d19c0f3b7be8b29fcc9253d454ac8435170b8fa6b45240a1d0e26a55857240dcd4824
-  data.tar.gz: 157a400f6121f22d3426d3661af6e98b8932ec7a547d36d9c688f8498b7def72ecf86fd98ff80f2afb3fcd4906646a954ce82834753bffe262de5e328b87c93b
+  metadata.gz: d7d61c3f61e07ff50a5ab51598647befa8295345864afa913829cc4311aa178dc2841e1bc9ddce5cb5a2f822add9d2a0cc667ecef438cfed3e0c056d9c726497
+  data.tar.gz: 4d9233be76b119ca9b09dcdb010e9a9bc6fdfa1c883530b97455a2ec2d23331458991c442b40640006ee8aa07ec12f5e0df3bf6c6b3a705761184661761e40d5

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,29 @@
+<!--
+  First of all, thanks for your report/suggestion/whatever!
+
+  This template is for bug reports. If you are reporting a bug, please continue on. If you are here for another reason, 
+  feel free to skip the rest of this template.
+-->
+
+### Tell us about your environment
+
+**Ruby version:**
+
+**Rails version:**
+
+**`anycable` gem version:**
+
+**`anycable-rails` gem version:**
+
+**`grpc` gem version:**
+
+### What did you do?
+
+### What did you expect to happen?
+
+### What actually happened?
+
+<!--
+  Please, provide reproduction script (using this template (https://github.com/anycable/anycable/blob/master/etc/bug_report_template.rb)
+  when submitting bugs if possible.
+-->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!--
+  First of all, thanks for contributing!
+
+  If it's a typo fix or minor documentation update feel free to skip the rest of this template!
+-->
+
+<!--
+  If it's a bug fix, then link it to the issue, for example:
+
+  Fixes #xxx
+-->
+
+
+<!--
+  Otherwise, describe the changes: 
+
+### What is the purpose of this pull request?
+
+### What changes did you make? (overview)
+
+### Is there anything you'd like reviewers to focus on?
+
+-->
+
+<!--
+    Please ensure your PR is ready:
+
+    - Include tests for this change
+    - Add Changelog entry
+    - Update documentation for this change (if appropriate)
+-->

data/.rubocop.yml

@@ -5,58 +5,45 @@ AllCops:
     - 'lib/**/*.rake'
     - 'spec/**/*.rb'
   Exclude:
-    - '*.gemspec'
     - 'bin/**/*'
-    - 'spec/dummy/**/*'
     - 'tmp/**/*'
-    - 'bench/**/*'
+    - 'lib/anycable/rpc/**/*'
     - 'vendor/**/*'
     - 'gemfiles/**/*'
-    - 'lib/anycable/rpc/**/*'
-    - 'Rakefile'
     - 'Gemfile'
+    - 'Rakefile'
+    - '*.gemspec'
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.3
-
-Style/AccessorMethodName:
-  Enabled: false
+  TargetRubyVersion: 2.4
 
-Style/TrivialAccessors:
+Rails:
   Enabled: false
 
 Style/Documentation:
   Exclude:
     - 'spec/**/*.rb'
 
-Style/FormatString:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
+Naming/FileName:
+  Exclude:
+    - 'lib/anycable-rails.rb'
 
 Style/StringLiterals: 
-  Enabled: false
+  EnforcedStyle: double_quotes
 
 Style/RegexpLiteral:
   Enabled: false
 
-Style/SpaceInsideStringInterpolation:
+Style/FormatStringToken:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
 
 Style/BlockDelimiters:
   Exclude:
     - 'spec/**/*.rb'
 
-Style/PercentLiteralDelimeters:
-  Enabled: false
-
-Lint/ScriptPermission:
-  Enabled: false
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
 Metrics/MethodLength:
   Exclude:
     - 'spec/**/*.rb'
@@ -66,18 +53,21 @@ Metrics/LineLength:
   Exclude:
     - 'spec/**/*.rb'
 
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/**/*.rb'
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
-Naming/FileName:
+Metrics/CyclomaticComplexity:
   Exclude:
-    - 'README.md'
-    - 'CHANGELOG.md'
-    - 'lib/anycable-rails.rb'
+    - 'spec/**/*.rb'
 
-Rails/Date:
-  Enabled: false
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'spec/**/*.rb'
 
-Rails/TimeZone:
-  Enabled: false
+Lint/HandleExceptions:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,35 @@
 # Change log
 
-## master
+## 0.6.0-dev
+
+- [PR #56](https://github.com/anycable/anycable-rails/pull/56) Request verification based on ActionCable config. ([@DmitryTsepelev][])
+
+- Add WS server session ID to log tags if present. ([@palkan][])
+
+- Support tagged logging. ([@palkan][])
+
+- Action Cable monkey-patches are only loaded in the context of AnyCable CLI. ([@palkan][])
+
+  No need to think about `requie` and `group` for `anycable-rails`, just add it to Gemfile.
+
+- Add `:any_cable` subscription adapter for Action Cable. ([@palkan][])
+
+  Use `:any_cable` adapter for Action Cable to broadcast data to AnyCable.
+
+  No more `pubsub` monkey-patches 🎉.
+
+- Added Rails executor/reloader support. ([@palkan][])
+
+- **[Breaking]** No more generators. ([@palkan][])
+
+  No need to generate AnyCable runner script since `anycable` gem ships with
+  the CLI.
+
+- Add dynamic (`AnyCable::CompatibilityError`) compatibility checks. ([@DmitryTsepelev][])
+
+- Added static (RuboCop) compatibility checks. ([@DmitryTsepelev][])
+
+  See https://github.com/anycable/anycable-rails/issues/52
 
 ## 0.5.4 (2018-06-13)
 
@@ -58,3 +87,4 @@ Ignore tagged logger features ('cause we do not have _persistent_ logger).
 
 [@palkan]: https://github.com/palkan
 [@alekseyl]: https://github.com/alekseyl
+[@DmitryTsepelev]: https://github.com/DmitryTsepelev

data/README.md

@@ -1,152 +1,107 @@
 [![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 Status](https://travis-ci.org/anycable/anycable-rails.svg?branch=master)](https://travis-ci.org/anycable/anycable-rails)
 [![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/#using_with_rails)
 
-# Anycable Rails
+# AnyCable Rails
 
-AnyCable allows you to use any WebSocket server (written in any language) as a replacement for built-in Rails ActionCable server.
+AnyCable allows you to use any WebSocket server (written in any language) as a replacement for built-in Rails Action Cable server.
 
-With AnyCable you can use channels, client-side JS, broadcasting - (almost) all that you can do with ActionCable.
+With AnyCable you can use channels, client-side JS, broadcasting - (almost) all that you can do with Action Cable.
 
-You can even use ActionCable in development and not be afraid of compatibility issues.
+You can even use Action Cable in development and not be afraid of [compatibility issues](#compatibility).
 
-[Example Application](https://github.com/anycable/anycable_demo)
+💾 [Example Application](https://github.com/anycable/anycable_demo)
+
+📑 [Documentation](https://docs.anycable.io).
 
-For usage outside Rails see [AnyCable repository](https://github.com/anycable/anycable).
 
 <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>
 
 ## Requirements
 
-- Ruby ~> 2.3;
+- Ruby ~> 2.4;
 - Rails ~> 5.0;
-- Redis
+- Redis (see [other options]() for broadcasting)
 
 ## How It Works?
 
 <img src="https://trello-attachments.s3.amazonaws.com/5781e0ed48e4679e302833d3/820x987/5b6a305417b04e20e75f49c5816e027c/Anycable_vs_ActionCable_copy.jpg" width="400" />
 
-## Links
-
-- [GitPitch Slides](https://gitpitch.com/anycable/anycable/master?grs=github)
-
-- RailsClub Moscow 2016 [slides](https://speakerdeck.com/palkan/railsclub-moscow-2016-anycable) and [video](https://www.youtube.com/watch?v=-k7GQKuBevY&list=PLiWUIs1hSNeOXZhotgDX7Y7qBsr24cu7o&index=4) (RU)
-
-
-## Compatible WebSocket servers
-
-- [Anycable Go](https://github.com/anycable/anycable-go)
-- [ErlyCable](https://github.com/anycable/erlycable)
-
+## Usage
 
-## Installation
 
-Add Anycable to your application's Gemfile:
+Add `anycable-rails` gem to your Gemfile:
 
 ```ruby
-gem 'anycable-rails'
+gem "anycable-rails"
 
-# or if you want to use built-in Action Cable server
-# for test and development (which is possible and recommended)
-gem 'anycable-rails', group: :production
+# when using Redis broadcast adapter
+gem "redis", ">= 4.0"
 ```
 
-**NOTE**: if you want to require `anycable-rails` _manually_ (i.e. with `require: false` in your `Gemfile`)
-make sure that it's loaded prior to `Rails.application.initialize!` call (see `config/environment.rb`).
+(and don't forget to run `bundle install`).
 
-And then run:
+Next, specify AnyCable subscription adapter for Action Cable:
 
-```shell
-rails generate anycable
+```yml
+# config/cable.yml
+production:
+  adapter: any_cable
 ```
 
-to create executable.
+and specify AnyCable WebSocket server URL:
 
-## Configuration
+```ruby
+# For development it's likely the localhost
 
-Add `config/anycable.yml`if you want to override defaults (see below):
+# config/environments/development.rb
+config.action_cable.url = "ws://localhost:3334/cable"
 
-```yml
-production:
-  # gRPC server host
-  rpc_host: "localhost:50051"
-  # Redis URL (for broadcasting) 
-  redis_url: "redis://localhost:6379/2"
-  # Redis channel name
-  redis_channel: "anycable"
+# For production it's likely to have a sub-domain and secure connection
 
+# config/environments/production.rb
+config.action_cable.url = "wss://ws.example.com/cable"
 ```
 
-Anycable uses [anyway_config](https://github.com/palkan/anyway_config), thus it is also possible to set configuration variables through `secrets.yml` or environment vars.
+hen, run AnyCable RPC server:
 
-## Usage
+```ruby
+$ bundle exec anycable
 
-Run Anycable RPC server:
+# don't forget to provide Rails env
 
-```ruby
-RAILS_ENV=production ./bin/anycable
+$ RAILS_ENV=production bundle exec anycable
 ```
 
-and also run AnyCable-compatible WebSocket server, e.g. [anycable-go](https://github.com/anycable/anycable-go):
+And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/#go_getting_started.md):
 
 ```sh
 anycable-go --host=localhost --port=3334
 ```
 
-Don't forget to set cable url in your environment:
+See [documentation](https://docs.anycable.io/#using_with_rails) for more information on AnyCable + Rails usage.
 
-```ruby
-# For development it's likely the localhost
+## Action Cable Compatibility
 
-# config/environments/development.rb
-config.action_cable.url = "ws://localhost:3334/cable"
+See [documentation](https://docs.anycable.io/#compatibility).
 
-# For production it's likely to have a sub-domain and secure connection
-
-# config/environments/production.rb
-config.action_cable.url = "wss://ws.example.com/cable"
-```
+## Links
 
-### Logging
+- [AnyCable: Action Cable on steroids!](https://evilmartians.com/chronicles/anycable-actioncable-on-steroids)
 
-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.:
+- [From Action to Any](https://medium.com/@leshchuk/from-action-to-any-1e8d863dd4cf) by [@alekseyl](https://github.com/alekseyl)
 
-```ruby
-# in Rails configuration
-if Anycable.config.debug
-  config.logger = Logger.new(STDOUT)
-  config.log_level = :debug
-end
-```
+## Talks
 
-You can also turn on access logging (`Started <request data>` / `Finished <request data>`):
+- One cable to rule them all, RubyKaigi 2018, [slides](https://speakerdeck.com/palkan/rubykaigi-2018-anycable-one-cable-to-rule-them-all) and [video](https://www.youtube.com/watch?v=jXCPuNICT8s) (EN)
 
-```ruby
-# in anycable.yml
-production:
-  access_logs_disabled: false
-```
+- Wroc_Love.rb 2018 [slides](https://speakerdeck.com/palkan/wroc-love-dot-rb-2018-cables-cables-cables) and [video](https://www.youtube.com/watch?v=AUxFFOehiy0) (EN)
 
-## ActionCable Compatibility
-
-This is the compatibility list for the AnyCable gem, not for AnyCable servers (which may not support some of the features yet).
-
-Feature                  | Status 
--------------------------|--------
-Connection Identifiers   | +
-Connection Request (cookies, params) | +
-Disconnect Handling | +
-Subscribe to channels | +
-Parameterized subscriptions | +
-Unsubscribe from channels | +
-[Subscription Instance Variables](http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html) | -
-Performing Channel Actions | +
-Streaming | +
-[Custom stream callbacks](http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html) | -
-Broadcasting | +
-Periodical Timers | -
-Disconnect remote clients | -
+## Compatible WebSocket servers
 
+- [AnyCable Go](https://github.com/anycable/anycable-go)
+- [ErlyCable](https://github.com/anycable/erlycable)
 
 ## Contributing
 

data/Rakefile

@@ -2,7 +2,12 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: [:rubocop, :spec]
+desc "Run compatibility specs"
+RSpec::Core::RakeTask.new("spec:compatibility") do |task|
+  task.pattern = "spec/**/*_compatibility.rb"
+  task.verbose = false
+end
+
+task default: %w[rubocop spec:compatibility spec]

data/anycable-rails.gemspec

@@ -6,7 +6,7 @@ require 'anycable/rails/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "anycable-rails"
-  spec.version       = Anycable::Rails::VERSION
+  spec.version       = AnyCable::Rails::VERSION
   spec.authors       = ["palkan"]
   spec.email         = ["dementiev.vm@gmail.com"]
 
@@ -19,12 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 5"
-  spec.add_dependency "anycable", "~> 0.5.0"
+  spec.add_dependency "anycable", "0.6.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 "ammeter", "~> 1.1"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "simplecov", ">= 0.3.8"
   spec.add_development_dependency "rubocop", "~> 0.60.0"
   spec.add_development_dependency "pry-byebug"