active_fedora-noid 2.0.0.beta3 → 2.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5db388af056519beadb49a49d0d1e4b10c5871fb
-  data.tar.gz: d50a20cc2589d1b84f0068dbed814d4002cc52c5
+  metadata.gz: 709c8e18225adbbd00041373fc45c436166ffa50
+  data.tar.gz: 4b4a569df3483bf994dc154ed986fc4bf700561c
 SHA512:
-  metadata.gz: 9d11883c84164902abdbcca6cb97e94bcfb23c4910f8230d390464070ef982866eb76d85969c916aa6c6cbb014eea3acdf35496a5dfd68d8b621cfec3dac7a0b
-  data.tar.gz: ae62d72ce5bc53cded2427798b3b07d37d3314c0c3423d703d6ccabeea59280602d4a161301792665e3b5a471082f3ad14e939c67ff27ed34a55b772b501ca5e
+  metadata.gz: 8ad9a677d42550c1fa40545ab19b5f872da006971a73cdbe9cf8788667316da5fee10541779f155d156ba772eca59f79d0a9c7db5262c07bb97e0f0320b506d1
+  data.tar.gz: db77507d045c565b2c7aa1ea351f4112405f0dcbaef0f47081f5589e6a56c2099cb1639dd6fda906ac621ec9a30a4229c3607db728a676674f01fa770159477d

data/.travis.yml

@@ -7,8 +7,8 @@ env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
   matrix:
-    - "RAILS_VERSION=4.2.6"
-    - "RAILS_VERSION=5.0.0"
+    - "RAILS_VERSION=4.2.7.1"
+    - "RAILS_VERSION=5.0.0.1"
 notifications:
   irc:
     channels:

data/Gemfile

@@ -6,13 +6,13 @@ gemspec
 group :development, :test do
   gem 'byebug' unless ENV['CI']
   gem 'coveralls', require: false
-  gem 'byebug' unless ENV['CI']
 end
+
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 0.8.2
-# engine_cart stanza: 0.8.0
+# engine_cart: 1.0.1
+# engine_cart stanza: 0.10.0
 # the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 if File.exist?(file)
   begin
     eval_gemfile file
@@ -26,19 +26,19 @@ else
   if ENV['RAILS_VERSION']
     if ENV['RAILS_VERSION'] == 'edge'
       gem 'rails', github: 'rails/rails'
-      ENV['ENGINE_CART_RAILS_OPTIONS']= "--edge --skip-turbolinks"
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
     else
       gem 'rails', ENV['RAILS_VERSION']
     end
   end
 
-  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
-    gem 'responders', "~> 2.0"
-    gem 'sass-rails', ">= 5.0"
-  elsif ENV['RAILS_VERSION'] =~ /^5.0/ || ENV['RAILS_VERSION'] == 'edge'
-    # nop
-  else
-    gem 'sass-rails', "< 5.0"
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -1,10 +1,11 @@
 [![Version](https://badge.fury.io/rb/active_fedora-noid.png)](http://badge.fury.io/rb/active_fedora-noid)
+[![Build Status](https://travis-ci.org/projecthydra-labs/active_fedora-noid.png?branch=master)](https://travis-ci.org/projecthydra-labs/active_fedora-noid)
+[![Coverage Status](https://coveralls.io/repos/projecthydra-labs/active_fedora-noid/badge.svg)](https://coveralls.io/r/projecthydra-labs/active_fedora-noid)
+[![Code Climate](https://codeclimate.com/github/projecthydra-labs/active_fedora-noid/badges/gpa.svg)](https://codeclimate.com/github/projecthydra-labs/active_fedora-noid)
+[![Dependency Status](https://gemnasium.com/projecthydra-labs/active_fedora-noid.png)](https://gemnasium.com/projecthydra-labs/active_fedora-noid)
 [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
 [![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/active_fedora-noid)
-[![Build Status](https://travis-ci.org/projecthydra-labs/active_fedora-noid.png?branch=master)](https://travis-ci.org/projecthydra-labs/active_fedora-noid)
-[![Dependency Status](https://gemnasium.com/projecthydra-labs/active_fedora-noid.png)](https://gemnasium.com/projecthydra-labs/active_fedora-noid)
-[![Coverage Status](https://coveralls.io/repos/projecthydra-labs/active_fedora-noid/badge.svg)](https://coveralls.io/r/projecthydra-labs/active_fedora-noid)
 
 # ActiveFedora::Noid
 
@@ -96,18 +97,30 @@ This will make sure your objects have Noid-like identifiers (e.g. `bb22bb22b`) t
 
 ## Overriding default behavior
 
-### Minter state (for replayability)
+The default minter in ActiveFedora::Noid 2.x is the database-backed minter to better support multi-host production installations that expect a shared database but not necessarily a shared filesystem (e.g., between load-balanced Rails applications).
 
-The default minter creates a Noid and dumps it to a statefile in the /tmp directory. You can override the location or name of this statefile as follows in e.g. `config/initializers/active_fedora-noid.rb`:
+### Use file-based minter state (for replayability)
+
+The file-based minter -- which was the default and only minter in 1.x -- creates a Noid and dumps it to a statefile in the /tmp directory. You can override the location or name of this statefile as follows in e.g. `config/initializers/active_fedora-noid.rb`:
 
 ```ruby
 require 'active_fedora/noid'
 
 ActiveFedora::Noid.configure do |config|
+  config.minter_class = ActiveFedora::Noid::Minter::File
   config.statefile = '/var/foo/bar'
 end
 ```
 
+**NOTE**: If you switch to a new minter, it will not automatically start with the same state as the old minter. AF::Noid does include a couple of rake tasks for copying state from database-backed minters to file-backed ones and vice versa:
+
+``` bash
+# For migrating minter state from a file to a database
+$ rake active_fedora:noid:migrate:file_to_database
+# For migrating minter state from a database to a file
+$ rake active_fedora:noid:migrate:database_to_file
+```
+
 ### Identifier template
 
 To override the default identifier pattern -- a nine-character string consisting of two alphanumeric digits, two numeric digits, two alphanumeric digits, two numeric digits, and a check digit -- put the following code in e.g. `config/initializers/active_fedora-noid.rb`:
@@ -124,28 +137,38 @@ For more information about the format of Noid patterns, see pages 8-10 of the [N
 
 ### Custom minters
 
-If you don't want your minter's state to be persisted, you may also pass in your own minter.  First write up a minter class that looks like the following:
+If you don't want your minter's state to be persisted, you may also write and configure your own minter.  First write up a minter class that looks like the following:
 
 ```ruby
-class MyMinter
-  def initialize(*args)
-    # do something if you need initialization
+class MyMinter < ActiveFedora::Noid::Minter::Base
+  def valid?(identifier)
+    # return true/false if you care about ids conforming to templates
   end
 
-  def mint
-    # spit out an identifier
+  def read
+    # return current minter state
   end
 
-  def valid?(identifier)
-    # return true/false if you care about ids conforming to templates
+  def write!(state)
+    # write a passed-in minter state
+  end
+
+  protected
+
+  def next_id
+    # return the next identifier from the minter
   end
 end
 ```
 
-Then inject an instance of your minter into ActiveFedora::Noid::Service:
+Then add your new minter class to the ActiveFedora::Noid configuration (`config/initializers/active_fedora-noid.rb`):
 
 ```ruby
-noid_service = ActiveFedora::Noid::Service.new(MyMinter.new)
+require 'active_fedora/noid'
+
+ActiveFedora::Noid.configure do |config|
+  config.minter_class = MyMinter
+end
 ```
 
 And the service will delegate minting and validating to an instance of your customized minter class.

data/active_fedora-noid.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'active-fedora', '>= 9.7', '< 12'
   spec.add_dependency 'noid', '~> 0.9'
-  spec.add_dependency 'rails', '>= 4.2.6', '< 6'
+  spec.add_dependency 'rails', '>= 4.2.7.1', '< 6'
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'engine_cart', '~> 0.8'
+  spec.add_development_dependency 'engine_cart', '~> 1.0'
 end

data/app/models/minter_state.rb

@@ -2,20 +2,4 @@ class MinterState < ActiveRecord::Base
   validates :namespace, presence: true, uniqueness: true
   validates :template, presence: true
   validates :template, format: { with: Object.const_get('Noid::Template::VALID_PATTERN'), message: 'value fails regex' }
-
-  # @return [Hash] options for Noid::Minter.new
-  # * template [String] setting the identifier pattern
-  # * seq [Integer] reflecting minter position in sequence
-  # * counters [Array{Hash}] "buckets" each with :current and :max values
-  # * rand [Object] random number generator object
-  def noid_options
-    return nil unless template
-    opts = {
-      :template => template,
-      :seq => seq
-    }
-    opts[:counters] = JSON.parse(counters, :symbolize_names => true) if counters
-    opts[:rand]     = Marshal.load(random) if random
-    opts
-  end
 end

data/db/migrate/20161021203429_rename_minter_state_random_to_rand.rb

@@ -0,0 +1,5 @@
+class RenameMinterStateRandomToRand < ActiveRecord::Migration
+  def change
+    rename_column :minter_states, :random, :rand
+  end
+end

data/lib/active_fedora/noid.rb

@@ -2,9 +2,7 @@ require 'active_fedora/noid/version'
 require 'active_fedora/noid/config'
 require 'active_fedora/noid/engine'
 require 'active_fedora/noid/service'
-require 'active_fedora/noid/minter/base'
-require 'active_fedora/noid/minter/db'
-require 'active_fedora/noid/synchronized_minter'
+require 'active_fedora/noid/minter'
 
 module ActiveFedora
   module Noid
@@ -18,7 +16,9 @@ module ActiveFedora
       end
 
       def treeify(identifier)
-        (identifier.scan(/..?/).first(4) + [identifier]).join('/')
+        head = identifier.split('/').first
+        head.gsub!(/#.*/, '')
+        (head.scan(/..?/).first(4) + [identifier]).join('/')
       end
     end
   end

data/lib/active_fedora/noid/config.rb

@@ -1,7 +1,8 @@
 module ActiveFedora
   module Noid
     class Config
-      attr_writer :template, :translate_uri_to_id, :translate_id_to_uri, :statefile, :namespace
+      attr_writer :template, :translate_uri_to_id, :translate_id_to_uri,
+                  :statefile, :namespace, :minter_class
 
       def template
         @template ||= '.reeddeeddk'
@@ -15,6 +16,10 @@ module ActiveFedora
         @namespace ||= 'default'
       end
 
+      def minter_class
+        @minter_class ||= Minter::Db
+      end
+
       def translate_uri_to_id
         lambda do |uri|
           uri.to_s.sub(baseurl, '').split('/', baseparts).last

data/lib/active_fedora/noid/minter.rb

@@ -0,0 +1,3 @@
+require_relative 'minter/base'
+require_relative 'minter/file'
+require_relative 'minter/db'

data/lib/active_fedora/noid/minter/base.rb

@@ -1,13 +1,23 @@
 require 'noid'
+require 'active_fedora'
 
 module ActiveFedora
   module Noid
     module Minter
       class Base < ::Noid::Minter
+        ##
+        # @param template [#to_s] a NOID template
+        #
+        # @see Noid::Template
         def initialize(template = default_template)
-          super(:template => template.to_s)
+          super(template: template.to_s)
         end
 
+        ##
+        # Sychronously mint a new identifier. Guarantees the ID is not
+        # already reserved in ActiveFedora.
+        #
+        # @return [String] the minted identifier
         def mint
           Mutex.new.synchronize do
             while true
@@ -17,14 +27,34 @@ module ActiveFedora
           end
         end
 
+        ##
+        # @return [Hash] an object representing the current minter state
+        def read
+          raise NotImplementedError.new('Implement #read in child class')
+        end
+
+        ##
+        # Updates the minter state to that of the `minter` parameter.
+        #
+        # @param minter [Minter::Base]
+        #
+        # @return [void]
+        def write!(_)
+          raise NotImplementedError.new('Implement #write! in child class')
+        end
+
         protected
 
+        ##
+        # @return [#to_s] the default template for this
         def default_template
           ActiveFedora::Noid.config.template
         end
 
+        ##
+        # @return [String] a new identifier.
         def next_id
-          raise NotImplementedError.new('Implement next_id in child class')
+          raise NotImplementedError.new('Implement #next_id in child class')
         end
       end
     end

data/lib/active_fedora/noid/minter/db.rb

@@ -4,6 +4,22 @@ module ActiveFedora
   module Noid
     module Minter
       class Db < Base
+
+        def read
+          filtered_hash = instance.as_json.select { |key| ['template', 'counters', 'seq', 'rand', 'namespace'].include?(key) }
+          filtered_hash['counters'] = JSON.parse(filtered_hash['counters'], symbolize_names: true) if filtered_hash['counters']
+          filtered_hash.symbolize_keys
+        end
+
+        def write!(minter)
+          # namespace and template are the same, now update the other attributes
+          instance.update_attributes!(
+            seq: minter.seq,
+            counters: JSON.generate(minter.counters),
+            rand: Marshal.dump(minter.instance_variable_get(:@rand))
+          )
+        end
+
         protected
 
         # Uses pessimistic lock to ensure the record fetched is the same one updated.
@@ -19,21 +35,20 @@ module ActiveFedora
         def next_id
           id = nil
           MinterState.transaction do
-            state = MinterState.lock.where(
-              namespace: ActiveFedora::Noid.config.namespace,
-              template: ActiveFedora::Noid.config.template,
-            ).first!
-            minter = ::Noid::Minter.new(state.noid_options)
+            state = read
+            minter = ::Noid::Minter.new(state)
             id = minter.mint
-            # namespace and template are the same, now update the other attributes
-            state.seq      = minter.seq
-            state.counters = JSON.generate(minter.counters)
-            state.random   = Marshal.dump(minter.instance_variable_get(:@rand))
-            state.save!
+            write!(minter)
           end # transaction
           id
         end
 
+        def instance
+          MinterState.lock.find_by(
+            namespace: ActiveFedora::Noid.config.namespace,
+            template: ActiveFedora::Noid.config.template,
+          )
+        end
       end # class Db
     end
   end

data/lib/active_fedora/noid/minter/file.rb

@@ -0,0 +1,60 @@
+require 'noid'
+
+module ActiveFedora
+  module Noid
+    module Minter
+      class File < Base
+        attr_reader :statefile
+
+        def initialize(template = default_template, statefile = default_statefile)
+          @statefile = statefile
+          super(template)
+        end
+
+        def default_statefile
+          ActiveFedora::Noid.config.statefile
+        end
+
+        def read
+          with_file do |f|
+            state_for(f)
+          end
+        end
+
+        def write!(minter)
+          with_file do |f|
+            # Wipe prior contents so the new state can be written from the beginning of the file
+            f.truncate(0)
+            f.write(Marshal.dump(minter.dump))
+          end
+        end
+
+        protected
+
+        def with_file
+          ::File.open(statefile, 'a+b', 0644) do |f|
+            f.flock(::File::LOCK_EX)
+            # Files opened in append mode seek to end of file
+            f.rewind
+            yield f
+          end
+        end
+
+        def state_for(io_object)
+          Marshal.load(io_object.read)
+        rescue TypeError, ArgumentError
+          { template: template }
+        end
+
+        def next_id
+          state = read
+          state[:template] &&= state[:template].to_s
+          minter = ::Noid::Minter.new(state) # minter w/in the minter, lives only for an instant
+          id = minter.mint
+          write!(minter)
+          id
+        end
+      end
+    end
+  end
+end

data/lib/active_fedora/noid/service.rb

@@ -20,7 +20,7 @@ module ActiveFedora
       protected
 
       def default_minter
-        ActiveFedora::Noid::SynchronizedMinter.new
+        ActiveFedora::Noid.config.minter_class.new
       end
     end
   end

data/lib/active_fedora/noid/version.rb

@@ -1,5 +1,5 @@
 module ActiveFedora
   module Noid
-    VERSION = '2.0.0.beta3'.freeze
+    VERSION = '2.0.0.beta4'.freeze
   end
 end

data/lib/tasks/noid_tasks.rake

@@ -4,25 +4,51 @@ require 'yaml'
 
 namespace :active_fedora do
   namespace :noid do
-    desc 'Migrate minter state file from YAML to Marshal'
-    task :migrate_statefile do
-      statefile = ENV.fetch('AFNOID_STATEFILE', ActiveFedora::Noid.config.statefile)
-      raise "File not found: #{statefile}\nAborting" unless File.exist?(statefile)
-      puts "Migrating #{statefile} from YAML to Marshal serialization..."
-      File.open(statefile, 'a+b', 0644) do |f|
-        f.flock(File::LOCK_EX)
-        f.rewind
-        begin
-          yaml_state = YAML.load(f)
-        rescue Psych::SyntaxError
-          raise "File not valid YAML: #{statefile}\nAborting."
+    namespace :migrate do
+      desc 'Migrate minter state file from YAML to Marshal'
+      task :yaml_to_marshal do
+        statefile = ENV.fetch('AFNOID_STATEFILE', ActiveFedora::Noid.config.statefile)
+        raise "File not found: #{statefile}\nAborting" unless File.exist?(statefile)
+        puts "Migrating #{statefile} from YAML to Marshal serialization..."
+        File.open(statefile, 'a+b', 0644) do |f|
+          f.flock(File::LOCK_EX)
+          f.rewind
+          begin
+            yaml_state = YAML.load(f)
+          rescue Psych::SyntaxError
+            raise "File not valid YAML: #{statefile}\nAborting."
+          end
+          minter = Noid::Minter.new(yaml_state)
+          f.truncate(0)
+          new_state = Marshal.dump(minter.dump)
+          f.write(new_state)
         end
-        minter = Noid::Minter.new(yaml_state)
-        f.truncate(0)
-        new_state = Marshal.dump(minter.dump)
-        f.write(new_state)
+        puts "Done!"
+      end
+
+      desc 'Migrate minter state from file to database'
+      task file_to_database: :environment do
+        statefile = ENV.fetch('AFNOID_STATEFILE', ActiveFedora::Noid.config.statefile)
+        raise "File not found: #{statefile}\nAborting" unless File.exist?(statefile)
+        puts "Migrating #{statefile} to database..."
+        state = ActiveFedora::Noid::Minter::File.new.read
+        minter = Noid::Minter.new(state)
+        new_state = ActiveFedora::Noid::Minter::Db.new
+        new_state.write!(minter)
+        puts "Done!"
+      end
+
+      desc 'Migrate minter state from database to file'
+      task database_to_file: :environment do
+        statefile = ENV.fetch('AFNOID_STATEFILE', ActiveFedora::Noid.config.statefile)
+        raise "File already exists (delete it first if it's not valuable): #{statefile}\nAborting" if File.exist?(statefile)
+        puts "Migrating minter state from database to #{statefile}..."
+        state = ActiveFedora::Noid::Minter::Db.new.read
+        minter = Noid::Minter.new(state)
+        new_state = ActiveFedora::Noid::Minter::File.new
+        new_state.write!(minter)
+        puts "Done!"
       end
-      puts "Done!"
     end
   end
 end

data/spec/models/minter_state_spec.rb

@@ -37,22 +37,4 @@ describe MinterState, type: :model do
       expect(described_class.group(:namespace).count).to eq('default' => 1, 'foobar' => 1)
     end
   end
-
-  describe '#noid_options' do
-    it 'returns nil without template (new object not persisted)' do
-      expect(state.noid_options).to be_nil
-    end
-    it 'returns correct hash when populated' do
-      state.template = '.reeddddk'
-      state.seq = 1
-      expect(state.noid_options).to match a_hash_including(
-        :template => '.reeddddk',
-        :seq => 1
-      )
-      expect(first.noid_options).to match a_hash_including(
-        :template => '.reeddeeddk',
-        :seq => 0
-      )
-    end
-  end
 end

data/spec/support/shared_examples/minter.rb

@@ -0,0 +1,55 @@
+shared_examples 'a minter' do
+  describe '#mint' do
+    subject     { minter.mint }
+    let(:other) { described_class.new('.reedddk') }
+
+    it { is_expected.not_to be_empty }
+
+    it 'does not mint the same ID twice in a row' do
+      expect(subject).not_to eq described_class.new.mint
+    end
+
+    it 'is valid' do
+      expect(minter.valid?(subject)).to be true
+      expect(described_class.new.valid?(subject)).to be true
+    end
+
+    it 'is invalid under a different template' do
+      expect(described_class.new('.reedddk').valid?(subject)).to be false
+    end
+
+    it 'is invalid under a different template' do
+      expect(other).not_to be_valid(minter.mint)
+    end
+  end
+
+  context 'conflicts' do
+    let(:existing_pid) { 'ef12ef12f' }
+    let(:unique_pid)   { 'bb22bb22b' }
+
+    before :each do
+      expect(subject).to receive(:next_id).and_return(existing_pid, unique_pid)
+    end
+
+    context 'when the pid already exists in Fedora' do
+      before do
+        expect(ActiveFedora::Base).to receive(:exists?).with(existing_pid).and_return(true)
+      end
+      it 'skips the existing pid' do
+        expect(subject.mint).to eq unique_pid
+      end
+    end
+
+    context 'when the pid already existed in Fedora and now is gone' do
+      let(:gone_pid) { existing_pid }
+
+      before do
+        expect(ActiveFedora::Base).to receive(:gone?).with(gone_pid).and_return(true)
+      end
+
+      it 'skips the deleted pid' do
+        expect(subject.mint).to eq unique_pid
+      end
+    end
+  end
+end

data/spec/unit/config_spec.rb

@@ -1,7 +1,10 @@
 describe ActiveFedora::Noid::Config do
+  subject { described_class.new }
+
   it { is_expected.to respond_to(:template) }
   it { is_expected.to respond_to(:statefile) }
   it { is_expected.to respond_to(:namespace) }
+  it { is_expected.to respond_to(:minter_class) }
   it { is_expected.to respond_to(:translate_id_to_uri) }
   it { is_expected.to respond_to(:translate_uri_to_id) }
 
@@ -23,6 +26,22 @@ describe ActiveFedora::Noid::Config do
     end
   end
 
+  describe '#minter_class' do
+    let(:default) { ActiveFedora::Noid::Minter::Db }
+
+    it 'has a default' do
+      expect(subject.minter_class).to eq default
+    end
+
+    context 'when overridden' do
+      before { subject.minter_class = different_minter }
+      let(:different_minter) { ActiveFedora::Noid::Minter::File }
+      it 'uses the different minter' do
+        expect(subject.minter_class).to eq different_minter
+      end
+    end
+  end
+
   describe '#translate_uri_to_id' do
     let(:config) { described_class.new }
     let(:translator) { config.translate_uri_to_id }
@@ -38,10 +57,10 @@ describe ActiveFedora::Noid::Config do
 
     context "with a hash code uri" do
       let(:uri) { "http://localhost:8983/fedora/rest/test/hh/63/vz/22/hh63vz22q#g123" }
-    it { is_expected.to eq 'hh63vz22q#g123' }
+      it { is_expected.to eq 'hh63vz22q#g123' }
     end
 
-    describe 'with a short custom template' do
+    context 'with a short custom template' do
       let(:uri) { "http://localhost:8983/fedora/rest/test/ab/cd/abcd/members" }
       let(:custom_template) { '.reeee' }
       before { config.template = custom_template }
@@ -50,7 +69,7 @@ describe ActiveFedora::Noid::Config do
       it { is_expected.to eq 'abcd/members' }
     end
 
-    describe 'with an even shorter custom template' do
+    context 'with an even shorter custom template' do
       let(:uri) { "http://localhost:8983/fedora/rest/test/ab/c/abc/members" }
       let(:custom_template) { '.reee' }
       before { config.template = custom_template }
@@ -59,7 +78,7 @@ describe ActiveFedora::Noid::Config do
       it { is_expected.to eq 'abc/members' }
     end
 
-    describe 'with a long custom template' do
+    context 'with a long custom template' do
       let(:uri) { "http://localhost:8983/fedora/rest/test/ab/cd/ef/gh/abcdefghijklmnopqrstuvwxyz/members" }
       let(:custom_template) { '.reeeeeeeeeeeeeeeeeeeeeeeeee' }
       before { config.template = custom_template }
@@ -67,6 +86,48 @@ describe ActiveFedora::Noid::Config do
 
       it { is_expected.to eq 'abcdefghijklmnopqrstuvwxyz/members' }
     end
+  end
 
+  describe '#translate_id_to_uri' do
+    let(:config) { described_class.new }
+    let(:translator) { config.translate_id_to_uri }
+    let(:id) { "hh63vz2/members" }
+    let(:ActiveFedora) { double(ActiveFedora) }
+    subject { translator.call(id) }
+    before do
+      allow(ActiveFedora).to receive_message_chain("fedora.host") { "http://localhost:8983" }
+      allow(ActiveFedora).to receive_message_chain("fedora.base_path") { "/fedora/rest/test" }
+    end
+
+    it { is_expected.to eq "http://localhost:8983/fedora/rest/test/hh/63/vz/2/hh63vz2/members" }
+
+    context "with a hash code id" do
+      let(:id) { 'hh63vz2#g123' }
+      it { is_expected.to eq "http://localhost:8983/fedora/rest/test/hh/63/vz/2/hh63vz2#g123" }
+    end
+
+    context 'with a short custom template' do
+      let(:id) { "abcd/members" }
+      let(:custom_template) { '.reeee' }
+      before { config.template = custom_template }
+      subject { translator.call(id) }
+      it { is_expected.to eq "http://localhost:8983/fedora/rest/test/ab/cd/abcd/members" }
+    end
+
+    context 'with an even shorter custom template' do
+      let(:id) { 'abc/members' }
+      let(:custom_template) { '.reee' }
+      before { config.template = custom_template }
+      subject { translator.call(id) }
+      it { is_expected.to eq "http://localhost:8983/fedora/rest/test/ab/c/abc/members" }
+    end
+
+    context 'with a long custom template' do
+      let(:id) { "abcdefghijklmnopqrstuvwxyz/members" }
+      let(:custom_template) { '.reeeeeeeeeeeeeeeeeeeeeeeeee' }
+      before { config.template = custom_template }
+      subject { translator.call(id) }
+      it { is_expected.to eq "http://localhost:8983/fedora/rest/test/ab/cd/ef/gh/abcdefghijklmnopqrstuvwxyz/members" }
+    end
   end
 end

data/spec/unit/db_minter_spec.rb

@@ -2,7 +2,7 @@ include MinterStateHelper
 
 describe ActiveFedora::Noid::Minter::Db do
   before(:each) { reset_minter_state_table }
-  after( :all ) { reset_minter_state_table }
+  after(:all) { reset_minter_state_table }
 
   before :each do
     # default novel mintings
@@ -10,19 +10,22 @@ describe ActiveFedora::Noid::Minter::Db do
     allow(ActiveFedora::Base).to receive(:gone?).and_return(false)
   end
 
-  let(:minter) { described_class.new }
   let(:other) { described_class.new('.reedddk') }
 
+  it_behaves_like 'a minter' do
+    let(:minter) { described_class.new }
+  end
+
   describe '#initialize' do
     it 'raises on bad templates' do
       expect{ described_class.new('reeddeeddk') }.to raise_error(Noid::TemplateError)
       expect{ described_class.new('')           }.to raise_error(Noid::TemplateError)
     end
     it 'returns object w/ default template' do
-      expect(minter).to be_instance_of described_class
-      expect(minter).to be_a Noid::Minter
-      expect(minter.template).to be_instance_of Noid::Template
-      expect(minter.template.to_s).to eq ActiveFedora::Noid.config.template
+      expect(subject).to be_instance_of described_class
+      expect(subject).to be_a Noid::Minter
+      expect(subject.template).to be_instance_of Noid::Template
+      expect(subject.template.to_s).to eq ActiveFedora::Noid.config.template
     end
     it 'accepts valid template arg' do
       expect(other).to be_instance_of described_class
@@ -32,45 +35,29 @@ describe ActiveFedora::Noid::Minter::Db do
     end
   end
 
-  describe '#mint' do
-    subject { minter.mint }
-    it { is_expected.not_to be_empty }
-    it 'does not mint the same ID twice in a row' do
-      expect(subject).not_to eq described_class.new.mint
+  describe '#read' do
+    it 'returns a hash' do
+      expect(subject.read).to be_a(Hash)
     end
-    it 'is valid' do
-      expect(minter.valid?(subject)).to be true
-      expect(described_class.new.valid?(subject)).to be true
+    it 'has the expected namespace' do
+      expect(subject.read[:namespace]).to eq ActiveFedora::Noid.config.namespace
     end
-    it 'is invalid under a different template' do
-      expect(described_class.new('.reedddk').valid?(subject)).to be false
+    it 'has the expected template' do
+      expect(subject.read[:template]).to eq ActiveFedora::Noid.config.template
     end
   end
 
-  context 'conflicts' do
-    let(:existing_pid) { 'ef12ef12f' }
-    let(:unique_pid) { 'bb22bb22b' }
-    before :each do
-      expect(minter).to receive(:next_id).and_return(existing_pid, unique_pid)
-    end
-
-    context 'when the pid already exists in Fedora' do
-      before do
-        expect(ActiveFedora::Base).to receive(:exists?).with(existing_pid).and_return(true)
-      end
-      it 'skips the existing pid' do
-        expect(minter.mint).to eq unique_pid
-      end
-    end
-
-    context 'when the pid already existed in Fedora and now is gone' do
-      let(:gone_pid) { existing_pid }
-      before do
-        expect(ActiveFedora::Base).to receive(:gone?).with(gone_pid).and_return(true)
-      end
-      it 'skips the deleted pid' do
-        expect(minter.mint).to eq unique_pid
-      end
+  describe '#write!' do
+    let(:starting_state) { subject.read }
+    let(:minter) { Noid::Minter.new(starting_state) }
+    before { minter.mint }
+    it 'changes the state of the minter' do
+      expect { subject.write!(minter) }.to change { subject.read[:seq] }
+                                           .from(starting_state[:seq]).to(minter.seq)
+                                       .and change { subject.read[:counters] }
+                                           .from(starting_state[:counters]).to(minter.counters)
+                                       .and change { subject.read[:rand] }
+                                           .from(starting_state[:rand]).to(Marshal.dump(minter.instance_variable_get(:@rand)))
     end
   end
 end

data/spec/unit/file_minter_spec.rb

@@ -0,0 +1,58 @@
+describe ActiveFedora::Noid::Minter::File do
+  before :each do
+    # default novel mintings
+    allow(ActiveFedora::Base).to receive(:exists?).and_return(false)
+    allow(ActiveFedora::Base).to receive(:gone?).and_return(false)
+  end
+
+  it { is_expected.to respond_to(:mint) }
+
+  it 'has a default statefile' do
+    expect(subject.statefile).to eq ActiveFedora::Noid.config.statefile
+  end
+  it 'has a default template' do
+    expect(subject.template.to_s).to eq ActiveFedora::Noid.config.template
+  end
+
+  it_behaves_like 'a minter' do
+    let(:minter) { described_class.new }
+  end
+
+  describe '#initialize' do
+    let(:template) { '.rededk' }
+    let(:statefile) { '/tmp/foobar' }
+
+    subject { described_class.new(template, statefile) }
+
+    it 'respects the custom template' do
+      expect(subject.template.to_s).to eq template
+    end
+    it 'respects the custom statefile' do
+      expect(subject.statefile).to eq statefile
+    end
+  end
+
+  describe '#read' do
+    it 'returns a hash' do
+      expect(subject.read).to be_a(Hash)
+    end
+    it 'has the expected template' do
+      expect(subject.read[:template]).to eq ActiveFedora::Noid.config.template
+    end
+  end
+
+  describe '#write!' do
+    let(:starting_state) { subject.read }
+    let(:minter) { Noid::Minter.new(starting_state) }
+    before { minter.mint }
+    it 'changes the state of the minter' do
+      expect { subject.write!(minter) }.to change { subject.read[:seq] }
+                                           .from(starting_state[:seq]).to(minter.seq)
+                                       .and change { subject.read[:rand] }
+                                           .from(starting_state[:rand]).to(Marshal.dump(minter.instance_variable_get(:@rand)))
+                                       .and change { subject.read[:counters] }
+                                           .to(minter.counters)
+
+    end
+  end
+end

data/spec/unit/noid_spec.rb

@@ -13,5 +13,9 @@ describe ActiveFedora::Noid do
     subject { ActiveFedora::Noid.treeify(id) }
     let(:id) { 'abc123def45' }
     it { is_expected.to eq 'ab/c1/23/de/abc123def45' }
+    context 'with a seven-digit identifier' do
+      let(:id) { 'abc123z' }
+      it { is_expected.to eq 'ab/c1/23/z/abc123z' }
+    end
   end
 end

data/spec/unit/service_spec.rb

@@ -5,7 +5,7 @@ describe ActiveFedora::Noid::Service do
   end
 
   it 'has a default minter' do
-    expect(subject.minter).to be_instance_of ActiveFedora::Noid::SynchronizedMinter
+    expect(subject.minter).to be_instance_of ActiveFedora::Noid::Minter::Db
   end
 
   context 'with a custom minter' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_fedora-noid
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta3
+  version: 2.0.0.beta4
 platform: ruby
 authors:
 - Michael J. Giarlo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.6
+        version: 4.2.7.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.6
+        version: 4.2.7.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 description: Noid identifier services for ActiveFedora-based applications.
 email:
 - leftwing@alumni.rutgers.edu
@@ -152,13 +152,15 @@ files:
 - active_fedora-noid.gemspec
 - app/models/minter_state.rb
 - db/migrate/20160610010003_create_minter_states.rb
+- db/migrate/20161021203429_rename_minter_state_random_to_rand.rb
 - lib/active_fedora/noid.rb
 - lib/active_fedora/noid/config.rb
 - lib/active_fedora/noid/engine.rb
+- lib/active_fedora/noid/minter.rb
 - lib/active_fedora/noid/minter/base.rb
 - lib/active_fedora/noid/minter/db.rb
+- lib/active_fedora/noid/minter/file.rb
 - lib/active_fedora/noid/service.rb
-- lib/active_fedora/noid/synchronized_minter.rb
 - lib/active_fedora/noid/version.rb
 - lib/generators/active_fedora/noid/install_generator.rb
 - lib/generators/active_fedora/noid/seed_generator.rb
@@ -166,12 +168,13 @@ files:
 - spec/models/minter_state_spec.rb
 - spec/spec_helper.rb
 - spec/support/minterstate_table.rb
+- spec/support/shared_examples/minter.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/unit/config_spec.rb
 - spec/unit/db_minter_spec.rb
+- spec/unit/file_minter_spec.rb
 - spec/unit/noid_spec.rb
 - spec/unit/service_spec.rb
-- spec/unit/synchronized_minter_spec.rb
 homepage: https://github.com/projecthydra-labs/active_fedora-noid
 licenses:
 - Apache2
@@ -200,9 +203,10 @@ test_files:
 - spec/models/minter_state_spec.rb
 - spec/spec_helper.rb
 - spec/support/minterstate_table.rb
+- spec/support/shared_examples/minter.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/unit/config_spec.rb
 - spec/unit/db_minter_spec.rb
+- spec/unit/file_minter_spec.rb
 - spec/unit/noid_spec.rb
 - spec/unit/service_spec.rb
-- spec/unit/synchronized_minter_spec.rb

data/lib/active_fedora/noid/synchronized_minter.rb

@@ -1,45 +0,0 @@
-require 'noid'
-
-module ActiveFedora
-  module Noid
-    class SynchronizedMinter < Minter::Base
-      attr_reader :statefile
-
-      def initialize(template = default_template, statefile = default_statefile)
-        super(template)
-        @statefile = statefile
-      end
-
-      protected
-
-      def default_statefile
-        ActiveFedora::Noid.config.statefile
-      end
-
-      def state_for(io_object)
-        Marshal.load(io_object.read)
-      rescue TypeError, ArgumentError
-        { template: template }
-      end
-
-      def next_id
-        id = nil
-        ::File.open(statefile, 'a+b', 0644) do |f|
-          f.flock(::File::LOCK_EX)
-          # Files opened in append mode seek to end of file
-          f.rewind
-          state = state_for(f)
-          state[:template] &&= state[:template].to_s
-          minter = ::Noid::Minter.new(state) # minter w/in the minter, lives only for an instant
-          id = minter.mint
-
-          # Wipe prior contents so the new state can be written from the beginning of the file
-          f.truncate(0)
-          new_state = Marshal.dump(minter.dump)
-          f.write(new_state)
-        end
-        id
-      end
-    end
-  end
-end

data/spec/unit/synchronized_minter_spec.rb

@@ -1,70 +0,0 @@
-describe ActiveFedora::Noid::SynchronizedMinter do
-  before :each do
-    # default novel mintings
-    allow(ActiveFedora::Base).to receive(:exists?).and_return(false)
-    allow(ActiveFedora::Base).to receive(:gone?).and_return(false)
-  end
-
-  let(:minter) { described_class.new }
-
-  it { is_expected.to respond_to(:mint) }
-  it 'has a default statefile' do
-    expect(subject.statefile).to eq ActiveFedora::Noid.config.statefile
-  end
-  it 'has a default template' do
-    expect(subject.template.to_s).to eq ActiveFedora::Noid.config.template
-  end
-
-  describe '#initialize' do
-    let(:template) { '.rededk' }
-    let(:statefile) { '/tmp/foobar' }
-
-    subject { described_class.new(template, statefile) }
-
-    it 'respects the custom template' do
-      expect(subject.template.to_s).to eq template
-    end
-    it 'respects the custom statefile' do
-      expect(subject.statefile).to eq statefile
-    end
-  end
-
-  describe '#mint' do
-    subject { minter.mint }
-    it { is_expected.not_to be_empty }
-    it 'does not mint the same ID twice in a row' do
-      expect(subject).not_to eq described_class.new.mint
-    end
-    it 'is valid' do
-      expect(minter.valid?(subject)).to be true
-      expect(described_class.new.valid?(subject)).to be true
-    end
-  end
-
-  context 'conflicts' do
-    let(:unique_pid) { 'bb22bb22b' }
-    let(:existing_pid) { 'ef12ef12f' }
-    before :each do
-      expect(minter).to receive(:next_id).and_return(existing_pid, unique_pid)
-    end
-
-    context 'when the pid already exists in Fedora' do
-      before do
-        expect(ActiveFedora::Base).to receive(:exists?).with(existing_pid).and_return(true)
-      end
-      it 'skips the existing pid' do
-        expect(minter.mint).to eq unique_pid
-      end
-    end
-
-    context 'when the pid already existed in Fedora and now is gone' do
-      let(:gone_pid) { existing_pid }
-      before do
-        expect(ActiveFedora::Base).to receive(:gone?).with(gone_pid).and_return(true)
-      end
-      it 'skips the deleted pid' do
-        expect(minter.mint).to eq unique_pid
-      end
-    end
-  end
-end