rubocop-anycable-rails 1.5.6 โ 1.6.0.rc.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -71
- data/lib/anycable/rails/version.rb +1 -1
- metadata +7 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 95172933f0049fda20cdfe829cd3d00f00866a33c93eefb49ab3edc4b519c813
|
4
|
+
data.tar.gz: 4aa3b4b6b1730ccbb74acbfad84921a316cb201905b527c7a4fbf51104bde739
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: be14311e21ffcb215c062b7ff237cf1ef0f60bb9dff9e9052cf422cf5ba7da488c283b5ce25cd26081b4791f5cf9663a7f7e90c25fa1826eda28ff523e146127
|
7
|
+
data.tar.gz: 865964b33c5d4efaa028b96bc83995377500ad94faf18390eeea596bfbe0c42ac20030a1764343fbdba022676146f6ba172447a4c2c8533ec83b76fdb1484c1f
|
data/README.md
CHANGED
@@ -1,30 +1,18 @@
|
|
1
|
-
[![Gem Version](https://badge.fury.io/rb/anycable
|
1
|
+
[![Gem Version](https://badge.fury.io/rb/anycable.svg)](https://rubygems.org/gems/anycable)
|
2
2
|
[![Build](https://github.com/anycable/anycable-rails/workflows/Build/badge.svg)](https://github.com/anycable/anycable-rails/actions)
|
3
3
|
[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/rails/getting_started)
|
4
4
|
|
5
|
-
# AnyCable Rails
|
5
|
+
# AnyCable SDK for Ruby on Rails
|
6
6
|
|
7
|
-
|
7
|
+
<img align="right" height="150" width="129"
|
8
|
+
title="AnyCable logo" src="https://docs.anycable.io/assets/images/logo.svg">
|
8
9
|
|
9
|
-
|
10
|
+
[AnyCable](https://github.com/anycable/anycable) is an open-source language-agnostic realtime server for reliable two-way communication over WebSockets and SSE.
|
11
|
+
This repository contains code for AnyCable Rails SKD that allows you to use AnyCable as a drop-in replacement for Action Cable.
|
10
12
|
|
11
|
-
๐พ [Example Application](https://github.com/anycable/anycable_rails_demo)
|
13
|
+
๐ [Website](https://anycable.io) ยท ๐ [Documentation](https://docs.anycable.io/rails/getting_started) ยท ๐พ [Example Rails Application](https://github.com/anycable/anycable_rails_demo)
|
12
14
|
|
13
|
-
|
14
|
-
|
15
|
-
> [AnyCable Pro](https://docs.anycable.io/pro) has been launched ๐
|
16
|
-
|
17
|
-
<a href="https://evilmartians.com/">
|
18
|
-
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
|
19
|
-
|
20
|
-
## Requirements
|
21
|
-
|
22
|
-
- Ruby >= 3.1
|
23
|
-
- Rails >= 6.0\*
|
24
|
-
|
25
|
-
\* Recent `anycable-rails` versions only work with Rails 8+; older versions compatible with Rails 6 and Rails 7 still receive fixes and minor updates (patch releases).
|
26
|
-
|
27
|
-
## Usage
|
15
|
+
## Quick Start
|
28
16
|
|
29
17
|
Add `anycable-rails` gem to your Gemfile:
|
30
18
|
|
@@ -32,62 +20,13 @@ Add `anycable-rails` gem to your Gemfile:
|
|
32
20
|
gem "anycable-rails"
|
33
21
|
```
|
34
22
|
|
35
|
-
|
36
|
-
|
37
|
-
After the gem was installed, you can run an interactive wizard to configure your Rails application for using with AnyCable by running a generator:
|
23
|
+
Then run our interactive setup command:
|
38
24
|
|
39
25
|
```sh
|
40
26
|
bundle exec rails g anycable:setup
|
41
27
|
```
|
42
28
|
|
43
|
-
|
44
|
-
|
45
|
-
Specify AnyCable subscription adapter for Action Cable:
|
46
|
-
|
47
|
-
```yml
|
48
|
-
# config/cable.yml
|
49
|
-
development:
|
50
|
-
adapter: any_cable # or anycable
|
51
|
-
|
52
|
-
production:
|
53
|
-
adapter: any_cable
|
54
|
-
```
|
55
|
-
|
56
|
-
and specify AnyCable WebSocket server URL:
|
57
|
-
|
58
|
-
```ruby
|
59
|
-
# For development it's likely the localhost
|
60
|
-
|
61
|
-
# config/environments/development.rb
|
62
|
-
config.action_cable.url = "ws://localhost:8080/cable"
|
63
|
-
|
64
|
-
# For production it's likely to have a sub-domain and secure connection
|
65
|
-
|
66
|
-
# config/environments/production.rb
|
67
|
-
config.action_cable.url = "wss://ws.example.com/cable"
|
68
|
-
```
|
69
|
-
|
70
|
-
Then, run AnyCable RPC server:
|
71
|
-
|
72
|
-
```sh
|
73
|
-
$ bundle exec anycable
|
74
|
-
|
75
|
-
# don't forget to provide Rails env
|
76
|
-
|
77
|
-
$ RAILS_ENV=production bundle exec anycable
|
78
|
-
```
|
79
|
-
|
80
|
-
And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/anycable-go/getting_started):
|
81
|
-
|
82
|
-
```sh
|
83
|
-
anycable-go --host=localhost --port=8080
|
84
|
-
```
|
85
|
-
|
86
|
-
See [documentation](https://docs.anycable.io/rails/getting_started) for more information on AnyCable + Rails usage.
|
87
|
-
|
88
|
-
## Action Cable Compatibility
|
89
|
-
|
90
|
-
See [documentation](https://docs.anycable.io/rails/compatibility).
|
29
|
+
Learn more [here](https://docs.anycable.io/rails/getting_started).
|
91
30
|
|
92
31
|
## Contributing
|
93
32
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rubocop-anycable-rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.6.0.rc.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- palkan
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-01-
|
11
|
+
date: 2025-01-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rubocop
|
@@ -51,7 +51,7 @@ metadata:
|
|
51
51
|
homepage_uri: https://anycable.io/
|
52
52
|
source_code_uri: http://github.com/anycable/anycable-rails
|
53
53
|
funding_uri: https://github.com/sponsors/anycable
|
54
|
-
post_install_message:
|
54
|
+
post_install_message:
|
55
55
|
rdoc_options: []
|
56
56
|
require_paths:
|
57
57
|
- lib
|
@@ -62,12 +62,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
62
62
|
version: '2.7'
|
63
63
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
64
64
|
requirements:
|
65
|
-
- - "
|
65
|
+
- - ">"
|
66
66
|
- !ruby/object:Gem::Version
|
67
|
-
version:
|
67
|
+
version: 1.3.1
|
68
68
|
requirements: []
|
69
69
|
rubygems_version: 3.4.19
|
70
|
-
signing_key:
|
70
|
+
signing_key:
|
71
71
|
specification_version: 4
|
72
72
|
summary: RuboCop rules for AnyCable Rails
|
73
73
|
test_files: []
|