kyanite 0.3.7 → 0.4.0

data/lib/kyanite/string/diff.rb

@@ -5,12 +5,12 @@ class String
 
         
 # ---------------------------------------------------------------------------------------------------------------------------------
-# :section: overlap / diff
-#          
+# :section: Overlap / Diff
+# See TestKyaniteStringDiff for tests and examples.         
         
   # Gibt den gemeinsamen Teil zweier Strings aus (von vorne gezählt).  
   #    
-  # Beispiele & Tests siehe TestString#test_overlap    
+  # Beispiele & Tests siehe TestKyaniteStringDiff#test_overlap    
   def overlap(b)
       return ''         if b.nil?
       b = b.to_str
@@ -26,7 +26,7 @@ class String
   # Im Zweifelsfall immer den längsten String.
   # Wenn dann immer noch Zweifel, dann self. 
   #    
-  # Beispiele & Tests siehe TestString#test_diff    
+  # Beispiele & Tests siehe TestKyaniteStringDiff#test_diff    
   def diff(b)
       return self     if b.nil?
       b = b.to_str
@@ -46,7 +46,7 @@ class String
   # Waren beide gleichlang, so erhält man self.
   # overlapdiff braucht genauso viel Zeit wie diff alleine. 
   #
-  # Beispiele & Tests siehe TestString#test_overlapdiff    
+  # Beispiele & Tests siehe TestKyaniteStringDiff#test_overlapdiff    
   def overlapdiff(b)
       return '', self     if b.nil?
       b = b.to_str
@@ -66,8 +66,17 @@ end
 
 
 class NilClass
+
+  # Rückgabe: Leerer String,
+  # siehe String#overlap
   def overlap(*a);              '';             end  
+  
+  # Rückgabe: b,
+  # siehe String#diff  
   def diff(b);                  b;              end  
+  
+  # Rückgabe: ['', b],
+  # siehe String#overlapdiff
   def overlapdiff(b);           ['', b];        end  
 end
 

data/lib/kyanite/string/div.rb

@@ -3,6 +3,10 @@
 
 class String
 
+  # ---------------------------------------------------------------------------------------------------------------------------------
+  # :section: Div
+  #  
+
   # Wörter zählen
   def count_words
     n = 0
@@ -15,5 +19,8 @@ end
 
 
 class NilClass
-    def count_words;                   0;          end  
+
+  # Rückgabe: 0
+  def count_words;                   0;          end  
+  
 end

data/lib/kyanite/string/include.rb

@@ -1,12 +1,17 @@
 
 class String
+
+  # ---------------------------------------------------------------------------------------------------------------------------------
+  # :section: include
+  #  
+  
   alias :old_include? :include?
   
-  # Nimmt jetzt auch ein Array an. 
-  # Die Array-Elemente werden ODER-verknüpft, d.h. 
-  # include? ist true, wenn für mindestens eines der Elemente include? true ist.
-  # Alle Strings includen '', [] oder nil. 
-  # Andersherum enthält nil niemals irgendwas (nil.include?  => false)
+  # [ ] Nimmt jetzt auch ein Array an. 
+  # [ ] Die Array-Elemente werden ODER-verknüpft, d.h. 
+  # [ ] include? ist true, wenn für mindestens eines der Elemente include? true ist.
+  # [ ] Alle Strings includen '', [] oder nil. 
+  # [ ] Andersherum enthält nil niemals irgendwas (nil.include?  => false)
   def include?(input)
     return true if input.nil?
     return true if input.empty?
@@ -23,6 +28,9 @@ end
 
 
 class NilClass
+
+    # Rückgabe: false
+    # redundante Definition!        
     def include?(*a);                   false;          end  
 end
 

data/lib/kyanite/string/list.rb

@@ -5,11 +5,11 @@ require 'kyanite/symbol'
 class String
 
 # ---------------------------------------------------------------------------------------------------------------------------------
-# :section: Listen / Datenbank
-#      
+# :section: List / Database
+# See TestKyaniteStringList for tests and examples.     
   
   
-  # Listet Text auf. Beispiele siehe Tests!
+  # Listet Text auf. Beispiele siehe TestKyaniteStringList
   def list_with(  elemente, options = {}, &block )
   
     options = { :pre    => %q{'},

data/lib/kyanite/string/mgsub.rb

@@ -1,10 +1,14 @@
 
 class String
+
+  # ---------------------------------------------------------------------------------------------------------------------------------
+  # :section: mgsub
+  #  
  
   # Mehrere Patterns mit einer RegExp replacen.
   # Ruby Cookbook Seite 32 
-  # "between".mgsub([[/ee/, 'AA'], [/e/, 'E']])      # Good code
-  # => "bEtwAAn"
+  #  "between".mgsub([[/ee/, 'AA'], [/e/, 'E']])      # Good code
+  #  => "bEtwAAn"
   #  
   def mgsub(key_value_pairs=[].freeze)
     regexp_fragments = key_value_pairs.collect { |k,v| k }

data/lib/kyanite/string/nested.rb

@@ -1,5 +1,10 @@
 
 class String
+
+# ---------------------------------------------------------------------------------------------------------------------------------
+# :section: Nested
+# See TestKyaniteStringNested for tests and examples.   
+#
   
   
   # Gibt die passende gegenteilige Klammer zurück
@@ -8,6 +13,9 @@ class String
   # ']'.anti          ->  '['
   # '<hallo>'.anti    ->  '</hallo>'
   # '</hallo>'.anti   ->  '<hallo>'
+  #
+  # See TestKyaniteStringNested for tests and examples.  
+  #  
   def anti
     if self.size == 1
       return self.tr('([{<)]}>',')]}>([{<')
@@ -26,6 +34,9 @@ class String
   # Findet das nächste zueinander passende Klammerpaar ab Position start.
   # Liefert die Positionen der Klammern als Range.
   # Bsp.: 'Hallo(welt)wort'.index_bracket  ->  5..10
+  #
+  # See TestKyaniteStringNested for tests and examples.   
+  #  
   def index_bracket( pattern=nil, start=0, last_found = nil )
     return nil if self.empty?
     pattern = /[{<\[]/ unless pattern    
@@ -63,7 +74,9 @@ class String
   
   
   # Wendet den Block auf eine hierarchisch definierte Auswahl des Strings an.
-  # Beispiele siehe Tests.
+  #
+  # See TestKyaniteStringNested for tests and examples.  
+  #  
   def mask( options={}, &block )
   
     # vorbereiten
@@ -176,7 +189,10 @@ class String
   end # def
 
 
-  # Liefert die Verschachtelungstiefe
+  # Liefert die Verschachtelungstiefe.
+  #
+  # See TestKyaniteStringNested for tests and examples.  
+  #    
   def nestinglevel(pattern=/[{<(\[]/)
     result = 0
     self.mask( :level_start => 0,
@@ -202,10 +218,13 @@ end # class
 
 
 class NilClass
+  
+  # Rückgabe: 0
+  def nestinglevel;               0;              end   
+  
   def anti;                       nil;            end
   def index_bracket;              nil;            end
   def mask(*a);                   nil;            end
-  def nestinglevel;               0;              end    
 end
 
 

data/lib/kyanite/string/random.rb

@@ -44,6 +44,10 @@ end
 
 class String
 
+  # ---------------------------------------------------------------------------------------------------------------------------------
+  # :section: Random
+  #  
+
     # Zufällige Reihenfolge
     def shuffle(separator=//)
       split(separator).shuffle.join('')

data/lib/kyanite/string/split.rb

@@ -6,13 +6,17 @@
  require 'kyanite/array/array'
  
  
+
+class String
+
 # ---------------------------------------------------------------------------------------------------------------------------------
-# :section: Aufsplitten
+# :section: Split
+# See TestKyaniteStringSplit for tests and examples.
 #
-# Aus {Facets/String}[http://facets.rubyforge.org/rdoc/Core/classes/String.html] eingefügt:
-# * <tt>shatter(re)</tt> :: Breaks a string up into an array based on a regular expression. Similar to +scan+, but includes the matches.       
-#
-class String
+# 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
@@ -117,7 +121,7 @@ class String
     # 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 TestKyaniteStringClear
+    # Tests siehe TestKyaniteStringSplit
     def without_versioninfo
         shatter(/\d+/)[0].strip.chomp('_').chomp('-').chomp('.')
     end        
@@ -126,8 +130,12 @@ end
 
 
 class NilClass
-  def nchar(*a);                          nil;            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  

data/lib/kyanite/symbol.rb

@@ -1,17 +1,31 @@
 
+
+# [ | Kyanite | *Object* | Array | Set | Enumerable | Hash | ]     | Object | String | *Symbol* | Numeric | 
+#
+# ---
+#
+# == *Symbol*
+#
+#
 class Symbol
   
+    # Rückgabe: false
     def empty?;                         false;           end  
+    
+    # Rückgabe: self    
     def dup;                            self;            end  
     
+    # wie gleichlautende String-Funktion   
     def +(other)
       (self.to_s + other.to_s).to_sym
     end
     
+    # wie gleichlautende String-Funktion       
     def <=>(other)
       self.to_s <=> other.to_s
     end
     
+    # wie gleichlautende String-Funktion       
     def size
       self.to_s.size
     end

data/lib/kyanite/tree.rb

@@ -2,10 +2,16 @@
 
 require 'tree'
 
-# -----------------------------------------------------------------------------------------
-# Ergänzungen zu rubytree 0.5.2
-#
-module Tree
+
+module Tree # :nodoc: 
+
+  # [ | *Kyanite* | Object | Array | Set | Enumerable | Hash | ]     | Kyanite | TrueClass | FalseClass | NilClass | *Div* | 
+  # [ ] | Div | <b>Tree::TreeNode</b> | Optimizer | 
+  # ---
+  #
+  # == *Ergänzungen* *zu* *rubytree* *0.5.2*  
+  # See TestKyaniteTree for tests and examples.
+  #
   class TreeNode
     attr_reader :childrenHash
    

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/kyanite.rb'}"
+puts "Welcome to Kyanite gem"
+exec "#{irb} #{libs} --simple-prompt --noreadline"

data/script/console.cmd

@@ -0,0 +1 @@
+@ruby script/console %*

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/destroy.cmd

@@ -0,0 +1 @@
+@ruby script/destroy %*

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/generate.cmd

@@ -0,0 +1 @@
+@ruby script/generate %*

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'kyanite' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'kyanite'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Kyanite::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)