kyanite 0.6.1 → 0.7.0

data/Div

@@ -10,38 +10,12 @@
 * Undoable          Undo für komplexe Objekte
 
 
-== Unit Tests
-Durchlaufende Tests besitzen eine Statusanzeige, wenn man UnitTest statt Test::Unit::TestCase: verwendet.
-
-smart_load_path vereinfacht die require-Statements in den Tests. Usage:
-  if $0 == __FILE__ 
-    require 'kyanite/smart_load_path'
-    smart_load_path   
-  end
-  require 'kyanite/unit_test'
-  require 'my_library'
-Das +require 'my_library'+ lädt die aktuelle Version von +my_library+ im übergeordneten Projektverzeichnis, nicht nur die über gem installierte Version.
-
-
-== Rake Tasks
-Usage: Head of Rakefile
-  projectname = File.dirname(__FILE__).split("/")[-1].strip   # Name des Projekt-Stammverzeichnisses
-  require File.dirname(__FILE__) + "/lib/#{projectname}"      # Hauptdatei der Library
-
-  Kyanite.projectname = projectname
-  Kyanite.github_username = 'bklippstein'
-
-  require 'hoe'
-  require 'rdoc/task'
-  require 'kyanite/rake'
-  
-
-Console:
-  rake rubygems_publish      # release actual version to rubygems
-  rake git_publish           # publish actual version to github
-  rake git_publish_docs      # publish docs to github
-  
-  rake publish               # publish all to github and rubygems, reinstall gem 
+
+
+
+
+
+
 
 
 

data/{History.txt → History.rdoc}

@@ -1,3 +1,11 @@
+== 0.7.0 2012-10-31
+* some structure changes
+* englisch YARD documentation
+
+== 0.6.2 2012-10-15
+* $LOAD_PATH management and Rake tasks for deploying: now in gem drumherum
+* Nil-Handling: now in gem transparent_nil
+
 == 0.6.0 2012-10-15
 * improved nil-Handling 
 

data/Manifest.txt

@@ -1,16 +1,14 @@
 console.rb
 Div
-History.txt
-License.txt
+History.rdoc
+License.rdoc
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile.rb
 init.rb
+version.rb
 lib/kyanite.rb
 lib/kyanite/array.rb
-lib/kyanite/array/array.rb
-lib/kyanite/array/array2.rb
-lib/kyanite/array/matrix2.rb
 lib/kyanite/array_of_enumerables.rb
 lib/kyanite/array_of_numerics.rb
 lib/kyanite/array_of_strings.rb
@@ -29,42 +27,28 @@ lib/kyanite/general/object.rb
 lib/kyanite/general/true_false.rb
 lib/kyanite/general/undoable.rb
 lib/kyanite/hash.rb
-lib/kyanite/hoe.rb
-lib/kyanite/matrix2.rb
 lib/kyanite/numeric.rb
 lib/kyanite/numeric/float.rb
 lib/kyanite/numeric/integer.rb
-lib/kyanite/numeric/numeric.rb
-lib/kyanite/operation.rb
-lib/kyanite/operation/call_tracker.rb
-lib/kyanite/operation/hoe.rb
-lib/kyanite/operation/rake.rb
-lib/kyanite/operation/regexp.rb
-lib/kyanite/operation/unit_test.rb
 lib/kyanite/optimizer.rb
-lib/kyanite/rake.rb
 lib/kyanite/range.rb
 lib/kyanite/set.rb
-lib/kyanite/smart_load_path.rb
 lib/kyanite/string.rb
 lib/kyanite/string/cast.rb
 lib/kyanite/string/chars.rb
 lib/kyanite/string/chars_const.rb
 lib/kyanite/string/diff.rb
-lib/kyanite/string/div.rb
 lib/kyanite/string/include.rb
 lib/kyanite/string/list.rb
-lib/kyanite/string/mgsub.rb
+lib/kyanite/string/misc.rb
 lib/kyanite/string/nested.rb
 lib/kyanite/string/random.rb
 lib/kyanite/string/split.rb
 lib/kyanite/symbol.rb
 lib/kyanite/tree.rb
 lib/kyanite/undoable.rb
-lib/kyanite/unit_test.rb
 test/_start_all.rb
 test/array/test_array.rb
-test/array/test_matrix2.rb
 test/enumerable/test_enumerable_enumerables.rb
 test/enumerable/test_enumerable_numerics.rb
 test/enumerable/test_enumerable_strings.rb
@@ -77,6 +61,7 @@ test/string/test_cast.rb
 test/string/test_chars.rb
 test/string/test_diff.rb
 test/string/test_list.rb
+test/string/test_misc.rb
 test/string/test_nested.rb
 test/string/test_split.rb
 test/test_dictionary.rb

data/README.rdoc

@@ -0,0 +1,44 @@
+= Kyanite
+http://bklippstein.github.com/kyanite/frames.html
+
+Welcome to Kyanite. It's a general toolbox like Facets or ActiveSupport.
+
+== Features
+[{String}] Support for special letters like german umlauts. Reduce UTF8 strings to ASCII or less. Compare Strings. Parse nested brackets. Database Helpers. 
+[{Class}] Tools for reflection. Convert {Class} <=> {String} <=> {Symbol}.
+[{Numeric} {Integer} {Float}] General tools.
+[{Range}] Invert selection of an Array or String.
+[{Array}] General tools. Mean values. Sum, product, parallel.
+[{Set}] General tools. New class {OrderedSet} as alternative to {SortedSet}.
+[{Hash} {Dictionary} {Tree::TreeNode Tree}] General tools.
+[{Optimizer}] Find objects with min or max score.
+[{Undoable}] Save and restore objects.
+[{Object} {CallerUtils}] Repeats a block until the time is up. Silence Ruby warnings. Deep copy. Examine the call stack.
+
+
+== Usage
+  require 'kyanite'              # require all
+  require 'kyanite/basics'       # require basic Kyanite behavior and features  
+  require 'kyanite/string'       # require all String related stuff
+  require 'kyanite/string/diff'  # require all String#diff related stuff
+  
+If you use {http://bklippstein.github.com/transparent_nil/frames.html transparent_nil}, require it first:
+  require 'transparent_nil'              
+  require 'kyanite'            
+  
+
+== More Info
+* *Documentation*: {http://bklippstein.github.com/kyanite/frames.html github.com/kyanite}
+* *Source* *code*: {https://github.com/bklippstein/kyanite github.com/bklippstein}
+* *License*: {http://creativecommons.org/licenses/by-sa/3.0/de/deed.en cc-by-sa Creative Commons Attribution-Share Alike 3.0 Germany}
+* *Autor*: {mailto:klippstein@klippstein.com Björn Klippstein}
+
+
+== Disclaimer
+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.

data/Rakefile.rb

@@ -1,16 +1,14 @@
 # ruby encoding: utf-8
+# ü
+require 'drumherum'
+smart_init
+require 'version' 
+require 'yard'
+require 'drumherum/rake'
+YARD::Rake::YardocTask.new
 
-projectname = File.dirname(__FILE__).split("/")[-1].strip   # Name des Projekt-Stammverzeichnisses
-require File.dirname(__FILE__) + "/lib/#{projectname}"      # Hauptdatei der Library
-
-require 'kyanite/hoe'
-Kyanite.projectname = projectname
-Kyanite.github_username = 'bklippstein'
-
-require 'rdoc/task'
-require 'kyanite/rake'
-
-
+Drumherum.github_username = 'bklippstein'
+require 'kyanite'
 
 
 #  ----------------------------------------------------------------------------------------------
@@ -18,84 +16,37 @@ require 'kyanite/rake'
 #  
 # http://nubyonrails.com/articles/tutorial-publishing-rubygems-with-hoe
 #
-$hoe = Hoe.spec Kyanite.projectname do 
+$hoe = Hoe.spec Drumherum.project_name do 
 
   # self.rubyforge_name = 'yourgemx' # if different than 'yourgem'
    
   developer('Bjoern Klippstein', 'klippstein@klippstein.com')
   summary               = 'General toolbox like Facets or ActiveSupport.'  
-  extra_deps            << ['transparent_nil', '>= 0.1.0']
+  extra_deps            << ['drumherum',  '>= 0.1.19']  
+  extra_deps            << ['transparent_nil', '>= 0.1.7']
   extra_deps            << ['activesupport',   '>= 3.2.8']
   extra_deps            << ['facets',          '>= 2.9.3']
   extra_deps            << ['rubytree',        '>= 0.8.3'] 
   remote_rdoc_dir = '' # Release to root only one project  
-  urls                  = [["http://#{Kyanite.github_username}.github.com/#{Kyanite.projectname}/"]]
-
+  urls                  = [[Drumherum.url_docs], [Drumherum.url_source]]
                     
 end
 
-# require 'pp'
-# pp $hoe
 
 
-  
-  
-  
 #  ----------------------------------------------------------------------------------------------
-#  Documentation
+#  Hide Tasks
 #  
-# http://rubeh.tumblr.com/post/27622544/rake-rdoctask-with-all-of-the-options-stubbed-out
-# http://www.java2s.com/Code/Ruby/Language-Basics/RDocoptionsareusedlikethisrdocoptionsnames.htm
-#   
-
-remove_task 'docs' 
+ 
+ hide_tasks [ :announce, :audit, :check_extra_deps, :clobber_docs, :clobber_package, :default ]
+ hide_tasks [ :dcov, :debug_email, :docs, :gem, :git_add, :git_commit, :git_push, :install_gem ]
+ hide_tasks [ :newb, :package, :post_blog, :publish_docs, :release, :release_sanity, :release_to_gemcutter ]
+ hide_tasks [ :repackage, :ridocs, :sleep_15, :sleep_5, :utf8, :yard, :yard_post ]
 
-desc "generate RDoc documentation"
-Rake::RDocTask.new(:docs) do |rd| 
 
-    rd.title    = "#{Kyanite.projectname.capitalize} #{Kyanite.projectname.to_class.const_get('VERSION')}"
-
-    rd.rdoc_dir = 'doc'   
-    rd.rdoc_files.include('lib/**/*.rb')
-    rd.rdoc_files.include('test/**/test_*.rb')
-    rd.rdoc_files.include('README.txt', 'License.txt', 'History.txt', 'Div')
-    
-    rd.rdoc_files.exclude('lib/kyanite/array/array2')
-    rd.rdoc_files.exclude('lib/kyanite/array/matrix2')
-    rd.rdoc_files.exclude('lib/kyanite/operation/call_tracker')
-
-    rd.options += [
-        '--tab-width', '4',
-        '--main', 'README.txt',
-        '--show-hash',        # A name of the form #name in a comment is a possible hyperlink to an instance method name. When displayed, the # is removed unless this option is specified.
-        '--line-numbers',
-        '--all',
-        '--charset=utf8'      
-      ]      
-      
-end
 
   
-#  ----------------------------------------------------------------------------------------------
-#  Local Tasks
-#  
-
-remove_task 'ridocs'
-remove_task 'rdoc' 
-remove_task 'audit' 
-remove_task 'dcov' 
-remove_task 'debug_email' 
-remove_task 'debug_gem' 
-remove_task 'deploy' 
-remove_task 'deps:email' 
-remove_task 'install_gem'
-remove_task 'multi' 
-remove_task 'newb' 
-#Dir['tasks/**/*.rake'].each { |t| load t }  
-  
   
-  
-
 
 
 

data/console.rb

@@ -2,8 +2,6 @@
 # File: script/console
 irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
 libs =  " -r irb/completion"
-libs <<  " -r #{File.dirname(__FILE__) + '/init.rb'}"
-
-puts "Welcome to Kyanite gem"
-
+initfile = File.join(File.dirname(__FILE__),  'init.rb' )  
+libs <<  " -r #{initfile}"
 exec "#{irb} #{libs} --simple-prompt --noreadline"

data/lib/kyanite.rb

@@ -1,25 +1,162 @@
 # ruby encoding: utf-8
-
+# ü
 # Required alle Kyanite-Libs
 # -- eine Auswahl der wichtigsten Kyanite-Libs required man mit 
 # require 'kyanite/basics'
 
+# @!macro [new] navigation
+#  {Object} {String} {Class} {Symbol} 
+#  {Integer} {Float} 
+#  {Range}
+#  {Array} 
+#  {Set} 
+#  {Dictionary} {Hash}
+#  {Tree::TreeNode Tree} {Optimizer} {Undoable} {CallerUtils}
+
+
+# @!macro [new] array
+#  === Array Additions
+#  [Kyanite definitions] {Array} 
+#  [Kyanite tests and examples] {TestKyaniteArray}    
+#  [Usage] +require 'kyanite/array'+
+
+
+# @!macro [new] dictionary
+#  === Dictionary Additions
+#  [Kyanite definitions] {Dictionary}, {Hash}
+#  [Kyanite tests and examples] {TestKyaniteDictionary}    
+#  [Base class] {http://rubydoc.info/github/rubyworks/hashery/master/Hashery/Dictionary +Hashery::Dictionary+} (A Dictionary is a Hash that preserves order.)
+#  [Usage] +require 'kyanite/dictionary'+
+#
+
+# @!macro [new] enum_of_enums
+#  === Enumeration Of Enumerations
+#  Two-dimensional enumerables or enumerables of objects, which are enumerable.
+#
+#  [Kyanite definitions] {EnumerableEnumerables} 
+#  [Kyanite class with module included] {ArrayOfEnumerables}
+#  [Kyanite tests and examples] {TestKyaniteEnumerableEnumerables}    
+#  [Usage] +require 'kyanite/enumerable/enumerable_enumerables'+ 
+#
+
+# @!macro [new] enum_of_numerics
+#  === Enumeration Of Numerics
+#  [Kyanite definitions] {EnumerableNumerics} 
+#  [Kyanite class with module included] {ArrayOfNumerics}
+#  [Kyanite tests and examples] {TestKyaniteEnumerableNumerics}    
+#  [Usage] +require 'kyanite/enumerable/enumerable_numerics'+
+#
+
+# @!macro [new] enum_of_strings
+#  === Enumeration Of Strings
+#  [Kyanite definitions] {EnumerableStrings} 
+#  [Kyanite class with module included] {ArrayOfStrings}
+#  [Kyanite tests and examples] {TestKyaniteEnumerableStrings}    
+#  [Usage] +require 'kyanite/enumerable/enumerable_strings'+
+#
+
+# @!macro [new] enumerable
+#  === Enumerable Additions
+#  [Kyanite definitions] {Enumerable} 
+#  [Kyanite tests and examples] {TestKyaniteEnumerableStructure}    
+#  [Usage] +require 'kyanite/enumerable/structure'+
 
-if $:.include?(File.dirname(__FILE__))  ||  $:.include?(File.expand_path(File.dirname(__FILE__)))
-  #puts 'Path schon aktuell'
-else
-  $:.unshift(File.dirname(__FILE__)) 
-end
+# @!macro [new] class_utils
+#  === Class Utils
+#  [Kyanite definitions] {Class}, {Symbol}, {String}
+#  [Kyanite tests and examples] {TestKyaniteClassutils}    
+#  [Usage] +require 'kyanite/general/classutils'+
+#
 
+# @!macro [new] hash
+#  === Hash Additions
+#  [Kyanite definitions] {Dictionary}, {Hash}
+#  [Kyanite tests and examples] {TestKyaniteHash}    
+#  [Usage] +require 'kyanite/hash'+  
+#
+# Note: If you define the method +==+ in any object, you have to define +hash+ as well.
+#
+# Note: Rubys +delete+ and +delete_if+ methods are working in-place, even if the name does not implicate that.
+# And they return the deleted value, not the hash.
+#
 
+# @!macro [new] numeric
+#  === Numeric Additions
+#  [Kyanite definitions] {Numeric} {Integer} {Float}
+#  [Kyanite tests and examples] {TestKyaniteNumeric} 
+#  [Usage] +require 'kyanite/numeric'+
+#
 
+# @!macro [new] optimizer
+#  === Optimizer 
+#  [Kyanite definitions] {Optimizer}
+#  [Kyanite tests and examples] {TestKyaniteOptimizer}  
+# 
+#  Selection of objects based on scores.
+#  Each object is written to the Optimizer by a +push+ command, together with it's score.
+#  +content_max+ and +content_min+ result the object with the highest / lowest score.
+#  The access to the second and third objects is possible by deleting objects with 
+#  +delete_max+ or +delete_min+.
 
-module Kyanite #:nodoc
+# @!macro [new] range
+#  === Range Additions
+#  [Kyanite definitions] {Range}
+#  [Kyanite tests and examples] {TestKyaniteRange}    
+#  [Usage] +require 'kyanite/range'+
 
-  VERSION  = '0.6.1'
-    
-end
-    
+# @!macro [new] set
+#  === Set Classes and Additions
+#  [Kyanite definitions] {Set}, {SortedSet}, {OrderedSet} 
+#  [Kyanite tests and examples] {TestKyaniteSet}  
+#  [Usage] +require 'kyanite/set'+
+#  === Differences between the set classes
+#  [{http://www.ruby-doc.org/stdlib-1.9.3/libdoc/set/rdoc/Set.html +Set+}] is unordered. Examples:  {TestKyaniteSet#test_set test_set}
+#  [{OrderedSet}] is ordered, it retains the original order, but it will not continually re-sorted -- as long you don't use {http://rubydoc.info/github/rubyworks/hashery/master/Hashery/Dictionary:order_by +Dictionary#order_by+}. Examples:  {TestKyaniteSet#test_ordered_set test_ordered_set}
+#  [{http://www.ruby-doc.org/stdlib-1.9.3/libdoc/set/rdoc/SortedSet.html +SortedSet+}] is ordered and sorted. It is always in order. Examples:  {TestKyaniteSet#test_sorted_set test_sorted_set}
+#
+
+# @!macro [new] string
+#  === String Additions
+#  [Kyanite definitions] {String} 
+#  [Kyanite tests and examples] {TestKyaniteStringCast Cast} {TestKyaniteStringChars Chars} {TestKyaniteStringDiff Diff} {TestKyaniteStringList Database-Helper} {TestKyaniteStringMisc Miscellaneous} {TestKyaniteStringNested Nested} {TestKyaniteStringSplit Split}     
+#  [Usage] +require 'kyanite/string'+
+#  === Required from {http://rubyworks.github.com/rubyfaux/?doc=http://rubyworks.github.com/facets/docs/facets-2.9.3/core.json#api-class-String Facets String}:  
+#  [+shatter(re)+] Breaks a string up into an array based on a regular expression. Similar to scan, but includes the matches.
+#
+
+
+# @!macro [new] tree
+#  === Rubytree Additions
+#  [Kyanite definitions] {Tree::TreeNode}
+#  [Kyanite tests and examples] {TestKyaniteTree}    
+#  [Base class] {http://rubytree.rubyforge.org +rubytree+}
+#  [Usage] +require 'kyanite/tree'+  
+
+# @!macro [new] object
+#  === Object Additions
+#  [Kyanite definitions] {Object}, {KKernel}
+#  [Kyanite tests and examples] {TestKyaniteObject}    
+#  [Usage] +require 'kyanite/basics'+  
+
+# @!macro [new] undoable 
+#  === Undoable Module
+#  [Kyanite definitions] {Undoable}
+#  [Kyanite tests and examples]    
+#  [Usage] +require 'kyanite/general/undoable'+  
+
+# @!macro [new] true_false
+#  === TrueClass & FalseClass
+#  [Kyanite definitions] {TrueClass} {FalseClass}
+#  [Kyanite tests and examples] {TestKyaniteTrueFalse}    
+#  [Usage] +require 'kyanite/general/true_false'+ 
+
+# @!macro [new] caller_utils
+#  === CallerUtils
+#  [Kyanite definitions] {CallerUtils} 
+#  [Kyanite tests and examples]  
+#  [Usage] +require 'kyanite/general/callerutils'+ 
+
+  require 'drumherum'
 
   require 'kyanite/array'
 # require 'kyanite/basics'            # Auswahl
@@ -27,9 +164,7 @@ end
   require 'kyanite/enumerable'       
   require 'kyanite/general'
   require 'kyanite/hash'
-# require 'kyanite/matrix2'           # ist schon in array
-  require 'kyanite/numeric'
-# require 'kyanite/operation'         # nur manuell   
+  require 'kyanite/numeric' 
   require 'kyanite/optimizer'
   require 'kyanite/range'
   require 'kyanite/set'
@@ -38,3 +173,5 @@ end
   require 'kyanite/tree'
 # require 'kyanite/unit_test'         # nur für Tests
 
+  Drumherum::loaded!
+