sinject 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fed4c106d5d6e0c1cd1dd49c31ebe332df763be9
-  data.tar.gz: 68990d54d47e65942b200277231a9c143736370d
+  metadata.gz: 2ff53f60728f9e82cae343665133a1afb5fd25a4
+  data.tar.gz: 484be6ecc45857889ad818ac5f9cb5d4d5af86cd
 SHA512:
-  metadata.gz: 4d3bc249e36cfd9f2051aeb600aa2a884073e98a40009c87ceb5d08589f081af89c952e5adc1ac00bec99c81cc6740dbdf5d1c51baa438adfa7a306bff85026b
-  data.tar.gz: 9d322a2331f564a61b1c5fd4cf763ebe4f19351d644c8df8468389841af9413dcb909c936cadc8be8a235caf33d5d6c7bbeac977e9c236ddd612578e79826318
+  metadata.gz: 13c4fca49e08c1da9e8936b4890c087377bfc08fdf0e234b122fdd5279e5d428451c2763e04ceecbdd9a4bff290e58057fdd3db1e13e4a7a5f45b892b9d290c9
+  data.tar.gz: 670cda2067966140a1f3e1577fc24480e7b38a38aaa74366937a06de8731e997d13558ec93bceb17b45acb9c54395f803d6694bd3eb77a2f7c94917c49b0bcc7

data/lib/sinject.rb

@@ -1,4 +1,3 @@
-require "sinject/version"
 require 'sinject/class'
 require 'sinject/container'
 require 'sinject/container_item'

data/lib/sinject/container.rb

@@ -43,7 +43,7 @@ module Sinject
         raise Sinject::DependencyRegistrationKeyNotSpecifiedException.new
       end
 
-      if(!options.has_key?(:key))
+      if(!options.has_key?(:class))
         raise Sinject::DependencyRegistrationClassNotSpecifiedException.new
       end
 
@@ -117,7 +117,7 @@ module Sinject
       Sinject::DependencyGroup.descendants.each do |g|
         group = g.new
         if group.is_valid?
-          group.register(Sinject::Container.instance)
+          group.register(self)
         end
       end
     end
@@ -155,7 +155,6 @@ module Sinject
     end
 
     def create_instance(item)
-      instance = nil
 
       #check if a custom initializer block has been specified
       if item.initialize_block != nil

data/lib/sinject/exceptions.rb

@@ -41,7 +41,7 @@ module Sinject
     end
 
     def to_s
-      "A Dependency has already been registered for the key: '#{key}'"
+      "A Dependency has already been registered for the key: '#{@key}'"
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinject
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
-- vaughan britton
+- Sage One
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-03 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,23 +54,11 @@ dependencies:
         version: '3.0'
 description: A simple dependency injection framework.
 email:
-- vaughanbritton@gmail.com
+- vaughan.britton@sage.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
-- ".gitignore"
-- ".idea/.rakeTasks"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/vcs.xml"
-- ".rspec"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - bin/console
 - bin/setup
 - lib/sinject.rb
@@ -79,9 +67,7 @@ files:
 - lib/sinject/container_item.rb
 - lib/sinject/dependency_group.rb
 - lib/sinject/exceptions.rb
-- lib/sinject/version.rb
-- sinject.gemspec
-homepage: https://github.com/vaughanbrittonsage/sinject
+homepage: https://github.com/sage/sinject
 licenses:
 - MIT
 metadata: {}
@@ -101,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple Dependency Injection.

data/.gitignore

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

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---format doc

data/CODE_OF_CONDUCT.md

@@ -1,49 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at vaughan.britton@sage.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 vaughanbrittonsage
-
-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

@@ -1,137 +0,0 @@
-
-# Sinject
-
-Welcome to Sinject! a simple dependency injection framework for ruby.
-
-[Note: The update to v 1.0.0 contains breaking changes. All code has now been moved into the module 'Sinject::*' and the register method of the container has been modified to take an options hash as apposed to requiring multiple method arguments.]
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'sinject'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sinject
-
-## Usage
-
-**Registering dependencies**
-
-Dependency objects need to be registered with the container before use, to do so you need to configure the Sinject::Container. [Note: This should be done after all code files have been required as the last step before your application starts.]
-
-    #initialize the container
-    container = Sinject::Container.new
-    
-    #register your dependencies
-    container.register({ :key => :cache_store, :class => RedisCacheStore, :singleton => true })
-    container.register({ :key => :country_repository, :class => MySqlCountryRepository, :singleton => false })
-   
-Dependencies can be registered with the container in 2 modes:
-
-- **Single instance:**  	This mode ensures that only 1 instance is created for the registered dependency and that all requests to the container for that dependency return the same instance.
-- **Multi instance:**	This mode ensures that a new instance of the registered dependency is returned for each request received by the container. 
-
-The registration mode can be set by specifying **true** or **false** to the *':singleton'* argument of the containers register method.
-
-Dependencies that require custom initialization can be registered with an initialization block to handle the creation of the dependency, this allows you more control over how the dependency is created if required:
-
-    container.register({ :key => :cache_store, :class => RedisCacheStore, :singleton => true }) do
-        instance = RedisCacheStore.new
-        instance.host = 'http://localhost'
-        instance.port = '6369'
-        instance
-    end
-
-Dependencies with a custom initialization block must return an object of the registered dependency class type, if an unexpected instance is returned then Sinject will raise a `Sinject::DependencyInitializeException`.
-
-**Assigning dependencies**
-
-To assign a dependency to an object you need to add the dependency attribute to the class and specify the symbol key that was used to register the dependency with the SinjectContainer:
-
-    class MySqlCountryRepository
-	    
-	    dependency :cache_store
-		
-		.....
-	end
-
-    class CountryController < ActionController::Base
-	
-		dependency :country_repository    
-
-		.....
-    end
-
-Sinject will then inject the registered dependency to that object and it will be accessible via the dependency key:
-
-    country_controller.country_repository.cache_store
-    
-
-**Dependency Contracts**
-
-Dependency contracts can be defined to validate registered dependencies are valid for the task they are being registered for. *(If you are familiar with other type based languages then you can think of this as a kind of Interface)*
-
-To create a dependency contract you need to create a new class with empty methods for each of the methods that the dependency needs to respond to in order to fulfill it's role:
-
-    class LoggerContract
-        def write(message)
-        end
-    end
-
-Then when registering a dependency for the role the contract is written for, you can assign the contract:
-
-    #register the dependency
-    container.register({ :key => :logger, :class => FileLogger, :singleton => false, :contract => LoggerContract })
-    
-Sinject will then validate that the registered dependency meets the requirements specified within the contract. If a dependency does not meet the contract requirements then 1 of the following exceptions will be raised:
-
-- `Sinject::DependencyContractMissingMethodsException` is raised when 1 or more methods from the contract could not be found on the dependency.
-- `Sinject::DependencyContractInvalidParametersException` is raised when the parameters of a contract method do not match the parameters found on a dependency method.
-
-**Dependency Groups**
-
-Dependency registration groups can be created to allow groups of dependencies to be set without the need for manual registration *(e.g. to include with a gem for auto registration)*, or to allow different dependency groups to be loaded in different circumstances *(e.g. per environment)*.
-
-To create a dependency group, create a class that inherits from the `Sinject::DependencyGroup` base class and implement the `register` & `is_valid?` methods.
-
-For example:
-
-    #create a development only dependency group
-    class DevelopmentDependencies < Sinject::DependencyGroup
-        def register(container)
-            container.register(:cache_store, LocalCacheStore, true)
-            container.register(:logger, TerminalLogger, true)
-        end
-        
-        def is_valid?
-            Rails.env.development?
-        end
-    end
-
-To load valid dependency groups the following method needs to be called from the container:
-
-    container.load_groups
-    
-
-## 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/vaughanbrittonsage/sinject. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec

data/lib/sinject/version.rb

@@ -1,3 +0,0 @@
-module Sinject
-  VERSION = "1.0.1"
-end

data/sinject.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sinject/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "sinject"
-  spec.version       = Sinject::VERSION
-  spec.authors       = ["vaughan britton"]
-  spec.email         = ["vaughanbritton@gmail.com"]
-
-  spec.summary       = "Simple Dependency Injection."
-  spec.description   = "A simple dependency injection framework."
-  spec.homepage      = "https://github.com/vaughanbrittonsage/sinject"
-  spec.license       = "MIT"
-
-  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_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end