noid 0.4.0 → 0.5.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -1,16 +1,4 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem "anvl"
-gem "json"
-gem "backports"
 
-# 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
+# Specify your gem's dependencies in noid.gemspec
+gemspec

data/Rakefile

@@ -1,53 +1,8 @@
-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 'bundler/gem_tasks'
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'rspec/core/rake_task'
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "noid #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/noid.rb

@@ -1,13 +1,8 @@
-require 'noid/base'
-require 'noid/minter'
-require 'noid/persistence'
-require 'noid/persistence/base'
-require 'noid/persistence/json'
-require 'noid/identifier'
-require 'noid/identifier/singleton'
-require 'noid/identifier/anvl'
-require 'noid/active_record'
-require 'noid/active_record/provider'
-module Noid
+require "noid/version"
+require "noid/minter"
+require "noid/template"
 
+module Noid
+    XDIGIT = ['0','1','2','3','4','5','6','7','8','9','b','c','d','f','g','h','j','k','m','n','p','q','r','s','t','v','w','x','z']
+    MAX_COUNTERS = 293
 end

data/lib/noid/minter.rb

@@ -1,5 +1,117 @@
+require 'backports'
+require 'backports'
+
 module Noid
   class Minter
-    include Noid::Base
+    attr_reader :seed, :seq
+    attr_writer :counters
+
+    def initialize args = {}
+      @seq = 0
+      seed(args[:seed], args[:seq])
+      @template_string = args[:template]
+      @max_counters = args[:max_counters]
+      @counters = args[:counters]
+    end  
+
+    ##
+    # Mint a new identifier
+    def mint
+      n = nil
+
+
+      case template.generator
+        when 's'
+          n = next_in_sequence
+        when 'z'
+          n = next_in_sequence
+        when 'r'
+          raise Exception if counters.size == 0
+          i = @rand.rand(counters.size)
+          next_in_sequence
+          n = counters[i][:value]
+          counters[i][:value] += 1
+          counters.delete_at(i) if counters[i][:value] == counters[i][:max]
+      end
+
+      template.mint(n)
+    end
+
+    ##
+    # Noid identifier template
+    #
+    # @return Noid::Template
+    def template
+      @template ||= Noid::Template.new(@template_string)
+    end
+
+    ##
+    # Is the identifier valid under the template string and checksum?
+    # @param [String] id
+    # @return bool
+    def valid? id
+      prefix = id[0..@prefix.length-1]
+      ch = id[@prefix.length..-1].split('')
+      check = ch.pop if @check
+      return false unless prefix == @prefix
+
+      return false unless @characters.length == ch.length
+      @characters.each_with_index do |c, i|
+        return false unless Noid::XDIGIT.include? ch[i] 
+        return false if c == 'd' and ch[i] =~ /[^\d]/
+      end
+
+      return false unless check.nil? or check == checkdigit(id[0..-2])
+
+      true
+    end
+
+    ##
+    # Seed the random number generator with a seed and sequence offset
+    # @param [Integer] seed
+    # @param [Integer] seq
+    # @return [Random]
+    def seed seed = nil, seq = 0
+      @rand = Random.new(seed) if seed
+      @rand ||= Random.new 
+      @seed = @rand.seed
+
+      seq.times { @rand.rand } if seq
+
+      @rand
+    end
+
+    def next_in_sequence
+      n = @seq
+      @seq += 1
+      n
+    end
+
+    ##
+    # Counters to use for quasi-random NOID sequences
+    def counters
+      return @counters if @counters
+      return [] unless template.generator == "r"
+
+      percounter = template.max / (@max_counters || Noid::MAX_COUNTERS) + 1
+      t = 0
+      @counters = []
+
+      while t < template.max
+        counter = {}
+        counter[:value] = t
+        counter[:max] = [t + percounter, template.max].min
+
+        t += percounter
+
+        @counters << counter
+      end
+
+      @counters
+    end
+
+    def dump
+      { :seq => @seq, :seed => @seed, :template => template.template, :counters => Marshal.load(Marshal.dump(counters)) }
+    end
   end
 end

data/lib/noid/template.rb

@@ -0,0 +1,144 @@
+module Noid
+  class Template
+    attr_reader :template
+
+    # @param [String] template A Template is a coded string of the form Prefix.Mask that governs how identifiers will be minted. 
+    def initialize template
+      @template = template  
+    end
+
+    def mint n
+      str = prefix
+      str += n2xdig(n)
+      str += checkdigit(str) if checkdigit?
+
+      str
+    end
+
+    def valid? str
+      return false unless str[0..prefix.length] == prefix
+
+      if generator == 'z'
+        str[prefix.length..-1].length > 2
+      else
+        str[prefix.length..-1].length == characters.length
+      end
+
+      characters.each_with_index do |c, i|
+        case c
+          when 'e'
+            return false unless Noid::XDIGIT.include? str[prefix.length + i]
+          when 'd'
+            return false unless str[prefix.length + i] =~ /\d/
+        end
+      end 
+
+      return false unless checkdigit(str[0..-2]) == str.split('').last if checkdigit?
+
+      true
+    end
+
+    ##
+    # identifier prefix string
+    def prefix
+      @prefix ||= @template.split('.').first
+    end
+
+    ##
+    # identifier mask string
+    def mask
+      @mask ||= @template.split('.').last
+    end
+
+    ##
+    # generator type to use: r, s, z
+    def generator
+      @generator ||= mask[0..0]  
+    end
+
+    ##
+    # sequence pattern: e (extended), d (digit)
+    def characters
+      @characters ||= begin
+        if checkdigit?
+          mask[1..-2]
+        else
+          mask[1..-1]
+        end
+                      end
+    end
+
+    ##
+    # should generated identifiers have a checkdigit?
+    def checkdigit?
+      mask.split('').last == 'k'
+    end
+
+    ##
+    # calculate a checkdigit for the str
+    # @param [String] str
+    # @return [String] checkdigit
+    def checkdigit str
+      Noid::XDIGIT[str.split('').map { |x| Noid::XDIGIT.index(x).to_i }.each_with_index.map { |n, idx| n*(idx+1) }.inject { |sum, n| sum += n }  % Noid::XDIGIT.length ]
+    end
+
+    ##
+    # minimum sequence value
+    def min
+      @min ||= 0
+    end
+
+    ##
+    # maximum sequence value for the template
+    def max
+      @max ||= begin
+        case generator
+          when 'z'
+            nil
+          else
+            characters.split('').map { |x| character_space(x) }.compact.inject(1) { |total, x| total *= x }
+        end
+      end
+    end
+
+
+    protected
+    ##
+    # total size of a given template character value
+    # @param [String] c
+    def character_space c
+      case c
+        when 'e'
+          Noid::XDIGIT.length
+        when 'd'
+          10
+      end
+    end
+
+    ##
+    # convert a minter position to a noid string under this template
+    # @param [Integer] n
+    # @return [String]
+    def n2xdig n
+      xdig = characters.reverse.split('').map do |c|
+        value = n % character_space(c)
+        n = n / character_space(c)  
+        Noid::XDIGIT[value]
+      end.compact.join('')
+
+      if generator == 'z'
+        c = characters.split('').last
+        while n > 0
+          value = n % character_space(c)
+          n = n / character_space(c)  
+          xdig += Noid::XDIGIT[value]
+        end
+      end
+
+      raise Exception if n > 0
+
+      xdig.reverse
+    end
+
+  end
+end

data/lib/noid/version.rb

@@ -0,0 +1,9 @@
+module Noid
+  unless Noid.const_defined? :VERSION
+    def self.version
+      @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+    end
+
+    VERSION = self.version
+  end
+end

data/noid.gemspec

@@ -1,87 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "noid/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{noid}
-  s.version = "0.4.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Chris Beer"]
-  s.date = %q{2010-12-23}
+  s.name        = "noid"
+  s.version     = Noid::VERSION
+  s.authors     = ["Chris Beer"]
+  s.email       = ["chris@cbeer.info"]
+  s.homepage    = "http://github.com/microservices/noid"
+  s.summary     = %q{Nice Opaque Identifier}
   s.description = %q{}
-  s.email = %q{chris@cbeer.info}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "doc/active_record_sample.rb",
-    "lib/noid.rb",
-    "lib/noid/active_record.rb",
-    "lib/noid/active_record/provider.rb",
-    "lib/noid/base.rb",
-    "lib/noid/identifier.rb",
-    "lib/noid/identifier/anvl.rb",
-    "lib/noid/identifier/singleton.rb",
-    "lib/noid/minter.rb",
-    "lib/noid/persistence.rb",
-    "lib/noid/persistence/base.rb",
-    "lib/noid/persistence/json.rb",
-    "noid.gemspec",
-    "test/helper.rb",
-    "test/test_binding.rb",
-    "test/test_noid.rb",
-    "test/test_persistence.rb"
-  ]
-  s.homepage = %q{http://github.com/cbeer/noid}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Nice Opaque Identifier}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_binding.rb",
-    "test/test_noid.rb",
-    "test/test_persistence.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.rubyforge_project = "noid"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<anvl>, [">= 0"])
-      s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<backports>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<anvl>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<backports>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<anvl>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<backports>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
-end
+  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"]
 
+  s.add_dependency "backports"
+  s.add_development_dependency "bundler", "~> 1.0.0"
+  s.add_development_dependency "rspec", ">= 2.0"
+  s.add_development_dependency "rcov", ">= 0"
+end