kyanite 0.6.1 → 0.7.0

data/lib/kyanite/string/split.rb

@@ -1,4 +1,10 @@
-# ruby encoding: utf-8 
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'drumherum'
+  smart_init
+end
+
 
  require 'facets/string/shatter' 
  require 'kyanite/string/cast' 
@@ -10,15 +16,11 @@
 class String
 
 # ---------------------------------------------------------------------------------------------------------------------------------
-# :section: Split
+# @!group Split
 # See TestKyaniteStringSplit for tests and examples.
-#
-# Aus {Facets/String}[http://facets.rubyforge.org/doc/api/core/classes/String.html]eingefügt:
-# *shatter*(re) 
-# Breaks a string up into an array based on a regular expression. Similar to +scan+, but includes the matches.       
+       
 
 
-    
     # Returns _n_ characters of the string. If _n_ is positive
     # the characters are from the beginning of the string.
     # If _n_ is negative from the end of the string.
@@ -26,11 +28,14 @@ class String
     # Alternatively a replacement string can be given, which will
     # replace the _n_ characters. 
     # Example:
+    #   'abcde'.nchar(1)  =>      'a'
     #   'abcde'.nchar(2)  =>      'ab'
+    #   'abcde'.nchar(3)  =>      'abc'
     #   'abcde'.nchar(2,'')  =>   'cde'
     #
-    # NICHT die Version aus Facets verwenden!!!
-    # Tests siehe TestKyaniteStringSplit#test_nchar   
+    # (The originaly version of this method is from the {http://rubyworks.github.com/rubyfaux/?doc=http://rubyworks.github.com/facets/docs/facets-2.9.3/core.json#api-class-String/api-method-String-h-nchar Facets} library).
+    # See tests and examples {TestKyaniteStringSplit#test_nchar here}.  
+    # @return [String] Substring
     def nchar(n, replacement=nil)
       if replacement
         return self   if n == 0     
@@ -48,19 +53,21 @@ class String
     end
     
     
-    # Schneidet eine String auf eine Maximallänge. Bsp.:
-    #   'Hallo'.cut(3) => 'Hal'
-    # 
-    # Tests siehe TestKyaniteStringSplit#test_cut    
+    # Cuts a string to a maximal length. Example.:
+    #   'Hello'.cut(3) => 'Hel'
+    #   
+    # See tests and examples {TestKyaniteStringSplit#test_cut here}.   
+    # @return [String] Substring
     def cut(len=5)
         return '' if len <= 0
         self[0..len-1]
     end        
     
     
-    # Erzwingt eine bestimmte Länge
-    # 
-    # Tests siehe TestKyaniteStringSplit#test_fixsize        
+    # Forces a fixed size.
+    #  
+    # See tests and examples {TestKyaniteStringSplit#test_fixsize here}.  
+    # @return [String]     
     def fixsize( len )
       return '' if len <= 0
       if self.size < len
@@ -71,11 +78,10 @@ class String
     end    
 
     
-    # Schneidet einen String in Stücke. 
-    # Wie lang die Stücke sind, sagt der Parameter (Format: einzelner Integer oder Array of Integer).
-    # Gibt alle Stücke zurück plus den Rest, der übrigbleibt.
-    # 
-    # Beispiele & Tests siehe TestKyaniteStringSplit#test_split_by_index      
+    # Cuts a string in parts with given length.  
+    # See tests and examples {TestKyaniteStringSplit#test_split_by_index here}.       
+    # @param idx [Integer, Array of Integer] Length of parts 
+    # @return [Array] All the parts with given length, plus remainder.
     def split_by_index(idx)     
       if idx.kind_of?(Integer)
        [nchar(idx)] + [nchar(idx,'')]
@@ -88,10 +94,14 @@ class String
     
     
     
-    # Extrahiert einen Teilstring anhand zweier regulärer Ausdrücke. Beispiel:
-    #   string = '<select id="hallo"><option value="0">none</option></select>'
-    #   string.extract(/select.*?id="/,'"')  =>  'hallo'
-    #
+    # Extracts a substring using two regular expressions. Example:
+    #   string = '<select id="hello"><option value="0">none</option></select>'
+    #   string.extract(  /select.*?id="/  ,  '"'  )  =>  'hello'
+    # 
+    # See tests and examples {TestKyaniteStringSplit#test_extract here}.      
+    # @return [String] Substring
+    # @param start_regexp [RegExp, String] Start extraction here
+    # @param stop_regexp [RegExp, String] Stop extraction here
     def extract( start_regexp, stop_regexp )
       split(start_regexp)[1].split(stop_regexp)[0]
     end    
@@ -99,18 +109,20 @@ class String
 
 
         
-    # Trennt einen String in numerische und alphanumerische Teile auf.
-    # Funktioniert derzeit nur mit positiven Integers. Bsp.:
+    # Separates a string into numeric and alphanumeric parts.
+    # Currently works only with positive integers. Example:
     #  'abc123'.split_numeric  >>  ['abc',123]   (Array)
     #  '123abc'.split_numeric  >>  [123,'abc']   (Array)
     #  '123'.split_numeric     >>  123           (Integer)
     #  'abc'.split_numeric     >>  'abc'         (String)
     #
-    # Das funktioniert sogar mit mehr als zwei Teilen:
+    # It even works with more than two parts:
     #  '123abc456'.split_numeric  >>  [123,'abc',456]
     #  'abc123def'.split_numeric  >>  ['abc',123,'def']         
+    #    
+    # See tests and examples {TestKyaniteStringSplit#test_split_numeric here}.      
+    # @return [Array] alphanumeric and numeric part
     #
-    # Tests siehe TestKyaniteStringSplit#test_split_numeric
     def split_numeric
         result = shatter(/\d+/).collect{ |i| i.to_integer_optional }
         return result[0]    if ( result.is_collection? && result.size == 1 )
@@ -118,28 +130,55 @@ class String
     end
     
 
-    # Trennt numerische Teile ab und entfernt abschließende Whitespaces, Bindestriche, Unterstriche und Punkte.
-    # Wird z.B. für die Generierung des Doku-Pfades verwendet. 
-    #
-    # Tests siehe TestKyaniteStringSplit
+
+    # Removes numeric parts and trailing white spaces, hyphens, underscores, and periods.   
+    # See tests and examples {TestKyaniteStringSplit#test_without_versioninfo here}.      
+    # @return [String] Substring  
     def without_versioninfo
         shatter(/\d+/)[0].strip.chomp('_').chomp('-').chomp('.')
     end        
     
 end
 
+# @!endgroup
 
-if defined? TransparentNil
-  class NilClass
+class NilClass
 
-    # Rückgabe: Leerer String,
-    # siehe String#split
-    def cut(*a);                            '';             end  
-    
-    def nchar(*a);                          nil;            end  
-    def split_by_index(*a);                 nil;            end  
-    def extract(*a);                        nil;            end  
-    def split_numeric;                      nil;            end  
-    def without_versioninfo;          nil;            end    
-  end
+  # Rückgabe: Leerer String,
+  # siehe String#split
+  def cut(*a);                            '';             end  
+  
+  def nchar(*a);                          nil;            end  
+  def split_by_index(*a);                 nil;            end  
+  def extract(*a);                        nil;            end  
+  def split_numeric;                      nil;            end  
+  def without_versioninfo;                nil;            end    
 end
+
+
+
+class Numeric
+
+
+  # +self+, complements {String#split_numeric}. 
+  # @return [Numeric]
+  def split_numeric 
+      self 
+  end    
+
+  
+  
+end  
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/kyanite/symbol.rb

@@ -1,33 +1,42 @@
 # ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'drumherum'
+  smart_init
+end
+
+
 
-# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | Object | String | *Symbol* | Numeric | 
-#
-# ---
-#
-# == *Symbol*
-#
-#
 class Symbol
-  
-    # Rückgabe: false
-    def empty?;                         false;           end  
+
+# @!group Core Extensions  
+
+    # false
+    # @return false    
+    #def empty?;                         false;           end  
     
-    # Rückgabe: self    
+    # +self+, you can not dup Symbols
+    # @return [self]
     def dup;                            self;            end  
     
-    # wie gleichlautende String-Funktion   
+    # like String method with same name
+    # @return [Symbol]
     def +(other)
       (self.to_s + other.to_s).to_sym
     end
     
-    # wie gleichlautende String-Funktion       
-    def <=>(other)
-      self.to_s <=> other.to_s
-    end
+    # like String method with same name
+    # @return [Boolean]    
+    # def <=>(other)
+      # self.to_s <=> other.to_s
+    # end
     
-    # wie gleichlautende String-Funktion       
-    def size
-      self.to_s.size
-    end
+    # like String method with same name   
+    # @return [Integer]
+    # def size
+      # self.to_s.size
+    # end
     
-end 
+end 
+
+

data/lib/kyanite/tree.rb

@@ -1,27 +1,29 @@
 # ruby encoding: utf-8
 if $0 == __FILE__ 
-  require File.join(File.dirname(__FILE__), '..', '..', '..', 'smart_load_path.rb' )
-  smart_load_path   
+  require 'drumherum'
+  smart_init
 end
 
 require 'rubytree'
-require 'transparent_nil'  
+require 'transparent_nil'  unless defined? TransparentNil
 
 
-module Tree #:nodoc: 
+module Tree 
 
-  # [ | *Kyanite* | Object | Array | Set | Enumerable | Hash | ]     | Kyanite | TrueClass | FalseClass | NilClass | *Div* | 
-  # [ ] | Div | <b>Tree::TreeNode</b> | Optimizer | 
-  # ---
-  #
-  # == Ergänzungen zu rubytree
-  # See TestKyaniteTree for tests and examples.
-  #
+
+  
+
+  
+    # @!macro tree
   class TreeNode
-    attr_reader :childrenHash
+  
+    # @private
+    attr_reader :children_hash
    
+    # @!group Additions for rubytree    
     
-    # kann jetzt auch mit Symbolen umgehen
+    # now handles symbols in the tree as well
+    # @return [String]      
     def to_s
       ":#{@name}"
       # "Node Name: #{@name}" +
@@ -32,7 +34,8 @@ module Tree #:nodoc:
     end  
     
     
-    # funktioniert jetzt  
+    # now it works
+    # @return [void]    
     def print_tree(level = 0, breite = 8)
 
       if is_root? 
@@ -56,8 +59,8 @@ module Tree #:nodoc:
     end    
     
     
-    # anders als [] wird der gesamte Baum durchsucht
-    # Liefert den ersten Treffer 
+    # As opposed to [] the entire tree is searched.
+    # Returns the first hit. 
     def find( node_name )
       return self               if self.name == node_name
       result = self[node_name]
@@ -72,18 +75,20 @@ module Tree #:nodoc:
     end
     
     
-    # Funktioniert nicht
-    # Liefert ein Array aller untergeordneten Child-Keys. 
-    # Es wird der gesamte Baum durchsucht.
-    # def all_child_keys
-      # result = @childrenHash.keys || []
-        # children do |c| 
-        # puts "durchsuche #{c}"
-          # next if c.childrenHash.empty?
-          # result += c.all_child_keys
-        # end      
-      # result
-    # end
+
+    # Returns an array of all child keys.
+    # The whole tree is searched.
+    # @return [Array]
+    #
+    def all_child_keys
+      result = @children_hash.keys || []
+        children do |c| 
+        #puts "durchsuche #{c}"
+          next if c.children_hash.empty?
+          result += c.all_child_keys
+        end      
+      result
+    end
     
     
     

data/test/_start_all.rb

@@ -1,24 +1,27 @@
 # ruby encoding: utf-8
-#!/usr/bin/env ruby
 # 
 #	Führt alle Tests aus
 #
 
-  if $0 == __FILE__ 
-    require File.join(File.dirname(__FILE__), '..', 'smart_load_path.rb' )
-    smart_load_path   
-  end
+if $0 == __FILE__ 
+  require 'drumherum'
+  smart_init  
+end
 
-  require 'transparent_nil'     
+require 'transparent_nil'     
   
-	# Test-Verzeichnis der Applikation
-	test_verzeichnis = File.expand_path(File.dirname(__FILE__) )    
-    
-	Dir["#{test_verzeichnis}/test_*.rb"].sort.each { |t| require t }
-	Dir["#{test_verzeichnis}/array/test_*.rb"].sort.each { |t| require t }
-	Dir["#{test_verzeichnis}/enumerable/test_*.rb"].sort.each { |t| require t }
-	Dir["#{test_verzeichnis}/general/test_*.rb"].sort.each { |t| require t }
-	Dir["#{test_verzeichnis}/numeric/test_*.rb"].sort.each { |t| require t }
-	Dir["#{test_verzeichnis}/string/test_*.rb"].sort.each { |t| require t }
+  
+# Test-Verzeichnisse der Applikation
+Dir["#{File.join(Drumherum::directory_main, 'test')}/test_*.rb"].sort.each { |t| require t }  
+
+Dir["#{File.join(Drumherum::directory_main, 'test', 'array' )}/test_*.rb"].sort.each { |t| require t }  
+Dir["#{File.join(Drumherum::directory_main, 'test', 'enumerable' )}/test_*.rb"].sort.each { |t| require t }  
+Dir["#{File.join(Drumherum::directory_main, 'test', 'general' )}/test_*.rb"].sort.each { |t| require t }  
+Dir["#{File.join(Drumherum::directory_main, 'test', 'numeric' )}/test_*.rb"].sort.each { |t| require t }  
+Dir["#{File.join(Drumherum::directory_main, 'test', 'string' )}/test_*.rb"].sort.each { |t| require t }  
+
+
+  
+
 
   

data/test/array/test_array.rb

@@ -1,18 +1,16 @@
 # ruby encoding: utf-8
 # ü
 if $0 == __FILE__ 
-  require File.join(File.dirname(__FILE__), '..', '..', 'smart_load_path.rb' )
-  smart_load_path   
+  require 'drumherum'
+  smart_init 
 end
-
-require 'kyanite/unit_test'
-require 'kyanite/array/array'
+require 'drumherum/unit_test'
+require 'kyanite/array'
 require 'kyanite/numeric/numeric'
 require 'kyanite/set' 
 
 
-# Tests für Array
-# 
+# @!macro array
 class TestKyaniteArray < UnitTest 
   
   def test_rephrase_index

data/test/enumerable/test_enumerable_enumerables.rb

@@ -1,41 +1,37 @@
 # ruby encoding: utf-8
 # ü
 if $0 == __FILE__ 
-  require File.join(File.dirname(__FILE__), '..', '..', 'smart_load_path.rb' )
-  smart_load_path   
+  require 'drumherum'
+  smart_init 
+  require 'perception'
 end
-
-require 'kyanite/unit_test'
+require 'drumherum/unit_test'
 require 'kyanite/enumerable/enumerable_enumerables'
 
-class Array
-  include EnumerableEnumerables
-end
-
 
-# Tests für EnumerableEnumerables
-# 
+# @!macro enum_of_enums
 class TestKyaniteEnumerableEnumerables < UnitTest
   
   def test_rectangle1
-    test = []
+    test = ArrayOfEnumerables.new
     test << [  :a,   :b,   :c  ]
     test << [   1,    2,    3  ]
     test << [ 'i', 'ii', 'iii' ]
+    
     assert_equal test,              test.rectangle
     assert_equal test,              test.rectangle.rectangle
-    assert_equal test.transpose,    test.rectangle.transpose.rectangle
+    assert_equal test.transpose,    test.rectangle.transpose.to_array_of_enumerables.rectangle
   end
   
   
   
   def test_rectangle2
-    test = []
+    test = ArrayOfEnumerables.new
     test << [  :a,   :b,   :c       ]
     test << [   1,    2,    3,   4  ]
     test << [ 'i', 'ii' ]
     
-    expc = []
+    expc = ArrayOfEnumerables.new
     expc << [  :a,   :b,   :c  ]
     expc << [   1,    2,    3  ]
     expc << [ 'i', 'ii', nil   ]    
@@ -43,7 +39,7 @@ class TestKyaniteEnumerableEnumerables < UnitTest
     
     assert_equal expc,              test.rectangle
     assert_equal expc,              test.rectangle.rectangle
-    assert_equal expc.transpose,    test.rectangle.transpose.rectangle
+    assert_equal expc.transpose,    test.rectangle.transpose.to_array_of_enumerables.rectangle
   end    
 
 end # class