Resol
Ruby Gem for creating simple service objects and other any object ruby patterns.
Installation
Add this line to your application's Gemfile:
gem 'resol'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install resol
Usage
Sample usage
class FindUser < Resol::Service
param :id
def call
user = User.find(id)
if user
success!(user)
else
fail!(:not_found)
end
end
end
# when user exists
FindUser.call(1) # => Resol::Success(<user object>)
FindUser.call!(1) # => <user object>
# when user doesn't exist
FindUser.call(100) # => Resol::Failure(:not_found)
FindUser.call!(100) # => raised FindUser::Failure: :not_found
So method .call
always returns the result object
and method .call!
returns a value or throws an error (in case of fail!
has been called).
Params defining
All incoming params and options can be defined using a smart_initializer gem interface.
Return a result
Note – calling success!
/fail!
methods interrupts call
method execution.
success!(value)
– finish with a success valuefail!(code, data = nil)
– fail with any error code and optional data
Define callbacks
You can define callbacks to be executed before calling the #call
method.
class FindUser < Resol::Service
param :id
before_call :set_user
def call
if user
success!(user)
else
fail!(:not_found)
end
end
private
attr_accessor :user
def set_user
self.user = User.find(id)
end
end
Result objects
Methods:
success?
– returnstrue
for success result andfalse
for failure resultfailure?
– returnstrue
for failure result andfalse
for success resultvalue!
– unwraps a result object, returns the value for success result, and throws an error for failure resultvalue_or(other_value, &block)
– returns a value for success result orother_value
for failure result (either callsblock
in case it given)or(&block)
- calls block for failure result, for success result does nothingeither(success_proc, failure_proc)
- for success result calls success_proc with result value in args, for failure result calls failure_proc with error in args.
Configuration
Configuration constant references to SmartCore::Initializer::Configuration
. You can read
about available configuration options here.
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run bin/rspec
to run the tests.
If you want to check coverage, then set env variable COVER
to true
before running bin/rspec
:
COVER=true bin/rspec
.
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 the created tag, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/resol.
License
The gem is available as open source under the terms of the MIT License.
Authors
Created by Aleksei Bespalov.