active_fedora-noid 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77f3bb9f61240306a75e00c8c4fc7d4c314110d7
-  data.tar.gz: 5310a81c3a8b3573d9dd756263de8a5ada773f47
+  metadata.gz: e58687a86fa490783729234d0a1db375c494faed
+  data.tar.gz: c37de3f330b5cc4c0a0f429ff1c6225422d5f4e4
 SHA512:
-  metadata.gz: a95ae3bae159006fdf2c89257b939693a77f92a7ee1c3e948e05164e703d7757219bb8a4d95557c74d87c0cb498f3605053398669dbb6886a8cf9fe6c1e1a88c
-  data.tar.gz: e9b5e44da2b1d277891aa75b6e0f3b353e740da925ab53a67f144032ac88995b2d65be96204f70414b6d303e05c72bc3ef02ca590d371da0bd7a0fb3b718170d
+  metadata.gz: 7454c2ca35895fbb2adebeddde58876e910e885705a633ffc322397c7b2d80dc3e48978b5cd9c10c85954f4c43d6c4b05441b7bee71f0de98c3d414567764206
+  data.tar.gz: 29039bd1d5da0854797832c3761f5ccbe1aebc46922625c27c9167b213d764c1c8bf4b244369eca286e6c83de3fa34bea62d7d1d68cf359e3fb52b4f8b0fa46f

data/README.md

@@ -99,7 +99,7 @@ This will make sure your objects have Noid-like identifiers (e.g. `bb22bb22b`) t
 
 ## Overriding default behavior
 
-The default minter in ActiveFedora::Noid 2.0.0 is the file-backed minter to preserve default behavior.
+The default minter in ActiveFedora::Noid 2.x is the file-backed minter to preserve default behavior.
 
 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), we highly recommend swapping in the database-backed minter.
 
@@ -111,7 +111,11 @@ The database-based minter stores minter state information in your application's
 $ rails generate active_fedora:noid:install
 ```
 
-This will create the necessary database tables and seed the database minter. To start minting identifiers with the new minter, override the AF::Noid configuration in e.g. `config/initializers/active_fedora-noid.rb`:
+This will create the necessary database migrations.
+
+Then run `rake db:migrate`
+
+To start minting identifiers with the new minter, override the AF::Noid configuration in e.g. `config/initializers/active_fedora-noid.rb`:
 
 ```ruby
 require 'active_fedora/noid'
@@ -134,7 +138,7 @@ RSpec.configure do |config|
 end
 ```
 
-If you switch to the new database-backed minter and want to include in that minter the state of your current file-backed minter, AF::Noid 2.0.0 provides a new rake task that will copy your minter's state from the filesystem to the database:
+If you switch to the new database-backed minter and want to include in that minter the state of your current file-backed minter, AF::Noid 2.x provides a new rake task that will copy your minter's state from the filesystem to the database:
 
 ```bash
 # For migrating minter state from a file to a database

data/active_fedora-noid.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rails', '>= 4.2.7.1', '< 6'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'rake', '>= 11'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'rubocop', '~> 0.42.0'

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

@@ -8,15 +8,13 @@ module ActiveFedora
       class Base < ::Noid::Minter
         ##
         # @param template [#to_s] a NOID template
-        #
         # @see Noid::Template
         def initialize(template = default_template)
           super(template: template.to_s)
         end
 
         ##
-        # Sychronously mint a new identifier. Guarantees the ID is not
-        # already reserved in ActiveFedora.
+        # Sychronously mint a new identifier. Guarantees the ID is not already reserved in ActiveFedora.
         #
         # @return [String] the minted identifier
         def mint
@@ -29,7 +27,7 @@ module ActiveFedora
         end
 
         ##
-        # @return [Hash] an object representing the current minter state
+        # @return [Hash{Symbol => String, Object}] representation of the current minter state
         def read
           raise NotImplementedError, 'Implement #read in child class'
         end
@@ -38,7 +36,6 @@ module ActiveFedora
         # Updates the minter state to that of the `minter` parameter.
         #
         # @param minter [Minter::Base]
-        #
         # @return [void]
         def write!(_)
           raise NotImplementedError, 'Implement #write! in child class'
@@ -53,7 +50,7 @@ module ActiveFedora
         end
 
         ##
-        # @return [String] a new identifier.
+        # @return [String] a new identifier
         def next_id
           raise NotImplementedError, 'Implement #next_id in child class'
         end

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

@@ -6,27 +6,40 @@ module ActiveFedora
     module Minter
       class Db < Base
         def read
-          filtered_hash = instance.as_json.select { |key| %w(template counters seq rand namespace).include?(key) }
+          deserialize(instance)
+        end
+
+        def write!(minter)
+          serialize(instance, minter)
+        end
+
+        protected
+
+        # @param [MinterState] inst minter state to be converted
+        # @return [Hash{Symbol => String, Object}] minter state as a Hash, like #read
+        # @see #read, ActiveFedora::Noid::Minter::Base#read
+        def deserialize(inst)
+          filtered_hash = inst.as_json.slice(*%w(template counters seq rand namespace))
           filtered_hash['counters'] = JSON.parse(filtered_hash['counters'], symbolize_names: true) if filtered_hash['counters']
           filtered_hash.symbolize_keys
         end
 
-        def write!(minter)
+        # @param [MinterState] inst a locked row/object to be updated
+        # @param [::Noid::Minter] minter state containing the updates
+        def serialize(inst, minter)
           # namespace and template are the same, now update the other attributes
-          instance.update_attributes!(
+          inst.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.
         # Should be fast enough to avoid terrible deadlock.
         # Must lock because of multi-connection context! (transaction is per connection -- not enough)
         # The DB table will only ever have at most one row per namespace.
-        # The 'default' namespace row is inserted by `rails generate active_fedora:noid:seed`.
+        # The 'default' namespace row is inserted by `rails generate active_fedora:noid:seed` or autofilled by instance below.
         # If you want another namespace, edit your config initialzer to something like:
         #     ActiveFedora::Noid.config.namespace = 'druid'
         #     ActiveFedora::Noid.config.template = '.reeedek'
@@ -35,14 +48,15 @@ module ActiveFedora
         def next_id
           id = nil
           MinterState.transaction do
-            state = read
-            minter = ::Noid::Minter.new(state)
+            locked = instance
+            minter = ::Noid::Minter.new(deserialize(locked))
             id = minter.mint
-            write!(minter)
+            serialize(locked, minter)
           end # transaction
           id
         end
 
+        # @return [MinterState]
         def instance
           MinterState.lock.find_by!(
             namespace: ActiveFedora::Noid.config.namespace,

data/lib/active_fedora/noid/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module ActiveFedora
   module Noid
-    VERSION = '2.0.1'
+    VERSION = '2.0.2'
   end
 end

data/lib/generators/active_fedora/noid/install_generator.rb

@@ -14,11 +14,6 @@ Copies DB migrations
 
       def migrations
         rake 'active_fedora_noid_engine:install:migrations'
-        rake 'db:migrate'
-      end
-
-      def seed
-        generate 'active_fedora:noid:seed'
       end
     end
   end

data/spec/spec_helper.rb

@@ -20,4 +20,5 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
+  config.filter_run_when_matching :focus
 end

data/spec/support/shared_examples/minter.rb

@@ -14,14 +14,9 @@ shared_examples 'a minter' do
       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
-
     context 'with a different template' do
-      let(:other) { described_class.new('.reedddk') }
-      it 'is invalid under a different template' do
-        expect(other).not_to be_valid(minter.mint)
+      it 'is invalid' do
+        expect(described_class.new('.reedddk').valid?(subject)).to be false
       end
     end
   end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -10,5 +10,6 @@ class TestAppGenerator < Rails::Generators::Base
 
   def install_engine
     generate 'active_fedora:noid:install'
+    rake 'db:migrate'
   end
 end

data/spec/unit/db_minter_spec.rb

@@ -64,13 +64,23 @@ describe ActiveFedora::Noid::Minter::Db do
     let(:starting_state) { db_minter.read }
     let(:minter) { Noid::Minter.new(starting_state) }
     before { minter.mint }
+
     it 'changes the state of the minter' do
-      expect { db_minter.write!(minter) }.to change { db_minter.read[:seq] }
-        .from(starting_state[:seq]).to(minter.seq)
-        .and change { db_minter.read[:counters] }
-        .from(starting_state[:counters]).to(minter.counters)
-        .and change { db_minter.read[:rand] }
-        .from(starting_state[:rand]).to(Marshal.dump(minter.instance_variable_get(:@rand)))
+      expect { db_minter.write!(minter) }
+        .to  change { db_minter.read[:seq]      }.from(starting_state[:seq]).to(minter.seq)
+        .and change { db_minter.read[:counters] }.from(starting_state[:counters]).to(minter.counters)
+        .and change { db_minter.read[:rand]     }.from(starting_state[:rand]).to(Marshal.dump(minter.instance_variable_get(:@rand)))
+    end
+  end
+
+  describe '#next_id' do
+    let(:stub_minter) { described_class.new }
+    let(:locked) { MinterState }
+
+    it 'locks DB row and does not query twice' do
+      expect(MinterState).to receive(:lock).and_return(locked).once
+      expect(locked).to receive(:find_by!).once.and_return(MinterState.first)
+      stub_minter.send(:next_id)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_fedora-noid
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Michael J. Giarlo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -82,16 +82,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -227,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Noid identifier services for ActiveFedora-based applications