service_provider 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in service_provider.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Johannes Tuchscherer
+
+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 @@
+![Build Status](https://secure.travis-ci.org/jtuchscherer/service_provider.png)
+
+# ServiceProvider
+
+Simple attempt to inject dependencies through method decorators (https://github.com/michaelfairley/method_decorators)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'service_provider'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service_provider
+
+## Usage
+Service provider comes with an automatic service provider, which registers every provided service under its name. You can specify your own service provider (see below).
+
+### Providing a service
+The class that provides a dependency has to extend the `ServiceProvider` module and to decorate its initialize method with the `Provides` decorator:
+
+```ruby
+class SquareService
+  extend ServiceProvider
+
+  +Provides
+  def initialize
+  end
+end  
+```
+The (suggested) name of the service provided defaults to the underscored class name, and can also be given as a parameter: `+Provides.new(:square_service)`. The standard service provider used will use this name as the name of the service. Custom service providers (see below) might not make use of this information.
+
+### Using a service
+The class that requires a service has to extend the `MethodDecorators` module and to decorate its initialize method with the `Requires` decorator. The argument passed into the `Requires` decorator will be the name of the instance variable that holds that service.
+
+```ruby
+class SquareSample
+  extend MethodDecorators
+
+  +Requires.new(:square_service)
+  def initialize
+  end
+
+  def do_work(num)
+    @square_service.square(num)
+  end
+end
+``` 
+
+After a service has been required it can be manually set on the object, through a setter for the instance variable, i.e. `square_service=`.
+
+### Using a custom service provider
+You might want to specify how services are provided when you have multiple classes that implement the same service or when you want to change the implementations completely, i.e. for tests. To do so, provide your own service provider and register it with `ServiceProvider`:
+
+```ruby
+class CustomServiceProvider
+  def provide(service_class, service_class_provided_service_name)
+    #how to store services
+  end
+
+  def get_service(service_name)
+    #how to retrieve services by name
+  end
+end
+
+ServiceProvider.provider_implementation = CustomServiceProvider.new
+```
+
+### Known limitatations and uglinesses
+- Each class has to have an empty constructor to put the MethodDecorators before it.
+- Provider has to extend the ServiceProvider, Requirer has to extend MethodDecorators
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) Johannes Tuchscherer
+
+Released under the MIT license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :rspec

data/lib/service_provider/method_decorators/provides.rb

@@ -0,0 +1,11 @@
+module ServiceProvider
+  module MethodDecorators
+    class Provides < MethodDecorator
+      attr_reader :service_name
+
+      def initialize(service_name = nil)
+        @service_name = service_name
+      end
+    end
+  end
+end

data/lib/service_provider/method_decorators/requires.rb

@@ -0,0 +1,23 @@
+module ServiceProvider
+  module MethodDecorators
+    class Requires < MethodDecorator
+      def initialize(service)
+        @service = service
+      end
+
+      def call(orig, this, *args, &blk)
+        orig.call(*args, &blk)
+        this.instance_variable_set("@#{@service.to_sym}", ServiceProvider.provider.get_service(@service.to_sym))
+        add_service_setter(this)
+        this
+      end
+
+      def add_service_setter(this)
+        service = @service
+        this.class.send(:define_method, "#{service}=") do |value|
+          instance_variable_set("@#{service}", value)
+        end
+      end
+    end
+  end
+end

data/lib/service_provider/provider/automatic.rb

@@ -0,0 +1,42 @@
+module ServiceProvider
+  module Provider
+    class Automatic
+      def self.add_service(requested_service_name, service_class)
+        service_name = requested_service_name ? requested_service_name.to_sym : underscore_string(service_class.name).to_sym
+        Services.instance.put service_name, service_class
+      end
+
+      def self.get_service(service_name)
+        Services.instance.get service_name
+      end
+
+      private
+      def self.underscore_string(class_name)
+        word = class_name.dup
+        word.gsub!(/::/, '/')
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+
+      class Services
+        include Singleton
+
+        def initialize
+          @services = {}
+          @service_constructors = {}
+        end
+
+        def put(service_name, service_class)
+          @service_constructors[service_name] = service_class
+        end
+
+        def get(service_name)
+          @services[service_name] ||= @service_constructors[service_name].new
+        end
+      end
+    end
+  end
+end

data/lib/service_provider/version.rb

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

data/lib/service_provider.rb

@@ -0,0 +1,58 @@
+require "service_provider/version"
+
+require "singleton"
+require "method_decorators"
+
+require "service_provider/method_decorators/requires"
+require "service_provider/method_decorators/provides"
+require "service_provider/provider/automatic"
+
+module ServiceProvider
+  def method_added(method_name)
+    super
+
+    decorators = MethodDecorator.current_decorators
+    return if decorators.empty?
+
+    provider_decorator = find_and_remove_provider_decorator!(decorators)
+    call_original_method_with_other_decorators(method_name, decorators)
+    add_provider_service_to_service_provider(provider_decorator.service_name) if provider_decorator
+  end
+
+  def self.provider
+    @provider ||= ServiceProvider::Provider::Automatic
+  end
+
+  def self.provider=(provider)
+    @provider = provider
+  end
+
+  private
+
+  def add_provider_service_to_service_provider(requested_service_name)
+    ServiceProvider.provider.add_service(requested_service_name, self)
+  end
+
+  def call_original_method_with_other_decorators(name, decorators)
+    original_method = instance_method(name)
+
+    define_method(name) do |*args, &blk|
+      decorated = ServiceProvider.decorate_callable(original_method.bind(self), decorators)
+      decorated.call(*args, &blk)
+    end
+  end
+
+  def find_and_remove_provider_decorator!(decorators)
+    provide_decorator_index = decorators.index { |decorator| decorator.is_a? Provides }
+    provide_decorator = provide_decorator_index ? decorators.delete_at(provide_decorator_index) : nil
+  end
+
+  def self.decorate_callable(orig, decorators)
+    decorators.reduce(orig) do |callable, decorator|
+      lambda { |*a, &b| decorator.call(callable, orig.receiver, *a, &b) }
+    end
+  end
+end
+
+Kernel.const_set(:Requires, ServiceProvider::MethodDecorators::Requires)
+Kernel.const_set(:Provides, ServiceProvider::MethodDecorators::Provides)

data/service_provider.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/service_provider/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Your Name"]
+  gem.email         = ["jtuchscherer@gmail.com"]
+  gem.description   = "DI for Ruby"
+  gem.summary       = "DI for Ruby"
+  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          = "service_provider"
+  gem.require_paths = ["lib"]
+  gem.version       = ServiceProvider::VERSION
+  
+  gem.add_dependency "method_decorators"
+  gem.add_development_dependency "rspec"
+end

data/spec/service_provider_spec.rb

@@ -0,0 +1,184 @@
+require "spec_helper"
+
+class SquareService
+  extend ServiceProvider
+
+  +Provides.new(:square_service)
+  def initialize
+  end
+
+  def square(num)
+    num * num
+  end
+end
+
+class PlusThreeService
+  extend ServiceProvider
+
+  +Provides.new(:plus_three_service)
+  def initialize
+  end
+
+  def plus3(num)
+    num + 3
+  end
+end
+
+class MinusTwoService
+  extend ServiceProvider
+
+  +Provides
+  def initialize
+  end
+
+  def minus2(num)
+    num - 2
+  end
+end
+
+class SuperMathService
+  extend ServiceProvider
+
+  +Requires.new(:square_service)
+  +Requires.new(:plus_three_service)
+  +Provides.new("super_math_service")
+  def initialize
+  end
+
+  def calculate(num)
+    @plus_three_service.plus3 @square_service.square(num)
+  end
+end
+
+describe ServiceProvider do
+  describe "providing a simple service" do
+    it "should work for one client using one service" do
+      class SquareSample
+        extend MethodDecorators
+
+        +Requires.new(:square_service)
+        def initialize
+        end
+
+        def do_work(num)
+          @square_service.square (num)
+        end
+      end
+
+      SquareSample.new.do_work(2).should == 4
+    end
+
+    it "should work when specifying the service as a string" do
+      class SquareSample
+        extend MethodDecorators
+
+        +Requires.new("square_service")
+        def initialize
+        end
+
+        def do_work(num)
+          @square_service.square (num)
+        end
+      end
+
+      SquareSample.new.do_work(2).should == 4
+    end
+    
+    it "should work when not specifying the service name" do
+      class SquareSample
+        extend MethodDecorators
+
+        +Requires.new("minus_two_service")
+        def initialize
+        end
+
+        def do_work(num)
+          @minus_two_service.minus2 (num)
+        end
+      end
+
+      SquareSample.new.do_work(4).should == 2
+    end
+
+    it "should work for one client using multiple service" do
+      class SquareSample
+        extend MethodDecorators
+
+        +Requires.new(:square_service)
+        +Requires.new(:plus_three_service)
+        def initialize
+        end
+
+        def do_work(num)
+          @plus_three_service.plus3 @square_service.square(num)
+        end
+      end
+
+      SquareSample.new.do_work(2).should == 7
+    end
+
+    it "should work for a client that requires a service which requires a service" do
+      class SuperMathSample
+        extend MethodDecorators
+
+        +Requires.new(:super_math_service)
+        def initialize
+        end
+
+        def do_work(num)
+          @super_math_service.calculate(num)
+        end
+      end
+
+      SuperMathSample.new.do_work(19).should == 364
+    end
+
+    it "should be possible to override the service by setting it explicitly" do
+      class SquareOverrideSample
+        extend MethodDecorators
+
+        +Requires.new(:square_service)
+        def initialize
+        end
+
+        def do_work(num)
+          @square_service.square (num)
+        end
+      end
+
+      square_service_mock = mock('SquareService', square: "square of a number")
+
+      square_override_sample = SquareOverrideSample.new
+      square_override_sample.square_service = square_service_mock
+      square_override_sample.do_work(2).should == "square of a number"
+    end
+
+    it "should be possible to override the service provider used" do
+      class SquareSample
+        extend MethodDecorators
+
+        +Requires.new(:square_service)
+        def initialize
+        end
+
+        def do_work(num)
+          @square_service.square (num)
+        end
+      end
+
+      square_service_mock = mock('SquareService', square: Math::PI)
+
+      service_provider_mock = mock('ServiceProvider')
+      service_provider_mock.stub(:add_service)
+      service_provider_mock.stub(:get_service).with(:square_service).and_return(square_service_mock)
+
+      ServiceProvider.provider = service_provider_mock
+
+      SquareSample.new.do_work(999).should == Math::PI
+
+      #cleanup
+      ServiceProvider.provider = nil
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "rspec"
+require "service_provider"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: service_provider
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Your Name
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_decorators
+  requirement: &70264872728480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70264872728480
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70264872728060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70264872728060
+description: DI for Ruby
+email:
+- jtuchscherer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/service_provider.rb
+- lib/service_provider/method_decorators/provides.rb
+- lib/service_provider/method_decorators/requires.rb
+- lib/service_provider/provider/automatic.rb
+- lib/service_provider/version.rb
+- service_provider.gemspec
+- spec/service_provider_spec.rb
+- spec/spec_helper.rb
+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.6
+signing_key: 
+specification_version: 3
+summary: DI for Ruby
+test_files:
+- spec/service_provider_spec.rb
+- spec/spec_helper.rb