kyanite 0.3.7 → 0.4.0

data/lib/kyanite/numeric/float.rb

@@ -2,13 +2,20 @@
 Infinity = 1.0/0        unless defined? Infinity
 Googol   = 10**100      unless defined? Googol
 
-
+# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | Object | String | Symbol | *Numeric* |  
+# [ ] | Numeric | Integer | *Float* |  
+#
+# ---
+#
+# == *Float* 
+#
+#
 class Float
 
-  # 1.9 == 1.8 + 0.1               => false
-  # 1.9.approx(1.8 + 0.1)          => true
-  # 98.6.approx(98.66)             => false
-  # 98.6.approx(98.66, 0.001)      => true
+  #  1.9 == 1.8 + 0.1               => false
+  #  1.9.approx(1.8 + 0.1)          => true
+  #  98.6.approx(98.66)             => false
+  #  98.6.approx(98.66, 0.001)      => true
   # Copyright 2006 O'Reilly Media, Ruby Cookbook, by Lucas Carlson and Leonard Richardson
   #
   def approx(other, relative_epsilon=Float::EPSILON, epsilon=Float::EPSILON)

data/lib/kyanite/numeric/integer.rb

@@ -1,4 +1,12 @@
 
+# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | Object | String | Symbol | *Numeric* | 
+# [ ] | Numeric | *Integer* | Float |  
+#
+# ---
+#
+# == *Trivial* *Integer* *Methods* 
+#
+#
 class Integer
 
   # Wandelt eine Sekundenzahl-seit-1970 in ein Time-Objekt
@@ -7,19 +15,18 @@ class Integer
     ::Time.at(self)                     # ohne die Doppelpunkte sucht Ruby die Methode at in ::Time und wirft einen Error
   end     
   
-  # <tt> self </tt>   
-  #
-  # Test: TestInteger#test_triviales
+  # [ ] Rückgabe: self    
+  # [ ] Test: TestKyaniteNumeric#test_integer_triviales
   def to_integer;                     self;            end     
   
-  # <tt> self </tt>    
-  #
-  # Test: TestInteger#test_triviales
+  
+  # [ ] Rückgabe: self    
+  # [ ] Test: TestKyaniteNumeric#test_integer_triviales
   def to_integer_optional;            self;            end  
   
-  # <tt> self </tt>    
-  #
-  # Test: TestInteger#test_triviales
+  
+  # [ ] Rückgabe: self    
+  # [ ] Test: TestKyaniteNumeric#test_integer_triviales
   def dup;                            self;            end        
   
 end # class

data/lib/kyanite/numeric/numeric.rb

@@ -1,35 +1,43 @@
 
+# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | Object | String | Symbol | *Numeric* |
+# [ ] | *Numeric* | Integer | Float |  
+#
+# ---
+#
+# == *General* *Numeric* 
+#
+#
 class Numeric
 
-  # Zahlen sind schon numerisch:
-  # <tt> self </tt>       
-  def split_numeric #:nodoc:
+  # [ ] Zahlen sind schon numerisch:
+  # [ ] Rückgabe self        
+  def split_numeric 
       self 
   end    
 
 
-  # Zahlen sind nicht empty:
-  # <tt> false </tt>       
-  def empty? #:nodoc:
+  # [ ] Zahlen sind nicht empty:
+  # [ ] Rückgabe false       
+  def empty? 
       false 
   end  
   
   
-  # siehe ::Array#shift_complement:
-  # <tt> nil </tt>       
-  def shift_complement #:nodoc:
+  # [ ] siehe Array#shift_complement:
+  # [ ] Rückgabe nil 
+  def shift_complement 
     nil
   end    
   
   
-  # Wandelt 0 in nil um
+  # [ ] Wandelt 0 in nil um
   def to_nil(*args)
     return nil  if self == 0
     self
   end
   
   
-  # nil-sicheres subtrahieren 
+  # [ ] nil-sicheres subtrahieren 
   def substract(other)
     return nil if other.nil?
     self - other

data/lib/kyanite/operation/regexp.rb

@@ -3,7 +3,11 @@
 
 class String
 
-  # Zeigt das Ergebnis eines Matches mit einer Regular Expression. Erleichtert das Entwickeln regul�rer Ausdr�cke.
+  # ---------------------------------------------------------------------------------------------------------------------------------
+  # :section: Operation
+  #  
+
+  # Zeigt das Ergebnis eines Matches mit einer Regular Expression. Erleichtert das Entwickeln regulärer Ausdrücke.
   # 
   def show_regexp(re)
       if self =~ re

data/lib/kyanite/optimizer.rb

@@ -1,6 +1,18 @@
 
 require 'perception'              if $0 == __FILE__ 
-
+ 
+#
+# [ | *Kyanite* | Object | Array | Set | Enumerable | Hash | ]     | Kyanite | TrueClass | FalseClass | NilClass | *Div* | 
+# [ ] | Div | Tree::TreeNode | *Optimizer* | 
+# ---
+#
+# == *Optimizer* 
+# Auswahl von Objekten auf Basis von Scores. See TestKyaniteOptimizer for Tests and examples.
+#
+# [] Jedes Objekt wird per +push+ in den Optimizer geschrieben. Dabei wird auch sein Score übergeben.
+# [] +content_max+ bzw. +content_min+ liefern das Objekt mit dem höchsten / niedrigsten Score. 
+# [] +delete_max+ bzw. +delete_min+ löschen das Objekt mit den höchsten / niedrigsten Score. Dadurch ist auch der Zugriff auf die zweiten und dritten Objekte möglich. 
+#
 # Drei Stufen für Marshall sind denkbar:
 # * kein Marshal
 # * Marshal.load(Marshal.dump) beim Schreiben. Dadurch sind Schreibzugriffe teuer, Lesezugriffe aber billig
@@ -16,23 +28,24 @@ class Optimizer < Hash
   # end
   
   
-  def matchpoints_max
+  # Liefert den Wert des höchsten Scores.
+  def score_max
     return nil  if size == 0  
     keys.max
   end
   
   
-  
-  def matchpoints_min
+  # Liefert den Wert des niedrigsten Scores.  
+  def score_min
     return nil  if size == 0  
     keys.min
   end  
   
   
-  # Liefert den Content mit den meisten Matchpoints. Mit
-  # content_max(0)      erhält man den ersten Content mit maximalen Matchpoints, mit
-  # content_max(-1)     den letzten Content mit maximalen Matchpoints und mit 
-  # content_max(0..-1)  alle Contents mit maximalen Matchpoints (dann als Array).
+  # Liefert den Content mit dem höchsten Score. Mit
+  # [] content_max(0)      erhält man den ersten Content mit maximalem Score, mit
+  # [] content_max(-1)     den letzten Content mit maximalem Score und mit 
+  # [] content_max(0..-1)  alle Contents mit maximalem Score (dann als Array).
   #
   def content_max(range=0..0)
     return nil  if size == 0
@@ -49,7 +62,7 @@ class Optimizer < Hash
   end
   
   
-  # siehe content_max
+  # siehe #content_max
   def content_min(range=0..0)
     return nil  if size == 0
     range = (range..range) if range.kind_of?(Fixnum)    
@@ -65,17 +78,17 @@ class Optimizer < Hash
   end 
   
   
-  
-  def push( matchpoints, content, options={} )
-    if self.has_key?(matchpoints) 
-      self[matchpoints] << Marshal.dump(content) 
+  # Beladen des Optimizers mit Objekten.
+  def push( score, content, options={} )
+    if self.has_key?(score) 
+      self[score] << Marshal.dump(content) 
     else
-      self[matchpoints] = [ Marshal.dump(content) ]
+      self[score] = [ Marshal.dump(content) ]
     end
   end
   
   
-  
+  # Löscht alle Objekte in der Mitte.
   def cleanup
     return false if size <= 2
     keys.sort[1..-2].each do | key | 
@@ -85,13 +98,14 @@ class Optimizer < Hash
   end
   
   
+  # Löscht das Objekt mit dem niedrigsten Score.   
   def delete_min
     return false if size <= 1
     self.delete(keys.min)
     true
   end  
   
-  
+  # Löscht das Objekt mit dem höchsten Score.     
   def delete_max
     return false if size <= 1
     self.delete(keys.max)
@@ -100,6 +114,7 @@ class Optimizer < Hash
 
 
 
+  
 
 
 end #class

data/lib/kyanite/range.rb

@@ -1,18 +1,25 @@
 
 require 'facets/range/combine'
 require 'facets/range/within'
-require 'kyanite/enumerable'             # is_collection? ist f�r Ranges false
+require 'kyanite/enumerable'             # is_collection? ist für Ranges false
 
-
-# Aus Facets eingef�gt:
-# * umbrella(r)
-# * within?
-# * combine(r)
+# [ | Kyanite | Object | *Array* | Set | Enumerable | Hash | ]     | Array |  ArrayOfNumerics  | ArrayOfStrings |  ArrayOfEnumerables | *Range* |  
+# ---
+#
+#
+# == *Range*
+#
+#
+# Aus {Facets/Range}[http://facets.rubyforge.org/doc/api/core/classes/Range.html] eingefügt:  
+# [ ] umbrella(range) 
+# [ ] within?
+# [ ] combine(range)
+#
 #
 class Range
 
   # Invertiert den Range, mit dem ein Ausschnitt eines Strings oder eines Arrays bestimmt wird.
-  # Liefert einen Range, mit dem der inverse Teil des Strings ausgew�hlt werden kann.
+  # Liefert einen Range, mit dem der inverse Teil des Strings ausgewählt werden kann.
   # Beispiele siehe TestKyaniteRange.
   #
   def invert_index
@@ -28,7 +35,7 @@ class Range
       
     end
     
-    # �u�ere Teile ausgeben
+    # äußere Teile ausgeben
     return [(first..-1).invert_index, (0..last).invert_index]
   end # def
 

data/lib/kyanite/set.rb

@@ -7,9 +7,15 @@ require 'kyanite/symbol'                 # damit man auch Symbols aufnehmen kann
 require 'kyanite/hash'                   # Korrektur der Methoden hash und eql?
 
 
-# Set OrderedSet SortedSet Array
+# [ | Kyanite | Object | Array | *Set* | Enumerable | Hash | ]     | *Set* | OrderedSet | SortedSet | 
+# ---
 #
-# = Unterschiede der verschiedenen Set-Klassen
+#
+# == *General* *Set*
+# [ ] Tests and examples see TestKyaniteSet
+#
+#
+# === Unterschiede der verschiedenen Set-Klassen
 # * Ein {Set}[http://www.ruby-doc.org/core/classes/Set.html] ist ungeordnet.                 
 #   Beispiele:  TestKyaniteSet#test_set
 # * Ein OrderedSet ist geordnet, es behält die ursprüngliche Reihenfolge, wird aber nicht kontinuierlich neu sortiert.
@@ -59,7 +65,13 @@ class Set
 end
 
 
-# Set OrderedSet SortedSet Array
+# [ | Kyanite | Object | Array | *Set* | Enumerable | Hash | ]     | Set | *OrderedSet* | SortedSet | 
+# ---
+#
+#
+# == *Ordered* *Set*
+# [ ] Tests and examples see TestKyaniteSet
+#
 #
 # Ein OrderedSet ist geordnet, es behält die ursprüngliche Reihenfolge, wird aber nicht kontinuierlich neu sortiert.
 # Es sei denn, man sorgt dafür mit Dictionary#order_by  
@@ -127,7 +139,13 @@ class OrderedSet < Set
 end # class
   
   
-# Set OrderedSet SortedSet Array
+# [ | Kyanite | Object | | Array | *Set* | Enumerable | Hash ]     | Set | OrderedSet | *SortedSet* | 
+# ---
+#
+#
+# == *Sorted* *Set*
+# [ ] Tests and examples see TestKyaniteSet
+#
 #
 # Ein {SortedSet}[http://www.ruby-doc.org/core/classes/SortedSet.html] ist geordnet und sortiert. Es behält immer die Sortierung.       
 # Beispiele:  TestKyaniteSet#test_sorted_set
@@ -186,14 +204,25 @@ end # class
 
 
 class NilClass
-  def to_set;                         Set.new;              end     
-  def to_sorted_set;                  SortedSet.new;        end     
+
+  # Rückgabe: Leeres Set
+  def to_set;                         Set.new;              end   
+
+  # Rückgabe: Leeres SortedSet
+  def to_sorted_set;                  SortedSet.new;        end    
+
+  # Rückgabe: Leeres OrderedSet
   def to_ordered_set;                 OrderedSet.new;       end     
 end
 
 
+
 class Object
+
+  # Liefert ein Set mit einem Element
+  #
   def to_set; Set.new([self]); end
+  
 end
 
     

data/lib/kyanite/string/cast.rb

@@ -1,19 +1,26 @@
 
 require 'kyanite/numeric/integer'
  
-
+# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | Object | *String* | Symbol | Numeric |
+#
+# ---
+#
+# == *String*  
+#
+#
 class String
 
   # ---------------------------------------------------------------------------------------------------------------------------------
-  # :section: Umwandeln
-  # Siehe auch KlippsteinMail::String#to_email_address und  KlippsteinMail::String#to_domain           
+  # :section: Cast
+  # See TestKyaniteStringCast for tests and examples.
+  #  
 
     
     
     # Wandelt einen String in den plausibelsten Identifier um:
     #   self.strip.to_integer_optional
     #
-    # Tests & Beispiele siehe TestString#test_to_identifier
+    # Tests & Beispiele siehe TestKyaniteStringCast#test_to_identifier
     def to_identifier
       self.strip.to_integer_optional
     end        
@@ -22,7 +29,7 @@ class String
     # Wandelt einen String in einen Integer, auch dann, wenn die Zahl hinten angehängt wurde.
     # Im Gegensatz zu to_i wird nil zurückgegeben, wenn keine Zahl drin war. 
     # 
-    # Beispiele & Tests siehe TestString#test_to_integer      
+    # Beispiele & Tests siehe TestKyaniteStringCast#test_to_integer      
     def to_integer
         return nil                 unless self =~ /\d/
         firsttry = self.to_i
@@ -35,7 +42,7 @@ class String
     # Im Gegensatz zu to_i wird self zurückgegeben, wenn der String nicht mit einer Zahl beginnt.
     # Leere Strings werden in NIL umgewandelt. 
     # 
-    # Beispiele & Tests siehe TestString#test_to_integer_optional    
+    # Beispiele & Tests siehe TestKyaniteStringCast#test_to_integer_optional    
     def to_integer_optional
         return nil                  if self.empty?
         return self                 unless (self =~ /^\d/  || self =~ /^-\d/ )
@@ -55,6 +62,9 @@ class String
       HEX_CHARS = '0123456789abcdef'.freeze
     end
 
+    
+    # Get a hex representation for a char.
+    # [ ] See also String#from_x.     
     def to_x
       hex = ''
       each_byte { |byte|
@@ -66,7 +76,8 @@ class String
       hex
     end
     
-    
+    # [ ] Get a char for a hex representation.   
+    # [ ] See also String#to_x. 
     def from_x
       str, q, first = '', 0, false
       each_byte { |byte|

data/lib/kyanite/string/chars.rb

@@ -32,39 +32,42 @@ end
 class String
 
     # ---------------------------------------------------------------------------------------------------------------------------------
-    # :section: clear / format text
-    #     
+    # :section: Clear / Format Text
+    # See TestKyaniteStringChars for tests and examples.    
 
     # Reduziert den String auf ein Base94-Encoding.
     # * Wandelt àáâăäãāåạąæảấầắằÀÁÂĂÄÃĀÅẠĄÆẢẤẦẮẰ usw. in aaaaaaaaaaaaaaaaAAAAAAAAAAAAAAAA usw. um 
     # * entfernt anschließend alle Nicht-Asciizeichen
     # * entfernt außerdem alle nichtdruckbaren Asciizeichen
     # * Vorsicht: Newlines werden auch entfernt
-    # 
+    #   
+    # See TestKyaniteStringChars for tests and examples.
     #
-    # Tests & Beispiele siehe TestKyaniteStringClear     
     def reduce94( options={} )
       dup.reduce94!
     end        
     
+    # See TestKyaniteStringChars for tests and examples.
+    #    
     def reduce94!( options={} )   
       self.tr!(TR_FULL, TR_REDUCED)
       self.delete!('^ -~')
       self
     end    
     
-    # Reduziert den String auf ein Base53-Encoding, 
-    # bestehend aus Großbuchstaben, Minuszeichen und zu Kleinbuchstaben umgeformten Sonderzeichen.
-    # Alle reduzierten Zeichen sind aber *klein*, streng genommen handelt es sich also um ein Base52-Encoding.
-    # Wandelt z.B. àáâăäãāåạąæảấầắằÀÁÂĂÄÃĀÅẠĄÆẢẤẦẮẰ usw. in aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usw. um. 
-    # 
-    #
-    # Tests & Beispiele siehe TestKyaniteStringClear        
+    # [ ] Reduziert den String auf ein Base53-Encoding, 
+    # [ ] bestehend aus Großbuchstaben, Minuszeichen und zu Kleinbuchstaben umgeformten Sonderzeichen.
+    # [ ] Alle reduzierten Zeichen sind aber *klein*, streng genommen handelt es sich also um ein Base52-Encoding.
+    # [ ] Wandelt z.B. àáâăäãāåạąæảấầắằÀÁÂĂÄÃĀÅẠĄÆẢẤẦẮẰ usw. in aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa usw. um. 
+    #       
+    # [ ] See TestKyaniteStringChars for tests and examples.
+    #    
     def reduce53( options={} )
       dup.reduce53!(options)
     end        
     
-    
+    # See TestKyaniteStringChars for tests and examples.
+    #    
     def reduce53!( options={} )
       if options[:camelcase]  
         self.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1-\2')
@@ -90,7 +93,8 @@ class String
     
     # Formt einen String so um, dass man auch mit utf8_general_ci verglichene Strings wiedererkennen kann
     #
-    # Tests & Beispiele siehe TestKyaniteStringClear     
+    # See TestKyaniteStringChars for tests and examples.
+    #   
     def mysqlize
       self.mb_chars.tidy_bytes.mgsub(MYSQL_REPLACES).downcase.to_s
     end           
@@ -99,7 +103,7 @@ class String
     
     # macht die nötigen Korrekturen für EmailAddress und Domain.
     #
-    # Tests & Beispiele siehe TestKyaniteStringClear 
+    # Tests & Beispiele siehe TestKyaniteStringChars 
     # def strip_downcase_iconv
                 #to          #from 
       # Iconv.new('iso-8859-1','utf-8').iconv(self.strip.downcase2)
@@ -111,7 +115,8 @@ class String
     
     # ---------------------------------------------------------------------------------------------------------------------------------
     # :section: Groß- und Kleinschreibung
-    #   
+    # See TestKyaniteStringChars for tests and examples.
+    #
     
     # Ein Überschreiben von downcase führt in Kombination mit ActiveSupport zu seltsamen Ergebnissen!
     def downcase2 
@@ -153,15 +158,17 @@ end
 
 
 class NilClass
+
+  # Rückgabe: false
+  def capitalized?;                 false;          end  
+  
   def reduce94;                     nil;            end
   def reduce94!;                    nil;            end
   def reduce53;                     nil;            end
   def reduce53!;                    nil;            end  
-  def capitalized?;                 false;          end  
   def downcase2;                    nil;            end    
   def downcase2!;                   nil;            end    
   def mysqlize;                     nil;            end  
-# def strip_downcase_iconv;         nil;            end  
   def upcase2;                      nil;            end  
   def upcase2!;                     nil;            end  
 end