Fixed the <=> operator, and added Rspec tests.

evolve75 · evolve75 · commit 3858262b934f · 2015-12-31T23:05:32.000-05:00
This is for addressing bug report #50. Also, Added retrieval of the parent node in the example code.
diff --git a/Gemfile b/Gemfile
@@ -7,6 +7,7 @@ group :development, :test do
   gem "rake", "~> 10.4"
   gem "test-unit", "~> 3.0"
   gem "coveralls", ">= 0.7", :require => false, :platforms => :mri_21
+  gem "rspec", ">= 3.4"
 end
 
 # Local Variables:
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,49 +1,65 @@
 PATH
   remote: .
   specs:
-    rubytree (0.9.6)
+    rubytree (0.9.7)
       json (~> 1.8)
       structured_warnings (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.8.2)
+    coveralls (0.8.10)
       json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.10.0)
+      simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    diff-lcs (1.2.5)
     docile (1.1.5)
-    domain_name (0.5.24)
+    domain_name (0.5.25)
       unf (>= 0.0.5, < 1.0.0)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     json (1.8.3)
-    mime-types (2.6.1)
-    netrc (0.10.3)
-    power_assert (0.2.3)
+    mime-types (2.99)
+    netrc (0.11.0)
+    power_assert (0.2.6)
     rake (10.4.2)
-    rdoc (4.2.0)
+    rdoc (4.2.1)
+      json (~> 1.4)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     rtags (0.97)
     rtagstask (0.0.4)
       rtags (> 0.0.0)
-    simplecov (0.10.0)
+    simplecov (0.11.1)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     structured_warnings (0.2.0)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
-    test-unit (3.1.2)
+    test-unit (3.1.5)
       power_assert
     thor (0.19.1)
-    tins (1.5.4)
+    tins (1.6.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
@@ -57,6 +73,7 @@ DEPENDENCIES
   coveralls (>= 0.7)
   rake (~> 10.4)
   rdoc (~> 4.2)
+  rspec (>= 3.4)
   rtagstask (~> 0.0)
   rubytree!
   test-unit (~> 3.0)
diff --git a/History.rdoc b/History.rdoc
@@ -1,5 +1,19 @@
 = History of Changes
 
+=== 0.9.7 / 2015-12-31
+
+* Released 0.9.6. This is a minor bug-fix release.
+
+* This release allows the {Tree::TreeNode#print_tree} method to be used on
+  non-root nodes. Thanks to {https://github.com/ojab Ojab}.
+
+* The spaceship operator ('<=>') now returns 'nil' if the object being compared
+  to is itself 'nil' or not another {Tree::TreeNode}.
+
+=== 0.9.6 / 2015-05-30
+
+* Released 0.9.6, which is same as 0.9.5, except for an update to the Gem release date.
+
 === 0.9.5 / 2015-05-30
 
 * Released 0.9.5.
diff --git a/README.md b/README.md
@@ -129,6 +129,7 @@ This example can also be found at
     * [Bundler][] for creating the stable build environment
     * [Rake][] for building the package
     * [Yard][] for the documentation
+    * [RSpec][] for additional Ruby Spec test files
 
 ## INSTALL: ##
 
@@ -260,6 +261,6 @@ A big thanks to the following contributors for helping improve **RubyTree**:
 [rt_site]:              http://rubytree.anupamsg.me "RubyTree Site"
 [structured_warnings]:  http://github.com/schmidt/structured_warnings "structured_warnings"
 [tree_data_structure]:  http://en.wikipedia.org/wiki/Tree_data_structure "Tree Data Structure"
-
+[RSpec]:                https://relishapp.com/rspec/
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/evolve75/rubytree/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
diff --git a/Rakefile b/Rakefile
@@ -45,6 +45,7 @@ task :default do
     Rake::Task["test:coverage"].invoke
   else
     Rake::Task["test:unit"].invoke
+    Rake::Task["spec"].invoke
   end
 end
 
@@ -133,6 +134,17 @@ namespace :test do              # ................................ Test related
 
 end
 
+begin                            # ................................ rspec tests
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.fail_on_error = false
+    t.rspec_opts = ["--color", "--format doc"]
+  end
+rescue LoadError
+  # Cannot load rspec.
+end
+
  namespace :tag do               # ................................ Emacs Tags
   begin
     require 'rtagstask'
diff --git a/examples/example_basic.rb b/examples/example_basic.rb
@@ -3,8 +3,8 @@
 # example_basic.rb:: Basic usage of the tree library.
 #
 # Author:  Anupam Sengupta
-# Time-stamp: <2013-12-28 12:14:20 anupam>
-# Copyright (C) 2013 Anupam Sengupta <anupamsg@gmail.com>
+# Time-stamp: <2015-12-31 22:17:30 anupam>
+# Copyright (C) 2013, 2015 Anupam Sengupta <anupamsg@gmail.com>
 #
 # The following example implements this tree structure:
 #
@@ -46,6 +46,9 @@
 # ..... Lets retrieve immediate children of the root node as an array.
 children_of_root = root_node.children
 
+# ..... Retrieve the parent of a node.
+parent = child1.parent
+
 # ..... This is a depth-first and L-to-R pre-ordered traversal.
 root_node.each { |node| node.content.reverse }
 
diff --git a/lib/tree.rb b/lib/tree.rb
@@ -922,9 +922,10 @@ def previous_sibling
     # @param [Tree::TreeNode] other The other node to compare against.
     #
     # @return [Integer] +1 if this node is a 'successor', 0 if equal and -1 if
-    #                   this node is a 'predecessor'.
+    #                   this node is a 'predecessor'. Returns 'nil' if the other
+    #                   object is not a 'Tree::TreeNode'.
     def <=>(other)
-      return +1 if other == nil
+      return nil if other == nil || other.class != Tree::TreeNode
       self.name <=> other.name
     end
 
diff --git a/lib/tree/version.rb b/lib/tree/version.rb
@@ -37,5 +37,5 @@
 #
 module Tree
   # Rubytree Package Version
-  VERSION = '0.9.6'
+  VERSION = '0.9.7'
 end
diff --git a/rubytree.gemspec b/rubytree.gemspec
@@ -12,7 +12,7 @@ require "tree/version"
 
 Gem::Specification.new do |s|
   s.name                  = 'rubytree'
-  s.date                  = '2015-05-30'
+  s.date                  = '2015-12-31'
   s.version               = Tree::VERSION
   s.license               = 'BSD'
 
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
   s.files                = Dir['lib/**/*.rb']  # The actual code
   s.files               += Dir['[A-Z]*']       # Various documentation files
   s.files               += Dir['test/**/*.rb'] # Test cases
+  s.files               += Dir['spec/**/*.rb'] # Rspec Test cases
   s.files               += Dir['examples/**/*.rb'] # Examples
 
   s.files               += ['.gemtest']        # Support for gem-test
@@ -74,6 +75,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rdoc'            , '~> 4.2'
   s.add_development_dependency 'yard'            , '~> 0.8'
   s.add_development_dependency 'rtagstask'       , '~> 0.0'
+  s.add_development_dependency 'rspec'           , '~> 3.4'
 
   s.post_install_message = <<-EOF
     ========================================================================
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+# spec_helper.rb
+#
+# Author:  Anupam Sengupta
+# Time-stamp: <2015-12-31 21:00:36 anupam>
+# Copyright (C) 2015 Anupam Sengupta <anupamsg@gmail.com>
+#
+
+require "tree"
diff --git a/spec/tree_spec.rb b/spec/tree_spec.rb
@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+#
+# tree_spec.rb
+#
+# Author:  Anupam Sengupta
+# Time-stamp: <2015-12-31 22:57:59 anupam>
+# Copyright (C) 2015 Anupam Sengupta <anupamsg@gmail.com>
+#
+
+require "rspec"
+require "spec_helper"
+
+describe Tree do
+
+  shared_examples_for "any detached node" do
+    it 'should not equal "Object.new"' do
+      expect(@tree).not_to eq(Object.new)
+    end
+    it 'should not equal 1 or any other fixnum' do
+      expect(@tree).not_to eq(1)
+    end
+    it 'identifies itself as a root node' do
+      expect(@tree.is_root?).to eq(true)
+    end
+    it "does not have a parent node" do
+      expect(@tree.parent).to eq(nil)
+    end
+
+  end
+  context "#initialize", "with empty name and nil content" do
+    before(:each) do
+      @tree = Tree::TreeNode.new("")
+    end
+    it 'creates the tree node with name as ""' do
+      expect(@tree.name).to eq("")
+    end
+    it "has 'nil' content" do
+      expect(@tree.content).to eq(nil)
+    end
+
+    it_behaves_like "any detached node"
+  end
+
+  context "#initialize", "with name 'A' and nil content" do
+    before(:each) do
+      @tree = Tree::TreeNode.new("A")
+    end
+
+    it 'creates the tree node with name as "A"' do
+      expect(@tree.name).to eq("A")
+    end
+    it "has 'nil' content" do
+      expect(@tree.content).to eq(nil)
+    end
+
+    it_behaves_like "any detached node"
+  end
+
+  context "#initialize", "with node name 'A' and some content" do
+    before(:each) do
+      @sample = "sample"
+      @tree = Tree::TreeNode.new("A", @sample)
+    end
+
+    it 'creates the tree node with name as "A"' do
+      expect(@tree.name).to eq("A")
+    end
+    it "has some content #{@sample}" do
+      expect(@tree.content).to eq(@sample)
+    end
+
+    it_behaves_like "any detached node"
+  end
+end
diff --git a/test/test_tree.rb b/test/test_tree.rb
@@ -316,7 +316,7 @@ def test_spaceship
       first_node  = Tree::TreeNode.new(1)
       second_node = Tree::TreeNode.new(2)
 
-      assert_equal(+1, first_node <=> nil)
+      assert_nil(first_node <=> nil)
       assert_equal(-1, first_node <=> second_node)
 
       second_node = Tree::TreeNode.new(1)
@@ -325,7 +325,7 @@ def test_spaceship
       first_node  = Tree::TreeNode.new("ABC")
       second_node = Tree::TreeNode.new("XYZ")
 
-      assert_equal(+1, first_node <=> nil)
+      assert_nil(first_node <=> nil)
       assert_equal(-1, first_node <=> second_node)
 
       second_node = Tree::TreeNode.new("ABC")

Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@`
`3`	`3`	`# example_basic.rb:: Basic usage of the tree library.`
`4`	`4`	`#`
`5`	`5`	`# Author: Anupam Sengupta`
`6`		`-# Time-stamp: <2013-12-28 12:14:20 anupam>`
`7`		`-# Copyright (C) 2013 Anupam Sengupta <anupamsg@gmail.com>`
	`6`	`+# Time-stamp: <2015-12-31 22:17:30 anupam>`
	`7`	`+# Copyright (C) 2013, 2015 Anupam Sengupta <anupamsg@gmail.com>`
`8`	`8`	`#`
`9`	`9`	`# The following example implements this tree structure:`
`10`	`10`	`#`
`@@ -46,6 +46,9 @@`
`46`	`46`	`# ..... Lets retrieve immediate children of the root node as an array.`
`47`	`47`	`children_of_root = root_node.children`
`48`	`48`
	`49`	`+# ..... Retrieve the parent of a node.`
	`50`	`+parent = child1.parent`
	`51`	`+`
`49`	`52`	`# ..... This is a depth-first and L-to-R pre-ordered traversal.`
`50`	`53`	`root_node.each { \|node\| node.content.reverse }`
`51`	`54`
Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,5 @@`
`37`	`37`	`#`
`38`	`38`	`module Tree`
`39`	`39`	`# Rubytree Package Version`
`40`		`- VERSION = '0.9.6'`
	`40`	`+ VERSION = '0.9.7'`
`41`	`41`	`end`