Hypo

Hypo is sinless general purpose IoC container for Ruby applications.

Installation

Add this line to your application's Gemfile:

gem 'hypo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hypo

Getting Started

First of all you need to create an instance of Hypo::Container.

container = Hypo::Container.new

Then you can register your types (classes) there:

container.register(User)

..and resolve them:

container.resolve(:user)

Optionally you can specify custom name for your component:

container.register(User, :my_dear_user)

and then you can resolve the component as :my_dear_user:

container.resolve(:my_dear_user)

Registered types can have some dependencies that will be resolved automatically if they're registered in the container. For example, you have classes:

class User
  attr_reader :company
  def initialize(company)
    @company = company
  end
end

class Company
end

and if you registered both of them, you can do:

  user = container.resolve(:user)

  # user.company is resolved as well

Sometimes you're not able to manage a type lifecycle, i.e. when you use 3rd-party static stuff, like:

class DB
  def self.connect
    # ...
  end
end

In that case you can register an instance instead of a type:

connection = DB.connect
container.register(connection, :connection)    

You must specify component name as it's done in example above.

Component Life Cycle

By default all registered components have life cycle Hypo::Transient (:transient). It means, every time when you resolve a component Hypo returns new instance of its type. If you wanna change this behavior then you can replace lifetime strategy. Out of the box Hypo provides Hypo::Singleton (:singleton) strategy, you can use it when register a component:

container.register(User).using_life_cycle(:singleton)

Actually you can implement your own life cycle, i.e. makes sense to think about HttpRequest strategy for your web applications.

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hypo.

License

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