rubytree 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dbe7b7742a7beba443f03362ae6022369091af3
-  data.tar.gz: abd8e15e9c052a75c19d2f73e9083aedbf8e24af
+  metadata.gz: 76d30f00380e7ea4594dda970de679d6949a61b9
+  data.tar.gz: 11a9fe380940e988200f84e2f69dff3752e4e380
 SHA512:
-  metadata.gz: cd494ba10200d91f96708e6528f07b42f1d8b881b7697ea378168fdade34407a637876bdd8b612558ea144f5bce64624d7c33a41fcb1970ccc3662776ad58d2c
-  data.tar.gz: 9bb44f611d7847eaff5b9888be9e07608583e4b63fc1701f33004fd061e1f685b9c9a2c7b7cfe3c8606d710123fc1068cfd88875260fc33d0e16c5f51f3d4691
+  metadata.gz: b7e9ee7173158d02e55c29ea3122076bc164f3bc180a717bce34bf0ca29d65e9e60bd9f0d13fccb16cf4339e064a56d05e2a0bb120b2bf2a65edb83cef29b7ec
+  data.tar.gz: cf1ced56a4092931a7f8439a466c68a338a3fb86cac941862885bbdd4ac3c34abd8e2c3921e76504681bb075309112cd5b0b5b50faddb9a10e1a7a172c3c7d5f

data/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:

data/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.1)
+    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.2)
-    mime-types (2.6.1)
-    netrc (0.10.3)
-    power_assert (0.2.3)
+    json (1.8.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.0)
+    term-ansicolor (1.3.2)
       tins (~> 1.0)
-    test-unit (3.1.1)
+    test-unit (3.1.5)
       power_assert
     thor (0.19.1)
-    tins (1.5.2)
+    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)

data/History.rdoc

@@ -1,7 +1,19 @@
-# @markup rdoc
-
 = 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.

data/README.md

@@ -11,7 +11,6 @@
 [![Dependency Status](https://gemnasium.com/evolve75/RubyTree.png)](https://gemnasium.com/evolve75/RubyTree)
 [![Code Climate](https://codeclimate.com/github/evolve75/RubyTree.png)](https://codeclimate.com/github/evolve75/RubyTree)
 [![Coverage Status](https://coveralls.io/repos/evolve75/RubyTree/badge.png)](https://coveralls.io/r/evolve75/RubyTree)
-[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/473b881f1075bf9f255f0181dde6068f)](http://githalytics.com/evolve75/RubyTree)
 
 ## DESCRIPTION: ##
 
@@ -104,6 +103,9 @@ siblings_of_child1 = child1.siblings
 # ..... 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 }
 
@@ -130,6 +132,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: ##
 
@@ -261,6 +264,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")

data/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'

data/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 @@ siblings_of_child1 = child1.siblings
 # ..... 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 }
 

data/lib/tree.rb

@@ -922,9 +922,10 @@ module Tree
     # @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
 
@@ -934,7 +935,7 @@ module Tree
     # @param [Integer] max_depth optional maximum depth at which the printing
     #                            with stop.
     # @param [Proc] block optional block to use for rendering
-    def print_tree(level = 0, max_depth = nil,
+    def print_tree(level = node_depth, max_depth = nil,
                    block = lambda { |node, prefix|
                      puts "#{prefix} #{node.name}" })
       prefix = ''

data/lib/tree/version.rb

@@ -37,5 +37,5 @@
 #
 module Tree
   # Rubytree Package Version
-  VERSION = '0.9.6'
+  VERSION = '0.9.7'
 end

data/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
     ========================================================================

data/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"

data/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

data/test/test_tree.rb

@@ -316,7 +316,7 @@ module TestTree
       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 @@ module TestTree
       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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubytree
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Anupam Sengupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-30 00:00:00.000000000 Z
+date: 2015-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: structured_warnings
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 description: |2+
 
       RubyTree is a pure Ruby implementation of the generic tree data structure. It
@@ -154,6 +168,8 @@ files:
 - lib/tree/version.rb
 - rubytree.gemspec
 - setup.rb
+- spec/spec_helper.rb
+- spec/tree_spec.rb
 - test/run_test.rb
 - test/test_binarytree.rb
 - test/test_rubytree_require.rb