dry-container 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dc623285b4e64816e0bea0c4668ab012291e234
+  data.tar.gz: 8fa2abd26fa7064d7765cc7cc27a75e01190888b
+SHA512:
+  metadata.gz: c2dfecb1010dc1a4325ca8dd6842d157a127427895802fe133b41c6bb7ff2605a059be69a78a7d5bd7a0c11e96202d2ad7f42c39a0017cedb29b5c6d68fe8d31
+  data.tar.gz: 006d27b613370ba76c9d0301286cf7038c8141afe7d3f4c5f835245c1e68ae76aff2b6a70e82c0b5452ad79e6623b166e5b0e2880c147afdf8b495ce9c6a81c2

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+coverage
+/.bundle
+vendor/bundle
+bin/
+tmp/
+.idea/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/*.rake

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-10 01:03:27 +0100 using RuboCop version 0.26.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without console
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :tools do
+  gem 'rubocop'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ruby Object Mapper
+
+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.
+s

data/README.md

@@ -0,0 +1,75 @@
+# dry-container <a href="https://gitter.im/dryrb/chat" target="_blank">![Join the chat at https://gitter.im/dryrb/chat](https://badges.gitter.im/Join%20Chat.svg)</a>
+
+<a href="https://rubygems.org/gems/dry-container" target="_blank">![Gem Version](https://badge.fury.io/rb/dry-container.svg)</a>
+<a href="https://travis-ci.org/dryrb/dry-container" target="_blank">![Build Status](https://travis-ci.org/dryrb/dry-container.svg?branch=master)</a>
+<a href="http://inch-ci.org/github/dryrb/dry-container" target="_blank">![Inline docs](http://inch-ci.org/github/dryrb/dry-container.svg?branch=master&style=flat)</a>
+
+A simple IoC container implemented in Ruby
+
+## Synopsis
+
+```ruby
+User = Struct.new(:name, :email)
+
+data_store = ThreadSafe::Cache.new.tap do |ds|
+  ds[:users] = ThreadSafe::Array.new
+end
+
+# Initialize container
+container = Dry::Container.new
+
+# Register an item with the container to be resolved later
+container.register(:data_store, data_store)
+container.register(:user_repository, -> { container.resolve(:data_store)[:users] })
+
+# Resolve an item from the container
+container.resolve(:user_repository) << User.new('Jack', 'jack@dry-container.com')
+# You can also resolve with []
+container[:user_repository] << User.new('Jill', 'jill@dry-container.com')
+# => [
+#      #<struct User name="Jack", email="jack@dry-container.com">,
+#      #<struct User name="Jill", email="jill@dry-container.com">
+#    ]
+
+# If you wish to register an item that responds to call but don't want it to be
+# called when resolved, you can use the options hash
+container.register(:proc, -> { :result }, call: false)
+container.resolve(:proc)
+# => #<Proc:0x007fa75e652c98@(irb):25 (lambda)>
+
+# You can also register using a block
+container.register(:item) do
+  :result
+end
+container.resolve(:item)
+# => :result
+
+container.register(:block, call: false) do
+  :result
+end
+container.resolve(:block)
+# => #<Proc:0x007fa75e6830f0@(irb):36>
+```
+
+You can also get container behaviour at both the class and instance level via the mixin:
+
+```ruby
+class Container
+  extend Dry::Container::Mixin
+end
+Container.register(:item, :my_item)
+Container.resolve(:item)
+# => :my_item
+
+class ContainerObject
+  include Dry::Container::Mixin
+end
+container = ContainerObject.new
+container.register(:item, :my_item)
+container.resolve(:item)
+# => :my_item
+```
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs in spec directory'
+RSpec::Core::RakeTask.new(:spec)

data/dry-container.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require File.expand_path('../lib/dry/container/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-container'
+  spec.version       = Dry::Container::VERSION
+  spec.authors       = ['Andy Holland']
+  spec.email         = ['andyholland1991@aol.com']
+  spec.summary       = 'A simple container intended for use as an IoC container'
+  spec.homepage      = 'https://github.com/dryrb/dry-container'
+  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_runtime_dependency 'thread_safe'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/dry/container.rb

@@ -0,0 +1,29 @@
+require 'thread_safe'
+require 'dry/container/error'
+require 'dry/container/item'
+require 'dry/container/mixin'
+require 'dry/container/version'
+
+module Dry
+  # Inversion of Control (IoC) container
+  #
+  # @example
+  #
+  #   container = Dry::Container.new
+  #   container.register(:item, 'item')
+  #   container.resolve(:item)
+  #   => 'item'
+  #
+  #   container.register(:item1, -> { 'item' })
+  #   container.resolve(:item1)
+  #   => 'item'
+  #
+  #   container.register(:item2, -> { 'item' }, call: false)
+  #   container.resolve(:item2)
+  #   => #<Proc:0x007f33b169e998@(irb):10 (lambda)>
+  #
+  # @api public
+  class Container
+    include Mixin
+  end
+end

data/lib/dry/container/error.rb

@@ -0,0 +1,6 @@
+module Dry
+  class Container
+    # @api public
+    class Error < StandardError; end
+  end
+end

data/lib/dry/container/item.rb

@@ -0,0 +1,25 @@
+module Dry
+  class Container
+    # Container class
+    #
+    # @private
+    class Item
+      attr_reader :item, :options
+
+      def initialize(item, options = {})
+        @item = item
+        @options = {
+          call: item.is_a?(::Proc)
+        }.merge(options)
+      end
+
+      def call
+        if options[:call] == true
+          item.call
+        else
+          item
+        end
+      end
+    end
+  end
+end

data/lib/dry/container/mixin.rb

@@ -0,0 +1,111 @@
+module Dry
+  class Container
+    # Mixin to expose Inversion of Control (IoC) container behaviour
+    #
+    # @example
+    #
+    #   class MyClass
+    #     extend Dry::Container::Mixin
+    #   end
+    #
+    #   MyClass.register(:item, 'item')
+    #   MyClass.resolve(:item)
+    #   => 'item'
+    #
+    #   class MyObject
+    #     include Dry::Container::Mixin
+    #   end
+    #
+    #   container = MyObject.new
+    #   container.register(:item, 'item')
+    #   container.resolve(:item)
+    #   => 'item'
+    #
+    #
+    # @api public
+    module Mixin
+      # @private
+      def self.extended(base)
+        base.instance_variable_set(:@_mutex, Mutex.new)
+      end
+      # @private
+      def self.included(base)
+        base.send(:define_method, :initialize) do |*args, &block|
+          @_mutex = Mutex.new
+          super(*args, &block)
+        end
+      end
+      # Register an item with the container to be resolved later
+      #
+      # @param [Mixed] key
+      #   The key to register the container item with (used to resolve)
+      # @param [Mixed] contents
+      #   The item to register with the container (if no block given)
+      # @param [Hash] options
+      # @option options [Symbol] :call
+      #   Whether the item should be called when resolved
+      # @yield
+      #   If a block is given, contents will be ignored and the block
+      #   will be registered instead
+      #
+      # @raise [Dry::Conainer::Error]
+      #   If an item is already registered with the given key
+      #
+      # @return [Dry::Container] self
+      #
+      # @api public
+      def register(key, contents = nil, options = {}, &block)
+        if block_given?
+          item = block
+          options = contents if contents.is_a?(::Hash)
+        else
+          item = contents
+        end
+
+        if _container.key?(key)
+          fail Error, "There is already an item registered with the key #{key.inspect}"
+        else
+          _container[key] = Item.new(item, options)
+        end
+
+        self
+      end
+      # Resolve an item from the container
+      #
+      # @param [Mixed] key
+      #   The key for the item you wish to resolve
+      #
+      # @raise [Dry::Conainer::Error]
+      #   If the given key is not registered with the container
+      #
+      # @return [Mixed]
+      #
+      # @api public
+      def resolve(key)
+        item = _container.fetch(key) do
+          fail Error, "Nothing registered with the key #{key.inspect}"
+        end
+
+        item.call
+      end
+      # Resolve an item from the container
+      #
+      # @param [Mixed] key
+      #   The key for the item you wish to resolve
+      #
+      # @return [Mixed]
+      #
+      # @api public
+      def [](key)
+        resolve(key)
+      end
+
+      private
+
+      # @private
+      def _container
+        @_mutex.synchronize { @_container ||= ThreadSafe::Cache.new }
+      end
+    end
+  end
+end

data/lib/dry/container/version.rb

@@ -0,0 +1,6 @@
+module Dry
+  class Container
+    # @api public
+    VERSION = '0.1.0'.freeze
+  end
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require 'rubocop/rake_task'
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << '--display-cop-names'
+  end
+
+  namespace :rubocop do
+    desc 'Generate a configuration file acting as a TODO list.'
+    task :auto_gen_config do
+      exec 'bundle exec rubocop --auto-gen-config'
+    end
+  end
+
+rescue LoadError
+end

data/spec/integration/container_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Dry::Container do
+  let(:container) { Dry::Container.new }
+
+  it_behaves_like 'a container'
+end

data/spec/integration/mixin_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Dry::Container::Mixin do
+  describe 'extended' do
+    let(:container) do
+      Class.new { extend Dry::Container::Mixin }
+    end
+
+    it_behaves_like 'a container'
+  end
+
+  describe 'included' do
+    let(:container) do
+      Class.new { include Dry::Container::Mixin }.new
+    end
+
+    it_behaves_like 'a container'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'dry/container'
+
+Dir[Pathname(__FILE__).dirname.join('support/**/*.rb').to_s].each do |file|
+  require file
+end

data/spec/support/shared_examples/container.rb

@@ -0,0 +1,76 @@
+shared_examples 'a container' do
+  describe 'registering a block' do
+    context 'without options' do
+      it 'registers and resolves an object' do
+        container.register(:item) { 'item' }
+
+        expect(container.resolve(:item)).to eq('item')
+      end
+    end
+
+    context 'with option call: false' do
+      it 'registers and resolves a proc' do
+        container.register(:item, call: false) { 'item' }
+
+        expect(container.resolve(:item).call).to eq('item')
+        expect(container[:item].call).to eq('item')
+      end
+    end
+  end
+
+  describe 'registering a proc' do
+    context 'without options' do
+      it 'registers and resolves an object' do
+        container.register(:item, proc { 'item' })
+
+        expect(container.resolve(:item)).to eq('item')
+        expect(container[:item]).to eq('item')
+      end
+    end
+
+    context 'with option call: false' do
+      it 'registers and resolves a proc' do
+        container.register(:item, proc { 'item' }, call: false)
+
+        expect(container.resolve(:item).call).to eq('item')
+        expect(container[:item].call).to eq('item')
+      end
+    end
+  end
+
+  describe 'registering an object' do
+    context 'without options' do
+      it 'registers and resolves the object' do
+        item = 'item'
+        container.register(:item, item)
+
+        expect(container.resolve(:item)).to be(item)
+        expect(container[:item]).to be(item)
+      end
+    end
+
+    context 'with option call: false' do
+      it 'registers and resolves an object' do
+        item = -> { 'test' }
+        container.register(:item, item, call: false)
+
+        expect(container.resolve(:item)).to eq(item)
+        expect(container[:item]).to eq(item)
+      end
+    end
+  end
+
+  describe 'registering with the same key multiple times' do
+    it do
+      container.register(:item, proc { 'item' })
+
+      expect { container.register(:item, proc { 'item' }) }.to raise_error(Dry::Container::Error)
+    end
+  end
+
+  describe 'resolving with a key that has not been registered' do
+    it do
+      expect { container.resolve(:item) }.to raise_error(Dry::Container::Error)
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: dry-container
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Holland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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'
+description: 
+email:
+- andyholland1991@aol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dry-container.gemspec
+- lib/dry/container.rb
+- lib/dry/container/error.rb
+- lib/dry/container/item.rb
+- lib/dry/container/mixin.rb
+- lib/dry/container/version.rb
+- rakelib/rubocop.rake
+- spec/integration/container_spec.rb
+- spec/integration/mixin_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/container.rb
+homepage: https://github.com/dryrb/dry-container
+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.6
+signing_key: 
+specification_version: 4
+summary: A simple container intended for use as an IoC container
+test_files:
+- spec/integration/container_spec.rb
+- spec/integration/mixin_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/container.rb