Nurse
Note: If Nurse
constant is used in your project you can use Koine::Di instead.
Nurse, for your dependency injection
Code quality
Package information
Installation
Add this line to your application's Gemfile:
gem 'nurse-rb'
And then execute:
$ bundle
Or install it yourself as:
$ gem install nurse-rb
Usage
Defining dependencies
dependency_manager = Nurse::DependencyContainer.new
dependency_manager.share(:connection) do |dependency_manager|
MyConnection.new("mysql://root@localhost/my_db")
end
dependency_manager.share(:user_repository) do |dependency_manager|
connection = dependency_manager.get(:connection)
UserRepository.new(connection)
end
Also, you can use the singleton instance. Use singleton if you do not have control over how classes, such as controllers, are created.
dependency_manager = Nurse.instance
Fetching dependencies
class UsersController < SomeBaseController
def index
@users = repository.find_all
end
private
def repository
dependency_manager.get(:user_repository)
end
end
Using factories
class DatabaseConnectionFactory < Nurse::ServiceFactory
share true
key :db_connection
def create_service(dependencies)
DatabaseConnection.new(dependencies.get(:db_config))
end
end
class UserRepositoryFactory < Nurse::ServiceFactory
key :user_repository
def create_service(dependencies)
UserRepository.new(dependencies.get(:db_connection))
end
end
dependency_manager.add_factory(DatabaseConnectionFactory.new)
dependency_manager.add_factory(UserRepositoryFactory.new)
Development
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mjacobus/nurse-rb. 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.
License
The gem is available as open source under the terms of the MIT License.