readymade

Set of base classes for ABDI architecture


License
MIT
Install
gem install readymade -v 0.1.6

Documentation

Readymade

This gems contains basic components to follow ABDI architecture

Installation

Add this line to your application's Gemfile:

gem 'readymade'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install readymade

Usage

Inherit your components from:

  • Readymade::Response
  • Readymade::Form
  • Readymade::InstantForm
  • Readymade::Action
  • Readymade::Operation

Readymade::Response

TODO: add

Readymade::Form

TODO: add

Readymade::InstantForm

Permit params and validates presence inline

Readymade::InstantForm.new(my_params, permitted: %i[name phone], required: %i[email]) # permits: name, phone, email; validates on presence: email

Readymade::Action

TODO: add

Readymade::Operation

TODO: add

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/[USERNAME]/readymade. 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 Lead project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.