interjectable 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0af3542297a01bc7ee22e3285d3e8304696930db
+  data.tar.gz: 13b3b515d6091e5060929799e01bebda5247847c
+SHA512:
+  metadata.gz: be91741b3702f14722f9553935f71ddc8429cc33e6e52d37807f105e6476e54943f79cc8af624e385859853cdfb59365c38e4b405cf20ed48c79c234daa2aca9
+  data.tar.gz: d3eb4089dcbe35bdb36a7ec801072f2ec125a60f38fdd1c8b0016063c434065ded77bdfd1bc811021cd69d75d8323885dbae928e0df9693d01ab01ecb946d407

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zach Margolis
+
+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,85 @@
+# Interjectable
+
+Interjectable is a really simple Ruby library for dependency injection, designed to make unit testing easier.
+
+## Installation
+
+It's a gem!
+
+```ruby
+gem 'interjectable'
+```
+
+## Usage
+
+Interjectable has one module (`Interjectable`) and one method (`inject`). Use it like so!
+
+```ruby
+class MyClass
+  extend Interjectable
+
+  inject(:dependency) { SomeOtherClass.new }
+  inject(:other_dependency) { AnotherClass.new }
+end
+```
+
+This replaces a pattern we've used before, adding default dependencies in the constructor, or as memoized methods.
+
+```ruby
+# OLD WAY, see above
+class MyClass
+  attr_accessor :dependency
+
+  def initialize(dependency=SomeOtherClass.new)
+    @dependency=dependency
+  end
+
+  def other_depency
+    @other_dependency ||= AnotherClass.new
+  end
+end
+```
+
+## Dependency Injection + Unit Testing?
+
+> Ok but what the heck is dependency injection and what does it have to do with unit tests?
+
+So in the real world, objects depend on other objects: object A uses object B to parse a file. This is normal. But what about when you want to test object A independently from object B? Object B might depend on objects C, D, E and so on, so the test would become needlessly complex.
+
+For the sake of testing object A, we can stub out object B with something fake. But for normal usage of object A, we want to actually use object B (and all its dependencies). We can accommodate both these use cases with dependency injection!
+
+Let's check it out: we can build a class A that normally references B, but in our test we can safely replace B, and don't even have to require or load B at all!
+
+```ruby
+# a.rb
+class A
+  extend Interjectable
+
+  inject(:b) { B.new }
+
+  def read
+    b.parse
+  end
+end
+
+# a_spec.rb
+require 'a'
+
+describe A do
+  describe "#read" do
+    before do
+      a.b = double("FakeB", parse: 'result')
+    end
+
+    it "parses from its b" do
+      subject.read.should == 'result'
+    end
+  end
+end
+```
+
+> Great, why this library over any other?
+
+Interjectable aims to provide clear defaults for easy debugging.
+
+The other libraries we found used inject/provide setups. That setup is nice because files don't reference each other. However, this can become a headache to debug to actually figure out what is being used where. In our use cases, we use dependency injection for simplified testing, not for hands-free configuration.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/interjectable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interjectable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interjectable"
+  spec.version       = Interjectable::VERSION
+  spec.authors       = ["Zach Margolis"]
+  spec.email         = ["zbmargolis@gmail.com"]
+  spec.description   = %q{A simple dependency injection library for unit testing}
+  spec.summary       = %q{A simple dependency injection library for unit testing}
+  spec.homepage      = "https://github.com/zachmargolis/interjectable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/interjectable/version.rb

@@ -0,0 +1,3 @@
+module Interjectable
+  VERSION = "0.0.2"
+end

data/lib/interjectable.rb

@@ -0,0 +1,21 @@
+require "interjectable/version"
+
+module Interjectable
+  def self.extended(mod)
+    super
+  end
+
+  def inject(dependency, &default_block)
+    attr_writer dependency
+
+    define_method(dependency) do
+      # @dependency ||= instance_eval(&default_block)
+      ivar_name = "@#{dependency}"
+      if instance_variable_defined?(ivar_name)
+        instance_variable_get(ivar_name)
+      else
+        instance_variable_set(ivar_name, instance_eval(&default_block))
+      end
+    end
+  end
+end

data/spec/interjectable_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Interjectable do
+  context "when extended" do
+    let(:klass) { Class.new { extend Interjectable } }
+    let(:instance) { klass.new }
+
+    describe "#inject" do
+      before do
+        klass.inject(:some_dependency) { :service }
+      end
+
+      it "adds an instance method getter and setter" do
+        instance.some_dependency = 'aaa'
+        instance.some_dependency.should == 'aaa' 
+      end
+
+      it "lazy-loads the default block" do
+        instance.instance_variable_get("@some_dependency").should be_nil
+        instance.some_dependency.should == :service
+        instance.instance_variable_get("@some_dependency").should_not be_nil
+      end
+
+      it "allows transitive dependencies (via instance_eval)" do
+        klass.inject(:first_dependency) { second_dependency }
+        klass.inject(:second_dependency) { :value }
+
+        instance.first_dependency.should == :value
+      end
+
+      it "calls dependency block once, even with a falsy value" do
+        klass.inject(:some_falsy_dependency) { @count += 1; nil }
+
+        instance.instance_variable_set("@count", 0)
+        2.times { instance.some_falsy_dependency.should be_nil }
+        instance.instance_variable_get("@count").should == 1
+      end
+
+      context "with a dependency on another class" do
+        before do
+          defined?(SomeOtherClass).should be_false
+
+          klass.inject(:some_other_class) { SomeOtherClass.new }
+        end
+
+        it "does not need to load that class (can be stubbed away)" do
+          instance.some_other_class = :fake_other_class
+
+          instance.some_other_class.should == :fake_other_class
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+$LOAD_PATH.unshift(
+  File.join(File.dirname(__FILE__), '..', 'lib', 'interjectable')
+)
+
+require 'interjectable'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: interjectable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Zach Margolis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple dependency injection library for unit testing
+email:
+- zbmargolis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- interjectable.gemspec
+- lib/interjectable.rb
+- lib/interjectable/version.rb
+- spec/interjectable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zachmargolis/interjectable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple dependency injection library for unit testing
+test_files:
+- spec/interjectable_spec.rb
+- spec/spec_helper.rb