motion.cr

Motion is a framework for building reactive, real-time frontend UI components in your Amber application using pure Crystal that are reusable, testable & encapsulated.

Programming language: Crystal

License: MIT License

Tags: Framework Components    

README

Reactive, Real-time Frontend Components Try the Motion Demo

Motion is a framework for building reactive, real-time frontend UI components in your Amber application using pure Crystal that are reusable, testable & encapsulated. For brevity, we will call them MotionComponents.

• Motion is an Object-Oriented View Layer
• Peacefully coexists with your existing frontend
• Real-time frontend UI updates from frontend user interaction AND server-side updates
• No more frontend models, stores, or syncing; your source of truth is the database you already have
• Write Less Javascript

Table of Contents

• Table of Contents
• Installation
• Documentation
• Component Guide
  • Why should I use components?
  • Testing
  • Data Flow
  • Standards
  • Building components
  • Conventions
  • Quick start
  • DSL HTML Generation
  • ECR & Slang
  • Properties, Props & Type Safety
  • Blocks & Procs
• Motions Guide
  • Installation
  • Building Motions
  • Frontend interactions
  • Periodic Timers
  • Backend Interactions
  • Motion::Event and Motion::Element
• Configuration
  • Redis
• Limitations
• Roadmap
• Contributing
• License

Installation

Add the shard to your dependencies:

dependencies:
  motion:
    github: andrewc910/motion.cr
    version: 0.2.0

Create a file motion.cr in config/initializers and add:

require "motion"
# Adds a few helper methods
require "motion/monkey_patch/amber"

Create a socket:

amber g socket Motion

Add the route:

websocket "/cable", MotionSocket

Documentation

• API Documentation

Component Guide

MotionComponents are Crystal objects that output HTML. MotionComponents are most effective in cases where view code is reused or benefits from being tested directly. The code itself was pulled & altered from Lucky Framework.

Why should I use components?

Testing

Unlike traditional views, Motion Components can be unit-tested.

Views are typically tested with slow integration tests that also exercise the routing and controller layers in addition to the view. This cost often discourages thorough test coverage.

With MotionComponents, integration tests can be reserved for end-to-end assertions, with permutations and corner cases covered at the unit level.

Data Flow

Traditional views have an implicit interface, making it hard to reason about what information is needed to render, leading to subtle bugs when rendering the same view in different contexts.

MotionComponents use defined props that clearly defines what is needed to render, making them easier (and safer) to reuse than partials.

Standards

Views often fail basic code quality standards: long methods, deep conditional nesting, and mystery guests abound.

MotionComponents are Crystal objects, making it easy to follow (and enforce) code quality standards.

Building components

Conventions

Components are subclasses of Motion::Base and live in views/components. It's common practice to create and inherit from an ApplicationComponent that is a subclass of Motion::Base. By doing so, not only can you share logic, you can share view templates.

Component names end in Component.

Component module names are plural, as for controllers and jobs: Users::AvatarComponent

Quick start

If you followed the installation guide above, you can start with you first component.

1. Create a components folder in views
2. Create your first component:

class MyFirstComponent < Motion::Base
  def render
    html_doctype
    head do
      css_link "/css/main.css"
      utf8_charset
      meta content: "text/html;charset=utf-8", http_equiv: "Content-Type"
      title "My First Component"
    end

    body do
      h1 { "My First Component!" }
    end
  end
end

1. Render it in your controller:

render MyFirstComponent

DSL HTML Generation

For static html rendering, please review the lucky framework documentation

Note: Lucky uses the macro keyword needs, motion uses props

ECR & Slang

You can render html templates if you prefer. You have to mix in the amber module in to the components you would like to render from.

class MyFirstComponent < Motion::Base
  include Amber::Controller::Helpers::Render

  def render
    render("users/new.ecr", layout: false)
  end
end

In your controller:

render(MyFirstComponent)

Properties, Props & Type Safety

Props allow you to pass arguements to child components that are type safe. One of the problems with ecr views & partials is, it's hard to reason what variables & data the page requires to render because everything is within scope. Props explicity display what is required for a particular component.

class MyFirstComponent < Motion::Base
  getter title : String

  def initialize(@title); end

  def render
    html_doctype
    head do
      css_link "/css/main.css"
      utf8_charset
      meta content: "text/html;charset=utf-8", http_equiv: "Content-Type"
      title "My First Component"
    end

    body do
      h1 { @title }
    end
  end
end

Or you can use the props keyword:

class MyFirstComponent < Motion::Base
  props title : String

  def render
    html_doctype
    head do
      css_link "/css/main.css"
      utf8_charset
      meta content: "text/html;charset=utf-8", http_equiv: "Content-Type"
      title "My First Component"
    end

    body do
      h1 { @title }
    end
  end
end

In your controller:

render(MyFirstComponent, title: "Hello World")

or rendering from a component:

m(MyFirstComponent, title: "Hello World") # m is shorthand for mount. mount is also acceptable

The if you use the props keyword, do not define an initialize method as it will do it for you. I recommend using the props macro when starting off and switching over to a custom initialization method when you need custom logic.

Blocks & Procs

Blocks & Procs can be passed to child components. This will allow you to create more generic & reusable components.

class MyFirstComponent < Motion::Base
  props title : Proc(void)

  def render
    html_doctype
    head do
      css_link "/css/main.css"
      utf8_charset
      meta content: "text/html;charset=utf-8", http_equiv: "Content-Type"
      title "My First Component"
    end

    body do
      title.call
    end
  end
end

In your parent component:

title = Proc(void).new { h1 "Hello World!" }
m(MyFirstComponent, title: title)

Motions Guide

Motion.cr allows you to mount special DOM elements that can be updated real-time from frontend interactions, backend state changes, or a combination of both. Some features include:

• Websockets Communication - Communication with your Amber backend is performed via websockets
• No Full Page Reload - The current page for a user is updated in place.
• Fast DOM Diffing - DOM diffing is performed when replacing existing content with new content.
• Server Triggered Events - Server-side events can trigger updates to arbitrarily many components via WebSocket channels.

Motion.cr is similar to Phoenix LiveView (and even React!) in some key ways:

• Partial Page Replacement - Motion.cr does not use full page replacement, but rather replaces only the component on the page with new HTML, DOM diffed for performance.
• Encapsulated, consistent stateful components - Components have continuous internal state that persists and updates. This means each time a component changes, new rendered HTML is generated and can replace what was there before.
• Blazing Fast - Communication does not have to go through the full Amber router and controller stack. No changes to your routing or controller are required to get the full functionality of Motion.cr.

Installation

npm i @awcrotwell/motion

In main.js add:

import { createClient } from '@awcrotwell/motion';

const client = createClient();

Building Motions

Frontend interactions

Frontend interactions can update your MotionComponents using standard JavaScript events that you're already familiar with: change, blur, form submission, and more. Motions default to click events however you can override this to make it any event you would like. You can invoke motions manually using JavaScript if you need to.

The primary way to handle user interactions on the frontend is by setting motion_component to true annotating @[Motion::MapMethod] any motion methods:

# Whenever a user click with the portion of the
# page that contains this component,
# `add` will be invoked, the component will be rerendered
# and the dom will be updated with the new html
class MyMotionComponent < Motion::Base
  # Let motion know this is a motion component
  props motion_component = true
  # Add your props that you plan to pass in or default
  props total : Int32 = 0

  # Annotate any motion methods
  @[Motion::MapMethod]
  def add
    @total += 1
  end

  # render is what motion will invoke
  # to generate your components html
  def render
    # data_motion: add tells the motion JS library what method
    # to invoke when a user interacts with this component
    div do
      span do
        @total
        button data_motion: "add" do # data_motion: "add" defaults to a click event
                                     # data_motion: "mouseover->add" to make it a mouseover event
                                     # data_motion: "mouseover->add mouseout->add" to map multiple events to a single element
          "Increment" # button text
        end
      end
    end
  end
end

class MyFirstComponent < Motion::Base
  def render
    html_doctype
    head do
      css_link "/css/main.css"
      utf8_charset
      meta content: "text/html;charset=utf-8", http_equiv: "Content-Type"
      title "My First Component"
    end

    body do
      m(MyFirstMotionComponent)
    end
  end
end

This component can be rendered from your controller:

render MyFirstComponent

Every time the "Increment" button is clicked, MyComponent will call the add method, re-render your component and send it back to the frontend to replace the existing DOM. All invocations of mapped motions will cause the component to re-render, and unchanged rendered HTML will not perform any changes.

Periodic Timers

Motion can automatically invoke a method on your component at regular intervals:

class TickerComponent < Motion::Base
  props ticker : Int32 = 0
  props motion_component : Bool = true

  @[Motion::PeriodicTimer(interval: 1.second)]
  def tick
    @ticker += 1
  end

  def render
    div do
      span @ticker.to_s
    end
  end
end

In this example, after the component has mounted to a websockets channel, tick will be invoked every second and the component will be rerendered on the frontend.

Backend Interactions

Backend changes can be streamed to your Motion components in 2 steps.

1. Broadcast changes after an event you care about:

# Examples are with Granite ORM but Jennifer ORM works as well
class Todo < Granite::Base
  after_create :broadcast_created

  def broadcast_created
    # Invoke `stream` on the socket motion connects through
    MotionSocket.stream("todos:created")
  end
end

1. Configure your Motion component to listen to a channel:

class TodosComponent < Motion::Base
  props todos : Array(Todo) = Todo.order(created_at: :desc).limit(10)
  # `stream_from` takes 2 arguements
  # the first is the channel we want to listen for
  # the second is a callback method
  stream_from "todos:created", "handle_created"

  # Callback which will be invoked before rendering
  def handle_created(name)
    Log.info { "I am a callback" }
  end
end

This will cause any user that has a page open with TodosComponent mounted on it to re-render that component's portion of the page when a new Todo is created.

Motion::Event and Motion::Element

Methods that are mapped using @[Motion::MapMethod] can choose to accept an event parameter which is a Motion::Event. This object has a target attribute which is a Motion::Element, the element in the DOM that triggered the motion. Useful state and attributes can be extracted from these objects, including value, selected, checked, form state, data attributes, and more.

  @[Motion::MapMethod]
  def example(event)
    event.type # => "change"
    event.name # alias for type

    # Motion::Element instance, the element that received the event.
    event.target

    # Motion::Element instance, the element with the event handler and the `data-motion` attribute
    element = event.current_target
    # Alias for #current_target
    event.element


    # Element API examples
    element.tag_name # => "input"
    element.value # => "5"
    element.attributes # { class: "col-xs-12", ... }

    # DOM element with aria-label="..."
    element[:aria_label]

    # DOM element with data-extra-info="..."
    element.data[:extra_info]

    # ActionController::Parameters instance with all form params. Also
    # available on Motion::Event objects for convenience.
    element.form_data
  end

See the code for full API for Event and Element.

Configuration

In your motion.cr initializer, you can configure motion.

require "motion"
require "motion/monkey_patch/amber"

Motion.configure do |config|
  # If true, 2 comments will be added at rendering signifying
  # the start & end of a component. Really helpful for debugging.
  #
  # Defaults to true
  config.render_component_comments = true
end

Redis Backend for Distributed Systems

By default, MotionComponents are serialized and stored on the server in a json format after a websockets channel has been instaniated. This would break on distributed systems as one server may process a motion but isn't storing the serialized object. Motion.cr supports storing serialized components in redis.

require "motion"
require "motion/monkey_patch/amber"

Motion.configure do |config|
  # Set the adapter for where deserialized components are stored.
    # Accepts either `:server` or `:redis`. If set to `:server`
    # component connections will be stored in memory on the server.
    # `:redis` requires you to set the `redis_url`.
    config.adapter = :redis

    # Set the redis url if you are using the redis adapter
    #
    # Defaults to `"redis://localhost:6379/0"`
    config.redis_url = "redis://localhost:6379/0"

    # Set the TTL property for components in minutes.
    #
    # Motion removes components after a page offloads, however
    # it is best to set a ttl in case any components do not get
    # offloaded.
    config.redis_ttl = 30
end

Limitations

• Due to the way that your components are replaced on the page, Components that set motion_component to true are limited to a single top-level DOM element. If you have multiple DOM elements in your template at the top level, you must wrap them in a single element. This is a similar limitation that React enforced until React.Fragment appeared and is for a very similar reason. Because of this, your upper most component (the component you call from the controller) cannot be a set motion_component. The top most component will return the entire html document to the controller and there is no way to wrap an entire document in a single tag.

• Components that enable motions (motion_component = true) cannot accept Proc's as they cannot be serialized to JSON. I am actively looking for workarounds however I have no idea if a solution will be found.

Roadmap

• Distributed system support
• Sending only the new html down the wire opposed the entire component
• Global key/value store
• Routing for a full SPA experience? (TBD)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/andrewc910/motion.cr/issues.

License

The shard is available as open source under the terms of the MIT License.