Gate

Gem Version Circle CI Dependency Status Code Climate Test Coverage

Gate is a small wrapper on dry-validation that might be used as Command in CQRS pattern. It will raise InvalidCommand error for invalid input and provide simple struct with access to coerced input.

Installation

Add this line to your application's Gemfile:

gem 'gate'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gate

Usage

Define structure

class DoSomethingCommand
  include Gate::Command

  schema do
    required(:id).filled
    required(:message).schema do
      required(:title).filled
      optional(:value).maybe(:decimal?)
    end
  end
end

Use it

begin
  cmd = DoSomethingCommand.with(params)
  cmd.id
  cmd.message
rescue DoSomethingCommand::InvalidCommand => e
  e.errors # => hash { key => [errors] }
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/gate/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request