untangle 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3-p194@untangle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in untangle.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yves Senn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Untangle
+
+This gem provides a very lightweight API to specify dependencies
+between objects. The key concepts behind it are:
+
+* Make dependencies of your objects visible by declaring them
+* Depend on roles, not implementation
+* Simplify testing by substituting your dependencies with mocks
+
+## Installation
+
+```ruby
+gem install untangle
+```
+
+## Define Dependencies
+
+**explicit**
+
+Explicit definitions contain a direct reference to the actual
+dependency. The reference can either be a String:
+
+```ruby
+class Person
+  extend Untangle
+
+  dependency :translator, 'I18n'
+end
+```
+
+or a block:
+
+```ruby
+class Person
+  extend Untangle
+
+  dependency(:translator) { I18n }
+end
+```
+
+**implicit**
+
+Implicit definitions have no reference to the actual dependency. The
+implementation will be inferred from the name. In the following
+example, the dependency would resolve to `Translator`.
+
+```ruby
+class Person
+  extend Untangle
+
+  dependency :translator
+end
+```
+
+## Global Dependencies
+
+If you have global dependencies, which are used throughout your app,
+you can register them globally. This way you can use `dependency`
+implicit definitions without a name that corresponds to the implementation.
+
+```ruby
+Untangle.register :translator, 'I18n'
+
+class Blog
+  extend Untangle
+
+  dependency :translator
+end
+```
+
+You can also use these registered dependencies to inject them into a
+constructor. This technique does not require that the object under
+construction knows about `explicit_dependencies`
+
+```ruby
+Untangle.register :translator, 'I18n'
+ExplicitDependencies.register :people_repository, 'PeopleRepository'
+
+class MyPrcoess
+
+  # The argument names must match the registered dependencies
+  def initialize(translator, people_repository)
+  end
+
+end
+
+Untangle.inject(MyProcess, :new)
+```
+
+## Testing

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/untangle.rb

@@ -0,0 +1,34 @@
+require "untangle/version"
+require "untangle/injector"
+
+module Untangle
+  def self.injector
+    @injector ||= Injector.new
+  end
+
+  def self.register(name, dependency)
+    injector.register(name, dependency)
+  end
+
+  def self.lookup(name)
+    injector.lookup(name)
+  end
+
+  def self.inject(method)
+    injector.inject(method)
+  end
+
+  def injector
+    @injector ||= Injector.new(Untangle.injector)
+  end
+
+  def dependency(name, *args, &block)
+    custom_injector = injector
+    custom_injector.register name, *args, &block
+
+    define_method name do
+      custom_injector.lookup(name)
+    end
+    private name
+  end
+end

data/lib/untangle/injector.rb

@@ -0,0 +1,50 @@
+require 'active_support/inflector'
+
+module Untangle
+  class Injector
+
+    def initialize(parent_injector = nil)
+      @parent_injector = parent_injector
+      @subjects = {}
+    end
+
+    def register(name, subject = nil)
+      subject = yield if block_given?
+      @subjects[name] = subject
+    end
+
+    def lookup(name)
+      @subjects[name] || handle_missing_subject(name)
+    end
+
+    def inject(method)
+      arguments = parameters(injection_method(method)).map { |type, name|
+        lookup(name)
+      }
+      method.call(*arguments)
+    end
+
+    def handle_missing_subject(name)
+      if @parent_injector
+        @parent_injector.lookup(name)
+      else
+        name.to_s.classify.constantize
+      end
+    end
+    private :handle_missing_subject
+
+    def parameters(method)
+      method.parameters
+    end
+    private :parameters
+
+    def injection_method(method)
+      if method.name == :new
+        method.receiver.instance_method(:initialize)
+      else
+        method
+      end
+    end
+    private :injection_method
+  end
+end

data/lib/untangle/version.rb

@@ -0,0 +1,3 @@
+module Untangle
+  VERSION = "0.0.1"
+end

data/spec/integration/dependency_definitions_spec.rb

@@ -0,0 +1,90 @@
+require 'integration/spec_helper'
+
+module TaskRepository
+end
+
+class Person
+end
+
+class ExampleClass
+  extend Untangle
+
+  dependency :class_dependency, Person
+  dependency :module_dependency, TaskRepository
+  dependency(:block_dependency) { Person }
+  dependency :task_repository
+  dependency :person
+  dependency :repository
+end
+
+module ExampleModule
+  extend self
+  extend Untangle
+
+  dependency :class_dependency, Person
+  dependency :module_dependency, TaskRepository
+  dependency(:block_dependency) { Person }
+  dependency :task_repository
+  dependency :person
+  dependency :repository
+end
+
+describe 'Dependency definitions' do
+  shared_examples_for 'definition with explicit dependencies' do
+
+    describe 'Dependency Definitions' do
+      it 'supports explicit class dependencies' do
+        subject.send(:class_dependency).should == Person
+      end
+
+      it 'supports explicit module dependencies' do
+        subject.send(:module_dependency).should == TaskRepository
+      end
+
+      it 'supports explicit block dependencies' do
+        subject.send(:block_dependency).should == Person
+      end
+
+      it 'supports implicit module dependencies ' do
+        subject.send(:task_repository).should == TaskRepository
+      end
+
+      it 'supports implicit class dependencies ' do
+        subject.send(:person).should == Person
+      end
+
+      it 'defined accessors are private' do
+        lambda do
+          subject.module_dependency
+        end.should raise_error(NoMethodError)
+      end
+
+      it 'implicit dependencies can be defined globaly' do
+        Untangle.register :repository, TaskRepository
+        subject.send(:repository).should == TaskRepository
+      end
+    end
+  end
+
+  describe "Classes" do
+    subject { ExampleClass.new }
+
+    it_behaves_like 'definition with explicit dependencies'
+  end
+
+  describe "Modules" do
+    subject {
+      Class.new do
+        include ExampleModule
+      end.new
+    }
+
+    it_behaves_like 'definition with explicit dependencies'
+  end
+
+  describe 'self extended Module' do
+    subject { ExampleModule }
+
+    it_behaves_like 'definition with explicit dependencies'
+  end
+end

data/spec/integration/injection_spec.rb

@@ -0,0 +1,24 @@
+require 'integration/spec_helper'
+
+class Blog; end
+module PostRepository; end
+
+class MyProcess
+  attr_reader :blog, :posts
+  def initialize(blog, posts)
+    @blog = blog
+    @posts = posts
+  end
+end
+
+
+describe 'Injection' do
+  it 'can inject the dependencies into arbitrary methods' do
+    Untangle.register :blog, Blog
+    Untangle.register :posts, PostRepository
+
+    process = Untangle.inject(MyProcess.method(:new))
+    process.blog.should == Blog
+    process.posts.should == PostRepository
+  end
+end

data/spec/integration/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'untangle'

data/spec/unit/injector_spec.rb

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+require 'unit/spec_helper'
+require 'untangle/injector'
+
+describe Untangle::Injector do
+
+  describe '#register ' do
+    it 'adds a dependency for later injection' do
+      subject.register :message, 'my name is Jane'
+      subject.lookup(:message).should == 'my name is Jane'
+    end
+
+    it 'works with a block' do
+      subject.register(:greet) {'welcome'}
+      subject.lookup(:greet).should == 'welcome'
+    end
+  end
+
+  describe '#lookup ' do
+    it 'returns registered subjects' do
+      subject.register :buffer_factory, String
+      subject.lookup(:buffer_factory).should == String
+    end
+
+    context 'without registered subject' do
+      it 'turns the name into a constant' do
+        subject.lookup(:hash).should == Hash
+      end
+    end
+  end
+
+  describe '#inject ' do
+    it 'passes matching arguments to a method' do
+      greeter_class = Class.new do
+        def greet(name)
+          "Hello #{name}!"
+        end
+      end
+
+      greeter = greeter_class.new
+      subject.register :name, 'Peter'
+      subject.inject(greeter.method(:greet)).should == 'Hello Peter!'
+    end
+
+    it 'can be used to create instances' do
+      greeter = Class.new do
+        attr_reader :name
+        def initialize(name)
+          @name = name
+        end
+      end
+
+      subject.register :name, 'Max'
+      subject.inject(greeter.method(:new)).name.should == 'Max'
+    end
+  end
+
+  context 'with parent injector' do
+    let(:parent_injector) { described_class.new }
+    subject { described_class.new(parent_injector) }
+
+    it 'returns dependencies from the parent injector' do
+      parent_injector.register :eleven, 11
+
+      subject.lookup(:eleven).should == 11
+    end
+
+    it 'overwrites parent dependencies with the same name' do
+      parent_injector.register :name, 'Sophie'
+      subject.register :name, 'Sandy'
+
+      subject.lookup(:name).should == 'Sandy'
+    end
+  end
+end

data/spec/unit/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec'

data/untangle.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/untangle/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yves Senn"]
+  gem.email         = ["yves.senn@gmail.com"]
+  gem.description   = 'Leightweight dependency API for your POROs'
+  gem.summary       = 'ungangle your dependencies mess and make them visible.'
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "untangle"
+  gem.require_paths = ["lib"]
+  gem.version       = Untangle::VERSION
+
+  gem.add_dependency 'activesupport', '>= 3.0'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: untangle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yves Senn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70221386294880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70221386294880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70221386294440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221386294440
+description: Leightweight dependency API for your POROs
+email:
+- yves.senn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/untangle.rb
+- lib/untangle/injector.rb
+- lib/untangle/version.rb
+- spec/integration/dependency_definitions_spec.rb
+- spec/integration/injection_spec.rb
+- spec/integration/spec_helper.rb
+- spec/unit/injector_spec.rb
+- spec/unit/spec_helper.rb
+- untangle.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ungangle your dependencies mess and make them visible.
+test_files:
+- spec/integration/dependency_definitions_spec.rb
+- spec/integration/injection_spec.rb
+- spec/integration/spec_helper.rb
+- spec/unit/injector_spec.rb
+- spec/unit/spec_helper.rb