WhiteCloth 0.0.2 → 0.0.4

data/Gemfile

@@ -12,6 +12,10 @@ source "http://rubygems.org"
 
 # Additional data structures
 gem "algorithms"
+gem "rubytree", "~> 0.8.1"
+
+# Log Library
+gem "log4r", "~> 1.1.9"
 
 # GUID library
 gem "uuidtools"

data/Gemfile.lock

@@ -16,6 +16,7 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    log4r (1.1.9)
     minitest (2.1.0)
     rake (0.8.7)
     rcov (0.9.9)
@@ -32,6 +33,7 @@ GEM
       sexp_processor (~> 3.0)
     ruby_parser (2.0.6)
       sexp_processor (~> 3.0)
+    rubytree (0.8.1)
     sexp_processor (3.0.5)
     uuidtools (2.1.2)
     vclog (1.8.1)
@@ -51,11 +53,13 @@ DEPENDENCIES
   gibberish
   hiredis (~> 0.3.1)
   jeweler (~> 1.6.0)
+  log4r (~> 1.1.9)
   minitest
   rcov
   redis (~> 2.2.0)
   reek (~> 1.2.8)
   riot
+  rubytree (~> 0.8.1)
   uuidtools
   vclog
   yard (~> 0.6.0)

data/HISTORY

@@ -1,5 +1,22 @@
 RELEASE HISTORY
 
+v0.0.2 / 2011-05-16
+
+Regenerate gemspec for version 0.0.2 (David Love david@homeunix.org.uk)
+
+Changes:
+
+* 2 Patch Enhancements
+
+    * Update the HISTORY
+    * Update the gemspec with the correct project information
+
+* 2 General Enhancements
+
+    * Version bump to 0.0.2
+    * Regenerate gemspec for version 0.0.1
+
+
 v0.0.1 / 2011-05-16
 
 Regenerate gemspec for version 0.0.1 (David Love david@homeunix.org.uk)
@@ -17,17 +34,21 @@ Changes:
     * Initial commit to WhiteCloth.
 
 
-HEAD / 2011-05-17
+HEAD / 2011-05-18
 
 Current Development (David Love)
 
 Changes:
 
-* 1 Patch Enhancements
+* 5 Patch Enhancements
 
-    * Update the gemspec with the correct project information
+    * Added foundations for the Standard Tree, including tests.
+    * Add a next function to UUIDTools::UUID to allow the generation of sequential UUID's
+    * Added basic sanity tests for the Gibberish library
+    * Update HISTORY file after tagging a version
+    * Remove FluxTuna from the testing namespace
 
 * 1 General Enhancements
 
-    * Regenerate gemspec for version 0.0.1
+    * Regenerate gemspec for version 0.0.2
 

data/Rakefile

@@ -68,7 +68,11 @@ task :test do
                     
                     "test/data/data_test.rb",
                     
-                    "test/dir_walk/create_witness_test.rb"]
+                    "test/data_structures/uuid_test.rb",
+                    "test/data_structures/basic_tree_test.rb",
+                    "test/data_structures/standard_tree_test.rb",
+                    
+                    "test/projections/project_file_test.rb"]
   end
 end
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.4

data/{FluxTuna.gemspec → WhiteCloth.gemspec}

@@ -4,12 +4,12 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{FluxTuna}
-  s.version = "0.0.1"
+  s.name = %q{WhiteCloth}
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Love"]
-  s.date = %q{2011-05-16}
+  s.date = %q{2011-05-17}
   s.default_executable = %q{whitecloth}
   s.description = %q{See: http://research.homeunix.org.uk}
   s.email = %q{david@homeunix.org.uk}
@@ -28,9 +28,19 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "WhiteCloth.gemspec",
     "bin/whitecloth",
     "lib/LICENSE",
     "lib/WhiteCloth.rb",
+    "lib/data_structures.rb",
+    "lib/data_structures/standard_node.rb",
+    "lib/data_structures/standard_tree.rb",
+    "lib/data_structures/white_node.rb",
+    "lib/helpers/tree_builder.rb",
+    "lib/helpers/uuid.rb",
+    "lib/projections.rb",
+    "lib/projections/project_dir.rb",
+    "lib/projections/project_file.rb",
     "lib/whitecloth/cli.rb",
     "lib/whitecloth/cli/base.rb",
     "lib/whitecloth/cli/commands.rb",
@@ -51,10 +61,13 @@ Gem::Specification.new do |s|
     "test/data/bayeux/Welcome.byx",
     "test/data/bayeux/Welcome.yaml",
     "test/data/data_test.rb",
-    "test/dir_walk/create_witness_test.rb",
-    "test/init_test.rb"
+    "test/data_structures/basic_tree_test.rb",
+    "test/data_structures/standard_tree_test.rb",
+    "test/data_structures/uuid_test.rb",
+    "test/init_test.rb",
+    "test/projections/project_file_test.rb"
   ]
-  s.homepage = %q{http://github.com/dlove24/FluxTuna}
+  s.homepage = %q{http://github.com/dlove24/WhiteCloth}
   s.licenses = ["ISC"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.6.2}
@@ -65,6 +78,8 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<algorithms>, [">= 0"])
+      s.add_runtime_dependency(%q<rubytree>, ["~> 0.8.1"])
+      s.add_runtime_dependency(%q<log4r>, ["~> 1.1.9"])
       s.add_runtime_dependency(%q<uuidtools>, [">= 0"])
       s.add_runtime_dependency(%q<hiredis>, ["~> 0.3.1"])
       s.add_runtime_dependency(%q<em-synchrony>, [">= 0"])
@@ -82,6 +97,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
     else
       s.add_dependency(%q<algorithms>, [">= 0"])
+      s.add_dependency(%q<rubytree>, ["~> 0.8.1"])
+      s.add_dependency(%q<log4r>, ["~> 1.1.9"])
       s.add_dependency(%q<uuidtools>, [">= 0"])
       s.add_dependency(%q<hiredis>, ["~> 0.3.1"])
       s.add_dependency(%q<em-synchrony>, [">= 0"])
@@ -100,6 +117,8 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<algorithms>, [">= 0"])
+    s.add_dependency(%q<rubytree>, ["~> 0.8.1"])
+    s.add_dependency(%q<log4r>, ["~> 1.1.9"])
     s.add_dependency(%q<uuidtools>, [">= 0"])
     s.add_dependency(%q<hiredis>, ["~> 0.3.1"])
     s.add_dependency(%q<em-synchrony>, [">= 0"])

data/lib/data_structures.rb

@@ -0,0 +1,25 @@
+# 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
+
+# Namespace for all the valid data structures used by {WhiteCloth} mutations
+# and projections
+module WhiteCloth::DataStructures
+    
+  # Load the known data structures
+  require "data_structures/standard_tree"
+  require "data_structures/standard_node"
+end

data/lib/data_structures/standard_node.rb

@@ -0,0 +1,64 @@
+# 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 base tree data structure
+  require "tree"
+    
+  class StandardNode < Tree::TreeNode
+    
+    ###
+    ### Constructors
+    ###
+    
+    def initialize(node_id, content)
+      super(node_id, content)
+    end
+    
+    ###
+    ### Operators
+    ###
+    
+    # Add a new child node to the current node.
+    def << (child_node)
+      self.add(child_node)
+    end
+    
+    # Look for the designated block within tree starting at the current node.
+    def [] (block_name)
+      
+      # We need to work out which node has the right content. Since
+      # the nodes are effectively unordered, we have to look (potentially)
+      # at every node
+      self.each{|child|
+        if child.content === block_name then
+          return child
+        end
+      }
+      
+    end
+    
+    ###
+    ### Accessors
+    ###
+    
+    # State that +id+ is an alias for the node name.
+    alias :id :name
+  end
+  
+end

data/lib/data_structures/standard_tree.rb

@@ -0,0 +1,99 @@
+# 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
+  
+  # The {StandardTree} is, as the name implies, the basic data structure for a realm. 
+  # All mutations operate over a {StandardTree}, and all projections to and from the 
+  # void create or imply a {StandardTree} as a result.
+  class StandardTree
+    
+    ###
+    ### Constructors
+    ###
+    
+    # Default constructor. Create a new tree, with a single node at the root.
+    def initialize(root_id = nil)
+      # Create the root id from supplied +root_id+, or a random one if the
+      # +root_id+ is missing
+      unless root_id.nil?
+        begin
+          @root_id = UUIDTools::UUID.parse(root_id)
+        rescue
+          @root_id = UUIDTools::UUID.random_create
+        end
+      else
+        @root_id = UUIDTools::UUID.random_create
+      end
+      @next_id = @root_id.next 
+      
+      # Create the root node for the tree
+      @nodes = StandardNode.new(@root_id.to_s, nil)
+    end
+    
+    ###
+    ### Operators
+    ###
+    
+    # Adds the specified nodes to the tree. The +node_list+ is a block, which is taken
+    # to be a hash of node names/node identities and the contents to add to the identified
+    # nodes.
+    def << (node_list)
+      Hash[*node_list.flatten].each{|parent, contents|
+        add_child(parent, contents)
+      }
+    end
+    
+    # Look for the designated block within tree starting at the current node.
+    def [] (block_name)
+      return @nodes[block_name]
+    end
+    
+    ###
+    ### Helper functions
+    ###
+    
+    # Adds a new node to the tree, below the +parent+ node and with the specified
+    # +contents+.
+    def add_child(parent, contents)
+      
+      # Find the parent node
+      if parent.nil? then
+        # Add to the root node
+        @nodes << StandardNode.new(@next_id.to_s, contents)
+      else
+        # Add to the relevant node
+        @nodes[parent] << StandardNode.new(@next_id.to_s, contents)
+      end
+      
+      # Increment the node index
+      @next_id = @next_id.next
+      
+    end
+    
+    ###
+    ### Query functions
+    ###
+    
+    # Is the tree 'empty' (i.e. it has only the root node)?
+    def empty?
+      return !@nodes.has_children?
+    end
+    
+  end
+  
+end

data/lib/data_structures/white_node.rb

@@ -0,0 +1,201 @@
+class ParaBlock
+  
+  # Default contructor
+  def initialize(type, content = "", target = nil)
+    @orig_type = type
+    @type = normalise_type(type)
+    
+    @content = content
+    @target = target
+  end
+  
+  ###
+  ### Accessors
+  ###
+  
+  def type=(type)
+    @type = normalise_type(type)
+  end
+  def type
+    @type
+  end
+
+  def content=(content)
+    @content = content
+  end
+  def content
+    @content
+  end
+  
+  def target=(target)
+    @target = target
+  end
+  def target
+    @target
+  end
+  
+  ###
+  ### Convenience functions
+  ###
+  
+  def <<(value)
+    @content << value
+  end
+  
+  def empty?
+    return (@content.empty? or (/\S/ !~ @content))
+  end
+  
+  def clear
+    @content.clear
+  end
+
+  # Returns the length of the type and target, as they were
+  # written out _in the original document_. For the current
+  # type length, see type_length
+  def orig_type_length
+    @orig_type.to_s.length + @target.to_s.length + 1
+  end
+  
+  # Returns the length of the type and target, as they would
+  # be written out (including the separator), e.g as 
+  # 'figure:L3'.length
+  def type_length
+    @type.to_s.length + @target.to_s.length + 1
+  end
+  
+  # Take the current contents as a block
+  # type, and reset the content
+  def content_to_type!
+    
+    unless @content =~ /\s+/ then
+      header = @content.split(':')
+      
+      if header[0].nil? then
+        
+        # If we can't work out the type, set everything
+        # to null
+        @type = :none
+        @target = nil
+      
+      else
+        
+        # Attempt to coerce the content to a type   
+        block_type = header[0].to_sym
+        unless block_type.nil? then
+          @orig_type = block_type
+          @type = normalise_type(block_type)
+        else
+          @orig_type = :none
+          @type = :none
+        end
+        
+        @target = header[1]
+        
+      end
+      
+    else
+      @type = :none
+    end
+    
+    @content.clear
+  end
+  
+  ###
+  ### Helper functions
+  ###
+  
+  # Do type mapping if needed, otherwise
+  # pass on the contents as the type
+  def normalise_type(type)
+    case type
+      when :e
+        return :emph
+      when :s
+        return :strong
+      when :quote
+        return :block_quote
+      else
+        return type
+    end
+  end
+  
+  ###
+  ### Type conversions
+  ###
+  
+  def self.from_s(string)
+    
+    unless string =~ /\s+/ then
+      header = string.split(':')
+      
+      if header[0].nil? then
+        
+        # If we can't work out the type, set everything
+        # to null
+        type = :none
+        target = nil
+      
+      else
+        
+        # Attempt to coerce the content to a type   
+        block_type = header[0].to_sym
+        unless block_type.nil? then
+          type = block_type
+        else
+          type = :none
+        end
+        
+        target = header[1]
+      
+      end
+      
+    else
+      type = :none
+    end
+    
+    return ParaBlock.new(type, "", target)
+  end
+  
+  def to_s
+    @content.to_s
+  end
+  
+  def to_debug_s
+    return "block type: #{type}, content: #{content}"
+  end
+  
+  def to_sym
+    @content.to_sym
+  end
+  
+  def to_json(*a)
+    begin
+      require 'json'
+
+      json_hash = {
+        "type"    => @name,
+        "content" => @content,
+        "target"  => @target,
+        JSON.create_id => self.class.name
+      }
+
+      return json_hash.to_json
+
+    rescue LoadError
+      warn "The JSON gem couldn't be loaded, and so the JSON representation could not be generated"
+    end
+  end
+
+  def self.json_create(json_hash)
+    begin
+      require 'json'
+
+      block = new(json_hash["type"], json_hash["content"], json_hash["target"])
+      return block
+
+    rescue LoadError
+      warn "The JSON gem couldn't be loaded, and so the JSON representation could not be generated"
+    end
+  end
+end