This gem provides a simple framework for creating Operations that encapsulate business logic generally found in Models (or hooks).
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install functional_operations
Here is a simple RegisterUser operation that demonstrates most of the functionality of this gem:
class RegisterUser < FunctionalOperations::Operation def arguments required :name, String optional :email, String end def perform user = User.create!(name: @name, email: @email) user.save! # send e-mail to user or other logic that usually goes into after hooks user end end
Then call the operation:
user = RegisterUser.perform(name: "John")
FunctionalOperations::DSL and use:
run RegisterUser, name: "John"
To integrate with RSpec, add the following to the
You can create tests with the
:operation type and test with the DSL included:
require "spec_helper" RSpec.describe RegisterUser, type: :operation do context "with valid params" do it "creates an user" do run RegisterUser, name: "John" # expect(...).to eq(...) end end end
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
Bug reports and pull requests are welcome on GitHub at https://github.com/juanibiapina/functional_operations. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.