jumoku 0.2.2 → 0.2.3

data/Rakefile

@@ -7,19 +7,7 @@ rescue LoadError
 end
 
 require 'rake'
-require 'rake/rdoctask'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Logg'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r jumoku.rb"
 end

data/lib/jumoku.rb

@@ -5,6 +5,7 @@ require 'pathname'
 require 'pp'
 require 'active_support'
 require 'facets'
+require 'hashery'
 require 'plexus'
 
 # Jumoku provides you with several modules and classes to build and manipulate
@@ -43,6 +44,10 @@ module Jumoku
   autoload :Tree,                     'jumoku/classes/tree_classes'
   autoload :Arborescence,             'jumoku/classes/tree_classes'
 
+  # strategies
+  autoload :EdgeLabeling,             'jumoku/strategies/edge_labeling'
+  EdgeLabeling.autoload :Simple,      'jumoku/strategies/edge_labeling/simple'
+
   # support
   require 'jumoku/support/ruby_compatibility'
   require 'jumoku/support/support'

data/lib/jumoku/builders/arborescence.rb

@@ -7,5 +7,19 @@ module Jumoku
   module ArborescenceBuilder
     include RawDirectedTreeBuilder
     include Extended
+
+    def leaves
+      terminal_nodes.delete_if do |node|
+        out_degree(node) > 0
+      end
+    end
+
+    def leaf?(node)
+      terminal?(node) && out_degree(node) == 0
+    end
+
+    def leaves?(*nodes)
+      nodes.to_a.flatten.all? { |node| leaf?(node) }
+    end
   end
 end

data/lib/jumoku/builders/raw_directed_tree.rb

@@ -21,8 +21,13 @@ module Jumoku
     # @return enhanced Plexus::DirectedGraph
     #
     def initialize(*params)
+      args = (params.pop if params.last.is_a? Hash) || {}
+      strategies = _extract_strategies(args)
+
       super(*params) # Delegates to Plexus.
+
       class << self; self; end.module_eval do
+        strategies.each { |strategy| include strategy }
         alias has_branch? has_arc?
       end
     end

data/lib/jumoku/builders/raw_undirected_tree.rb

@@ -25,8 +25,13 @@ module Jumoku
     # @return enhanced Plexus::UndirectedGraph
     #
     def initialize(*params)
+      args = (params.pop if params.last.is_a? Hash) || {}
+      strategies = _extract_strategies(args)
+
       super(*params) # Delegates to Plexus.
+
       class << self; self; end.module_eval do
+        strategies.each { |strategy| include strategy }
         alias has_branch? has_edge?
       end
     end

data/lib/jumoku/builders/shared.rb

@@ -21,13 +21,13 @@ module Jumoku
     # @overload add_node!(b)
     #   @param [Branch] b Branch[node i, node j, label l = nil]; if i (j) already exists, then j (i) must not exist
     # @return [RawTree] self
-    def add_node! u, v = nil
+    def add_node! u, v = nil, l = nil
       if nodes.empty?
-        add_vertex! u
+        add_vertex! u, l
       elsif u.is_a? _branch_type
-        add_branch! u
+        add_branch! u, nil, l
       elsif not v.nil?
-        add_branch! u, v
+        add_branch! u, v, l
       else
         # Ensure the connected constraint.
         raise RawTreeError, "In order to add a node to the tree, you must specify another node to attach to."
@@ -153,7 +153,6 @@ module Jumoku
       end
     end
     alias boundaries terminal_nodes
-    alias leaves terminal_nodes
 
     # The branches of the tree in a 1D array.
     #
@@ -164,10 +163,9 @@ module Jumoku
 
     # Tree helpers.
 
-    # Checks whether the tree is *really* a valid tree, that is if the
-    # following conditions are fulfilled:
+    # Checks whether the tree is a valid tree (directed or undirected), that is
+    # if the following conditions are fulfilled:
     #
-    # * undirected
     # * acyclic
     # * connected
     #
@@ -180,12 +178,9 @@ module Jumoku
     #
     # @return [Boolean]
     def terminal? u
-      if has_node? u
-        # root is always terminal, otherwise check whether degree is unitary
-        nodes == [u] ? true : (degree(u) == 1)
-      else
-        raise UndefinedNode, "Not a node of this tree."
-      end
+      raise UndefinedNode, "Not a node of this tree." unless has_node? u
+      return true if (1..2).include? nodes.size
+      degree(u) == 1
     end
     alias has_terminal_node? terminal?
     alias leaf? terminal?
@@ -211,5 +206,16 @@ module Jumoku
     def _clone
       self.class.new(self)
     end
+
+    def _extract_strategies(options)
+      options.inject([]) do |strategies, (k,v)|
+        begin
+          strategies << Jumoku.const_get(k.to_s.constantize).const_get(v.to_s.constantize)
+          strategies
+        rescue NameError # silently ignored
+          strategies
+        end
+      end
+    end
   end
 end

data/lib/jumoku/ext/ext.rb

@@ -1,3 +1,4 @@
+# FIXME: nest this into Jumoku's namespace and inherit from stdlib classes
 class Array
   # Takes a flat array of nodes pairs and yield
   # them to the block.
@@ -54,3 +55,9 @@ class Array
     branches
   end
 end
+
+class String
+  def constantize
+    to_s.gsub(/(_|^)(\w)/) { $2.upcase }
+  end
+end

data/lib/jumoku/strategies/edge_labeling.rb

@@ -0,0 +1,25 @@
+module Jumoku
+  module EdgeLabeling
+    module Backend
+      # Sort edges by the provided block's logic. The block takes edge as
+      # parameter, and this method delegates to Enumerable#sort_by for
+      # sorting edges. Return unsorted edges list if no block is provided.
+      #
+      # @return [Array]
+      #
+      def sort_edges(&block)
+        return edges.sort_by { |edge| block.call(edge) } if block_given?
+        edges
+      end
+
+      private
+
+      # Callback triggered when labeling a new edge. Does nothing by default.
+      # Labeling strategies may implement their own logic and call super to
+      # chain callbacks, or impose their behavior (caution!).
+      #
+      def _edge_labeling_inc
+      end
+    end
+  end
+end

data/lib/jumoku/strategies/edge_labeling/simple.rb

@@ -0,0 +1,75 @@
+module Jumoku
+  module EdgeLabeling
+    # A simple edge labeling strategy: as new nodes are added, new edges are
+    # assigned increasing integers. Removed edges do not trigger reindexing,
+    # so for a tree with n nodes, the labeling set is ||n|| but indexes are
+    # not necessarily < n (indexing starts from 0).
+    #
+    # This simple strategy allows for using simple search algorithms as well
+    # for simple ordering schemes.
+    #
+    module Simple
+      include EdgeLabeling::Backend
+
+      attr_accessor :next_simple_edge_label_number
+
+      # Override to handle an iterator for simple edge labeling. When a branch
+      # is added, it is labeled with an OpenHash with one :_weight key which
+      # value is an increasing integer. One may pass any custom label to the
+      # method, which will be available under the :label key of the hash.
+      #
+      def add_branch!(u, v = nil, l = nil)
+        self.next_simple_edge_label_number ||= 0
+        label = OpenHash.new(:_weight => self.next_simple_edge_label_number)
+        label.label = l unless l.nil?
+        super(u, v, label)
+        _edge_labeling_inc
+      end
+
+      # Sort edges by increasing weight number. If a block is provided, rely
+      # on the backend implementation (#sort_by).
+      #
+      # @return [Array]
+      #
+      def sort_edges(&block)
+        return super(&block) if block_given?
+        edges.sort { |a,b| a.label._weight <=> b.label._weight }
+      end
+
+      # Only for directed trees.
+      #
+      # Return the sorted list of arcs branched out from the specified node.
+      #
+      # @param [Node] node
+      # @return [Array<Plexus::Arc>]
+      #
+      def sorted_arcs_from(node)
+        return nil unless is_a? RawDirectedTreeBuilder
+        adjacent(node).map do |child_node|
+          edge_class[node, child_node, edge_label(node, child_node)]
+        end.sort_by { |e| e.label._weight }
+      end
+      alias sorted_edges_from sorted_arcs_from # for lazy people
+
+      # Only for directed trees.
+      #
+      # Return the sorted list of nodes branched out from the specified node.
+      #
+      # @param [Node] node
+      # @return [Array<Node>]
+      #
+      def sorted_children_of(node)
+        return nil unless is_a? RawDirectedTreeBuilder
+        sorted_edges_from(node).map { |edge| edge.target }
+      end
+
+      private
+
+      def _edge_labeling_inc
+        self.next_simple_edge_label_number ||= 0
+        self.next_simple_edge_label_number += 1
+        super
+      end
+    end
+  end
+end

data/lib/jumoku/version.rb

@@ -1,6 +1,6 @@
 module Jumoku
   MAJOR = 0
   MINOR = 2
-  PATCH = 2
+  PATCH = 3
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/spec/arborescence_spec.rb

@@ -7,8 +7,42 @@ describe Arborescence do
   let(:branch_type) { subject.send :_branch_type }
 
   it_should_behave_like "a legacy tree"
+
   it "should be a directed graph" do
     tree.class.ancestors.should include RawDirectedTreeBuilder
   end
+
   it_should_behave_like "a tree with extended features"
+
+  context "leaf nodes inspection" do
+    before :each do
+      tree.add_branches! 1,2, 2,3, 1,4, 1,5
+    end
+
+    describe "#leaves" do
+      it "should list the leaf nodes" do
+        tree.leaves.sort.should == [3,4,5]
+      end
+    end
+
+    describe "#leaf?" do
+      it "should check whether a node is a leaf" do
+        tree.leaf?(1).should be_false
+        tree.leaf?(2).should be_false
+        tree.leaf?(3).should be_true
+        tree.leaf?(4).should be_true
+        tree.leaf?(5).should be_true
+      end
+    end
+
+    describe "#leaves?" do
+      it "should check whether each node of a list is a leaf" do
+        tree.leaves?(1).should be_false
+        tree.leaves?(1,2).should be_false
+        tree.leaves?(1,2,3).should be_false
+        tree.leaves?(3,4).should be_true
+        tree.leaves?(3,4,5).should be_true
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,9 +2,6 @@ require File.expand_path("../../lib/jumoku.rb",  __FILE__)
 require File.expand_path("../behaviors/core_tree.rb",  __FILE__)
 require File.expand_path("../behaviors/extended.rb",  __FILE__)
 
-require 'jumoku'
-include Jumoku
-
 RSpec.configure do |config|
   # Remove this line if you don't want RSpec's should and should_not
   # methods or matchers
@@ -13,4 +10,7 @@ RSpec.configure do |config|
 
   # == Mock Framework
   config.mock_with :rspec
+
+  require 'jumoku'
+  include Jumoku
 end

data/spec/strategies/simple_edge_labeling.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe EdgeLabeling::Simple do
+  let(:tree) { Tree.new(:edge_labeling => :simple) }
+  let(:arbo) { Arborescence.new(:edge_labeling => :simple) }
+
+  describe 'a tree with simple edge labeling' do
+    it "should label its edges with increasing integers when new nodes are added or removed" do
+      tree.add_node! 1
+      tree.add_node! 1, 2 # adding edge 0
+      edge = tree.edges.first
+      edge.label.should be_an OpenHash
+      edge.label._weight.should == 0
+
+      tree.add_branch! 2, 3 # adding edge 1
+      tree.edges.all? { |e| e.label.is_a? OpenHash }.should be_true
+      tree.edges.map { |e| e.label._weight }.sort.should == [0,1]
+
+      tree.remove_node! 1 # removing edge 0
+      tree.add_node! 3, 4 # adding edge 2
+      tree.add_node! 2, 5 # adding edge 3
+      tree.add_node! 5, 6 # adding edge 4
+      tree.remove_node! 6 # removing edge 4
+      tree.add_node! 5, 7 # adding edge 5
+      tree.edges.map { |e| e.label._weight }.sort.should == [1,2,3,5]
+    end
+
+    describe "#sort_edges" do
+      it "should by default return the list of edges in (increasing) order" do
+        tree.add_branches! 1,2, 1,3, 2,4, 1,5, 3,6, 1,7
+        tree.sort_edges.map { |e| e.label._weight }.should == (0..5).to_a
+      end
+
+      it "should accept a block to sort edges" do
+        # for the sake of this specs, one'd actually #reverse the default sorting ;)
+        tree.add_branches! 1,2, 1,3, 2,4, 1,5, 3,6, 1,7
+        tree.sort_edges do |edge|
+          -edge.label._weight
+        end.map { |e| e.label._weight }.should == (0..5).to_a.reverse
+      end
+    end
+
+    it "should thus allow for local edge and children ordering (directed trees only)" do
+      arbo.add_branches! 1,2, 1,3, 2,4, 1,5, 3,6, 1,7
+      arbo.sorted_arcs_from(1).map { |e| e.target }.should == [2,3,5,7]
+      arbo.sorted_children_of(1).should == [2,3,5,7]
+    end
+
+    it "should return nil when asking for nodes ordering on an undirected tree" do
+      tree.add_branches! 1,2, 1,3, 2,4, 1,5, 3,6, 1,7
+      tree.sorted_arcs_from(1).should == nil
+      tree.sorted_children_of(1).should == nil
+    end
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: jumoku
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jean-Denis Vauguet <jd@vauguet.fr>
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-10 00:00:00 +02:00
+date: 2011-07-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -40,54 +32,53 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: plexus
+  name: hashery
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: plexus
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: Jumoku provides you with tree behaviors to mixin and tree classes to inherit from. Raw tree, common binary trees, custom trees...
 email: jd@vauguet.fr
 executables: []
@@ -107,6 +98,8 @@ files:
 - lib/jumoku/builders/raw_directed_tree.rb
 - lib/jumoku/raw_tree_node.rb
 - lib/jumoku/classes/tree_classes.rb
+- lib/jumoku/strategies/edge_labeling/simple.rb
+- lib/jumoku/strategies/edge_labeling.rb
 - lib/jumoku/support/support.rb
 - lib/jumoku/support/ruby_compatibility.rb
 - lib/jumoku/support/branch.rb
@@ -114,6 +107,7 @@ files:
 - spec/spec.opts
 - spec/arborescence_spec.rb
 - spec/spec_helper.rb
+- spec/strategies/simple_edge_labeling.rb
 - spec/raw_directed_tree_spec.rb
 - spec/raw_undirected_tree_spec.rb
 - spec/tree_spec.rb
@@ -137,18 +131,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []