little_boxes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86e6644930011e5254977f6ab0809cafa6a22696
+  data.tar.gz: bc84eb541accd46a4f35a3eb3e13d51913f489ca
+SHA512:
+  metadata.gz: efe43b09428af99ed51374d404f2d590ab135cba431fc7d53317d93d304befdb00db1ddb38f65aace6460d0bd684932d88d8cd26e0950e72ee551543eca5d531
+  data.tar.gz: 3fe8e90d9769f77b80b795eb939b5fc4b4779e4c61db4bc7ac6d84861c32824e1cfbc6650b3061f5dc009e415ae2eac4fbcbd8d266b1b521afd83dc243967379

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'rspec'
+  gem 'pry'
+  gem 'rerun'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Manuel Morales, et al.
+
+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,28 @@
+# LittleBoxes
+
+Dependancy injection framework in Ruby.
+
+
+## Contributing
+
+Do not forget to run the tests with:
+
+```bash
+rake
+```
+
+And bump the version with any of:
+
+```bash
+$ gem bump --version 1.1.1       # Bump the gem version to the given version number
+$ gem bump --version major       # Bump the gem version to the next major level (e.g. 0.0.1 to 1.0.0)
+$ gem bump --version minor       # Bump the gem version to the next minor level (e.g. 0.0.1 to 0.1.0)
+$ gem bump --version patch       # Bump the gem version to the next patch level (e.g. 0.0.1 to 0.0.2)
+```
+
+
+## License
+
+Released under the MIT License.
+See the [LICENSE](LICENSE.txt) file for further details.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake'
+
+require 'rspec/core/rake_task'
+task :default => :spec
+task :test => :spec
+desc 'Run all specs'
+RSpec::Core::RakeTask.new('spec') do |spec|
+  spec.rspec_opts = %w{}
+end

data/lib/little_boxes.rb

@@ -0,0 +1,7 @@
+module LittleBoxes
+  require 'little_boxes/registry'
+  require 'little_boxes/dependant_registry'
+  Dir.glob(File.dirname(__FILE__) + '/little_boxes/*').each{|p| require p }
+
+  class MissingDependency < RuntimeError; end
+end

data/lib/little_boxes/box.rb

@@ -0,0 +1,19 @@
+module LittleBoxes
+  class Box
+    include Registry
+
+    def get
+      self
+    end
+
+    def customize name, &block
+      ForwardingDsl.run self[name], &block
+    end
+
+    def box name, &block
+      s = self.class.new parent: self, name: name
+      self[name] = s
+      ForwardingDsl.run s, &block
+    end
+  end
+end

data/lib/little_boxes/defined_dependant.rb

@@ -0,0 +1,9 @@
+module LittleBoxes
+  class DefinedDependant
+    include DependantRegistry
+
+    def get
+      run
+    end
+  end
+end

data/lib/little_boxes/dependant.rb

@@ -0,0 +1,44 @@
+require 'mini_object'
+
+module LittleBoxes
+  module Dependant
+    module ClassMethods
+      def dependency name, opts = {}
+        instance_dependencies[name] = opts
+        attr_injectable name
+      end
+
+      def class_dependency name, opts = {}
+        class_dependencies[name] = opts
+        cattr_injectable name
+      end
+
+      def instance_dependencies
+        @instance_dependencies ||= {}
+      end
+
+      def class_dependencies
+        @class_dependencies ||= {}
+      end
+
+      def dependencies
+        class_dependencies
+      end
+
+      def inherited klass
+        klass.class_dependencies.merge! class_dependencies
+        klass.instance_dependencies.merge! instance_dependencies
+        super
+      end
+    end
+
+    def self.included klass
+      klass.extend ClassMethods
+      klass.include MiniObject::Injectable
+    end
+
+    def dependencies
+      self.class.instance_dependencies
+    end
+  end
+end

data/lib/little_boxes/dependant_registry.rb

@@ -0,0 +1,44 @@
+module LittleBoxes
+  module DependantRegistry
+    def self.included base
+      base.class_eval do
+        include Registry
+        attr_accessor :build_block
+
+        def initialize name: nil, parent: parent, &block
+          @build_block = block
+          @name = name
+          @parent = parent
+        end
+      end
+    end
+        
+    def get
+      raise NotImplementedError
+    end
+
+    def build &block
+      @build_block = block
+    end
+
+    def get_dependency name, options = nil
+      options ||= {}
+
+      if d = self[name]; d.get
+      elsif s = options[:default]; s.call parent
+      else raise(MissingDependency.new "Could not find #{name}")
+      end
+    end
+
+    private
+    def run
+      ForwardingDsl.run(self, &build_block).tap do |subject|
+        if subject.respond_to? :dependencies
+          subject.dependencies.each do |name, options|
+            subject.send("#{name}"){ get_dependency(name, options) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/little_boxes/memoized_dependant.rb

@@ -0,0 +1,9 @@
+module LittleBoxes
+  class MemoizedDependant
+    include DependantRegistry
+
+    def get
+      @value ||= run
+    end
+  end
+end

data/lib/little_boxes/null_logger.rb

@@ -0,0 +1,8 @@
+require 'logger'
+
+module LittleBoxes
+  class NullLogger < Logger
+    def initialize; end
+    def add(*args); end
+  end
+end

data/lib/little_boxes/obtained.rb

@@ -0,0 +1,13 @@
+module LittleBoxes
+  class Obtained
+    include DependantRegistry
+
+    def get
+      run
+    end
+
+    def get
+      ForwardingDsl.run(self, &build_block)
+    end
+  end
+end

data/lib/little_boxes/registry.rb

@@ -0,0 +1,84 @@
+require 'forwarding_dsl'
+
+module LittleBoxes
+  module Registry
+    attr_accessor :parent
+    attr_accessor :name
+
+    def initialize parent: nil, name: self.class, &block
+      @parent = parent
+      @name = name
+      ForwardingDsl.run self, &block
+    end
+
+    def registry
+      @registry ||= {}
+    end
+
+    def method_missing name, *args, &block
+      if self[name]
+        self[name].get
+      else
+        super
+      end
+    end
+
+    def respond_to_missing? name, *args
+      !!self[name] || super
+    end
+
+    def [] name
+      registry[name] || (parent && parent[name])
+    end
+
+    def []= name, value
+      registry[name]= value
+    end
+
+    def clear
+      @registry = {}
+    end
+
+    def let name, &block
+      self[name] = MemoizedDependant.new name: name, parent: self, &block
+    end
+
+    def define name, &block
+      self[name] = DefinedDependant.new name: name, parent: self, &block
+    end
+
+    def obtain name, &block
+      self[name] = Obtained.new name: name, parent: self, &block
+    end
+
+    def inspect
+      "<#{name} box: #{registry.keys.join(" ")}>"
+    end
+
+    alias to_s inspect
+
+    def name
+      @name || self.class.name
+    end
+
+    def path
+      if parent
+        parent.path + [self]
+      else
+        [self]
+      end
+    end
+
+    def root
+      path.first
+    end
+
+    def reset
+      @value = nil
+
+      registry.each do |name, register|
+        register.reset
+      end
+    end
+  end
+end

data/lib/little_boxes/version.rb

@@ -0,0 +1,3 @@
+module LittleBoxes
+  VERSION = "0.1.0"
+end

data/little_boxes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+gem_name = "little_boxes" # TODO: Rename this
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "#{gem_name}/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = gem_name
+  spec.version       = LittleBoxes::VERSION
+  spec.authors       = ["Workshare's dev team"]
+  spec.email         = ['_Development@workshare.com']
+  spec.description   = File.read('README.md').split("\n").reject{|l| l.length == 0 || l =~ /^[#=]+/ }.first
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/worshare/#{spec.name.gsub('_','-')}"
+  spec.license       = "Copyright"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "forwarding_dsl"
+  spec.add_runtime_dependency "mini_object"
+end

data/spec/little_boxes/box_spec.rb

@@ -0,0 +1,341 @@
+require_relative '../spec_helper'
+require 'ostruct'
+
+describe LittleBoxes::Box do
+  subject{ described_class.new }
+
+  describe '#customize' do
+    it 'allows customizing dependencies' do
+      subject.let(:loglevel) { 0 }
+      subject.let(:logger) { double('logger', loglevel: loglevel) }
+
+      subject.customize(:logger) do |l|
+        l.let(:loglevel) { 1 }
+      end
+
+      expect(subject.logger.loglevel).to eq 1
+    end
+
+    it 'supports overriding lets attributes from the outside' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :logger
+      end
+
+      subject.let(:logger) { :logger }
+
+      subject.let(:server) { server_class.new }
+
+      subject.customize(:server) do
+        let(:logger) { :new_logger }
+      end
+
+      expect(subject.server.logger).to be :new_logger
+    end
+  end
+
+  describe '#let' do
+    it 'has freely defined registers with just a lambda' do
+      subject.let(:loglevel) { 0 }
+      expect(subject.loglevel).to eq 0
+    end
+
+    it 'memoizes the result' do
+      n = 0
+      subject.let(:loglevel) { n = n + 1 }
+
+      expect(subject.loglevel).to eq 1
+      expect(subject.loglevel).to eq 1
+    end
+
+    it 'allows referencing other dependencies within such lambda' do
+      subject.let(:loglevel) { 0 }
+      subject.let(:logger) { double('logger', loglevel: loglevel) }
+      expect(subject.logger.loglevel).to eq 0
+    end
+
+    it 'has instances that have dependencies' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :logger
+      end
+
+      subject.let(:logger) { double('logger') }
+      subject.let(:server) { server_class.new }
+      expect(subject.server.logger).to be subject.logger
+    end
+
+    it 'unknown dependencies raise exception' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :unknown_dep
+      end
+
+      subject.let(:server) { server_class.new }
+      expect{ subject.server.unknown_dep }.to raise_error(LittleBoxes::MissingDependency)
+    end
+
+    it 'has classes that have class dependencies' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        class_dependency :host
+      end
+
+      subject.let(:host) { 'localhost' }
+      subject.let(:server_class) { server_class }
+      expect(subject.server_class.host).to eq 'localhost'
+    end
+
+    it 'supports defaults' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :log, default: ->(d){ d.logger }
+      end
+
+      subject.let(:logger) { :logger }
+
+      subject.let(:server) { server_class.new }
+
+      expect(subject.server.log).to be :logger
+    end
+
+    it 'assigns dependencies with lambdas' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+
+        dependency :logger
+      end
+
+      subject.let(:server) { server_class.new }
+
+      subject.let(:logger) { :old }
+      expect(subject.server.logger).to be :old
+
+      subject.let(:logger) { :new }
+      expect(subject.server.logger).to be :new
+    end
+
+    it 'supports overriding specific attributes' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :logger
+      end
+
+      subject.let(:logger) { :logger }
+      subject.let(:new_logger) { :new_logger }
+
+      subject.let(:server) do
+        build { server_class.new }
+        let(:logger) { new_logger }
+      end
+
+      expect(subject.server.logger).to be :new_logger
+    end
+  end
+
+  describe '#obtain' do
+    it 'does not memoize the result' do
+      n = 0
+      subject.obtain(:loglevel) { n = n + 1 }
+
+      expect(subject.loglevel).to eq 1
+      expect(subject.loglevel).to eq 2
+    end
+
+    it 'doesn not inject anything' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :logger
+      end
+
+      subject.let(:logger) { double('logger') }
+      subject.obtain(:server) { server_class.new.tap { |s| s.logger = :old_logger } }
+      expect(subject.server.logger).to be :old_logger
+    end
+  end
+
+  describe '#define' do
+    it 'does not memoize the result' do
+      n = 0
+      subject.define(:loglevel) { n = n + 1 }
+
+      expect(subject.loglevel).to eq 1
+      expect(subject.loglevel).to eq 2
+    end
+
+    it 'has instances that have dependencies' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :logger
+      end
+
+      subject.let(:logger) { double('logger') }
+      subject.define(:server) { server_class.new }
+      expect(subject.server.logger).to be subject.logger
+    end
+
+    it 'unknown dependencies raise exception' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :unknown_dep
+      end
+
+      subject.define(:server) { server_class.new }
+      expect{ subject.server.unknown_dep }.to raise_error(LittleBoxes::MissingDependency)
+    end
+
+    it 'has classes that have class dependencies' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        class_dependency :host
+      end
+
+      subject.let(:host) { 'localhost' }
+      subject.define(:server_class) { server_class }
+      expect(subject.server_class.host).to eq 'localhost'
+    end
+
+    it 'supports defaults' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :log, default: ->(d){ d.logger }
+      end
+
+      subject.let(:logger) { :logger }
+
+      subject.define(:server) { server_class.new }
+
+      expect(subject.server.log).to be :logger
+    end
+
+    it 'assigns dependencies with lambdas' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+
+        dependency :logger
+      end
+
+      subject.define(:server) { server_class.new }
+
+      subject.let(:logger) { :old }
+      expect(subject.server.logger).to be :old
+
+      subject.let(:logger) { :new }
+      expect(subject.server.logger).to be :new
+    end
+  end
+
+  describe '#box' do
+    it 'supports boxes' do
+      subject.box :loggers do
+        let(:null) { :null_logger }
+        let(:file) { :file_logger }
+      end
+
+      expect(subject.loggers.null).to be :null_logger
+    end
+
+    it 'supports finding dependencies upwards in the ancestry' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :logger
+      end
+
+      subject.let(:logger) { :logger }
+
+      subject.box :servers do
+        let(:one) { server_class.new }
+      end
+
+      expect(subject.servers.one.logger).to be :logger
+    end
+
+    it 'defaults within boxes' do
+      server_class = Class.new do
+        include LittleBoxes::Dependant
+        dependency :log, default: ->(a){ a.logger }
+      end
+
+      subject.let(:logger) { :logger }
+
+      subject.box :servers do
+        let(:apache) { server_class.new }
+      end
+
+      expect(subject.servers.apache.log).to be :logger
+    end
+  end
+
+  describe '#inspect' do
+    it 'has nice inspect' do
+      subject.let(:loglevel) { 0 }
+      subject.let(:logger) { 0 }
+      expect(subject.inspect).to eq "<LittleBoxes::Box box: loglevel logger>"
+    end
+  end
+  
+  describe '#path' do
+    it 'has a path' do
+      subject.box :second do
+        box :third do
+        end
+      end
+
+      expect(subject.second.third.path).to eq [subject, subject.second, subject.second.third]
+    end
+  end
+
+  describe '#name' do
+    it 'names boxes' do
+      subject.name = :first
+
+      subject.box :second do
+        box :third do
+        end
+      end
+
+      expect(subject.second.third.path.map(&:name)).to eq [:first, :second, :third]
+    end
+  end
+
+  describe '#reset' do
+    it 'has a reset' do
+      first = subject
+
+      first.box :second do
+        let(:logger) { Object.new }
+      end
+
+      old_logger = first.second.logger
+
+      first.reset
+      expect(first.second.logger).not_to be old_logger
+    end
+  end
+
+  describe '#root' do
+    it 'has a root' do
+      first = subject
+
+      first.box :second do
+        box(:third) { }
+      end
+
+      expect(first.second.third.root).to eq first
+    end
+  end
+
+  describe '.new' do
+    it 'executes block on initialize' do
+      subject = described_class.new do
+        let(:loglevel) { 0 }
+      end
+
+      expect(subject.loglevel).to eq 0
+    end
+
+    it 'can build instances' do
+      expect(subject).to be_a(described_class)
+    end
+  end
+end

data/spec/little_boxes/dependant_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../spec_helper'
+
+describe LittleBoxes::Dependant do
+  let(:box) { LittleBoxes::Box.new }
+
+  describe 'Dependant' do
+    it 'can be inherited' do
+      class_one = Class.new do
+        include LittleBoxes::Dependant
+        dependency :one
+      end
+
+      class_two = Class.new class_one do
+        include LittleBoxes::Dependant
+        dependency :two
+      end
+
+      box.let(:one) { :one }
+      box.let(:two) { :two }
+      box.let(:dependant_one) { class_one.new }
+      box.let(:dependant_two) { class_two.new }
+
+      expect(box.dependant_one.one).to be :one
+      expect(box.dependant_two.one).to be :one
+      expect(box.dependant_two.two).to be :two
+    end
+  end
+end

data/spec/little_boxes_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe LittleBoxes do
+  it 'has a version' do
+    expect(LittleBoxes::VERSION).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rspec'
+require 'pry'
+
+RSpec.configure do |config|
+   config.color = true
+   config.tty = true
+   config.formatter = :documentation # :documentation, :progress, :html, :textmate
+end
+
+$LOAD_PATH.unshift File.expand_path('lib')
+require 'little_boxes'
+
+$LOAD_PATH.unshift File.expand_path('spec/support')
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: little_boxes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Workshare's dev team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: forwarding_dsl
+  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: mini_object
+  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'
+description: Dependancy injection framework in Ruby.
+email:
+- _Development@workshare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/little_boxes.rb
+- lib/little_boxes/box.rb
+- lib/little_boxes/defined_dependant.rb
+- lib/little_boxes/dependant.rb
+- lib/little_boxes/dependant_registry.rb
+- lib/little_boxes/memoized_dependant.rb
+- lib/little_boxes/null_logger.rb
+- lib/little_boxes/obtained.rb
+- lib/little_boxes/registry.rb
+- lib/little_boxes/version.rb
+- little_boxes.gemspec
+- spec/little_boxes/box_spec.rb
+- spec/little_boxes/dependant_spec.rb
+- spec/little_boxes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/worshare/little-boxes
+licenses:
+- Copyright
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Dependancy injection framework in Ruby.
+test_files:
+- spec/little_boxes/box_spec.rb
+- spec/little_boxes/dependant_spec.rb
+- spec/little_boxes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: