ddr-models 2.11.0 → 3.0.0.alpha.1

data/lib/ddr/models/has_thumbnail.rb

@@ -4,10 +4,7 @@ module Ddr
       extend ActiveSupport::Concern
 
       included do
-        has_file_datastream name: Ddr::Datastreams::THUMBNAIL,
-                            versionable: true,
-                            label: "Thumbnail for this object",
-                            control_group: 'M'
+        contains Ddr::Datastreams::THUMBNAIL
       end
 
       def thumbnail_changed?

data/lib/ddr/models/indexing.rb

@@ -1,205 +1,116 @@
-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 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,
-        AFFILIATION             => affiliation,
-        AFFILIATION_FACET       => affiliation,
-        ALEPH_ID                => aleph_id,
-        ARRANGER_FACET          => desc_metadata_values('arranger'),
-        ASPACE_ID               => aspace_id,
-        ATTACHED_FILES_HAVING_CONTENT => attached_files_having_content.keys,
-        BIBLICAL_BOOK_FACET     => desc_metadata_values('biblical_book'),
-        BOX_NUMBER_FACET        => desc_metadata_values('box_number'),
-        CATEGORY_FACET          => desc_metadata_values('category'),
-        CHAPTER_AND_VERSE_FACET => desc_metadata_values('chapter_and_verse'),
-        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,
-        LANGUAGE_FACET          => language_name,
-        LANGUAGE_NAME           => language_name,
-        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
-      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
+      def to_solr(solr_doc=Hash.new, opts={})
+        solr_doc = super(solr_doc, opts)
+        solr_doc.merge index_fields
       end
-      if has_struct_metadata?
-        fields[STRUCTURE] = structure.dereferenced_structure.to_json
-        fields[STRUCTURE_SOURCE] = structure.repository_maintained? ? Ddr::Models::Structure::REPOSITORY_MAINTAINED
-                                                                    : Ddr::Models::Structure::EXTERNALLY_PROVIDED
-      end
-      if has_extracted_text?
-        fields[EXTRACTED_TEXT] = extractedText.content
-      end
-      if streamable?
-        fields[STREAMABLE_MEDIA_TYPE] = streamable_media_type
-      end
-      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[NESTED_PATH] = nested_path
-        fields[NESTED_PATH_TEXT] = nested_path
-        fields[ALL_TEXT] = all_text
-      end
-      fields
-    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 index_fields
+        fields = {
+          ACCESS_ROLE           => roles.to_json,
+          ADMIN_SET             => admin_set,
+          BOX_NUMBER_FACET      => desc_metadata_values('box_number'),
+          CREATOR_FACET         => descMetadata.creator,
+          DATE_FACET            => descMetadata.date,
+          DATE_SORT             => date_sort,
+          DEPOSITOR             => depositor,
+          DISPLAY_FORMAT        => display_format,
+          DOI                   => doi,
+          EAD_ID                => ead_id,
+          IDENTIFIER_ALL        => all_identifiers,
+          LICENSE               => license,
+          LOCAL_ID              => local_id,
+          PERMANENT_ID          => permanent_id,
+          PERMANENT_URL         => permanent_url,
+          POLICY_ROLE           => roles.in_policy_scope.agents,
+          PUBLISHER_FACET       => descMetadata.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'),
+          TITLE                 => title_display,
+          TYPE_FACET            => descMetadata.type,
+          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_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_id
+        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
+        end
+        fields
+      end
 
-    def associated_collection
-      # XXX Can/should we use SolrDocument here?
-      # I.e., ::SolrDocument.find(admin_policy_id)
-      admin_policy
-    end
+      def title_display
+        return descMetadata.title.first if descMetadata.title.present?
+        return descMetadata.identifier.first if descMetadata.identifier.present?
+        return original_filename if respond_to?(:original_filename) && original_filename.present?
+        "[#{pid}]"
+      end
 
-    def admin_set_facet
-      if admin_set.present?
-        admin_set
-      elsif associated_collection.present?
-        associated_collection.admin_set
+      def all_identifiers
+        descMetadata.identifier + [local_id, permanent_id, pid].compact
       end
-    end
 
-    def admin_set_title
-      code = if admin_set.present?
-               admin_set
-             elsif associated_collection.present?
-               associated_collection.admin_set
-             else
-               nil
-             end
-      if code && ( as = AdminSet.find_by_code(code) )
-        as.title
+      def associated_collection
+        admin_policy
       end
-    end
 
-    def collection_facet
-      associated_collection.internal_uri if associated_collection.present?
-    end
+      def admin_set_facet
+        if admin_set.present?
+          admin_set
+        elsif associated_collection.present?
+          associated_collection.admin_set
+        end
+      end
 
-    def collection_title
-      if instance_of?(Collection)
-        title_display
-      elsif associated_collection.present?
-        associated_collection.title_display
+      def collection_facet
+        associated_collection.id if associated_collection.present?
       end
-    end
 
-    def date_sort
-      date.first
-    end
+      def date_sort
+        descMetadata.date.first
+      end
 
-    def language_name
-      language.map do |lang|
-        Language.find_by_code(lang).to_s rescue lang
+      def year_facet
+        YearFacet.call(self)
       end
-    end
 
-    def year_facet
-      YearFacet.call(self)
     end
-
   end
 end

data/lib/ddr/models/licenses/admin_policy_license.rb

@@ -0,0 +1,11 @@
+module Ddr::Models
+  class AdminPolicyLicense
+
+    def self.call(obj)
+      if obj.admin_policy_id && (obj.admin_policy_id != obj.id)
+        License.call obj.admin_policy
+      end
+    end
+
+  end
+end

data/lib/ddr/models/licenses/effective_license.rb

@@ -0,0 +1,9 @@
+module Ddr::Models
+  class EffectiveLicense
+
+    def self.call(obj)
+      License.call(obj) || InheritedLicense.call(obj)
+    end
+
+  end
+end

data/lib/ddr/models/licenses/inherited_license.rb

@@ -0,0 +1,9 @@
+module Ddr::Models
+  class InheritedLicense
+
+    def self.call(obj)
+      ParentLicense.call(obj) || AdminPolicyLicense.call(obj)
+    end
+
+  end
+end

data/lib/ddr/models/licenses/license.rb

@@ -0,0 +1,21 @@
+require "ddr_aux/client"
+
+module Ddr::Models
+  class License < DdrAux::Client::License
+
+    attr_accessor :pid
+
+    def self.call(obj)
+      if obj.license
+        license = find(url: obj.license)
+        license.pid = obj.pid
+        license
+      end
+    end
+
+    def to_s
+      title
+    end
+
+  end
+end

data/lib/ddr/models/licenses/parent_license.rb

@@ -0,0 +1,11 @@
+module Ddr::Models
+  class ParentLicense
+
+    def self.call(obj)
+      if obj.respond_to?(:parent) && obj.parent
+        License.call(obj.parent)
+      end
+    end
+
+  end
+end

data/lib/ddr/models/metadata/descriptive_metadata.rb

@@ -0,0 +1,50 @@
+require "forwardable"
+
+module Ddr::Models
+  class DescriptiveMetadata
+    extend Forwardable
+    include Metadata
+
+    class << self
+      def mappers
+        [ MetadataMapper.dcterms, MetadataMapper.duketerms ]
+      end
+
+      def mapper
+        @mapper ||= mappers.reduce(&:merge)
+      end
+
+      def mapping
+        mapper.mapping
+      end
+
+      def unqualified_names
+        mapper.unqualified_names
+      end
+
+      def field_names
+        mapping.keys
+      end
+      alias_method :field_readers, :field_names
+
+      def field_writers
+        field_names.map { |name| "#{name}=".to_sym }
+      end
+    end
+
+    attr_reader :object
+
+    def_delegators :object, *field_readers
+    def_delegators :object, *field_writers
+
+    mapping.each do |qualified_name, term|
+      def_delegator :object, qualified_name, term.unqualified_name
+      def_delegator :object, "#{qualified_name}=".to_sym, "#{term.unqualified_name}=".to_sym
+    end
+
+    def initialize(object)
+      @object = object
+    end
+
+  end
+end

data/lib/ddr/models/metadata/metadata.rb

@@ -0,0 +1,37 @@
+module Ddr::Models
+  module Metadata
+
+    def values(term)
+      self.send(term)
+    end
+
+    # Update term with values
+    # Note that empty values (nil or "") are rejected from values array
+    def set_values(term, values)
+      if values.respond_to?(:reject!)
+        values.reject! { |v| v.blank? }
+      else
+        values = nil if values.blank?
+      end
+      begin
+        self.send("#{term}=", values)
+      rescue NoMethodError
+        raise ArgumentError, "No such term: #{term}"
+      end
+    end
+
+    # Add value to term
+    # Note that empty value (nil or "") is not added
+    def add_value(term, value)
+      begin
+        unless value.blank?
+          values = values(term).to_a << value
+          set_values term, values
+        end
+      rescue NoMethodError
+        raise ArgumentError, "No such term: #{term}"
+      end
+    end
+
+  end
+end