peterc-rsmaz 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.1 2009-04-02
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,6 @@
+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/README.rdoc

@@ -0,0 +1,69 @@
+= rsmaz
+
+* http://github.com/peterc/rsmaz/tree/master
+* http://github.com/antirez/smaz/tree/master (original C 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!
+
+== REQUIREMENTS:
+
+* RSpec (if you want to run the specs)
+* Some strings to compress
+* A sense of humor
+
+== INSTALL:
+
+* require 'rsmaz'
+  r = RSmaz.compress("whatever")
+  puts RSmaz.decompress(r)
+
+== LICENSE:
+
+Copyright (c) 2009 Peter Cooper, Salvatore Sanfilippo
+
+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:
+
+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,
+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.
+
+== SMAZ LICENSE:
+
+Copyright (c) 2006-2009, Salvatore Sanfilippo
+All rights reserved.
+ 
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+ 
+    * Redistributions of source code must retain the above copyright 
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright 
+      notice, this list of conditions and the following disclaimer in the 
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Smaz nor the names of its contributors may be 
+      used to endorse or promote products derived from this software without 
+      specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/rsmaz'
+
+# 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'
+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]

data/lib/rsmaz.rb

@@ -0,0 +1,164 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'strscan'
+
+# RSmaz is too small to bother splitting into separate files, so I'll be lazy..
+
+module RSmaz
+  VERSION = '0.0.1'
+  
+  # From http://github.com/antirez/smaz/blob/4b913924e15b7663ee0240af19cedfd266052aab/smaz.c
+  CODEBOOK = ["\002s,\266", "\003had\232\002leW", "\003on \216", "", "\001yS",
+  "\002ma\255\002li\227", "\003or \260", "", "\002ll\230\003s t\277",
+  "\004fromg\002mel", "", "\003its\332", "\001z\333", "\003ingF", "\001>\336",
+  "\001 \000\003   (\002nc\344", "\002nd=\003 on\312",
+  "\002ne\213\003hat\276\003re q", "", "\002ngT\003herz\004have\306\003s o\225",
+  "", "\003ionk\003s a\254\002ly\352", "\003hisL\003 inN\003 be\252", "",
+  "\003 fo\325\003 of \003 ha\311", "", "\002of\005",
+  "\003 co\241\002no\267\003 ma\370", "", "", "\003 cl\356\003enta\003 an7",
+  "\002ns\300\001\"e", "\003n t\217\002ntP\003s, \205",
+  "\002pe\320\003 we\351\002om\223", "\002on\037", "", "\002y G", "\003 wa\271",
+  "\003 re\321\002or*", "", "\002=\"\251\002ot\337", "\003forD\002ou[",
+  "\003 toR", "\003 th\r", "\003 it\366",
+  "\003but\261\002ra\202\003 wi\363\002</\361", "\003 wh\237", "\002  4",
+  "\003nd ?", "\002re!", "", "\003ng c", "",
+  "\003ly \307\003ass\323\001a\004\002rir", "", "", "", "\002se_", "\003of \"",
+  "\003div\364\002ros\003ere\240", "", "\002ta\310\001bZ\002si\324", "",
+  "\003and\a\002rs\335", "\002rt\362", "\002teE", "\003ati\316", "\002so\263",
+  "\002th\021", "\002tiJ\001c\034\003allp", "\003ate\345", "\002ss\246",
+  "\002stM", "", "\002><\346", "\002to\024", "\003arew", "\001d\030",
+  "\002tr\303", "", "\001\n1\003 a \222", "\003f tv\002veo", "\002un\340", "",
+  "\003e o\242", "\002a \243\002wa\326\001e\002", "\002ur\226\003e a\274",
+  "\002us\244\003\n\r\n\247", "\002ut\304\003e c\373", "\002we\221", "", "",
+  "\002wh\302", "\001f,", "", "", "", "\003d t\206", "", "", "\003th \343",
+  "\001g;", "", "", "\001\r9\003e s\265", "\003e t\234", "", "\003to Y",
+  "\003e\r\n\236", "\002d \036\001h\022", "", "\001,Q", "\002 a\031", "\002 b^",
+  "\002\r\n\025\002 cI", "\002 d\245", "\002 e\253", "\002 fh\001i\b\002e \v",
+  "", "\002 hU\001-\314", "\002 i8", "", "", "\002 l\315", "\002 m{",
+  "\002f :\002 n\354", "\002 o\035", "\002 p}\001.n\003\r\n\r\250", "",
+  "\002 r\275", "\002 s>", "\002 t\016", "", "\002g \235\005which+\003whi\367",
+  "\002 w5", "\001/\305", "\003as \214", "\003at \207", "", "\003who\331", "",
+  "\001l\026\002h \212", "", "\002, $", "", "\004withV", "", "", "", "\001m-", "",
+  "", "\002ac\357", "\002ad\350", "\003TheH", "", "", "\004this\233\001n\t",
+  "", "\002. y", "", "\002alX\003e, \365", "\003tio\215\002be\\",
+  "\002an\032\003ver\347", "", "\004that0\003tha\313\001o\006", "\003was2",
+  "\002arO", "\002as.", "\002at'\003the\001\004they\200\005there\322\005theird",
+  "\002ce\210", "\004were]", "", "\002ch\231\002l \264\001p<", "", "",
+  "\003one\256", "", "\003he \023\002dej", "\003ter\270", "\002cou", "",
+  "\002by\177\002di\201\002eax", "", "\002ec\327", "\002edB", "\002ee\353", "",
+  "", "\001r\f\002n )", "", "", "", "\002el\262", "", "\003in i\002en3", "",
+  "\002o `\001s\n", "", "\002er\033", "\003is t\002es6", "", "\002ge\371",
+  "\004.com\375", "\002fo\334\003our\330", "\003ch \301\001t\003", "\002hab", "",
+  "\003men\374", "", "\002he\020", "", "", "\001u&", "\002hif", "",
+  "\003not\204\002ic\203", "\003ed @\002id\355", "", "", "\002ho\273",
+  "\002r K\001vm", "", "", "", "\003t t\257\002il\360", "\002im\342",
+  "\003en \317\002in\017", "\002io\220", "\002s \027\001wA", "", "\003er |",
+  "\003es ~\002is%", "\002it/", "", "\002iv\272", "",
+  "\002t #\ahttp://C\001x\372", "\002la\211", "\001<\341", "\003, a\224"]
+  
+  # From http://github.com/antirez/smaz/blob/4b913924e15b7663ee0240af19cedfd266052aab/smaz.c
+  REVERSE_CODEBOOK = [" ", "the", "e", "t", "a", "of", "o", "and", "i", "n", "s", "e ", "r", " th",
+  " t", "in", "he", "th", "h", "he ", "to", "\r\n", "l", "s ", "d", " a", "an",
+  "er", "c", " o", "d ", "on", " of", "re", "of ", "t ", ", ", "is", "u", "at",
+  "   ", "n ", "or", "which", "f", "m", "as", "it", "that", "\n", "was", "en",
+  "  ", " w", "es", " an", " i", "\r", "f ", "g", "p", "nd", " s", "nd ", "ed ",
+  "w", "ed", "http://", "for", "te", "ing", "y ", "The", " c", "ti", "r ", "his",
+  "st", " in", "ar", "nt", ",", " to", "y", "ng", " h", "with", "le", "al", "to ",
+  "b", "ou", "be", "were", " b", "se", "o ", "ent", "ha", "ng ", "their", "\"",
+  "hi", "from", " f", "in ", "de", "ion", "me", "v", ".", "ve", "all", "re ",
+  "ri", "ro", "is ", "co", "f t", "are", "ea", ". ", "her", " m", "er ", " p",
+  "es ", "by", "they", "di", "ra", "ic", "not", "s, ", "d t", "at ", "ce", "la",
+  "h ", "ne", "as ", "tio", "on ", "n t", "io", "we", " a ", "om", ", a", "s o",
+  "ur", "li", "ll", "ch", "had", "this", "e t", "g ", "e\r\n", " wh", "ere",
+  " co", "e o", "a ", "us", " d", "ss", "\n\r\n", "\r\n\r", "=\"", " be", " e",
+  "s a", "ma", "one", "t t", "or ", "but", "el", "so", "l ", "e s", "s,", "no",
+  "ter", " wa", "iv", "ho", "e a", " r", "hat", "s t", "ns", "ch ", "wh", "tr",
+  "ut", "/", "have", "ly ", "ta", " ha", " on", "tha", "-", " l", "ati", "en ",
+  "pe", " re", "there", "ass", "si", " fo", "wa", "ec", "our", "who", "its", "z",
+  "fo", "rs", ">", "ot", "un", "<", "im", "th ", "nc", "ate", "><", "ver", "ad",
+  " 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
+  def self.compress(input)
+    h1, h2, h3 = 0
+    verb = ""
+    out = ""
+    
+    # This algorithm has been ported to Ruby from C and only
+    # slightly Rubyized.. still a lonnnng way to go. Wanna give it a crack?
+    while (input && input.length > 0)
+      h1 = h2 = input[0] << 3
+      h2 += input[1] if (input.length > 1)
+      h3 = h2 ^ input[2] if (input.length > 2)
+      q = []
+
+      [input.length, 7].min.downto(1) do |j2|
+        slot = if j2 == 1
+          CODEBOOK[h1 % 241]
+        elsif j2 == 2
+          CODEBOOK[h2 % 241] 
+        else
+          CODEBOOK[h3 % 241] 
+        end
+
+        while (slot && slot[0]) do
+          if (slot[0] == j2 && (slot[1,j2] == input[0,j2]))
+            # Match found in hash table
+            q << verb
+            verb = ""
+            q << slot[slot[0]+1]
+            input = input[j2..-1]
+          else
+            slot = slot[2..-1]
+          end
+        end
+      end
+      
+      # No queue? It means we matched nothing, so add the current byte to the verbatim buffer
+      if q.empty?
+        verb << input[0] #if input[0]
+        input = input[1..-1]
+      end
+
+      # If the verbatim buffer is getting too long or we're at the end of the doc
+      # throw the verbatim buffer to the output queue
+      q << verb if verb.length == 256 || (verb.length > 0 && input.length == 0)
+ 
+      out << q.collect do |item|
+        if item.class == String && item.length == 1
+          "\376" + item
+        elsif item.class == String && item.length > 1
+          "\377" + (item.length - 1).chr + item
+        elsif item.class == Fixnum
+          item.chr
+        end
+      end.join
+
+    end
+
+    out
+  end     
+  
+  # Decompress a Smaz encoded string back to normal plain text
+  def self.decompress(input)
+    out = ""
+    s = StringScanner.new(input)
+    until s.eos?
+      bv = s.get_byte[0]
+      if (bv == 254) 
+        out << s.get_byte
+      elsif (bv == 255)
+        len = s.get_byte[0] + 1
+        len.times do 
+          out << s.get_byte
+        end
+      else
+        out << REVERSE_CODEBOOK[bv]
+      end
+    end
+    
+    out
+  end
+end

data/script/console

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

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

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

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe RSmaz do
+  
+  it "should compress 'the' to one byte" do
+    RSmaz.compress("the").length.should == 1
+  end
+  
+  it "should compress 'thex' to three bytes" do
+    RSmaz.compress("thex").length.should == 3
+  end
+  
+  it "should compress and decompress strings to the same thing" 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
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rsmaz'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: peterc-rsmaz
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Cooper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  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!"
+email: 
+- pcooper@petercooper.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- 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
+has_rdoc: true
+homepage: http://github.com/peterc/rsmaz/tree/master
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rsmaz
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Short String Compression for Ruby
+test_files: []
+