ddr-models 2.6.0.rc1 → 2.6.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edadac3d26e329ebd8cd6ce67e3d92c10e2233da
-  data.tar.gz: 70aefbe23b138eedb961dd6cc24886a3ad4691ed
+  metadata.gz: 2a6aaa85c1cec8d9127e06e4db353d27bff2242f
+  data.tar.gz: d00f7e80d79c688e814ea6f3db6f07acf011cf09
 SHA512:
-  metadata.gz: 73f1a830f3a2763d9a867505260286d5c50836d530551d758b92351339af451c67eb4572f5924501017d271bedbef692a1ff9981469f589c4fe796e187e05bbe
-  data.tar.gz: 1a2541c01cdf459f64ec0b9ee291479f77446b845da398c13038d721c48c69d9a3641a25f83a56ea7f673d555e096f99ff2c1a670705d298dc773b444389c51e
+  metadata.gz: 7a9dbb8d4bc4b4e4ecba17969d8a1dea7f10fc23da40e9002f8abfb86cce07005f461f100ebf3fd9dc70ef1485f40124b028b2df39361ba60d1cb091d481880f
+  data.tar.gz: 28eba8f8e3b45a2b19155e138a7886e97e6884b2296c4d344a9c11d1e1c2e1a01e07f9ab6bae1f2c1353b2073e6953a3fff270ff17505b842d52264a04a83af6

data/config/initializers/subscriptions.rb

@@ -13,10 +13,16 @@ ActiveSupport::Notifications.subscribe(Ddr::Notifications::CREATION, Ddr::Events
 
 # Update
 ActiveSupport::Notifications.subscribe(Ddr::Notifications::UPDATE, Ddr::Events::UpdateEvent)
+ActiveSupport::Notifications.subscribe("assign.permanent_id", Ddr::Events::UpdateEvent)
 
 # Deletion
 ActiveSupport::Notifications.subscribe(Ddr::Notifications::DELETION, Ddr::Events::DeletionEvent)
 ActiveSupport::Notifications.subscribe(/destroy\.\w+/, Ddr::Events::DeletionEvent)
+ActiveSupport::Notifications.subscribe(/destroy\.\w+/, Ddr::Models::PermanentId)
 
 # Deaccession
 ActiveSupport::Notifications.subscribe(/deaccession\.\w+/, Ddr::Events::DeaccessionEvent)
+ActiveSupport::Notifications.subscribe(/deaccession\.\w+/, Ddr::Models::PermanentId)
+
+# Workflow
+ActiveSupport::Notifications.subscribe(/workflow/, Ddr::Models::PermanentId)

data/lib/ddr/models.rb

@@ -63,6 +63,7 @@ module Ddr
     autoload :HasThumbnail
     autoload :Indexing
     autoload :NotFoundError, 'ddr/models/error'
+    autoload :PermanentId
     autoload :SolrDocument
     autoload :StructDiv
     autoload :Structure
@@ -119,6 +120,14 @@ module Ddr
       false
     end
 
+    mattr_accessor :auto_assign_permanent_id do
+      false
+    end
+
+    mattr_accessor :auto_update_permanent_id do
+      false
+    end
+
     # Yields an object with module configuration accessors
     def self.configure
       yield self

data/lib/ddr/models/base.rb

@@ -24,7 +24,7 @@ module Ddr
 
       around_save :notify_save
       around_save :notify_workflow_change, if: [:workflow_state_changed?, :persisted?]
-      after_create :notify_create
+      after_create :assign_permanent_id, if: :assign_permanent_id?
       around_deaccession :notify_deaccession
       around_destroy :notify_destroy
 
@@ -136,11 +136,6 @@ module Ddr
         end
       end
 
-      def notify_create
-        ActiveSupport::Notifications.instrument("create.#{self.class.to_s.underscore}",
-                                                pid: pid)
-      end
-
       def notify_deaccession
         ActiveSupport::Notifications.instrument("deaccession.#{self.class.to_s.underscore}",
                                                 pid: pid,
@@ -157,6 +152,14 @@ module Ddr
         end
       end
 
+      def assign_permanent_id?
+        permanent_id.nil? && Ddr::Models.auto_assign_permanent_id
+      end
+
+      def assign_permanent_id
+        PermanentId.assign!(self)
+      end
+
     end
   end
 end

data/lib/ddr/models/permanent_id.rb

@@ -0,0 +1,263 @@
+require 'ezid-client'
+
+module Ddr::Models
+  class PermanentId
+
+    class Error < Ddr::Models::Error; end
+    class AssignmentFailed < Error; end
+    class RepoObjectNotPersisted < Error; end
+    class AlreadyAssigned < AssignmentFailed; end
+    class IdentifierNotAssigned < Error; end
+    class IdentifierNotFound < Error; end
+
+    PERMANENT_URL_BASE = "https://idn.duke.edu/".freeze
+    DEFAULT_STATUS     = Ezid::Status::RESERVED
+    DEFAULT_EXPORT     = "no".freeze
+    DEFAULT_PROFILE    = "dc".freeze
+    DEFAULT_TARGET     = "https://repository.duke.edu/id/%s"
+    FCREPO3_PID        = "fcrepo3.pid".freeze
+    DELETED            = "deleted".freeze
+    DEACCESSIONED      = "deaccessioned".freeze
+
+    class_attribute :identifier_class, :identifier_repo_id_field
+
+    self.identifier_class = Ezid::Identifier
+    self.identifier_class.defaults = {
+      profile: DEFAULT_PROFILE,
+      export:  DEFAULT_EXPORT,
+      status:  DEFAULT_STATUS,
+    }
+
+    self.identifier_repo_id_field = FCREPO3_PID
+
+    # ActiveSupport::Notifications event handler
+    def self.call(*args)
+      event = ActiveSupport::Notifications::Event.new(*args)
+      repo_id, identifier_id, reason = event.payload.values_at(:pid, :permanent_id, :reason)
+      case event.name
+      when /workflow/
+        update!(repo_id) if auto_update?
+      when /^deaccession/
+        if auto_update? && identifier_id
+          deaccession!(repo_id, identifier_id, reason)
+        end
+      when /^destroy/
+        if auto_update? && identifier_id
+          delete!(repo_id, identifier_id, reason)
+        end
+      end
+    end
+
+    def self.auto_update?
+      Ddr::Models.auto_update_permanent_id
+    end
+
+    def self.deaccession!(repo_object_or_id, identifier_or_id, reason = nil)
+      new(repo_object_or_id, identifier_or_id).deaccession!(reason)
+    end
+
+    def self.delete!(repo_object_or_id, identifier_or_id, reason = nil)
+      new(repo_object_or_id, identifier_or_id).delete!(reason)
+    end
+
+    def self.update!(repo_object_or_id)
+      perm_id = new(repo_object_or_id)
+      perm_id.update! if perm_id.assigned?
+    end
+
+    def self.assign!(repo_object_or_id, identifier_or_id = nil)
+      new(repo_object_or_id, identifier_or_id).assign!
+    end
+
+    def self.assigned(repo_object_or_id)
+      perm_id = new(repo_object_or_id)
+      perm_id.assigned? ? perm_id : nil
+    end
+
+    def initialize(repo_object_or_id, identifier_or_id = nil)
+      case repo_object_or_id
+      when ActiveFedora::Base
+        raise RepoObjectNotPersisted, "Repository object must be persisted." if repo_object_or_id.new_record?
+        @repo_object = repo_object_or_id
+      when String, nil
+        @repo_id = repo_object_or_id
+      else
+        raise TypeError, "#{repo_object_or_id.class} is not expected as the first argument."
+      end
+
+      case identifier_or_id
+      when identifier_class
+        @identifier = identifier_or_id
+      when String, nil
+        @identifier_id = identifier_or_id
+      else
+        raise TypeError, "#{identifier_or_id.class} is not expected as the second argument."
+      end
+    end
+
+    def repo_object
+      @repo_object ||= ActiveFedora::Base.find(repo_id)
+    end
+
+    def repo_id
+      @repo_id ||= @repo_object && @repo_object.id
+    end
+
+    def assign!(id = nil)
+      ActiveSupport::Notifications.instrument("assign.permanent_id", pid: repo_object.id) do |payload|
+        assign(id)
+        software = [ "ddr-models #{Ddr::Models::VERSION}", Ezid::Client.version ].join("; ")
+        detail = <<-EOS
+Permanent ID:  #{repo_object.permanent_id}
+Permanent URL: #{repo_object.permanent_url}
+
+EZID Metadata:
+#{identifier.metadata}
+      EOS
+        payload.merge!(summary: "Permanent ID assignment",
+                       detail: detail,
+                       software: software,
+                       permanent_id: identifier.id)
+      end
+    end
+
+    def assigned?
+      repo_object.permanent_id
+    end
+
+    def update!
+      ActiveSupport::Notifications.instrument("update.permanent_id", pid: repo_object.id) do |payload|
+        update
+        payload.merge!(permanent_id: identifier.id)
+      end
+    end
+
+    def deaccession!(reason = nil)
+      delete_or_make_unavailable(reason || DEACCESSIONED)
+    end
+
+    def delete!(reason = nil)
+      delete_or_make_unavailable(reason || DELETED)
+    end
+
+    def identifier
+      if @identifier.nil?
+        if identifier_id
+          @identifier = find_identifier(identifier_id)
+        elsif assigned?
+          @identifier = find_identifier(repo_object.permanent_id)
+        end
+      end
+      @identifier
+    end
+
+    def identifier_id
+      @identifier_id ||= @identifier && @identifier.id
+    end
+
+    def set_permanent_url
+      repo_object.permanent_url = PERMANENT_URL_BASE + identifier.id
+    end
+
+    def set_metadata!
+      set_metadata
+      save
+      self
+    end
+
+    def set_metadata
+      set_target
+      set_status
+      set_identifier_repo_id
+    end
+
+    def set_target
+      self.target = DEFAULT_TARGET % id
+    end
+
+    def set_identifier_repo_id
+      self.identifier_repo_id = repo_object.id
+    end
+
+    def identifier_repo_id=(val)
+      if identifier_repo_id
+        raise Error, "Identifier repository id already set to \"#{identifier_repo_id}\"; cannot change."
+      end
+      self[identifier_repo_id_field] = val
+    end
+
+    def identifier_repo_id
+      self[identifier_repo_id_field]
+    end
+
+    def set_status!
+      save if set_status
+    end
+
+    def set_status
+      if repo_object.published? && !public?
+        public!
+      elsif repo_object.unpublished? && public?
+        unavailable!("not published")
+      end
+    end
+
+    protected
+
+    def method_missing(name, *args, &block)
+      identifier.send(name, *args, &block)
+    end
+
+    private
+
+    def find_identifier(ark)
+      identifier_class.find(ark)
+    rescue Ezid::IdentifierNotFoundError => e
+      raise IdentifierNotFound, e.message
+    end
+
+    def mint_identifier(*args)
+      identifier_class.mint(*args)
+    end
+
+    def update
+      if !assigned?
+        raise IdentifierNotAssigned,
+              "Cannot update identifier for repository object \"#{repo_object.id}\"; not assigned."
+      end
+      set_status!
+    end
+
+    def assign(id = nil)
+      if assigned?
+        raise AlreadyAssigned,
+              "Repository object \"#{repo_object.id}\" has already been assigned permanent id \"#{repo_object.permanent_id}\"."
+      end
+      @identifier = case id
+                    when identifier_class
+                      id
+                    when String
+                      find_identifier(id)
+                    when nil
+                      mint_identifier
+                    end
+      repo_object.reload
+      repo_object.permanent_id = identifier.id
+      repo_object.permanent_url = PERMANENT_URL_BASE + identifier.id
+      repo_object.save(validate: false)
+      set_metadata!
+    end
+
+    def delete_or_make_unavailable(reason)
+      if repo_id && identifier_repo_id && ( identifier_repo_id != repo_id )
+        raise Error, "Identifier \"#{identifier_id}\" is assigned to a different repository object \"#{repo_id}\"."
+      end
+      if reserved?
+        delete
+      else
+        unavailable!(reason) && save
+      end
+    end
+
+  end
+end

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "2.6.0.rc1"
+    VERSION = "2.6.0.rc2"
   end
 end

data/spec/models/permanent_id_spec.rb

@@ -0,0 +1,440 @@
+module Ddr::Models
+  RSpec.describe PermanentId do
+
+    describe "auto assigment" do
+      let(:obj) { FactoryGirl.create(:item) }
+      describe "when enabled" do
+        let!(:id) { described_class.identifier_class.new("foo") }
+        before do
+          allow(id).to receive(:save) { nil }
+          allow(described_class.identifier_class).to receive(:mint) { id }
+          allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+          allow(Ddr::Models).to receive(:auto_assign_permanent_id) { true }
+        end
+        after do
+          obj.permanent_id = nil
+          obj.save!
+        end
+        it "assigns a permanent id to the object" do
+          obj.reload
+          expect(obj.permanent_id).to eq("foo")
+          expect(obj.permanent_url).to eq("https://idn.duke.edu/foo")
+        end
+      end
+      describe "when disabled" do
+        before do
+          allow(Ddr::Models).to receive(:auto_assign_permanent_id) { false }
+        end
+        it "does not assign a permanent id to the object" do
+          expect(obj.reload.permanent_id).to be_nil
+        end
+      end
+    end
+
+    describe "assignment" do
+      let(:obj) { FactoryGirl.create(:item) }
+      let!(:id) { described_class.identifier_class.new("foo") }
+      before do
+        allow(id).to receive(:save) { nil }
+        allow(described_class.identifier_class).to receive(:mint) { id }
+        allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+      end
+      after do
+        obj.permanent_id = nil
+        obj.save!
+      end
+      it "creates an update event" do
+        expect { described_class.assign!(obj) }.to change(Ddr::Events::UpdateEvent, :count).to(1)
+      end
+    end
+
+    describe "auto updating" do
+      let(:obj) { Item.create(pid: "test:1") }
+      let!(:id) { described_class.identifier_class.new("foo") }
+      before do
+        allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+      end
+      describe "when enabled" do
+        before do
+          allow(Ddr::Models).to receive(:auto_update_permanent_id) { true }
+        end
+        describe "when the object workflow state changes" do
+          describe "and the object has a permanent id" do
+            before do
+              allow(id).to receive(:save) { nil }
+              obj.permanent_id = "foo"
+            end
+            after do
+              obj.permanent_id = nil
+              obj.save!
+            end
+            it "updates the permanent id" do
+              expect { obj.publish! }.to change(id, :status).to("public")
+            end
+          end
+          describe "and the object does not have a permanent id" do
+            it "does not update the permanent id" do
+              expect { obj.publish! }.not_to change(id, :status)
+            end
+          end
+        end
+        describe "when the object workflow state does not change" do
+          it "does not update the permanent id" do
+            expect { obj.save! }.not_to change(id, :status)
+          end
+        end
+      end
+      describe "when disabled" do
+        before do
+          allow(Ddr::Models).to receive(:auto_update_permanent_id) { false }
+        end
+        describe "when the object workflow state changes" do
+          describe "and the object has a permanent id" do
+            before do
+              allow(id).to receive(:save) { nil }
+              obj.permanent_id = "foo"
+            end
+            after do
+              obj.permanent_id = nil
+              obj.save!
+            end
+            it "does not update the permanent id" do
+              expect { obj.publish! }.not_to change(id, :status)
+            end
+          end
+          describe "and the object does not have a permanent id" do
+            it "does not update the permanent id" do
+              expect { obj.publish! }.not_to change(id, :status)
+            end
+          end
+        end
+      end
+    end
+
+    describe "auto deleting / marking unavailable" do
+      describe "when enabled" do
+        before do
+          allow(Ddr::Models).to receive(:auto_update_permanent_id) { true }
+        end
+        describe "when an object has a permanent id" do
+          let(:obj) { Item.create(pid: "test:1", permanent_id: "foo") }
+          let!(:id) { described_class.identifier_class.new("foo") }
+          before do
+            allow(id).to receive(:save) { nil }
+            allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+          end
+          describe "and it's deacessioned" do
+            specify {
+              expect(described_class).to receive(:deaccession!).with("test:1", "foo", nil) { nil }
+              obj.deaccession
+            }
+          end
+          describe "and it's deleted" do
+            specify {
+              expect(described_class).not_to receive(:delete!)
+              expect(described_class).not_to receive(:deaccession!)
+              obj.send(:delete)
+            }
+          end
+          describe "and it's destroyed" do
+            specify {
+              expect(described_class).to receive(:delete!).with("test:1", "foo", nil) { nil }
+              obj.destroy
+            }
+          end
+        end
+        describe "when an object does not have a permanent id" do
+          let(:obj) { FactoryGirl.create(:item) }
+          describe "and it's deacessioned" do
+            specify {
+              expect(described_class).not_to receive(:deaccession!)
+              obj.deaccession
+            }
+          end
+          describe "and it's deleted" do
+            specify {
+              expect(described_class).not_to receive(:deaccession!)
+              expect(described_class).not_to receive(:delete!)
+              obj.send(:delete)
+            }
+          end
+          describe "and it's destroyed" do
+            specify {
+              expect(described_class).not_to receive(:delete!)
+              obj.destroy
+            }
+          end
+        end
+      end
+      describe "when disabled" do
+        before do
+          allow(Ddr::Models).to receive(:auto_update_permanent_id) { false }
+        end
+        describe "when an object has a permanent id" do
+          let(:obj) { Item.create(pid: "test:1", permanent_id: "foo") }
+          let!(:id) { described_class.identifier_class.new("foo") }
+          before do
+            allow(id).to receive(:save) { nil }
+            allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+          end
+          describe "and it's deacessioned" do
+            specify {
+              expect(described_class).not_to receive(:deaccession!)
+              obj.deaccession
+            }
+          end
+          describe "and it's destroyed" do
+            specify {
+              expect(described_class).not_to receive(:delete!)
+              obj.destroy
+            }
+          end
+        end
+      end
+    end
+
+    describe "constructor" do
+      describe "when the object is new" do
+        let(:obj) { FactoryGirl.build(:item) }
+        it "raises an error" do
+          expect { described_class.new(obj) }.to raise_error(PermanentId::RepoObjectNotPersisted)
+        end
+      end
+      describe "when passed a repo object id" do
+        let(:obj) { FactoryGirl.create(:item) }
+        subject { described_class.new(obj.id) }
+        its(:repo_id) { is_expected.to eq(obj.id) }
+      end
+    end
+
+    describe "instance methods" do
+      let(:obj) { FactoryGirl.create(:item) }
+      subject { described_class.new(obj) }
+
+      describe "#assign!" do
+        describe "when the object already has a permanent identifier" do
+          before { obj.permanent_id = "foo" }
+          it "raises an error" do
+            expect { subject.assign! }.to raise_error(PermanentId::AlreadyAssigned)
+            expect { subject.assign!("bar") }.to raise_error(PermanentId::AlreadyAssigned)
+          end
+        end
+        describe "when the object does not have a permanent identifier" do
+          let(:obj) { FactoryGirl.create(:item) }
+          let!(:id) { described_class.identifier_class.new("foo") }
+          before do
+            allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+            allow(id).to receive(:save) { nil }
+            allow(obj).to receive(:save) { true }
+          end
+          describe "when passed an ARK" do
+            before do
+              subject.assign!("foo")
+            end
+            it "assigns the ARK" do
+              expect(obj.permanent_id).to eq("foo")
+            end
+            it "sets the target on the identifier" do
+              expect(id.target).to eq("https://repository.duke.edu/id/foo")
+            end
+            it "sets the status on the identifier" do
+              expect(id.status).to eq("reserved")
+            end
+            it "sets the repository id on the identifier" do
+              expect(id["fcrepo3.pid"]).to eq(obj.id)
+            end
+          end
+          describe "when not passed an ARK" do
+            before do
+              subject.assign!("foo")
+              allow(described_class.identifier_class).to receive(:mint) { id }
+            end
+            it "mints and assigns an ARK" do
+              expect(obj.permanent_id).to eq("foo")
+            end
+            it "sets the target on the identifier" do
+              expect(id.target).to eq("https://repository.duke.edu/id/foo")
+            end
+            it "sets the status on the identifier" do
+              expect(id.status).to eq("reserved")
+            end
+            it "sets the repository id on the identifier" do
+              expect(id["fcrepo3.pid"]).to eq(obj.id)
+            end
+          end
+        end
+      end
+
+      describe "#update!" do
+        describe "when the object has not been assigned a permanent id" do
+          it "raises an error" do
+            expect { subject.update! }.to raise_error(PermanentId::IdentifierNotAssigned)
+          end
+        end
+        describe "when the object has been assigned a permanent id" do
+          let!(:id) { described_class.identifier_class.new("foo") }
+          before do
+            allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+            obj.permanent_id = "foo"
+          end
+          it "sets the status on the permanent id" do
+            expect(subject).to receive(:set_status!) { nil }
+            subject.update!
+          end
+        end
+      end
+
+      describe "#deaccession!" do
+        let!(:id) { described_class.identifier_class.new("foo") }
+        subject { described_class.new("test:1", "foo") }
+        before do
+          allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+          allow(id).to receive(:save) { nil }
+        end
+        specify {
+          expect(id).to receive(:delete)
+          subject.deaccession!
+        }
+        describe " when the identifier is not reserved" do
+          before { id.public! }
+          specify {
+            expect { subject.deaccession! }.to change(id, :status).to("unavailable | deaccessioned")
+          }
+        end
+        describe "when the identifier is associated with another repo id" do
+          before { subject.identifier_repo_id = "test:2" }
+          specify {
+            expect { subject.deaccession! }.to raise_error(PermanentId::Error)
+          }
+        end
+      end
+
+      describe "#delete!" do
+        let!(:id) { described_class.identifier_class.new("foo") }
+        subject { described_class.new("test:1", "foo") }
+        before do
+          allow(described_class.identifier_class).to receive(:find).with("foo") { id }
+        end
+        specify {
+          expect(id).to receive(:delete)
+          subject.delete!
+        }
+        describe " when the identifier is not reserved" do
+          before do
+            allow(id).to receive(:save) { nil }
+            id.public!
+          end
+          specify {
+            expect { subject.delete! }.to change(id, :status).to("unavailable | deleted")
+          }
+        end
+        describe "when the identifier is associated with another repo id" do
+          before { subject.identifier_repo_id = "test:2" }
+          specify {
+            expect { subject.delete! }.to raise_error(PermanentId::Error)
+          }
+        end
+      end
+
+      describe "identifier metadata" do
+        let(:obj) { Item.create(pid: "test:1") }
+        let!(:id) { described_class.identifier_class.new("foo") }
+        subject { described_class.new(obj) }
+        before do
+          allow(subject).to receive(:identifier) { id }
+        end
+        describe "#identifier_repo_id" do
+          before do
+            id["fcrepo3.pid"] = "test:1"
+          end
+          its(:identifier_repo_id) { is_expected.to eq("test:1") }
+        end
+        describe "#identifier_repo_id=" do
+          specify {
+            subject.identifier_repo_id = "test:1"
+            expect(id["fcrepo3.pid"]).to eq("test:1")
+          }
+          describe "when a value was previously assigned" do
+            before { subject.identifier_repo_id = "test:1" }
+            specify {
+              expect { subject.identifier_repo_id = "test:2" }.to raise_error(PermanentId::Error)
+            }
+          end
+        end
+        describe "#set_identifier_repo_id" do
+          specify {
+            subject.set_identifier_repo_id
+            expect(subject.identifier_repo_id).to eq("test:1")
+          }
+        end
+        describe "#set_target" do
+          specify {
+            subject.set_target
+            expect(subject.target).to eq("https://repository.duke.edu/id/foo")
+          }
+        end
+        describe "#set_status" do
+          describe "when object is published" do
+            before { obj.workflow_state = "published" }
+            describe "and identifier is public" do
+              before { subject.public! }
+              it "does not change" do
+                expect { subject.set_status }.not_to change(subject, :status)
+              end
+            end
+            describe "and identifier is reserved" do
+              it "changes to public" do
+                expect { subject.set_status }.to change(subject, :status).to("public")
+              end
+            end
+            describe "and identifier is unavailable" do
+              before { subject.unavailable! }
+              it "changes to public" do
+                expect { subject.set_status }.to change(subject, :status).to("public")
+              end
+            end
+          end
+          describe "when object is unpublished" do
+            before { obj.workflow_state = "unpublished" }
+            describe "and identifier is public" do
+              before { subject.public! }
+              it "changes to unavailable" do
+                expect { subject.set_status }.to change(subject, :status).to("unavailable | not published")
+              end
+            end
+            describe "and identifier is reserved" do
+              it "does not change" do
+                expect { subject.set_status }.not_to change(subject, :status)
+              end
+            end
+            describe "and identifier is unavailable" do
+              before { subject.unavailable! }
+              it "does not change" do
+                expect { subject.set_status }.not_to change(subject, :status)
+              end
+            end
+          end
+          describe "when object has no workflow state" do
+            describe "and identifier is public" do
+              before { subject.public! }
+              it "does not change" do
+                expect { subject.set_status }.not_to change(subject, :status)
+              end
+            end
+            describe "and identifier is reserved" do
+              it "does not change" do
+                expect { subject.set_status }.not_to change(subject, :status)
+              end
+            end
+            describe "and identifier is unavailable" do
+              before { subject.unavailable! }
+              it "does not change" do
+                expect { subject.set_status }.not_to change(subject, :status)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/shared_examples_for_ddr_models.rb

@@ -6,6 +6,36 @@ RSpec.shared_examples "a DDR model" do
   it_behaves_like "an object that has a display title"
   it_behaves_like "an object that has identifiers"
 
+  describe "permanent ID assignment" do
+    describe "when auto assignment is enabled" do
+      before do
+        allow(Ddr::Models).to receive(:auto_assign_permanent_id) { true }
+      end
+      describe "and a permanent ID is pre-assigned" do
+        before do
+          subject.permanent_id = "foo"
+        end
+        it "does not assign a permanent ID" do
+          expect { subject.save(validate: false) }.not_to change(subject, :permanent_id)
+        end
+      end
+      describe "and no permanent ID has been pre-assigned" do
+        before do
+          expect(Ddr::Models::PermanentId).to receive(:assign!).with(subject) { nil }
+          subject.save(validate: false)
+        end
+      end
+    end
+    describe "when auto assignment is disabled" do
+      before do
+        allow(Ddr::Models).to receive(:auto_assign_permanent_id) { false }
+      end
+      it "does not assign a permanent ID" do
+        expect { subject.save(validate: false) }.not_to change(subject, :permanent_id)
+      end
+    end
+  end
+
   describe "notification on save" do
     let(:events) { [] }
     before {
@@ -30,26 +60,6 @@ RSpec.shared_examples "a DDR model" do
     end
   end
 
-  describe "notification on create" do
-    let(:events) { [] }
-    before {
-      @subscriber = ActiveSupport::Notifications.subscribe("create.#{described_class.to_s.underscore}") do |name, start, finish, id, payload|
-        events << payload
-      end
-    }
-    after {
-      ActiveSupport::Notifications.unsubscribe(@subscriber)
-    }
-    it "happens after create" do
-      subject.title = [ "My Title Changed" ]
-      subject.save
-      subject.title = [ "My Title Changed Again" ]
-      subject.save
-      expect(events.size).to eq(1)
-      expect(events.first[:pid]).to eq(subject.pid)
-    end
-  end
-
   describe "notification on workflow state change" do
     let(:events) { [] }
     before {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddr-models
 version: !ruby/object:Gem::Version
-  version: 2.6.0.rc1
+  version: 2.6.0.rc2
 platform: ruby
 authors:
 - Jim Coble
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -552,6 +552,7 @@ files:
 - lib/ddr/models/licenses/inherited_license.rb
 - lib/ddr/models/licenses/license.rb
 - lib/ddr/models/licenses/parent_license.rb
+- lib/ddr/models/permanent_id.rb
 - lib/ddr/models/solr_document.rb
 - lib/ddr/models/struct_div.rb
 - lib/ddr/models/structure.rb
@@ -697,6 +698,7 @@ files:
 - spec/models/indexing_spec.rb
 - spec/models/item_spec.rb
 - spec/models/license_spec.rb
+- spec/models/permanent_id_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/models/struct_div_spec.rb
 - spec/models/structure_spec.rb
@@ -874,6 +876,7 @@ test_files:
 - spec/models/indexing_spec.rb
 - spec/models/item_spec.rb
 - spec/models/license_spec.rb
+- spec/models/permanent_id_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/models/struct_div_spec.rb
 - spec/models/structure_spec.rb