perception 0.1.6 → 0.3.0

data/History.txt

@@ -1,8 +1,12 @@
 
-== 0.1.6 2008-12-10
+== 0.3.0 2012-10-08
+* now works with Ruby 1.9.x
+
+== 0.2.0 2008-12-10
+* improved documentation
 
+== 0.1.6 2008-12-10
 * first public release
 
 == 0.0.1 2008-08-01
-
 * Initial release

data/License.txt

@@ -1,16 +1,10 @@
-LICENSE: GNU General Public License (GPL)
-Autor: Bjoern Klippstein
 
-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:
+== License
+Creative Commons Attribution-Share Alike 3.0 Germany
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+(cc-by-sa) http://creativecommons.org/licenses/by-sa/3.0/de/deed.en
+
+AUTOR: Björn Klippstein
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

data/Manifest.txt

@@ -1,27 +1,24 @@
-lib/perception.rb
-lib/perception/const.rb
-lib/perception/date_and_time.rb
-lib/perception/logging.rb
-lib/perception/numeric.rb
-lib/perception/perception_main.rb
-lib/perception/perception_private.rb
-lib/perception/ppp.rb
-lib/perception/string_spread.rb
-lib/perception/test.rb
-History.txt
-init.rb
-License.txt
-Manifest.txt
-Rakefile.rb
-README.txt
-website/index.html
-website/index.txt
-website/javascripts/rounded_corners_lite.inc.js
-website/stylesheets/screen.css
-website/template.html.erb
-demo/demo_pp.rb
-demo/demo_zz.rb
-test/_start_all.rb
-test/test_date_and_time.rb
-test/test_numeric.rb
-test/test_ppp.rb
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile.rb
+demo/demo_pp.rb
+demo/demo_system_info.rb
+demo/demo_zz.rb
+init.rb
+lib/perception.rb
+lib/perception/const.rb
+lib/perception/date_and_time.rb
+lib/perception/logging.rb
+lib/perception/numeric.rb
+lib/perception/perception_main.rb
+lib/perception/perception_private.rb
+lib/perception/ppp.rb
+lib/perception/string_spread.rb
+profile.rb
+script/console.rb
+test/_start_all.rb
+test/test_date_and_time.rb
+test/test_numeric.rb
+test/test_ppp.rb

data/README.txt

@@ -1,55 +1,48 @@
-= Perception
+# ruby encoding: utf-8
 
-http://perception.rubyforge.org/
+= Perception - Readable Printouts For Logs And Console
 
-== DESCRIPTION:
+http://bklippstein.github.com/perception/
 
-Perception - Beautiful printouts for humans
 Perception is a intuitive toolkit for simple everyday debugging. 
 It offers a powerfull replacement for print, puts and pp. 
 
 You get auto-intended and structured output on your console without any configuration. 
-Perception also offers temporary printouts (overwritten by the next print), 
-printing two informations in one line without destroying the structure 
-and optionally slows down printing to readable speed, depending on the complexity of the output.
 
+Perception also offers temporary printouts (overwritten by the next print). So you can print
+two informations in one place without destroying the structure. 
 
-== FEATURES/PROBLEMS:
+Perception optionally slows down printing to readable speed, depending on the complexity of the output.
 
-* FIX (list of features or problems)
 
-== SYNOPSIS:
 
-  FIX (code sample of usage)
+== Usage
+  require 'perception'
+use +see+ instead of pp, puts, print.
+[] There are demos included. Run them.  
 
-== REQUIREMENTS:
 
-* FIX (list of requirements)
+== License
+cc-by-sa
 
-== INSTALL:
+Creative Commons Attribution-Share Alike 3.0 Germany
 
-* FIX (sudo gem install, anything else)
+http://creativecommons.org/licenses/by-sa/3.0/de/deed.en
 
-== LICENSE:
 
-GNU General Public License (GPL)
+== Homepage
+http://bklippstein.github.com/perception/
 
 
-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:
+== Author
+Björn Klippstein
 
-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,
+== 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.
+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,96 +1,102 @@
+# ruby encoding: utf-8
+# ü
+
+require 'kyanite/smart_load_path'
+smart_load_path  
+require 'kyanite/hoe'
+Kyanite.projectname = File.dirname(__FILE__).split("/")[-1].strip   # Name des Projekt-Stammverzeichnisses
+Kyanite.github_username = 'bklippstein'
+require 'rdoc/task'
+require 'kyanite/rake'
+
+require 'perception'
+
+# puts Kyanite.github_username
+# puts Kyanite.projectname
+# puts Hoe.class
 
 #  ----------------------------------------------------------------------------------------------
-#  NewGem
+#  Hoe
 #  
+# http://nubyonrails.com/articles/tutorial-publishing-rubygems-with-hoe
+#
+$hoe = Hoe.spec Kyanite.projectname do 
+
+  # self.rubyforge_name = 'yourgemx' # if different than 'yourgem'
+   
+  developer('Bjoern Klippstein', 'klippstein@klippstein.com')
+  summary               = 'Beautiful and readable printouts for console and logs.'  
+  extra_deps            << ['kyanite',    '>= 0.5.17']
+  extra_deps            << ['highline',   '>= 1.6.15']
+  remote_rdoc_dir = '' # Release to root only one project  
+  urls                  = [["http://#{Kyanite.github_username}.github.com/#{Kyanite.projectname}/"]]
+                              
+end
+
 
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/perception'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('perception', Perception::VERSION) do |p|
-
-  p.author                = 'Bjoern Klippstein' 
-  p.email                 = 'bjoernklippstein@gmail.com'
-  p.url                   = 'http://rapidrubyonrails.de' 
-  
-  p.rubyforge_name        = p.name    
-  p.summary               = 'Beautiful and readable printouts for console and logs.'  
-  p.changes               = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-
-  p.extra_deps            = [ ['kyanite',        '>= 0.3.1'] ]
-  p.extra_dev_deps        = [ ['newgem', ">= #{::Newgem::VERSION}"] ]
-  
-  p.clean_globs           |= %w[**/.DS_Store tmp *.log]
-  path                    = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  # p.remote_rdoc_dir       = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.remote_rdoc_dir       = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), '')
-  p.rsync_args            = '-av --delete --ignore-errors'
+
+#  ----------------------------------------------------------------------------------------------
+#  Documentation
+#  
+# 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' 
+
+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' )
+
+    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
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
+
+
 
 
 
 
 #  ----------------------------------------------------------------------------------------------
-#  Patch Hoe
+#  Local Tasks
 #  
 
-  # Task :release korrigieren
-  # no explicit version needed 
-  #
-  remove_task :release     
-  desc 'Package and upload the actual version to rubyforge.'
-  task :release => [:clean, :package] do |t|
-    pkg = "pkg/#{$hoe.name}-#{Perception::VERSION}"
-    rf = RubyForge.new.configure
-    puts "Logging in"
-    rf.login
-    c = rf.userconfig
-    c["release_notes"]    = $hoe.description    if $hoe.description
-    c["release_changes"]  = $hoe.changes        if $hoe.changes
-    c["preformatted"]     = true
-
-    files = ["#{pkg}.tgz", "#{pkg}.gem"].compact
-    puts "Releasing #{$hoe.name} #{Perception::VERSION}"
-    rf.add_release $hoe.rubyforge_name, $hoe.name, Perception::VERSION, *files
-  end
-
-
-
-# Task :publish_docs korrigieren
-#
-remove_task :publish_docs   
-desc 'Publish RDoc to RubyForge.'
-task :publish_docs => [:clean, :docs] do
-#task :publish_docs do
-  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "#{config["username"]}@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/#{$hoe.rubyforge_name}"
-  local_dir = 'doc'
-  sh %{rsync #{$hoe.rsync_args} #{local_dir}/ #{host}:#{remote_dir}}
-end
+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 }  
+
+
+
 
 
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
 
 
 
-#  ----------------------------------------------------------------------------------------------
-#  Kyanite
-#  
 
-$rake_tasks_ausblenden = %w{ bundles:tm deps:email deps:fetch deps:list manifest manifest:refresh
-                             announce clobber clobber_docs clobber_package clobber_rdoc
-                             config_hoe deploy 
-                             install_gem_no_doc 
-                             local_deploy package post_blog post_news ridocs test_deps 
-                             clobber_docs clobber_rdoc rdoc redocs rerdoc}
-require 'kyanite/rake'
 
 
 
@@ -98,29 +104,6 @@ require 'kyanite/rake'
 
 
 
-#  ----------------------------------------------------------------------------------------------
-#  Documentation
-#  
-# http://github.com/mislav/hanna/tree/master
-
-# instead of 'rake/rdoctask':
-require 'hanna/rdoctask'
-
-desc 'Generate RDoc documentation for Perception'
-Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_dir = 'doc'
-    rdoc.title    = "Perception - #{$hoe.summary}"
-    rdoc.rdoc_files.include('README.txt', 'License.txt')
-    rdoc.rdoc_files.include('lib/**/*.rb')
-    rdoc.rdoc_files.include('test/**/test_*.rb')
-    #rdoc.rdoc_files.exclude('lib/perception/array/array2')
-
-    rdoc.options += [
-        '-SNap',
-        '-w4',
-        '--charset=utf8',
-      ]
-end
 
 
 

data/demo/demo_pp.rb

@@ -1,4 +1,5 @@
-
+# ruby encoding: utf-8
+# ü
 if $0 == __FILE__ 
   require File.join(File.dirname(__FILE__), '..', 'lib', 'perception' )  
 else
@@ -29,7 +30,7 @@ module Perception #:nodoc
         see "=================="
       end
       see
-      #wait_for_key('Press any key to start')
+      # wait_for_key('Press any key to start')
       
       
     end # def
@@ -107,7 +108,7 @@ module Perception #:nodoc
 
 
     def demo_see_pp_dictionary
-      require 'facets/dictionary'
+      require 'hashery' # old: 'facets/dictionary'
         
       @dictionary = Dictionary.new  
       @dictionary[:a_dictionary] =    true
@@ -132,10 +133,10 @@ module Perception #:nodoc
       Perception::DemoSee.new('PrettyPrint Array').demo_see_pp_array     
       Perception::DemoSee.new('PrettyPrint Object').demo_see_pp_object  
       Perception::DemoSee.new('PrettyPrint Hash').demo_see_pp_hash       
-      #Perception::DemoSee.new('PrettyPrint Dictionary').demo_see_pp_dictionary      
+      Perception::DemoSee.new('PrettyPrint Dictionary').demo_see_pp_dictionary      
 
       
-      #Perception::DemoSee.new('PrettyPrint div').demo_see_basic_types  
+      Perception::DemoSee.new('PrettyPrint div').demo_see_basic_types  
  
     end
 

data/demo/demo_system_info.rb

@@ -0,0 +1,28 @@
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require File.join(File.dirname(__FILE__), '..', 'lib', 'perception' )  
+else
+  require 'perception'
+end
+
+require 'rbconfig'
+seee.out << :log
+see Config::CONFIG 
+see
+see
+see "------------------------------------------------------"
+
+# require 'awesome_print'
+# ap Config::CONFIG 
+
+
+
+
+ 
+
+
+
+
+
+  

data/demo/demo_zz.rb

@@ -1,4 +1,5 @@
-
+# ruby encoding: utf-8
+# ü
 if $0 == __FILE__ 
   require File.join(File.dirname(__FILE__), '..', 'lib', 'perception' )  
 else

data/lib/perception/const.rb

@@ -1,5 +1,10 @@
-
-require File.join(File.dirname(__FILE__), '..', 'perception' )  if $0 == __FILE__ 
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
 
 module Perception #:nodoc
 

data/lib/perception/date_and_time.rb

@@ -1,5 +1,10 @@
-
-require File.join(File.dirname(__FILE__), '..', 'perception' )  if $0 == __FILE__ 
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
 
 
 module Perception #:nodoc

data/lib/perception/logging.rb

@@ -1,5 +1,10 @@
-
-require File.join(File.dirname(__FILE__), '..', 'perception' )  if $0 == __FILE__ 
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
 
 
 module Perception #:nodoc

data/lib/perception/numeric.rb

@@ -1,5 +1,12 @@
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
+
 
-require File.join(File.dirname(__FILE__), '..', 'perception' )  if $0 == __FILE__ 
 
 module Perception #:nodoc
 

data/lib/perception/perception_main.rb

@@ -1,5 +1,10 @@
-
-require File.join(File.dirname(__FILE__), '..', 'perception' )  if $0 == __FILE__ 
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
 
 require 'kyanite/array/array'
 require 'kyanite/enumerable/structure'   # Methode contentclass

data/lib/perception/perception_private.rb

@@ -1,5 +1,13 @@
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
+
+
 
-require File.join(File.dirname(__FILE__), '..', 'perception' )  if $0 == __FILE__ 
 
 module Perception #:nodoc
 

data/lib/perception/ppp.rb

@@ -1,5 +1,12 @@
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
+
 
-require File.join(File.dirname(__FILE__), '..', 'perception' )  if $0 == __FILE__ 
 
 class PPP < PP
 
@@ -320,13 +327,13 @@ class PPP < PP
 end # class
 
 
-class String
+class String # :nodoc:
   def pretty_print(q)
     q.text "'#{self}'"
   end
 end
 
-class Set
+class Set # :nodoc:
   def pretty_print(q)
     q.group(1, '{', '}') {
       q.seplist(self) {|v|
@@ -341,7 +348,7 @@ class Set
 end
 
 
-class Dictionary
+class Dictionary # :nodoc:
   def inspect
     ary = []
     each {|k,v| ary << k.inspect + "=>" + v.inspect}
@@ -350,7 +357,7 @@ class Dictionary
 end
 
 
-class Dictionary
+class Dictionary # :nodoc:
   def pretty_print(q)
     q.pp_hash self
   end

data/lib/perception/string_spread.rb

@@ -1,5 +1,10 @@
-
-require 'perception'      if $0 == __FILE__ 
+# ruby encoding: utf-8
+# ü
+if $0 == __FILE__ 
+  require 'kyanite/smart_load_path'
+  smart_load_path   
+  require 'perception'
+end
 require 'kyanite/array_of_enumerables'
 
 

data/lib/perception.rb

@@ -1,21 +1,18 @@
-
+# ruby encoding: utf-8
+# ü
 if $:.include?(File.dirname(__FILE__))  ||  $:.include?(File.expand_path(File.dirname(__FILE__)))
-  # puts 'Path schon aktuell'
+  #puts 'Path schon aktuell'
 else
   $:.unshift(File.dirname(__FILE__)) 
 end
 
 
-# Die Versionsnummer steht ausserdem 
-#   * im Script '2_rake_install_gem.bat'
-#   * ggf. in der gem-Verkn�pfung
-module Perception
-  VERSION = '0.1.6'
-end
 
+module Perception #:nodoc
+  VERSION = '0.3.0'
+end
 
 
-$KCODE = 'UTF8'
 require 'pp'
 require 'set'
 require 'kyanite/string/mgsub'
@@ -28,7 +25,7 @@ require 'perception/const'
 require 'perception/perception_private'        
 require 'perception/perception_main'   
 require 'perception/ppp' 
-require 'perception/test' 
+#require 'perception/test' 
 require 'perception/string_spread' 
 require 'perception/numeric' 
 require 'perception/date_and_time'