deep_end 0.0.4

data/.gitignore

@@ -0,0 +1,53 @@
+# Also see Global .gitignore:  ~/.gitignore_global
+# https://github.com/stationkeeping/osx/blob/master/git/.gitignore_global
+
+# Environmental Variables
+#########################
+
+.env
+
+# Rails 
+#########################
+
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+.rvmrc
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+.project
+
+# Ruby 
+#########################
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+Gemfile.lock

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pedr Browne
+
+MIT License
+
+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,61 @@
+# DeepEnd
+
+This gem processes a list of objects and their dependencies, ordering them so that dependencies are correctly resolved and checking for circular dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deep_end'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deep_end
+
+## Usage
+
+The Graph is the only class you have to worry about:
+
+    dependency_graph = Graph.new
+
+Add any objects you like to it, along with an array of any other objects that they depend on:
+    
+    # Create objects - you can use any objects/instances
+    dependency_a = {name: 'a'}
+    dependency_b = {name: 'b'}
+    dependency_c = {name: 'c'}
+
+    dependency_graph.add_dependency dependency_c, [dependency_b, dependency_a]
+    dependency_graph.add_dependency dependency_b, [dependency_a]
+    dependency_graph.add_dependency dependency_a
+
+An array of all objects in an order that obeys dependencies is returned from 'add_dependency',
+It is also available from the `resolved_dependencies` property.
+
+    dependency_graph.resolved_dependencies # [{:name=>"a"}, {:name=>"b"}, {:name=>"c"}]
+
+To reuse the Graph you can remove all objects and dependencies using `reset`:
+
+    dependency_graph.reset
+
+Whenever a new object is added with `add_dependency`, the graph re-calculates dependencies. An object can
+be added multiple times with different dependencies. Dependencies are cumulative, so adding an object for
+a second time with different dependencies will result in the object having both sets of dependencies.
+
+If an object is added with itself as a dependency, a `SelfDependencyError` will be raised. 
+
+If a circular dependency is detected a `CircularDependencyError` will be raise.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/deep_end.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deep_end/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "deep_end"
+  gem.version       = DeepEnd::VERSION
+  gem.authors       = ["Pedr Browne"]
+  gem.email         = ["pedr.browne@gmail.com"]
+  gem.description   = %q{Simple dependency resolver}
+  gem.summary       = %q{This gem processes a list of objects and their dependencies, ordering them so that dependencies are correctly resolved and checking for circular dependencies.}
+  gem.homepage      = "https://github.com/stationkeeping/Deep-End"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "log4r"
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/deep_end.sublime-project

@@ -0,0 +1,8 @@
+{
+	"folders":
+	[
+		{
+			"path": "/Users/pedr/Documents/Work/Projects/Code/Ruby/Gems/deep_end"
+		}
+	]
+}

data/lib/deep_end/version.rb

@@ -0,0 +1,3 @@
+module DeepEnd
+  VERSION = "0.0.4"
+end

data/lib/deep_end.rb

@@ -0,0 +1,116 @@
+require "deep_end/version"
+
+module DeepEnd
+
+  # Errors
+  class SelfDependencyError < StandardError; end
+  class CircularDependencyError < StandardError; end
+  
+  # Graph Node
+  class Node
+
+    attr_reader :key
+    attr_accessor :seen
+    attr_reader :edges
+
+    def initialize(key)
+      @key = key
+      @edges = []
+    end
+
+    def addEdge(node)
+      @edges << node
+    end 
+    
+  end
+
+  # Dependency Graph
+  class Graph
+
+    def resolved_dependencies
+      a = []
+      @resolved.each{|node| a << node.key}
+      return a
+    end 
+
+    def initialize
+      reset
+    end
+
+    # Add a new node, causing dependencies to be re-evaluated
+    def add_dependency(key, dependencies = [])
+
+      raise SelfDependencyError, "An object's dependencies cannot contain itself" if dependencies.include? key
+
+      node = node_for_key_or_new key
+      dependencies.each do |dependency|
+        node.addEdge(node_for_key_or_new(dependency))
+      end
+      resolve_dependencies
+      return @resolved
+    end
+
+    # Return the graph to its virgin state
+    def reset
+      @resolved = []
+      @seen_this_pass
+      @nodes = []
+    end
+
+    protected
+
+      # Recurse through nodes
+      def resolve_dependencies
+        reset_seen
+        @resolved = []
+        @nodes.each do |node| 
+          @seen_this_pass = []
+          resolve_dependency node unless node.seen
+        end
+      end
+
+      # Recurse through node edges
+      def resolve_dependency(node)
+        node.seen = true
+        @seen_this_pass << node
+        
+        node.edges.each do |edge| 
+          unless @resolved.include? edge 
+            unless @seen_this_pass.include? edge
+              unless edge.seen
+                resolve_dependency edge
+              end
+            else
+              raise CircularDependencyError, "Circular reference detected: #{node.key.to_s} - #{edge.key.to_s}"
+            end
+          end
+        end
+        @resolved << node
+      end
+      
+      def key_exists(key)
+        return node_for_key(key).present?
+      end
+
+      def node_for_key(key)
+        @nodes.each { |node| return node if node.key == key }
+        return 
+      end
+
+      def node_for_key_or_new(key)
+        existing_node = node_for_key(key)
+        if existing_node
+          return existing_node
+        else
+          node = Node.new key 
+          @nodes << node
+          return node
+        end
+      end
+
+      def reset_seen
+        @nodes.each{ |node| node.seen = false}
+      end
+
+  end
+end

data/spec/lib/deep_end_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module DeepEnd
+  
+  describe Graph do
+
+    before(:each) do
+      @graph = Graph.new
+    end
+
+    context 'when first created' do 
+      it 'should have no resolved dependencies' do
+        @graph.resolved_dependencies.should be_empty
+      end
+    end
+
+    context 'when given dendencies' do 
+
+      # Create dependencies
+      before(:each) do
+        @dependency_a = {name: 'a'}
+        @dependency_b = {name: 'b'}
+        @dependency_c = {name: 'c'}
+        @dependency_d = {name: 'd'}
+        @dependency_e = {name: 'e'}
+      end
+
+      it 'should not be empty' do
+        @graph.add_dependency @dependency_a
+        sorted_objects = @graph.resolved_dependencies.should_not be_empty
+      end
+
+      it 'should contain the dependency' do
+        @graph.add_dependency @dependency_a
+        sorted_objects = @graph.resolved_dependencies.should include(@dependency_a)
+      end
+
+      it 'should maintain order of non-interdependent objects' do
+        # Add dependencies
+        @graph.add_dependency @dependency_a
+        @graph.add_dependency @dependency_b
+        @graph.add_dependency @dependency_c
+        # Check order
+        sorted_objects = @graph.resolved_dependencies
+        sorted_objects[0].should == @dependency_a
+        sorted_objects[1].should == @dependency_b
+        sorted_objects[2].should == @dependency_c
+      end
+
+      it 'should correctly order interdependent objects' do
+        # Add dependencies
+        @graph.add_dependency @dependency_c, [@dependency_b, @dependency_a]
+        @graph.add_dependency @dependency_b, [@dependency_a]
+        @graph.add_dependency @dependency_a
+        # Check order
+        sorted_objects = @graph.resolved_dependencies
+        sorted_objects[0].should == @dependency_a
+        sorted_objects[1].should == @dependency_b
+        sorted_objects[2].should == @dependency_c
+      end
+
+      it 'should raise a SelfDependencyError if an object is added as its own dependency' do
+        # Add dependencies
+        expect { @graph.add_dependency @dependency_a, [@dependency_a] }.to raise_error(SelfDependencyError) 
+      end
+
+      it 'should raise a CircularDependencyError if objects are added with direct circular dependencies' do
+        # Add dependencies
+        @graph.add_dependency @dependency_b, [@dependency_a]
+        expect { @graph.add_dependency @dependency_a, [@dependency_b] }.to raise_error(CircularDependencyError) 
+      end
+
+      it 'should raise a CircularDependencyError if objects are added with indirect circular dependencies' do
+        # Add dependencies
+        @graph.add_dependency @dependency_b, [@dependency_c]
+        @graph.add_dependency @dependency_c, [@dependency_a]
+        expect { @graph.add_dependency @dependency_a, [@dependency_b] }.to raise_error(CircularDependencyError) 
+      end
+
+      context "when reset" do 
+
+        it 'should have no resolved dependencies' do
+          # Add dependencies
+          @graph.add_dependency @dependency_c, [@dependency_b, @dependency_a]
+          @graph.add_dependency @dependency_b, [@dependency_a]
+          @graph.add_dependency @dependency_a
+          @graph.reset 
+          @graph.resolved_dependencies.length.should == 0
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'deep_end'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: deep_end
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Pedr Browne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple dependency resolver
+email:
+- pedr.browne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deep_end.gemspec
+- deep_end.sublime-project
+- lib/deep_end.rb
+- lib/deep_end/version.rb
+- spec/lib/deep_end_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/stationkeeping/Deep-End
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This gem processes a list of objects and their dependencies, ordering them
+  so that dependencies are correctly resolved and checking for circular dependencies.
+test_files:
+- spec/lib/deep_end_spec.rb
+- spec/spec_helper.rb