dumpling 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27b87ea50d627fb4bf537b97334435165f0550dc
-  data.tar.gz: 084c021f548b392e1e0aa749d7a5566e5ff9b4a2
+  metadata.gz: 07ff2f1a56d0fabcfefe29dec5322d7ff2f57eb6
+  data.tar.gz: bead658711229742bb88e919d913af3257a19883
 SHA512:
-  metadata.gz: 6e9fceb60dcfb9464d028d6fb34ab1f7358f14ff21abd93b65f7dbef581353ba2bc445895120fa1ebac5bc57d9276b00fb941f0063801d7610293b10e52e98be
-  data.tar.gz: e7dcdc818d2a6df4eeea40032bbf2cb85ab0db228b3350d4db1361991fe943de2c0752d17c6a6271f509e9f3fafe8e4e81a16bdf4e90726a5957b799eeac8822
+  metadata.gz: cf8af125eed37639db305a1fe6639cdb0c91fb2402d24826423909b05f3d53d7bc2531442244917a5597b53d0652ea77e3485cf3c5281b8247757be9385c3d82
+  data.tar.gz: 3b2946aeb843ff9f916b25e495a1d577a6ce5cf91a966464f64a630dc28bb9d56a11ac68bcd9d1302068efe11c96c09020dfecc5a28aaf14bf6bcd344df53b7e

data/README.md

@@ -1,6 +1,8 @@
 # Dumpling
 
-TODO: Describe your gem
+Dumpling provides you an unobtrusive way to manage dependencies.
+What is unobtrusive? Unobtrusive means that you don't need to include a module or inherit a class anywhere in your project.
+Dumpling does not tie your hands. All you have to do is just wire up dependencies.
 
 ## Installation
 
@@ -18,9 +20,105 @@ Or install it yourself as:
 
     $ gem install dumpling
 
-## Usage
+## Getting started
 
-TODO: Write usage instructions here
+### Basics
+
+```ruby
+class UsersRepository
+  attr_writer :logger
+end
+
+Dumpling.configure do
+  set :logger do |s|
+    s.instance Logger.new(STDOUT) # => #<Logger:0x00000000e281a0>
+  end
+
+  set :users_repository do |s|
+    s.class UsersRepository
+    s.dependency :logger
+  end
+end
+
+# Every time you invoke the #get method you will get a new instance of the #class
+Dumpling.get(:users_repository) # => #<UsersRepository:0x00000000ebee20>
+Dumpling.get(:users_repository) # => #<UsersRepository:0x00000000e8a8f0>
+
+# Every time you invoke the #get method you will get the same predefined #instance
+Dumpling.get(:logger) # => #<Logger:0x00000000e281a0>
+Dumpling.get(:logger) # => #<Logger:0x00000000e281a0>
+```
+
+### Defining multiple dependencies
+
+```ruby
+container = Dumpling::Container.new
+container.configure do
+  set :logger do |s|
+    s.instance Logger.new(STDOUT) # => #<Logger:0x00000000e281a0>
+  end
+  
+  set :adapter do |s|
+    s.instance PostgreSQLAdapter.new
+    s.dependency :logger
+  end
+
+  set :users_repository do |s|
+    s.class UsersRepository
+    s.dependency :logger
+    s.dependency :adapter
+  end
+end
+
+class UsersRepository
+  attr_accessor :logger, :adapter
+
+  # You can mark a setter method as a private if you need
+  private :adapter=, :logger=
+end
+
+container.get(:users_repository).logger # => #<Logger:0x00000000e281a0>
+container[:users_repository].adapter.logger # => #<Logger:0x00000000e281a0>
+# Logger will be injected every time an adapter is accessed
+container[:adapter].logger # => #<Logger:0x00000000e281a0>
+```
+
+### Using namespaces
+
+```ruby
+container = Dumpling::Container.new
+container.configure do
+  # All that does not match [a-zA-Z0-9_] is a delimiter
+  set :'billing:repositories:users' do |s|
+    ...
+  end
+  
+  set :'billing repositories users' do |s|
+    ...
+  end
+  
+  set :'billing.repositories.users' do |s|
+    ...
+  end
+  
+  # Delimiters can be mixed up
+  set :'billing repositories-users' do |s|
+    ...
+  end
+  
+  set :'billing.commands.create' do |s|
+    s.class Billing::Commands::Create
+    # Will automatically guess the name of the attr_writer by the last word (attr_writer :users)
+    s.dependency :'billing.repositories.users'
+  end
+  
+  set :'billing.commands.open_dispute' do |s|
+    s.class Billing::Commands::OpenDispute
+    # Define the attr_writer explicitly (attr_writer :customers)
+    s.dependency :'billing.repositories.users', attribute: :customers
+  end
+end
+```
 
 ## Development
 

data/dumpling.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/antonkuzmenko/dumpling'
   spec.license = 'MIT'
 
-  spec.summary = 'Dumpling is a simple Dependency Injection Container'
+  spec.summary = 'Dumpling is an unobtrusive Dependency Injection Container'
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\Aspec/}) }
   spec.require_paths = ['lib']
@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.36.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
 end

data/lib/dumpling.rb

@@ -7,5 +7,14 @@ module Dumpling
   require 'dumpling/errors/specification'
   require 'dumpling/specification'
   require 'dumpling/specification_validator'
+  require 'dumpling/registry'
   require 'dumpling/container'
+
+  @container = Container.new
+
+  class << self
+    extend Forwardable
+
+    def_delegators :@container, :set, :get, :[], :configure
+  end
 end

data/lib/dumpling/container.rb

@@ -1,14 +1,24 @@
 module Dumpling
   class Container
+    attr_writer :validator_class
+
     def initialize
-      @id_list = Set.new
-      @registry = {}
+      @registry = Registry.new
+      @validator_class = SpecificationValidator
+    end
+
+    def set(id, &block)
+      fail(Errors::Container::Duplicate, id) if @registry.has?(id)
+
+      specification = create_specification(&block)
+      @registry.set(id, specification)
+
+      id
     end
 
     def get(id)
-      id = id.to_sym
-      fail(Errors::Container::Missing, id) unless @id_list.include?(id)
-      specification = @registry[id]
+      fail(Errors::Container::Missing, id) unless @registry.has?(id)
+      specification = @registry.get(id)
       instance = build_instance(specification)
       inject_dependencies(instance, specification)
       instance
@@ -16,21 +26,6 @@ module Dumpling
 
     alias :[] get
 
-    def set(id)
-      id = id.to_sym
-      fail(Errors::Container::Duplicate, id) if @id_list.include?(id)
-
-      specification = Specification.new
-      yield specification
-      SpecificationValidator.new(@id_list, specification).validate!
-      @registry[id] = specification
-      @id_list << id
-
-      nil
-    end
-
-    alias :[]= set
-
     def configure(&block)
       instance_eval(&block)
       self
@@ -38,13 +33,20 @@ module Dumpling
 
     private
 
+    def create_specification
+      specification = Specification.new
+      yield specification
+      @validator_class.new(@registry.keys, specification).validate!
+      specification
+    end
+
     def build_instance(specification)
       specification.class.nil? ? specification.instance : specification.class.new
     end
 
     def inject_dependencies(instance, specification)
       specification.dependencies.each do |dependency|
-        instance.send("#{dependency[:attr]}=", get(dependency[:id]))
+        instance.send("#{dependency[:attribute]}=", get(dependency[:id]))
       end
     end
   end

data/lib/dumpling/errors/specification.rb

@@ -6,9 +6,6 @@ module Dumpling
 
       class MissingDependencies < Invalid
       end
-
-      class NotClass < Invalid
-      end
     end
   end
 end

data/lib/dumpling/registry.rb

@@ -0,0 +1,25 @@
+module Dumpling
+  class Registry
+    attr_reader :keys
+
+    def initialize
+      @data = {}
+      @keys = Set.new
+    end
+
+    def set(id, value)
+      @data[id] = value
+      @keys << id
+
+      value
+    end
+
+    def get(id)
+      @data[id]
+    end
+
+    def has?(id)
+      @keys.include?(id)
+    end
+  end
+end

data/lib/dumpling/specification.rb

@@ -14,15 +14,15 @@ module Dumpling
       instance.nil? ? @instance : (@instance = instance)
     end
 
-    def inject(id, attr: nil)
-      dependencies << { id: id.to_sym, attr: (attr || guess_attribute(id)).to_sym }
+    def dependency(id, attribute: nil)
+      dependencies << { id: id, attribute: (attribute || guess_attribute(id)).to_sym }
     end
 
     private
 
     def guess_attribute(id)
-      /(?<attr>\w+)\z/i =~ id
-      attr || id
+      /(?<attribute>\w+)\z/i =~ id
+      attribute || id
     end
   end
 end

data/lib/dumpling/specification_validator.rb

@@ -13,8 +13,13 @@ module Dumpling
     private
 
     def validate_value
+      unless @specification.class.nil? || @specification.instance.nil?
+        fail Errors::Specification::Invalid,
+             'Do not define both #class and #instance at the same time'
+      end
+
       if @specification.class.nil? && @specification.instance.nil?
-        fail Errors::Specification::Invalid, 'You must define #class or #instance'
+        fail Errors::Specification::Invalid, 'Define #class or #instance'
       end
     end
 
@@ -29,8 +34,8 @@ module Dumpling
     def missing_dependencies
       @specification
         .dependencies
-        .reject { |e| @id_list.include?(e[:id]) }
         .map { |e| e[:id] }
+        .reject { |e| @id_list.include?(e) }
     end
   end
 end

data/lib/dumpling/version.rb

@@ -1,7 +1,7 @@
 module Dumpling
   module Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY = 0
     PRE = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dumpling
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Kuzmenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.36.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 description: 
 email: antonkuzmenko.dev@gmail.com
 executables: []
@@ -89,6 +103,7 @@ files:
 - lib/dumpling/errors/base_error.rb
 - lib/dumpling/errors/container.rb
 - lib/dumpling/errors/specification.rb
+- lib/dumpling/registry.rb
 - lib/dumpling/specification.rb
 - lib/dumpling/specification_validator.rb
 - lib/dumpling/version.rb
@@ -115,5 +130,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Dumpling is a simple Dependency Injection Container
+summary: Dumpling is an unobtrusive Dependency Injection Container
 test_files: []