actioncable 7.0.8.6 → 7.1.0.beta1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +58 -166
- data/MIT-LICENSE +1 -1
- data/README.md +4 -4
- data/app/assets/javascripts/action_cable.js +25 -4
- data/app/assets/javascripts/actioncable.esm.js +25 -4
- data/app/assets/javascripts/actioncable.js +25 -4
- data/lib/action_cable/channel/base.rb +17 -5
- data/lib/action_cable/channel/broadcasting.rb +3 -1
- data/lib/action_cable/channel/callbacks.rb +16 -0
- data/lib/action_cable/channel/naming.rb +4 -2
- data/lib/action_cable/channel/streams.rb +2 -0
- data/lib/action_cable/channel/test_case.rb +6 -1
- data/lib/action_cable/connection/authorization.rb +1 -1
- data/lib/action_cable/connection/base.rb +18 -5
- data/lib/action_cable/connection/callbacks.rb +51 -0
- data/lib/action_cable/connection/internal_channel.rb +3 -1
- data/lib/action_cable/connection/stream.rb +1 -3
- data/lib/action_cable/connection/stream_event_loop.rb +0 -1
- data/lib/action_cable/connection/subscriptions.rb +2 -0
- data/lib/action_cable/connection/tagged_logger_proxy.rb +6 -4
- data/lib/action_cable/connection/test_case.rb +3 -1
- data/lib/action_cable/connection/web_socket.rb +2 -0
- data/lib/action_cable/deprecator.rb +7 -0
- data/lib/action_cable/engine.rb +13 -5
- data/lib/action_cable/gem_version.rb +4 -4
- data/lib/action_cable/remote_connections.rb +11 -2
- data/lib/action_cable/server/base.rb +3 -0
- data/lib/action_cable/server/broadcasting.rb +2 -0
- data/lib/action_cable/server/configuration.rb +12 -2
- data/lib/action_cable/server/connections.rb +3 -1
- data/lib/action_cable/server/worker.rb +0 -1
- data/lib/action_cable/subscription_adapter/async.rb +0 -2
- data/lib/action_cable/subscription_adapter/postgresql.rb +0 -1
- data/lib/action_cable/subscription_adapter/redis.rb +3 -6
- data/lib/action_cable/subscription_adapter/test.rb +3 -5
- data/lib/action_cable/test_helper.rb +53 -22
- data/lib/action_cable/version.rb +1 -1
- data/lib/action_cable.rb +24 -12
- data/lib/rails/generators/channel/USAGE +14 -8
- data/lib/rails/generators/channel/channel_generator.rb +21 -7
- metadata +31 -19
- data/lib/action_cable/channel.rb +0 -17
- data/lib/action_cable/connection.rb +0 -22
- data/lib/action_cable/server.rb +0 -16
- data/lib/action_cable/subscription_adapter.rb +0 -12
data/lib/action_cable/version.rb
CHANGED
data/lib/action_cable.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
#--
|
4
|
-
# Copyright (c)
|
4
|
+
# Copyright (c) 37signals LLC
|
5
5
|
#
|
6
6
|
# Permission is hereby granted, free of charge, to any person obtaining
|
7
7
|
# a copy of this software and associated documentation files (the
|
@@ -25,10 +25,29 @@
|
|
25
25
|
|
26
26
|
require "active_support"
|
27
27
|
require "active_support/rails"
|
28
|
-
require "
|
28
|
+
require "zeitwerk"
|
29
29
|
|
30
|
+
Zeitwerk::Loader.for_gem.tap do |loader|
|
31
|
+
loader.ignore(
|
32
|
+
"#{__dir__}/rails", # Contains generators, templates, docs, etc.
|
33
|
+
"#{__dir__}/action_cable/gem_version.rb",
|
34
|
+
"#{__dir__}/action_cable/deprecator.rb",
|
35
|
+
)
|
36
|
+
|
37
|
+
loader.do_not_eager_load(
|
38
|
+
"#{__dir__}/action_cable/subscription_adapter", # Adapters are required and loaded on demand.
|
39
|
+
"#{__dir__}/action_cable/test_helper.rb",
|
40
|
+
Dir["#{__dir__}/action_cable/**/test_case.rb"]
|
41
|
+
)
|
42
|
+
|
43
|
+
loader.inflector.inflect("postgresql" => "PostgreSQL")
|
44
|
+
end.setup
|
45
|
+
|
46
|
+
# :markup: markdown
|
47
|
+
# :include: actioncable/README.md
|
30
48
|
module ActionCable
|
31
|
-
|
49
|
+
require_relative "action_cable/version"
|
50
|
+
require_relative "action_cable/deprecator"
|
32
51
|
|
33
52
|
INTERNAL = {
|
34
53
|
message_types: {
|
@@ -41,7 +60,8 @@ module ActionCable
|
|
41
60
|
disconnect_reasons: {
|
42
61
|
unauthorized: "unauthorized",
|
43
62
|
invalid_request: "invalid_request",
|
44
|
-
server_restart: "server_restart"
|
63
|
+
server_restart: "server_restart",
|
64
|
+
remote: "remote"
|
45
65
|
},
|
46
66
|
default_mount_path: "/cable",
|
47
67
|
protocols: ["actioncable-v1-json", "actioncable-unsupported"].freeze
|
@@ -51,12 +71,4 @@ module ActionCable
|
|
51
71
|
module_function def server
|
52
72
|
@server ||= ActionCable::Server::Base.new
|
53
73
|
end
|
54
|
-
|
55
|
-
autoload :Server
|
56
|
-
autoload :Connection
|
57
|
-
autoload :Channel
|
58
|
-
autoload :RemoteConnections
|
59
|
-
autoload :SubscriptionAdapter
|
60
|
-
autoload :TestHelper
|
61
|
-
autoload :TestCase
|
62
74
|
end
|
@@ -1,13 +1,19 @@
|
|
1
1
|
Description:
|
2
|
-
============
|
3
2
|
Generates a new cable channel for the server (in Ruby) and client (in JavaScript).
|
4
3
|
Pass the channel name, either CamelCased or under_scored, and an optional list of channel actions as arguments.
|
5
4
|
|
6
|
-
|
7
|
-
|
8
|
-
bin/rails generate channel Chat speak
|
5
|
+
Examples:
|
6
|
+
`bin/rails generate channel notification`
|
9
7
|
|
10
|
-
creates a
|
11
|
-
Channel: app/channels/
|
12
|
-
Test: test/channels/
|
13
|
-
Assets: $JAVASCRIPT_PATH/channels/
|
8
|
+
creates a notification channel class, test and JavaScript asset:
|
9
|
+
Channel: app/channels/notification_channel.rb
|
10
|
+
Test: test/channels/notification_channel_test.rb
|
11
|
+
Assets: $JAVASCRIPT_PATH/channels/notification_channel.js
|
12
|
+
|
13
|
+
`bin/rails generate channel chat speak`
|
14
|
+
|
15
|
+
creates a chat channel with a speak action.
|
16
|
+
|
17
|
+
`bin/rails generate channel comments --no-assets`
|
18
|
+
|
19
|
+
creates a comments channel without JavaScript assets.
|
@@ -24,7 +24,7 @@ module Rails
|
|
24
24
|
|
25
25
|
if using_importmap?
|
26
26
|
pin_javascript_dependencies
|
27
|
-
elsif
|
27
|
+
elsif using_js_runtime?
|
28
28
|
install_javascript_dependencies
|
29
29
|
end
|
30
30
|
end
|
@@ -57,22 +57,26 @@ module Rails
|
|
57
57
|
def create_channel_javascript_file
|
58
58
|
channel_js_path = File.join("app/javascript/channels", class_path, "#{file_name}_channel")
|
59
59
|
js_template "javascript/channel", channel_js_path
|
60
|
-
gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless
|
60
|
+
gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless using_js_runtime?
|
61
61
|
end
|
62
62
|
|
63
63
|
def import_channels_in_javascript_entrypoint
|
64
64
|
append_to_file "app/javascript/application.js",
|
65
|
-
|
65
|
+
using_js_runtime? ? %(import "./channels"\n) : %(import "channels"\n)
|
66
66
|
end
|
67
67
|
|
68
68
|
def import_channel_in_javascript_entrypoint
|
69
69
|
append_to_file "app/javascript/channels/index.js",
|
70
|
-
|
70
|
+
using_js_runtime? ? %(import "./#{file_name}_channel"\n) : %(import "channels/#{file_name}_channel"\n)
|
71
71
|
end
|
72
72
|
|
73
73
|
def install_javascript_dependencies
|
74
74
|
say "Installing JavaScript dependencies", :green
|
75
|
-
|
75
|
+
if using_bun?
|
76
|
+
run "bun add @rails/actioncable"
|
77
|
+
elsif using_node?
|
78
|
+
run "yarn add @rails/actioncable"
|
79
|
+
end
|
76
80
|
end
|
77
81
|
|
78
82
|
def pin_javascript_dependencies
|
@@ -82,7 +86,6 @@ pin_all_from "app/javascript/channels", under: "channels"
|
|
82
86
|
RUBY
|
83
87
|
end
|
84
88
|
|
85
|
-
|
86
89
|
def file_name
|
87
90
|
@_file_name ||= super.sub(/_channel\z/i, "")
|
88
91
|
end
|
@@ -95,8 +98,19 @@ pin_all_from "app/javascript/channels", under: "channels"
|
|
95
98
|
@using_javascript ||= options[:assets] && root.join("app/javascript").exist?
|
96
99
|
end
|
97
100
|
|
101
|
+
def using_js_runtime?
|
102
|
+
@using_js_runtime ||= root.join("package.json").exist?
|
103
|
+
end
|
104
|
+
|
105
|
+
def using_bun?
|
106
|
+
# Cannot assume bun.lockb has been generated yet so we look for
|
107
|
+
# a file known to be generated by the jsbundling-rails gem
|
108
|
+
@using_bun ||= using_js_runtime? && root.join("bun.config.js").exist?
|
109
|
+
end
|
110
|
+
|
98
111
|
def using_node?
|
99
|
-
|
112
|
+
# Bun is the only runtime that _isn't_ node.
|
113
|
+
@using_node ||= using_js_runtime? && !root.join("bun.config.js").exist?
|
100
114
|
end
|
101
115
|
|
102
116
|
def using_importmap?
|
metadata
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: actioncable
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 7.0.
|
4
|
+
version: 7.1.0.beta1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Pratik Naik
|
8
8
|
- David Heinemeier Hansson
|
9
|
-
autorequire:
|
9
|
+
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date:
|
12
|
+
date: 2023-09-13 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: activesupport
|
@@ -17,28 +17,28 @@ dependencies:
|
|
17
17
|
requirements:
|
18
18
|
- - '='
|
19
19
|
- !ruby/object:Gem::Version
|
20
|
-
version: 7.0.
|
20
|
+
version: 7.1.0.beta1
|
21
21
|
type: :runtime
|
22
22
|
prerelease: false
|
23
23
|
version_requirements: !ruby/object:Gem::Requirement
|
24
24
|
requirements:
|
25
25
|
- - '='
|
26
26
|
- !ruby/object:Gem::Version
|
27
|
-
version: 7.0.
|
27
|
+
version: 7.1.0.beta1
|
28
28
|
- !ruby/object:Gem::Dependency
|
29
29
|
name: actionpack
|
30
30
|
requirement: !ruby/object:Gem::Requirement
|
31
31
|
requirements:
|
32
32
|
- - '='
|
33
33
|
- !ruby/object:Gem::Version
|
34
|
-
version: 7.0.
|
34
|
+
version: 7.1.0.beta1
|
35
35
|
type: :runtime
|
36
36
|
prerelease: false
|
37
37
|
version_requirements: !ruby/object:Gem::Requirement
|
38
38
|
requirements:
|
39
39
|
- - '='
|
40
40
|
- !ruby/object:Gem::Version
|
41
|
-
version: 7.0.
|
41
|
+
version: 7.1.0.beta1
|
42
42
|
- !ruby/object:Gem::Dependency
|
43
43
|
name: nio4r
|
44
44
|
requirement: !ruby/object:Gem::Requirement
|
@@ -67,6 +67,20 @@ dependencies:
|
|
67
67
|
- - ">="
|
68
68
|
- !ruby/object:Gem::Version
|
69
69
|
version: 0.6.1
|
70
|
+
- !ruby/object:Gem::Dependency
|
71
|
+
name: zeitwerk
|
72
|
+
requirement: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - "~>"
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '2.6'
|
77
|
+
type: :runtime
|
78
|
+
prerelease: false
|
79
|
+
version_requirements: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - "~>"
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '2.6'
|
70
84
|
description: Structure many real-time application concerns into channels over a single
|
71
85
|
WebSocket connection.
|
72
86
|
email:
|
@@ -83,7 +97,6 @@ files:
|
|
83
97
|
- app/assets/javascripts/actioncable.esm.js
|
84
98
|
- app/assets/javascripts/actioncable.js
|
85
99
|
- lib/action_cable.rb
|
86
|
-
- lib/action_cable/channel.rb
|
87
100
|
- lib/action_cable/channel/base.rb
|
88
101
|
- lib/action_cable/channel/broadcasting.rb
|
89
102
|
- lib/action_cable/channel/callbacks.rb
|
@@ -91,9 +104,9 @@ files:
|
|
91
104
|
- lib/action_cable/channel/periodic_timers.rb
|
92
105
|
- lib/action_cable/channel/streams.rb
|
93
106
|
- lib/action_cable/channel/test_case.rb
|
94
|
-
- lib/action_cable/connection.rb
|
95
107
|
- lib/action_cable/connection/authorization.rb
|
96
108
|
- lib/action_cable/connection/base.rb
|
109
|
+
- lib/action_cable/connection/callbacks.rb
|
97
110
|
- lib/action_cable/connection/client_socket.rb
|
98
111
|
- lib/action_cable/connection/identification.rb
|
99
112
|
- lib/action_cable/connection/internal_channel.rb
|
@@ -104,18 +117,17 @@ files:
|
|
104
117
|
- lib/action_cable/connection/tagged_logger_proxy.rb
|
105
118
|
- lib/action_cable/connection/test_case.rb
|
106
119
|
- lib/action_cable/connection/web_socket.rb
|
120
|
+
- lib/action_cable/deprecator.rb
|
107
121
|
- lib/action_cable/engine.rb
|
108
122
|
- lib/action_cable/gem_version.rb
|
109
123
|
- lib/action_cable/helpers/action_cable_helper.rb
|
110
124
|
- lib/action_cable/remote_connections.rb
|
111
|
-
- lib/action_cable/server.rb
|
112
125
|
- lib/action_cable/server/base.rb
|
113
126
|
- lib/action_cable/server/broadcasting.rb
|
114
127
|
- lib/action_cable/server/configuration.rb
|
115
128
|
- lib/action_cable/server/connections.rb
|
116
129
|
- lib/action_cable/server/worker.rb
|
117
130
|
- lib/action_cable/server/worker/active_record_connection_management.rb
|
118
|
-
- lib/action_cable/subscription_adapter.rb
|
119
131
|
- lib/action_cable/subscription_adapter/async.rb
|
120
132
|
- lib/action_cable/subscription_adapter/base.rb
|
121
133
|
- lib/action_cable/subscription_adapter/channel_prefix.rb
|
@@ -142,12 +154,12 @@ licenses:
|
|
142
154
|
- MIT
|
143
155
|
metadata:
|
144
156
|
bug_tracker_uri: https://github.com/rails/rails/issues
|
145
|
-
changelog_uri: https://github.com/rails/rails/blob/v7.0.
|
146
|
-
documentation_uri: https://api.rubyonrails.org/v7.0.
|
157
|
+
changelog_uri: https://github.com/rails/rails/blob/v7.1.0.beta1/actioncable/CHANGELOG.md
|
158
|
+
documentation_uri: https://api.rubyonrails.org/v7.1.0.beta1/
|
147
159
|
mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
|
148
|
-
source_code_uri: https://github.com/rails/rails/tree/v7.0.
|
160
|
+
source_code_uri: https://github.com/rails/rails/tree/v7.1.0.beta1/actioncable
|
149
161
|
rubygems_mfa_required: 'true'
|
150
|
-
post_install_message:
|
162
|
+
post_install_message:
|
151
163
|
rdoc_options: []
|
152
164
|
require_paths:
|
153
165
|
- lib
|
@@ -158,12 +170,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
158
170
|
version: 2.7.0
|
159
171
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
160
172
|
requirements:
|
161
|
-
- - "
|
173
|
+
- - ">"
|
162
174
|
- !ruby/object:Gem::Version
|
163
|
-
version:
|
175
|
+
version: 1.3.1
|
164
176
|
requirements: []
|
165
|
-
rubygems_version: 3.
|
166
|
-
signing_key:
|
177
|
+
rubygems_version: 3.4.18
|
178
|
+
signing_key:
|
167
179
|
specification_version: 4
|
168
180
|
summary: WebSocket framework for Rails.
|
169
181
|
test_files: []
|
data/lib/action_cable/channel.rb
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module ActionCable
|
4
|
-
module Channel
|
5
|
-
extend ActiveSupport::Autoload
|
6
|
-
|
7
|
-
eager_autoload do
|
8
|
-
autoload :Base
|
9
|
-
autoload :Broadcasting
|
10
|
-
autoload :Callbacks
|
11
|
-
autoload :Naming
|
12
|
-
autoload :PeriodicTimers
|
13
|
-
autoload :Streams
|
14
|
-
autoload :TestCase
|
15
|
-
end
|
16
|
-
end
|
17
|
-
end
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module ActionCable
|
4
|
-
module Connection
|
5
|
-
extend ActiveSupport::Autoload
|
6
|
-
|
7
|
-
eager_autoload do
|
8
|
-
autoload :Authorization
|
9
|
-
autoload :Base
|
10
|
-
autoload :ClientSocket
|
11
|
-
autoload :Identification
|
12
|
-
autoload :InternalChannel
|
13
|
-
autoload :MessageBuffer
|
14
|
-
autoload :Stream
|
15
|
-
autoload :StreamEventLoop
|
16
|
-
autoload :Subscriptions
|
17
|
-
autoload :TaggedLoggerProxy
|
18
|
-
autoload :TestCase
|
19
|
-
autoload :WebSocket
|
20
|
-
end
|
21
|
-
end
|
22
|
-
end
|
data/lib/action_cable/server.rb
DELETED
@@ -1,16 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module ActionCable
|
4
|
-
module Server
|
5
|
-
extend ActiveSupport::Autoload
|
6
|
-
|
7
|
-
eager_autoload do
|
8
|
-
autoload :Base
|
9
|
-
autoload :Broadcasting
|
10
|
-
autoload :Connections
|
11
|
-
autoload :Configuration
|
12
|
-
|
13
|
-
autoload :Worker
|
14
|
-
end
|
15
|
-
end
|
16
|
-
end
|