kyanite 0.3.7 → 0.4.0

data/lib/kyanite/array/array2.rb

@@ -14,7 +14,7 @@ class Array
 
 end   
 
-class NilClass # :nodoc:
+class NilClass 
   def row_to_nil;           nil;              end    
 end
 

data/lib/kyanite/dictionary.rb

@@ -2,6 +2,18 @@
 require 'facets/dictionary'
 require 'kyanite/enumerable'             # is_collection?
 
+
+
+# [ | Kyanite | Object | Array | Set | Enumerable | *Hash* | ]     | Hash |  *Dictionary* |
+# ---
+#  
+#
+# == *Tools* *For* *Facets* *Dictionary*
+# [ ] A Dictionary is a ordered Hash. 
+# [ ] Expands {Facets/Dictionary}[http://facets.rubyforge.org/doc/api/more/classes/Dictionary.html].
+# [ ] See TestKyaniteDictionary for tests and examples.
+#
+#
 class Dictionary
 
   def fetch_by_index(index)
@@ -42,7 +54,6 @@ end
 
 class Hash
 
-  # :section: Cast
   # TODO: effizienter
   def to_dictionary
     result = Dictionary.new
@@ -81,8 +92,12 @@ end
 
 
 class NilClass
-  def fetch_by_index(*a);                 nil;                end  
+
+  # Rückgabe: Leeres Dictionary    
   def to_dictionary;                      Dictionary.new;     end  
+
+  def fetch_by_index(*a);                 nil;                end  
+
 end
 
 

data/lib/kyanite/enumerable/enumerable_enumerables.rb

@@ -9,18 +9,22 @@ module Enumerable
 
 end
 
-# Enumerable, EnumerableNumerics, EnumerableStrings, EnumerableEnumerables
+# [ | Kyanite | Object | Array | Set | *Enumerable* | Hash | ]     | Enumerable | EnumerableNumerics | EnumerableStrings | *EnumerableEnumerables* | 
+# ---
+#
+#
+# == *Enumeration* *Of* *Enumerations*
+# [ ] Für zweidimensionale Enumerables bzw. Aufzählungen von Objekten, die wiederum aufzählbar sind.
+# [ ] See TestKyaniteEnumerableEnumerables for tests and examples.
+# [ ] See ArrayOfEnumerables for an Array with modul EnumerableEnumerables included. 
+#
 #
-# ==Aufzählungen aufzählbarer Objekte
-# Für zweidimensionale Enumerables bzw. Aufzählungen von Objekten, die wiederum aufzählbar sind.
-# Ein ArrayOfEnumerables inkludiert dieses Modul.
-# 
 module EnumerableEnumerables
 
   # Macht das Enumerable rechteckig.
   # Maßgeblich ist die erste Zeile.
   #
-  # Tests und Beispiele siehe TestKyaniteEnumerableEnumerables.
+  # Tests and examples see TestKyaniteEnumerableEnumerables.
   def rectangle
     qsize = self[0].size   
     result = []
@@ -39,11 +43,17 @@ module EnumerableEnumerables
 
 end
 
-# Array, ArrayOfNumerics, ArrayOfStrings, ArrayOfEnumerables
+
+
+# [ | Kyanite | Object | *Array* | Set | Enumerable | Hash | ]     | Array |  ArrayOfNumerics  | ArrayOfStrings |  *ArrayOfEnumerables* | Range |  
+# ---
+#
 #
-# Ein ArrayOfEnumerables ist ein Array mit inkludiertem Modul EnumerableEnumerables
+# == *Array* *Of* *Enumerations*
+# [ ] An ArrayOfEnumerables is an Array with modul EnumerableEnumerables included. 
+# [ ] See TestKyaniteEnumerableEnumerables for tests and examples.
 #
-class ArrayOfEnumerables < Array
+class ArrayOfEnumerables < Array   
   include EnumerableEnumerables
 end
 

data/lib/kyanite/enumerable/enumerable_numerics.rb

@@ -1,8 +1,12 @@
 
-# Enumerable, EnumerableNumerics, EnumerableStrings, EnumerableEnumerables
+# [ | Kyanite | Object | Array | Set | *Enumerable* | Hash | ]     | Enumerable | *EnumerableNumerics* | EnumerableStrings | EnumerableEnumerables | 
+# ---
+#
+#
+# == *Enumeration* *Of* *Numerics*
+# [ ] See TestKyaniteEnumerableNumerics for tests and examples.
+# [ ] See ArrayOfNumerics for an Array with modul EnumerableNumerics included. 
 #
-# ==Aufzählungen numerischer Objekte
-# Ein ArrayOfNumerics inkludiert dieses Modul.
 #
 module EnumerableNumerics
 
@@ -12,7 +16,7 @@ module EnumerableNumerics
 #  
 
   # Arithmetrischer Mittelwert
-  # Tests und Beispiele siehe TestKyaniteEnumerableNumerics.
+  # Tests and examples see TestKyaniteEnumerableNumerics.
   #    
   def mean
     self.inject(0.0) { |sum, i | sum += i } / self.length.to_f 
@@ -28,7 +32,7 @@ module EnumerableNumerics
   # Dann wird der harmonische Mittelwert aller positiven Elemente mit dem 
   # harmonische Mittelwert aller negativen Elemente verrechnet (als gewichtetes arithmetisches Mittel).
   #
-  # Tests und Beispiele siehe TestKyaniteEnumerableNumerics.
+  # Tests and examples see TestKyaniteEnumerableNumerics.
   #    
   def mean_harmonic( options={} )
     return 0              if self.empty?  
@@ -67,7 +71,7 @@ module EnumerableNumerics
  
   # Geometrischer Mittelwert 
   def mean_geometric
-    self.product**( 1.0/self.size ) 
+    self.prd ** ( 1.0/self.size ) 
   end  
   
 
@@ -80,7 +84,7 @@ module EnumerableNumerics
   # Summe
   #
   # Methode darf nicht sum heißen, kollidiert sonst schnell mit ActiveRecord.
-  # Tests und Beispiele siehe TestKyaniteEnumerableNumerics.
+  # Tests and examples see TestKyaniteEnumerableNumerics.
   #  
   def summation
     self.inject(0.0) { |sum, i | sum += i }  
@@ -88,17 +92,16 @@ module EnumerableNumerics
   
   
   # Produkt
-  #  
-  # Tests und Beispiele siehe TestKyaniteEnumerableNumerics.
+  # Methode darf nicht product heißen, die gibt es nämlich schon.
+  # Tests and examples see TestKyaniteEnumerableNumerics.
   #    
-  def product
-    self.inject(1.0) { |prd, i | prd *= i }  
-  end   
-  alias prd product  
+  def prd
+    self.inject(1.0) { |p, i | p *= i }  
+  end    
   
   
   # Ergebnis entspricht der Parallelschaltung von Widerständen.
-  # Tests und Beispiele siehe TestKyaniteEnumerableNumerics.
+  # Tests and examples see TestKyaniteEnumerableNumerics.
   #    
   def parallel
     mean_harmonic / size  
@@ -110,11 +113,15 @@ end #class
 
 
 
-# Array, ArrayOfNumerics, ArrayOfStrings, ArrayOfEnumerables
+# [ | Kyanite | Object | *Array* | Set | Enumerable | Hash | ]     | Array |  *ArrayOfNumerics*  | ArrayOfStrings |  ArrayOfEnumerables | Range | 
+# ---
+#
 #
-# Ein ArrayOfNumerics ist ein Array mit inkludiertem Modul EnumerableNumerics
+# == *Array* *Of* *Numerics*
+# [ ] An ArrayOfNumerics is an Array with modul EnumerableNumerics included. 
+# [ ] See TestKyaniteEnumerableNumerics for tests and examples.
 #
-class ArrayOfNumerics < Array
+class ArrayOfNumerics < Array 
   include EnumerableNumerics
 end
 
@@ -138,9 +145,8 @@ class NilClass
   def mean_arithmetric;                         nil;            end  
   def mean_geometric;                           nil;            end  
   def mean_harmonic(*a);                        nil;            end  
-  def parallel(*a);                             nil;            end  
+  def parallel(*a);                             nil;            end           
   def prd;                                      nil;            end  
-  def product;                                  nil;            end  
   def sum;                                      nil;            end  
   def summation;                                nil;            end  
 end

data/lib/kyanite/enumerable/enumerable_strings.rb

@@ -1,8 +1,12 @@
 
-# Enumerable, EnumerableNumerics, EnumerableStrings, EnumerableEnumerables
+# [ | Kyanite | Object | Array | Set | *Enumerable* | Hash | ]     | Enumerable | EnumerableNumerics | *EnumerableStrings* | EnumerableEnumerables | 
+# ---
+#
+#
+# == *Enumeration* *Of* *Strings*
+# [ ] See TestKyaniteEnumerableStrings for tests and examples.
+# [ ] See ArrayOfStrings for an Array with modul EnumerableStrings included. 
 #
-# ==Aufzählungen textueller Objekte
-# Ein ArrayOfStrings inkludiert dieses Modul.
 # 
 module EnumerableStrings
 
@@ -12,7 +16,7 @@ module EnumerableStrings
   #  ['lutm', 'lutmi', 'lutmil', 'lutmila', 'lutrika', 'lutrik', 'lutri', 'lutr']
   # d.h. vorne und hinten wird alles Gleiche weggestrichen.
   #
-  # Tests und Beispiele siehe TestKyaniteEnumerableStrings.
+  # Tests and examples see TestKyaniteEnumerableStrings.
   #
   def palindrom_rumpf
     result = self.dup
@@ -32,9 +36,13 @@ end
 
 
 
-# Array, ArrayOfNumerics, ArrayOfStrings, ArrayOfEnumerables
+# [ | Kyanite | Object | *Array* | Set | Enumerable | Hash | ]     | Array |  ArrayOfNumerics  | *ArrayOfStrings* |  ArrayOfEnumerables | Range |  
+# ---
+#
 #
-# Ein ArrayOfStrings ist ein Array mit inkludiertem Modul EnumerableStrings
+# == *Array* *Of* *Strings*
+# [ ] An ArrayOfstrings is an Array with modul EnumerableStrings included. 
+# [ ] See TestKyaniteEnumerableStrings for tests and examples.
 #
 class ArrayOfStrings < Array
   include EnumerableStrings

data/lib/kyanite/enumerable/structure.rb

@@ -1,56 +1,74 @@
 
-# 
-# is_collection?
-#
+
 
 class Object
 
-  # Enthält ein Objekt mehrere Objekte?
-  # String und Range gelten nicht als Collection.
-  #
-  # Tests & Beispiele siehe TestKyaniteEnumerableStructure.
+  # [ ] Enthält ein Objekt mehrere Objekte?
+  # [ ] String und Range gelten nicht als Collection.
+  # [ ] See TestKyaniteEnumerableStructure for tests and examples.
   def is_collection?;                 false;          end
+  
 end
 
 
 module Enumerable
 
-  # Enthält ein Objekt mehrere Objekte?
-  # String und Range gelten nicht als Collection.
-  #
-  # Tests & Beispiele siehe TestKyaniteEnumerableStructure.
+  # [ ] Enthält ein Objekt mehrere Objekte?
+  # [ ] Rückgabe: true  
+  # [ ] String und Range gelten nicht als Collection.
+  # [ ] See TestKyaniteEnumerableStructure for tests and examples.
   def is_collection?;                 true;          end
+  
 end
 
 
-class String # :nodoc:
+class String 
+
+  # ---------------------------------------------------------------------------------------------------------------------------------
+  # :section: Structure
+  #  
+
+  # [ ] Enthält ein Objekt mehrere Objekte?
+  # [ ] Rückgabe: false  
+  # [ ] String und Range gelten nicht als Collection.
+  # [ ] See TestKyaniteEnumerableStructure for tests and examples.
   def is_collection?;                 false;          end
+  
+  
 end
 
 
-class Range # :nodoc:
+class Range 
+
+  # [ ] Enthält ein Objekt mehrere Objekte?
+  # [ ] Rückgabe: false  
+  # [ ] String und Range gelten nicht als Collection.
+  # [ ] See TestKyaniteEnumerableStructure for tests and examples.
   def is_collection?;                 false;          end
+  
 end
 
 
 
 
-# 
-# Distribution
-#
 
 
-# Enumerable, EnumerableNumerics, EnumerableStrings, EnumerableEnumerables
+
+# [ | Kyanite | Object | Array | Set | *Enumerable* | Hash | ]     | *Enumerable* | EnumerableNumerics | EnumerableStrings | EnumerableEnumerables | 
+# ---
+#
+#
+# == *General* *Enumerations*
+# [ ] See TestKyaniteEnumerableStructure for tests and examples.
 #
-# ==Allgemeine Aufzählungen
 # 
 module Enumerable
 
-  # Liefert die Verteilung der size 
-  # oder die Verteilung der class 
-  # oder die Verteilung eines anderen Merkmals der aufgezählten Elemente.
-  #
-  # Tests & Beispiele siehe TestKyaniteEnumerableStructure.
+  # [ ] Liefert die Verteilung der size 
+  # [ ] oder die Verteilung der class 
+  # [ ] oder die Verteilung eines anderen Merkmals der aufgezählten Elemente.
+  # [ ] die Methode gibt es auch als Hash#distribution.  
+  # [ ] See TestKyaniteEnumerableStructure  for tests and examples.
   #
   def distribution( mode = :size)
     verteilung = Hash.new
@@ -68,9 +86,7 @@ module Enumerable
   
   
   
-# 
-# contentclass
-#  
+
   
   # Was für Objekte beinhaltet die Collection?
   # Liefert die Klasse der Contentelemente, oder <tt>Object</tt> wenn es verschiedene sind. 
@@ -82,7 +98,7 @@ module Enumerable
   #  :ignore_nil => true   NilClass wird nicht aufgeführt                    (STANDARD)
   #  :ignore_nil => false  NilClass wird mit aufgeführt  
   #
-  # Tests & Beispiele siehe TestKyaniteEnumerableStructure.  
+  # See TestKyaniteEnumerableStructure  for tests and examples.
   #
   def contentclass( options={} )
     precision  = options[:precision]    || 2
@@ -108,7 +124,7 @@ module Enumerable
         return f
       else
         result = f.ancestors & l.ancestors
-        #see result - [Object, Kernel, Precision, Perception::NumericI,  PP::ObjectMixin,  KyaniteKernel]
+        #see result - [Object, Kernel, Precision, Perception::NumericI,  PP::ObjectMixin,  KKernel]
         return Numeric      if result.include?(Numeric)
         return Enumerable   if result.include?(Enumerable)
         return Object
@@ -131,7 +147,7 @@ module Enumerable
       c[1..-1].each do |e|
         result = result & e.ancestors
       end
-      #see result - [Object, Kernel, Precision, Perception::NumericI,  PP::ObjectMixin,  KyaniteKernel]      
+      #see result - [Object, Kernel, Precision, Perception::NumericI,  PP::ObjectMixin,  KKernel]      
       return Numeric      if result.include?(Numeric)
       return Enumerable   if result.include?(Enumerable)
       return Object

data/lib/kyanite/general/callerutils.rb

@@ -1,7 +1,15 @@
 
 require 'kyanite/string/include'
 
-# ==Tools for Kernel#caller
+
+
+# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | *Object* | String | Symbol | Numeric |  
+# [ ] | Object | KKernel | *CallerUtils* | Undoable | Class |
+#
+# ---
+#
+#
+# == *Tools* *for* Kernel#caller
 #
 class CallerUtils
 

data/lib/kyanite/general/classutils.rb

@@ -4,10 +4,14 @@ require 'facets/kernel/singleton_class'     # Easy access to an object‘s "spec
 require 'facets/class/descendents'          # Methode   descendents 
 
 
-# 
-# Class
-# 
-
+# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | *Object* | String | Symbol | Numeric | 
+# [ ] | Object | KKernel | CallerUtils | Undoable | *Class* | 
+#
+# ---
+#
+# == *Class* *Utils*  
+# See TestKyaniteClassutils for tests and examples.
+#
 class Class
   
   # Vergleichsoperator: Alphabetisch. 
@@ -24,15 +28,20 @@ class Class
     return false
   end  
 
-  # <tt> self </tt>
+  # [ ] Die Methode to_class wandelt einen Klassennamen in eine Klasse.
+  # [ ] Die Methode gibt es insbesondere für String und Symbol, siehe String#to_class, Symbol#to_class  
+  # [ ] Für Class ist sie einfach transparent, d.h. sie liefert self.   
+  # [ ] Tests and examples see TestKyaniteClassutils
+  # 
   def to_class 
     self
   end     
 
   
-  # Wandelt eine Klasse in einen Klassennamen um, der nur Kleinbuchstaben enthält.
-  #
-  # Tests siehe TestKyaniteClassutils
+  # [ ] Gegenstück zu to_class: 
+  # [ ] Wandelt eine Klasse in einen Klassennamen um, der nur Kleinbuchstaben enthält.
+  # [ ] Siehe String#to_classname, Symbol#to_classname
+  # [ ] Tests and examples see TestKyaniteClassutils
   #
   def to_classname
     self.to_s.demodulize.underscore
@@ -43,26 +52,22 @@ end # class
 
 
 
-# 
-# Symbol
-#
+
   
 class Symbol
 
-  # Wandelt einen String in einen Klassennamen. 
-  #   'MeinModul::EineKlasse'  =>  eine_klasse
-  #
-  # Tests und Beispiele siehe TestKyaniteClassutils
+  # [ ] Wandelt ein Symbol in einen Klassennamen, der nur Kleinbuchstaben enthält. 
+  # [ ] Siehe String#to_classname     
+  # [ ] Tests and examples see TestKyaniteClassutils
   #
    def to_classname 
       self.to_s.to_classname
   end
 
-  # Wandelt einen Klassennamen in eine Klasse.
-  #
-  # Akzeptiert sowohl CamelCase als auch down_case.
-  #
-  # Tests und Beispiele siehe TestKyaniteClassutils
+  # [ ] Wandelt einen Klassennamen in eine Klasse.
+  # [ ] Akzeptiert sowohl CamelCase als auch down_case.
+  # [ ] Die Methode gibt es auch für String und Class.
+  # [ ] Tests and examples see TestKyaniteClassutils
   #
   def to_class 
       self.to_s.to_class
@@ -74,71 +79,40 @@ end # class
 
 
   
-# 
-# String
-#  
+ 
   
 class String  
 
-  # Wandelt einen Klassennamen in eine Klasse.
+  # ---------------------------------------------------------------------------------------------------------------------------------
+  # :section: Class Utils
+  # See TestKyaniteClassutils for tests and examples.
+  #  
+
+
+  # Wandelt einen String in einen Klassennamen, der nur Kleinbuchstaben enthält. 
+  #   'MeinModul::EineKlasse'  =>  'eine_klasse'
   #
-  # Akzeptiert sowohl CamelCase als auch down_case.
+  # Tests and examples see TestKyaniteClassutils
+  #
+  def to_classname
+      self.demodulize.underscore
+  end
+  
+  
+
+  # [ ] Wandelt einen Klassennamen in eine Klasse.
+  # [ ] Akzeptiert sowohl CamelCase als auch down_case.
+  # [ ] Die Methode gibt es auch für Symbol und Class.
+  # [ ] Tests and examples see TestKyaniteClassutils
   #
-  # Tests und Beispiele siehe TestKyaniteClassutils
-  # 
   def to_class
       self.camelize.constantize
   rescue
       return nil
   end
   
-  
-  # Wandelt einen String in einen Klassennamen. 
-  #   'MeinModul::EineKlasse'  =>  eine_klasse
-  #
-  # Tests und Beispiele siehe TestKyaniteClassutils
-  #
-  def to_classname
-      self.demodulize.underscore
-  end
-
-end
-
 
 
-# 
-# String, from ActiveSupport
-#  
-
-#
-# ActiveSupport
-# --------------
-#
-# Copyright (c) 2005 David Heinemeier Hansson
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-
-class String
-
 
   # The reverse of +camelize+. Makes an underscored, lowercase form from the expression in the string.
   #
@@ -147,7 +121,7 @@ class String
   # Examples:
   #   "ActiveRecord".underscore         # => "active_record"
   #   "ActiveRecord::Errors".underscore # => active_record/errors
-  # From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson  
+  # [ ] From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson. See License.txt.  
   #  
   def underscore
     self.gsub(/::/, '/').
@@ -169,7 +143,7 @@ class String
   #   "active_record".camelize(:lower)        # => "activeRecord"
   #   "active_record/errors".camelize         # => "ActiveRecord::Errors"
   #   "active_record/errors".camelize(:lower) # => "activeRecord::Errors"
-  # From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson  
+  # [ ] From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson. See License.txt.   
   #  
   def camelize(first_letter_in_uppercase = true)
     if first_letter_in_uppercase
@@ -185,7 +159,7 @@ class String
   # Examples:
   #   "ActiveRecord::CoreExtensions::String::Inflections".demodulize # => "Inflections"
   #   "Inflections".demodulize                                       # => "Inflections"
-  # From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson  
+  # [ ] From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson. See License.txt.   
   #  
   def demodulize
     self.gsub(/^.*::/, '')
@@ -210,7 +184,7 @@ class String
   #
   # NameError is raised when the name is not in CamelCase or the constant is
   # unknown.
-  # From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson  
+  # From ActiveSupport, Copyright (c) 2005 David Heinemeier Hansson. See License.txt.   
   #
   def constantize
     unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ self
@@ -224,12 +198,19 @@ end # class
 
 
 class NilClass
+
+  # Rückgabe: Leerer String  
+  def to_classname;             '';                   end  
+
   def camelize;                 nil;                  end 
   def constantize;              nil;                  end 
   def demodulize;               nil;                  end 
-  def to_class;                 nil;                  end    
-  def to_classname;             '';                   end    
+  def to_class;                 nil;                  end  
   def underscore;               nil;                  end 
+  
+  
+  
+
 end