rubytree 0.9.7 → 2.0.0

data/rubytree.gemspec

@@ -1,55 +1,57 @@
-# -*- encoding: utf-8 -*-
 #
 # gemspec for the rubytree gem.
 #
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
-# Copyright (c) 2012, 2013, 2014, 2015 Anupam Sengupta
-# All rights reserved.
+# Copyright (c) 2012-2022 Anupam Sengupta. All rights reserved.
+#
+# frozen_string_literal: true
 
-$:.unshift File.expand_path("../lib", __FILE__)
-require "tree/version"
+require './lib/tree/version'
 
 Gem::Specification.new do |s|
   s.name                  = 'rubytree'
-  s.date                  = '2015-12-31'
   s.version               = Tree::VERSION
-  s.license               = 'BSD'
-
+  s.license               = 'BSD-3-Clause-Clear'
+  # NOTE: s.date should NOT be assigned. It is automatically set to pkg date.
   s.platform              = Gem::Platform::RUBY
   s.author                = 'Anupam Sengupta'
   s.email                 = 'anupamsg@gmail.com'
   s.homepage              = 'http://rubytree.anupamsg.me'
 
-  s.required_ruby_version = '>=1.8.7'
+  s.required_ruby_version = '>=2.6'
 
-  s.summary               = %q{A generic tree data structure.}
-  s.description           = <<-EOF
+  s.summary               = 'A generic tree data structure for Ruby.'
 
-    RubyTree is a pure Ruby implementation of the generic tree data structure. It
-    provides a node-based model to store named nodes in the tree, and provides
-    simple APIs to access, modify and traverse the structure.
+  s.description           = <<-END_DESC
+    RubyTree is a pure Ruby implementation of the generic tree data
+    structure. It provides a node-based model to store named nodes in the tree,
+    and provides simple APIs to access, modify and traverse the structure.
 
-    The implementation is node-centric, where individual nodes in the tree are the
-    primary structural elements. All common tree-traversal methods (pre-order,
-    post-order, and breadth-first) are supported.
+    The implementation is node-centric, where individual nodes in the tree are
+    the primary structural elements. All common tree-traversal methods
+    (pre-order, post-order, and breadth-first) are supported.
 
-    The library mixes in the Enumerable and Comparable modules to allow access to
-    the tree as a standard collection (iteration, comparison, etc.).
+    The library mixes in the Enumerable and Comparable modules to allow access
+    to the tree as a standard collection (iteration, comparison, etc.).
 
     A Binary tree is also provided, which provides the in-order traversal in
     addition to the other methods.
 
-    RubyTree supports importing from, and exporting to JSON, and also supports the
-    Ruby's standard object marshaling.
+    RubyTree supports importing from, and exporting to JSON, and also supports
+    the Ruby's standard object marshaling.
 
     This is a BSD licensed open source project, and is hosted at
-    http://github.com/evolve75/RubyTree, and is available as a standard gem from
-    http://rubygems.org/gems/rubytree.
+    <https://github.com/evolve75/RubyTree>, and is available as a standard gem
+    from <https://rubygems.org/gems/rubytree>.
+
+    The home page for RubyTree is at <http://rubytree.anupamsg.me>.
 
-    The home page for RubyTree is at http://rubytree.anupamsg.me.
+  END_DESC
 
-  EOF
+  s.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 
   s.files                = Dir['lib/**/*.rb']  # The actual code
   s.files               += Dir['[A-Z]*']       # Various documentation files
@@ -57,34 +59,55 @@ Gem::Specification.new do |s|
   s.files               += Dir['spec/**/*.rb'] # Rspec Test cases
   s.files               += Dir['examples/**/*.rb'] # Examples
 
-  s.files               += ['.gemtest']        # Support for gem-test
+  # @todo: Check if this is really needed.
+  s.files               += ['.gemtest'] # Support for gem-test
 
   s.require_paths        = ['lib']
 
   s.test_files           = Dir.glob('test/**/test_*.rb')
 
-  s.extra_rdoc_files     = ['README.md', 'LICENSE.md',
-                            'API-CHANGES.rdoc', 'History.rdoc']
-  s.rdoc_options         = ["--title", "Rubytree Documentation", "--quiet"]
+  s.extra_rdoc_files     = %w[README.md LICENSE.md API-CHANGES.md History.md]
+  s.rdoc_options         = ['--title', "Rubytree Documentation: #{s.name}-#{s.version}",
+                            '--main', 'README.md',
+                            '--quiet']
+
+  s.add_runtime_dependency 'json', '~> 2.0', '> 2.3.1'
+
+  # NOTE: Rake is added as a development and test dependency in the Gemfile.
+  s.add_development_dependency 'bundler', '~> 2.3'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rdoc', '~> 6.0'
+  s.add_development_dependency 'rspec', '~> 3.0', '> 3.10'
+  s.add_development_dependency 'rtagstask', '~> 0.0.4'
+  s.add_development_dependency 'rubocop', '~> 1.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.0'
+  s.add_development_dependency 'test-unit', '~> 3.0'
+  s.add_development_dependency 'yard', '~> 0.0', '>= 0.9.20'
+
+  s.post_install_message = <<-END_MESSAGE
+    ========================================================================
+                    Thank you for installing RubyTree.
 
-  s.add_runtime_dependency 'structured_warnings' , '~> 0.2'
-  s.add_runtime_dependency 'json'                , '~> 1.8'
+    Note::
 
-  # Note: Rake is added as a development and test dependency in the Gemfile.
-  s.add_development_dependency 'bundler'         , '~> 1.7'
-  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'
+    - 2.0.0 is a major release with BREAKING API changes.
+            See `API-CHANGES.md` for details.
 
-  s.post_install_message = <<-EOF
-    ========================================================================
-                    Thank you for installing RubyTree.
+    - `Tree::TreeNode#depth` method has been removed (it was broken).
 
-    Note:: As of 0.9.5, the Tree::TreeNode#add method has 'move' semantics.
+    - Support for `CamelCase` methods names has bee removed.
 
-    Details of the API changes are documented in the API-CHANGES file.
-    ========================================================================
-  EOF
+    - The predicate methods no longer have `is_` or `has_` prefixes. However,
+      aliases with these prefixes exist to support existing client code.
+
+    - Use of integers as node names does not require the optional
+      `num_as_name` flag.
 
+    - `structured_warnings` is no longer a dependency.
+
+    - Explicit support for rbx Ruby has been removed.
+
+    ========================================================================
+  END_MESSAGE
 end

data/spec/spec_helper.rb

@@ -3,8 +3,10 @@
 # spec_helper.rb
 #
 # Author:  Anupam Sengupta
-# Time-stamp: <2015-12-31 21:00:36 anupam>
-# Copyright (C) 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Time-stamp: <2022-06-19 22:38:14 anupam>
 #
+# Copyright (C) 2015, 2022 Anupam Sengupta <anupamsg@gmail.com>
+#
+# frozen_string_literal: true
 
-require "tree"
+require 'tree'

data/spec/tree_spec.rb

@@ -3,72 +3,171 @@
 # tree_spec.rb
 #
 # Author:  Anupam Sengupta
-# Time-stamp: <2015-12-31 22:57:59 anupam>
-# Copyright (C) 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Time-stamp: <2022-06-20 22:16:11 anupam>
+# Copyright (C) 2015-2022 Anupam Sengupta <anupamsg@gmail.com>
 #
+# frozen_string_literal: true
 
-require "rspec"
-require "spec_helper"
+require 'rspec'
+require 'spec_helper'
 
-describe Tree do
+class SpecializedTreeNode < Tree::TreeNode; end
 
-  shared_examples_for "any detached node" do
-    it 'should not equal "Object.new"' do
-      expect(@tree).not_to eq(Object.new)
+describe Tree do
+  shared_examples_for 'any detached node' do
+    it 'does 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)
+
+    it 'does 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)
+      expect(tree.root?).to be(true)
     end
 
-  end
-  context "#initialize", "with empty name and nil content" do
-    before(:each) do
-      @tree = Tree::TreeNode.new("")
+    it 'does not have a parent node' do
+      expect(tree.parent).to be_nil
     end
+  end
+
+  describe '#initialize with empty name and nil content' do
+    let(:tree) { Tree::TreeNode.new('') }
+
     it 'creates the tree node with name as ""' do
-      expect(@tree.name).to eq("")
+      expect(tree.name).to eq('')
     end
+
     it "has 'nil' content" do
-      expect(@tree.content).to eq(nil)
+      expect(tree.content).to be_nil
     end
 
-    it_behaves_like "any detached node"
+    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
+  describe "#initialize with name 'A' and nil content" do
+    let(:tree) { Tree::TreeNode.new('A') }
 
     it 'creates the tree node with name as "A"' do
-      expect(@tree.name).to eq("A")
+      expect(tree.name).to eq('A')
     end
+
     it "has 'nil' content" do
-      expect(@tree.content).to eq(nil)
+      expect(tree.content).to be_nil
     end
 
-    it_behaves_like "any detached node"
+    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
+  describe "#initialize with node name 'A' and some content" do
+    sample = 'some content'
+    let(:tree) { Tree::TreeNode.new('A', sample) }
 
     it 'creates the tree node with name as "A"' do
-      expect(@tree.name).to eq("A")
+      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
+
+  describe 'comparison' do
+    let(:node1) { Tree::TreeNode.new('a') }
+    let(:node2) { SpecializedTreeNode.new('b') }
+
+    it 'allows comparison of specialized tree nodes' do
+      expect(node1 <=> node2).to be_eql(-1)
+    end
+
+    it 'does not allow comparison with nil' do
+      expect(node1 <=> nil).to be_nil
+    end
+
+    it 'does not allow comparison with other objects' do
+      expect(node1 <=> 'c').to be_nil
+    end
+  end
+
+  describe 'serialization' do
+    let(:serialized_node1) { Marshal.dump(SpecializedTreeNode.new('a')) }
+    let(:serialized_node2) { Marshal.dump(Tree::TreeNode.new('b')) }
+    let(:tree) do
+      SpecializedTreeNode.new('root').tap do |root|
+        root << SpecializedTreeNode.new('a')
+        root << Tree::TreeNode.new('b')
+      end
+    end
+    let(:serialized_tree) { Marshal.dump(tree) }
+
+    it 'parses the serialized specialized tree node correctly (root)' do
+      expect(Marshal.load(serialized_tree)).to be_a(SpecializedTreeNode)
+    end
+
+    it 'parses the serialized specialized tree node correctly (child)' do
+      expect(Marshal.load(serialized_tree).children.first).to \
+        be_a(SpecializedTreeNode)
+    end
+
+    it 'parses the serialized tree node correctly' do
+      expect(Marshal.load(serialized_node2)).to be_a(Tree::TreeNode)
+    end
+  end
+
+  shared_examples_for 'any cloned node' do
+    it 'is equal to the original' do
+      expect(clone).to eq tree
+    end
+
+    it 'is not identical to the original' do
+      expect(clone).not_to be tree
+    end
+  end
+
+  describe '#detached_copy', 'Without content' do
+    let(:tree) { Tree::TreeNode.new('A', nil) }
+    let(:clone) { tree.detached_copy }
+
+    it_behaves_like 'any cloned node'
+  end
+
+  describe '#detached_copy with clonable content' do
+    let(:tree) { Tree::TreeNode.new('A', 'clonable content') }
+    let(:clone) { tree.detached_copy }
+
+    it 'makes a clone of the content' do
+      expect(clone.content).to eq tree.content
+    end
+
+    it 'is not the same as the original content' do
+      expect(clone.content).not_to be tree.content
+    end
+
+    it_behaves_like 'any cloned node'
+  end
+
+  describe '#detached_copy with unclonable content' do
+    let(:tree) { Tree::TreeNode.new('A', :unclonable_content) }
+    let(:clone) { tree.detached_copy }
+
+    it 'retains the original content' do
+      expect(clone.content).to be tree.content
     end
-    it "has some content #{@sample}" do
-      expect(@tree.content).to eq(@sample)
+
+    it_behaves_like 'any cloned node'
+  end
+
+  describe '#detached_copy with false as content' do
+    let(:tree) { Tree::TreeNode.new('A', false) }
+    let(:clone) { tree.detached_copy }
+
+    it 'retains the original content' do
+      expect(clone.content).to be tree.content
     end
 
-    it_behaves_like "any detached node"
+    it_behaves_like 'any cloned node'
   end
 end

data/test/run_test.rb

@@ -3,8 +3,8 @@
 # run_test.rb:: Run all the tests from the Ruby command line.
 #
 # Author:  Anupam Sengupta
-# Time-stamp: <2014-01-03 21:15:37 anupam>
-# Copyright (C) 2014 Anupam Sengupta <anupamsg@gmail.com>
+# Time-stamp: <2022-06-19 22:44:56 anupam>
+# Copyright (C) 2014, 2022 Anupam Sengupta <anupamsg@gmail.com>
 #
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
@@ -31,14 +31,15 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
+# frozen_string_literal: true
 
-base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-lib_dir  = File.join(base_dir, "lib")
-test_dir = File.join(base_dir, "test")
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+lib_dir  = File.join(base_dir, 'lib')
+test_dir = File.join(base_dir, 'test')
 
 $LOAD_PATH.unshift(lib_dir)
 
-if ENV["COVERAGE"]
+if ENV['COVERAGE']
   begin
     require 'simplecov'
     require 'coveralls'
@@ -51,10 +52,10 @@ if ENV["COVERAGE"]
       add_group 'Internal Utilities', '/lib/tree/utils/.*.rb'
     end
   rescue LoadError => e
-    puts "Could not load simplecov; continuing without code coverage"
+    puts "Could not load simplecov; continuing without code coverage #{e.cause}"
   end
 end
 
 require 'test/unit'
 
-exit Test::Unit::AutoRunner.run(true, test_dir)
+Test::Unit::AutoRunner.run(true, test_dir)