Skip to content

Latest commit

 

History

History
104 lines (67 loc) · 7.52 KB

README.md

File metadata and controls

104 lines (67 loc) · 7.52 KB
Raw
description
A Redis ORM for reactive applications. Quacks just like Active Record. 🦆

All Futures

Rails developers can use the all_futures gem to persist data across multiple requests. It leverages Redis to provide an ephemeral model that you can use just like an Active Record model.

It's perfect for building faceted search interfaces, multi-step forms, real-time input validation and persisting the display state of UI elements.

Try a demo, here: 👉 Beast Mode StimulusReflex 👈

GitHub stars GitHub forks Twitter follow Discord

Is All Futures for you?

Do you ever find yourself:

  • building complex search interfaces
  • creating multi-stage data entry processes
  • frustrated by the limitations of classic form submission
  • wanting to save data even if the model is currently invalid
  • reinventing the wheel every time you need field validation
  • needing granular dirty checking and state management for every attribute

If you answered yes to any of the above... you are every Rails developer, and you're not crazy. This functionality has been a blind-spot in the framework for a long time.

Yes, All Futures is for you.

Why use All Futures?

Many reactive UI concepts are a pain in the ass to implement using the classic Rails request/response pattern, which was created at a time before developers started using Ajax to update portions of a page. ActionController is amazing, but if a user interaction doesn't fit cleanly into a single form submission, the developer now has to maintain UI state across multiple atomic requests. Naturally, this leads to abuse of the session object and awkward hacks to validate and persist models.

{% hint style="danger" %} In vanilla Rails, it's very difficult to incrementally save models that require the presence of multiple attributes to be valid. {% endhint %}

The combination of ActionCable and Turbo Drive creates a persistent Connection that blurs the line between session and request, forcing a new mental model that is poorly served by ActionDispatch and the conventions which drove Rails to success... in 2005.

Moving forward, new tooling is required to take full advantage of reactive possibilities.

All Futures presents a flexible and lightweight mechanism to refine a model that persists its attributes across multiple updates, and even multiple servers.

Key features and advantages

  • A natural fit with StimulusReflex, Stimulus, Turbo Drive and mrujs
  • No reliance on sessions, so it works across servers
  • Easy to learn, quick to implement
  • Supports model attributes with defaults, arrays and associations
  • Per-attribute dirty checking and state management with rollbacks
  • Remembers previous model state across multiple requests
  • Automatic versioning allows time travel views
  • Model validations, errors and associations
  • Can be added as attributes in your Active Record model classes
  • No more temporary database tables that need to be purged later

How does All Futures work?

All Futures is the fusion of Active Entity and Kredis. It is similar to using a properly juiced ActiveModel::Model, except that it has full support for Attributes, including arrays and nested attributes. All Futures classes behave like Active Record model instances as much as possible.

class Example < AllFutures::Base
  attribute :name, :string
  validates :name, presence: true
end

example = Example.create
example.valid? # false
example.errors # @errors=[#<ActiveModel::Error attribute=name, type=blank, options={}>]

Unlike an Active Record model, All Futures instances can persist their attributes even if the attributes are currently invalid. This design allows you to resolve any errors present, even if it takes several distinct operations to do so.

Once the state of your attributes is valid, you can pass the attributes from your All Futures model right into the constructor of a real Active Record model.

{% hint style="danger" %} All Futures v1 persisted the attributes every time you set the value of an attribute using bracket notation. This behavior has been removed. An explicit save operation is now required to persist changes. {% endhint %}

Who makes this?

First, All Futures wouldn't exist without Active Entity and Kredis. Thank you, Jun Jiang and Kasper Timm Hansen.

All Futures was originally created by leastbad, who continues to serve as the primary developer and writer of words. 👋

v2 welcomes pivotal contributions from key members of the StimulusReflex core and moderation teams. Stephen Margheim heroically made sure that callbacks work as expected, twice. Julian Rubisch is the reason All Futures models are usually interchangeable with Active Record models. Nate Hopkins, Marco Roth and Konnor Rogers have been generous with their feedback and suggestions.

We realized that this library needed to exist and had a deep understanding of how it should work only because we have spent years helping thousands of Rails developers figure out the right way to develop reactive UIs.

All Futures truly was born in fire. 🔥🔨

Try it now

You can experiment with Beast Mode StimulusReflex, a live demonstration of using All Futures to drill down into a tabular dataset, right now. 👈

The Beast Mode codebase GitHub stars GitHub forks is set up as a template repo which I recommend that you clone and experiment with.

The three key files are the CustomerFilter, the Reflex and the Model. You can read the tutorial post behind this example on my blog here.

Assuming you're running at least Ruby 2.7.3, Postgres and have Redis running on your system, you can just run bin/setup to install it, including migrations and the DB seed file.

{% embed url="https://www.youtube.com/watch?v=Fbo21aWFbhQ" %} REFRACT {% endembed %}