ruse 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed5777f12733b8e7e6ed8fc9711354f77b93db58
+  data.tar.gz: 62796162f3a934ff9668cc39f029b7bb6b58947f
+SHA512:
+  metadata.gz: f5a5251bc60259ea099c2cf2f5402f8dd2b642c8b0ae736305ecfc71e28398ac911b6e68c3e017f9267ab7b1b3da5974f563d3f784ff55496e37fd4ab08fdbd1
+  data.tar.gz: 1a1a86387be403adfa675b87b9d0b91f3ea401939da9bd8937dddec6c4a34d3cca3948e86f4bc228f0d98e92ab9244869dcc04850542140b4cbb9768203ceb06

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Flanagan
+
+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,120 @@
+# Ruse
+
+Ruse is a low friction dependency injection tool for ruby.
+
+It was inspired by the injector in [angular.js](http://docs.angularjs.org/guide/di)
+(and so, transitively, [Guice](https://code.google.com/p/google-guice/)).
+
+## Usage
+
+Create an injector at the top level of your application:
+
+```ruby
+  injector = Ruse.create_injector
+```
+
+Retrieve instances via that injector:
+
+```ruby
+  command = injector.get :create_order_command
+  #=> #<CreateOrderCommand:0x00000105cbea70>
+```
+
+## Example
+
+Suppose you have a command that collaborates with a notifier service:
+
+```ruby
+class CreateOrderCommand
+  def execute(customer, order_details)
+    save_order(order_details)
+    notifier.notify(customer)
+  end
+
+  def notifier
+    @notifier ||= Notifier.new
+  end
+end
+
+class Notifier
+  def notify(customer)
+    # send a notification to customer
+  end
+end
+```
+
+That `CreateOrderCommand` class is now tightly coupled to the `Notifier` class.
+It has to know how to construct the Notifier. You would have to change
+`CreateOrderCommand` to use a different notifier service.
+
+You can improve the class by using dependency injection:
+
+
+```ruby
+class CreateOrderCommand
+  def initialize(notifier)
+    @notifier = notifier
+  end
+
+  def execute(customer, order_details)
+    save_order(order_details)
+    @notifier.notify(customer)
+  end
+end
+```
+
+The `CreateOrderCommand` class is now open for extension, but closed for
+modification.  It can use a different notifier service, without any changes.
+It also does not need to know how to construct a `Notifier` instance, which is
+really important if `Notifier` has its own dependencies.
+
+You have now passed the burden of creating and configuring the
+`CreateOrderCommand`, the `Notifier`, and any of its dependencies on to the
+caller. This is where an Inversion of Control/Dependency Injection tool becomes
+valuable:
+
+```ruby
+  command = injector.get "CreateOrderCommand"
+```
+
+The tool did the tedious work of identifying and populating the dependencies,
+all the way down the object graph.
+
+## Instance Resolution
+
+Dependencies are determined by the identifiers used in constructure parameters.
+This was lifted directly from angular.js, and I believe may be the key to
+reducing the overhead in using a tool like this. Your dependency consuming
+classes do not have to be annotated or registered in any way.
+
+In this early alpha state, identifiers are resolved to types through simple
+string manipulation (similiar to ActiveSupport's `classify` and `constantize`).
+That means you can get an instance of `SomeService` by requesting
+`"SomeService"`, `"some_service"` or `:some_service`.
+
+In the future, I can imagine a simple configuration mechanism that lets you
+resolve an identifier to some other type, so `"notifier"` resolves to
+`EmailNotifier`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruse'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruse
+
+
+## Contributing
+
+1. [Fork it](http://github.com/joshuaflanagan/ruse/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['specs/*_spec.rb']
+  t.verbose = true
+end

data/lib/ruse.rb

@@ -0,0 +1,8 @@
+require "ruse/injector"
+require "ruse/version"
+
+module Ruse
+  def self.create_injector
+    Ruse::Injector.new
+  end
+end

data/lib/ruse/injector.rb

@@ -0,0 +1,32 @@
+module Ruse
+  class Injector
+    def get(identifier)
+      type = resolve_type identifier
+      args = resolve_dependencies type
+      type.new *args
+    end
+
+    def resolve_type(identifier)
+      type_name = classify(identifier)
+      unless Object.const_defined?(type_name)
+        raise UnknownServiceError.new(type_name)
+      end
+      Object.const_get type_name
+    end
+
+    def resolve_dependencies(type)
+      type.instance_method(:initialize).parameters.map{|_, identifier|
+        get identifier
+      }
+    end
+
+    def classify(term)
+      # lifted from active_support gem: lib/active_support/inflector/methods.rb
+      string = term.to_s
+      string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+      string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{ $2.capitalize}" }.gsub('/', '::')
+    end
+  end
+
+  class UnknownServiceError < StandardError; end
+end

data/lib/ruse/version.rb

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

data/ruse.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruse"
+  spec.version       = Ruse::VERSION
+  spec.authors       = ["Joshua Flanagan"]
+  spec.email         = ["joshuaflanagan@gmail.com"]
+  spec.summary       = %q{Ruse}
+  spec.description   = %q{Ruse}
+  spec.homepage      = "https://github.com/joshuaflanagan/ruse"
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/specs/injector_spec.rb

@@ -0,0 +1,44 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'ruse/injector'
+
+describe Ruse::Injector do
+  it "retrieves an instance it can infer from an identifier" do
+    injector = Ruse::Injector.new
+    injector.get("SomeService").must_be_instance_of(SomeService)
+  end
+
+  it "raises UnknownServiceError for an identifier it cannot resolve" do
+    injector = Ruse::Injector.new
+    ->{
+      injector.get("cannot_be_resolved")
+    }.must_raise(Ruse::UnknownServiceError)
+  end
+
+  it "populates dependencies for the instance it retrieves" do
+    injector = Ruse::Injector.new
+    instance = injector.get("ServiceConsumer")
+    instance.must_be_instance_of(ServiceConsumer)
+    instance.service1.must_be_instance_of(SomeService)
+    instance.service2.must_be_instance_of(OtherService)
+  end
+
+  class SomeService; end
+  class OtherService; end
+
+  class ServiceConsumer
+    attr_reader :service1, :service2
+    def initialize(some_service, other_service)
+      @service1 = some_service
+      @service2 = other_service
+    end
+  end
+end
+
+# classify will be moved
+describe "classify" do
+  it "converts an underscored_term to PascalCase" do
+    resolver = Ruse::Injector.new
+    resolver.classify("camel_case").must_equal("CamelCase")
+  end
+end

data/specs/ruse_spec.rb

@@ -0,0 +1,9 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'ruse'
+
+describe Ruse do
+  it "can create an injector" do
+    Ruse.create_injector.must_be_kind_of Ruse::Injector
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: ruse
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joshua Flanagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruse
+email:
+- joshuaflanagan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruse.rb
+- lib/ruse/injector.rb
+- lib/ruse/version.rb
+- ruse.gemspec
+- specs/injector_spec.rb
+- specs/ruse_spec.rb
+homepage: https://github.com/joshuaflanagan/ruse
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Ruse
+test_files: []