medicine 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19f0f8412a402f42bd7b0f91644a187d664e6e29
-  data.tar.gz: ec738b16e8c28da75bd08f4fa660aab74b33b6f7
+  metadata.gz: 79bc0ab2a504f8fac7530336253908d4d7a79332
+  data.tar.gz: dbd4d812702841a2182eee8506bcd650144190a0
 SHA512:
-  metadata.gz: 73d44fa17647302412a37d9055e8770c0505e5d7468fb30bd8499c6cca3b5df10722a4aaa1e9ce61cd858efdfc8903332413f20967980dde8b261211932e1856
-  data.tar.gz: d40fecb0a6d6d0af603fc698f959887fd5753a9fae779b2f533d5f5c5cc23e463952625b70943a5280232daf1efa7bfe56916fc9f76d8cbd78c1623fe0cfe04d
+  metadata.gz: 8677b2d572b120218ee4fb4a9812948673d2eff51fc703a973f88029a82b77076fbf6d80fe3e90e00af5964c28c945a8cbdf869422e71703b9d18fd29a1c82b5
+  data.tar.gz: 24a18976d5119c76c0a56f6e115382c87c1786060613bedadaf63ff9a8a3b331b3f54289212e6b593771b3436cbcf3ea559aeaa718196f6f19c87f15377ffa0a

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+bundler_args: --without=extras
+script: rspec spec
+rvm:
+  - '2.1.5'
+  - rbx-2
+matrix:
+  include:
+    - rvm: jruby
+      env: JRUBY_OPTS="--2.1"

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+## Unreleased
+
+## 0.0.2 (13th Feb 2015)
+
+* refactoring
+* fix for inheritence
+* add typecasting for default dependencies
+* allow late evaluation of default dependency via lambda
+
+## 0.0.1 (9th Feb 2015)
+
+* Initial code

data/Gemfile

@@ -3,6 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem "bundler"
-gem "rake"
 gem "rspec"
-gem 'pry-byebug'
+gem 'coveralls', require: false
+
+group :extras do
+  gem "rake"
+  gem 'pry-byebug'
+  gem 'yard'
+end

data/README.md

@@ -1,5 +1,10 @@
 # Medicine
 
+[![Gem Version](https://badge.fury.io/rb/medicine.png)](http://badge.fury.io/rb/medicine)
+[![Code Climate](https://codeclimate.com/github/krisleech/medicine.png)](https://codeclimate.com/github/krisleech/medicine)
+[![Build Status](https://travis-ci.org/krisleech/medicine.png?branch=master)](https://travis-ci.org/krisleech/medicine)
+[![Coverage Status](https://coveralls.io/repos/krisleech/medicine/badge.png?branch=master)](https://coveralls.io/r/krisleech/medicine?branch=master)
+
 Simple Dependency Injection for Ruby
 
 Find yourself passing dependencies in to the initalizer? Medicine makes this
@@ -28,10 +33,17 @@ In this example Medicine adds a private method called `vote_repo` which returns
 ```ruby
 vote_repo = double('VoteRepo')
 cast_vote = CastVote.new(vote_repo: vote_repo)
+```
 
-# or
+If you want to arguments other than the dependencies in to the constructor
+don't forget to invoke `super`:
 
-cast_vote = CastVote.new(arg1, arg2, vote_repo: vote_repo)
+```ruby
+def initialize(arg1, arg2, dependencies = {})
+  @arg1 = arg1
+  @arg2 = arg2
+  super(dependencies)
+end
 ```
 
 ## Required dependencies
@@ -40,33 +52,17 @@ cast_vote = CastVote.new(arg1, arg2, vote_repo: vote_repo)
 dependency :vote_repo
 ```
 
-When no default is specified and is not injected an error will be raised on
+When no default is specified and is not injected an exception will be raised on
 initialization.
 
 ## Default dependencies
 
 ```ruby
+dependency :vote_repo, default: :vote
 dependency :vote_repo, default: :Vote
 dependency :vote_repo, default: 'Vote'
 dependency :vote_repo, default: -> { Vote }
 ```
 
-The above examples will expose a method called `vote_repo` which returns the 
+The above examples will expose a method called `vote_repo` which returns the
 `Vote` class as the default dependency.
-
-You could also pass an object which responds to call and accepts one argument,
-the name of the dependency
-
-```ruby
-dependency :vote_repo, default: Repo
-```
-
-```ruby
-class Repo
-  def self.call(name)
-    Kernel.constant_get(name.gsub('_repo', ''))
-  end
-end
-```
-
-In this example the `vote_repo` method will return the `Vote` class.

data/TODO

@@ -4,9 +4,6 @@ test that zsuper/super is called
 module populates class with many private instance methods
   * think about namespacing them somehow, module/double underscore...
 refactor tests
-implement remaining examples in README
-add example of how to call super if overriding initialize
-see how it works with inheritence
 test to make sure state is not shared between objects
 freeze dependency hash passed to initalize
-release 0.0.1
+release 0.0.2

data/lib/medicine/version.rb

@@ -1,3 +1,3 @@
 module Medicine
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/medicine.rb

@@ -1,23 +1,28 @@
 require "medicine/version"
+require "inflecto"
 
 module Medicine
   def self.di
     DI
   end
 
-  module DI
-    ArgumentError = Class.new(::ArgumentError)
+  RequiredDependencyError = Class.new(::ArgumentError)
 
+  module DI
     def self.included(base)
       base.extend(ClassMethods)
     end
 
+    def self.prepended(base)
+      base.extend(ClassMethods)
+    end
+
     def initialize(*args)
       @dependencies = extract_dependencies(args)
       assert_all_dependencies_met
       define_dependency_methods
 
-      super(*args)
+      super
     end
 
     private
@@ -27,6 +32,7 @@ module Medicine
         define_singleton_method name do
           @dependencies.fetch(name) { resolve_dependency(name) }
         end
+        self.singleton_class.class_eval { private name }
       end
     end
 
@@ -35,26 +41,46 @@ module Medicine
     end
 
     def assert_all_dependencies_met
-      raise ArgumentError, "initalize with all dependencies without a default" unless all_dependencies_met?
+      raise RequiredDependencyError, "pass all required dependencies (#{unmet_dependencies.join(', ')}) in to initialize" unless unmet_dependencies.empty?
     end
 
-    def all_dependencies_met?
-      self.class.dependencies.keys.all? do |key|
-        @dependencies.has_key?(key) || self.class.dependencies.fetch(key).has_key?(:default)
+    def unmet_dependencies
+      self.class.dependencies.keys.select do |key|
+        !@dependencies.has_key?(key) && !self.class.dependencies.fetch(key).has_key?(:default)
       end
     end
 
     def resolve_dependency(name)
-      self.class.dependencies.fetch(name).fetch(:default)
+      typecast_dependency(self.class.dependencies.fetch(name).fetch(:default))
+    end
+
+    def typecast_dependency(dependency)
+      case dependency.class.name
+      when 'String' then
+        Inflecto.constantize(Inflecto.camelize(dependency))
+      when 'Symbol' then
+        typecast_dependency(dependency.to_s)
+      when 'Proc' then
+        dependency.call
+      else
+        dependency
+      end
     end
 
     module ClassMethods
+      def dependencies
+        @dependencies ||= {}
+      end
+
+      private
+
       def dependency(name, options = {})
         dependencies[name] = options
       end
 
-      def dependencies
-        @dependencies ||= {}
+      def inherited(subclass)
+        subclass.instance_variable_set("@dependencies", @dependencies)
+        super
       end
     end
   end

data/medicine.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |spec|
   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_dependency 'inflecto'
 end

data/spec/medicine_spec.rb

@@ -1,90 +1,165 @@
 RSpec.describe 'Medicine' do
-  let(:klass) do
+  let(:medicated_class) { new_medicated_class }
+
+  def new_medicated_class
     Class.new do
       include Medicine.di
+
+      # access to otherwise private method
+      def _vote_repo
+        vote_repo
+      end
     end
   end
 
-  describe '.dependency' do
+  describe 'dependency declarations' do
+    it 'survive inheritence' do
+      medicated_class.class_eval { dependency :foobar }
 
-    describe 'without any options' do
-      before { klass.class_eval { dependency :vote_repo } }
+      super_medicated_class = Class.new(medicated_class)
+      expect(super_medicated_class.dependencies).not_to be_empty
+    end
 
-      context 'initialized with no arguments' do
-        subject { klass.new }
+    it 'do not leak between unrelated classes' do
+      medicated_class.class_eval { dependency :foobar }
 
-        it 'initialization raises error' do
-          expect { subject }.to raise_error(Medicine::DI::ArgumentError)
-        end
+      expect(medicated_class.dependencies).not_to be_empty
+      expect(new_medicated_class.dependencies).to be_empty
+    end
+  end
+
+  describe 'dependency declared without any options' do
+    before { medicated_class.class_eval { dependency :vote_repo } }
+
+    context 'and subject initialized with no arguments' do
+      subject { medicated_class.new }
+
+      it 'raises exception' do
+        expect { subject }.to raise_error(Medicine::RequiredDependencyError)
       end
+    end
+
+    context 'and subject initalized with hash' do
+      subject { medicated_class.new(vote_repo: :foo) }
 
-      context 'when initalized with hash' do
-        subject { klass.new(vote_repo: :foo) }
+      context 'and hash has key for dependency' do
+        it 'provides a private method' do
+          expect(subject.respond_to?(:vote_repo, true)).to be_truthy
+        end
 
-        context 'and hash has key for dependency' do
-          it 'responds to dependency name' do # TODO: method should be private
-            expect(subject).to respond_to(:vote_repo)
-          end
+        it 'does not provide a public method' do
+          expect(subject).not_to respond_to(:vote_repo)
+        end
 
-          it 'provides method which returns injected value' do
-            expect(subject.vote_repo).to eq :foo
-          end
+        it 'provides method which returns injected value' do
+          expect(subject._vote_repo).to eq :foo
         end
+      end
 
-        context 'hash has no key for dependency' do
-          subject { klass.new({}) }
+      context 'and hash has no key for dependency' do
+        subject { medicated_class.new({}) }
 
-          it 'raises error' do
-            expect { subject }.to raise_error(Medicine::DI::ArgumentError)
-          end
+        it 'raises exception' do
+          expect { subject }.to raise_error(Medicine::RequiredDependencyError)
         end
       end
+    end
+  end
+
+  context 'and subject initialized with no arguments' do
 
-      context 'initalized with arguments and hash' do
-        before do
-          klass.class_eval do
-            def initialize(arg1, arg2, deps)
-              super
-            end
-          end
+    subject { medicated_class.new }
+
+    before do
+      Foo  = Class.new unless defined?(Foo)
+      Foos = Class.new unless defined?(Foos)
+    end
+
+    describe 'and dependency declared with default option' do
+
+      describe 'as a class' do
+        before { medicated_class.class_eval { dependency :vote_repo, default: Foo } }
+
+        it 'returns a class' do
+          expect(subject._vote_repo).to eq Foo
         end
+      end
 
-        context 'and hash has key for dependency' do
-          subject { klass.new(double, double, vote_repo: :foo) }
+      describe 'as a lambda' do
+        before { medicated_class.class_eval { dependency :vote_repo, default: -> { Foo } } }
 
-          skip 'provides method for dependency' do
-            expect(subject).to respond_to(:vote_repo)
-          end
+        it 'returns a class' do
+          expect(subject._vote_repo).to eq Foo
         end
+      end
 
-        context 'hash has no key for dependency' do
-          subject { klass.new(double, double, {}) }
+      describe 'as a Proc' do
+        before { medicated_class.class_eval { dependency :vote_repo, default: Proc.new { Foo } } }
 
-          skip 'raises error' do
-            expect { subject }.to raise_error(Medicine::DI::ArgumentError)
-          end
+        it 'returns a class' do
+          expect(subject._vote_repo).to eq Foo
+        end
+      end
+
+      describe 'as a CamelCase String' do
+        before { medicated_class.class_eval { dependency :vote_repo, default: 'Foo' } }
+
+        it 'returns a class' do
+          expect(subject._vote_repo).to eq Foo
         end
       end
-    end
 
-    describe 'with default option' do
-      describe 'of type String' do
-        before { klass.class_eval { dependency :vote_repo, default: 'Object' } }
+      describe 'as a plural CamelCase String' do
+        before { medicated_class.class_eval { dependency :vote_repo, default: 'Foos' } }
 
-        context 'and initializer given no arguments' do
+        it 'returns a class' do
+          expect(subject._vote_repo).to eq Foos
+        end
+      end
+
+      describe 'as a CamelCase Symbol' do
+        before { medicated_class.class_eval { dependency :vote_repo, default: :Foo} }
 
-          subject { klass.new }
+        it 'returns a class' do
+          expect(subject._vote_repo).to eq Foo
+        end
+      end
 
-          it 'responds to dependency name' do
-            expect(subject).to respond_to(:vote_repo)
-          end
+      describe 'as a lowercase Symbol' do
+        before { medicated_class.class_eval { dependency :vote_repo, default: :foo} }
 
-          it 'returns given default typecast to a class' do
-            expect(subject.vote_repo).to be_an_instance_of(Object)
-          end
+        it 'returns a class' do
+          expect(subject._vote_repo).to eq Foo
         end
       end
     end # with default option
+  end # initialized with no arguments
 
-  end # .dependency
+  describe 'inclusion of module' do
+    it 'can be included' do
+      klass = Class.new { include Medicine.di }
+      expect(klass).to respond_to(:dependencies)
+    end
+
+    it 'can be prepended' do
+      klass = Class.new { prepend Medicine.di }
+      expect(klass).to respond_to(:dependencies)
+    end
+  end
+
+  describe 'object initialization' do
+    it 'zsuper is called' do
+      klass = Class.new do
+        prepend Medicine.di
+
+        attr_reader :initalize_reached
+
+        def initialize(*args)
+          @initalize_reached = true
+        end
+      end
+
+      expect(klass.new.initalize_reached).to be_truthy
+    end
+  end
 end # rspec

data/spec/spec_helper.rb

@@ -1,4 +1,11 @@
-require 'pry'
+require 'coveralls'
+Coveralls.wear!
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
 require 'medicine'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: medicine
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
-dependencies: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple Dependency Injection for Ruby. Find yourself passing dependencies
   in to the initalizer? Medicine makes this declarative.
 email:
@@ -21,6 +35,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -58,3 +74,4 @@ summary: Simple Dependency Injection for Ruby
 test_files:
 - spec/medicine_spec.rb
 - spec/spec_helper.rb
+has_rdoc: