graphs 0.1.1-x86-linux → 0.1.2-x86-linux

data/lib/graph.rb

@@ -2,8 +2,10 @@
 
 require 'yaml'
 
+# A graph with nodes and edges
 class Graph
 
+    # An array of nodes, each node is an hash of label/value paires
     class NodeArray < Array
 
         def initialize(*args)
@@ -11,6 +13,10 @@ class Graph
             @defaults = {}
         end
 
+        # Set some default values for current elements.
+        # @note This method can be called multiple times.
+        # @example Set all nodes's 'created-at' value to '2012-05-03'
+        #   myNodeList.set_default({'created-at'=>'2012-05-03'})
         def set_default(dict)
             @defaults.update(dict)
             self.map! { |e| e.update(@defaults) }
@@ -22,20 +28,26 @@ class Graph
             end
             o2 = o.clone
             o2.update(@defaults)
-            super
+            super(o2)
         end
     end
 
+    # An array of edges, each edge is an hash of label/value paires
     class EdgeArray < NodeArray
     end
 
     attr_accessor :nodes, :edges
 
+    # @param nodes [Array] Nodes of the graph
+    # @param edges [Array] Edges of the graph
     def initialize(nodes=nil, edges=nil)
         @nodes = NodeArray.new(nodes || [])
         @edges = EdgeArray.new(edges || [])
     end
 
+    # Test if current graph has same nodes and edges as the other
+    # graph.
+    # @param other [Graph]
     def ==(other)
         if (!other.is_a?(Graph))
             return false
@@ -43,6 +55,10 @@ class Graph
         (self.nodes === other.nodes) && (self.edges == other.edges)
     end
 
+    # Perform an intersection between the current graph and the other.
+    # Returns a new Graph which nodes are both in the current graph and
+    # the other (idem for edges).
+    # @param other [Graph]
     def &(other)
         if (!other.is_a?(Graph))
             return nil
@@ -54,27 +70,31 @@ class Graph
         Graph.new(nodes, edges)
     end
 
+    # Write the current Graph into a file.
+    # @param filename [String] A valid filename
+    # @param opts [Hash] A customizable set of options
+    # @option opts [Boolean] :gephi Should be <tt>true</tt> if the file will be used with Gephi.
     def write(filename, opts=nil)
 
         has_ext = filename.split('.')
+        ext = (has_ext.length>1) ? has_ext[-1] : 'unknow'
 
-        if ((has_ext.length == 1) || (has_ext[-1] == 'yml'))
+        m = (self.methods - Object.methods).map {|e| e.to_s}
+
+        if (m.include? 'write_'+ext.downcase)
+            self.send('write_'+ext.downcase, filename, opts)
+
+        elsif (ext == 'unknow' || ext == 'yml')
             # YAML (default)
             nodes = self.nodes.to_a
             edges = self.edges.to_a
 
             data = {'nodes'=>nodes, 'edges'=>edges}.to_yaml
-            f = open(filename+'.yml', 'w')
+            f = open(filename, 'w')
             f.write(data)
             f.close
         else
-            ext = has_ext[-1]
-
-            m = (self.methods - Object.methods).map {|e| e.to_s}
-
-            if (m.include? '_write_'+ext.downcase)
-                self.send('_write_'+ext.downcase, filename, opts)
-            end
+            raise NoMethodError.new("No method to handle #{ext} file extension.")
         end
 
     end

data/lib/graphs/gdf.rb

@@ -3,11 +3,18 @@
 require_relative '../graph'
 
 class Graph
+    # Returns a GDF version of the current graph
+    # @param opts [Hash] A customizable set of options
+    # @see GDF::unparse
     def to_gdf(opts=nil)
         GDF::unparse(self, opts)
     end
 
-    def _write_gdf(filename, opts=nil)
+    # Write the current graph into a GDF file. This method is used internally,
+    # use Graph#write instead.
+    # @param filename [String] a valid filename
+    # @see GDF::unparse
+    def write_gdf(filename, opts=nil)
         gdf = GDF::unparse(self, opts)
         f = File.open(filename, 'w')
         f.write(gdf)
@@ -15,12 +22,20 @@ class Graph
     end
 end
 
+# GDF-related functions
 module GDF
 
+    # Loads a GDF file and return a new Graph object
+    # @param filename [String] a valid filename
+    # @see GDF::parse
     def self.load(filename)
         self.parse(File.read(filename))
     end
 
+    # Parse some GDF text and return a new Graph object
+    # @param content [String] a valid GDF String
+    # @see GDF::load
+    # @see GDF::unparse
     def self.parse(content)
 
         if (content.nil? || content.length == 0)
@@ -99,6 +114,10 @@ module GDF
         Graph.new(nodes, edges)
     end
 
+    # Return a GDF String which describe the given Graph
+    # @param graph [Graph]
+    # @param opts [Hash] A customizable set of options
+    # @see Graph#write
     def self.unparse(graph, opts=nil)
 
         # nodes
@@ -138,7 +157,8 @@ module GDF
 
     private
 
-    # read the value of a node|edge field, and return the value's type (String)
+    # Read the value of a node/edge field, and return the value's
+    # type (String)
     def self.get_type(v, opts=nil)
         opts = opts || {}
 
@@ -155,7 +175,8 @@ module GDF
         end
     end
 
-    # read a (node|edge)def, and return ['label', 'type of value']
+    # read a node/edge def, and return a list which first element is the
+    # label of the field, and the second is its type
     def self.read_def(s)
         *label, value_type = s.split /\s+/
             if /((tiny|small|medium|big)?int|integer)/i.match(value_type)

data/tests/tests_graph.rb

@@ -21,6 +21,19 @@ class Graph_test < Test::Unit::TestCase
         ]
     )
 
+    @@sample_graph_1 = Graph.new(
+        [
+            {'label'=>'bar', 'num'=>3},
+            {'label'=>'foo', 'num'=>42},
+            {'label'=>'chuck', 'num'=>78}
+        ],
+        [
+            {'node1'=>'foo', 'node2'=>'bar', 'time'=>1.0},
+            {'node1'=>'bar', 'node2'=>'foo', 'time'=>2.5},
+            {'node1'=>'foo', 'node2'=>'chuck', 'time'=>3.1}
+        ]
+    )
+
     def test_new_empty_graph
         g = Graph.new
 
@@ -102,8 +115,7 @@ class Graph_test < Test::Unit::TestCase
     end
 
     def test_edgearray_set_default_existing_property_before_push
-        g = Graph.new([],
-                           [{'node1'=>'foo', 'node2'=>'bar', 'directed'=>true}])
+        g = Graph.new([], [{'node1'=>'foo', 'node2'=>'bar', 'directed'=>true}])
         g.edges.set_default 'node2' => 'foo'
         g.edges.push({'node1' => 'bar', 'node2' => 'foo'})
 
@@ -159,6 +171,14 @@ class Graph_test < Test::Unit::TestCase
         assert_equal(nil, g & 'foo')
     end
 
+    def test_AND_2_graphs_same_nodes_different_labels
+        g1 = @@sample_graph
+        g2 = @@sample_graph_1
+        empty = Graph.new
+
+        assert_equal(empty, g1 & g2)
+    end
+
     # == Graph#write == #
 
     def test_graph_write_no_ext
@@ -171,4 +191,13 @@ class Graph_test < Test::Unit::TestCase
         assert_equal(g.nodes, dict['nodes'])
         assert_equal(g.edges, dict['edges'])
     end
+
+    def test_graph_write_unknow_ext
+        g = @@sample_graph
+        f = '/tmp/_graph_test.foo'
+        assert_raise(NoMethodError) do
+            g.write(f)
+        end
+        assert_equal(false, File.exists?(f))
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: x86-linux
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-02 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies: []
 description: Provide functions to (un)parse GDF files and generate graphs
 email: batifon@yahoo.fr