hinge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 674762229cddb1ad8dc8dc7ed1efcb6efaf1736e
+  data.tar.gz: eba6a6ac27016e695befd31b4e99cddd266a31da
+SHA512:
+  metadata.gz: 7c9b6045fce65cb1781703d79a737fabfa71fb5dc708962cc27f45033ac902b87c9040f9b9d4821ab37fcbd1d300dac6e5a029a3001c20ca9ce23a46ea61cd82
+  data.tar.gz: cee48df84aeba75c3641dbfc00f37b3618b12fce607e18bc46b5f3f69f3fc4735f897c1cdbff1e9dfc85f8d30be0e41299ea63f4c1eb8fb8fa303649b6fe44b2

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/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hinge.gemspec
+gemspec
+
+gem "rspec"

data/README.md

@@ -0,0 +1,60 @@
+# Hinge
+
+Hinge is a trivial dependency resolver. With Hinge, you can write down object dependencies
+in a linear fashion to have a simple overview of them.
+
+```
+class Deps
+  # This method implements building a logger. It has no dependencies.
+  def build_logger
+    Logger.new($stdout)
+  end
+
+  # This method builds an instance of the `Processor` class you want to use,
+  # initialized with the logger from the previous method.
+  # This matching is done by the name of the parameter!
+  def build_processor(logger)
+    Processor.new(logger)
+  end
+
+  # Named parameters can be used as well!
+  def build_runner(logger:)
+    Runner.new(logger)
+  end
+end
+
+deps = Deps.new
+resolver = Hinge.resolver(deps)
+processor = resolver.resolve(:processor)
+resolver.resolve(:processor).equal?(processor) # => true (the same object is returned as last time)
+```
+
+And that's all!
+
+Varying dependencies depending on the environment can now easily be handled in a number of ways,
+ranging from `if/else` or `case` constructs to inheritance or overriding methods of `Deps`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hinge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hinge
+
+## Development
+
+Tests are written in RSpec.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/schnittchen/hinge.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hinge"
+
+# 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/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/hinge.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hinge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hinge"
+  spec.version       = Hinge::VERSION
+  spec.authors       = ["Thomas Stratmann"]
+  spec.email         = ["thomas.stratmann@9elements.com"]
+
+  spec.summary       = %q{Trivial dependency resolver using introspection}
+  spec.description   = %q{Trivial dependency resolver using introspection}
+
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hinge.rb

@@ -0,0 +1,8 @@
+require "hinge/version"
+require 'hinge/resolver'
+
+module Hinge
+  def self.resolver(container)
+    Resolver.new(container)
+  end
+end

data/lib/hinge/resolver.rb

@@ -0,0 +1,95 @@
+module Hinge
+  class Resolver
+    Error = Class.new(RuntimeError)
+    UnknownDependency = Class.new(Error)
+    CircularReference = Class.new(Error)
+
+    def initialize(container)
+      @container = container
+      @nodes = {}
+      @resolved = {}
+    end
+    attr_reader :container
+    attr_reader :resolved
+
+    def resolve(name)
+      return resolved[name] if resolved.key?(name)
+
+      raise ArgumentError unless name.is_a?(Symbol)
+
+      node = node(name)
+      populate_node(node)
+
+      resolved[name]
+    end
+
+    private
+
+    def populate_node(node, history = [])
+      unless node.method
+        complain(UnknownDependency, node, history, "method #{node.method_name} not found")
+      end
+      if history.include?(node.name)
+        complain(CircularReference, node, history, "dependency #{node.name} depends on itself")
+      end
+
+      node.dependency_names.each do |dep_name|
+        populate_node node(dep_name), history + [node.name]
+      end
+
+      ordered_dependent_values =
+        node.dependency_names.map do |dep_name|
+          @resolved[dep_name]
+        end
+      @resolved[node.name] = node.invoke(ordered_dependent_values)
+    end
+
+    def complain(exn, node, history, msg = "")
+      raise exn, "#{msg} (resolving #{[*history, node.name].join(" -> ")})"
+    end
+
+    def node(name)
+      @nodes[name] ||= Node.new(name, container)
+    end
+
+    class Node
+      def initialize(name, container)
+        @name = name
+        @method_name = "build_#{@name}"
+        @method =
+          begin
+            container.method(@method_name)
+          rescue NameError
+            nil
+          end
+
+        if @method
+          @dependency_names = []
+          @positional_args_count = 0
+          @keyword_arg_names = []
+
+          @method.parameters.each do |kind, argument_name|
+            argument_name = argument_name.to_sym
+            @dependency_names << argument_name
+            case kind
+            when :req
+              @positional_args_count += 1
+            when :keyreq
+              @keyword_arg_names << argument_name
+            end
+          end
+        end
+      end
+      attr_reader :name, :method_name, :method, :dependency_names
+
+      def invoke(ordered_values)
+        splat = ordered_values.take(@positional_args_count)
+        splat << Hash[
+          @keyword_arg_names.zip(ordered_values.drop(@positional_args_count))
+        ] if @keyword_arg_names.any?
+        @method.call(*splat)
+      end
+    end
+  end
+end
+

data/lib/hinge/version.rb

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: hinge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Stratmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Trivial dependency resolver using introspection
+email:
+- thomas.stratmann@9elements.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hinge.gemspec
+- lib/hinge.rb
+- lib/hinge/resolver.rb
+- lib/hinge/version.rb
+homepage: 
+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.2
+signing_key: 
+specification_version: 4
+summary: Trivial dependency resolver using introspection
+test_files: []