node.py

# Python 2/3 Tree Implementation
#
# Copyright (C) 2011
# Brett Alistair Kromkamp - brettkromkamp@gmail.com
# Copyright (C) 2012
# Xiaming Chen - chenxm35@gmail.com
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# Redistributions of source code must retain the above copyright notice, this list
# of conditions and the following disclaimer.
#
# Redistributions in binary form must reproduce the above copyright notice, this
# list of conditions and the following disclaimer in the documentation and/or
# other materials provided with the distribution.
#
# Neither the name of the copyright holder nor the names of the contributors
# may be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, 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.
import unittest
import uuid

def sanitize_id(id):
	return id.strip().replace(" ", "_")

# Module constants
(_ADD, _DELETE, _INSERT) = range(3)

class Node(object):
	"""Class for basic node functionality."""

	def __init__(self, name, identifier=None, expanded=True):
		self.__identifier = (str(uuid.uuid1()) if identifier is None else
				sanitize_id(str(identifier)))
		self.name = name
		self.expanded = expanded
		self.__bpointer = None		# identifier
		self.__fpointer = []		# identifier

	@property
	def identifier(self):
		return self.__identifier

	@property
	def bpointer(self):
		return self.__bpointer

	@bpointer.setter
	def bpointer(self, value):
		if value is not None:
			self.__bpointer = sanitize_id(value)

	@property
	def fpointer(self):
		return self.__fpointer

	@fpointer.setter
	def fpointer(self, value):
		if value is not None and isinstance(value, list):
			self.__fpointer = value

	def update_fpointer(self, identifier, mode=_ADD):
		if mode is _ADD:
			self.__fpointer.append(sanitize_id(identifier))
		elif mode is _DELETE:
			self.__fpointer.remove(sanitize_id(identifier))
		elif mode is _INSERT:
			self.__fpointer = [sanitize_id(identifier)]

#--------------------------------------------------------------------------------

# Test suite

class TestNode(unittest.TestCase):
	def setUp(self):
		self.node1 = Node("Test One", "ide ntifier 1 ")

	def test_initialization(self):
		self.assertEqual(self.node1.name, "Test One")
		self.assertEqual(self.node1.identifier, "identifier1")
		self.assertEqual(self.node1.expanded, True)

	def test_set_fpointer(self):
		self.node1.update_fpointer(" identi fier 2")
		self.assertEqual(self.node1.fpointer, ['identifier2'])

	def test_set_bpointer(self):
		self.node1.bpointer = " identi fier 1"
		self.assertEqual(self.node1.bpointer, 'identifier1')
		
	def test_set_data(self):
		self.node1.data = {1:'hello', "two":'world'}
		self.assertEqual(self.node1.data, {1:'hello', "two":'world'})

	def tearDown(self):
		pass

#--------------------------------------------------------------------------------

# Module testing

if __name__ == "__main__":
	unittest.main()