id_stuffer 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+id_stuffer*.gem

data/README.textile

@@ -0,0 +1,42 @@
+h1. IdStuffer
+
+A way to efficiently store ids (i.e., possibly sequential numbers > 0), well suited for params-ecoding.
+
+Note that the ids will be sorted and uniqued.
+
+h2. Examples
+
+<pre>
+> require 'id_stuffer'
+=> true
+> l = IdStuffer.stuff [1,2,3,4,5,6,7,10,11,12,15,16,17]
+=> "IdS1ulxye8j3x"
+> IdStuffer.unstuff(l)
+=> [1, 2, 3, 4, 5, 6, 7, 10, 11, 12, 15, 16, 17]
+</pre>
+
+It's efficiency depends on the ocurrence of 'runs':
+
+<pre>
+> IdStuffer.stuff [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15]
+=> "IdS1eh"
+> IdStuffer.stuff [1,2,3,4,5,6,7,10,11,12,15,16,17]
+=> "IdS1ulxye8j3x"
+> IdStuffer.stuff [1,4,7,10,13,16,19,22,25,26,29,31,35]
+=> "IdS14iltvlqc3t1ifhh1o8wnmf"
+</pre>
+
+h2. How it's done
+
+It's pretty simple, but you can find more infos in <a href="http://blog.metaminded.com/2011/02/08/how-to-efficiently-store-lists-of-ids-in-ruby/" target="_blank">our blog</a>.
+
+h2. License
+
+Copyright (c) 2010-2011 Peter Horn, <a href="http://www.provideal.net" target="_blank">Provideal GmbH</a>
+
+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.
+

data/id_stuffer.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "id_stuffer"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "a reasonable way to compress sequences of ids for parameter encoding"
+  s.email       = "info@provideal.net"
+  s.homepage    = "http://github.com/provideal/id_stuffer"
+  s.description = "a way to efficiently store ids (i.e., possibly sequential numbers > 0), well suited for params-ecoding. Note that the ids will be sorted and uniqued"
+  s.authors     = ['Peter Horn']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/id_stuffer.rb

@@ -0,0 +1,38 @@
+module IdStuffer
+
+  PREFIX = 'IdS'
+
+  # compress the list of ids as good as I could imagine ;)
+  # uses fancy base twisting
+  def self.stuff(list)
+    return PREFIX if list.length == 0
+    PREFIX.dup << (list.sort.uniq.map(&:to_i).inject([[-9,-9]]) do |l, c|
+      if l.last.last+1 == c
+        l.last[-1] = c
+        l
+      else
+        l << [c,c]
+      end
+    end.map do |r|
+      if r.first == r.last
+        r.first.to_s(8)
+      else
+        r.first.to_s(8) << "8" << r.last.to_s(8)
+      end
+    end[1..-1].join("9").to_i.to_s(36))
+  end
+
+  # inverse of compress_id_list
+  def self.unstuff(str)
+    return [] if !str or str.length==0 or str=='0' or str==PREFIX
+    raise "Corrupted id list. Starts w/o mandatory prefix" unless str.start_with?(PREFIX)
+    n = str[PREFIX.length..-1].to_i(36).to_s.split("9").map do |e|
+      p = e.split("8")
+      if p.length == 1 then p[0].to_i(8)
+      elsif p.length == 2 then (p[0].to_i(8)..p[1].to_i(8)).entries
+      else raise "Corrupted id list. Or a bug ;)"
+      end
+    end.flatten
+  end
+
+end

data/test/id_stuffer.rb

@@ -0,0 +1,59 @@
+require 'test/unit'
+require 'id_stuffer'
+
+class TestIdStuffer < Test::Unit::TestCase
+  def test_empty
+    l = []
+    c = IdStuffer.stuff(l)
+    ll = IdStuffer.unstuff(c)
+    assert_equal(l,ll)
+  end
+
+  def test_empty2
+    assert_equal(IdStuffer.unstuff(nil),[])
+    assert_equal(IdStuffer.unstuff(''),[])
+    assert_equal(IdStuffer.unstuff("0"),[])
+    assert_equal(IdStuffer.unstuff(IdStuffer::PREFIX),[])
+  end
+
+  def test_simple
+    l = [1,2,3,4,5,6,7]
+    c = IdStuffer.stuff(l)
+    ll = IdStuffer.unstuff(c)
+    assert_equal(l,ll)
+  end
+
+  def test_simple2
+    l = [1,12,23,34,45,56,67]
+    c = IdStuffer.stuff(l)
+    ll = IdStuffer.unstuff(c)
+    assert_equal(l,ll)
+  end
+
+  def test_random
+    max = 300
+    100.times do |i|
+      n = 10*(i+1)
+      l = (1..n).map{|i| 1+(max*rand()).to_i }.sort.uniq
+      c = IdStuffer.stuff(l)
+      ll = IdStuffer.unstuff(c)
+      assert_equal(l,ll)
+    end
+  end
+
+  def test_sort
+    l = [7,1,6,3,5,4]
+    c = IdStuffer.stuff(l)
+    ll = IdStuffer.unstuff(c)
+    assert_equal(l.sort,ll)
+  end
+
+  def test_uniq
+    l = [1,2,2,2,3,4,5,6,7,2,2,2,3,3,3,4,5]
+    c = IdStuffer.stuff(l)
+    ll = IdStuffer.unstuff(c)
+    assert_equal(l.sort.uniq,ll)
+  end
+
+
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: id_stuffer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Horn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-14 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: a way to efficiently store ids (i.e., possibly sequential numbers > 0), well suited for params-ecoding. Note that the ids will be sorted and uniqued
+email: info@provideal.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.textile
+- id_stuffer.gemspec
+- lib/id_stuffer.rb
+- test/id_stuffer.rb
+has_rdoc: true
+homepage: http://github.com/provideal/id_stuffer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: a reasonable way to compress sequences of ids for parameter encoding
+test_files: 
+- test/id_stuffer.rb