medicine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19f0f8412a402f42bd7b0f91644a187d664e6e29
+  data.tar.gz: ec738b16e8c28da75bd08f4fa660aab74b33b6f7
+SHA512:
+  metadata.gz: 73d44fa17647302412a37d9055e8770c0505e5d7468fb30bd8499c6cca3b5df10722a4aaa1e9ce61cd858efdfc8903332413f20967980dde8b261211932e1856
+  data.tar.gz: d40fecb0a6d6d0af603fc698f959887fd5753a9fae779b2f533d5f5c5cc23e463952625b70943a5280232daf1efa7bfe56916fc9f76d8cbd78c1623fe0cfe04d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "bundler"
+gem "rake"
+gem "rspec"
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Leech
+
+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,72 @@
+# Medicine
+
+Simple Dependency Injection for Ruby
+
+Find yourself passing dependencies in to the initalizer? Medicine makes this
+declarative.
+
+```ruby
+class CastVote
+  include Medicine.di
+
+  dependency :votes_repo, default: -> { Vote }
+
+  def call(entry_id)
+    vote_repo.create!(entry_id: entry_id)
+  end
+end
+
+
+cast_vote = CastVote.new
+cast_vote.call(3)
+```
+
+In this example Medicine adds a private method called `vote_repo` which returns `Vote`.
+
+## Injecting a dependency
+
+```ruby
+vote_repo = double('VoteRepo')
+cast_vote = CastVote.new(vote_repo: vote_repo)
+
+# or
+
+cast_vote = CastVote.new(arg1, arg2, vote_repo: vote_repo)
+```
+
+## Required dependencies
+
+```ruby
+dependency :vote_repo
+```
+
+When no default is specified and is not injected an error will be raised on
+initialization.
+
+## Default dependencies
+
+```ruby
+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 
+`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/Rakefile

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

data/TODO

@@ -0,0 +1,12 @@
+# TODO
+
+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

data/lib/medicine/version.rb

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

data/lib/medicine.rb

@@ -0,0 +1,61 @@
+require "medicine/version"
+
+module Medicine
+  def self.di
+    DI
+  end
+
+  module DI
+    ArgumentError = Class.new(::ArgumentError)
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def initialize(*args)
+      @dependencies = extract_dependencies(args)
+      assert_all_dependencies_met
+      define_dependency_methods
+
+      super(*args)
+    end
+
+    private
+
+    def define_dependency_methods
+      self.class.dependencies.each do |name, options|
+        define_singleton_method name do
+          @dependencies.fetch(name) { resolve_dependency(name) }
+        end
+      end
+    end
+
+    def extract_dependencies(args)
+      args.last.respond_to?(:[]) ? args.pop : {}
+    end
+
+    def assert_all_dependencies_met
+      raise ArgumentError, "initalize with all dependencies without a default" unless all_dependencies_met?
+    end
+
+    def all_dependencies_met?
+      self.class.dependencies.keys.all? 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)
+    end
+
+    module ClassMethods
+      def dependency(name, options = {})
+        dependencies[name] = options
+      end
+
+      def dependencies
+        @dependencies ||= {}
+      end
+    end
+  end
+end

data/medicine.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'medicine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "medicine"
+  spec.version       = Medicine::VERSION
+  spec.authors       = ["Kris Leech"]
+  spec.email         = ["kris.leech@gmail.com"]
+  spec.summary       = "Simple Dependency Injection for Ruby"
+  spec.description   = "Simple Dependency Injection for Ruby. Find yourself passing dependencies in to the initalizer? Medicine makes this declarative."
+  spec.homepage      = "https://github.com/krisleech/medicine"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"]
+end

data/spec/medicine_spec.rb

@@ -0,0 +1,90 @@
+RSpec.describe 'Medicine' do
+  let(:klass) do
+    Class.new do
+      include Medicine.di
+    end
+  end
+
+  describe '.dependency' do
+
+    describe 'without any options' do
+      before { klass.class_eval { dependency :vote_repo } }
+
+      context 'initialized with no arguments' do
+        subject { klass.new }
+
+        it 'initialization raises error' do
+          expect { subject }.to raise_error(Medicine::DI::ArgumentError)
+        end
+      end
+
+      context 'when initalized with hash' do
+        subject { klass.new(vote_repo: :foo) }
+
+        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 '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({}) }
+
+          it 'raises error' do
+            expect { subject }.to raise_error(Medicine::DI::ArgumentError)
+          end
+        end
+      end
+
+      context 'initalized with arguments and hash' do
+        before do
+          klass.class_eval do
+            def initialize(arg1, arg2, deps)
+              super
+            end
+          end
+        end
+
+        context 'and hash has key for dependency' do
+          subject { klass.new(double, double, vote_repo: :foo) }
+
+          skip 'provides method for dependency' do
+            expect(subject).to respond_to(:vote_repo)
+          end
+        end
+
+        context 'hash has no key for dependency' do
+          subject { klass.new(double, double, {}) }
+
+          skip 'raises error' do
+            expect { subject }.to raise_error(Medicine::DI::ArgumentError)
+          end
+        end
+      end
+    end
+
+    describe 'with default option' do
+      describe 'of type String' do
+        before { klass.class_eval { dependency :vote_repo, default: 'Object' } }
+
+        context 'and initializer given no arguments' do
+
+          subject { klass.new }
+
+          it 'responds to dependency name' do
+            expect(subject).to respond_to(:vote_repo)
+          end
+
+          it 'returns given default typecast to a class' do
+            expect(subject.vote_repo).to be_an_instance_of(Object)
+          end
+        end
+      end
+    end # with default option
+
+  end # .dependency
+end # rspec

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'pry'
+require 'medicine'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: medicine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies: []
+description: Simple Dependency Injection for Ruby. Find yourself passing dependencies
+  in to the initalizer? Medicine makes this declarative.
+email:
+- kris.leech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- lib/medicine.rb
+- lib/medicine/version.rb
+- medicine.gemspec
+- spec/medicine_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/krisleech/medicine
+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: Simple Dependency Injection for Ruby
+test_files:
+- spec/medicine_spec.rb
+- spec/spec_helper.rb