Creed - Stupid Simple Commands for Rails

Creed provides a stupid simple way to introduce the Command Pattern to your Rails app.

Add this line to your application's Gemfile:

gem 'creed'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install creed

Create your Command classes in app/commands, extending Creed::Command, and implementing a perform method. Optionally defining params and/or options that can be passed when performing the command. Unknown arguments will raise an exception.

class CreateUser < Creed::Command
  # Define types and/or validations. See https://github.com/dry-rb/dry-initializer.
  param :user_params, Creed::Types.Instance(ActionController::Parameters)
  option :validate, default: true

  # #perform has access to all options and params and named attributes. You can also pass it a
  # block.
  def perform(&block)
    # Do something here...
  end
end

Then in your controller (or anywhere):

class UserController < ApplicationController
  def create
    CreateUser.perform(user_params, validate: false)
  end
end

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.

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

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

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