https://github.com/marcoroth/cable_ready-dsl
[PoC] An opinionated DSL for CableReady.
https://github.com/marcoroth/cable_ready-dsl
cableready rails ruby stimulusreflex
Last synced: 2 months ago
JSON representation
[PoC] An opinionated DSL for CableReady.
- Host: GitHub
- URL: https://github.com/marcoroth/cable_ready-dsl
- Owner: marcoroth
- License: mit
- Created: 2021-03-27T14:49:14.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-24T21:16:46.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T16:16:44.254Z (3 months ago)
- Topics: cableready, rails, ruby, stimulusreflex
- Language: Ruby
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CableReady::Dsl
An opinionated DSL for CableReady.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cable_ready-dsl'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install cable_ready-dsl
## Usage
### Setup
```ruby
require "cable_ready/dsl"
```
### String DSL
```ruby
class YourReflex < ApplicationReflex
using CableReady::Dsl::StringDsl
def increment
'#posts'.morph('
Your HTML
')
dom_id(Post.last).morph('
Your HTML
', children_only: true)
end
end
```
### DOM DSL
```ruby
class YourReflex < ApplicationReflex
using CableReady::Dsl::DomDsl
def increment
'#posts'.dom.morph('
Your HTML
')
dom_id(Post).dom.morph('
Your HTML
', children_only: true, channel: 'users')
end
end
```
### DOM-Method DSL
```ruby
class YourReflex < ApplicationReflex
include CableReady::Dsl::MethodDsl
def increment
dom('#posts').morph('
Your HTML
')
selector('#posts').morph('
Your HTML
')
id('posts').morph('
Your HTML
')
css_class('card').morph('
Your HTML
', 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](https://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](https://github.com/marcoroth/cable_ready-dsl/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/marcoroth/cable_ready-dsl/blob/master/CODE_OF_CONDUCT.md).