ddr-models 2.4.16 → 2.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f83d8acaf696ecb6e92b5958efd1d09c9727acf1
-  data.tar.gz: d6af219cbb3395901762d0eb5f4a1f60c6b2ce0e
+  metadata.gz: 9d6faf41cfbc69e87be3083dede83f8d226253ae
+  data.tar.gz: 98a2c8e8eda939beae492194807dbd0dcc824f0c
 SHA512:
-  metadata.gz: 76e0f78041619d77258e3877f2dc587cb204e18c75b1be5e85ab7c883ac45ec5dec92cbfc2ab8d77306677d300bb831e2e1ce5dfa7e0e67a41d3f1adeb4a8963
-  data.tar.gz: 4f6c466ac5ed669cd23babebff7ef3b7cb2a0f62c957b02e6967121f6b75f950e62b77440994cfc7ffc942690be7b5558f0d119f9ffa0747404d5d72517479c3
+  metadata.gz: 9785835818f8ab3080c894fcd96a24d6ae812072ca595f09f75e521a257a6f350c6d65d6fc9bc6c0d84a7e1fc4a4dddaf66307e6ef983f51fe1013b4f759fff8
+  data.tar.gz: 00aeccc3b05dbce09364f94310e82adf1a0de9a63ea0b708bc0b3e0e591d7e3849febac22b7142cf064d650a33c9d646310852f79a87b6b221761f22a9d4563b

data/config/initializers/subscriptions.rb

@@ -16,3 +16,9 @@ ActiveSupport::Notifications.subscribe(Ddr::Notifications::UPDATE, Ddr::Events::
 
 # Deletion
 ActiveSupport::Notifications.subscribe(Ddr::Notifications::DELETION, Ddr::Events::DeletionEvent)
+ActiveSupport::Notifications.subscribe(/destroy\.\w+/, Ddr::Events::DeletionEvent)
+ActiveSupport::Notifications.subscribe(/destroy\.\w+/, Ddr::Jobs::PermanentId::MakeUnavailable)
+
+# Deaccession
+ActiveSupport::Notifications.subscribe(/deaccession\.\w+/, Ddr::Events::DeaccessionEvent)
+ActiveSupport::Notifications.subscribe(/deaccession\.\w+/, Ddr::Jobs::PermanentId::MakeUnavailable)

data/db/migrate/20161021201011_add_permanent_id_to_events.rb

@@ -0,0 +1,8 @@
+class AddPermanentIdToEvents < ActiveRecord::Migration
+  def change
+    change_table :events do |t|
+      t.string :permanent_id
+      t.index :permanent_id
+    end
+  end
+end

data/lib/ddr/datastreams/fits_datastream.rb

@@ -36,6 +36,8 @@ module Ddr::Datastreams
           t.imageWidth
           t.imageHeight
           t.colorSpace
+          t.iccProfileName
+          t.iccProfileVersion
         }
         t.document {
           # TODO - configure to get from Tika?
@@ -63,6 +65,8 @@ module Ddr::Datastreams
       t.image_width          proxy: [:metadata, :image, :imageWidth]
       t.image_height         proxy: [:metadata, :image, :imageHeight]
       t.color_space          proxy: [:metadata, :image, :colorSpace]
+      t.icc_profile_name     proxy: [:metadata, :image, :iccProfileName]
+      t.icc_profile_version  proxy: [:metadata, :image, :iccProfileVersion]
     end
 
     def self.xml_template

data/lib/ddr/events.rb

@@ -4,6 +4,7 @@ module Ddr
 
     autoload :Event
     autoload :CreationEvent
+    autoload :DeaccessionEvent
     autoload :DeletionEvent
     autoload :FixityCheckEvent
     autoload :IngestionEvent

data/lib/ddr/events/deaccession_event.rb

@@ -0,0 +1,8 @@
+module Ddr::Events
+  class DeaccessionEvent < Event
+    include PreservationEventBehavior
+
+    self.description = "Object deaccessioned"
+    self.preservation_event_type = :dea
+  end
+end

data/lib/ddr/index/fields.rb

@@ -8,13 +8,17 @@ module Ddr::Index
     ACTIVE_FEDORA_MODEL         = Field.new :active_fedora_model, :stored_sortable
     ADMIN_SET                   = Field.new :admin_set, :stored_sortable
     ADMIN_SET_FACET             = Field.new :admin_set_facet, :facetable
+    ADMIN_SET_TITLE             = Field.new :admin_set_title, :stored_sortable
     ALL_TEXT                    = Field.new :all_text, solr_name: "all_text_timv"
     ASPACE_ID                   = Field.new :aspace_id, :stored_sortable
     ATTACHED_FILES_HAVING_CONTENT =
       Field.new :attached_files_having_content, :symbol
     BOX_NUMBER_FACET            = Field.new :box_number_facet, :facetable
+    CATEGORY_FACET              = Field.new :category_facet, :facetable
     COLLECTION_FACET            = Field.new :collection_facet, :facetable
+    COLLECTION_TITLE            = Field.new :collection_title, :stored_sortable
     COLLECTION_URI              = Field.new :collection_uri, :symbol
+    COMPANY_FACET               = Field.new :company_facet, :facetable
     CONTENT_CONTROL_GROUP       = Field.new :content_control_group, :searchable, type: :string
     CONTENT_CREATE_DATE         = Field.new :content_create_date, :stored_sortable, type: :date
     CONTENT_SIZE                = Field.new :content_size, solr_name: "content_size_lsi"
@@ -28,6 +32,7 @@ module Ddr::Index
     DOI                         = Field.new :doi, :symbol
     EAD_ID                      = Field.new :ead_id, :stored_sortable
     EXTRACTED_TEXT              = Field.new :extracted_text, solr_name: "extracted_text_tsm"
+    FOLDER_FACET                = Field.new :folder_facet, :facetable
     FORMAT_FACET                = Field.new :format_facet, :facetable
     HAS_MODEL                   = Field.new :has_model, :symbol
     IDENTIFIER_ALL              = Field.new :identifier_all, :symbol
@@ -48,6 +53,7 @@ module Ddr::Index
     MEDIA_SUB_TYPE              = Field.new :content_media_sub_type, :facetable
     MEDIA_MAJOR_TYPE            = Field.new :content_media_major_type, :facetable
     MEDIA_TYPE                  = Field.new :content_media_type, :symbol
+    MEDIUM_FACET                = Field.new :medium_facet, :facetable
     MULTIRES_IMAGE_FILE_PATH    = Field.new :multires_image_file_path, :stored_sortable
     OBJECT_PROFILE              = Field.new :object_profile, :displayable
     OBJECT_STATE                = Field.new :object_state, :stored_sortable
@@ -55,11 +61,15 @@ module Ddr::Index
     OBJECT_MODIFIED_DATE        = Field.new :system_modified, :stored_sortable, type: :date
     PERMANENT_ID                = Field.new :permanent_id, :stored_sortable, type: :string
     PERMANENT_URL               = Field.new :permanent_url, :stored_sortable, type: :string
+    PLACEMENT_COMPANY_FACET     = Field.new :placement_company_facet, :facetable
     POLICY_ROLE                 = Field.new :policy_role, :symbol
+    PRODUCT_FACET               = Field.new :product_facet, :facetable
+    PUBLICATION_FACET           = Field.new :publication_facet, :facetable
     PUBLISHER_FACET             = Field.new :publisher_facet, :facetable
     RESEARCH_HELP_CONTACT       = Field.new :research_help_contact, :stored_sortable
     RESOURCE_ROLE               = Field.new :resource_role, :symbol
     SERIES_FACET                = Field.new :series_facet, :facetable
+    SETTING_FACET               = Field.new :setting_facet, :facetable
     SPATIAL_FACET               = Field.new :spatial_facet, :facetable
     STRUCT_MAPS                 = Field.new :struct_maps, :stored_sortable
     SUBJECT_FACET               = Field.new :subject_facet, :facetable
@@ -71,6 +81,8 @@ module Ddr::Index
     TECHMD_FITS_DATETIME        = Field.new :techmd_fits_datetime, :stored_sortable, type: :date
     TECHMD_FORMAT_LABEL         = Field.new :techmd_format_label, :symbol
     TECHMD_FORMAT_VERSION       = Field.new :techmd_format_version, :symbol
+    TECHMD_ICC_PROFILE_NAME     = Field.new :techmd_icc_profile_name, :symbol
+    TECHMD_ICC_PROFILE_VERSION  = Field.new :techmd_icc_profile_version, :symbol
     TECHMD_IMAGE_HEIGHT         = Field.new :techmd_image_height, :stored_searchable, type: :integer
     TECHMD_IMAGE_WIDTH          = Field.new :techmd_image_width, :stored_searchable, type: :integer
     TECHMD_MEDIA_TYPE           = Field.new :techmd_media_type, :symbol
@@ -79,6 +91,7 @@ module Ddr::Index
     TECHMD_VALID                = Field.new :techmd_valid, :symbol
     TECHMD_WELL_FORMED          = Field.new :techmd_well_formed, :symbol
     TITLE                       = Field.new :title, :stored_sortable
+    TONE_FACET                  = Field.new :tone_facet, :facetable
     TYPE_FACET                  = Field.new :type_facet, :facetable
     WORKFLOW_STATE              = Field.new :workflow_state, :stored_sortable
     YEAR_FACET                  = Field.new :year_facet, solr_name: "year_facet_iim"
@@ -105,8 +118,9 @@ module Ddr::Index
         return ID
       end
       if const = LegacyLicenseFields.const_get(name)
-        Deprecation.warn(Ddr::Index::Fields,
-                         "`Ddr::Index::Fields::#{name}` is deprecated and will be removed in ddr-models 3.0.")
+        # XXX Commented out b/c annoying, but maybe we want later ...
+        # Deprecation.warn(Ddr::Index::Fields,
+        #                  "`Ddr::Index::Fields::#{name}` is deprecated and will be removed in ddr-models 3.0.")
         return const
       end
       super

data/lib/ddr/jobs/permanent_id.rb

@@ -11,6 +11,18 @@ module Ddr
       end
 
       class MakeUnavailable < Job
+        def self.call(*args)
+          event = ActiveSupport::Notifications::Event.new(*args)
+          id = event.payload[:permanent_id]
+          reason = case event.name.split(".").first
+                   when "destroy"
+                     "deleted"
+                   when "deaccession"
+                     "deaccessioned"
+                   end
+          Resque.enqueue(self, id, reason) if id.present?
+        end
+
         def self.perform(id, reason = nil)
           identifier = Ezid::Identifier.find(id)
           identifier.unavailable!(reason)

data/lib/ddr/managers/technical_metadata_manager.rb

@@ -9,6 +9,7 @@ module Ddr::Managers
              :media_type, :format_label, :format_version, :pronom_identifier,
              :created, :modified, :creating_application, :extent,
              :image_width, :image_height, :color_space,
+             :icc_profile_name, :icc_profile_version,
              to: :fits
 
     alias_method :last_modified, :modified
@@ -81,6 +82,8 @@ module Ddr::Managers
         Ddr::Index::Fields::TECHMD_FILE_SIZE         => file_size,
         Ddr::Index::Fields::TECHMD_FORMAT_LABEL      => format_label,
         Ddr::Index::Fields::TECHMD_FORMAT_VERSION    => format_version,
+        Ddr::Index::Fields::TECHMD_ICC_PROFILE_NAME  => icc_profile_name,
+        Ddr::Index::Fields::TECHMD_ICC_PROFILE_VERSION => icc_profile_version,
         Ddr::Index::Fields::TECHMD_IMAGE_HEIGHT      => image_height,
         Ddr::Index::Fields::TECHMD_IMAGE_WIDTH       => image_width,
         Ddr::Index::Fields::TECHMD_MEDIA_TYPE        => media_type,

data/lib/ddr/managers/workflow_manager.rb

@@ -9,22 +9,35 @@ module Ddr
         object.workflow_state == PUBLISHED
       end
 
-      def publish
-        object.workflow_state = PUBLISHED
+
+      def publish!(include_descendants: true)
+        unless published?
+          publish
+          object.save!
+        end
+        if include_descendants && object.respond_to?(:children)
+          object.children.each { |child| child.publish!(include_descendants: include_descendants) }
+        end
       end
 
-      def publish!
-        publish
-        object.save
+      def unpublish!
+        if published?
+          unpublish
+          object.save!
+        end
+        if object.respond_to?(:children)
+          object.children.each { |child| child.unpublish! }
+        end
       end
 
-      def unpublish
-        object.workflow_state = UNPUBLISHED
+      private
+
+      def publish
+        object.workflow_state = PUBLISHED
       end
 
-      def unpublish!
-        unpublish
-        object.save
+      def unpublish
+        object.workflow_state = UNPUBLISHED
       end
 
     end

data/lib/ddr/models/admin_set.rb

@@ -6,13 +6,16 @@ module Ddr::Models
     self.site = ENV["DDR_AUX_API_URL"]
 
     def self.call(obj)
-      if obj.admin_set
-        new get(:find, code: obj.admin_set)
-      end
+      find_by_code(obj.admin_set)
     rescue ActiveResource::ResourceNotFound => e
       raise Ddr::Models::NotFoundError, e
     end
 
+    def self.find_by_code(code)
+      return unless code
+      new get(:find, code: code)
+    end
+
     def self.keys
       all.map(&:code)
     end

data/lib/ddr/models/base.rb

@@ -13,12 +13,23 @@ module Ddr
       include Hydra::Validations
       include HasAdminMetadata
 
+      # Prevent accidental use of #delete which lacks callbacks
+      private :delete
+
+      define_model_callbacks :deaccession, only: :around
+
       extend Deprecation
       # Deprecate Hydra permissions-related methods
       deprecation_deprecate *(Hydra::AccessControls::Permissions.public_instance_methods)
 
-      after_destroy do
-        notify_event :deletion
+      around_save :notify_save
+      around_deaccession :notify_deaccession
+      around_destroy :notify_destroy
+
+      def deaccession
+        run_callbacks :deaccession do
+          delete
+        end
       end
 
       def copy_admin_policy_or_permissions_from(other)
@@ -106,6 +117,33 @@ module Ddr
         raise NotImplementedError, "Must be implemented by subclasses"
       end
 
+      private
+
+      def notify_save
+        ActiveSupport::Notifications.instrument("save.#{self.class.to_s.underscore}",
+                                                pid: pid,
+                                                changes: changes,
+                                                created: new_record?) do |payload|
+          yield
+        end
+      end
+
+      def notify_deaccession
+        ActiveSupport::Notifications.instrument("deaccession.#{self.class.to_s.underscore}",
+                                                pid: pid,
+                                                permanent_id: permanent_id) do |payload|
+          yield
+        end
+      end
+
+      def notify_destroy
+        ActiveSupport::Notifications.instrument("destroy.#{self.class.to_s.underscore}",
+                                                pid: pid,
+                                                permanent_id: permanent_id) do |payload|
+          yield
+        end
+      end
+
     end
   end
 end

data/lib/ddr/models/has_admin_metadata.rb

@@ -28,7 +28,6 @@ module Ddr::Models
       delegate :publish!, :unpublish!, :published?, to: :workflow
 
       after_create :assign_permanent_id!, if: "Ddr::Models.auto_assign_permanent_ids"
-      around_destroy :update_permanent_id_on_destroy, if: "permanent_id.present?"
     end
 
     def permanent_id_manager

data/lib/ddr/models/indexing.rb

@@ -17,41 +17,52 @@ module Ddr
 
       def index_fields
         fields = {
-          ACCESS_ROLE           => roles.to_json,
-          ADMIN_SET             => admin_set,
-          ASPACE_ID             => aspace_id,
+          ACCESS_ROLE             => roles.to_json,
+          ADMIN_SET               => admin_set,
+          ADMIN_SET_TITLE         => admin_set_title,
+          ASPACE_ID               => aspace_id,
           ATTACHED_FILES_HAVING_CONTENT => attached_files_having_content.keys,
-          BOX_NUMBER_FACET      => desc_metadata_values('box_number'),
-          CONTRIBUTOR_FACET     => contributor,
-          CREATOR_FACET         => creator,
-          DATE_FACET            => date,
-          DATE_SORT             => date_sort,
-          DEPOSITOR             => depositor,
-          DISPLAY_FORMAT        => display_format,
-          DOI                   => adminMetadata.doi,
-          EAD_ID                => ead_id,
-          FORMAT_FACET          => format,
-          IDENTIFIER_ALL        => all_identifiers,
-          INTERNAL_URI          => internal_uri,
-          IS_LOCKED             => is_locked,
-          LICENSE               => license,
-          LICENSE_DESCRIPTION   => rightsMetadata.license.description.first,
-          LICENSE_TITLE         => rightsMetadata.license.title.first,
-          LICENSE_URL           => rightsMetadata.license.url.first,
-          LOCAL_ID              => local_id,
-          PERMANENT_ID          => permanent_id,
-          PERMANENT_URL         => permanent_url,
-          POLICY_ROLE           => roles.in_policy_scope.agents,
-          PUBLISHER_FACET       => publisher,
-          RESEARCH_HELP_CONTACT => research_help_contact,
-          RESOURCE_ROLE         => roles.in_resource_scope.agents,
-          SERIES_FACET          => desc_metadata_values('series'),
-          SPATIAL_FACET         => desc_metadata_values('spatial'),
-          SUBJECT_FACET         => subject,
-          TITLE                 => title_display,
-          TYPE_FACET            => type,
-          WORKFLOW_STATE        => workflow_state,
-          YEAR_FACET            => year_facet,
+          BOX_NUMBER_FACET        => desc_metadata_values('box_number'),
+          CATEGORY_FACET          => desc_metadata_values('category'),
+          COLLECTION_TITLE        => collection_title,
+          COMPANY_FACET           => desc_metadata_values('company'),
+          CONTRIBUTOR_FACET       => contributor,
+          CREATOR_FACET           => creator,
+          DATE_FACET              => date,
+          DATE_SORT               => date_sort,
+          DEPOSITOR               => depositor,
+          DISPLAY_FORMAT          => display_format,
+          DOI                     => adminMetadata.doi,
+          EAD_ID                  => ead_id,
+          FOLDER_FACET            => desc_metadata_values('folder'),
+          FORMAT_FACET            => format,
+          IDENTIFIER_ALL          => all_identifiers,
+          INTERNAL_URI            => internal_uri,
+          IS_LOCKED               => is_locked,
+          LICENSE                 => license,
+          LICENSE_DESCRIPTION     => rightsMetadata.license.description.first,
+          LICENSE_TITLE           => rightsMetadata.license.title.first,
+          LICENSE_URL             => rightsMetadata.license.url.first,
+          LOCAL_ID                => local_id,
+          MEDIUM_FACET            => desc_metadata_values('medium'),
+          PERMANENT_ID            => permanent_id,
+          PERMANENT_URL           => permanent_url,
+          PLACEMENT_COMPANY_FACET => desc_metadata_values('placement_company'),
+          POLICY_ROLE             => roles.in_policy_scope.agents,
+          PRODUCT_FACET           => desc_metadata_values('product'),
+          PUBLICATION_FACET       => desc_metadata_values('publication'),
+          PUBLISHER_FACET         => publisher,
+          RESEARCH_HELP_CONTACT   => research_help_contact,
+          RESOURCE_ROLE           => roles.in_resource_scope.agents,
+          SERIES_FACET            => desc_metadata_values('series'),
+          SETTING_FACET           => desc_metadata_values('setting'),
+          SPATIAL_FACET           => desc_metadata_values('spatial'),
+          SUBJECT_FACET           => subject,
+          TITLE                   => title_display,
+          TONE_FACET              => desc_metadata_values('tone'),
+          TYPE_FACET              => type,
+          WORKFLOW_STATE          => workflow_state,
+          YEAR_FACET              => year_facet,
         }
         if respond_to? :fixity_checks
           last_fixity_check = fixity_checks.last
@@ -110,6 +121,8 @@ module Ddr
       end
 
       def associated_collection
+        # XXX Can/should we use SolrDocument here?
+        # I.e., ::SolrDocument.find(admin_policy_id)
         admin_policy
       end
 
@@ -121,10 +134,29 @@ module Ddr
         end
       end
 
+      def admin_set_title
+        code = if admin_set.present?
+                 admin_set
+               elsif associated_collection.present?
+                 associated_collection.admin_set
+               end
+        if as = AdminSet.find_by_code(code)
+          as.title
+        end
+      end
+
       def collection_facet
         associated_collection.internal_uri if associated_collection.present?
       end
 
+      def collection_title
+        if instance_of?(Collection)
+          title_display
+        elsif associated_collection.present?
+          associated_collection.title_display
+        end
+      end
+
       def date_sort
         date.first
       end

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "2.4.16"
+    VERSION = "2.5.0.rc1"
   end
 end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150713171838) do
+ActiveRecord::Schema.define(version: 20161021201011) do
 
   create_table "events", force: true do |t|
     t.datetime "event_date_time"
@@ -27,10 +27,12 @@ ActiveRecord::Schema.define(version: 20150713171838) do
     t.text     "detail"
     t.text     "exception",       limit: 65535
     t.string   "user_key"
+    t.string   "permanent_id"
   end
 
   add_index "events", ["event_date_time"], name: "index_events_on_event_date_time"
   add_index "events", ["outcome"], name: "index_events_on_outcome"
+  add_index "events", ["permanent_id"], name: "index_events_on_permanent_id"
   add_index "events", ["pid"], name: "index_events_on_pid"
   add_index "events", ["type"], name: "index_events_on_type"
 

data/spec/index/fields_spec.rb

@@ -12,6 +12,8 @@ module Ddr::Index
                                    Fields::TECHMD_FITS_DATETIME,
                                    Fields::TECHMD_FORMAT_LABEL,
                                    Fields::TECHMD_FORMAT_VERSION,
+                                   Fields::TECHMD_ICC_PROFILE_NAME,
+                                   Fields::TECHMD_ICC_PROFILE_VERSION,
                                    Fields::TECHMD_IMAGE_HEIGHT,
                                    Fields::TECHMD_IMAGE_WIDTH,
                                    Fields::TECHMD_MEDIA_TYPE,
@@ -60,6 +62,18 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "aspace_id" }
       end
 
+      describe "CATEGORY_FACET" do
+        subject { Fields::CATEGORY_FACET }
+        its(:label) { is_expected.to eq "Category Facet" }
+        its(:heading) { is_expected.to eq "category_facet" }
+      end
+
+      describe "COMPANY_FACET" do
+        subject { Fields::COMPANY_FACET }
+        its(:label) { is_expected.to eq "Company Facet" }
+        its(:heading) { is_expected.to eq "company_facet" }
+      end
+
       describe "DOI" do
         subject { Fields::DOI }
         its(:label) { is_expected.to eq "DOI" }
@@ -72,12 +86,24 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "ead_id" }
       end
 
+      describe "FOLDER_FACET" do
+        subject { Fields::FOLDER_FACET }
+        its(:label) { is_expected.to eq "Folder Facet" }
+        its(:heading) { is_expected.to eq "folder_facet" }
+      end
+
       describe "LOCAL_ID" do
         subject { Fields::LOCAL_ID }
         its(:label) { is_expected.to eq "Local ID" }
         its(:heading) { is_expected.to eq "local_id" }
       end
 
+      describe "MEDIUM_FACET" do
+        subject { Fields::MEDIUM_FACET }
+        its(:label) { is_expected.to eq "Medium Facet" }
+        its(:heading) { is_expected.to eq "medium_facet" }
+      end
+
       describe "OBJECT_CREATE_DATE" do
         subject { Fields::OBJECT_CREATE_DATE }
         its(:label) { is_expected.to eq "Creation Date" }
@@ -102,6 +128,30 @@ module Ddr::Index
         its(:heading) { is_expected.to eq "permanent_url" }
       end
 
+      describe "PLACEMENT_COMPANY_FACET" do
+        subject { Fields::PLACEMENT_COMPANY_FACET }
+        its(:label) { is_expected.to eq "Placement Company Facet" }
+        its(:heading) { is_expected.to eq "placement_company_facet" }
+      end
+
+      describe "PRODUCT_FACET" do
+        subject { Fields::PRODUCT_FACET }
+        its(:label) { is_expected.to eq "Product Facet" }
+        its(:heading) { is_expected.to eq "product_facet" }
+      end
+
+      describe "PUBLICATION_FACET" do
+        subject { Fields::PUBLICATION_FACET }
+        its(:label) { is_expected.to eq "Publication Facet" }
+        its(:heading) { is_expected.to eq "publication_facet" }
+      end
+
+      describe "SETTING_FACET" do
+        subject { Fields::SETTING_FACET }
+        its(:label) { is_expected.to eq "Setting Facet" }
+        its(:heading) { is_expected.to eq "setting_facet" }
+      end
+
       describe "TECHMD_COLOR_SPACE" do
         subject { Fields::TECHMD_COLOR_SPACE }
         its(:label) { is_expected.to eq "Color Space" }
@@ -191,6 +241,12 @@ module Ddr::Index
         its(:label) { is_expected.to eq "Well-formed" }
         its(:heading) { is_expected.to eq "well_formed" }
       end
+
+      describe "TONE_FACET" do
+        subject { Fields::TONE_FACET }
+        its(:label) { is_expected.to eq "Tone Facet" }
+        its(:heading) { is_expected.to eq "tone_facet" }
+      end
     end
 
   end

data/spec/managers/technical_metadata_manager_spec.rb

@@ -72,6 +72,8 @@ module Ddr::Managers
       its(:image_width) { is_expected.to eq(["500"]) }
       its(:image_height) { is_expected.to eq(["569"]) }
       its(:color_space) { is_expected.to eq(["YCbCr"]) }
+      its(:icc_profile_name) { is_expected.to eq(["c2"]) }
+      its(:icc_profile_version) { is_expected.to eq(["2.1.0"]) }
     end
 
     describe "valid? / invalid?" do

data/spec/models/admin_set_spec.rb

@@ -6,19 +6,20 @@ module Ddr::Models
 
       describe "when the object has an admin set" do
         before { obj.admin_set = "dvs" }
+        let(:admin_set) {
+          described_class.new("id"=>1, "code"=>"dvs", "title"=>"Data and Visualization Services", "created_at"=>"2015-09-15T16:15:58.514Z", "updated_at"=>"2015-09-15T16:15:58.514Z")
+        }
         describe "and the admin set code is found" do
           before {
-            allow(described_class).to receive(:get).with(:find, code: "dvs") {
-              {"id"=>1, "code"=>"dvs", "title"=>"Data and Visualization Services", "created_at"=>"2015-09-15T16:15:58.514Z", "updated_at"=>"2015-09-15T16:15:58.514Z"}
-            }
+            allow(described_class).to receive(:find_by_code).with("dvs") { admin_set }
           }
           it "returns an AdminSet instance" do
-            expect(described_class.call(obj)).to be_a(described_class)
+            expect(described_class.call(obj)).to eq(admin_set)
           end
         end
         describe "and the admin set is not found" do
           before {
-            allow(described_class).to receive(:get).with(:find, code: "dvs")
+            allow(described_class).to receive(:find_by_code).with("dvs")
                                        .and_raise(ActiveResource::ResourceNotFound, "404")
           }
           it "raises an exception" do

data/spec/models/collection_spec.rb

@@ -7,13 +7,33 @@ RSpec.describe Collection, type: :model do
   it_behaves_like "it has an association", :has_many, :targets, :is_external_target_for, "Target"
   it_behaves_like "a publishable object"
 
+  describe "admin set" do
+    let(:admin_set) { Ddr::Models::AdminSet.new(code: "foobar", title: "FooBar") }
+    before do
+      allow(Ddr::Models::AdminSet).to receive(:find_by_code).with("foobar") { admin_set }
+      subject.admin_set = "foobar"
+    end
+    it "indexes the admin set title" do
+      expect(subject.to_solr[Ddr::Index::Fields::ADMIN_SET_TITLE]).to eq("FooBar")
+    end
+  end
+
+  describe "title" do
+    before do
+      subject.title = [ "Test Collection" ]
+    end
+    it "indexes the collection title" do
+      expect(subject.to_solr[Ddr::Index::Fields::COLLECTION_TITLE]).to eq("Test Collection")
+    end
+  end
+
   describe "legacy license information" do
     before do
       subject.defaultRights.license.title = ["License Title"]
       subject.defaultRights.license.description = ["License Description"]
       subject.defaultRights.license.url = ["http://library.duke.edu"]
     end
-    it "should index the terms" do
+    it "indexes the terms" do
       expect(subject.to_solr[Ddr::Index::Fields::DEFAULT_LICENSE_TITLE]).to eq("License Title")
       expect(subject.to_solr[Ddr::Index::Fields::DEFAULT_LICENSE_DESCRIPTION]).to eq("License Description")
       expect(subject.to_solr[Ddr::Index::Fields::DEFAULT_LICENSE_URL]).to eq("http://library.duke.edu")
@@ -25,7 +45,7 @@ RSpec.describe Collection, type: :model do
     before do
       allow_any_instance_of(Component).to receive(:collection_uri).and_return(subject.internal_uri)
     end
-    it "should return the correct component(s)" do
+    it "returns the correct component(s)" do
       component = Component.create
       docs = subject.components_from_solr
       expect(docs.size).to eq(1)
@@ -34,7 +54,7 @@ RSpec.describe Collection, type: :model do
   end
 
   describe "validation" do
-    it "should require a title" do
+    it "requires a title" do
       expect(subject).to_not be_valid
       expect(subject.errors.messages).to have_key(:title)
     end
@@ -42,7 +62,7 @@ RSpec.describe Collection, type: :model do
 
   describe "creation" do
     subject { Collection.create(title: [ "Test Collection" ]) }
-    it "should be governed by itself" do
+    it "is governed by itself" do
       expect(subject.admin_policy).to eq(subject)
     end
   end
@@ -50,7 +70,7 @@ RSpec.describe Collection, type: :model do
   describe "roles granted to creator" do
     let(:user) { FactoryGirl.build(:user) }
     before { subject.grant_roles_to_creator(user) }
-    it "should include Curator roles in both resource abd policy scopes" do
+    it "includes Curator roles in both resource and policy scopes" do
       expect(subject.roles.to_a).to eq([Ddr::Auth::Roles::Role.build(type: "Curator", agent: user.agent, scope: "resource"), Ddr::Auth::Roles::Role.build(type: "Curator", agent: user.agent, scope: "policy")])
     end
   end

data/spec/models/events_spec.rb

@@ -68,5 +68,18 @@ module Ddr
         expect(subject.display_type).to eq "Deletion"
       end
     end
+
+    RSpec.describe DeaccessionEvent, type: :model, events: true do
+      it_behaves_like "an event"
+      it_behaves_like "a preservation-related event"
+      it "should have a display type" do
+        expect(subject.display_type).to eq "Deaccession"
+      end
+
+      describe "permanent id" do
+        subject { described_class.new(pid: "test:1", permanent_id: "ark:/99999/fk4zzz") }
+        its(:permanent_id) { is_expected.to eq("ark:/99999/fk4zzz") }
+      end
+    end
   end
 end

data/spec/models/has_admin_metadata_spec.rb

@@ -73,6 +73,13 @@ module Ddr::Models
                    .to("unavailable | deleted")
           end
         end
+        describe "object deaccession" do
+          it "marks the identifier as unavailable" do
+            expect { subject.deaccession }
+              .to change(identifier, :status)
+                   .to("unavailable | deaccessioned")
+          end
+        end
       end
 
       describe "events" do
@@ -104,35 +111,57 @@ module Ddr::Models
 
     describe "workflow" do
 
-      subject { FactoryGirl.build(:item) }
+      let(:collection) { FactoryGirl.create(:collection) }
+      let(:item) { FactoryGirl.create(:item) }
+      let(:component) { FactoryGirl.create(:component) }
+      before do
+        item.parent = collection
+        item.save!
+        component.parent = item
+        component.save!
+      end
 
       describe "#published?" do
         context "object is published" do
-          before { allow(subject).to receive(:workflow_state) { Ddr::Managers::WorkflowManager::PUBLISHED } }
+          before { allow(collection).to receive(:workflow_state) { Ddr::Managers::WorkflowManager::PUBLISHED } }
           it "should return true" do
-            expect(subject).to be_published
+            expect(collection).to be_published
           end
         end
         context "object is not published" do
-          before { allow(subject).to receive(:workflow_state) { nil } }
+          before { allow(collection).to receive(:workflow_state) { nil } }
           it "should return false" do
-            expect(subject).not_to be_published
+            expect(collection).not_to be_published
           end
         end
       end
 
       describe "#publish!" do
-        it "should publish and persist the object" do
-          subject.publish!
-          expect(subject.reload).to be_published
+        context "do not include descendants" do
+          it "should publish and persist the object" do
+            collection.publish!(include_descendants: false)
+            expect(collection.reload).to be_published
+            expect(item.reload).not_to be_published
+            expect(component.reload).not_to be_published
+          end
+        end
+        context "do include descendants" do
+          it "should publish and persist the object and descendants" do
+            collection.publish!
+            expect(collection.reload).to be_published
+            expect(item.reload).to be_published
+            expect(component.reload).to be_published
+          end
         end
       end
 
       describe "#unpublish!" do
-        before { subject.publish! }
-        it "should unpublish and persist the object" do
-          subject.unpublish!
-          expect(subject.reload).not_to be_published
+        before { collection.publish! }
+        it "should unpublish and persist the object and descendants" do
+          collection.unpublish!
+          expect(collection.reload).not_to be_published
+          expect(item.reload).not_to be_published
+          expect(component.reload).not_to be_published
         end
       end
     end

data/spec/models/indexing_spec.rb

@@ -12,32 +12,50 @@ module Ddr::Models
       let(:role4) { FactoryGirl.build(:role, :editor, :person, :policy) }
 
       before do
+        obj.adminMetadata.doi << "http://doi.org/10.1000/182"
+        obj.aspace_id = "aspace_dccea43034e1b8261e14cf999e86449d"
+        obj.display_format = "Image"
         obj.license = "cc-by-nc-nd-40"
-        obj.rightsMetadata.license.title = ["License Title"]
-        obj.rightsMetadata.license.description = ["License Description"]
-        obj.rightsMetadata.license.url = ["http://library.duke.edu"]
         obj.local_id = "foo"
-        obj.adminMetadata.doi << "http://doi.org/10.1000/182"
         obj.permanent_id = "ark:/99999/fk4zzz"
         obj.permanent_url = "http://id.library.duke.edu/ark:/99999/fk4zzz"
-        obj.display_format = "Image"
+        obj.rightsMetadata.license.description = ["License Description"]
+        obj.rightsMetadata.license.title = ["License Title"]
+        obj.rightsMetadata.license.url = ["http://library.duke.edu"]
         obj.roles.grant role1, role2, role3, role4
-        obj.aspace_id = "aspace_dccea43034e1b8261e14cf999e86449d"
+        obj.set_desc_metadata_values(:category, "Category Facet")
+        obj.set_desc_metadata_values(:company, "Company Facet")
+        obj.set_desc_metadata_values(:folder, "Folder Facet")
+        obj.set_desc_metadata_values(:medium, "Medium Facet")
+        obj.set_desc_metadata_values(:placement_company, "Placement Company Facet")
+        obj.set_desc_metadata_values(:product, "Product Facet")
+        obj.set_desc_metadata_values(:publication, "Publication Facet")
+        obj.set_desc_metadata_values(:setting, "Setting Facet")
+        obj.set_desc_metadata_values(:tone, "Tone Facet")
       end
 
+      its([Indexing::ACCESS_ROLE]) { is_expected.to eq(obj.roles.to_json) }
+      its([Indexing::ASPACE_ID]) { is_expected.to eq("aspace_dccea43034e1b8261e14cf999e86449d") }
+      its([Indexing::CATEGORY_FACET]) { is_expected.to eq(["Category Facet"]) }
+      its([Indexing::COMPANY_FACET]) { is_expected.to eq(["Company Facet"]) }
+      its([Indexing::DISPLAY_FORMAT]) { is_expected.to eq("Image") }
+      its([Indexing::DOI]) { is_expected.to eq(["http://doi.org/10.1000/182"]) }
+      its([Indexing::FOLDER_FACET]) { is_expected.to eq(["Folder Facet"]) }
       its([Indexing::LICENSE]) { is_expected.to eq("cc-by-nc-nd-40") }
-      its([Indexing::LICENSE_TITLE]) { is_expected.to eq("License Title") }
       its([Indexing::LICENSE_DESCRIPTION]) { is_expected.to eq("License Description") }
+      its([Indexing::LICENSE_TITLE]) { is_expected.to eq("License Title") }
       its([Indexing::LICENSE_URL]) { is_expected.to eq("http://library.duke.edu") }
       its([Indexing::LOCAL_ID]) { is_expected.to eq("foo") }
-      its([Indexing::DOI]) { is_expected.to eq(["http://doi.org/10.1000/182"]) }
+      its([Indexing::MEDIUM_FACET]) { is_expected.to eq(["Medium Facet"]) }
       its([Indexing::PERMANENT_ID]) { is_expected.to eq("ark:/99999/fk4zzz") }
       its([Indexing::PERMANENT_URL]) { is_expected.to eq("http://id.library.duke.edu/ark:/99999/fk4zzz") }
-      its([Indexing::DISPLAY_FORMAT]) { is_expected.to eq("Image") }
-      its([Indexing::ACCESS_ROLE]) { is_expected.to eq(obj.roles.to_json) }
+      its([Indexing::PLACEMENT_COMPANY_FACET]) { is_expected.to eq(["Placement Company Facet"]) }
       its([Indexing::POLICY_ROLE]) { is_expected.to contain_exactly(role2.agent.first, role3.agent.first, role4.agent.first) }
+      its([Indexing::PRODUCT_FACET]) { is_expected.to eq(["Product Facet"]) }
+      its([Indexing::PUBLICATION_FACET]) { is_expected.to eq(["Publication Facet"]) }
       its([Indexing::RESOURCE_ROLE]) { is_expected.to contain_exactly(role1.agent.first) }
-      its([Indexing::ASPACE_ID]) { is_expected.to eq("aspace_dccea43034e1b8261e14cf999e86449d") }
+      its([Indexing::SETTING_FACET]) { is_expected.to eq(["Setting Facet"]) }
+      its([Indexing::TONE_FACET]) { is_expected.to eq(["Tone Facet"]) }
     end
 
     describe "content-bearing object indexing" do

data/spec/support/shared_examples_for_ddr_models.rb

@@ -6,10 +6,43 @@ 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 "notification on save" do
+    let(:events) { [] }
+    before {
+      @subscriber = ActiveSupport::Notifications.subscribe("save.#{described_class.to_s.underscore}") do |name, start, finish, id, payload|
+        events << payload
+      end
+    }
+    after {
+      ActiveSupport::Notifications.unsubscribe(@subscriber)
+    }
+    it "happens when save succeeds" do
+      subject.title = [ "My Title Changed" ]
+      subject.save
+      subject.title = [ "My Title Changed Again" ]
+      subject.save
+      expect(events.first[:changes]).to eq({"title"=>[[], ["My Title Changed"]]})
+      expect(events.first[:created]).to be true
+      expect(events.first[:pid]).to eq(subject.pid)
+      expect(events.last[:changes]).to eq({"title"=>[["My Title Changed"], ["My Title Changed Again"]]})
+      expect(events.last[:created]).to be false
+      expect(events.last[:pid]).to eq(subject.pid)
+    end
+  end
+
   describe "events" do
+    before {
+      subject.permanent_id = "ark:/99999/fk4zzz"
+      subject.save(validate: false)
+      allow(Ddr::Jobs::PermanentId::MakeUnavailable).to receive(:perform) { nil }
+    }
+    describe "deaccession" do
+      it "creates a deaccession event" do
+        expect { subject.deaccession }.to change { Ddr::Events::DeaccessionEvent.for_object(subject).count }.by(1)
+      end
+    end
     describe "on deletion with #destroy" do
-      before { subject.save(validate: false) }
-      it "should create a deletion event" do
+      it "creates a deletion event" do
         expect { subject.destroy }.to change { Ddr::Events::DeletionEvent.for_object(subject).count }.from(0).to(1)
       end
     end
@@ -38,7 +71,7 @@ RSpec.shared_examples "a DDR model" do
     context "one desc metadata identifier" do
       before { subject.identifier = Array(identifiers.first) }
       context "local id not present" do
-        it "should set the local id and remove the identifier" do
+        it "sets the local id and removes the identifier" do
           result = subject.move_first_identifier_to_local_id
           expect(result).to be true
           expect(subject.local_id).to eq(identifiers.first)
@@ -48,7 +81,7 @@ RSpec.shared_examples "a DDR model" do
       context "local id present" do
         before { subject.local_id = local_id }
         context "replace option is true" do
-          it "should set the local id and remove the identifier" do
+          it "sets the local id and removes the identifier" do
             result = subject.move_first_identifier_to_local_id
             expect(result).to be true
             expect(subject.local_id).to eq(identifiers.first)
@@ -58,7 +91,7 @@ RSpec.shared_examples "a DDR model" do
         context "replace option is false" do
           context "local id matches first identifier" do
             before { subject.identifier = Array(local_id) }
-            it "should remove the identifier" do
+            it "removes the identifier" do
               result = subject.move_first_identifier_to_local_id(replace: false)
               expect(result).to be true
               expect(subject.local_id).to eq(local_id)
@@ -66,7 +99,7 @@ RSpec.shared_examples "a DDR model" do
             end
           end
           context "local id does not match first identifier" do
-            it "should not change the local id and not remove the identifier" do
+            it "does not change the local id and does not remove the identifier" do
               result = subject.move_first_identifier_to_local_id(replace: false)
               expect(result).to be false
               expect(subject.local_id).to eq(local_id)
@@ -79,7 +112,7 @@ RSpec.shared_examples "a DDR model" do
     context "more than one desc metadata identifer" do
       before { subject.identifier = identifiers }
       context "local id not present" do
-        it "should set the local id and remove the identifier" do
+        it "sets the local id and removes the identifier" do
           result = subject.move_first_identifier_to_local_id
           expect(result).to be true
           expect(subject.local_id).to eq(identifiers.first)
@@ -89,7 +122,7 @@ RSpec.shared_examples "a DDR model" do
       context "local id present" do
         before { subject.local_id = local_id }
         context "replace option is true" do
-          it "should set the local id and remove the identifier" do
+          it "sets the local id and removes the identifier" do
             result = subject.move_first_identifier_to_local_id
             expect(result).to be true
             expect(subject.local_id).to eq(identifiers.first)
@@ -99,7 +132,7 @@ RSpec.shared_examples "a DDR model" do
         context "replace option is false" do
           context "local id matches first identifier" do
             before { subject.identifier = [ local_id, identifiers.last ] }
-            it "should remove the identifier" do
+            it "removes the identifier" do
               result = subject.move_first_identifier_to_local_id(replace: false)
               expect(result).to be true
               expect(subject.local_id).to eq(local_id)
@@ -107,7 +140,7 @@ RSpec.shared_examples "a DDR model" do
             end
           end
           context "local id does not match first identifier" do
-            it "should not change the local id and not remove the identifier" do
+            it "does not change the local id and does not remove the identifier" do
               result = subject.move_first_identifier_to_local_id(replace: false)
               expect(result).to be false
               expect(subject.local_id).to eq(local_id)

data/spec/support/shared_examples_for_non_collection_models.rb

@@ -3,8 +3,34 @@ RSpec.shared_examples "a non-collection model" do
     subject { described_class.new }
     let(:user) { FactoryGirl.build(:user) }
     before { subject.grant_roles_to_creator(user) }
-    it "should include the Editor role in resource scope" do
+    it "includes the Editor role in resource scope" do
       expect(subject.roles.to_a).to eq([Ddr::Auth::Roles::Role.build(type: "Editor", agent: user.agent, scope: "resource")])
     end
   end
+
+  describe "admin set" do
+    subject { described_class.new }
+    let(:collection) { FactoryGirl.build(:collection) }
+    let(:admin_set) { Ddr::Models::AdminSet.new(code: "foobar", title: "FooBar") }
+    before {
+      allow(Ddr::Models::AdminSet).to receive(:find_by_code).with("foobar") { admin_set }
+      collection.admin_set = "foobar"
+      collection.save!
+      subject.admin_policy = collection
+    }
+    it "indexes the admin set title" do
+      expect(subject.to_solr[Ddr::Index::Fields::ADMIN_SET_TITLE]).to eq("FooBar")
+    end
+  end
+
+  describe "collection title" do
+    subject { described_class.new }
+    let(:collection) { FactoryGirl.create(:collection) }
+    before {
+      subject.admin_policy = collection
+    }
+    it "indexes the collection title" do
+      expect(subject.to_solr[Ddr::Index::Fields::COLLECTION_TITLE]).to eq("Test Collection")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddr-models
 version: !ruby/object:Gem::Version
-  version: 2.4.16
+  version: 2.5.0.rc1
 platform: ruby
 authors:
 - Jim Coble
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -396,6 +396,7 @@ files:
 - db/migrate/20150130134416_add_user_key_to_events.rb
 - db/migrate/20150710211530_change_events_exception_to_text.rb
 - db/migrate/20150713171838_add_limit_to_events_exception.rb
+- db/migrate/20161021201011_add_permanent_id_to_events.rb
 - ddr-models.gemspec
 - lib/ddr-models.rb
 - lib/ddr/actions.rb
@@ -468,6 +469,7 @@ files:
 - lib/ddr/derivatives/ptif_generator.rb
 - lib/ddr/events.rb
 - lib/ddr/events/creation_event.rb
+- lib/ddr/events/deaccession_event.rb
 - lib/ddr/events/deletion_event.rb
 - lib/ddr/events/event.rb
 - lib/ddr/events/fixity_check_event.rb
@@ -721,9 +723,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.3