strudel 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjE1YjU5NGQwMGM2ZDVhN2Y4NzRjNWUxODJlYWM1NDdlNmIxNGM1Yg==
+  data.tar.gz: !binary |-
+    MjViNzIwNjY2ZmEzMWI3ZGIxMTEyZDFkZDJlYTdmYTVhYjI3YzZlYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ODI4ZjFmMDVhMzQwNTc1NjE0OGM2ZTMwMjE0NGIxNjE5NmVjZmUwNzk2MGUz
+    YzljMzVhMjA5NmI1NDA2M2M2YzdhZmFkNTAyMjA2MTdmMTI0ZmE0YTFkYzcx
+    YzY0ZGY4OTU2NTY1YTFkZWQ2OGJiMmViOTE4Y2JhNTAxYjdiNDM=
+  data.tar.gz: !binary |-
+    MTZiNjhlYTY0ZmMyZGFhNGU1NjQ4Mjc5YzgyYzM4YWJlNTI2OTVkM2M2ZmUz
+    N2MwY2Y5NWEyOTEyNmRmMjIwNWUwNDFjMjFiZjFmNWNhZTU3YTdlYmQzYjMy
+    MjlmYWI2MTZmZTE5M2QzZDQxMzgyNDU2YTc5MDFlYTEzYjQ5Y2I=

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/coverage/
+/doc/
+/vendor/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'vendor/**/*'
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: f1rTqFzMHA1DueBSv7YzFOHy6JxUuSwflvSL6TXG5v5bWs0c6KWi1LhY43pYnpoY3ZyDtFAGgKyvQvvFCvrTB0jQx2lFo2fbXD7LoT1ThX3GLYPvGO79ycUzmXlhNFOGPZo1V3iGb5xAo8ZOVSKNesFWivy81b9SEsL4alv1QUfd2iDs4GzGJMwMIQy758PY21vQhGFfKDXld4ei9cK3hCS4999MluWtjt624FTs9oKoMfzZHfBpMa4ml6oogM1CR3tY8OzjXK0T7nLTr7ykcIiQeJGEP5q8t/IPaDs2v5yPWHv6cm8v9gCewFnzgv0Kqp0CNidzO2OlS3JmOk8mwdKad7dwpm5TKeJp3d9od35vN7H5uYZdozjfiMI7jXsQa+cfsFWWMTf5uaD0hnJFu93AWC+8xxid+/cihcbY8GA2QjjslUNGKZ0/XsWAcE3MBVyBQLecjDWidyyNbgq/LB0lS8F+U9TKTkrNLqID/HsrGnDlA15NY2Kmz74wYs5tEpm5cJ6PLjaJ+vQ8RlgI6Vk+slExheF1bXoQZrGzdXh6G3ZdPxCKynQ7KUkpRfbpmK6NdAaIf2+B77BnpKRYmLcIkfARv2bugBx571IaN8duAz0JIJIWlubL96eJv7RzzRPrsr378OTjEpO8A+w3LyOprhHJ0MYkmeItMKQKl+k=
+  gem: strudel
+  on:
+    tags: true
+    repo: justinhoward/strudel
+addons:
+  code_climate:
+    repo_token:
+      secure: "fSiRB01llLIkzTLFuRHKDwTHJYelGo7+T4q1WZq9/qBuulCzIBUS0VdS7YyZIY0WVhrdhDUVIzNmESt3nGguL9By5TasrMi4HkdaL/WQPQnn/nH4vwkyOFex1mYa/lEmUnYW6fdVWvq9aS79P20zUCcK5EBFqmWZ/jTe7ssFV9u88QwR/NOa1gH8uabsBwefFlg8hKWi+G4DKRtNuOF0dGmiE6bG3VAKv/n16WRXIfyzFHDdNdrURJObHTEzEW7+Q7JNDRsuAcaSwGAWQtOC3RZmUKWfvIy33wJE+amIhL0GHhXJ3L2s1W/pSc/eiIMg1zsGJsbeUg2VdE4XFIRY9nRamXYtCl85IYct9P1nSB4mMXC1ezCN4fmYS0CBfsBJqzEw13mRf2G3qk65z5CYPHIdL0qZ2qHvRw2tz+EVShFk9mLd9g57KsbeGcq+7daOcSMVGo4ypEd/fx512kaWdUxzZQlEZ2YqIFFI3na4aC/dZmmSFdlghtSZCtYnxz/6ZzoHvx+9rZrcR3FNNB+A3TDGynRfmIZf1ZBqKBdbrocUZ4dODxaI7/82J+y3pFoS3bmb+8r8NevwPce/QwPTesU7hJ9iBMutGLJ0+A6WB4iBpBAwq0H7awKVkluCw/me8ZAD7Nwf8+SBjWCUXX87KbCG3niF+EtKjljgE3Q3cFk="

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Justin Howard
+
+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,124 @@
+# Strudel
+
+[![Build Status](https://travis-ci.org/justinhoward/strudel.svg?branch=master)]
+(https://travis-ci.org/justinhoward/strudel)
+[![Code Climate](https://codeclimate.com/github/justinhoward/strudel/badges/gpa.svg)]
+(https://codeclimate.com/github/justinhoward/strudel)
+[![Test Coverage](https://codeclimate.com/github/justinhoward/strudel/badges/coverage.svg)]
+(https://codeclimate.com/github/justinhoward/strudel/coverage)
+[![Inline docs](http://inch-ci.org/github/justinhoward/strudel.svg?branch=master&style=shields)]
+(http://inch-ci.org/github/justinhoward/strudel)
+
+Strudel is a dependency injection container for Ruby. It's a way to organize
+your Ruby application to take advantage of the [dependency inversion
+principle][ioc].
+
+## Why another DI framework?
+
+Strudel is not a framework. It's one class that serves as a container only. No
+auto-injection. That means no polluting your classes with garbage injection
+metaprogramming. You have full, explicit control over how your services
+are constructed.
+
+Honestly, you may not even need Strudel or any other DI library. If you are
+passing your dependencies through your class constructors, you're already doing
+dependency injection! Strudel simply helps you organize your services and
+dependencies in one place.
+
+## But Ruby Doesn't Need Dependency Injection!
+
+You may have read [this post][dhh] by David Heineimer Hansson. However he
+didn't address the primary benefit of DI, explicitly defining dependencies.
+I also happen to think that patching code at runtime for testing is a egregious
+anti-pattern.  In case you need more convincing, check out this
+[great post][piotr] by Piotr Solnica.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```sh
+gem 'strudel'
+```
+
+## Getting Started
+
+Fist create a new instance of `Strudel`.
+
+```ruby
+require 'strudel'
+app = Strudel.new
+```
+
+The methods you will use most often are `get` and `set`. These allow you to
+create and access services.
+
+```ruby
+# Set a static service
+app[:api_url] = 'http://example.com/api'
+
+# Set a shared service
+app.set(:api) do
+  RestApi.new(app[:api_url])
+end
+
+# Now we can access the api service
+app[:api].request
+```
+
+In this example, we set up and use an `api` service.
+
+- First we use the `[]=` method to create a static service called `api_url`.
+- Then we create a service called `api`. This time we pass a block into the
+  `set` method. This allows the service to be instantiated asynchronously. The
+  `RestApi` instance won't be created until we use it on the final line.
+- On the last line, we use the `[]` method to retrieve the instance of `RestApi`
+  and call a `request` method on it. Because of the way we defined the `api`
+  service, the `api.url` parameter will be passed into the `RestApi` constructor
+  when it is created.
+
+Once it's constructed, the `api` service will be cached, so if we call it again,
+Strudel will use the same instance of `RestApi`.
+
+See the API Documentation for more information or to learn about the other
+available methods:
+
+- `[]`
+- `[]=`
+- `set`
+- `factory`
+- `protect`
+- `extend`
+- `each`
+- `include?`
+
+## API Documentation
+
+API documentation can be found [inline][inline-docs], or you can generate HTML documentation
+with yard.
+
+```sh
+bin/rake yard
+```
+
+## Credits
+
+Strudel is a port of the JavaScript library [papaya] by [Justin Howard][justin].
+
+Papaya is originally inspired by [Pimple][pimple], a library for PHP by
+[Fabien Potencier][fabien].
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License][mit].
+
+[ioc]: https://en.wikipedia.org/wiki/Dependency_inversion_principle
+[dhh]: http://david.heinemeierhansson.com/2012/dependency-injection-is-not-a-virtue.html
+[piotr]: http://solnic.eu/2013/12/17/the-world-needs-another-post-about-dependency-injection-in-ruby.html
+[papaya]: https://github.com/justinhoward/papaya
+[justin]: https://github.com/justinhoward
+[pimple]: http://pimple.sensiolabs.org
+[fabien]: https://github.com/fabpot
+[mit]: http://opensource.org/licenses/MIT
+[inline-docs]: lib/strudel.rb

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+YARD::Rake::YardocTask.new
+
+task default: :check
+task check: [:rubocop, :spec]

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/bin/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yardoc")

data/bin/yri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yri")

data/lib/strudel.rb

@@ -0,0 +1,162 @@
+# Strudel
+#
+# A tiny dependency injection container
+class Strudel
+  # Creates a new Strudel container
+  #
+  # @yield [self]
+  def initialize
+    @services = {}
+    @procs = {}
+    @factories = {}
+    yield self if block_given?
+  end
+
+  # Get a service by key
+  #
+  # If the service is not set, returns +nil+.
+  #
+  # @param [key] key The service key
+  # @return [value, nil] The service or nil if not set
+  def [](key)
+    return @services[key].call(self) if @factories[key]
+
+    if @procs[key]
+      @services[key] = @services[key].call(self)
+      @procs.delete(key)
+    end
+
+    @services[key]
+  end
+
+  # Set a service by key and value
+  #
+  # If +service+ is a Proc, its return value will be treated as a
+  # singleton service meaning it will be initialized the first time it is
+  # requested and its valud will be cached for subsequent requests.
+  #
+  # Use the +set+ method to allow using a block instead of a Proc argument.
+  #
+  # If +service+ is not a function, its value will be stored directly.
+  #
+  # @param [key] key The service key
+  # @param [Proc, value] service The service singleton Proc or static service
+  # @return [self]
+  def []=(key, service)
+    set(key, service)
+  end
+
+  # Set a service by key and value
+  #
+  # Same as +[]=+ except allows passing a block instead of a Proc argument.
+  #
+  # @param [key] key The service key
+  # @param [Proc, value, nil] service The service singleton Proc or static
+  #   service
+  # @yield [self]
+  # @return [self]
+  def set(key, service = nil)
+    create(key, service || Proc.new, @procs)
+  end
+
+  # Set a factory service by key and value
+  #
+  # If +factory+ is a function, it will be called every time the service is
+  # requested. So if it returns an object, it will create a new object for
+  # every request.
+  #
+  # If +factory+ is not a function, this method acts like +set+.
+  #
+  # @param [key] key The service key
+  # @param [Proc, block] factory The service factory Proc or static service
+  # @yield [self]
+  # @return [self]
+  def factory(key, factory = nil)
+    create(key, factory || Proc.new, @factories)
+  end
+
+  # Set a protected service by name and value
+  #
+  # If +service+ is a function, the function itself will be registered as a
+  # service. So when it is requested with +get+, the function will be returned
+  # instead of the function's return value.
+  #
+  # If +service+ is not a function, this method acts like +set+.
+  #
+  # @param [key] key The service key
+  # @param [Proc, value, nil] service The service function.
+  # @yield [self]
+  # @return [self]
+  def protect(key, service = nil)
+    create(key, service || Proc.new)
+  end
+
+  # Extends an existing service and overrides it.
+  #
+  # The +extender+ block will be called with 2 arguments: +old_value+ and
+  # +self+. If there is no existing +key+ service, +old_value+ will be nil. It
+  # should return the new value for the service that will override the existing
+  # one.
+  #
+  # If +extend+ is called for a service that was created with +set+, the
+  # resulting service will be a singleton.
+  #
+  # If +extend+ is called for a service that was created with +factory+, the
+  # resulting service will be a factory.
+  #
+  # If +extend+ is called for a service that was created with +protect+, the
+  # resulting service will also be protected.
+  #
+  # If +extender+ is not a function, this method will override any existing
+  # service like +set+.
+  #
+  # @param [key] key The service key
+  # @param [Proc, value, nil] extender
+  # @yield [old_value, self]
+  # @return [self]
+  def extend(key, extender = nil)
+    extender ||= Proc.new
+    return set(key, extender) unless extender.is_a?(Proc) && @services.key?(key)
+
+    extended = @services[key]
+    call = @factories[key] || @procs[key]
+    send(@factories[key] ? :factory : :set, key) do
+      extender.call(self, call ? extended.call(self) : extended)
+    end
+  end
+
+  # Iterates over the service keys
+  #
+  # If a block is given, the block is called with each of the service keys
+  # If a block is not given, returns an +Enumerable+ of the keys.
+  #
+  # The key order is undefined.
+  #
+  # @yield [key] Gives the key
+  # @return [Enumerable, nil]
+  def each
+    return @services.each_key unless block_given?
+    @services.each_key { |key| yield key }
+  end
+
+  # Checks if a service for +key+ exists.
+  #
+  # @return [bool] True if the service exists.
+  def include?(key)
+    @services.key?(key)
+  end
+
+  private
+
+  # Create a service
+  #
+  # @param [key] key The service key
+  # @param [value] service The service value or factory
+  # @param [Hash] registry If the service is a proc, the registery
+  def create(key, service, registry = nil)
+    [@procs, @factories].each { |reg| reg.delete key }
+    registry[key] = true if registry && service.is_a?(Proc)
+    @services[key] = service
+    self
+  end
+end

data/strudel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name = 'strudel'
+  spec.version = '0.1.0'
+  spec.authors = ['Justin Howard']
+  spec.email = ['jmhoward0@gmail.com']
+
+  spec.summary = 'A tiny dependency injection container'
+  spec.homepage = 'https://github.com/justinhoward/strudel'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: strudel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jmhoward0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rake
+- bin/rspec
+- bin/yard
+- bin/yardoc
+- bin/yri
+- lib/strudel.rb
+- strudel.gemspec
+homepage: https://github.com/justinhoward/strudel
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A tiny dependency injection container
+test_files: []