rsmaz 0.0.3 → 0.0.4

data/{History.txt → HISTORY}

@@ -1,3 +1,9 @@
+== 0.0.4 2011-03-26
+
+* Text forced to binary for a consistent Ruby 1.9 experience (Hongli Lai)
+* Dependency on hoe removed (Peter Cooper)
+* Switched from RSpec to MiniTest
+
 == 0.0.3 2009-04-02
 
 * Now produces same output as reference smaz implementation

data/README.rdoc

@@ -5,21 +5,23 @@
 
 == DESCRIPTION:
 
-  Short String Compression for Ruby.
+Short String Compression for Ruby.
 
-  RSmaz is a pure-Ruby port of the Smaz short string compression
-  algorithm by Salvatore Sanfilippo and released as a C library at:
-  http://github.com/antirez/smaz/tree/master
-  
-  I've done some initial cleanup of a pure Ruby->C port, but this
-  is not yet complete. It does pass the specs, however! Feel free
-  to clean it up as it's a bit memory inefficient right now... :)
+RSmaz is a pure-Ruby port of the Smaz short string compression
+algorithm by Salvatore Sanfilippo and released as a C library at:
+http://github.com/antirez/smaz/tree/master
+
+I've done some initial cleanup of a pure Ruby->C port, but this
+is not yet complete. It does pass the specs, however! Feel free
+to clean it up as it's a bit memory inefficient right now... :)
 
 == REQUIREMENTS:
 
-* RSpec (if you want to run the specs)
-* Some strings to compress
-* A sense of humor
+* MiniTest (in the Ruby 1.9 stdlib or `gem install minitest` on Ruby 1.8)
+
+== INSTALLATION:
+
+  gem install rsmaz
 
 == USAGE:
 
@@ -27,9 +29,19 @@
   r = RSmaz.compress("whatever")
   puts RSmaz.decompress(r)
 
+=== Ruby 1.9 and encodings
+
+RSmaz.compress always returns a string with the binary encoding. The
+input can be any encoding, it will internally force it to binary
+and compress byte-by-byte.
+
+RSmaz.decompress also always returns a string with the binary encoding.
+You must manually force the encoding back to the right one because
+RSmaz does not store information about the original encoding.
+
 == RSMAZ LICENSE:
 
-Copyright (c) 2009 Peter Cooper, Salvatore Sanfilippo
+Copyright (c) 2009-2011 Peter Cooper, Salvatore Sanfilippo, Hongli Lai
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,28 +1,9 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/rsmaz'
+%w[rubygems rake rake/testtask].each { |f| require f }
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('rsmaz', RSmaz::VERSION) do |p|
-  p.developer('Peter Cooper', 'pcooper@petercooper.co.uk')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = p.name # TODO this is default value
-  # p.extra_deps         = [
-  #   ['activesupport','>= 2.0.2'],
-  # ]
-  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.rsync_args = '-av --delete --ignore-errors'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
+task :default => :test

data/lib/rsmaz.rb

@@ -1,3 +1,4 @@
+# encoding: binary
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
@@ -86,11 +87,12 @@ module RSmaz
   " we", "ly", "ee", " n", "id", " cl", "ac", "il", "</", "rt", " wi", "div",
   "e, ", " it", "whi", " ma", "ge", "x", "e c", "men", ".com"]
   
-  # Compress a string to Smaz encoding
+  # Compress a string to Smaz encoding. On Ruby 1.9, the returned string
+  # has the binary encoding.
   def self.compress(input)
     verb = ""
     out = ""
-    input = input.dup
+    input = force_binary(input.dup)
     
     # This algorithm has been ported to Ruby from C and only
     # slightly Rubyized.. still a lonnnng way to go. Wanna give it a crack?
@@ -159,10 +161,13 @@ module RSmaz
     out
   end     
   
-  # Decompress a Smaz encoded string back to normal plain text
+  # Decompress a Smaz encoded string back to normal plain text.
+  # On Ruby 1.9, the returned string has the binary encoding. You
+  # must manually force the encoding back to the right one because
+  # RSmaz does not store information about the original encoding.
   def self.decompress(input)
     out = ""
-    s = StringScanner.new(input)
+    s = StringScanner.new(dup_and_force_binary(input))
     until s.eos?
       bv = s.get_byte.ord
       if (bv == 254) 
@@ -179,4 +184,23 @@ module RSmaz
     
     out
   end
+  
+  private
+    if ''.respond_to?(:encoding)
+      def self.force_binary(str)
+        str.force_encoding('binary')
+      end
+      
+      def self.dup_and_force_binary(str)
+        str.dup.force_encoding('binary')
+      end
+    else
+      def self.force_binary(str)
+        str
+      end
+      
+      def self.dup_and_force_binary(str)
+        str
+      end
+    end
 end

data/{spec/spec_helper.rb → test/test_helper.rb}

@@ -1,9 +1,9 @@
 begin
-  require 'spec'
+  require 'minitest/spec'
 rescue LoadError
   require 'rubygems'
-  gem 'rspec'
-  require 'spec'
+  gem 'minitest'
+  require 'minitest/spec'
 end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
@@ -11,4 +11,6 @@ require 'rsmaz'
 
 def memory_usage
   `ps -Orss #{Process.pid} | tail -1`.scan(/\d+/)[1].to_i rescue 0
-end
+end
+
+MiniTest::Unit.autorun

data/test/test_rsmaz.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper.rb')
+
+describe RSmaz do
+  
+  #before(:each) do
+  #  # Do some memory leak checking
+  #  puts "\nMemory used: #{memory_usage}K"
+  #end
+  #
+  #after(:each) do
+  #  puts "\nMemory used: #{memory_usage}K"
+  #end
+  
+  it "should compress 'the' to one byte" do
+    RSmaz.compress("the").length.must_equal 1
+  end
+  
+  it "should compress 'thex' to two bytes" do
+    RSmaz.compress("thex").length.must_equal 2
+  end
+  
+  it "should compress and decompress strings back to the same string" do
+    [
+      "This is a test.",
+      "This is a test",
+      "this is a test",
+      "Let's try a SlIgHtLy Funkie938R str1ng!?!?x",
+      "What about a long one?" * 100
+    ].each { |str| RSmaz.decompress(RSmaz.compress(str)).must_equal str }    
+  end
+  
+  it "should properly decode a reference compression (so the internal coding doesn't change)" do
+    RSmaz.decompress("\020\230`A\376o\f\026\030").must_equal "hello world"
+  end
+  
+  it "should compress to the same extent as the reference smaz implementation" do
+    RSmaz.compress("foobar").length.must_equal 4
+    RSmaz.compress("Nel mezzo del cammin di nostra vita, mi ritrovai in una selva oscura").length.must_equal 46
+  end
+  
+  it "should compress and decompress lots of random strings without issues" do
+    100.times do
+      str = (1..100).map { |a| (rand(26)+97).chr }.join
+      RSmaz.decompress(RSmaz.compress(str)).length.must_equal str.length
+    end
+  end
+
+  it "should compress and decompress lots of random strings without issues (again)" do
+    100.times do
+      str = (1..100).map { |a| (rand(26)+97).chr }.join
+      RSmaz.decompress(RSmaz.compress(str)).length.must_equal str.length
+    end
+  end
+  
+  if ''.respond_to?(:encoding)
+    # U+2603 = Unicode snowman
+    
+    it "should be able to compress strings with arbitrary encodings" do
+      RSmaz.decompress(RSmaz.compress("\u2603")).force_encoding('utf-8').must_equal "\u2603"
+    end
+    
+    it "should return binary strings upon compressing" do
+      RSmaz.compress("\u2603").encoding.must_equal Encoding.find('binary')
+    end
+    
+    it "should return binary strings upon decompressing" do
+      RSmaz.decompress(RSmaz.compress("\u2603")).encoding.must_equal Encoding.find('binary')
+    end
+  end
+end
+

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rsmaz
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors: 
 - Peter Cooper
@@ -9,83 +10,64 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-02 00:00:00 +01:00
+date: 2011-03-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
+        version: "0"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.0
-    version: 
-description: "Short String Compression for Ruby.  RSmaz is a pure-Ruby port of the Smaz short string compression algorithm by Salvatore Sanfilippo and released as a C library at: http://github.com/antirez/smaz/tree/master  I've done some initial cleanup of a pure Ruby->C port, but this is not yet complete. It does pass the specs, however! Feel free to clean it up as it's a bit memory inefficient right now... :)"
+  version_requirements: *id001
+description: "Short String Compression for Ruby. RSmaz is a pure-Ruby port of the Smaz short string compression algorithm by Salvatore Sanfilippo and released as a C library at: http://github.com/antirez/smaz/tree/master  I've done some initial cleanup of a pure Ruby->C port, but this is not yet complete. It does pass the specs, however! Feel free to clean it up as it's a bit memory inefficient right now... :)"
 email: 
-- pcooper@petercooper.co.uk
+- git@peterc.org
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
+- HISTORY
 - README.rdoc
 files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
-- README.rdoc
+- HISTORY
 - Rakefile
+- README.rdoc
+- test/test_helper.rb
+- test/test_rsmaz.rb
 - lib/rsmaz.rb
-- script/console
-- script/destroy
-- script/generate
-- spec/rsmaz_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- tasks/rspec.rake
 has_rdoc: true
-homepage: http://github.com/peterc/rsmaz/tree/master
+homepage: http://github.com/peterc/rsmaz
 licenses: []
 
-post_install_message: PostInstall.txt
-rdoc_options: 
-- --main
-- README.rdoc
+post_install_message: 
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: rsmaz
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Short String Compression for Ruby
 test_files: []
 

data/Manifest.txt

@@ -1,13 +0,0 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-lib/rsmaz.rb
-script/console
-script/destroy
-script/generate
-spec/rsmaz_spec.rb
-spec/spec.opts
-spec/spec_helper.rb
-tasks/rspec.rake

data/PostInstall.txt

@@ -1,6 +0,0 @@
-Code example:
-
-  require 'rsmaz'
-  RSmaz.decompress(RSmaz.compress("this is a test"))
-
-For more information on smaz in general, see http://github.com/antirez/smaz/tree/master

data/script/console

@@ -1,10 +0,0 @@
-#!/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/rsmaz.rb'}"
-puts "Loading rsmaz gem"
-exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +0,0 @@
-#!/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/generate

@@ -1,14 +0,0 @@
-#!/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/spec/rsmaz_spec.rb

@@ -1,56 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe RSmaz do
-  
-  before(:each) do
-    # Do some memory leak checking
-    puts "\nMemory used: #{memory_usage}K"
-  end
-  
-  after(:each) do
-    puts "\nMemory used: #{memory_usage}K"
-  end
-  
-  it "should compress 'the' to one byte" do
-    RSmaz.compress("the").length.should == 1
-  end
-  
-  it "should compress 'thex' to two bytes" do
-    RSmaz.compress("thex").length.should == 2
-  end
-  
-  it "should compress and decompress strings back to the same string" do
-    [
-      "This is a test.",
-      "This is a test",
-      "this is a test",
-      "Let's try a SlIgHtLy Funkie938R str1ng!?!?x",
-      "What about a long one?" * 100
-    ].each { |str| RSmaz.decompress(RSmaz.compress(str)).should == str }    
-  end
-  
-  it "should properly decode a reference compression (so the internal coding doesn't change)" do
-    RSmaz.decompress("\020\230`A\376o\f\026\030").should == "hello world"
-  end
-  
-  it "should compress to the same extent as the reference smaz implementation" do
-    RSmaz.compress("foobar").length.should == 4
-    RSmaz.compress("Nel mezzo del cammin di nostra vita, mi ritrovai in una selva oscura").length.should == 46
-  end
-  
-  it "should compress and decompress lots of random strings without issues" do
-    100.times do
-      str = (1..100).map { |a| (rand(26)+97).chr }.join
-      RSmaz.decompress(RSmaz.compress(str)).length.should == str.length
-    end
-  end
-
-  it "should compress and decompress lots of random strings without issues (again)" do
-    100.times do
-      str = (1..100).map { |a| (rand(26)+97).chr }.join
-      RSmaz.decompress(RSmaz.compress(str)).length.should == str.length
-    end
-  end
-  
-  
-end

data/spec/spec.opts

@@ -1 +0,0 @@
---colour

data/tasks/rspec.rake

@@ -1,21 +0,0 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems'
-  require 'spec'
-end
-begin
-  require 'spec/rake/spectask'
-rescue LoadError
-  puts <<-EOS
-To use rspec for testing you must install rspec gem:
-    gem install rspec
-EOS
-  exit(0)
-end
-
-desc "Run the specs under spec/models"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end