trivet 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e89a9e0bf927395b3957b685542a8e9ce4971f455b1214f6fd14dc25d0c15e'
-  data.tar.gz: 7f50bf59dbaa328abfc4dcdd1f2500a342b44430cfdfe758614917ff7ccf84c7
+  metadata.gz: 5fbcf1a7c9514f12a41ecaa45f4f1ba5bec3ccec08a2ea1d9c080d4d93f3e363
+  data.tar.gz: cf1e7334a9aa7184622c1dac9c55df342e72187390fce5d01de4772095ff91e1
 SHA512:
-  metadata.gz: 46ecd9c3584757faec3db79f6ceee686299b597fe6666336858d03820166ce5962d36ce4c36e69808147d96f66eda01865489ea8c24336ee1770917f5b3a3ce3
-  data.tar.gz: a1060b86507afb34f49f26f96f22e9a884e4cc6c828d92ca06162d4e15dad0c4b7b6a55e27100aaded5d5c0e85225633e508f7731e8f098aed94d56f594b48a2
+  metadata.gz: 8826eedd9ca3b47f572bee245675bee71629be643066151579b62dc461982f94f26e919891e53b4c258870eb5d5ce57293c647338c4ec3aa50e5e153b924240a
+  data.tar.gz: 6df953e0bfd143563ebfe50de94635940eb8066037f14ef5f0777e21671d9e889a2dd51fb57491c4ec34154290dbdc21118d79f279097f53bb7766da24e0157d

data/README.md

@@ -81,19 +81,19 @@ mike@idocs.com
 		<th>date</th>
 		<th>notes</th>
 	</tr>
-
+	
 	<tr>
 		<td>1.0</td>
 		<td>June 18, 2020</td>
 		<td>Initial upload.</td>
 	</tr>
-
+	
 	<tr>
 		<td>1.1</td>
 		<td>June 22, 2020</td>
 		<td>Consolidated can_have_children? and can_have_child? into allow_child?.</td>
 	</tr>
-
+	
 	<tr>
 		<td>1.2</td>
 		<td>January 3, 2021</td>
@@ -101,5 +101,13 @@ mike@idocs.com
 			Added several methods to Trivet::Node: next_sibling, previous_sibling, have_child?, and move_child.
 		</td>
 	</tr>
+	
+	<tr>
+		<td>1.3</td>
+		<td>January 4, 2021</td>
+		<td>
+			Renamed have_child? to have_object?. Renamed remove_child() to remove_object().
+		</td>
+	</tr>
 
 </table>

data/lib/trivet.rb

@@ -11,7 +11,7 @@ require 'lx'
 # Trivet::Node to learn about this package.
 module Trivet
 	# Version
-	VERSION = '1.2'
+	VERSION = '1.3'
 	
 	#---------------------------------------------------------------------------
 	# query control constants
@@ -72,7 +72,23 @@ end
 class Trivet::Node
 	# delegate
 	extend Forwardable
-	delegate %w(remove_child have_child?) => :@children
+	
+	# @!method have_object?(object)
+	# Returns true if the node has the given object as a child. This method is
+	# not quite the same as include?. This method returns true only if children
+	# contains the actual object given, not just an object that matches `==`.
+	# So, for example, the following use of have_object? would return false,
+	# even though it cohtains a string identical to the string in @children.
+	# 
+	#     node.add 'whatever'
+	#     node.include? 'whatever'     # true
+	#     node.have_object? 'whatever' # false
+	
+	# @!method remove_object(object)
+	# Removes the given object from children. Only the exact object is removed.
+	# If the object is a string, strings that are identical but not that actual
+	# object will *not* be removed.
+	delegate %w(remove_object have_object?) => :@children
 	
 	
 	#---------------------------------------------------------------------------
@@ -366,7 +382,7 @@ class Trivet::Node
 	# add
 	#
 	
-	# A shortcut for adding children of any arbistrary class. Takes zero or more
+	# A shortcut for adding children of any arbitrary class. Takes zero or more
 	# params, each of which is an object.
 	
 	def add(*objs)
@@ -593,7 +609,7 @@ class Trivet::Node
 			if @parent.is_a?(Trivet::Document)
 				@parent.set_root nil, 'recurse'=>false
 			elsif @parent.is_a?(Trivet::Node)
-				@parent.remove_child self
+				@parent.remove_object self
 			else
 				raise 'unlink-unknown-parent-class: ' + @parent.class.to_
 			end
@@ -1052,7 +1068,7 @@ class Trivet::Node
 	
 	def move_child(child, tgt)
 		# $tm.hrm
-		@children.remove_child child
+		@children.remove_object child
 		tgt.add child
 	end
 	#
@@ -1190,12 +1206,12 @@ class Trivet::Childset
 	
 	
 	#---------------------------------------------------------------------------
-	# remove_child
+	# remove_object
 	#
 	
 	# Removes the given child from the array of children. Does nothing if the
 	# child isn't present.
-	def remove_child(child, opts={})
+	def remove_object(child, opts={})
 		# opts = {'recurse'=>true}.merge(opts)
 		
 		@children.reject!() do |el|
@@ -1216,7 +1232,7 @@ class Trivet::Childset
 		@children.clear
 	end
 	#
-	# remove_child
+	# remove_object
 	#---------------------------------------------------------------------------
 	
 	
@@ -1282,7 +1298,7 @@ class Trivet::Childset
 		# loop through all
 		all.each do |child|
 			bool = yield(child)
-			bool or remove_child(child)
+			bool or remove_object(child)
 		end
 		
 		# return
@@ -1307,9 +1323,20 @@ class Trivet::Childset
 	
 	
 	#---------------------------------------------------------------------------
-	# have_child?
+	# have_object?
 	#
-	def have_child?(potential)
+	
+	# Returns true if the @children contains the given object. This method is
+	# not quite the same as include?. This method returns true only if @children
+	# contains the actual object given, not just an object that matches ==. So,
+	# for example, the following use of have_object? would return false, even
+	# though it cohtains a string identical to the string in @children.
+	# 
+	#     @children.push 'whatever'
+	#     @children.include? 'whatever'     # true
+	#     @children.have_object? 'whatever' # false
+	
+	def have_object?(potential)
 		@children.each_with_index do |child, idx|
 			if child.equal?(potential)
 				return idx
@@ -1319,7 +1346,7 @@ class Trivet::Childset
 		return false
 	end
 	#
-	# have_child?
+	# have_object?
 	#---------------------------------------------------------------------------
 	
 	
@@ -1348,7 +1375,7 @@ class Trivet::Childset
 		
 		# add to children if not already there
 		# if dup_ok or (not @children.include?(new_child))
-		if (not have_child?(new_child))
+		if (not have_object?(new_child))
 			# add to start of array
 			if index == 'first'
 				@children.unshift new_child

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trivet
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Mike O'Sullivan