graphm 0.1

data/COPYING

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Makefile

@@ -0,0 +1,59 @@
+DESTDIR=
+
+NAME=libgraphm-ruby
+GEMNAME=graphm
+RUBYVERSION=1.8
+
+BINDIR=$(DESTDIR)/usr/bin
+MANDIR=$(DESTDIR)/usr/share/man
+LIBDIR=$(DESTDIR)/usr/lib/ruby/$(RUBYVERSION)
+DOCDIR=$(DESTDIR)/usr/share/doc/$(NAME)
+
+RDOC=rdoc$(RUBYVERSION)
+#RDOC=rdoc1.9
+all: doc test
+
+clean:
+	rm -fr doc *.gem
+
+build:
+
+.PHONY: doc doc-reader
+doc-reader: doc
+	xdg-open file://`pwd`/doc/api/index.html
+
+doc:
+	rm -fr doc/api
+	$(RDOC) \
+		--promiscuous \
+		--inline-source \
+		--line-numbers \
+		-o doc/api lib/
+	# --diagram
+
+.PHONY: test
+test:
+	$(MAKE) -C test
+
+install: doc test
+	# install libraries
+	#
+	find lib -name '*.rb' |while read FILE ; do \
+		FILEPATH=`echo $$FILE |sed -e "s~^lib~$(LIBDIR)~"` ; \
+		install -D -o root -g root -m 644 $$FILE $$FILEPATH ; \
+		done
+	# install binaries
+	find bin -name '*.rb' |while read FILE ; do \
+		FILEPATH=`echo $$FILE |sed -e "s~^bin~$(BINDIR)~"` ; \
+		install -D -o root -g root -m 755 $$FILE $$FILEPATH ; \
+		done
+	# install documentation
+	rm -fr $(DOCDIR)
+	mkdir -p $(DOCDIR)
+	cp -a doc $(DOCDIR)
+
+gem:
+	gem build $(GEMNAME).gemspec
+
+gem_install:
+	gem install $(GEMNAME)*.gem

data/graphm.gemspec

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -d
+
+require 'rake'
+
+spec = Gem::Specification.new do |s|
+	s.author = 'Glenn Y. Rolland'
+	s.email = 'glenux@glenux.net'
+	s.homepage = 'http://code.google.com/p/libgraphm-ruby/'
+
+	s.signing_key = ENV['GEM_PRIVATE_KEY']
+	s.cert_chain  = ENV['GEM_CERTIFICATE_CHAIN']
+
+	s.name = 'graphm'
+	s.version = '0.1'
+	s.summary = 'A simple graph manipulation library'
+	s.description = 'A simple graph manipulation library' \
+		+ "providing search, rendering (to dot format, etc.)"
+
+	s.required_ruby_version = '>= 1.8.1'
+
+	s.require_paths = ['lib']
+	s.files = FileList[
+		"lib/graphm/*.rb", 
+		"lib/graphm/render/*.rb", 
+		"examples/*.rb", 
+		"test/**/*"
+	].to_a + [ \
+		"Makefile",
+		"graphm.gemspec",
+		"COPYING",
+		"README"
+	]
+	s.files.reject! { |fn| fn.include? "coverage" }
+
+	puts "== GEM CONTENT =="
+	puts s.files
+	puts "== /GEM CONTENT =="
+end

data/lib/graphm/edge.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby
+
+module Graphm
+	class Edge
+		attr_reader :src, :dst, :prop
+
+		def initialize src, dst, prop={}
+			@src = src
+			@dst = dst
+			@prop = {}
+			set_prop prop
+		end
+
+		def set_prop prop
+			prop.each do |k,v|
+				@prop[k] = v
+			end
+		end
+
+		def has_prop? key, val=nil
+			res = if @prop.include? key then
+					  @prop[key]
+				  else
+					  false
+				  end
+			return res
+		end
+	end
+end

data/lib/graphm/graph.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby
+
+require 'set'
+require 'graphm/node'
+
+module Graphm
+	class Graph
+		attr_reader :nodes, :name
+
+		def initialize name=nil, &block
+			@name = name
+			@nodes = {}
+			self.instance_eval(&block) if block_given?
+		end
+
+		def title name
+			@name = name
+		end
+
+		def edge src, dst, prop={}
+			src_node = node src
+			dst_node = node dst
+
+			@nodes[src].edge_to dst_node, prop
+		end
+
+		def node name, prop={}
+			if not @nodes.include? name then
+				@nodes[name] = Node.new name, prop
+			else
+				@nodes[name].set_prop prop
+			end
+			return @nodes[name]
+		end
+
+		def initial name
+			node name, {:initial => true}
+		end
+
+		def final name
+			node name, {:final => true}
+		end
+
+		def render renderer
+			return renderer.render_graph self
+		end
+	end
+end

data/lib/graphm/node.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby
+
+require 'set'
+require 'graphm/edge'
+
+module Graphm
+	class Node
+		attr_reader :name
+		attr_reader :prop
+		attr_reader :edges
+
+		def initialize name, prop={}
+			@name = name
+			@edges = Set.new
+			@prop = {}
+
+			set_prop prop
+		end
+
+		def set_prop prop
+			prop.each do |k,v|
+				@prop[k] = v
+			end
+		end
+
+		def edge_to node, prop={}
+			edge = ( Edge.new self, node, prop )
+			@edges << edge
+			return edge
+		end
+
+		def has_prop? key, val=nil
+			res = if @prop.include? key then
+					  @prop[key]
+				  else
+					  false
+				  end
+			return res
+		end
+	end
+end

data/lib/graphm/render/dot.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby
+
+require 'graphm/graph'
+require 'graphm/render/generic'
+
+module Graphm
+	module Render
+
+		class DotRenderer < GenericRenderer
+			def render_graph graph
+				buff = ""
+
+				buff << "digraph graphm {\n"
+				graph.nodes.each do |name,dinode|
+					buff << ( render_node dinode )
+				end
+
+				graph.nodes.each do |name,dinode|
+					dinode.edges.each do |edge|
+						buff << ( render_edge edge )
+					end
+				end
+				buff << "}\n"
+				return buff
+			end
+
+			def render_node node
+				opts = {}
+				opts[:label] = "\"%s\"" % node.prop[:label] if node.prop.include? :label
+				opts[:shape] = 'circle' if node.has_prop? :initial
+				opts[:shape] = 'doublecircle' if node.has_prop? :final
+				opts_str = opts.map{ |k,v| "%s=%s" % [k, v] }.join(',')
+
+				return "\t%s [%s];\n" % [ node.name, opts_str ]
+			end
+
+			def render_edge edge
+				opts = {}
+				opts[:label] = "\"%s\"" % edge.prop[:label] if edge.prop.include? :label
+				opts_str = opts.map{ |k,v| "%s=%s" % [k, v] }.join(',')
+
+				return "\t%s -> %s [%s];\n" % [ edge.src.name, edge.dst.name, opts_str ]
+			end
+
+		end
+
+	end
+end

data/lib/graphm/render/generic.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby
+
+module Graphm
+	module Render
+
+		class GenericRenderer
+			def initialize
+			end
+
+			def render_graph graph
+				raise NotImplementedError
+			end
+
+			def render_node node
+				raise NotImplementedError
+			end
+
+			def render_edge edge
+				raise NotImplementedError
+			end
+		end
+
+	end
+end

data/lib/graphm/render/path.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby
+
+require 'graphm/graph'
+require 'graphm/render/generic'
+
+module Graphm
+	module Render
+
+		class PathRenderer
+			def initialize
+				@incomplete = []
+				@complete = []
+			end
+
+			def render_graph graph
+				# create a path for each init node
+				ini = graph.nodes.map{ |name,node| node }.reject{ |node| not node.has_prop? :initial }
+
+				ini.each do |node|
+					@incomplete << [ node ]
+				end
+
+				# while there is an incomplete path
+				while not @incomplete.empty? do
+					cur_path = @incomplete.shift
+
+					node = cur_path.last
+					node.edges.each do |edge|
+						next if cur_path.include? edge
+
+						node_path = cur_path + [ edge, edge.dst ]
+						if edge.dst.has_prop? :final then
+							@complete << node_path
+						else
+							@incomplete << node_path
+						end
+					end
+				end
+
+				res = []
+				res = @complete.map do |path|
+					rpath = path.map do |elem|
+						case elem
+						when Node then render_node elem
+						when Edge then render_edge elem
+						end
+					end
+					rpath
+				end
+				return res
+			end
+
+			def render_node node
+				return node.name
+			end
+
+			def render_edge edge
+				res = if edge.has_prop? :label then
+						  "[%s]-->" % edge.prop[:label]
+					  else
+						  "-->" 
+					  end
+				return res
+			end
+		end
+
+	end
+end

data/test/Makefile

@@ -0,0 +1,36 @@
+TESTS=$(wildcard *.rb)
+
+all: test-unit test-notimplemented
+
+test-unit-%: %.rb
+	rcov --aggregate coverage/cov.info $< 2>&1 >/dev/null
+	ruby $< || exit 1
+
+test-unit:
+	# 
+	# UNIT TESTING
+	#
+	echo "require 'test/unit'" > coverage.rb
+	echo "\$$LOAD_PATH.insert( 0, '../lib' )" >> coverage.rb
+	find ../lib/ |grep rb$$ |sed -e 's/.rb$$/"/' -e 's|../lib/||' -e 's/^/require "/' >> coverage.rb
+	#
+	rm -fr coverage
+	mkdir -p coverage
+	for test in $(TESTS); do \
+		$(MAKE) test-unit-$${test/.rb/} ; \
+	done
+	#
+	# TESTING MISSING CODE
+	#
+
+test-notimplemented:
+	TMP=`mktemp` ; \
+		find ../lib -name '*.rb' |xargs grep -n 'NotImplementedError' > $$TMP ; \
+		COUNT=`wc -l < $$TMP` ; \
+		if [ $$COUNT -gt 0 ]; then \
+		cat $$TMP 1>&2 ; \
+		fi
+
+clean:
+	rm -fr coverage
+	rm -f coverage.rb

data/test/template.rb

@@ -0,0 +1,31 @@
+
+# create sample system command
+
+# exec system command
+
+# verify return code
+
+# run batch and catch errors
+
+
+require "test/unit"
+
+$LOAD_PATH.insert( 0, '../lib' )
+
+require 'graphm/digraph'
+
+class TestXyz < Test::Unit::TestCase
+
+	def test_base
+		#assert_nothing_raised( Exception ) do
+		#	sc.run
+		#end
+
+		#assert_raise( CommandRuntimeError ) do
+		#	sc.run
+		#end
+
+	end
+
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: graphm
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Glenn Y. Rolland
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMDCCAhigAwIBAgIBADANBgkqhkiG9w0BAQUFADA+MQ8wDQYDVQQDDAZnbGVu
+  dXgxFjAUBgoJkiaJk/IsZAEZFgZnbGVudXgxEzARBgoJkiaJk/IsZAEZFgNuZXQw
+  HhcNMTAwODA1MTAwMDQxWhcNMTEwODA1MTAwMDQxWjA+MQ8wDQYDVQQDDAZnbGVu
+  dXgxFjAUBgoJkiaJk/IsZAEZFgZnbGVudXgxEzARBgoJkiaJk/IsZAEZFgNuZXQw
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD01Jf7nrsqLLF2lT/d5K1P
+  t9PxGHrp/gDzopzVHOFUNWnhgUnzBo/1uISQCbVaKMzzM6W/JSDB72Ijnida4uXQ
+  NWu/nKNhUnYMsrbiDVNrZLTXqcxa1Yeh5XwyyNyLDIsQp8YaZIGiJ1CgY6Ex+erv
+  xdA6QYO0qAHwNLGNUsrOziUjZ+Uoi4ETTwLf3XLqfc//P7vdimSeZ/8xlqR7avE+
+  6moADBqhnL12XL1YpvpznN5XdsolOYnXgjcrJXLXWLbkHWWbAbVaKrdWQegms0cA
+  VL3Wd2g7zBS0bJwFzVzfYhq2qybYDouMynHHngniaBPyKoY6Ksu+1Xx5mKwd7Tyd
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQH0/mD
+  dOYIOt0x/69bL/mihBAY8jANBgkqhkiG9w0BAQUFAAOCAQEANfqG5FKOe2n+0VVy
+  Vb9Dlo5jFPtFokVGcxrKWy/rgKKZTHe6nUD8PpT5TPAv/fqss42znaDU2c3x0hjY
+  k/f1o+y82A7kvDQ4ln7nhkIcX3d8jv1zIGrn/9XANK5cDE+3WUlUhVunvqb+SVad
+  ijFd6F9aVBhtUcRj6fuJcv5iyxWtfoUqKfn/iiRk3nrhrCr9/gczp5DVY3fWGUVA
+  grXBYDK5aYBKJ2iHqAq1daY9tESVu3o63ciS3xDj1dFH3Uw1nzMBL79/Jk7KXbwZ
+  fZIDGVYLDMJ8LJiNOG8hoFAolZdVL/Sdncmb3HNZVFsuLBj4GgXEXTjCwKYyWpah
+  WpLCnA==
+  -----END CERTIFICATE-----
+
+date: 2010-08-09 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A simple graph manipulation libraryproviding search, rendering (to dot format, etc.)
+email: glenux@glenux.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/graphm/node.rb
+- lib/graphm/graph.rb
+- lib/graphm/edge.rb
+- lib/graphm/render/dot.rb
+- lib/graphm/render/generic.rb
+- lib/graphm/render/path.rb
+- test/template.rb
+- test/Makefile
+- Makefile
+- graphm.gemspec
+- COPYING
+- README
+has_rdoc: true
+homepage: http://code.google.com/p/libgraphm-ruby/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 53
+      segments: 
+      - 1
+      - 8
+      - 1
+      version: 1.8.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple graph manipulation library
+test_files: []
+