WhiteCloth 0.0.2 → 0.0.4

data/lib/helpers/tree_builder.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+module WhiteCloth::DataStructures
+  
+  # Load the UUID class, as extended by the helper library
+  require "helpers/uuid"
+  
+  # Helper class for constructing trees. Takes care of the basic manipulation of the trees, allowing
+  # some abstraction in the projections.
+  class TreeBuilder
+    
+    # Default constructor. Creates an internal UUID, which is used to sequence objects
+    # added to the {TreeBuilder}.
+    def initialize
+      
+      # Call the parent to create the underlying stack
+      super()
+      
+      # Create our sequence number
+      @sequence = UUIDTools::UUID.random_create
+      
+      # Create the level stack
+      @level_stack = Containers::Stack.new
+    end
+    
+  end
+  
+end

data/{test/dir_walk/create_witness_test.rb → lib/helpers/uuid.rb}

@@ -15,25 +15,21 @@
 
 # @author David Love
 
-# 
-# This test suite checks we can create the relevant witness objects
-#
-module Test::Witness
-  
-  # Include the standard witness classes
-  include FluxTuna::Witness
+require "uuidtools"
 
-  # Check that we can instantiate a directory walker
-  context "Create a DirFileWitness object" do
-    setup { DirFileWitness.new }
-    asserts_topic.kind_of(FluxTuna::Witness::DirFileWitness)
-  end
+# Extendes the {UUIDTools::UUID} class, adding the ability to
+# generate sequential UUID's
+class UUIDTools::UUID
   
-  # Create a walker for the test data
-  context "Create a DirFileWitness object" do
-    setup { DirFileWitness.new }
-    asserts("directory walker"){ topic.shatter("test/data/bayeux/**/*.byx") }
+  # Increments the internal UUID representation, returning a
+  # new UUID that is different from, but greater, than the 
+  # current sequence number
+  def next
+    next_uuid = self.to_i
+    next_uuid += 1
+    
+    # Return the newly created UUID
+    return UUIDTools::UUID::parse_int(next_uuid)
   end
-
+  
 end
-

data/lib/projections.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+# Loads all the standards projections
+module WhiteCloth::Projections
+  
+  # Load the additional data structures required by the projections
+  require "data_structures"
+  include WhiteCloth::DataStructures
+  
+  # Load the known projections
+  require "projections/project_dir.rb"
+  require "projections/project_file.rb"
+end

data/lib/projections/project_dir.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+module WhiteCloth::Projections
+
+  # Create a Projection for the specified directory
+  class DirFile
+  
+    # Default constructor
+    def initialize
+      @file_stack = WhiteCloth::DataStructures::FlatTree.new
+    end
+  
+    # Run the projection function, taking +path+ as the {File#glob} 
+    # shell glob for the path and pattern to match
+    # when looking for files
+    def project(path)
+      
+      # Walk the path,
+      Dir.glob(path){|file_name|
+        
+        # Ignore directories
+        unless File.directory?(file_name) then
+          
+          # Ignore the special files as well
+          unless file_name == "." or file_name == ".." then
+            
+
+          end        
+        end
+        
+      }
+      
+    end
+  end
+  
+end

data/test/data/data_test.rb

@@ -15,7 +15,7 @@
 
 # @author David Love
 
-require "flux_tuna"
+require "whitecloth"
 
 # 
 # The {Test::Data} module does not contain any tests, as such, but instead

data/test/data_structures/basic_tree_test.rb

@@ -0,0 +1,122 @@
+# Copyright (c) 2011 David Love
+#
+# Based on the file testtree.rb, part of the RubyTree package.
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 Anupam Sengupta.
+#
+# Modified for use with the Riot test framework, and integration into the other
+# tests
+#
+# 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 organization nor the names of its 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 OWNER 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.
+#
+
+require 'tree'
+
+module Test::DataStructures
+  
+  # Create this structure for the tests
+  #
+  #          +----------+
+  #          |  ROOT    |
+  #          +-+--------+
+  #            |
+  #            |    +---------------+
+  #            +----+  CHILD1       |
+  #            |    +---------------+
+  #            |
+  #            |    +---------------+
+  #            +----+  CHILD2       |
+  #            |    +---------------+
+  #            |
+  #            |    +---------------+   +------------------+
+  #            +----+  CHILD3       +---+  CHILD4          |
+  #                 +---------------+   +------------------+
+  #
+
+  # This test is for the root alone - without any children being linked
+  context "Sanity tests for the Basic Tree root node" do
+    setup { 
+      root = Tree::TreeNode.new("ROOT", "Root Node")
+    }
+
+    denies("root node"){ topic }.nil
+    asserts("parent of root node") { topic.parent }.nil  
+    denies("root name") { topic.name }.nil
+    asserts("root name") { topic.name }.equals("ROOT")
+    asserts("root contents") { topic.content }.equals("Root Node")
+    asserts("root node declares as the root node") { topic.is_root? }
+    denies("root cannot have any children") { topic.has_children? }
+    asserts("root has contents") { topic.has_content? }
+    asserts("number of nodes should be one") { topic.size }.equals(1)
+    asserts("root does not have any children") { topic.siblings.nil? }
+    asserts("root should have an in-degree that") { topic.in_degree }.equals(0)
+    asserts("root's height before adding any children") { topic.node_height }.equals(0)    
+  end
+
+  context "Sanity tests for the Basic Tree after the children are linked to the root" do
+    setup { 
+      @root = Tree::TreeNode.new("ROOT", "Root Node")
+
+      @child1 = Tree::TreeNode.new("Child1", "Child Node 1")
+      @child2 = Tree::TreeNode.new("Child2", "Child Node 2")
+      @child3 = Tree::TreeNode.new("Child3", "Child Node 3")
+      @child4 = Tree::TreeNode.new("Child4", "Grand Child 1")
+      @child5 = Tree::TreeNode.new("Child5", "Child Node 4")
+
+      @root << @child1
+      @root << @child2
+      @root << @child3 << @child4
+      
+      @root 
+    }
+    
+    asserts("root's root is self") { topic.root == topic }
+    asserts("child 1's root should be ROOT") { @child1.root == topic }
+    asserts("child 4's root should be ROOT") { @child4.root == topic }
+    asserts("root's height after adding the children") { topic.node_height }.equals(2)
+  end
+
+  context "Test the new nodes have no content" do
+    setup { a_node = Tree::TreeNode.new("A Node") }
+    
+    asserts("the node should not have content") { topic.content }.nil
+    denies("the node should not have content") { topic.has_content? } 
+  end
+  
+  context "Test the presence of content in the nodes" do
+    setup { 
+      a_node = Tree::TreeNode.new("A Node") 
+      a_node.content = "Something"
+      
+      a_node
+    }
+    
+    denies("the node should now have content") { topic.content }.nil
+    asserts("the node should now have content") { topic.has_content? }
+  end
+
+end

data/test/data_structures/standard_tree_test.rb

@@ -0,0 +1,118 @@
+# Copyright (c) 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+# 
+# This test suite checks for the correct behaviour of the {FlatTree} data
+# structure
+#
+module Test::DataStructures
+  
+  require "data_structures"
+  include WhiteCloth::DataStructures
+    
+  # Check that we can create a {StandardTree}
+  context "Creating empty Standard Tree" do
+    setup { StandardTree.new }
+    asserts_topic.kind_of(WhiteCloth::DataStructures::StandardTree)
+    asserts("the Standard Tree is empty") { topic.empty? }
+  end
+  
+  # Create this structure for the tests
+  #
+  #          +----------+
+  #          |  ROOT    |
+  #          +-+--------+
+  #            |
+  #            |    +---------------+
+  #            +----+  Child 1     |
+  #            |    +---------------+
+  #            |
+  #            |    +---------------+
+  #            +----+  Child 2     |
+  #            |    +---------------+
+  #            |
+  #            |    +---------------+   +------------------+   +---------------------+
+  #            +----+  Child 3      +---+  Grand Child 1   +---+ Great Grand Child 1 |
+  #            |    +---------------+   +------------------+   +---------------------+  
+  #            |
+  #            |    +---------------+   +------------------+
+  #            +----+  Child 4      +---+  Grand Child 2   |
+  #                 +---------------+   +------------------+
+  #
+
+  # This test is for the root alone - without any children being linked
+  context "Check the Standard Tree root node behaves as it should" do
+    setup { 
+      @root = StandardTree.new("b081eabd-8799-4885-8c4d-eb3cf76b30b4")
+    }
+
+    denies("root node"){ topic }.nil
+    asserts("parent of root node") { topic[nil].parent }.nil  
+    denies("root name") { topic[nil].id }.nil
+    asserts("root name") { topic[nil].id }.equals("b081eabd-8799-4885-8c4d-eb3cf76b30b4")
+    asserts("root contents") { topic[nil].content }.nil
+    asserts("root node declares as the root node") { topic[nil].is_root? }
+    denies("root cannot have any children") { topic[nil].has_children? }
+    denies("root has contents") { topic[nil].has_content? }
+    asserts("number of nodes should be one") { topic[nil].size }.equals(1)
+    asserts("root does not have any children") { topic[nil].siblings.nil? }
+    asserts("root should have an in-degree that") { topic[nil].in_degree }.equals(0)
+    asserts("root's height before adding any children") { topic[nil].node_height }.equals(0)    
+  end
+
+  context "Check that the Standard Tree adds new nodes correctly" do
+    setup { 
+      @root = StandardTree.new("b081eabd-8799-4885-8c4d-eb3cf76b30b4")
+
+      @root << {nil => "Child 1"}
+      @root << {nil => "Child 2", nil => "Child 3"}
+      @root << {nil => "Child 3", "Child Node 3" => "Grand Child 1"}
+      @root << {nil => "Child 4"}
+      @root << {"Child 4" => "Grand Child 2", "Grand Child 1" => "Great Grand Child 1"}
+      
+      @root 
+    }
+    
+    asserts("root's root is self") { topic[nil].root == topic[nil] }
+    asserts("child 1's root should be ROOT") { topic["Child 1"].root == topic[nil] }
+    asserts("child 4's root should be ROOT") { topic["Child 4"].root == topic[nil] }
+    asserts("great grand child 1's parent should be \"Grand Child 1\"") { topic["Great Grand Child 1"].parent == topic["Grand Child 1"] }
+    denies("great grand child 1's parent should be \"Child 3\"") { topic["Great Grand Child 1"].parent == topic["Child 3"] }
+    asserts("root's height after adding the children") { topic[nil].node_height }.equals(2)
+  end
+
+  context "Test the new nodes have no content" do
+    setup { a_node = Tree::TreeNode.new("A Node") }
+    
+    asserts("the node should not have content") { topic.content }.nil
+    denies("the node should not have content") { topic.has_content? } 
+  end
+  
+  context "Test the presence of content in the nodes" do
+    setup { 
+      a_node = Tree::TreeNode.new("A Node") 
+      a_node.content = "Something"
+      
+      a_node
+    }
+    
+    denies("the node should now have content") { topic.content }.nil
+    asserts("the node should now have content") { topic.has_content? }
+  end
+  
+end
+

data/test/data_structures/uuid_test.rb

@@ -0,0 +1,56 @@
+# Copyright (c) 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+module WhiteCloth::DataStructures
+  
+  require "helpers/uuid"
+  
+  # Check that we can create a random {UUIDTools::UUID} object. This checks
+  # we haven't accidently broken the class definition when re-opening the
+  # class
+  context "Creating random UUID" do
+    setup { UUIDTools::UUID.random_create }
+    asserts_topic.kind_of(UUIDTools::UUID)
+    asserts("the UUIDTools::UUID is valid") { topic.valid? }
+  end
+  
+  # Create a UUID from a string. This shouldn't fail (see above), but is a
+  # necessary pre-condition for the later checks
+  context "Creating UUID \"984265dc-4200-4f02-ae70-fe4f48964159\"" do
+    setup { UUIDTools::UUID.parse("984265dc-4200-4f02-ae70-fe4f48964159") }
+    asserts_topic.kind_of(UUIDTools::UUID)
+    asserts("the UUIDTools::UUID is valid") { topic.valid? }
+    asserts("UUID randomly generated, hence version") { topic.version }.equals(4)
+    asserts("UUID string") { topic.to_s }.equals("984265dc-4200-4f02-ae70-fe4f48964159")
+    asserts("UUID hexadecimal digest") { topic.hexdigest }.equals("984265dc42004f02ae70fe4f48964159")
+    asserts("UUID integer") { topic.to_i }.equals(202387412925962617026353010734081130841)
+  end
+  
+  # Create the next UUID from the string used above. This checks the basic functionality of our
+  # 'next' function, and that we haven't broken the UUID too much
+  context "Creating UUID sequential to \"984265dc-4200-4f02-ae70-fe4f48964159\"" do
+    setup { UUIDTools::UUID.parse("984265dc-4200-4f02-ae70-fe4f48964159").next }
+    asserts_topic.kind_of(UUIDTools::UUID)
+    asserts("the UUIDTools::UUID is valid") { topic.valid? }
+    asserts("UUID randomly generated, hence version") { topic.version }.equals(4)
+    asserts("UUID string") { topic.to_s }.equals("984265dc-4200-4f02-ae70-fe4f4896415a")
+    asserts("UUID hexadecimal digest") { topic.hexdigest }.equals("984265dc42004f02ae70fe4f4896415a")
+    asserts("UUID integer") { topic.to_i }.equals(202387412925962617026353010734081130842)
+  end
+  
+  
+end