knut_tools 0.1.0

data/lib/knut_tools/rake/testtask.rb

@@ -0,0 +1,67 @@
+=begin rdoc
+Modify Rake::TestTask to allow tests in different directories.
+
+This may be necessary, if you have to test, if files are created correct.
+
+Details see Rake::TestTask
+=end
+
+#~ gem 'rake', '=0.8.7'
+#~ gem 'rake', '>= 0.8.7'
+#~ gem 'rake', '=0.8'
+
+require 'rake/testtask.rb'
+module Rake
+=begin rdoc
+Modify Rake::TestTask to allow tests in different directories.
+
+This may be necessary, if you have to test, if files are created correct.
+
+Example:
+  Rake::TestTask.new(:test_ok) do |t|
+      t.dir = $testdir
+      t.test_files = $testfile
+      t.verbose = true
+  end
+$testfile must be located relative to $testdir.
+=end
+  class TestTask
+    # Directory to find and start the tests.
+    attr_accessor :dir
+=begin rdoc    
+Create the tasks defined by this task lib.
+
+Redefined to run the tests from another directory.
+The original definition was rake version 0.8.7.
+
+=end
+    def define
+      lib_path = @libs.join(File::PATH_SEPARATOR)
+      desc "Run tests" + (@name==:test ? "" : " for #{@name}")
+      task @name do
+        run_code = ''
+        RakeFileUtils.verbose(@verbose) do
+          run_code =
+            case @loader
+            when :direct
+              "-e 'ARGV.each{|f| load f}'"
+            when :testrb
+              "-S testrb #{fix}"
+            when :rake
+              rake_loader
+            end
+          @ruby_opts.unshift( "-I\"#{lib_path}\"" )
+          @ruby_opts.unshift( "-w" ) if @warning
+          #Change to directory if requested.
+          Dir.chdir(@dir ? @dir : '.'){  # ##add knut##
+            ruby @ruby_opts.join(" ") +
+              " \"#{run_code}\" " +
+              file_list.collect { |fn| "\"#{fn}\"" }.join(' ') +
+              " #{option_list}"
+            } # ##add knut##
+          end
+      end
+      self
+    end
+  end #TestTask
+end

data/lib/knut_tools/required_what.rb

@@ -0,0 +1,78 @@
+=begin rdoc
+Redefine require to get a list with all expanded filenames 
+of the required features.
+
+In ruby standard, $LOADED_FEATURES ($") is 
+an array containing the filenames of modules loaded by require.
+
+This script fills also $LOADED_FEATURES_FULL with the full pathes of 
+modules loaded by require.
+
+$LOADED_FEATURES_WARN contains warnings with conflicts.
+
+=Example
+Just imagine you have strange errors when you use singleton.
+You call "require 'singleton'", but no Singleton is defined.
+
+Ok, the problem may be easy, there is anywhere a 'singleton.rb' - but where?
+
+Just add 'knut_tools/required_what' before you load your package,
+then analyse $LOADED_FEATURES_FULL and $LOADED_FEATURES_WARN:
+
+  require 'knut_tools/required_what'
+  require 'singleton'
+
+  puts $LOADED_FEATURES_FULL  #The loaded gems with full path
+  puts $LOADED_FEATURES_WARN  #Possible name conflicts
+
+In $LOADED_FEATURES_FULL you see, whats loaded really, not what you expected.
+$LOADED_FEATURES_WARN contains a list with warnings.
+=end
+
+=begin rdoc
+An 'expanded $LOADED_FEATURES ($")'.
+Contains all loaded features, but with the complete path.
+=end
+$LOADED_FEATURES_FULL = []
+
+=begin rdoc
+Collects all warnings about loading conflicts.
+=end
+$LOADED_FEATURES_WARN = []
+
+
+=begin rdoc
+Store require to use it in the redefinition.
+=end
+alias :old_require :require
+
+=begin rdoc
+Redefine require, to get an 'expanded $"' ($LOADED_FEATURES_FULL)
+All loaded features, but with the complete path.
+
+If there is a name conflict between the files you load, 
+a warning is collected in 
+=end
+def require( package )
+  #make the original require and return if there was a failure.
+  return false unless old_require package
+  loaded = $LOADED_FEATURES.last #get the filename of the last load
+  found = []        #help variable to collect possible file pathes.
+  #loop on search pathes
+  $LOAD_PATH.each{|searchpath|  
+    #Check if the last load is found in the search path
+    found << "#{searchpath}/#{loaded}" if File.exist?( "#{searchpath}/#{loaded}")
+  }
+
+  #Store the path of the loaded feature
+  $LOADED_FEATURES_FULL << found.first 
+  case found.size
+  when 0  #May not happen.
+    $LOADED_FEATURES_WARN << "require: loaded #{loaded}, but don't know from where"
+  when 1  #Everything ok.
+  else
+    $LOADED_FEATURES_WARN << "Filename conflict in require: #{loaded}: #{found.inspect}"
+  end #found.size
+
+  true  #return result of old_require
+end

data/lib/knut_tools/yaml.rb

@@ -0,0 +1,131 @@
+=begin rdoc
+Extend YAML with some features:
+* YAML.load_with_warning Warn if a hash with double key is loaded.
+* Hash#to_yaml Sorted output 
+=end
+
+
+require 'yaml'
+
+=begin rdoc
+Extend YAML with some features:
+* YAML.load_with_warning Warn if a hash with double key is loaded.
+* Hash#to_yaml Sorted output 
+=end
+module YAML
+=begin rdoc
+Load, but warn, if a Hash key was added before.
+
+Works only on first level of hashs.
+
+See http://forum.ruby-portal.de/viewtopic.php?f=19&t=9862
+=end 
+  def self.load_with_warning( data )
+    keys = []
+    doc = parse(data)
+    doc.value.each {|key, value|
+      puts "!YAML.load: Double Hash-key: #{key.value}" if keys.include?(key.value)
+      keys << key.value
+    }
+    doc.transform
+  end
+end #YAML
+
+=begin rdoc
+Modify Hash, so to_yaml will output sorted by key
+=end
+class Hash 
+
+=begin rdoc
+Unfortenatly the option
+		:SortKeys	=>	true
+isn't supported in yaml-original.
+
+This extension adds this feature. 
+Default is sorted, you may set it off.
+
+If the keys may not be sorted "natural", 
+all keys are converted to Strings and the sorted.
+Mixtures of numbers and Strings will result in
+character sorted values ('10' will be before 2).
+
+If the keys can't be sorted (e.g. symbols...),
+the result keeps unsorted.
+
+Source: http://groups.google.de/group/comp.lang.ruby/browse_thread/thread/813cd7086e37f004/3057ffb1ebd96a8d
+=end
+   def to_yaml( emitter = {} )
+=begin
+opt is a #<YAML::Syck::Emitter:0x2c182a0>
+
+I don't know how to get access to the ":SortKeys => true"-value correct.
+=end
+
+    #~ opts = emitter
+    #~ case emitter
+      #~ when YAML::Syck::Emitter
+        #~ opts = emitter.instance_variable_get('@options')
+    #~ end
+    
+     YAML::quick_emit( object_id, emitter ) do |out| 
+       out.map( taguri, to_yaml_style ) do |map| 
+        #~ if opts[:SortKeys] ## fails in nesting, so let's just always sort 
+           sorted_keys = keys 
+           sorted_keys = begin 
+             sorted_keys.sort 
+           rescue 
+             sorted_keys.sort_by {|k| k.to_s} rescue sorted_keys 
+           end 
+
+           sorted_keys.each do |k| 
+             map.add( k, fetch(k) ) 
+           end 
+        #~ else 
+          #~ each do |k, v| 
+            #~ map.add( k, v ) 
+          #~ end 
+        #~ end 
+       end 
+     end 
+   end 
+end
+
+if __FILE__ == $0
+  
+def test( txt  )
+	puts '>>>>>>>>>>>>>>'
+	puts "in:\t#{txt.inspect}"
+	y = YAML.load( txt )
+	puts "out:\t#{y.inspect}"
+	puts "yaml:\t#{y.to_yaml.inspect}"
+	puts y.to_yaml()
+	puts y.to_yaml( :SortKey => true  )
+	puts y.to_yaml( :SortKey => false  )
+	puts '<<<<<<<<<<<<<<'
+end
+
+test( <<beispiel
+-
+ key2: aaa
+ key1: bbb
+beispiel
+)
+
+test( %q|
+2: zwei
+1: eins
+|
+)
+
+#~ test( <<beispiel
+#~ -
+ #~ key: <<
+#~ aaa
+#~ <<
+ #~ key2: <<
+#~ bbb
+#~ <<
+#~ beispiel
+#~ )
+
+end	#if __FILE__ == $0

data/readme.html

@@ -0,0 +1,63 @@
+<!--
+
+	Build by	C:/Program Files/ruby/lib/ruby/gems/1.8/gems/docgenerator-1.2.0/lib/docgenerator/document.rb
+	Dir:		C:/usr/Script/knut_tools
+	Creator:	rakefile_knut_tools.rb
+	Target:		readme.html
+	2010/04/01 10:07:31
+	
+	Generation-Info-End
+-->
+<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head ></head>
+<body ><h1 >Handling stdout and stderr</h1>
+<h2 >knut_tools/catch_output.rb</h2>
+<p >
+Defines a function to catch outputs on stdout and stderr.  
+</p>
+<h2 >knut_tools/rake/testtask.rb</h2>
+<p >
+Extends rake/testtask to run test in selected directory. This may be necessary, if you have to test, if files are created correct. Rake::TestTask to allow tests in different directories.  
+</p>
+<p >
+Example:  
+</p>
+<pre>
+  Rake::TestTask.new(:test_ok) do |t|
+      t.dir = $testdir
+      t.test_files = $testfile
+      t.verbose = true
+  end
+</pre>
+<p >
+$testfile must be located relative to $testdir.  
+</p>
+<h2 >knut_tools/rake/gempacker.rb</h2>
+<p >
+Defines some task for gem administration.  
+</p>
+<ul >
+<li > gem  </li>
+<li > install  </li>
+<li > test  </li>
+<li > push  </li>
+<li > ...  </li>
+</ul>
+<h2 >knut_tools/yaml.rb</h2>
+<p >
+Add yaml-related feature:  
+</p>
+<ul >
+<li > sorted to_yaml for Hash with :SortKeys &rArr; true  </li>
+<li > YAML.load_with_warning warns you about double Hash-keys.  </li>
+</ul>
+<h2 >knut_tools/file_winlink.rb</h2>
+<p >
+provides method to create Winlinks:  
+</p>
+<pre>
+  mk_link( target, linkname )
+</pre>
+</body>
+</html>

data/readme.txt

@@ -0,0 +1,47 @@
+
+
+Handling stdout and stderr
+    ------------------------------
+
+knut_tools/catch_output.rb
+      ------------------------------
+
+Defines a function to catch outputs on stdout and stderr.  
+
+knut_tools/rake/testtask.rb
+      ------------------------------
+
+Extends rake/testtask to run test in selected directory. This may be necessary, if you have to test, if files are created correct. Rake::TestTask to allow tests in different directories.  
+
+Example:  
+  Rake::TestTask.new(:test_ok) do |t|
+      t.dir = $testdir
+      t.test_files = $testfile
+      t.verbose = true
+  end
+
+$testfile must be located relative to $testdir.  
+
+knut_tools/rake/gempacker.rb
+      ------------------------------
+
+Defines some task for gem administration.  
+-  gem  
+-  install  
+-  test  
+-  push  
+-  ...  
+
+knut_tools/yaml.rb
+      ------------------------------
+
+Add yaml-related feature:  
+-  sorted to_yaml for Hash with :SortKeys => true  
+-  YAML.load_with_warning warns you about double Hash-keys.  
+
+knut_tools/file_winlink.rb
+      ------------------------------
+
+provides method to create Winlinks:  
+  mk_link( target, linkname )
+

data/unittest/test_file__END__.rb

@@ -0,0 +1,77 @@
+
+$:.unshift('../lib') if $0 == __FILE__
+
+require 'test/unit'
+#~ require "more_unit_test/assert_equal_filecontent.rb"
+
+require 'knut_tools/file__END__.rb'
+
+#~ $expected = File.dirname(__FILE__) + '/tmp_expected'
+#~ $folder_for_failure  = File.dirname(__FILE__) + '/tmp_failure'
+
+
+class Test_file__END__ < Test::Unit::TestCase
+  #Check behaviour with unexisting files.
+  def test_exceptions()
+    assert_equal(true, File.exist?('testdata/hello_world.rb'))  #check testdata
+    assert_raise(Errno::ENOENT){ File.open_after_END('not_found.rb') }    
+    assert_raise(Errno::ENOENT){ File.readlines_after_END('not_found.rb') }    
+  end
+  
+  def test_open_after_END()
+    filehandle = File.open_after_END('testdata/hello_world.rb')
+    assert_equal(false, filehandle.closed? )
+    assert_equal(7, filehandle.lineno )
+    assert_equal(false, filehandle.eof? )
+    assert_equal('This is a litte Hello World script.', filehandle.readline )
+    assert_equal(8, filehandle.lineno )
+    assert_equal(true, filehandle.eof? )
+    assert_equal(false, filehandle.closed? )
+    
+    #Close the file handle
+    assert_nothing_raised{filehandle.close}
+    assert_equal(true, filehandle.closed? )
+    assert_raise(IOError){filehandle.close}
+  end
+
+  def test_open_after_END_block()
+    assert_equal(nil, defined? filehandle )
+    File.open_after_END('testdata/hello_world.rb'){|filehandle|
+      assert_includes(["local-variable(in-block)", "local-variable"], defined? filehandle )
+      #~ assert_equal("local-variable(in-block)", defined? filehandle ) #Only ruby 1.8
+      assert_kind_of(File, filehandle )
+      
+      assert_equal(false, filehandle.closed? )
+      assert_equal(7, filehandle.lineno )
+      assert_equal(false, filehandle.eof? )
+      assert_equal('This is a litte Hello World script.', filehandle.readline )
+      assert_equal(8, filehandle.lineno )
+      assert_equal(true, filehandle.eof? )
+      assert_equal(false, filehandle.closed? )
+    }
+    assert_equal(nil, defined? filehandle )
+  end
+
+  def test_each_line_after_END_block()
+    assert_equal(nil, defined? line )
+    File.each_line_after_END('testdata/hello_world.rb'){|line|
+      #~ assert_equal("local-variable(in-block)", defined? line ) #Only ruby 1.8
+      assert_includes(["local-variable(in-block)", "local-variable"], defined? line ) #Ruby 1.8/1.9
+      assert_kind_of(String, line )      
+      assert_equal('This is a litte Hello World script.', line )
+    }
+    assert_equal(nil, defined? line )
+  end
+
+  def test_each_line_after_END()
+    assert_equal(nil, defined? line )
+    res = File.each_line_after_END('testdata/hello_world.rb')
+    assert_kind_of(Array, res )      
+    assert_equal(['This is a litte Hello World script.'], res )
+  end
+
+  def test_txt_after_END()
+    assert_equal("This is a litte Hello World script.", File.readlines_after_END('testdata/hello_world.rb') )
+  end
+end #Test_knut_tools
+