Cleaned up GZip helper library (moved into CodeRay namespace, removed String extensions), improved FileType error message for ambiguous arguments.

3 files changed, 52 insertions, 244 deletions

diff --git a/lib/coderay/helpers/file_type.rb b/lib/coderay/helpers/file_type.rb
index ab3fe99..8b1a728 100644
--- a/lib/coderay/helpers/file_type.rb
+++ b/lib/coderay/helpers/file_type.rb
@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 module CodeRay
 
 # = FileType
@@ -50,7 +49,7 @@ module FileType
     # is returned.
     def fetch filename, default = nil, read_shebang = false
       if default and block_given?
-        warn 'block supersedes default value argument'
+        warn 'Block supersedes default value argument; use either.'
       end
 
       unless type = self[filename, read_shebang]
@@ -136,122 +135,3 @@ module FileType
 end
 
 end
-
-if $0 == __FILE__
-  $VERBOSE = true
-  eval DATA.read, nil, $0, __LINE__ + 4
-end
-
-__END__
-require 'test/unit'
-
-class FileTypeTests < Test::Unit::TestCase
-  
-  include CodeRay
-  
-  def test_fetch
-    assert_raise FileType::UnknownFileType do
-      FileType.fetch ''
-    end
-
-    assert_throws :not_found do
-      FileType.fetch '.' do
-        throw :not_found
-      end
-    end
-
-    assert_equal :default, FileType.fetch('c', :default)
-
-    stderr, fake_stderr = $stderr, Object.new
-    $err = ''
-    def fake_stderr.write x
-      $err << x
-    end
-    $stderr = fake_stderr
-    FileType.fetch('c', :default) { }
-    assert_equal "block supersedes default value argument\n", $err
-    $stderr = stderr
-  end
-
-  def test_ruby
-    assert_equal :ruby, FileType['test.rb']
-    assert_equal :ruby, FileType['test.java.rb']
-    assert_equal :java, FileType['test.rb.java']
-    assert_equal :ruby, FileType['C:\\Program Files\\x\\y\\c\\test.rbw']
-    assert_equal :ruby, FileType['/usr/bin/something/Rakefile']
-    assert_equal :ruby, FileType['~/myapp/gem/Rantfile']
-    assert_equal :ruby, FileType['./lib/tasks\repository.rake']
-    assert_not_equal :ruby, FileType['test_rb']
-    assert_not_equal :ruby, FileType['Makefile']
-    assert_not_equal :ruby, FileType['set.rb/set']
-    assert_not_equal :ruby, FileType['~/projects/blabla/rb']
-  end
-
-  def test_c
-    assert_equal :c, FileType['test.c']
-    assert_equal :c, FileType['C:\\Program Files\\x\\y\\c\\test.h']
-    assert_not_equal :c, FileType['test_c']
-    assert_not_equal :c, FileType['Makefile']
-    assert_not_equal :c, FileType['set.h/set']
-    assert_not_equal :c, FileType['~/projects/blabla/c']
-  end
-
-  def test_cpp
-    assert_equal :cpp, FileType['test.c++']
-    assert_equal :cpp, FileType['test.cxx']
-    assert_equal :cpp, FileType['test.hh']
-    assert_equal :cpp, FileType['test.hpp']
-    assert_equal :cpp, FileType['test.cu']
-    assert_equal :cpp, FileType['test.C']
-    assert_not_equal :cpp, FileType['test.c']
-    assert_not_equal :cpp, FileType['test.h']
-  end
-
-  def test_html
-    assert_equal :html, FileType['test.htm']
-    assert_equal :xhtml, FileType['test.xhtml']
-    assert_equal :xhtml, FileType['test.html.xhtml']
-    assert_equal :rhtml, FileType['_form.rhtml']
-    assert_equal :rhtml, FileType['_form.html.erb']
-  end
-
-  def test_yaml
-    assert_equal :yaml, FileType['test.yml']
-    assert_equal :yaml, FileType['test.yaml']
-    assert_equal :yaml, FileType['my.html.yaml']
-    assert_not_equal :yaml, FileType['YAML']
-  end
-
-  def test_pathname
-    require 'pathname'
-    pn = Pathname.new 'test.rb'
-    assert_equal :ruby, FileType[pn]
-    dir = Pathname.new '/etc/var/blubb'
-    assert_equal :ruby, FileType[dir + pn]
-    assert_equal :cpp, FileType[dir + 'test.cpp']
-  end
-
-  def test_no_shebang
-    dir = './test'
-    if File.directory? dir
-      Dir.chdir dir do
-        assert_equal :c, FileType['test.c']
-      end
-    end
-  end
-  
-  def test_shebang_empty_file
-    require 'tmpdir'
-    tmpfile = File.join(Dir.tmpdir, 'bla')
-    File.open(tmpfile, 'w') { }  # touch
-    assert_equal nil, FileType[tmpfile]
-  end
-  
-  def test_shebang
-    require 'tmpdir'
-    tmpfile = File.join(Dir.tmpdir, 'bla')
-    File.open(tmpfile, 'w') { |f| f.puts '#!/usr/bin/env ruby' }
-    assert_equal :ruby, FileType[tmpfile, true]
-  end
-
-end
diff --git a/lib/coderay/helpers/gzip.rb b/lib/coderay/helpers/gzip.rb
new file mode 100644
index 0000000..43f1000
--- /dev/null
+++ b/lib/coderay/helpers/gzip.rb
@@ -0,0 +1,51 @@
+module CodeRay
+
+# =GZip Simple
+#
+# A simplified interface to the gzip library +zlib+ (from the Ruby Standard Library.)
+#
+# Author: murphy (mail to murphy rubychan de)
+#
+# Version: 0.2 (2005.may.28)
+#
+# ==Documentation
+#
+# See +GZip+ module and the +String+ extensions.
+#
+module GZip
+
+  require 'zlib'
+
+  # The default zipping level. 7 zips good and fast.
+  DEFAULT_GZIP_LEVEL = 7
+
+  # Unzips the given string +s+.
+  #
+  # Example:
+  #   require 'gzip_simple'
+  #   print GZip.gunzip(File.read('adresses.gz'))
+  def GZip.gunzip s
+    Zlib::Inflate.inflate s
+  end
+
+  # Zips the given string +s+.
+  #
+  # Example:
+  #   require 'gzip_simple'
+  #   File.open('adresses.gz', 'w') do |file
+  #     file.write GZip.gzip('Mum: 0123 456 789', 9)
+  #   end
+  #
+  # If you provide a +level+, you can control how strong
+  # the string is compressed:
+  # - 0: no compression, only convert to gzip format
+  # - 1: compress fast
+  # - 7: compress more, but still fast (default)
+  # - 8: compress more, slower
+  # - 9: compress best, very slow
+  def GZip.gzip s, level = DEFAULT_GZIP_LEVEL
+    Zlib::Deflate.new(level).deflate s, Zlib::FINISH
+  end
+end
+
+end
diff --git a/lib/coderay/helpers/gzip_simple.rb b/lib/coderay/helpers/gzip_simple.rb
deleted file mode 100644
index b979f66..0000000
--- a/lib/coderay/helpers/gzip_simple.rb
+++ /dev/null
@@ -1,123 +0,0 @@
-# =GZip Simple
-#
-# A simplified interface to the gzip library +zlib+ (from the Ruby Standard Library.)
-#
-# Author: murphy (mail to murphy rubychan de)
-#
-# Version: 0.2 (2005.may.28)
-#
-# ==Documentation
-#
-# See +GZip+ module and the +String+ extensions.
-#
-module GZip
-
-  require 'zlib'
-
-  # The default zipping level. 7 zips good and fast.
-  DEFAULT_GZIP_LEVEL = 7
-
-  # Unzips the given string +s+.
-  #
-  # Example:
-  #   require 'gzip_simple'
-  #   print GZip.gunzip(File.read('adresses.gz'))
-  def GZip.gunzip s
-    Zlib::Inflate.inflate s
-  end
-
-  # Zips the given string +s+.
-  #
-  # Example:
-  #   require 'gzip_simple'
-  #   File.open('adresses.gz', 'w') do |file
-  #     file.write GZip.gzip('Mum: 0123 456 789', 9)
-  #   end
-  #
-  # If you provide a +level+, you can control how strong
-  # the string is compressed:
-  # - 0: no compression, only convert to gzip format
-  # - 1: compress fast
-  # - 7: compress more, but still fast (default)
-  # - 8: compress more, slower
-  # - 9: compress best, very slow
-  def GZip.gzip s, level = DEFAULT_GZIP_LEVEL
-    Zlib::Deflate.new(level).deflate s, Zlib::FINISH
-  end
-end
-
-
-# String extensions to use the GZip module.
-#
-# The methods gzip and gunzip provide an even more simple
-# interface to the ZLib:
-#
-#   # create a big string
-#   x = 'a' * 1000
-#   
-#   # zip it
-#   x_gz = x.gzip
-#   
-#   # test the result
-#   puts 'Zipped %d bytes to %d bytes.' % [x.size, x_gz.size]
-#   #-> Zipped 1000 bytes to 19 bytes.
-#   
-#   # unzipping works
-#   p x_gz.gunzip == x  #-> true
-class String
-  # Returns the string, unzipped.
-  # See GZip.gunzip
-  def gunzip
-    GZip.gunzip self
-  end
-  # Replaces the string with its unzipped value.
-  # See GZip.gunzip
-  def gunzip!
-    replace gunzip
-  end
-
-  # Returns the string, zipped.
-  # +level+ is the gzip compression level, see GZip.gzip.
-  def gzip level = GZip::DEFAULT_GZIP_LEVEL
-    GZip.gzip self, level
-  end
-  # Replaces the string with its zipped value.
-  # See GZip.gzip.
-  def gzip!(*args)
-    replace gzip(*args)
-  end
-end
-
-if $0 == __FILE__
-  eval DATA.read, nil, $0, __LINE__+4
-end
-
-__END__
-#CODE
-
-# Testing / Benchmark
-x = 'a' * 1000
-x_gz = x.gzip
-puts 'Zipped %d bytes to %d bytes.' % [x.size, x_gz.size]  #-> Zipped 1000 bytes to 19 bytes.
-p x_gz.gunzip == x  #-> true
-
-require 'benchmark'
-
-INFO = 'packed to %0.3f%%'  # :nodoc:
-
-x = Array.new(100000) { rand(255).chr + 'aaaaaaaaa' + rand(255).chr }.join
-Benchmark.bm(10) do |bm|
-  for level in 0..9
-    bm.report "zip #{level}" do
-      $x = x.gzip level
-    end
-    puts INFO % [100.0 * $x.size / x.size]
-  end
-  bm.report 'zip' do
-    $x = x.gzip
-  end
-  puts INFO % [100.0 * $x.size / x.size]
-  bm.report 'unzip' do
-    $x.gunzip
-  end
-end