ddr-models 2.6.2 → 2.7.0.rc1

data/lib/ddr/models/fixity_checkable.rb

@@ -2,11 +2,6 @@ module Ddr
   module Models
     module FixityCheckable
 
-      def datastreams_to_validate
-        datastreams.select { |dsid, ds| ds.has_content? }
-      end
-      alias_method :attached_files_having_content, :datastreams_to_validate
-
       def fixity_checks
         Ddr::Events::FixityCheckEvent.for_object(self)
       end

data/lib/ddr/models/has_admin_metadata.rb

@@ -1,5 +1,3 @@
-require "resque"
-
 module Ddr::Models
   module HasAdminMetadata
     extend ActiveSupport::Concern
@@ -23,9 +21,13 @@ module Ddr::Models
                      :aspace_id,
                      :is_locked,
                      :doi,
+                     :ingested_by,
+                     :ingestion_date,
                      datastream: "adminMetadata",
                      multiple: false
 
+      has_attributes :rights_note, datastream: "adminMetadata", multiple: true
+
       delegate :publish!, :unpublish!, :published?, :unpublished?,
                to: :workflow
     end

data/lib/ddr/models/has_children.rb

@@ -2,8 +2,42 @@ module Ddr
   module Models
     module HasChildren
 
+      DEFAULT_SORT = "#{Ddr::Index::Fields::LOCAL_ID} ASC, #{Ddr::Index::Fields::OBJECT_CREATE_DATE} ASC"
+
       def first_child
-        ActiveFedora::Base.where(association_query(:children)).order("#{Ddr::Index::Fields::LOCAL_ID} ASC").first
+        ActiveFedora::SolrService.lazy_reify_solr_results(sorted_children).first
+      end
+
+      def default_structure
+        if children.present?
+          build_default_structure
+        end
+      end
+
+      def sorted_children
+        ActiveFedora::SolrService.query(association_query(:children), sort: DEFAULT_SORT, rows: 999999)
+      end
+
+      private
+
+      def build_default_structure
+        document = Ddr::Models::Structure.xml_template
+        structure = Ddr::Models::Structure.new(document)
+        metshdr = structure.add_metshdr
+        structure.add_agent(parent: metshdr, role: Ddr::Models::Structures::Agent::ROLE_CREATOR,
+                            name: Ddr::Models::Structures::Agent::NAME_REPOSITORY_DEFAULT)
+        structmap = structure.add_structmap(type: Ddr::Models::Structure::TYPE_DEFAULT)
+        add_children(structure, structmap, sorted_children)
+        structure
+      end
+
+      def add_children(structure, structmap, children)
+        count = 0
+        children.each do |child|
+          count += 1
+          div = structure.add_div(parent: structmap, order: count)
+          structure.add_mptr(parent: div, href: child[Ddr::Index::Fields::PERMANENT_ID])
+        end
       end
 
     end

data/lib/ddr/models/has_content.rb

@@ -3,22 +3,13 @@ module Ddr
     module HasContent
       extend ActiveSupport::Concern
 
-      MASTER_FILE_TYPES = [ "image/tiff" ]
-
-      def master_file?
-        if respond_to?(:file_use) && file_use.present?
-          file_use == Ddr::Models::HasStructMetadata::FILE_USE_MASTER
-        else
-          MASTER_FILE_TYPES.include?(content_type)
-        end
-      end
-
       included do
         has_file_datastream \
           name: Ddr::Datastreams::CONTENT,
+          type: Ddr::Datastreams::ContentDatastream,
           versionable: true,
           label: "Content file for this object",
-          control_group: "M"
+          control_group: "E"
 
         has_file_datastream \
           name: Ddr::Datastreams::EXTRACTED_TEXT,
@@ -30,7 +21,7 @@ module Ddr
         has_metadata \
           name: Ddr::Datastreams::FITS,
           type: Ddr::Datastreams::FitsDatastream,
-          versionable: true,
+          versionable: false,
           label: "FITS Output for content file",
           control_group: "M"
 
@@ -38,18 +29,6 @@ module Ddr
 
         include FileManagement
 
-        around_save :update_derivatives, if: :content_changed?
-
-        before_save if: :re_characterize? do
-          fits.delete
-        end
-
-        after_add_file do
-          if file_to_add.original_name && file_to_add.dsid == "content"
-            self.original_filename = file_to_add.original_name
-          end
-        end
-
         delegate :validate_checksum!, to: :content
       end
 
@@ -134,15 +113,6 @@ module Ddr
 
       protected
 
-      def update_derivatives
-        yield
-        derivatives.update_derivatives(:later)
-      end
-
-      def re_characterize?
-        content_changed? && !fits.new?
-      end
-
       def default_content_type
         "application/octet-stream"
       end

data/lib/ddr/models/has_intermediate_file.rb

@@ -0,0 +1,18 @@
+module Ddr
+  module Models
+    module HasIntermediateFile
+      extend ActiveSupport::Concern
+
+      included do
+        has_file_datastream name: Ddr::Datastreams::INTERMEDIATE_FILE,
+                            type: Ddr::Datastreams::IntermediateFileDatastream,
+                            versionable: true,
+                            label: "Intermediate file for this object",
+                            control_group: "E"
+
+        include FileManagement
+      end
+
+    end
+  end
+end

data/lib/ddr/models/has_multires_image.rb

@@ -1,20 +1,17 @@
-module Ddr
-  module Models
-    module HasMultiresImage
-      extend ActiveSupport::Concern
+module Ddr::Models
+  module HasMultiresImage
+    extend ActiveSupport::Concern
 
-      included do
-        has_file_datastream name: Ddr::Datastreams::MULTIRES_IMAGE,
-                            label: "Multi-resolution image derivative for this object",
-                            control_group: 'E'
-
-        include FileManagement unless include?(FileManagement)
-      end
-
-      def multires_image_file_path
-        URI.parse(datastreams[Ddr::Datastreams::MULTIRES_IMAGE].dsLocation).path if datastreams[Ddr::Datastreams::MULTIRES_IMAGE].dsLocation
-      end
+    included do
+      has_file_datastream name: Ddr::Datastreams::MULTIRES_IMAGE,
+                          type: Ddr::Datastreams::MultiresImageDatastream,
+                          label: "Multi-resolution image derivative for this object",
+                          control_group: "E"
+    end
 
+    def multires_image_file_path
+      datastreams[Ddr::Datastreams::MULTIRES_IMAGE].file_path
     end
+
   end
 end

data/lib/ddr/models/has_struct_metadata.rb

@@ -17,44 +17,8 @@ module Ddr
         @structure
       end
 
-      def build_default_structure
-        structure = Ddr::Models::Structure.new(Ddr::Models::Structure.template)
-        children = find_children
-        children.each do |child|
-          add_to_struct_map(structure, child)
-        end
-        structure
-      end
-
-      def multires_image_file_paths(type='default')
-        ::SolrDocument.find(pid).multires_image_file_paths(type)
-      end
-
-      private
-
-      def find_children
-        query = association_query(:children)
-        sort = "#{Ddr::Index::Fields::LOCAL_ID} ASC, #{Ddr::Index::Fields::OBJECT_CREATE_DATE} ASC"
-        ActiveFedora::SolrService.query(query, sort: sort, rows: 999999)
-      end
-
-      def add_to_struct_map(stru, child)
-        div = create_div(stru)
-        create_fptr(stru, div, child['id'])
-      end
-
-      def create_div(stru)
-        div_count = stru.structMap_node('default').xpath('xmlns:div').size
-        div = Nokogiri::XML::Node.new('div', stru.as_xml_document)
-        div['ORDER'] = div_count + 1
-        stru.structMap_node('default').add_child(div)
-        div
-      end
-
-      def create_fptr(stru, div, pid)
-        fptr = Nokogiri::XML::Node.new('fptr', stru.as_xml_document)
-        fptr['CONTENTIDS'] = "info:fedora/#{pid}"
-        div.add_child(fptr)
+      def multires_image_file_paths
+        ::SolrDocument.find(pid).multires_image_file_paths
       end
 
     end

data/lib/ddr/models/indexing.rb

@@ -1,186 +1,183 @@
 require 'time'
 
-module Ddr
-  module Models
-    module Indexing
+module Ddr::Models
+  module Indexing
 
-      include Ddr::Index::Fields
+    include Ddr::Index::Fields
 
-      def self.const_missing(name)
-        Ddr::Index::Fields.const_missing(name)
-      end
+    def self.const_missing(name)
+      Ddr::Index::Fields.const_missing(name)
+    end
 
-      def to_solr(solr_doc=Hash.new, opts={})
-        solr_doc = super(solr_doc, opts)
-        solr_doc.merge index_fields
-      end
+    def to_solr(solr_doc=Hash.new, opts={})
+      solr_doc = super(solr_doc, opts)
+      solr_doc.merge index_fields
+    end
 
-      def index_fields
-        fields = {
-          ACCESS_ROLE             => roles.to_json,
-          ADMIN_SET               => admin_set,
-          ADMIN_SET_TITLE         => admin_set_title,
-          ARRANGER_FACET          => desc_metadata_values('arranger'),
-          ASPACE_ID               => aspace_id,
-          ATTACHED_FILES_HAVING_CONTENT => attached_files_having_content.keys,
-          BOX_NUMBER_FACET        => desc_metadata_values('box_number'),
-          CATEGORY_FACET          => desc_metadata_values('category'),
-          COLLECTION_TITLE        => collection_title,
-          COMPANY_FACET           => desc_metadata_values('company'),
-          COMPOSER_FACET          => desc_metadata_values('composer'),
-          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,
-          ENGRAVER_FACET          => desc_metadata_values('engraver'),
-          FOLDER_FACET            => desc_metadata_values('folder'),
-          FORMAT_FACET            => format,
-          GENRE_FACET             => desc_metadata_values('genre'),
-          IDENTIFIER_ALL          => all_identifiers,
-          ILLUSTRATED_FACET       => desc_metadata_values('illustrated'),
-          ILLUSTRATOR_FACET       => desc_metadata_values('illustrator'),
-          INSTRUMENTATION_FACET   => desc_metadata_values('instrumentation'),
-          INTERNAL_URI            => internal_uri,
-          INTERVIEWER_NAME_FACET  => desc_metadata_values('interviewer_name'),
-          IS_LOCKED               => is_locked,
-          LICENSE                 => license,
-          LICENSE_DESCRIPTION     => rightsMetadata.license.description.first,
-          LICENSE_TITLE           => rightsMetadata.license.title.first,
-          LICENSE_URL             => rightsMetadata.license.url.first,
-          LITHOGRAPHER_FACET      => desc_metadata_values('lithographer'),
-          LOCAL_ID                => local_id,
-          LYRICIST_FACET          => desc_metadata_values('lyricist'),
-          MEDIUM_FACET            => desc_metadata_values('medium'),
-          PERFORMER_FACET         => desc_metadata_values('performer'),
-          PERMANENT_ID            => permanent_id,
-          PERMANENT_URL           => permanent_url,
-          PLACEMENT_COMPANY_FACET => desc_metadata_values('placement_company'),
-          POLICY_ROLE             => roles.in_policy_scope.agents,
-          PRODUCER_FACET          => desc_metadata_values('producer'),
-          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,
-          ROLL_NUMBER_FACET       => desc_metadata_values('roll_number'),
-          SERIES_FACET            => desc_metadata_values('series'),
-          SETTING_FACET           => desc_metadata_values('setting'),
-          SPATIAL_FACET           => desc_metadata_values('spatial'),
-          SUBJECT_FACET           => subject,
-          SUBSERIES_FACET         => desc_metadata_values('subseries'),
-          TEMPORAL_FACET          => desc_metadata_values('temporal'),
-          TITLE                   => title_display,
-          TONE_FACET              => desc_metadata_values('tone'),
-          TYPE_FACET              => type,
-          VOLUME_FACET            => desc_metadata_values('volume'),
-          WORKFLOW_STATE          => workflow_state,
-          YEAR_FACET              => year_facet,
-        }
-        if respond_to? :fixity_checks
-          last_fixity_check = fixity_checks.last
-          fields.merge!(last_fixity_check.to_solr) if last_fixity_check
-        end
-        if respond_to? :virus_checks
-          last_virus_check = virus_checks.last
-          fields.merge!(last_virus_check.to_solr) if last_virus_check
-        end
-        if has_content?
-          fields[CONTENT_CREATE_DATE] = Ddr::Utils.solr_date(content.createDate)
-          fields[CONTENT_CONTROL_GROUP] = content.controlGroup
-          fields[CONTENT_SIZE] = content_size
-          fields[CONTENT_SIZE_HUMAN] = content_human_size
-          fields[MEDIA_TYPE] = content_type
-          fields[MEDIA_MAJOR_TYPE] = content_major_type
-          fields[MEDIA_SUB_TYPE] = content_sub_type
-          fields.merge! techmd.index_fields
-        end
-        if has_multires_image?
-          fields[MULTIRES_IMAGE_FILE_PATH] = multires_image_file_path
-        end
-        if has_struct_metadata?
-          fields[STRUCT_MAPS] = structure.struct_maps.to_json
-        end
-        if has_extracted_text?
-          fields[EXTRACTED_TEXT] = extractedText.content
-        end
-        if is_a? Component
-          fields[COLLECTION_URI] = collection_uri
-        end
-        if is_a? Collection
-          fields[DEFAULT_LICENSE_DESCRIPTION] = defaultRights.license.description.first
-          fields[DEFAULT_LICENSE_TITLE] = defaultRights.license.title.first
-          fields[DEFAULT_LICENSE_URL] = defaultRights.license.url.first
-          fields[ADMIN_SET_FACET] = admin_set_facet
-          fields[COLLECTION_FACET] = collection_facet
-        end
-        if is_a? Item
-          fields[ADMIN_SET_FACET] = admin_set_facet
-          fields[COLLECTION_FACET] = collection_facet
-          fields[ALL_TEXT] = all_text
-        end
-        fields
+    def index_fields
+      fields = {
+        ACCESS_ROLE             => roles.to_json,
+        ADMIN_SET               => admin_set,
+        ADMIN_SET_TITLE         => admin_set_title,
+        ARRANGER_FACET          => desc_metadata_values('arranger'),
+        ASPACE_ID               => aspace_id,
+        ATTACHED_FILES_HAVING_CONTENT => attached_files_having_content.keys,
+        BOX_NUMBER_FACET        => desc_metadata_values('box_number'),
+        CATEGORY_FACET          => desc_metadata_values('category'),
+        COLLECTION_TITLE        => collection_title,
+        COMPANY_FACET           => desc_metadata_values('company'),
+        COMPOSER_FACET          => desc_metadata_values('composer'),
+        CONTRIBUTOR_FACET       => contributor,
+        CREATOR_FACET           => creator,
+        DATE_FACET              => date,
+        DATE_SORT               => date_sort,
+        DC_IS_PART_OF           => desc_metadata_values('isPartOf'),
+        DEPOSITOR               => depositor,
+        DISPLAY_FORMAT          => display_format,
+        DOI                     => adminMetadata.doi,
+        EAD_ID                  => ead_id,
+        ENGRAVER_FACET          => desc_metadata_values('engraver'),
+        FOLDER_FACET            => desc_metadata_values('folder'),
+        FORMAT_FACET            => format,
+        GENRE_FACET             => desc_metadata_values('genre'),
+        IDENTIFIER_ALL          => all_identifiers,
+        ILLUSTRATED_FACET       => desc_metadata_values('illustrated'),
+        ILLUSTRATOR_FACET       => desc_metadata_values('illustrator'),
+        INGESTED_BY             => ingested_by,
+        INGESTION_DATE          => ingestion_date,
+        INSTRUMENTATION_FACET   => desc_metadata_values('instrumentation'),
+        INTERNAL_URI            => internal_uri,
+        INTERVIEWER_NAME_FACET  => desc_metadata_values('interviewer_name'),
+        IS_FORMAT_OF            => desc_metadata_values('isFormatOf'),
+        IS_LOCKED               => is_locked,
+        LICENSE                 => license,
+        LITHOGRAPHER_FACET      => desc_metadata_values('lithographer'),
+        LOCAL_ID                => local_id,
+        LYRICIST_FACET          => desc_metadata_values('lyricist'),
+        MEDIUM_FACET            => desc_metadata_values('medium'),
+        PERFORMER_FACET         => desc_metadata_values('performer'),
+        PERMANENT_ID            => permanent_id,
+        PERMANENT_URL           => permanent_url,
+        PLACEMENT_COMPANY_FACET => desc_metadata_values('placement_company'),
+        POLICY_ROLE             => roles.in_policy_scope.agents,
+        PRODUCER_FACET          => desc_metadata_values('producer'),
+        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,
+        RIGHTS_NOTE             => rights_note,
+        ROLL_NUMBER_FACET       => desc_metadata_values('roll_number'),
+        SERIES_FACET            => desc_metadata_values('series'),
+        SETTING_FACET           => desc_metadata_values('setting'),
+        SPATIAL_FACET           => desc_metadata_values('spatial'),
+        SUBJECT_FACET           => subject,
+        SUBSERIES_FACET         => desc_metadata_values('subseries'),
+        TEMPORAL_FACET          => desc_metadata_values('temporal'),
+        TITLE                   => title_display,
+        TONE_FACET              => desc_metadata_values('tone'),
+        TYPE_FACET              => type,
+        VOLUME_FACET            => desc_metadata_values('volume'),
+        WORKFLOW_STATE          => workflow_state,
+        YEAR_FACET              => year_facet,
+      }
+      if respond_to? :fixity_checks
+        last_fixity_check = fixity_checks.last
+        fields.merge!(last_fixity_check.to_solr) if last_fixity_check
       end
-
-      def title_display
-        return title.first if title.present?
-        return identifier.first if identifier.present?
-        return original_filename if respond_to?(:original_filename) && original_filename.present?
-        "[#{pid}]"
+      if respond_to? :virus_checks
+        last_virus_check = virus_checks.last
+        fields.merge!(last_virus_check.to_solr) if last_virus_check
       end
-
-      def all_identifiers
-        identifier + [local_id, permanent_id, pid].compact
+      if has_content?
+        fields[CONTENT_CREATE_DATE] = Ddr::Utils.solr_date(content.createDate)
+        fields[CONTENT_CONTROL_GROUP] = content.controlGroup
+        fields[CONTENT_SIZE] = content_size
+        fields[CONTENT_SIZE_HUMAN] = content_human_size
+        fields[MEDIA_TYPE] = content_type
+        fields[MEDIA_MAJOR_TYPE] = content_major_type
+        fields[MEDIA_SUB_TYPE] = content_sub_type
+        fields.merge! techmd.index_fields
       end
-
-      def associated_collection
-        # XXX Can/should we use SolrDocument here?
-        # I.e., ::SolrDocument.find(admin_policy_id)
-        admin_policy
+      if has_multires_image?
+        fields[MULTIRES_IMAGE_FILE_PATH] = multires_image_file_path
       end
-
-      def admin_set_facet
-        if admin_set.present?
-          admin_set
-        elsif associated_collection.present?
-          associated_collection.admin_set
-        end
+      if has_struct_metadata?
+        fields[STRUCTURE] = structure.dereferenced_structure.to_json
       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
+      if has_extracted_text?
+        fields[EXTRACTED_TEXT] = extractedText.content
       end
-
-      def collection_facet
-        associated_collection.internal_uri if associated_collection.present?
+      if is_a? Component
+        fields[COLLECTION_URI] = collection_uri
+      end
+      if is_a? Collection
+        fields[ADMIN_SET_FACET] = admin_set_facet
+        fields[COLLECTION_FACET] = collection_facet
       end
+      if is_a? Item
+        fields[ADMIN_SET_FACET] = admin_set_facet
+        fields[COLLECTION_FACET] = collection_facet
+        fields[ALL_TEXT] = all_text
+      end
+      fields
+    end
 
-      def collection_title
-        if instance_of?(Collection)
-          title_display
-        elsif associated_collection.present?
-          associated_collection.title_display
-        end
+    def title_display
+      return title.first if title.present?
+      return identifier.first if identifier.present?
+      return original_filename if respond_to?(:original_filename) && original_filename.present?
+      "[#{pid}]"
+    end
+
+    def all_identifiers
+      identifier + [local_id, permanent_id, pid].compact
+    end
+
+    def associated_collection
+      # XXX Can/should we use SolrDocument here?
+      # I.e., ::SolrDocument.find(admin_policy_id)
+      admin_policy
+    end
+
+    def admin_set_facet
+      if admin_set.present?
+        admin_set
+      elsif associated_collection.present?
+        associated_collection.admin_set
       end
+    end
 
-      def date_sort
-        date.first
+    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 year_facet
-        YearFacet.call(self)
+    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
+
+    def year_facet
+      YearFacet.call(self)
+    end
+
   end
 end