dc-util 0.0.2

data/.document

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dorren Chen
+
+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,17 @@
+= dc-util
+
+A library for data structures. Currently only has Node and BinaryNode class.
+
+== 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 Dorren Chen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dc-util"
+    gem.summary = %Q{An utility gem that contains useful data structures.}
+    gem.description = %Q{An utility gem that contains useful data structures, like tree node, etc.}
+    gem.email = "dorrenchen@gmail.com"
+    gem.homepage = "http://github.com/dorren/dc-util"
+    gem.authors = ["Dorren Chen"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dc-util #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/dc-util.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dc-util}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dorren Chen"]
+  s.date = %q{2011-02-01}
+  s.description = %q{An utility gem that contains useful data structures, like tree node, etc.}
+  s.email = %q{dorrenchen@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "dc-util.gemspec",
+    "lib/dc-util.rb",
+    "lib/dc_util.rb",
+    "lib/dc_util/binary_node.rb",
+    "lib/dc_util/node.rb",
+    "spec/binary_node_spec.rb",
+    "spec/node_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dorren/dc-util}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{An utility gem that contains useful data structures.}
+  s.test_files = [
+    "spec/binary_node_spec.rb",
+    "spec/node_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/dc-util.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/dc_util'

data/lib/dc_util.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/dc_util/node'
+require File.dirname(__FILE__) + '/dc_util/binary_node'

data/lib/dc_util/binary_node.rb

@@ -0,0 +1,27 @@
+module DcUtil
+  class BinaryNode < Node
+    # returns left child
+    def left
+      children[0]
+    end
+    
+    # returns right child
+    def right
+      children[1]
+    end
+    
+    # set left child
+    def left=(node)
+      raise ArgumentError.new("not a valid node class") unless node.kind_of? self.class
+      children[0] = node
+      node.parent = self
+    end
+    
+    # set right child
+    def right=(node)
+      raise ArgumentError.new("not a valid node class") unless node.kind_of? self.class
+      children[1] = node
+      node.parent = self
+    end
+  end
+end

data/lib/dc_util/node.rb

@@ -0,0 +1,86 @@
+module DcUtil
+  # a data structure used in tree-like operations.
+  class Node
+    attr_accessor :children, :data, :parent
+  
+    def initialize(options={})
+      self.data = options[:data]
+      self.children = []
+    end
+
+    class << self
+      # breath first search
+      def bfs(node, queue, exclude_root, &block)
+        return if node.nil?
+        block.call(node) unless exclude_root
+
+        node.children.each{|x| queue.push(x)}
+        bfs(queue.shift, queue, false, &block)
+      end
+      
+      # breath first search, non recursive style to prevent stack overflow
+      def bfs_non_recursive(node, queue, exclude_root, &block)
+        return if node.nil?
+        queue.push(node)
+        
+        while not queue.empty?
+          node = queue.shift
+          block.call(node) unless exclude_root
+          node.children.each{|x| queue.push(x)}
+          exclude_root = false
+        end
+      end
+      
+      # depth first search
+      def dfs(node, exclude_root, &block)
+        block.call(node) unless exclude_root
+        node.children.each{|x| dfs(x, false, &block)}
+      end
+    end
+    
+    # add a child node. 
+    def add(node)
+      raise ArgumentError.new("not a valid node class") unless node.kind_of? self.class
+      children << node
+      node.parent = self
+    end
+    
+    def parents
+      parent ? [parent] + parent.parents : []
+    end
+    
+    # breath first search
+    #   root.bfs{|node| puts node.inspect}
+    #
+    #   root.bfs(true){|node| puts node.inspect}  # skip first node
+    def bfs(exclude_root=false, &block)
+      # self.class.bfs(self, [], exclude_root, &block)
+      self.class.bfs_non_recursive(self, [], exclude_root, &block)
+    end
+    
+    # depth first search
+    #   root.dfs{|node| puts node.inspect}
+    #
+    #   root.dfs(true){|node| puts node.inspect}  # skip first node
+    def dfs(exclude_root=false, &block)
+      self.class.dfs(self, exclude_root, &block)
+    end
+    
+    # return all nodes that has no children
+    def leaves
+      arr = []
+      self.dfs do |node|
+        arr << node if node.children.empty?
+      end
+      arr
+    end
+    
+    # return all nodes count
+    def tree_size
+      n = 0
+      dfs{|x| n += 1}
+      n
+    end
+  end
+end
+

data/spec/binary_node_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+include DcUtil
+
+describe DcUtil::BinaryNode do 
+  it "should initialize" do
+    node = BinaryNode.new
+    node.left.should be_nil
+  end
+  
+  it "should add" do
+    node = BinaryNode.new
+    child = BinaryNode.new
+    
+    node.left = child
+    node.left.should == child
+    
+    lambda {node.left = "hello"}.should raise_error
+  end
+  
+  def to_tree(node)
+    node.dfs{|x| 
+      indent = "  " * x.parents.size
+      puts "#{indent}#{x.object_id}"
+    }
+  end
+  
+  it "should do root leaves" do
+    root = BinaryNode.new
+    root.left = node1 = BinaryNode.new
+    root.right = node2 = BinaryNode.new
+    root.leaves.should == [node1, node2]
+  end
+end

data/spec/node_spec.rb

@@ -0,0 +1,130 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+include DcUtil
+
+describe DcUtil::Node do 
+  describe "#new" do
+    it "should initialize" do
+      node = Node.new(:data => 1)
+      node.data.should == 1
+    end
+  end
+
+  describe "#add" do
+    it "should only add node class object as children" do
+      node = Node.new(1)
+      lambda{
+        node.add("something")
+      }.should raise_error(ArgumentError)
+    end
+  
+    it "should work with subclass node as well" do
+      class CoolNode < DcUtil::Node; end
+      class SuperCoolNode < CoolNode; end
+
+      lambda{ # only same or subclass nodes are allowed
+        CoolNode.new(:data => 1).add(Node.new(:data => 2))
+      }.should raise_error(ArgumentError)
+    
+      lambda{
+        CoolNode.new(:data => 1).add(CoolNode.new(:data => 2))
+      }.should_not raise_error
+  
+      lambda{
+        CoolNode.new(:data => 1).add(SuperCoolNode.new(:data => 2))
+      }.should_not raise_error
+    end
+  
+    
+    it "should add children" do
+      node = Node.new(:data => 1)
+      n2 = Node.new(:data => 2)
+      node.add(n2)
+      node.children == [n2]
+      n2.parent.should == node
+    end
+  end
+  
+  describe "#parent" do
+    it "should have parent" do
+      node = Node.new(:data => 1)
+      n2 = Node.new(:data => 2)
+      node.add(n2)
+      n2.parent.should == node
+    end
+    
+    it "should have parents" do
+      node = Node.new(:data => 1)
+      n2 = Node.new(:data => 2)
+      n3 = Node.new(:data => 3)
+      node.add(n2)
+      n2.add(n3)
+      node.parents.should == []
+      n2.parents.should == [node]
+      n3.parents.should == [n2, node]
+    end
+  end
+
+  describe "traversal" do
+    before(:each) do
+      init_tree
+    end
+  
+    def init_tree
+      #             1
+      #         /      \
+      #      2           3
+      #    /   \       /   \
+      #   4     5     6     7
+      #  /\    /
+      # 8  9  10      
+      @tree = Node.new(:data => 1)
+      n2 = Node.new(:data => 2)
+      n3 = Node.new(:data => 3)
+      n4 = Node.new(:data => 4)
+      n5 = Node.new(:data => 5)
+      n6 = Node.new(:data => 6)
+      n7 = Node.new(:data => 7)
+      n8 = Node.new(:data => 8)
+      n9 = Node.new(:data => 9)
+      n10 = Node.new(:data => 10)
+      
+      @tree.add n2
+      @tree.add n3
+      n2.add n4
+      n2.add n5
+      n4.add n8
+      n4.add n9
+      n5.add n10
+      n3.add n6
+      n3.add n7
+    end
+
+    it "should do bfs" do
+      arr = []
+      @tree.bfs{|node| arr << node.data}
+      arr.should == [1,2,3,4,5,6,7,8,9,10]
+    end
+    
+    it "should do bfs exclude root" do
+      arr = []
+      @tree.bfs(true){|node| arr << node.data}
+      arr.should == [2,3,4,5,6,7,8,9,10]
+    end
+    
+    it "should do dfs" do
+      arr = []
+      @tree.dfs{|node| arr << node.data}
+      arr.should == [1,2,4,8,9,5,10,3,6,7]
+    end
+    
+    it "should do dfs exclude root" do
+      arr = []
+      @tree.dfs(true){|node| arr << node.data}
+      arr.should == [2,4,8,9,5,10,3,6,7]
+    end
+    
+    it "should count tree size" do
+      @tree.tree_size.should == 10
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
+require 'dc-util'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: dc-util
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dorren Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: An utility gem that contains useful data structures, like tree node, etc.
+email: dorrenchen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- dc-util.gemspec
+- lib/dc-util.rb
+- lib/dc_util.rb
+- lib/dc_util/binary_node.rb
+- lib/dc_util/node.rb
+- spec/binary_node_spec.rb
+- spec/node_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dorren/dc-util
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An utility gem that contains useful data structures.
+test_files: 
+- spec/binary_node_spec.rb
+- spec/node_spec.rb
+- spec/spec_helper.rb