graphs 0.1.4-x86-linux → 0.1.5-x86-linux

data/lib/graph.rb

@@ -8,7 +8,8 @@ require 'yaml'
 # @!attribute [rw] edges
 #   @return [EdgeArray] array of current Graph's edges
 # @!attribute [rw] attrs
-#   @return [Hash] attributes of the current Graph (e.g. author, description, …)
+#   @return [Hash] attributes of the current Graph (e.g. author, description, …).
+#   By default, the graph is directed, i.e. the :directed attribute is set to `true`.
 class Graph
 
     # Return a new Graph which is the intersection of every given graph.
@@ -46,11 +47,60 @@ class Graph
         perform_graphs_group_op(*graphs, &:^)
     end
 
-    # An array of nodes, each node is an hash of label/value paires
+    # A node. This class is just a wrapper around a hash of
+    # attributes since in version <= 0.1.5 nodes were simple hashes
+    class Node
+
+        attr_accessor :attrs
+
+        def initialize(attrs=nil)
+            @attrs = attrs || {}
+        end
+
+        # compare two nodes
+        # @param other [Node]
+        def ==(other)
+            return false if !other.is_a?(Node)
+
+            @attrs == other.attrs
+        end
+
+        def method_missing(method, *args, &block)
+            @attrs.send(method, *args, &block)
+        end
+
+    end
+
+    # An edge. This class is just a wrapper around a hash of
+    # attributes since in version <= 0.1.5 edges were simple hashes
+    class Edge
+
+        attr_accessor :attrs
+
+        def initialize(attrs=nil)
+            @attrs = attrs || {}
+        end
+
+        # compare two edges
+        # @param other [Edge]
+        def ==(other)
+            return false if !other.is_a?(Edge)
+
+            @attrs == other.attrs
+        end
+
+        def method_missing(method, *args, &block)
+            @attrs.send(method, *args, &block)
+        end
+
+    end
+
+    # An array of Node objects
     class NodeArray < Array
 
-        def initialize(*args)
-            super(*args)
+        def initialize(li)
+            nodes = li.map { |n| n.is_a?(Node) ? n : Node.new(n) }
+            super(nodes)
             @defaults = {}
         end
 
@@ -64,19 +114,43 @@ class Graph
         end
 
         # Add the given node at the end of the list
-        # @param o [Node]
-        def push(o)
-            if (!o.is_a?(Hash))
-                raise TypeError.new "#{o.inspect} is not an Hash!"
+        # @param n [Node]
+        def push(n)
+            if (!n.is_a?(Hash) && !n.is_a?(Node))
+                raise TypeError.new "#{n.inspect} is not an Hash or a Node!"
             end
-            o2 = o.clone
-            o2.update(@defaults)
-            super(o2)
+
+            super(n.clone.update(@defaults))
         end
     end
 
-    # An array of edges, each edge is an hash of label/value paires
-    class EdgeArray < NodeArray
+    # An array of Edge objects
+    class EdgeArray < Array
+        def initialize(li)
+            edges = li.map { |n| n.is_a?(Edge) ? n : Edge.new(n) }
+            super(edges)
+            @defaults = {}
+        end
+
+        # Set some default values for current elements.
+        # @note This method can be called multiple times.
+        # @example Set all edges's 'created-at' value to '2012-05-03'
+        #   myEdgeList.set_default({'created-at'=>'2012-05-03'})
+        # @param dict [Hash]
+        def set_default(dict)
+            @defaults.update(dict)
+            self.map! { |e| e.update(@defaults) }
+        end
+
+        # Add the given edge at the end of the list
+        # @param e [Edge]
+        def push(e)
+            if (!e.is_a?(Hash) && !e.is_a?(Edge))
+                raise TypeError.new "#{e.inspect} is not an Hash or an Edge!"
+            end
+
+            super(e.clone.update(@defaults))
+        end
     end
 
     attr_accessor :nodes, :edges, :attrs
@@ -86,7 +160,7 @@ class Graph
     def initialize(nodes=nil, edges=nil)
         @nodes = NodeArray.new(nodes || [])
         @edges = EdgeArray.new(edges || [])
-        @attrs = {}
+        @attrs = { :directed => true }
     end
 
     # Test if current graph has same nodes and edges as the other
@@ -148,6 +222,7 @@ class Graph
     # Perform an OR operation on the current Graph and the given one. Returns a
     # new graph which every node is in the current Graph and/or the other
     # (idem for edges).
+    # @param other [Graph]
     def |(other)
         if (!other.is_a?(Graph))
             return nil
@@ -178,6 +253,12 @@ class Graph
         self - other
     end
 
+    # Return true if the Graph is directed.
+    # @see Graph.attrs
+    def directed?()
+        self.attrs[:directed]
+    end
+
     # Clone the current graph. All nodes and edges are also cloned. A new Graph
     # is returned.
     def clone()
@@ -220,6 +301,111 @@ class Graph
 
     end
 
+    # Return the degree of the node n in the current graph, i.e. the number
+    # of edges which are connected to this node. Note that this is useful
+    # only for a undirected graph, for a directed one, you should use
+    # Graph#in_degree_of and/or Graph#out_degree_of.
+    #
+    # Edges must have the 'node1' and 'node2' attributes, which must contain
+    # the 'label' attributes of nodes.
+    #
+    # @param n [Node,String] A node or a label of one
+    # @see Graph#in_degree_of
+    # @see Graph#out_degree_of
+    def degree_of(n)
+        label = Graph::get_label_from_node(n)
+
+        degree = 0
+
+        # This is more efficient than in_degree_of(n)+out_degree_of(n)
+        # since it goes only once through the edges array
+        self.edges.each do |e|
+            degree += 1 if (e['node1'] || e[:node1]).to_s == label
+            degree += 1 if (e['node2'] || e[:node2]).to_s == label
+        end
+
+        degree
+    end
+
+    # Return the “in degree” of the node n in the current graph, i.e. the number
+    # of edges which are directed to this node. Note that the graph must be oriented.
+    #
+    # Edges must have the 'node1' and 'node2' attributes, which must contain
+    # the 'label' attributes of nodes.
+    #
+    # @param n [Node,String] A node or a label of one
+    # @see Graph#degree_of
+    # @see Graph#out_degree_of
+    def in_degree_of(n)
+        label = Graph::get_label_from_node(n)
+
+        degree = 0
+
+        self.edges.each do |e|
+            degree += 1 if (e['node2'] || e[:node2]).to_s == label
+        end
+
+        degree
+    end
+
+    # Return the “out degree” of the node n in the current graph, i.e. the number
+    # of edges which are directed from this node. Note that the graph must be oriented.
+    #
+    # Edges must have the 'node1' and 'node2' attributes, which must contain
+    # the 'label' attributes of nodes.
+    #
+    # @param n [Node,String] A node or a label of one
+    # @see Graph#degree_of
+    # @see Graph#out_degree_of
+    def out_degree_of(n)
+        label = Graph::get_label_from_node(n)
+
+        degree = 0
+
+        self.edges.each do |e|
+            degree += 1 if (e['node1'] || e[:node1]).to_s == label
+        end
+
+        degree
+    end
+
+    # Return the “in degree” of the node n in the current graph, i.e. the number
+    # of edges which are directed to this node. Note that the graph must be oriented.
+    #
+    # Edges must have the 'node1' and 'node2' attributes, which must contain
+    # the 'label' attributes of nodes.
+    #
+    # @param n [Node,String] A node or a label of one
+    # @see Graph#degree_of
+    # @see Graph#out_degree_of
+    def in_degree_of(n)
+        label = Graph::get_label_from_node(n)
+
+        degree = 0
+
+        # This is more efficient than in_degree_of(n)+out_degree_of(n)
+        # since it goes only once through the edges array
+        self.edges.each do |e|
+            degree += 1 if (e['node2'] || e[:node2]).to_s == label
+        end
+
+        degree
+    end
+
+
+    # return the label of a node. Raise a TypeError exception if the argument
+    # is not a Node nor a String object.
+    # @param n [Node,String] A node with a 'label' or :label attribute, or a string
+    def Graph::get_label_from_node(n)
+        label = n.is_a?(Node) \
+                      ? (n['label'] || n[:label]).to_s \
+                      : n.is_a?(String) ? n : nil
+
+        raise TypeError.new("#{n.inspect} must be a Node or String object.") if label.nil?
+
+        label
+    end
+
     # return the provided set of graphs, from which every node/edge label which
     # is not in all graphs has been removed. So every returned graph has same
     # node/edge labels than each other
@@ -275,16 +461,17 @@ class Graph
         # from the arguments
         if graphs[-1].is_a?(Hash)
             return nil if graphs.length == 1
-            opts.update(graphs.pop)
+            
+            opts = graphs.pop
         end
 
         # return nil if one argument is not a graph
-        graphs.each {|g|
-                return nil if (!g.is_a?(Graph))
-        }
+        graphs.each do |g|
+                return nil if !g.is_a?(Graph)
+        end
 
         # if :same_fields option is set, call `keep_only_same_fields` function
-        *graphs = keep_only_same_fields(*graphs) if opts[:same_fields]
+        graphs = keep_only_same_fields(*graphs) if opts[:same_fields]
 
         # perform an and operation on all graph list
         graphs.inject(&block)

data/tests/{tests_gdf.rb → gdf_tests.rb}

@@ -1,8 +1,6 @@
 #! /usr/bin/ruby1.9.1
 
-require 'graph'
-require 'graphs/gdf'
-require 'test/unit'
+require_relative '../lib/graphs/gdf'
 
 module Utils
     def self.get_sample_graph

data/tests/{tests_gexf.rb → gexf_tests.rb}

@@ -1,5 +1,4 @@
 #! /usr/bin/ruby1.9.1
 # -*- coding: UTF-8 -*-
 
-require 'test/unit'
 # require 'graphs/gexf'

data/tests/{tests_graph.rb → graph_tests.rb}

@@ -3,7 +3,7 @@
 
 require 'test/unit'
 require 'yaml'
-require 'graph'
+require_relative '../lib/graph'
 
 class Graph_test < Test::Unit::TestCase
 
@@ -40,9 +40,10 @@ class Graph_test < Test::Unit::TestCase
 
     # == Graph#attrs == #
 
-    def test_graph_attrs
+    def test_empty_graph_attrs
         g = @@empty
-        assert_equal({}, g.attrs)
+        assert_equal({:directed => true}, g.attrs)
+        assert_equal(true, g.directed?)
 
         g.attrs['mode'] = 'static'
         g.attrs['defaultedgetype'] = 'directed'
@@ -181,6 +182,9 @@ class Graph_test < Test::Unit::TestCase
 
         assert_equal(21, g.nodes[0]['age'])
         assert_equal(21, g.nodes[1]['age'])
+
+        assert_equal(21, g.nodes[0]['age'])
+        assert_equal(21, g.nodes[1]['age'])
     end
 
     def test_nodearray_set_default_existing_property
@@ -467,8 +471,8 @@ class Graph_test < Test::Unit::TestCase
     def test_union_sample_graph_and_itself
         g = @@sample_graph
 
-        assert_equal(g, Graph::intersection(g, g))
-        assert_equal(g, Graph::intersection(g, g, g, g))
+        assert_equal(g, Graph::union(g, g))
+        assert_equal(g, Graph::union(g, g, g, g))
     end
     
     def test_union_sample_graph_and_other_sample_graph

data/tests/node_tests.rb

@@ -0,0 +1,84 @@
+#! /usr/bin/ruby1.9.1
+# -*- coding: UTF-8 -*-
+
+class Node_test < Test::Unit::TestCase
+    
+    def setup
+        @@empty = Graph::Node.new
+        @@alice = Graph::Node.new('label' => 'Alice')
+    
+        # Alice ----> Bob
+        #   ↑          ↑
+        #   |          |
+        # Oscar -------'
+        @@sample_graph = Graph.new(
+            [
+                { 'label' => 'Alice' },
+                { 'label' => 'Bob'   },
+                { 'label' => 'Oscar' }
+            ],
+            [
+                { 'node1' => 'Alice', 'node2' => 'Bob' },
+                { 'node1' => 'Oscar', 'node2' => 'Alice'},
+                { 'node1' => 'Oscar', 'node2' => 'Bob'}
+            ]
+        )
+    
+    end
+
+    def test_create_graph_with_node_objects
+        g1 = Graph.new([
+            Graph::Node.new('label' => 'Foo')
+        ])
+
+        g2 = Graph.new([
+            { 'label' => 'Foo' }
+        ])
+
+        assert_equal(g2, g1)
+    end
+
+    def test_node_attrs
+        a = @@alice
+
+        a['foo'] = 'bar'
+
+        assert_equal('Alice', @@alice['label'])
+        assert_equal('bar',   @@alice['foo'])
+        assert_equal(nil,     @@alice['fooo'])
+    end
+
+    def test_node_degree_by_label
+        assert_equal(2, @@sample_graph.degree_of('Alice'))
+        assert_equal(2, @@sample_graph.degree_of('Oscar'))
+        assert_equal(2, @@sample_graph.degree_of('Bob'))
+        assert_equal(0, @@sample_graph.degree_of('not found'))
+    end
+
+    def test_node_degree_by_object
+        assert_equal(2, @@sample_graph.degree_of(@@alice))
+    end
+
+    def test_node_in_degree_by_label
+        assert_equal(1, @@sample_graph.in_degree_of('Alice'))
+        assert_equal(2, @@sample_graph.in_degree_of('Bob'))
+        assert_equal(0, @@sample_graph.in_degree_of('Oscar'))
+        assert_equal(0, @@sample_graph.in_degree_of('not found'))
+    end
+
+    def test_node_in_degree_by_object
+        assert_equal(1, @@sample_graph.in_degree_of(@@alice))
+    end
+
+    def test_node_out_degree_by_label
+        assert_equal(1, @@sample_graph.out_degree_of('Alice'))
+        assert_equal(0, @@sample_graph.out_degree_of('Bob'))
+        assert_equal(2, @@sample_graph.out_degree_of('Oscar'))
+        assert_equal(0, @@sample_graph.out_degree_of('not found'))
+    end
+
+    def test_node_out_degree_by_object
+        assert_equal(1, @@sample_graph.out_degree_of(@@alice))
+    end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphs
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: x86-linux
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-06 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies: []
 description: Provide functions to (un)parse GDF files and generate graphs
 email: batifon@yahoo.fr
@@ -19,9 +19,10 @@ extra_rdoc_files: []
 files:
 - lib/graph.rb
 - lib/graphs/gdf.rb
-- tests/tests_gexf.rb
-- tests/tests_graph.rb
-- tests/tests_gdf.rb
+- tests/graph_tests.rb
+- tests/gdf_tests.rb
+- tests/node_tests.rb
+- tests/gexf_tests.rb
 homepage: https://github.com/bfontaine/Graphs.rb
 licenses:
 - MIT
@@ -48,6 +49,7 @@ signing_key:
 specification_version: 3
 summary: Utilities to manipulate graph files
 test_files:
-- tests/tests_gexf.rb
-- tests/tests_graph.rb
-- tests/tests_gdf.rb
+- tests/graph_tests.rb
+- tests/gdf_tests.rb
+- tests/node_tests.rb
+- tests/gexf_tests.rb