Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stimulusreflex/futurism
Lazy-load Rails partials via CableReady
https://github.com/stimulusreflex/futurism
Last synced: about 2 months ago
JSON representation
Lazy-load Rails partials via CableReady
- Host: GitHub
- URL: https://github.com/stimulusreflex/futurism
- Owner: stimulusreflex
- License: mit
- Created: 2020-07-09T09:25:49.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T17:59:13.000Z (3 months ago)
- Last Synced: 2024-07-12T06:45:33.864Z (2 months ago)
- Language: Ruby
- Size: 725 KB
- Stars: 408
- Watchers: 7
- Forks: 19
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Futurism
[](https://twitter.com/julian_rubisch)
[](#contributors-)
Lazy-load Rails partials via CableReady
:rotating_light: *BREAKING CHANGE: With v1.0, futurism has been transferred to the [stimulusreflex](https://github.com/stimulusreflex) organization. Please update your npm package to `@stimulus_reflex/futurism` accordingly* :rotating_light:
Photo by Birmingham Museums Trust on Unsplash
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Facts](#facts)
- [Browser Support](#browser-support)
- [Usage](#usage)
- [API](#api)
- [Resource](#resource)
- [Explicit Partial](#explicit-partial)
- [HTML Options](#html-options)
- [Eager Loading](#eager-loading)
- [Bypassing](#bypassing)
- [Broadcast Partials Individually](#broadcast-partials-individually)
- [Contextual Placeholder Arguments](#contextual-placeholder-arguments)
- [Events](#events)
- [Instrumentation](#instrumentation)
- [Installation](#installation)
- [Manual Installation](#manual-installation)
- [Authentication](#authentication)
- [Testing](#testing)
- [Gotchas](#gotchas)
- [Contributing](#contributing)
- [License](#license)
- [Contributors](#contributors)
## Facts
- only one dependency: CableReady
- bundle size (without CableReady) is around [~2.46kB](https://bundlephobia.com/result?p=@stimulus_reflex/[email protected])
### Browser Support
- Chrome v67+ (v54+ via Polyfill)
- Firefox v63+
- Edge v79+
- Safari v10.1+ via Polyfill
- iOS Safari & Chrome v10.3+ via Polyfill
[Caniuse](https://www.caniuse.com/#search=custom%20elements)
## Usage
with a helper in your template
```erb
<%= futurize @posts, extends: :div do %>
<% end %>
```
custom ``s (in the form of a `
` or a `` are rendered. Those custom elements have an `IntersectionObserver` attached that will send a signed global id to an ActionCable channel (`FuturismChannel`) which will then replace the placeholders with the actual resource partial.
With that method, you could lazy load every class that has to_partial_path defined (ActiveModel has by default).
You can pass the placeholder as a block:
```erb
<%= futurize @posts, extends: :tr do %>
<% end %>
```
You can also omit the placeholder, which falls back to [eager loading](#eager-loading).
## API
Currently there are two ways to call `futurize`, designed to wrap `render`'s behavior:
### Resource
You can pass a single `ActiveRecord` or an `ActiveRecord::Relation` to `futurize`, just as you would call `render`:
```erb
<%= futurize @posts, extends: :tr do %>
<% end %>
```
#### Partial Path
Remember that you can override the partial path in you models, like so:
```rb
class Post < ApplicationRecord
def to_partial_path
"home/post"
end
end
```
That way you get maximal flexibility when just specifying a single resource.
### Explicit Partial
Call `futurize` with a `partial` keyword:
```erb
<%= futurize partial: "items/card", locals: {card: @card}, extends: :div do %>
<% end %>
```
You can also use the shorthand syntax:
```erb
<%= futurize "items/card", card: @card, extends: :div do %>
<% end %>
```
#### Collections
Collection rendering is also possible:
```erb
<%= futurize partial: "items/card", collection: @cards, extends: :div do %>
<% end %>
```
#### Specifying Controller to Render
You can also pass in the controller that will be used to render the partial.
```erb
<%= futurize partial: "items/card", collection: @cards, controller: MyController, extends: :div do %>
<% end %>
```
By default (i.e. not passing in a value), futurize will use `ApplicationController`, but you may override by setting the Futurism default controller in an initializer, for example `config/initializers/futurism.rb`.
```ruby
Futurism.default_controller = "MyController" # to avoid the controller from trying to autoload at boot, provide as a string
```
### HTML Options
You can pass a hash of attribute/value pairs which will be mixed into the HTML markup for the placeholder element. This is important for layouts that require elements to have dimensionality. For example, many scripts calculate size based on element height and width. This option ensures that your elements have integrity, even if they are gone before you see them.
```erb
<%= futurize @posts, extends: :tr, html_options: {style: "width: 50px; height: 50px;"} do %>
<% end %>
```
This will output the following:
```html
```
### Eager Loading
It may sound surprising to support eager loading in a lazy loading library :joy:, but there's a quite simple use case:
Suppose you have some hidden interactive portion of your page, like a tab or dropdown. You don't want its content to block the initial page load, but once that is done, you occasionally don't want to wait for the element to become visible and trigger the `IntersectionObserver`, you want to lazy load its contents right after it's added to the DOM.
Futurism makes that dead simple:
```erb
<%= futurize 'some_tab', eager: true, extends: :tr do %>
<% end %>
```
### Bypassing
In some rare cases, e.g. when combined with CableReady's async `updates_for` mechanism, you'll want to bypass futurism entirely and fall back to native `rendering`. You can do this by passing an `unless` option:
```erb
<%= futurize 'some_tab', unless: bypass_futurism?, extends: :tr do %>
<% end %>
```
Internally, this works the same as [bypassing futurism in tests](#testing)
### Broadcast Partials Individually
Futurism's default behavior is to `broadcast` partials as they are generated in batches:
On the client side, `IntersectionObserver` events are triggered in a debounced fashion, so several `render`s are performed on the server for each of those events. By default, futurism will group those to a single `broadcast` call (to save server CPU time).
For collections, however, you can opt into individual broadcasts by specifying `broadcast_each: true` in your helper usage:
```erb
<%= futurize @posts, broadcast_each: true, extends: :tr do %>
<% end %>
```
### Contextual Placeholder Arguments
For individual models or arbitrary collections, you can pass `record` and `index` to the placeholder block as arguments:
```erb
<%= futurize @post, extends: :div do |post| %>
<%= post.title %>
<% end %>
```
```erb
<%= futurize @posts, extends: :tr do |post, index| %>
<%= index + 1 %><%= post.title %>
<% end %>
```
```erb
<%= futurize partial: "users/user", collection: users, extends: "tr" do |user, index| %>
<%= index + 1 %><%= user.name %>
<% end >
```
## Events
Once your futurize element has been rendered, the `futurism:appeared` custom event will be called.
## Instrumentation
Futurism includes support for instrumenting rendering events.
To enable ActiveSupport notifications, use the `instrumentation` option:
```ruby
Futurism.instrumentation = true
```
Then subscribe to the `render.futurism` event:
```ruby
ActiveSupport::Notifications.subscribe("render.futurism") do |*args|
event = ActiveSupport::Notifications::Event.new(*args)
event.name # => "render.futurism"
event.payload[:channel] # => "Futurism::Channel" # ActionCable channel to broadcast
event.payload[:controller] # => "posts" # The controller that invokes `futurize` call
event.payload[:action] # => "show" # The action that invokes `futurize` call
event.payload[:partial] # => "posts/card" # The partial that was rendered
end
```
This is useful for performance monitoring, specifically for tracking the source of `futurize` calls.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'futurism'
```
And then execute:
```bash
$ bundle
```
To copy over the javascript files to your application, run
```bash
$ bin/rails futurism:install
```
**! Note that the installer will run `yarn add @stimulus_reflex/futurism` for you !**
### Manual Installation
After `bundle`, install the Javascript library:
There are a few ways to install the Futurism JavaScript client, depending on your application setup.
#### ESBuild / Webpacker
```sh
yarn add @stimulus_reflex/futurism
```
#### Import maps:
```ruby
# config/importmap.rb
# ...
pin '@stimulus_reflex/futurism', to: 'futurism.min.js', preload: true
```
#### Rails Asset pipeline (Sprockets):
```html+erb
<%= javascript_include_tag "futurism.umd.min.js", "data-turbo-track": "reload" %>
```
In your `app/javascript/channels/index.js`, add the following
```js
import * as Futurism from '@stimulus_reflex/futurism'
import consumer from './consumer'
Futurism.initializeElements()
Futurism.createSubscription(consumer)
```
## Authentication
For authentication, you can rely on ActionCable identifiers, for example, if you use Devise:
```ruby
module ApplicationCable
class Connection < ActionCable::Connection::Base
identified_by :current_user
def connect
self.current_user = env["warden"].user || reject_unauthorized_connection
end
end
end
```
The [Stimulus Reflex Docs](https://docs.stimulusreflex.com/authentication) have an excellent section about all sorts of authentication.
## Testing
In Rails system tests there is a chance that flaky errors will occur due to Capybara not waiting for the placeholder elements to be replaced. To overcome this, add the flag
```ruby
Futurism.skip_in_test = true
```
to an initializer, for example `config/initializers/futurism.rb`.
## Gotchas
### ActiveStorage URLs aren't correct in development
Out of the box, Rails will prefix generated urls with `http://example.org` rather than `http://localhost`, much like ActionMailer. To amend this, add
```ruby
# config/environments/development.rb
config.action_controller.default_url_options = {host: "localhost", port: 3000}
# config/environments/production.rb
config.action_controller.default_url_options = {host: "mysite.com"}
```
to your environments.
### Choosing the parent for Futurism::Channel
By default Futurism::CHannel will inherit from ApplicationCable::Channel, you can change this by setting
```ruby
Futurism.configure do |config|
config.parent_channel = "CustomFuturismChannel"
end
```
in config/initializers.
## Contributing
### Get local environment setup
Below are a set of instructions that may help you get a local development environment working
```shell
# Get the gem/npm package source locally
git clone futurism
cd futurism/javascript
yarn install # install all of the npm package's dependencies
yarn link # set the local machine's futurism npm package's lookup to this local path
# Setup a sample project, use the information below directly or use your own project
git clone https://github.com/leastbad/stimulus_reflex_harness.git
cd stimulus_reflex_harness
git checkout futurism
# Edit Gemfile to point point to local gem (e.g. `gem "futurism", path: "../futurism"`)
# yarn link @stimulus_reflex/futurism
# Do your work, Submit PR, Profit!
# To stop using your local version of futurism
# change your Gemfile back to the published (e.g. `gem "futurism"`)
cd path/to/futurism/javascript
# Stop using the local npm package
yarn unlink
# Instruct your project to reinstall the published version of the npm package
cd path/to/project
yarn install --force
```
### 📦 Releasing
1. Make sure that you run `yarn` and `bundle` to pick up the latest.
2. Bump version number at `lib/futurism/version.rb`. Pre-release versions use `.preN`
3. Run `rake build` and `yarn build`
4. Commit and push changes to github `git commit -m "Bump version to x.x.x"`
5. Run `rake release`
6. Run `yarn publish --no-git-tag-version`
7. Yarn will prompt you for the new version. Pre-release versions use `-preN`
8. Commit and push changes to GitHub
9. Create a new release on GitHub ([here](https://github.com/stimulusreflex/futurism/releases)) and generate the changelog for the stable release for it
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Julian Rubisch
💻
darkrubyist
💻 📖
Konnor Rogers
💻
Andrew Mason
🚧
Chris Oliver
💻 👀
leastbad
💻 👀
M. E. Patterson
🐛
Stephen Margheim
💻
Hassanin Ahmed
💻
Marco Roth
💻
Viedit com
📖
Scott Barrow
💻
Dom Christie
👀
Ricky Chilcott
👀
mansakondo
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!