trivet 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 816c724387a4e6931697972dc59868bce4032a3cc7df3064e84f9cf9d6dc9b87
-  data.tar.gz: 33e2980a16a1e6575816635ee34c2273935bf185330c7ef2a190b399bc3a53ef
+  metadata.gz: b09cc26cad8b1fbc420bb6868a184dbd29d51816ad584deb8196c97d8a69b396
+  data.tar.gz: a70bbc909538386b6dc2e3fb18a7de6cb1d8c2220a40b961c8bba8c5ef7bda4f
 SHA512:
-  metadata.gz: 15ad703f9a3977dad38e21b0e12159048fb348dc52beeeb79e03ce5bbd835b76bcaf887ee24e4ba18c1f846fac17fa027b643ce1cf1ea4553edf285f57dc442c
-  data.tar.gz: 1fad0c2a2c2ca47839e48ced488964b5a13ac3474b6207f985b0d2a7de68b30f0320f63428709da92f01d6cb670e356854359a38b8eebdd8d9c5ca00d73c3f43
+  metadata.gz: 91990c0931cf9a24efc58ea659e78a29080b7cf66acd82677f79a6329e0debeb4483d9dcdaf45731e6bcbf3baa624eedecc09d31249d1911abfadb32fe4bdbc9
+  data.tar.gz: 3a2842b26cee8dfb2f2777220c03224274f37bf21e0412312efdddc2c15ad3aa8f22fc5e351bc10fe974dc756c7fdd6079a389a0a28a5f75dd327365db5289ec

data/README.md

@@ -76,4 +76,5 @@ mike@idocs.com
 
 | version | date          | notes                                                 |
 |---------|---------------|-------------------------------------------------------|
-| 1.0     | June 18, 2020 | Initial upload.                                       |
+| 1.0     | June 18, 2020 | Initial upload.                                       |
+| 1.1     | June 22, 2020 | Consolidated can_have_children? and can_have_child? into allow_child?. |

data/lib/trivet.rb

@@ -10,7 +10,7 @@ require 'forwardable'
 # Trivet::Node to learn about this package.
 module Trivet
 	# Version
-	VERSION = '1.0'
+	VERSION = '1.1'
 	
 	#---------------------------------------------------------------------------
 	# query control constants
@@ -121,21 +121,6 @@ class Trivet::Node
 	#---------------------------------------------------------------------------
 	
 	
-	#---------------------------------------------------------------------------
-	# can_have_children?
-	#
-	
-	# This method indicates if the node can have any children. By default this
-	# method always return true. Override this method in your own class to
-	# set more fine grained rules.
-	def can_have_children?
-		return true
-	end
-	#
-	# can_have_children?
-	#---------------------------------------------------------------------------
-	
-	
 	#---------------------------------------------------------------------------
 	# parent=
 	#
@@ -862,17 +847,37 @@ class Trivet::Node
 	
 	
 	#---------------------------------------------------------------------------
-	# can_have_child?
+	# shortcut to create allow_child? that returns false
+	#
+	
+	# This method provides a concise way to override Trivet::Node#allow_child?
+	# so that it always returns false. Just add this to your class:
+	#
+	#    self.no_children()
+	#
+	def self.no_children()
+		self.child_levels = []
+		
+		self.define_method('allow_child?') do
+			return false
+		end
+	end
+	#
+	# shortcut to create allow_child? that returns false
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# allow_child?
 	#
 	
-	# This methd is called when a node or other object is to be set as the child
-	# of the current node. By default, always returns true. Override this method
-	# to create custom rules.
-	def can_have_child?(child)
+	# This method is called when a node or other object is added to a node. By
+	# default, always returns true. Override this method to create custom rules.
+	def allow_child?(child)
 		return true
 	end
 	#
-	# can_have_child?
+	# allow_child?
 	#---------------------------------------------------------------------------
 	
 	
@@ -937,8 +942,7 @@ end
 
 # Objects of this class act like an array of the children of a node. However,
 # unlike an array, attempts to add children result in calling
-# Trivet::Node#can_have_children? and Trivet::Node#can_have_child?
-# to check if the child is allowed.
+# Trivet::Node#allow_child? to check if the child is allowed.
 class Trivet::Childset
 	#---------------------------------------------------------------------------
 	# delegate
@@ -1003,16 +1007,14 @@ class Trivet::Childset
 	# methods for adding a child to the array
 	#
 	
-	# Adds a child to the end of the array. Calls
-	# Trivet::Node#can_have_children? and Trivet::Node#can_have_child? to
+	# Adds a child to the end of the array. Calls Trivet::Node#allow_child? to
 	# check if the child can be added. Does nothing if the node is already a
 	# child.
 	def push(new_child, opts={})
 		return add_child new_child, 'last', opts
 	end
 	
-	# Adds a child to the end of the array. Calls
-	# Trivet::Node#can_have_children? and Trivet::Node#can_have_child? to
+	# Adds a child to the end of the array. Calls Trivet::Node#allow_child? to
 	# check if the child can be added. Does nothing if the node is already a
 	# child.
 	def append(new_child, opts={})
@@ -1024,16 +1026,14 @@ class Trivet::Childset
 		return append(new_child)
 	end
 	
-	# Adds a child to the beginning of the array. Calls
-	# Trivet::Node#can_have_children? and Trivet::Node#can_have_child? to
+	# Adds a child to the beginning of the array. Calls Trivet::Node#allow_child? to
 	# check if the child can be added. Does nothing if the node is already a
 	# child.
 	def unshift(new_child, opts={})
 		return add_child new_child, 'first', opts
 	end
 	
-	# Inserts the child at the position indicated by index. Calls
-	# Trivet::Node#can_have_children? and Trivet::Node#can_have_child? to
+	# Inserts the child at the position indicated by index. Calls Trivet::Node#allow_child? to
 	# check if the child can be added. Does nothing if the node is already a
 	# child.
 	def insert(index, new_child, opts={})
@@ -1166,12 +1166,7 @@ class Trivet::Childset
 		opts = {'recurse'=>true}.merge(opts)
 		
 		# check if this parent is allowed to have this child
-		if not @node.can_have_children?
-			raise 'parent-cannot-have-children: ' + @node.to_s + ' / ' + new_child.to_s
-		end
-		
-		# check if this parent is allowed to have this child
-		if not @node.can_have_child?(new_child)
+		if not @node.allow_child?(new_child)
 			raise 'parent-cannot-have-this-child: ' + @node.to_s + ' / ' + new_child.to_s
 		end
 		

metadata

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