rubytree 0.6.0 → 0.6.1

data/COPYING

@@ -1,4 +1,4 @@
-= Rubytree
+= RubyTree
 
 http://rubytree.rubyforge.org
 
@@ -26,4 +26,4 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSE
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-$Id: COPYING 143 2010-01-02 09:10:16Z anupamsg $
+$Id: COPYING 163 2010-01-03 19:38:25Z anupamsg $

data/ChangeLog

@@ -1,3 +1,19 @@
+2010-01-05  Anupam Sengupta  <anupamsg@gmail.com>
+
+	* README: Updated the requirements section.
+
+	* Rakefile: Removed the hard run-time dependency on
+	'structured_warnings' gem.  The library will still be used if
+	available on the user's system.
+
+	* test/test_tree.rb: Changed the tests to sync with the
+	soft-dependency on 'structured_warnings'.
+
+	* lib/tree.rb (Tree::TreeNode#depth): Removed the hard
+	dependency on 'structured_warnings' RubyGem.  Changed to a soft
+	dependency that degrades well to a standard warning mechanism if
+	the Gem is not available.
+
 2010-01-03  Anupam Sengupta  <anupamsg@gmail.com>
 
 	* lib/tree.rb (Tree::TreeNode#nodeDepth): Added the nodeDepth and
@@ -191,4 +207,4 @@
 
 	* Changelog: Added the Changelog file.
 
-$Id: ChangeLog 154 2010-01-03 18:01:28Z anupamsg $
+$Id: ChangeLog 164 2010-01-04 19:27:12Z anupamsg $

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.6.1 / 2010-01-04
+
+* Changed the hard-dependency on the 'structured_warnings' RubyGem to a soft-dependency - which lets Rubytree still
+  work if this RubyGem is not available.  The rationale for this is that we should not require the user to install a
+  separate library just for one single edge-case function (in this case, to indicate a deprecated method).  However, if
+  the library _is_ available on the user's system, then it will get used.
+
 === 0.6.0 / 2010-01-03
 
 * Fixed the bug#22535[http://rubyforge.org/tracker/index.php?func=detail&aid=22535&group_id=1215&atid=4793] where the
@@ -33,4 +40,4 @@
 
 * Minor code refactoring. Changes in the Rakefile.
 
-$Id: History.txt 156 2010-01-03 18:06:22Z anupamsg $
+$Id: History.txt 164 2010-01-04 19:27:12Z anupamsg $

data/README

@@ -11,7 +11,7 @@
 
 == DESCRIPTION:
 
-Rubytree is a Ruby implementation of the generic Tree data structure.  It provides a generic tree data-structure with
+RubyTree is a Ruby implementation of the generic Tree data structure.  It provides a generic tree data-structure with
 ability to store keyed node-elements in the tree.  This implementation is node-centric, where the individual nodes on
 the tree are the primary objects and form the leafs of the structure.  The implementation mixes in the Enumerable
 module.
@@ -58,15 +58,17 @@ As an example, the following code-snippet implements this tree structure:
 
 * Ruby 1.8+  (http://www.ruby-lang.org)
 * Hoe (http://seattlerb.rubyforge.org/hoe/Hoe.html) Rubygem
-* structured_warnings (http://github.com/schmidt/structured_warnings) Rubygem
+
+* Optional but recommended:
+  * structured_warnings (http://github.com/schmidt/structured_warnings) Rubygem
 
 == INSTALL:
 
-Rubytree is an open source project and is hosted at:
+RubyTree is an open source project and is hosted at:
 
 http://rubytree.rubyforge.org
 
-Rubytree can be downloaded as a Rubygem or as a tar/zip file from:
+RubyTree can be downloaded as a Rubygem or as a tar/zip file from:
 
 http://rubyforge.org/frs/?group_id=1215&release_id=8817
 
@@ -78,7 +80,7 @@ The file-name is one of:
 
 Download the appropriate file-type for your system.
 
-It is recommended to install Rubytree as a Ruby Gem, as this is an easy way to keep the version updated, and keep
+It is recommended to install RubyTree as a Ruby Gem, as this is an easy way to keep the version updated, and keep
 multiple versions of the library available on your system.
 
 === Installing the Gem
@@ -87,7 +89,7 @@ To Install the Gem, from a Terminal/CLI command prompt, issue the command:
 
   $ gem install rubytree
 
-This should install the gem file for Rubytree. Note that you may need to be a super-user (root) to successfully install
+This should install the gem file for RubyTree. Note that you may need to be a super-user (root) to successfully install
 the gem.
 
 === Installing from the tgz/zip file
@@ -123,7 +125,7 @@ tasks.
 
 == LICENSE:
 
-Rubytree is licensed under the BSD[http://www.opensource.org/licenses/bsd-license.php] license.
+RubyTree is licensed under the BSD[http://www.opensource.org/licenses/bsd-license.php] license.
 
 Copyright (c) 2006, 2007 Anupam Sengupta
 All rights reserved.
@@ -149,4 +151,4 @@ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWIS
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
-(Document Revision: $Revision: 158 $ by $Author: anupamsg $)
+(Document Revision: $Revision: 164 $ by $Author: anupamsg $)

data/Rakefile

@@ -2,7 +2,7 @@
 #
 # Rakefile
 #
-# $Revision: 154 $ by $Author: anupamsg $ on $Date: 2010-01-03 23:31:28 +0530 (Sun, 03 Jan 2010) $
+# $Revision: 164 $ by $Author: anupamsg $ on $Date: 2010-01-05 00:57:12 +0530 (Tue, 05 Jan 2010) $
 #
 # Copyright (c) 2006, 2007 Anupam Sengupta
 #
@@ -50,7 +50,6 @@ begin
     self.extra_rdoc_files           = ['README', 'COPYING', 'ChangeLog']
     self.url                        =  "http://rubytree.rubyforge.org"
     self.readme_file                = 'README'
-    self.extra_deps                 << ['structured_warnings', '>= 0.1.3']
     # Set the RDoc Options.
     self.spec_extras[:rdoc_options] = ['--main', 'README', '--line-numbers']
     self.spec_extras[:has_rdoc]     = true

data/lib/tree.rb

@@ -1,6 +1,6 @@
 # tree.rb
 #
-# $Revision: 154 $ by $Author: anupamsg $ on $Date: 2010-01-03 23:31:28 +0530 (Sun, 03 Jan 2010) $
+# $Revision: 164 $ by $Author: anupamsg $ on $Date: 2010-01-05 00:57:12 +0530 (Tue, 05 Jan 2010) $
 #
 # = tree.rb - Generic Multi-way Tree implementation
 #
@@ -41,15 +41,13 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-require 'structured_warnings'   # To enable the deprecation of the depth method.
-
 # This module provides a TreeNode class which is the primary class for all
 # nodes represented in the Tree.
 # This module mixes in the Enumerable module.
 module Tree
 
   # Rubytree Package Version
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 
   # == TreeNode Class Description
   #
@@ -492,7 +490,15 @@ module Tree
     # For correct and conventional behavior, please use Tree::TreeNode#nodeDepth and Tree::TreeNode#nodeHeight methods
     # instead.
     def depth
-      warn DeprecatedMethodWarning, 'This method is deprecated.  Please use nodeDepth or nodeHeight instead (bug # 22535)'
+      begin
+        require 'structured_warnings'   # To enable a nice way of deprecating of the depth method.
+        warn DeprecatedMethodWarning, 'This method is deprecated.  Please use nodeDepth() or nodeHeight() instead (bug # 22535)'
+      rescue LoadError
+        # Oh well. Will use the standard Kernel#warn.  Behavior will be identical.
+        warn 'Tree::TreeNode#depth() method is deprecated.  Please use nodeDepth() or nodeHeight() instead (bug # 22535)'
+      end
+
+
       return 1 if isLeaf?
       1 + @children.collect { |child| child.depth }.max
     end

data/test/test_tree.rb

@@ -2,7 +2,7 @@
 
 # testtree.rb
 #
-# $Revision: 154 $ by $Author: anupamsg $ on $Date: 2010-01-03 23:31:28 +0530 (Sun, 03 Jan 2010) $
+# $Revision: 164 $ by $Author: anupamsg $ on $Date: 2010-01-05 00:57:12 +0530 (Tue, 05 Jan 2010) $
 #
 # Copyright (c) 2006, 2007, 2008, 2009, 2010 Anupam Sengupta
 #
@@ -36,7 +36,6 @@
 
 require 'test/unit'
 require 'tree'
-require 'structured_warnings'
 
 module TestTree
   # Test class for the Tree node.
@@ -511,22 +510,31 @@ module TestTree
     # Test the depth computation algorithm.  Note that this is an incorrect computation and actually returns height+1
     # instead of depth.  This method has been deprecated in this release and may be removed in the future.
     def test_depth
-      assert_warn(DeprecatedMethodWarning) do
-        assert_equal(1, @root.depth, "A single node's depth is 1")
+      begin
+        require 'structured_warnings'
+        assert_warn(DeprecatedMethodWarning) { do_deprecated_depth }
+      rescue LoadError
+        # Since the structued_warnings package is not present, we revert to good old Kernel#warn behavior.
+        do_deprecated_depth
+      end
+    end
 
-        @root << @child1
-        assert_equal(2, @root.depth, "This should be of depth 2")
+    # Run the assertions for the deprecated depth method.
+    def do_deprecated_depth
+      assert_equal(1, @root.depth, "A single node's depth is 1")
+
+      @root << @child1
+      assert_equal(2, @root.depth, "This should be of depth 2")
 
-        @root << @child2
-        assert_equal(2, @root.depth, "This should be of depth 2")
+      @root << @child2
+      assert_equal(2, @root.depth, "This should be of depth 2")
 
-        @child2 << @child3
-        assert_equal(3, @root.depth, "This should be of depth 3")
-        assert_equal(2, @child2.depth, "This should be of depth 2")
+      @child2 << @child3
+      assert_equal(3, @root.depth, "This should be of depth 3")
+      assert_equal(2, @child2.depth, "This should be of depth 2")
 
-        @child3 << @child4
-        assert_equal(4, @root.depth, "This should be of depth 4")
-      end
+      @child3 << @child4
+      assert_equal(4, @root.depth, "This should be of depth 4")
     end
 
     # Test the height computation algorithm

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubytree
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - Anupam Sengupta
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-04 00:00:00 +05:30
+date: 2010-01-05 00:00:00 +05:30
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: structured_warnings
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.1.3
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -33,7 +23,7 @@ dependencies:
         version: 2.4.0
     version: 
 description: |-
-  Rubytree is a Ruby implementation of the generic Tree data structure.  It provides a generic tree data-structure with
+  RubyTree is a Ruby implementation of the generic Tree data structure.  It provides a generic tree data-structure with
   ability to store keyed node-elements in the tree.  This implementation is node-centric, where the individual nodes on
   the tree are the primary objects and form the leafs of the structure.  The implementation mixes in the Enumerable
   module.
@@ -91,7 +81,7 @@ rubyforge_project: rubytree
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Rubytree is a Ruby implementation of the generic Tree data structure
+summary: RubyTree is a Ruby implementation of the generic Tree data structure
 test_files: 
 - test/test_binarytree.rb
 - test/test_tree.rb