noid 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Beer
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= noid
+
+Ruby implementation of NOID (Nice Opaque Identifier)
+
+== Contributing to noid
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Chris Beer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "noid"
+  gem.homepage = "http://github.com/cbeer/noid"
+  gem.license = "MIT"
+  gem.summary = %Q{Nice Opaque Identifier}
+  gem.description = %Q{}
+  gem.email = "chris@cbeer.info"
+  gem.authors = ["Chris Beer"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "noid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/noid.rb

@@ -0,0 +1,4 @@
+require 'noid/minter'
+module Noid
+
+end

data/lib/noid/minter.rb

@@ -0,0 +1,136 @@
+module Noid
+  class Minter
+    XDIGIT = ['0','1','2','3','4','5','6','7','8','9','b','c','d','f','g','h','j','k','l','n','p','q','r','s','t','v','w','x','z']
+    MAX_COUNTERS = 293
+
+    def initialize args = {}
+
+      @max = nil
+      @min = nil
+
+      @prefix, @mask = args[:template].split('.')
+      @type, @characters = @mask.split '', 2
+      @characters = @characters.split ''
+      @check = @characters.pop and true if @characters.last == 'k'
+      case @type
+        when 's'
+          @s = 0
+        when 'z'
+          @s = 0
+        when 'r'
+
+          percounter = max / MAX_COUNTERS + 1
+          t = 0
+          @s = Array.new(max/percounter) do |i| 
+            { :value => case i
+              when 0 then 0
+              else t += percounter 
+              end, :max => t + percounter }
+          end
+      end
+      
+    end
+
+    def mint
+      str = @prefix
+      case @type
+        when 's'
+          n = @s
+          @s += 1
+          str += n2xdig(n)
+        when 'z'
+          n = @s
+          @s += 1
+          str += n2xdig(n)
+        when 'r'
+          i = rand(@s.size)
+          n = @s[i][:value]
+          @s[i][:value] += 1
+          @s.delete_at(i) if @s[i][:value] == @s[i][:max]
+          str += n2xdig(n)
+      end
+
+      str += checkdigit(str) if @check
+
+      str
+    end
+
+    def hold id
+
+    end
+
+    def release id
+
+    end
+
+    def validate id
+
+    end
+
+
+    private
+
+    def s
+      @s
+    end
+
+    def checkdigit str
+      i = 1
+      XDIGIT[str.split('').map { |x|  XDIGIT.index(x).to_i }.inject { |sum, n| i+=1; sum += (n * i) } % XDIGIT.length]
+    end
+
+    def min
+      return @min if @min
+      @min = 0
+    end
+
+    def max
+      return @max if @max
+      return @max = nil if @type == 'z'
+      @max = @characters.inject(1) do |sum, n|
+        i = case n
+            when 'e'
+              XDIGIT.length
+            when 'd'
+              10
+            else 
+              1
+        end
+        sum *= i 
+      end  
+    end
+
+    def n2xdig n
+      xdig = @characters.reverse.map do |c|
+        div = case c
+          when 'e' then XDIGIT.length
+          when 'd' then 10  
+          end
+          next if div.nil?
+
+          value = n % div
+          n = n / div
+          XDIGIT[value]
+      end.compact.join ''
+
+      if @type == 'z'
+        while n > 0
+          c = @characters.last
+          div = case c
+            when 'e' then XDIGIT.length
+            when 'd' then 10  
+            end
+            next if div.nil?
+
+            value = n % div
+            n = n / div
+            xdig += XDIGIT[value]
+        end
+      end
+      
+      raise Exception if n > 0
+
+      xdig.reverse
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'noid'
+
+class Test::Unit::TestCase
+end

data/test/test_noid.rb

@@ -0,0 +1,109 @@
+require 'helper'
+
+class TestNoid < Test::Unit::TestCase
+  context "Noid" do
+    should "generate checkdigits correctly" do
+      n = Noid::Minter.new :template => 's.zd'
+      assert_equal('q', n.send(:checkdigit, '13030/xf93gt2'))
+    end
+
+    should "generate max sequence for type 'r'" do
+      n = Noid::Minter.new :template => 's.rd'
+      assert_equal(0, n.send(:min))
+      assert_equal(10, n.send(:max))
+
+      n = Noid::Minter.new :template => 's.rdd'
+      assert_equal(0, n.send(:min))
+      assert_equal(100, n.send(:max))
+    end
+
+    should "generate quasi-random counters for type 'r'" do
+      n = Noid::Minter.new :template => 's.rd'
+      assert_equal((0..9).map { |x| {:value => x, :max => (x + 1)} }, n.send(:s))
+
+      n = Noid::Minter.new :template => 's.rdde'
+      s = n.send(:s)
+      assert_contains(s, {:value => 2890, :max => 2900})
+    end
+
+    should "generate random sequence for type 'r'" do
+      n = Noid::Minter.new :template => 's.rd' 
+      a = 10.times.map { |i| n.mint }
+
+      10.times do |i|
+        assert_contains(a, "s#{i}")
+      end
+
+    end
+
+    should "generate numeric sequence for type 's'" do
+      n = Noid::Minter.new :template => 's.sd'
+      10.times do |i|
+        assert_equal("s#{i}", n.mint)
+      end
+    end
+
+    should "generate extended sequence for type 's'" do
+      n = Noid::Minter.new :template => 's.se'
+      10.times do |i|
+        assert_equal("s#{i}", n.mint)
+      end
+        assert_equal("sb", n.mint)
+      10.times { n.mint }  
+        assert_equal("sq", n.mint)
+
+    end
+
+    should "raise an exception when overflowing sequence" do
+      n = Noid::Minter.new :template => 's.sd'
+      10.times do |i|
+        assert_equal("s#{i}", n.mint)
+      end
+
+      assert_raise Exception do
+        n.mint
+      end
+    end
+
+    should "generate sequence for type 's' with checkdigit" do
+      n = Noid::Minter.new :template => 's.sdk'
+      assert_equal('s0s', n.mint)
+      assert_equal('s1v', n.mint)
+      assert_equal('s2x', n.mint)
+    end
+
+    should "generate sequence for type 'z' with checkdigit" do
+      n = Noid::Minter.new :template => 'z.zdk'
+      assert_equal('z0z', n.mint)
+      assert_equal('z11', n.mint)
+      assert_equal('z23', n.mint)
+    end
+    should "generate sequence for type 'z', adding new digits as needed" do
+      n = Noid::Minter.new :template => 'z.zdk'
+      assert_equal('z0z', n.mint)
+      assert_equal('z11', n.mint)
+      assert_equal('z23', n.mint)
+      10.times { n.mint }
+      assert_equal('z13b', n.mint)
+    end
+
+    should "generate sequence for type 'z', adding new xdigits as needed" do
+      n = Noid::Minter.new :template => 'z.zdek'
+      assert_equal('z00z', n.mint)
+      assert_equal('z012', n.mint)
+      assert_equal('z025', n.mint)
+      10.times { 
+        assert_match(/^z[0-9]/, n.mint) 
+      }
+      assert_equal('z0f9', n.mint)
+      100.times { 
+        assert_match(/^z[0-9]/, n.mint) 
+      }
+      assert_equal('z3xz', n.mint)
+      1000.times { 
+        assert_match(/^z[0-9]/, n.mint) 
+      }
+      assert_equal('z38fs', n.mint)
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: noid
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: ""
+email: chris@cbeer.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/noid.rb
+- lib/noid/minter.rb
+- test/helper.rb
+- test/test_noid.rb
+has_rdoc: true
+homepage: http://github.com/cbeer/noid
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Nice Opaque Identifier
+test_files: 
+- test/helper.rb
+- test/test_noid.rb