hash_graph 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Trampoline Systems Ltd
+
+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.rdoc

@@ -0,0 +1,25 @@
+= hash_graph
+
+HashGraph::DirectedGraph and HashGraph::UndirectedGraph are simple implementations of 
+a directed an undirected graph respectively, based on Hash
+
+HashGraph::UndirectedGraph ensures that g[a][b]==g[b][a]
+
+HashGraph::DirectedGraph ensures that for every edge g[a][b] that there is always a key
+b in the Hash g, so all nodes can be identified by g.keys
+
+HashGraph::DirectedGraph also includes TSort for Tarjan's algorithm
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Trampoline Systems Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hash_graph"
+    gem.summary = %Q{simple Hash based directed and undirected graph implementations for Ruby}
+    gem.description = %Q{Hash based directed and undirected graph implementations for Ruby}
+    gem.email = "craig@trampolinesystems.com"
+    gem.homepage = "http://github.com/trampoline/hash_graph"
+    gem.authors = ["mccraig mccraig of the clan mccraig"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "rr", ">= 0.10.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/hash_graph.rb

@@ -0,0 +1,73 @@
+require 'tsort'
+
+module HashGraph
+  # a simple directed graph representation for TSort,
+  # [ TSort implements tarjan's algorithm for finding the
+  #   strongly connected components of a graph ]
+  # DirectedGraph extends Hash, all nodes have a key in the top-level
+  # Hash, and a possibly empty child-hash of node to weight
+  # mappings, thus the structure is :
+  # {from_v*=>{to_v*=>weight}} and all keys used in the child hashes
+  # are guaranteed to also be present in the top-level hash
+  class DirectedGraph < Hash
+    include TSort
+
+    def self.new_lower_hash(top_hash,from_vertex)
+      tos = Hash.new()
+      tos.instance_eval do
+        ec = class << self ; self ; end
+        ec.send(:alias_method, :uhg_store, :store)
+        ec.send(:define_method, :store) do |to_vertex,weight|
+          top_hash[from_vertex]=tos if !top_hash.key?(from_vertex)
+          uhg_store(to_vertex,weight)
+          top_hash[to_vertex]=DirectedGraph::new_lower_hash(top_hash,to_vertex) if !top_hash.key?(to_vertex)
+        end
+        ec.send(:alias_method, :[]=, :store)
+      end
+      tos
+    end
+
+    # construct a DirectedGraph which ensures that all destination node keys
+    # are present in the top level Hash
+    def initialize()
+      super() do |h,from_vertex|
+        DirectedGraph::new_lower_hash(h,from_vertex)
+      end
+    end
+
+    alias tsort_each_node each_key
+
+    def tsort_each_child(node,&block)
+      fetch(node).keys.each(&block)
+    end
+  end
+
+  # an undirected graph representation based on Hash,
+  # which ensures that h[a][b]==h[b][a]
+  class UndirectedGraph < Hash
+    def self.new_lower_hash(top_hash,a_vertex)
+      tos = Hash.new()
+      tos.instance_eval do
+        ec = class << self ; self ; end
+        ec.send(:alias_method, :uhg_store, :store)
+        ec.send(:define_method, :store) do |b_vertex,weight|
+          top_hash[a_vertex]=tos if !top_hash.key?(a_vertex)
+          uhg_store(b_vertex,weight)
+          if top_hash.key?(b_vertex)
+            top_hash[b_vertex]
+          else
+            top_hash[b_vertex]=UndirectedGraph::new_lower_hash(top_hash,b_vertex)
+          end.uhg_store(a_vertex,weight) # ensure reverse link added too
+        end
+        ec.send(:alias_method, :[]=, :store)
+      end
+      tos
+    end
+
+    def initialize()
+      super() do |h,a_vertex|
+        UndirectedGraph::new_lower_hash(h,a_vertex)
+      end
+    end
+  end
+end

data/spec/hash_graph_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe HashGraph do
+  module HashGraph
+    describe DirectedGraph do
+      it "should not create a top-level key on top-level access" do
+        h = DirectedGraph.new
+        h[:foo]
+        h.should == {}
+      end
+
+      it "should not create a top-level key on second-level access" do
+        h = DirectedGraph.new
+        h[:foo][:bar]
+        h.should == {}
+      end
+
+      it "should create a top-level key for new target nodes" do
+        h = DirectedGraph.new
+        h[:foo][:bar] = 1
+        h.should == {:foo=>{:bar=>1}, :bar=>{}}
+      end
+
+      it "should create new edges on existing top-level keys" do
+        h = DirectedGraph.new
+        h[:foo][:bar] = 1
+        h[:bar][:baz] = 5
+        h.should == {:foo=>{:bar=>1}, :bar=>{:baz=>5}, :baz=>{}}
+      end
+    end
+
+    describe UndirectedGraph do
+      it "should not create a top-level key on top-level access" do
+        h = UndirectedGraph.new
+        h[:foo]
+        h.should == {}
+      end
+
+      it "should not create a top-leve key on second level acces" do
+        h = UndirectedGraph.new
+        h[:foo][:bar]
+        h.should == {}
+      end
+
+      it "should create the reverse edge on edge creation" do
+        h = UndirectedGraph.new
+        h[:foo][:bar]=1
+        h.should == {:foo=>{:bar=>1}, :bar=>{:foo=>1}}
+      end
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hash_graph'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: hash_graph
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- mccraig mccraig of the clan mccraig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-19 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rr
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.5
+    version: 
+description: Hash based directed and undirected graph implementations for Ruby
+email: craig@trampolinesystems.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/hash_graph.rb
+- spec/hash_graph_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/trampoline/hash_graph
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: simple Hash based directed and undirected graph implementations for Ruby
+test_files: 
+- spec/hash_graph_spec.rb
+- spec/spec_helper.rb