inject 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.rvmrc
+.DS_Store
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Arun Srinivasan
+
+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,32 @@
+# Inject
+
+Inject arguments into methods, by name.
+
+Inspired by ideas from Raptor and Objectify. Figured something
+like this might be useful on its own.
+
+# Example
+
+```ruby
+class InsultParams
+  def target
+    "Arthur Philip Dent"
+  end
+
+  def insult
+    "You're a jerk, Dent... a complete kneebiter."
+  end
+end
+
+class Wowbagger
+  def self.vilify(target, insult)
+    [target, insult].join(": ")
+  end
+end
+
+injector = Inject::Injector.new(InsultParams.new)
+
+injector.call(Wowbagger, :vilify)
+# => "Arthur Philip Dent: You're a jerk, Dent... a complete kneebiter."
+```
+

data/Rakefile

@@ -0,0 +1,38 @@
+$:.push("lib")
+require "inject"
+require "tst"
+
+name = "inject"
+version = Inject::VERSION
+
+desc "Run the tests"
+task :test do
+  Tst.run "test/*.rb",
+    :load_paths => ["lib"],
+    :reporter => Tst::Reporters::Pretty.new
+end
+
+namespace :gem do
+  desc 'Clean up generated files'
+  task :clean do
+    sh 'rm -rf pkg'
+  end
+
+  desc "Build the gem"
+  task :build => :clean do
+    sh "mkdir pkg"
+    sh "gem build #{name}.gemspec"
+    sh "mv #{name}-#{version}.gem pkg/"
+  end
+
+  desc "Release v#{version}"
+  task :release => :build do
+    sh "git commit --allow-empty -a -m 'Release #{version}'"
+    sh "git tag v#{version}"
+    sh "git push origin master"
+    sh "git push origin v#{version}"
+    sh "gem push pkg/#{name}-#{version}.gem"
+  end
+end
+
+task :default => :test

data/inject.gemspec

@@ -0,0 +1,18 @@
+require './lib/inject'
+
+Gem::Specification.new do |s|
+  s.name              = "inject"
+  s.version           = Inject::VERSION
+  s.summary           = "Inject arguments into methods. By name."
+  s.description       = "Inject arguments into methods. By name."
+
+  s.authors           = ["Arun Srinivasan"]
+  s.email             = ["satchmorun@gmail.com"]
+  s.homepage          = "http://github.com/satchmorun/inject"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+
+  s.add_development_dependency "tst"
+  s.require_paths = ["lib"]
+end

data/lib/inject.rb

@@ -0,0 +1,66 @@
+module Inject
+  VERSION = "0.0.1"
+
+  class UnknownArg < ArgumentError; end
+  class Conflict < NameError; end
+
+  class Injector
+    NULL_SOURCE = Proc.new {}
+
+    attr_reader :known
+
+    def initialize(*sources)
+      @known = {}
+      sources.each { |source| add_source(source) }
+    end
+
+    def call(target, name)
+      method = target.method(name)
+      args   = resolve(method.parameters)
+      method.call(*args)
+    end
+
+    def add_source(source)
+      extract_injections(source).each do |name|
+        prevent_collisions(name)
+        known[name] = source.method(name)
+      end
+    end
+
+    def extract_injections(source)
+      if source.respond_to?(:injections)
+        source.injections
+      else
+        source.class.instance_methods(false)
+      end
+    end
+
+    def resolve(parameters)
+      parameters.map do |type, name|
+        fetch(type, name).call unless ignore?(type)
+      end.compact
+    end
+
+    def ignore?(type)
+      @ignored_types ||= [:block, :rest]
+      @ignored_types.include?(type)
+    end
+
+    def fetch(type, name)
+      known.fetch(name) do |key|
+        prevent_unkown_required_args(type, name)
+        NULL_SOURCE
+      end
+    end
+
+    def prevent_unkown_required_args(type, name)
+      return unless type == :req
+      raise UnknownArg.new("Don't know how to inject :#{name}")
+    end
+
+    def prevent_collisions(name)
+      return unless known.key?(name)
+      raise Conflict.new("The :#{name} method is defined more than once.")
+    end
+  end
+end

data/test/injection.rb

@@ -0,0 +1,39 @@
+require 'inject'
+
+class Source
+  def answer; 42 end
+  def injections; [:answer] end
+end
+
+class Target
+  def none; 'no args' end
+  def opt(unknown = 'unknown opt arg') unknown end
+  def known_opt(answer = nil) answer end
+  def req(answer) answer end
+  def block(&b) b end
+  def unknown(unknown_arg) 'should never get here' end
+  def rest(*answer) answer end
+end
+
+def test_injection(method, options={})
+  tst "calling #{method}" do
+    source = Source.new
+    target = Target.new
+    injector = Inject::Injector.new(source)
+
+    if options[:raises]
+      assert_raises options[:raises] { injector.call(target, method) }
+    else
+      result = injector.call(target, method)
+      assert_equal options[:expected], result
+    end
+  end
+end
+
+test_injection :none      , :expected => 'no args'
+test_injection :opt       , :expected => 'unknown opt arg'
+test_injection :known_opt , :expected => 42
+test_injection :req       , :expected => 42
+test_injection :block     , :expected => nil
+test_injection :unknown   , :raises   => Inject::UnknownArg
+test_injection :rest      , :expected => []

data/test/readme_example.rb

@@ -0,0 +1,24 @@
+require 'inject'
+
+class InsultParams
+  def target
+    "Arthur Philip Dent"
+  end
+
+  def insult
+    "You're a jerk, Dent... a complete kneebiter."
+  end
+end
+
+class Wowbagger
+  def self.vilify(target, insult)
+    [target, insult].join(": ")
+  end
+end
+
+tst "Wowbagger" do
+  injector = Inject::Injector.new(InsultParams.new)
+  expected = "Arthur Philip Dent: You're a jerk, Dent... a complete kneebiter."
+  actual = injector.call(Wowbagger, :vilify)
+  assert_equal expected, actual
+end

data/test/sources.rb

@@ -0,0 +1,70 @@
+require 'inject'
+
+class SourceA; def a; 'a' end end
+class SourceB; def b; 'b' end end
+class Conflict; def b; 'conflict' end end
+class APrime < SourceA;
+  def c; 'c' end
+  def injections; [:a, :c] end
+end
+
+class Target
+  def self.a(a); a end
+  def self.b(b); b end
+  def self.c(c); c end
+end
+
+tst "Injector.new with no sources" do
+  Inject::Injector.new
+end
+
+tst "Injector.new with one source" do
+  source = SourceA.new
+  injector = Inject::Injector.new(source)
+
+  assert_equal 'a', injector.call(Target, :a)
+end
+
+tst "Injector.new with more than one sources" do
+  sources = [SourceA.new, SourceB.new]
+  injector = Inject::Injector.new(*sources)
+
+  # Now we have access to injections from both
+  # SourceA and SourceB
+  assert_equal 'a', injector.call(Target, :a)
+  assert_equal 'b', injector.call(Target, :b)
+end
+
+tst "Injector.new detects name collisions" do
+  conflict = assert_raises do
+    sources = [SourceA.new, SourceB.new, Conflict.new]
+    Inject::Injector.new(*sources)
+  end
+
+  assert_equal Inject::Conflict, conflict.class
+  assert_equal "The :b method is defined more than once.", conflict.message
+end
+
+tst "Injector#add_source detects name collisions" do
+  injector = Inject::Injector.new(SourceB.new)
+  conflict = assert_raises { injector.add_source(Conflict.new) }
+
+  assert_equal Inject::Conflict, conflict.class
+  assert_equal "The :b method is defined more than once.", conflict.message
+end
+
+tst "sources can declare their injections" do
+  class APrime < SourceA;
+    def c; 'c' end
+    def injections; [:a, :c] end
+  end
+
+  source = APrime.new
+  injector = Inject::Injector.new(source)
+
+  # Inherited methods won't be auto-discovered, so
+  # we check that both :a and :c do the right thing.
+  # :a - inherited, :c - not inherited.
+  assert_equal 'a', injector.call(Target, :a)
+  assert_equal 'c', injector.call(Target, :c)
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: inject
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arun Srinivasan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tst
+  requirement: &70264599879080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70264599879080
+description: Inject arguments into methods. By name.
+email:
+- satchmorun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- inject.gemspec
+- lib/inject.rb
+- test/injection.rb
+- test/readme_example.rb
+- test/sources.rb
+homepage: http://github.com/satchmorun/inject
+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: Inject arguments into methods. By name.
+test_files:
+- test/injection.rb
+- test/readme_example.rb
+- test/sources.rb