Bandoleer

Bandoleer is an IoC container focusing on the automatic extraction of constants from ruby files. Essentially it's a rather simple wrapper for the canister gem, adding helper methods to abstract boilerplate for a particular pattern of containering. It also uses medieval style rpg equip lingo, which helps you feel cool when writing basic code, if that's something you're into.

Install the gem and add to the application's Gemfile by executing:

$ bundle add bandoleer

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install bandoleer

Bandoleer has two expectations for the structure of a ruby project:

• that ruby files will contain a constant with the same name as the file.
• that directories and files will be in snake_case, and constants will be in Camelcase.

For example, a file named basic_one will define a constant named BasicOne.

Bandoleer files reference a directory; a file named basic_bandoleer.rb looks for files in basic_bandoleer/.

You can equip files to a bandoleer using equip. This will register the ruby constants directly. Given the following structure:

$ ls basic_bandoleer
. .. basic_one.rb
$ cat basic_bandoleer/basic_one.rb
module BasicOne
end

You can define a bandoleer file basic_bandoleer.rb like this:

require 'bandoleer'

module BasicBandoleer
  extend Bandoleer

  vials = %i[
    basic_one
  ]

  equip vials
end

This file can be generated using the included command line interface:

$ bandoleer craft basic_bandoleer
      create  basic_bandoleer.rb

If you want to add namespaces, use / as a delimiter. Running bandoleer craft namespace/basic_bandoleer will create a file that looks like this:

require 'bandoleer'

module Namespace
  module BasicBandoleer
    # ...
  end
end

You can resolve equipped vials using the slice method:

BasicBandoleer[:basic_one]
=> BasicOne

Or with named methods:

BasicBandoleer.basic_one
=> BasicOne

You can also equip custom potions (register Objects other than named constants). Do this using the #equip_custom method. The file named by the entry key will still be required prior to resolution. Given a file basic_two.rb with the content:

module BasicTwo
  def self.report
    'report two!'
  end
end

You can register a different entry than the named constant:

module BasicBandoleer
  report = -> { BasicTwo.report }
  equip_custom basic_two: report
end

Then resolve it:

BasicBandoleer.basic_two.call
=> 'report two!'

Bug reports and pull requests are welcome on GitHub at https://github.com/JC-Morph/bandoleer.