canister 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d69f8befb7b0da9e4d982db5a64988fcc6d540e
+  data.tar.gz: e4cd5da5bfc6cfad289ede2651b55ccaeb165f8e
+SHA512:
+  metadata.gz: ece48adf544fa81cae520ded5e0ec262090d257ada284449c4b59702a8e20c34c1e4e55c8273f57905be2e8791d4032ac03feb94c22dfe01f06e0ec46b84e775
+  data.tar.gz: cea1b3678cd466155d63e3ab6bff4b4ea0fd82eeda8e22a0a36a660f9b5e1cf046cd8e3ecdc8f17db32021c0c3752e843d4102cc4c9f99d5f626610c83d3efb7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,144 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - '*.gemspec'
+
+Naming/FileName:
+  ExpectMatchingDefinition: true
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/**/*'
+    - 'lib/*/version.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+
+# We disable this cop because we want to use Pathname#/
+# and this cop is not configurable at all.
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Security/YAMLLoad:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Metrics/LineLength:
+  Max: 100
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/CommentAnnotation:
+  Enabled: false
+
+# Does not work for multi-line copyright notices.
+Style/Copyright:
+  Enabled: false
+
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# These two cops do not differentiate between the scope the file is describing
+# and any namespaces it is nested under.  If this is not acceptable,
+# no_empty_lines produces the least offensive results.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Produces poor results.
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Produces poor results.
+Style/Next:
+  Enabled: false
+
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Lint/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+  #EnforcedStyleAlignWith: start_of_line
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Lint/DefEndAlignment:
+  EnforcedStyleAlignWith: def
+
+Performance/RedundantMerge:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+

data/.travis.yml

@@ -0,0 +1,28 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4
+  - 2.3
+
+branches:
+  only:
+    - master
+    - develop
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a492448053c934b2a3cfa2f86f3357491d11beda5499db7884ae13859870fd29
+
+before_install: gem install bundler
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+    - bundle exec rspec --order=random
+
+after_script:
+    - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT || true
+

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in closet.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry"
+end

data/LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2018, The Regents of the University of Michigan.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of the The University of Michigan nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS OF THE UNIVERSITY OF MICHIGAN AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OF THE
+UNIVERSITY OF MICHIGAN BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO,PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,100 @@
+# Canister
+
+[![Build Status](https://travis-ci.org/mlibrary/canister.svg?branch=master)](https://travis-ci.org/mlibrary/canister)
+[![Maintainability](https://api.codeclimate.com/v1/badges/590e17334ea92100e297/maintainability)](https://codeclimate.com/github/mlibrary/canister/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/590e17334ea92100e297/test_coverage)](https://codeclimate.com/github/mlibrary/canister/test_coverage)
+
+
+## Summary
+
+Canister is a simple IoC container for ruby. It has no dependencies and provides only
+the functionality you need. It does not monkey-patch ruby or pollute the global
+namespace, and most importantly *it expects to be invisible to your domain classes.*
+
+It provides:
+
+* Out-of-order declaration
+* Caching
+* Automatic dependency resolution
+* Automatic cache invalidation on re-registration
+
+## Why do I need this? Especially in ruby?
+
+Canister was created to make it easier to declare our setup for our application's
+production and test environments in a single place, without needing to know
+when exactly those objects were created.
+
+*Canister is not a replacement for
+dependency injection.* Rather, it is useful when you have designed your objects
+to have their dependencies injected.  For example, it would be a *mistake* to write
+all of your classes such that they except a single parameter called `container`.
+
+For more information on dependency injection and inversion of control containers in
+ruby, please see
+[this excellent article](https://gist.github.com/malakai97/b1d3bdf6d80c6f99a875930981243f9d)
+by [Blair Anderson](https://github.com/blairanderson) that both sums up the issue
+and was the inspiration for this gem.
+
+
+## Installation
+
+Add it to your Gemfile and you're off to the races.
+
+## Usage
+
+```ruby
+# Basic usage
+container = Canister.new
+container.register(:foo) { "foo" }
+container.register(:bar) {|c| c.foo + "bar" }
+
+container.bar     #=> "foobar"
+container[:bar]   #=> "foobar"
+container["bar"]  #=> "foobar"
+
+# Dependencies can be declared in any order
+container.register(:after) {|c| "#{c.before} and after" }
+container.register(:before) { "before" }
+container.after   #=> "before and after"
+
+# Values are cached
+container.register(:wait) { sleep 3; 27 }
+container.wait
+  .
+  .
+  .
+  #=================> 27
+container.wait    #=> 27
+
+# Caches are invalidated automatically
+container.register(:foo) { "oof" }
+container.bar     #=> "oofbar"
+```
+
+## Contributing
+
+Standard rules apply.
+
+## Compatibility
+
+* ruby 2.3.x
+* ruby 2.4.x
+
+As Canister does not rely on any specific runtime environment other than
+the ruby core, it is compatible with every ruby library and framework.
+
+## Authors
+
+* The author and maintainer is [Bryan Hockey](https://github.com/malakai97)
+* This project was inspired by
+  [this excellent article](https://gist.github.com/malakai97/b1d3bdf6d80c6f99a875930981243f9d)
+  by [Blair Anderson](https://github.com/blairanderson). (We are not affiliated, so
+  don't blame him if this breaks.)
+
+## License
+
+    Copyright (c) 2018 The Regents of the University of Michigan.
+    All Rights Reserved.
+    Licensed according to the terms of the Revised BSD License.
+    See LICENSE.md for details.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/canister.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "canister/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "canister"
+  spec.version       = Canister::VERSION
+  spec.authors       = ["Bryan Hockey"]
+  spec.email         = ["bhock@umich.edu"]
+
+  spec.summary       = %q{A simple IoC container for ruby.}
+  spec.description   = %q{
+    Canister is a simple IoC container for ruby. It has no dependencies and provides only
+    the functionality you need. It does not monkey-patch ruby or pollute the global
+    namespace, and most importantly it expects to be invisible to your domain classes.
+  }
+  spec.homepage      = "https://github.com/mlibrary/canister"
+  spec.license       = "Revised BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov"
+end

data/lib/canister/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Canister
+  VERSION = "0.9.0"
+end

data/lib/canister.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "canister/version"
+
+# A container that registers keys to values that are
+# resolved at runtime. This allows for out-of-order declaration,
+# automatic dependency resolution, and--upon
+# redeclaration--automatic dependency cache invalidation.
+class Canister
+
+  def initialize
+    @stack = []
+    @registry = {}
+    @resolved = {}
+    @dependents = Hash.new do |hash, key|
+      hash[key] = []
+    end
+    yield self if block_given?
+  end
+
+  # We override method_missing to enable dot notation
+  # for accessing registered values.
+  def method_missing(method, *args, &block)
+    if handles?(method)
+      resolve(method)
+    else
+      super(method, *args, block)
+    end
+  end
+
+  # We override respond_to? to enable dot notation
+  # for accessing registered values.
+  def respond_to_missing?(method, include_all = false)
+    handles?(method) || super(method, include_all)
+  end
+
+  # Register a value to a key by passing a block. Note that
+  # the value will be that returned by the block. If the key
+  # has been registered before, the old registration is
+  # overwritten. Dependents of the original registration
+  # are automatically invalidated.
+  # @param key [Symbol]
+  # @yield self [Container] Yields this container.
+  # @return the value defined in the block
+  def register(key, &block)
+    invalidate(key) if registered?(key)
+    registry[key.to_sym] = block
+    self
+  end
+
+  # Recursively resolves the object that was registered to
+  # the key. This value is memoized.
+  # @param key [Symbol]
+  def resolve(key)
+    add_dependent(key)
+    stack << key
+    value = resolved[key.to_sym] ||= registry[key.to_sym].call(self)
+    stack.pop
+    value
+  end
+  alias_method :[], :resolve
+
+  def keys
+    registry.keys
+  end
+
+  private
+
+  attr_reader :dependents, :registry, :resolved, :stack
+
+  def handles?(method)
+    registered?(method)
+  end
+
+  def add_dependent(key)
+    unless stack.empty?
+      dependents[key.to_sym] << stack.last
+    end
+  end
+
+  def registered?(key)
+    registry.key?(key.to_sym)
+  end
+
+  def unresolve(key)
+    resolved.delete(key.to_sym)
+  end
+
+  def invalidate(key, first = true)
+    unresolve(key)
+    dependents[key.to_sym]
+      .each {|child| invalidate(child, false) }
+    dependents.delete(key.to_sym) if first
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: canister
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Bryan Hockey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: 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'
+description: "\n    Canister is a simple IoC container for ruby. It has no dependencies
+  and provides only\n    the functionality you need. It does not monkey-patch ruby
+  or pollute the global\n    namespace, and most importantly it expects to be invisible
+  to your domain classes.\n  "
+email:
+- bhock@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- canister.gemspec
+- lib/canister.rb
+- lib/canister/version.rb
+homepage: https://github.com/mlibrary/canister
+licenses:
+- Revised BSD
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A simple IoC container for ruby.
+test_files: []