pimple 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.rspec
+coverage
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Florian Mhun.
+
+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,83 @@
+# Pimple for Ruby
+
+This is the Ruby implementation of Pimple, originally a leightweight Dependancy Injection library written in PHP and created by Fabien Potencier.
+
+Refer to [the original documentation](http://pimple.sensiolabs.org/) for more details about Pimple, you could found better explanations on the topic.
+
+## Installation
+
+Install with RubyGems :
+
+```shell
+sudo gem install pimple
+```
+
+Then, create the container : 
+
+```ruby
+require 'pimple'
+container = Pimple.new
+``` 
+
+## Defining parameter
+
+```ruby
+container[:foo] = 'bar'
+container[:foo] # => bar
+```
+
+## Defining services
+
+Pimple is built to provide services on demand. Just wrap a return instance to pimple in a lambda and get your service later when you need its functionnalities.
+
+See that example to inject a redis client with some parameters:
+
+```ruby
+# Defining redis config in container as parameter before ...
+container[:redis_config] = {:host => 'localhost', :port => 6379}
+
+# Defining the redis client into Pimple
+container[:redis] = lambda { |c| Redis.new(c[:redis_config]) }
+
+# And get an instance
+container[:redis] # => #<Redis client v2.1.1 connected to redis://localhost:6379/0 (Redis v2.2.2)>
+```
+
+**Important!** : Each time you get a service by its key, Pimple will call your defined lambda and then return a new instance.
+
+## Defining shared services (Singleton like)
+
+Sometimes, you need to work with the same instance each time you access to your service. Use `share` method as shown as below :
+
+```ruby
+container[:session_storage] = container.share { Redis.new }
+```
+
+## Defining protected parameter (Wrap anonymous function as parameter)
+
+Anonymous functions (lambda) can be passed to the container to provide a method that make something. To ensure the lambda will be not evaluated as a service, you need to use `protect` method. Then, when you get the value from the container, you just have to to access the container value to automatically call the function. 
+Let me show you an example with a random function : 
+
+```ruby
+# First of all, we inject the random function
+container[:random] = container.protect { rand(100) }
+
+# ... and sometime in the future, we want a random number.
+# So we call the function from the container by its key
+container[:random] # => 12
+# ... and get another one later !
+container[:random] # => 48
+```
+
+## Extend services
+
+Not implemented
+
+# Contribute <3
+
+I'm sure this library can be improved by many ways. If you want to improve some stuff, feel free to send a pull-request with your changes. One condition, ensure to test and document your code ;).
+
+# License
+
+Released under the MIT License. View LICENSE file for details.
+Copyright (c) 2012 Florian Mhun.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => ['spec']
+task :test => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/lib/pimple.rb

@@ -0,0 +1,33 @@
+class Pimple < Hash
+  
+  VERSION = '0.0.1.alpha'
+  
+  def initialize(parameters={})
+    self.replace(parameters)
+  end
+  
+  def [](key)
+    obj = self.fetch key
+    obj.kind_of?(Proc) ? obj.call(self) : obj
+  rescue
+    raise KeyError, "Identifier \"#{key}\" is not defined."
+  end
+  
+  def protect
+    raise ArgumentError, "Missing block for protected function" unless block_given?
+    Proc.new { yield }
+  end
+  
+  def share
+    raise ArgumentError, "Missing block for shared service" unless block_given?
+    lambda do |c|
+      @object ||= yield(self)
+      @object
+    end
+  end
+  
+  def extend
+    # Not implemented yet
+  end
+  
+end

data/ruby-pimple.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), 'lib/pimple')
+
+Gem::Specification.new do |s|
+  s.name = "pimple"
+  s.version = Pimple::VERSION
+  s.authors = ["Florian Mhun"]
+  s.email = ["florian.mhun@gmail.com"]
+  s.homepage = "https://github.com/floommon/ruby-pimple"
+  s.description = s.summary = "A lightweight dependency injection container for Ruby"
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+	s.extra_rdoc_files = ['README.md']
+	s.license = 'MIT'
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rdoc"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/pimple_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Pimple do
+  
+  describe '.new' do
+    
+    it 'should be a type of Hash' do
+      Pimple.new.kind_of?(Hash).should be_true 
+    end
+    
+    it 'should initialize with parameters' do
+      params = { :redis_classname => 'Redis' }
+      Pimple.new(params)[:redis_classname].should == 'Redis'
+    end
+    
+  end
+  
+  describe '.[]' do
+    let(:container) { Pimple.new }
+    before { class Facebook; end; } # Simulate Facebook Api Client class
+    
+    it 'should inject service' do
+      container[:facebook] = lambda { |c| Facebook.new }
+      container[:facebook].class.should equal(Facebook)
+    end
+    
+    it 'should return a new instance each time the [](key) method is invoked' do
+      container[:facebook] = lambda { |c| Facebook.new }
+      container[:facebook].should_not equal(container[:facebook])
+    end
+    
+    it 'should raise KeyError if service not found' do
+      lambda { container[:notfound] }.should raise_error(KeyError)
+    end
+    
+  end
+  
+  describe '.protect' do
+    let(:container) { Pimple.new }
+    
+    it 'should define anonymous function as parameter' do
+      container[:lambda_param] = container.protect { rand(1000) }
+      container[:lambda_param].should_not equal(container[:lambda_param])
+    end
+    
+    it 'should define anonymous function as parameter by Proc.new way' do
+      container[:lambda_param] = Proc.new { rand(1000) }
+      container[:lambda_param].should_not equal(container[:lambda_param])
+    end
+    
+    it 'should raise ArgumentError when block is missing' do
+      lambda { container.protect }.should raise_error(ArgumentError)
+    end
+    
+  end
+  
+  describe '.share' do
+    let(:container) { Pimple.new }
+    before { class Facebook; end; } # Simulate Facebook Api Client class
+    
+    it 'should define shared (global) service' do
+      container[:facebook] = container.share { |c| Facebook.new }
+      container[:facebook].class.should equal(Facebook)
+    end
+    
+    it 'should get the same instance each time [](key) method is invoked' do
+       container[:facebook] = container.share { |c| Facebook.new }
+       container[:facebook].should equal(container[:facebook])
+    end
+    
+  end
+  
+  describe '.extend', :pending => true do
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_group 'Libraries', 'lib'
+end
+
+require 'pimple'
+
+RSpec.configure do |config|
+	config.filter_run_excluding :broken => true
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: pimple
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Florian Mhun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A lightweight dependency injection container for Ruby
+email:
+- florian.mhun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pimple.rb
+- ruby-pimple.gemspec
+- spec/pimple_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/floommon/ruby-pimple
+licenses:
+- MIT
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A lightweight dependency injection container for Ruby
+test_files:
+- spec/pimple_spec.rb
+- spec/spec_helper.rb