turbo-rails 0.5.9 → 0.7.14
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +19 -14
- data/Rakefile +4 -0
- data/app/assets/javascripts/turbo.js +1230 -807
- data/app/channels/turbo/streams/broadcasts.rb +43 -21
- data/app/helpers/turbo/frames_helper.rb +4 -0
- data/app/helpers/turbo/streams/action_helper.rb +17 -5
- data/app/helpers/turbo/streams_helper.rb +5 -3
- data/app/javascript/turbo/cable.js +6 -3
- data/app/jobs/turbo/streams/action_broadcast_job.rb +2 -0
- data/app/jobs/turbo/streams/broadcast_job.rb +2 -0
- data/app/models/concerns/turbo/broadcastable.rb +79 -16
- data/app/models/turbo/streams/tag_builder.rb +136 -17
- data/lib/install/turbo_needs_redis.rb +9 -0
- data/lib/install/turbo_with_importmap.rb +5 -0
- data/lib/install/turbo_with_node.rb +9 -0
- data/lib/tasks/turbo_tasks.rake +31 -8
- data/lib/turbo/engine.rb +6 -2
- data/lib/turbo/test_assertions.rb +2 -3
- data/lib/turbo/version.rb +1 -1
- metadata +6 -5
- data/lib/install/turbo_with_asset_pipeline.rb +0 -36
- data/lib/install/turbo_with_webpacker.rb +0 -23
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b6feabeb5b9eef2fcc9032b12f9c067a2ec66408b235a02683540d182276d454
|
|
4
|
+
data.tar.gz: 4f20ead78ccf0a8005213c864a4e3df0d82081fac933c435d367997eaf7c7d27
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '015978592c5ca79dfada00ab3fa9ebceeaeb77b180af317fcf50cf29263571863e753499cab48f4baec165e7a37d438acd93b44720e206a654e8bdb644f4bd63'
|
|
7
|
+
data.tar.gz: 2c7d3f5a342f8fd9343e494b55079628fc4e4f04e4a6728c2ef0a26e366c1c2802549da294b6025dede18827421ab1b2ac1c6f9464c0a260829a8c03c69f75b6
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Turbo
|
|
2
2
|
|
|
3
|
-
[Turbo](https://turbo.
|
|
3
|
+
[Turbo](https://turbo.hotwired.dev) gives you the speed of a single-page web application without having to write any JavaScript. Turbo accelerates links and form submissions without requiring you to change your server-side generated HTML. It lets you carve up a page into independent frames, which can be lazy-loaded and operate as independent components. And finally, helps you make partial page updates using just HTML and a set of CRUD-like container tags. These three techniques reduce the amount of custom JavaScript that many web applications need to write by an order of magnitude. And for the few dynamic bits that are left, you're invited to finish the job with [Stimulus](https://github.com/hotwired/stimulus).
|
|
4
4
|
|
|
5
5
|
On top of accelerating web applications, Turbo was built from the ground-up to form the foundation of hybrid native applications. Write the navigational shell of your Android or iOS app using the standard platform tooling, then seamlessly fill in features from the web, following native navigation patterns. Not every mobile screen needs to be written in Swift or Kotlin to feel native. With Turbo, you spend less time wrangling JSON, waiting on app stores to approve updates, or reimplementing features you've already created in HTML.
|
|
6
6
|
|
|
@@ -15,6 +15,15 @@ During rendering, Turbo replaces the current `<body>` element outright and merge
|
|
|
15
15
|
|
|
16
16
|
Whereas Turbolinks previously just dealt with links, Turbo can now also process form submissions and responses. This means the entire flow in the web application is wrapped into Turbo, making all the parts fast. No more need for `data-remote=true`.
|
|
17
17
|
|
|
18
|
+
Turbo Drive can be disabled on a per-element basis by annotating the element or any of its ancestors with `data-turbo="false"`. If you want Turbo Drive to be disabled by default, then you can adjust your import like this:
|
|
19
|
+
|
|
20
|
+
```js
|
|
21
|
+
import { Turbo } from "@hotwired/turbo-rails"
|
|
22
|
+
Turbo.session.drive = false
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Then you can use `data-turbo="true"` to enable Drive on a per-element basis.
|
|
26
|
+
|
|
18
27
|
|
|
19
28
|
## Turbo Frames
|
|
20
29
|
|
|
@@ -37,36 +46,32 @@ The JavaScript for Turbo can either be run through the asset pipeline, which is
|
|
|
37
46
|
1. Add the `turbo-rails` gem to your Gemfile: `gem 'turbo-rails'`
|
|
38
47
|
2. Run `./bin/bundle install`
|
|
39
48
|
3. Run `./bin/rails turbo:install`
|
|
49
|
+
4. Run `./bin/rails turbo:install:redis` to change the development Action Cable adapter from Async (the default one) to Redis. The Async adapter does not support Turbo Stream broadcasting.
|
|
40
50
|
|
|
41
|
-
Running `turbo:install` will install through NPM if Webpacker is installed in the application. Otherwise the asset pipeline version is used.
|
|
51
|
+
Running `turbo:install` will install through NPM if Webpacker is installed in the application. Otherwise the asset pipeline version is used. To use the asset pipeline version, you must have `importmap-rails` installed first and listed higher in the Gemfile.
|
|
42
52
|
|
|
43
|
-
If you're using
|
|
53
|
+
If you're using node and need to use the cable consumer, you can import [`cable`](https://github.com/hotwired/turbo-rails/blob/main/app/javascript/turbo/cable.js) (`import { cable } from "@hotwired/turbo-rails"`), but ensure that your application actually *uses* the members it `import`s when using this style (see [turbo-rails#48](https://github.com/hotwired/turbo-rails/issues/48)).
|
|
44
54
|
|
|
45
|
-
|
|
55
|
+
The `Turbo` instance is automatically assigned to `window.Turbo` upon import:
|
|
46
56
|
|
|
47
57
|
```js
|
|
48
|
-
import
|
|
49
|
-
window.Turbo = Turbo
|
|
58
|
+
import "@hotwired/turbo-rails"
|
|
50
59
|
```
|
|
51
60
|
|
|
61
|
+
|
|
52
62
|
## Usage
|
|
53
63
|
|
|
54
|
-
You can watch [the video introduction to Hotwire](https://
|
|
64
|
+
You can watch [the video introduction to Hotwire](https://hotwired.dev/#screencast), which focuses extensively on demonstration Turbo in a Rails demo. Then you should familiarize yourself with [Turbo handbook](https://turbo.hotwired.dev/handbook/introduction) to understand Drive, Frames, and Streams in-depth. Finally, dive into the code documentation by starting with [`Turbo::FramesHelper`](https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/frames_helper.rb), [`Turbo::StreamsHelper`](https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/streams_helper.rb), [`Turbo::Streams::TagBuilder`](https://github.com/hotwired/turbo-rails/blob/main/app/models/turbo/streams/tag_builder.rb), and [`Turbo::Broadcastable`](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb).
|
|
55
65
|
|
|
56
66
|
|
|
57
67
|
## Compatibility with Rails UJS
|
|
58
68
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
Note that the helpers that turn `link_to` into remote invocations will _not_ currently work with Turbo. Links that have been made remote will not stick within frames nor will they allow you to respond with turbo stream actions. The recommendation is to replace these links with styled `button_to`, so you'll flow through a regular form, and you'll be better off with a11y compliance.
|
|
62
|
-
|
|
63
|
-
You can still use the `data-confirm` and `data-disable-with`.
|
|
69
|
+
Turbo can coexist with Rails UJS, but you need to take a series of upgrade steps to make it happen. See [the upgrading guide](https://github.com/hotwired/turbo-rails/blob/main/UPGRADING.md).
|
|
64
70
|
|
|
65
71
|
|
|
66
72
|
## Development
|
|
67
73
|
|
|
68
|
-
|
|
69
|
-
* To compile the JavaScript for the asset pipeline: `yarn build`
|
|
74
|
+
Run the tests with `./bin/test`.
|
|
70
75
|
|
|
71
76
|
|
|
72
77
|
## License
|
data/Rakefile
CHANGED
|
@@ -2,6 +2,10 @@ require "bundler/setup"
|
|
|
2
2
|
require "bundler/gem_tasks"
|
|
3
3
|
require "rake/testtask"
|
|
4
4
|
|
|
5
|
+
APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
|
|
6
|
+
load "rails/tasks/engine.rake"
|
|
7
|
+
load "rails/tasks/statistics.rake"
|
|
8
|
+
|
|
5
9
|
Rake::TestTask.new do |test|
|
|
6
10
|
test.libs << "test"
|
|
7
11
|
test.test_files = FileList["test/**/*_test.rb"]
|