Manioc exposes two main utility classes: Struct
and Container
.
A struct is a simple stateless object with transparently inverted dependencies:
class Service < Manioc[:http, :logger]
def call url
response = http.get url
logger.info "#{url}: #{response}"
end
end
real = Service.new(http: HTTP::Client.new, logger: Logger.new)
fake = Service.new(http: double('http'), logger: double('logger'))
[real, fake].sample.call('http://google.com')
A container makes it easy to declare and customize the interdependencies between various structs:
dev = Manioc::Container.new do
http { HTTP::Client.new }
logger { Logger.new STDOUT }
error_handler { ->(e) { logger.error e } }
end
test = dev.with do
http { instance_double HTTP::Client }
end
prod = dev.with do
error_handler { ->(e) { Rollbar.error e } }
end
Manioc includes a few convenience methods for the conventional use case of a Rails application with one container, customized per-environment:
# config/application.rb
module MyApp
class Applicaton
container do
foo { 0 }
bar { foo + 1 }
end
end
end
# config/environments/test.rb
Rails.application.configure do
container do
foo { 1000 }
end
end
# in e.g. a spec file
Rails.configuration.container.bar # => 1001
Add this line to your application's Gemfile:
gem 'manioc'
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/manioc. 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.