noid 0.1.0 → 0.3.0

data/Gemfile

@@ -3,6 +3,8 @@ source "http://rubygems.org"
 # 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.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/lib/noid.rb

@@ -1,4 +1,6 @@
-require 'noid/minter'
+require 'noid/base'
+require 'noid/persistence'
+require 'noid/persistence/json'
 require 'noid/identifier'
 require 'noid/identifier/singleton'
 require 'noid/identifier/anvl'

data/lib/noid/{minter.rb → base.rb}

@@ -1,64 +1,38 @@
+require 'backports'
+
 module Noid
-  class Minter
+  class Base
     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
+      @config = { :identifier => {} }.merge args
+      setup_mask args
+    end  
 
-      @identifier_class = args[:identifier_class]
-      @identifier_class ||= String
-
-      @prefix, @mask = args[:template].split('.')
-
-      @prefix = "#{args[:namespace]}/#{@prefix}" if args[:namespace]
-
-      @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
+      n = @s
+      @s += 1
+
       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)
+          raise Exception if @counters.size == 0
+          i = @rand.rand(@counters.size)
+          n = @counters[i][:value]
+          @counters[i][:value] += 1
+          @counters.delete_at(i) if @counters[i][:value] == @counters[i][:max]
       end
+      str += n2xdig(n)
 
       str += checkdigit(str) if @check
 
-      @identifier_class.new str
+      identifier.new str
     end
 
     def valid? id
@@ -79,8 +53,8 @@ module Noid
     end
 
     protected
-    def s
-      @s
+    def identifier
+      @config[:identifier][:class] || String  
     end
 
     def checkdigit str
@@ -141,5 +115,38 @@ module Noid
 
       xdig.reverse
     end
+
+    def setup_mask args
+      @prefix, @mask = args[:template].split('.')
+
+      @prefix = "#{args[:namespace]}/#{@prefix}" if args[:namespace]
+
+      @type, @characters = @mask.split '', 2
+      @characters = @characters.split ''
+      @check = @characters.pop and true if @characters.last == 'k'
+      @s = args[:s] || 0
+      case @type
+        when 's'
+        when 'z'
+        when 'r'
+          @rand = Random.new(args[:seed]) if args[:seed]
+          @rand ||= Random.new
+          @seed = @rand.seed
+
+          if args[:s]
+            args[:s].times { @rand.rand }
+          end
+
+          percounter = max / (args[:max_counters] || MAX_COUNTERS) + 1
+          t = 0
+          @counters = args[:counters]
+          @counters ||= Array.new(max/percounter) do |i| 
+            { :value => case i
+              when 0 then 0
+              else t += percounter 
+              end, :max => t + percounter }
+          end
+      end
+    end
   end
 end

data/lib/noid/persistence.rb

@@ -0,0 +1,4 @@
+module Noid
+  module Persistence
+  end
+end

data/lib/noid/persistence/json.rb

@@ -0,0 +1,36 @@
+require 'json'
+module Noid::Persistence
+  class JSON < Noid::Base
+    FILENAME = 'NOID.js'
+    def initialize args = {}
+      @file = args[:filename] || FILENAME
+      data = load_json
+      super data.merge(args)
+      save
+    end
+
+    def mint
+      a = super
+      save
+      return a
+    end
+
+    protected
+    def load_json
+      data = ::JSON.parse(File.read(@file)) if File.exists? @file
+      data ||= {}
+      data = data.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} unless data.empty?
+      data[:counters] = data[:counters].map { |x| x.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} } if data[:counters]
+      data[:identifier] = { :class => Kernel.const_get(data[:identifier]['class']) } if data[:identifier]
+      data
+    end
+
+    def save
+      File.open(@file, 'w') do |f|
+          str = { :identifier => { :class => identifier }, :s => @s, :counters => @counters, :seed => @seed, }.to_json
+        f.write(str)
+      end
+    end
+
+  end
+end

data/noid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{noid}
-  s.version = "0.1.0"
+  s.version = "0.3.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-12}
+  s.date = %q{2010-12-16}
   s.description = %q{}
   s.email = %q{chris@cbeer.info}
   s.extra_rdoc_files = [
@@ -24,14 +24,17 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/noid.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/json.rb",
     "noid.gemspec",
     "test/helper.rb",
     "test/test_binding.rb",
-    "test/test_noid.rb"
+    "test/test_noid.rb",
+    "test/test_persistence.rb"
   ]
   s.homepage = %q{http://github.com/cbeer/noid}
   s.licenses = ["MIT"]
@@ -41,7 +44,8 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
     "test/test_binding.rb",
-    "test/test_noid.rb"
+    "test/test_noid.rb",
+    "test/test_persistence.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -50,12 +54,16 @@ Gem::Specification.new do |s|
 
     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"])
@@ -63,6 +71,8 @@ Gem::Specification.new do |s|
     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"])

data/test/test_binding.rb

@@ -1,33 +1,42 @@
 require 'helper'
 require 'anvl'
+require 'tmpdir'
 
 class TestNoidBinding < Test::Unit::TestCase
   context "Noid" do
     should "accept identifier_class for NOID bindings" do
-      n = Noid::Minter.new :template => 'r.rek', :identifier_class => Noid::Identifier::Base
-      id = n.mint
-      assert_equal(Noid::Identifier::Base, id.class)
-      id['abc'] = 123
-      assert_equal(123, id['abc'])
+      Dir.mktmpdir do |d|
+        Dir.chdir d
+        n = Noid::Base.new :template => 'r.rek', :identifier => { :class => Noid::Identifier::Base }
+        id = n.mint
+        assert_equal(Noid::Identifier::Base, id.class)
+        id['abc'] = 123
+        assert_equal(123, id['abc'])
+      end
     end
 
     should "use singleton instance to persist  NOID bindings" do
-      n = Noid::Minter.new :template => 'r.rek', :identifier_class => Noid::Identifier::Singleton
-      id = n.mint
-      id['abc'] = 123
-      assert_equal(123, id['abc'])
+      Dir.mktmpdir do |d|
+        Dir.chdir d
+        n = Noid::Base.new :template => 'r.rek', :identifier => { :class => Noid::Identifier::Singleton }
+        id = n.mint
+        id['abc'] = 123
+        assert_equal(123, id['abc'])
 
-      id2 = Noid::Identifier::Singleton.new id.id
-      assert_equal(123, id2['abc'])
+        id2 = Noid::Identifier::Singleton.new id.id
+        assert_equal(123, id2['abc'])
+      end
     end
 
     should "user anvl instance to persist NOID binding info" do
-      n = Noid::Minter.new :template => 'r.rek', :identifier_class => Noid::Identifier::Anvl
-      id = n.mint
-      id['abc'] = 123
-      assert_equal(Noid::Identifier::Anvl, id.class)
-      assert_equal("123", id['abc'])
-
+      Dir.mktmpdir do |d|
+        Dir.chdir d
+        n = Noid::Base.new :template => 'r.rek', :identifier => { :class => Noid::Identifier::Anvl }
+        id = n.mint
+        id['abc'] = "123"
+        assert_equal(Noid::Identifier::Anvl, id.class)
+        assert_equal("123", id['abc'])
+      end  
     end
   end
 end

data/test/test_noid.rb

@@ -3,31 +3,31 @@ require 'helper'
 class TestNoid < Test::Unit::TestCase
   context "Noid" do
     should "generate checkdigits correctly" do
-      n = Noid::Minter.new :template => 's.zd'
+      n = Noid::Base.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'
+      n = Noid::Base.new :template => 's.rd'
       assert_equal(0, n.send(:min))
       assert_equal(10, n.send(:max))
 
-      n = Noid::Minter.new :template => 's.rdd'
+      n = Noid::Base.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::Base.new :template => 's.rd'
+      assert_equal((0..9).map { |x| {:value => x, :max => (x + 1)} }, n.instance_variable_get('@counters'))
 
-      n = Noid::Minter.new :template => 's.rdde'
-      s = n.send(:s)
+      n = Noid::Base.new :template => 's.rdde'
+      s = n.instance_variable_get('@counters')
       assert_contains(s, {:value => 2890, :max => 2900})
     end
 
     should "generate random sequence for type 'r'" do
-      n = Noid::Minter.new :template => 's.rd' 
+      n = Noid::Base.new :template => 's.rd' 
       a = 10.times.map { |i| n.mint }
 
       10.times do |i|
@@ -37,14 +37,14 @@ class TestNoid < Test::Unit::TestCase
     end
 
     should "generate numeric sequence for type 's'" do
-      n = Noid::Minter.new :template => 's.sd'
+      n = Noid::Base.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'
+      n = Noid::Base.new :template => 's.se'
       10.times do |i|
         assert_equal("s#{i}", n.mint)
       end
@@ -55,7 +55,7 @@ class TestNoid < Test::Unit::TestCase
     end
 
     should "raise an exception when overflowing sequence" do
-      n = Noid::Minter.new :template => 's.sd'
+      n = Noid::Base.new :template => 's.sd'
       10.times do |i|
         assert_equal("s#{i}", n.mint)
       end
@@ -66,20 +66,20 @@ class TestNoid < Test::Unit::TestCase
     end
 
     should "generate sequence for type 's' with checkdigit" do
-      n = Noid::Minter.new :template => 's.sdk'
+      n = Noid::Base.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'
+      n = Noid::Base.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'
+      n = Noid::Base.new :template => 'z.zdk'
       assert_equal('z0z', n.mint)
       assert_equal('z11', n.mint)
       assert_equal('z23', n.mint)
@@ -88,7 +88,7 @@ class TestNoid < Test::Unit::TestCase
     end
 
     should "generate sequence for type 'z', adding new xdigits as needed" do
-      n = Noid::Minter.new :template => 'z.zdek'
+      n = Noid::Base.new :template => 'z.zdek'
       assert_equal('z00z', n.mint)
       assert_equal('z012', n.mint)
       assert_equal('z025', n.mint)
@@ -107,7 +107,7 @@ class TestNoid < Test::Unit::TestCase
     end
 
     should "validate 'r' digit sequences" do
-      n = Noid::Minter.new :template => 'r.rd'
+      n = Noid::Base.new :template => 'r.rd'
 
       assert_equal(true, n.valid?('r1')   )
       assert_equal(true, n.valid?('r9')  )
@@ -117,7 +117,7 @@ class TestNoid < Test::Unit::TestCase
     end
 
     should "validate 'r' xdigit sequences" do
-      n = Noid::Minter.new :template => 'r.re'
+      n = Noid::Base.new :template => 'r.re'
 
       assert_equal(true, n.valid?('r1')   )
       assert_equal(true, n.valid?('r9')  )
@@ -125,30 +125,10 @@ class TestNoid < Test::Unit::TestCase
       assert_equal(true, n.valid?('rb'))
     end
     should "validate 'r' xdigit + checkdigit sequences" do
-      n = Noid::Minter.new :template => 'r.rek'
+      n = Noid::Base.new :template => 'r.rek'
 
       assert_equal(true, n.valid?('r2w')   )
       assert_equal(false, n.valid?('r2b')  )
     end
-
-    should "accept identifier_class for NOID bindings" do
-      n = Noid::Minter.new :template => 'r.rek', :identifier_class => Noid::Identifier::Base
-      id = n.mint
-      assert_equal(Noid::Identifier::Base, id.class)
-      id['abc'] = 123
-      assert_equal(123, id['abc'])
-    end
-
-    should "use singleton instance to persist  NOID bindings" do
-      n = Noid::Minter.new :template => 'r.rek', :identifier_class => Noid::Identifier::Singleton
-      id = n.mint
-      id['abc'] = 123
-      assert_equal(123, id['abc'])
-
-      id2 = Noid::Identifier::Singleton.new id.id
-      assert_equal(123, id2['abc'])
-    end
-
-
   end
 end

data/test/test_persistence.rb

@@ -0,0 +1,47 @@
+require 'helper'
+require 'fileutils'
+require 'tmpdir'
+
+class TestNoidPersistence < Test::Unit::TestCase
+  context "Noid" do
+    should "persist data using the JSON module" do
+      Dir.mktmpdir do |d|
+        Dir.chdir d
+        n = Noid::Persistence::JSON.new(:template => 's.sd')
+        assert_equal('s0', n.mint)
+        assert_equal(1, n.instance_variable_get('@s'))
+        m = Noid::Persistence::JSON.new(:template => 's.sd')
+        assert_equal('s1', m.mint)
+        assert_equal(2, m.instance_variable_get('@s'))
+      end
+    end
+
+    should "persist data in a supplied file" do
+      Dir.mktmpdir do |d|
+        Dir.chdir d
+        n = Noid::Persistence::JSON.new(:template => 's.sd', :filename => 'NOID.json')
+        assert(File.exists?('NOID.json'))
+      end
+    end
+
+    should "persist seed data for random" do
+      Dir.mktmpdir do |d|
+        Dir.chdir d
+        n = Noid::Persistence::JSON.new(:template => 'r.rd') 
+        n.mint
+        assert_equal(1, n.instance_variable_get('@s'))
+
+        m = Noid::Persistence::JSON.new(:template => 'r.rd')
+        assert_equal(n.instance_variable_get('@counters'), m.instance_variable_get('@counters'))
+        assert_equal(n.instance_variable_get('@s'), m.instance_variable_get('@s'))
+        assert_equal(n.instance_variable_get('@mask'), m.instance_variable_get('@mask'))
+        assert_equal(n.instance_variable_get('@characters'), m.instance_variable_get('@characters'))
+        assert_equal(n.instance_variable_get('@rand').seed, m.instance_variable_get('@rand').seed)
+        assert_equal(n.send(:min), m.send(:min))
+        assert_equal(n.send(:max), m.send(:max))
+        5.times { assert_equal(n.mint, m.mint) }
+        assert_equal(6, m.instance_variable_get('@s'))
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: noid
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 3
   - 0
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Chris Beer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -05:00
+date: 2010-12-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,9 +33,9 @@ dependencies:
         version: "0"
   requirement: *id001
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   prerelease: false
-  name: shoulda
+  name: json
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,11 +46,39 @@ dependencies:
         - 0
         version: "0"
   requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: backports
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: bundler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,12 +89,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id003
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: jeweler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,12 +105,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  requirement: *id004
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: rcov
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -91,7 +119,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
+  requirement: *id007
 description: ""
 email: chris@cbeer.info
 executables: []
@@ -109,14 +137,17 @@ files:
 - Rakefile
 - VERSION
 - lib/noid.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/json.rb
 - noid.gemspec
 - test/helper.rb
 - test/test_binding.rb
 - test/test_noid.rb
+- test/test_persistence.rb
 has_rdoc: true
 homepage: http://github.com/cbeer/noid
 licenses: 
@@ -155,3 +186,4 @@ test_files:
 - test/helper.rb
 - test/test_binding.rb
 - test/test_noid.rb
+- test/test_persistence.rb