carb-container 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b2266086979fc001d37b802f0737e46a0101fa7
-  data.tar.gz: 85fe087f9b35d32ee015b897f3eeba8f6a670a3e
+  metadata.gz: 14c4ecb86c8b6ad0344f83c69a88197abc40fd28
+  data.tar.gz: 98914be8b62f72dbed25e62fe0df868994694b02
 SHA512:
-  metadata.gz: 3fe8e15f66cae9431cec660c5cbd082e13c5394d5a6c619dc99ccff405ff702ef206acc6f7e94770e0b10ab3e34e4c866f786b45c53f2a7acdf4421cd729f489
-  data.tar.gz: 0353b4d1bb150e98b3a8815f62e1585b7cd0d41523ace337c6778f0764255d95c3f20dbbe6a66d02e5ccb22605af1adeec1278c66efd000b80a4df8b2135eff7
+  metadata.gz: 9407ea0ee8bc049976ba4b782e59799b4a9d93885a1c308c7778091100aa8a06683ce7d2b6238d03deebff40f6ea88d963636d741768caa576e8fe80350a5737
+  data.tar.gz: 849aab3233cc33197af4a87fdc2c547d186384c9537297c366efd914a6820368a294e3d438eac7c35406bd0fd78b677fedb3934fef55e38911e63d5e22f3b034

data/README.md

@@ -3,6 +3,50 @@
 A set of simple container objects to store dependencies. Can be used in
 conjuction with [carb-inject](https://github.com/Carburetor/carb-inject) as
 an IoC container.
+Check the following example usage:
+
+```ruby
+# Optional, used to auto convert class names to symbol
+require "active_support/inflector/methods"
+
+Container = Carb::Container::RegistryContainer.new
+Carb::Container::RegistrationGlue.call(Container)
+
+class Foo
+  carb_container as: :myfoo
+
+  def hello
+    "foo"
+  end
+end
+
+class Bar
+  carb_container
+
+  def hello
+    "bar"
+  end
+end
+
+class Baz
+  def hello
+    "baz"
+  end
+end
+
+Container.register(:special_baz, -> { Baz.new })
+
+# Now let's use the container to fetch various dependencies
+foo_class = Container[:myfoo]
+bar_class = Container[:bar]
+foo = foo_class.new
+bar = bar_class.new
+baz = Container[:special_baz]
+
+foo.hello # => "foo"
+bar.hello # => "bar"
+baz.hello # => "baz"
+```
 
 ## Installation
 
@@ -61,9 +105,10 @@ container[:my_class].new.hello
 
 ### Carb::Container::RegistrationGlue
 
-A utility class that allows you to create a class method inside `Module` so
-that you can easily register any newly created class. This is entirely
-optional, for people who don't like monkey patching, can be skipped.
+A utility class that makes the method `carb_container` available as class 
+class method in all classes so, that you can easily register any newly
+created class. This is entirely optional, for people who don't like monkey
+patching, can be skipped.
 
 ```ruby
 MyContainer = Carb::Container::RegistryContainer.new
@@ -94,6 +139,27 @@ person.greet
 person.bark
 ```
 
+#### carb_container
+
+This method accepts two options:
+
+- `as:` which accepts a `Symbol` and is the name which will be used to
+  register the class. If not supplied and `activesupport` is present, it will
+  be inferred by class name in snake_case
+- `init: false` by default the value is the same as the `init`
+  supplied to `RegistrationGlue` when invoked (which defaults to `false`).
+  When false, it will register the class itself as is, equivalent to calling
+  `mycontainer.register(:foo, -> { Foo })`, however if set to `true` it
+  store the dependency with a call to `new`, like
+  `mycontainer.register(:foo, -> { Foo.new })`, the class must have a
+  constructor without arguments
+
+`RegistrationGlue` also accepts an option when called:
+
+- `init: false` which can be set to `true` so that `carb_container` will
+  automatically supply `init: true` instead (check `carb_container` for
+  more details)
+
 ### Carb::Container::DelegateContainer
 
 Special container which allows chaining containers together so that a

data/lib/carb/container/registerer.rb

@@ -7,26 +7,35 @@ module Carb::Container
     private
 
     attr_reader :container
+    attr_reader :init
     attr_reader :converter
 
     # @param container [#register] object which will be used to register
     #   dependencies as {::Proc}
+    # @param init [Boolean] defaults to `false`. If `true`, carb_container will
+    #   register classes as `-> { MyClass.new }` instead of `-> { MyClass }`
     # @param converter [#call] object which accepts a string and converts it
     #   into a valid method name. It's used to convert class name to a method
     #   name. By default it uses an instance of {ClassNameToMethodName}
-    def initialize(container, converter: ClassNameToMethodName.new)
+    def initialize(
+      container,
+      init:      false,
+      converter: ClassNameToMethodName.new
+    )
       @container = container
+      @init      = init
       @converter = converter
-      def_carb_container(container, converter)
+      def_carb_container(container, init, converter)
     end
 
     private
 
-    def def_carb_container(kontainer, convert)
-      define_method(:carb_container) do |as: nil|
+    def def_carb_container(kontainer, auto_init, convert)
+      define_method(:carb_container) do |as: nil, init: auto_init|
         as ||= convert.call(self.name.to_s)
         as   = as.to_sym
-        kontainer.register(as, -> { self })
+        kontainer.register(as, -> { self.new })     if init
+        kontainer.register(as, -> { self })     unless init
       end
       send(:protected, :carb_container)
     end

data/lib/carb/container/registration_glue.rb

@@ -10,6 +10,9 @@ module Carb::Container
     # @param container [#register] a generic object, usually a
     #   {RegistryContainer} which responds to `#register(name, dependency)`,
     #   it's the only required argument
+    # @param init [Boolean] auto initialize classes by calling `#new` (without
+    #   arguments) if true when `carb_container` is called. By default is
+    #   `false`
     # @param target [Class, Module] class where you want to add the class
     #   method `carb_container`. Usually it's the {::Module} class so it's
     #   available on all classes
@@ -21,11 +24,16 @@ module Carb::Container
     #   name. By default it uses an instance of {ClassNameToMethodName}
     def call(
       container,
+      init:       false,
       target:     Module,
       registerer: Registerer,
       converter:  ClassNameToMethodName.new
     )
-      registerer_instance = registerer.new(container, converter: converter)
+      registerer_instance = registerer.new(
+        container,
+        init:       init,
+        converter:  converter
+      )
 
       include_registerer(target, registerer_instance)
     end

data/lib/carb/container/version.rb

@@ -1,5 +1,5 @@
 module Carb
   module Container
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carb-container
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Fire-Dragon-DoL
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-27 00:00:00.000000000 Z
+date: 2017-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carb-core