CableReady::Dsl

An opinionated DSL for CableReady.

Installation

Add this line to your application's Gemfile:

gem 'cable_ready-dsl'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install cable_ready-dsl

Usage

Setup

require "cable_ready/dsl"

String DSL

class YourReflex < ApplicationReflex
  using CableReady::Dsl::StringDsl

  def increment
    '#posts'.morph('<p>Your HTML</p>')

    dom_id(Post.last).morph('<p>Your HTML</p>', children_only: true)
  end
end

DOM DSL

class YourReflex < ApplicationReflex
  using CableReady::Dsl::DomDsl

  def increment
    '#posts'.dom.morph('<p>Your HTML</p>')

    dom_id(Post).dom.morph('<p>Your HTML</p>', children_only: true, channel: 'users')
  end
end

DOM-Method DSL

class YourReflex < ApplicationReflex
  include CableReady::Dsl::MethodDsl

  def increment
    dom('#posts').morph('<p>Your HTML</p>')

    selector('#posts').morph('<p>Your HTML</p>')

    id('posts').morph('<p>Your HTML</p>')

    css_class('card').morph('<p>Your HTML</p>', children_only: true, channel: 'users')
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/cable_ready-dsl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the CableReady::Dsl project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.