soar-dependency_container 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddd4ab593f8cf8ff50a0294a636b10ab02a8827b
+  data.tar.gz: 042ead91daba16add897f82b198c62e42c15c50c
+SHA512:
+  metadata.gz: f27caecf840cfe12484c6985e393b6bf7276a3c726f91b706538c0cae5d075882d874309b9fc5b9276c2c29fa01b26c92b134f8ff8b04fc1e4978c08a30eb79e
+  data.tar.gz: 6d67d2e349812239bc20c166fc879153d2eb8177a33a117957ca785dd37014b5ee952fdd2b646aaaf67cab8cbbb6279b330353fdaa8852c09bcffdbabe6adb9b

data/.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar/dependency_container/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar-dependency_container"
+  spec.version       = Soar::DependencyContainer::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{Dependency injection container}
+  spec.description   = %q{Dependency injection container compatible with the SOAR Ruby framework}
+  spec.homepage      = "https://github.com/hetznerZA/soar-dependency_container"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fabrique", "~> 1.0", ">= 1.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber", "~> 2.4"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rspec-expectations", "~> 3.3"
+end

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:2.3
+
+WORKDIR /usr/local/src
+
+ADD Gemfile .gemspec /usr/local/src/
+ADD lib/soar/dependency_container/version.rb /usr/local/src/lib/soar/dependency_container/
+RUN bundle install
+
+ADD . /usr/local/src/
+
+CMD bundle exec rake

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+# Soar::DependencyInjector
+
+Dependency injection container compatible with the SOAR Ruby framework.
+
+The first intended provider is a thing wrapper around a [fabrique](https://github.com/starjuice/fabrique)
+[YamlBeanFactory](http://www.rubydoc.info/gems/fabrique/Fabrique/YamlBeanFactory).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar-dependency_injector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar-dependency_injector
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hetznerZA/soar-dependency_injector.
+

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :test
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Test the included providers"
+task :test => ["test:includes", "test:stub", "test:fabrique"]
+
+namespace :test do
+
+  desc "Test the stub provider"
+  task :stub => :spec do
+
+    sh %{TEST_ORCHESTRATION_PROVIDER=stub bundle exec cucumber}
+  end
+
+  desc "Test the fabrique provider"
+  task :fabrique => :spec do
+
+    sh %{TEST_ORCHESTRATION_PROVIDER=fabrique bundle exec cucumber}
+  end
+
+  desc "Test includes"
+  task :includes do
+    sh %{cd lib && for i in soar/dependency_container.rb $(find soar/dependency_container -name '*.rb'); do
+           i=${i%.rb}
+           ruby -e '$LOAD_PATH.unshift("."); '"require '$i'; "'exit 0' || break
+         done}
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soar/dependency_injector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/dockerized-test

@@ -0,0 +1,4 @@
+#!/bin/sh -e
+
+docker build --tag soar-dependency_container .
+docker run --rm soar-dependency_container

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/soar/dependency_container.rb

@@ -0,0 +1,13 @@
+require "soar/dependency_container/base"
+require "soar/dependency_container/hash_proxy"
+require "soar/dependency_container/errors"
+require "soar/dependency_container/legacy_injector"
+require "soar/dependency_container/version"
+
+module Soar
+
+  module DependencyContainer
+
+  end
+
+end

data/lib/soar/dependency_container/base.rb

@@ -0,0 +1,24 @@
+module Soar
+
+  module DependencyContainer
+
+    class Base
+
+      def initialize(provider)
+        raise ArgumentError.new("Missing argument :provider") unless provider
+        @provider = provider
+      end
+
+      def get_dependency(name)
+        @provider.get_dependency(name) or raise MissingDependencyError.new("Missing dependency: #{name}")
+      end
+
+      def list_dependencies
+        @provider.list_dependencies
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/errors.rb

@@ -0,0 +1,14 @@
+module Soar
+
+  module DependencyContainer
+
+    class Error < RuntimeError
+
+    end
+
+    class MissingDependencyError < Error
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/hash_proxy.rb

@@ -0,0 +1,23 @@
+module Soar
+
+  module DependencyContainer
+
+    class HashProxy
+
+      def initialize(dependency_container)
+        @dependency_container = dependency_container
+      end
+
+      def [](name)
+        @dependency_container.get_dependency(name)
+      end
+
+      def keys
+        @dependency_container.list_dependencies
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/legacy_injector.rb

@@ -0,0 +1,24 @@
+require "soar/dependency_container/provider/fabrique"
+
+module Soar
+
+  module DependencyContainer
+
+    class LegacyInjector
+
+      def inject_dependencies(configuration)
+        context = configuration["dependency_injector_config"]
+        if context
+          provider = Soar::DependencyContainer::Provider::Fabrique.new(context)
+          model = Soar::DependencyContainer::Base.new(provider)
+          HashProxy.new(model)
+        else
+          {}
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/provider/fabrique.rb

@@ -0,0 +1,35 @@
+require "fabrique"
+
+module Soar
+
+  module DependencyContainer
+
+    module Provider
+
+      class Fabrique
+
+        def initialize(config)
+          @fabrique = ::Fabrique::YamlBeanFactory.new(config)
+          @fabrique.load_gem_dependencies
+        end
+
+        def get_dependency(name)
+          begin
+            @fabrique.get_bean(name)
+          rescue ::Fabrique::MissingBeanError
+            # Soar::DependencyContainer::Base interprets nil as a missing dependency error
+            nil
+          end
+        end
+
+        def list_dependencies
+          @fabrique.registry.get_definitions.map(&:id)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/provider/stub.rb

@@ -0,0 +1,31 @@
+module Soar
+
+  module DependencyContainer
+
+    module Provider
+
+      class Stub
+
+        def initialize(dependencies)
+          @dependencies = dependencies
+        end
+
+        def get_dependency(name)
+          if @dependencies[name].is_a?(Proc)
+            @dependencies[name].call
+          else
+            @dependencies[name]
+          end
+        end
+
+        def list_dependencies
+          @dependencies.keys
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/test.rb

@@ -0,0 +1,3 @@
+require "soar/dependency_container/test/dependency_fixture"
+require "soar/dependency_container/test/orchestrator"
+require "soar/dependency_container/test/stub_orchestration_provider"

data/lib/soar/dependency_container/test/dependency_fixture.rb

@@ -0,0 +1,23 @@
+module Soar
+
+  module DependencyContainer
+
+    module Test
+
+      class DependencyFixture
+
+        attr_reader :created_at
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+          @created_at = Time.now
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/test/fabrique_orchestration_provider.rb

@@ -0,0 +1,75 @@
+require "soar/dependency_container/provider/fabrique"
+
+module Soar
+
+  module DependencyContainer
+
+    module Test
+
+      class FabriqueOrchestrationProvider
+
+        def get_dependency_container_config_with_no_dependencies
+          unindent %{
+            ---
+            beans: []
+          }
+        end
+
+        def get_dependency_container_config_with_singleton_dependency(name)
+          unindent %{
+            ---
+            beans:
+            - id: #{name}
+              class: Soar::DependencyContainer::Test::DependencyFixture
+              scope: singleton
+              constructor_args:
+              - #{name}
+          }
+        end
+
+        def get_dependency_container_config_with_prototype_dependency(name)
+          unindent %{
+            ---
+            beans:
+            - id: #{name}
+              class: Soar::DependencyContainer::Test::DependencyFixture
+              scope: prototype
+              constructor_args:
+              - #{name}
+          }
+        end
+
+        def get_dependency_container_config_with_two_dependencies(name1, name2)
+          unindent %{
+            ---
+            beans:
+            - id: #{name1}
+              class: Soar::DependencyContainer::Test::DependencyFixture
+              constructor_args:
+              - #{name1}
+            - id: #{name2}
+              class: Soar::DependencyContainer::Test::DependencyFixture
+              constructor_args:
+              - #{name2}
+          }
+        end
+
+        def get_dependency_container_provider(config)
+          Soar::DependencyContainer::Provider::Fabrique.new(config)
+        end
+
+        private
+
+        def unindent(s)
+          s =~ /^(\s+)/
+          top_level_indent = $1
+          s.gsub(/^#{top_level_indent}/m, "")
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/test/list_response.rb

@@ -0,0 +1,29 @@
+module Soar
+
+  module DependencyContainer
+
+    module Test
+
+      class ListResponse
+
+        attr_reader :dependencies
+        attr_reader :error_message
+
+        def initialize(dependencies = nil, error_message = nil)
+          raise ArgumentError.new("Dependencies or error required") unless dependencies || error_message
+          raise ArgumentError.new("Dependencies and error cannot both be provided") if dependencies && error_message
+          @dependencies = dependencies
+          @error_message = error_message
+        end
+
+        def empty?
+          @dependencies && @dependencies.empty?
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/test/orchestrator.rb

@@ -0,0 +1,104 @@
+require "rspec/expectations"
+
+require "soar/dependency_container/test/response"
+require "soar/dependency_container/test/list_response"
+
+module Soar
+
+  module DependencyContainer
+
+    module Test
+
+      class Orchestrator
+
+        include ::RSpec::Matchers
+
+        def initialize(provider)
+          @orchestrator = provider
+        end
+
+        def dependency_container_with_no_dependencies
+          config = @orchestrator.get_dependency_container_config_with_no_dependencies
+          @dependency_container = create_dependency_container(config)
+        end
+
+        def dependency_container_with_singleton_dependency(name)
+          config = @orchestrator.get_dependency_container_config_with_singleton_dependency(name)
+          @dependency_container = create_dependency_container(config)
+        end
+
+        def dependency_container_with_prototype_dependency(name)
+          config = @orchestrator.get_dependency_container_config_with_prototype_dependency(name)
+          @dependency_container = create_dependency_container(config)
+        end
+
+        def dependency_container_with_two_dependencies(name1, name2)
+          config = @orchestrator.get_dependency_container_config_with_two_dependencies(name1, name2)
+          @dependency_container = create_dependency_container(config)
+        end
+
+        def request_dependency(name)
+          begin
+            @requested_dependency = @dependency_container.get_dependency(name)
+          rescue Exception => e
+            $stderr.puts "DEBUG: Observed possibly rescued exception #{e.inspect}"
+            @request_raised_exception = e
+          end
+          @response = Response.new(@requested_dependency, (@request_raised_exception.message if @request_raised_exception))
+        end
+
+        def request_dependency_twice(name)
+          @first_response = request_dependency(name)
+          @second_response = request_dependency(name)
+        end
+
+        def list_dependencies
+          @dependency_list = @dependency_container.list_dependencies
+          @list_response = ListResponse.new(@dependency_list, nil)
+        end
+
+        def assert_received_error(pattern)
+          expect(@response.error_message).to match(/missing dependency/i)
+        end
+
+        def assert_received_dependency(name)
+          expect(@response.error_message).to be_nil
+          expect(@response.dependency.name).to eql name
+        end
+
+        def assert_received_same_dependency
+          expect(@first_response.error_message).to be_nil
+          expect(@second_response.error_message).to be_nil
+          expect(@second_response.dependency.created_at).to eql @first_response.dependency.created_at
+        end
+
+        def assert_received_different_dependency
+          expect(@first_response.error_message).to be_nil
+          expect(@second_response.error_message).to be_nil
+          expect(@second_response.dependency.created_at).to_not eql @first_response.dependency.created_at
+        end
+
+        def assert_received_empty_list
+          expect(@list_response.error_message).to be_nil
+          expect(@list_response).to be_empty
+        end
+
+        def assert_received_list_including(names)
+          expect(@list_response.error_message).to be_nil
+          expect(@list_response.dependencies).to include(*names)
+        end
+
+        private
+
+        def create_dependency_container(config)
+          dependency_container_provider = @orchestrator.get_dependency_container_provider(config)
+          Soar::DependencyContainer::Base.new(dependency_container_provider)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/test/response.rb

@@ -0,0 +1,25 @@
+module Soar
+
+  module DependencyContainer
+
+    module Test
+
+      class Response
+
+        attr_reader :dependency
+        attr_reader :error_message
+
+        def initialize(dependency = nil, error_message = nil)
+          raise ArgumentError.new("Dependency or error required") unless dependency || error_message
+          raise ArgumentError.new("Dependency and error cannot both be provided") if dependency && error_message
+          @dependency = dependency
+          @error_message = error_message
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/test/stub_orchestration_provider.rb

@@ -0,0 +1,36 @@
+module Soar
+
+  module DependencyContainer
+
+    module Test
+
+      class StubOrchestrationProvider
+
+        def get_dependency_container_config_with_no_dependencies
+          {}
+        end
+
+        def get_dependency_container_config_with_singleton_dependency(name)
+          {name => Soar::DependencyContainer::Test::DependencyFixture.new(name)}
+        end
+
+        def get_dependency_container_config_with_prototype_dependency(name)
+          {name => -> { Soar::DependencyContainer::Test::DependencyFixture.new(name) }}
+        end
+
+        def get_dependency_container_config_with_two_dependencies(name1, name2)
+          {name1 => Soar::DependencyContainer::Test::DependencyFixture.new(name1),
+           name2 => Soar::DependencyContainer::Test::DependencyFixture.new(name2)}
+        end
+
+        def get_dependency_container_provider(config)
+          Soar::DependencyContainer::Provider::Stub.new(config)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/soar/dependency_container/version.rb

@@ -0,0 +1,5 @@
+module Soar
+  module DependencyContainer
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: soar-dependency_container
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fabrique
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Dependency injection container compatible with the SOAR Ruby framework
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemspec"
+- ".gitignore"
+- ".rspec"
+- Dockerfile
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/dockerized-test
+- bin/setup
+- lib/soar/dependency_container.rb
+- lib/soar/dependency_container/base.rb
+- lib/soar/dependency_container/errors.rb
+- lib/soar/dependency_container/hash_proxy.rb
+- lib/soar/dependency_container/legacy_injector.rb
+- lib/soar/dependency_container/provider/fabrique.rb
+- lib/soar/dependency_container/provider/stub.rb
+- lib/soar/dependency_container/test.rb
+- lib/soar/dependency_container/test/dependency_fixture.rb
+- lib/soar/dependency_container/test/fabrique_orchestration_provider.rb
+- lib/soar/dependency_container/test/list_response.rb
+- lib/soar/dependency_container/test/orchestrator.rb
+- lib/soar/dependency_container/test/response.rb
+- lib/soar/dependency_container/test/stub_orchestration_provider.rb
+- lib/soar/dependency_container/version.rb
+homepage: https://github.com/hetznerZA/soar-dependency_container
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Dependency injection container
+test_files: []
+has_rdoc: