ddr-models 3.0.0.alpha.2 → 3.0.0.alpha.3

data/lib/ddr/models/attached_file_profile.rb

@@ -0,0 +1,12 @@
+require "delegate"
+
+module Ddr::Models
+  class AttachedFileProfile < SimpleDelegator
+    include ActiveModel::Serializers::JSON
+
+    def attributes
+      { "size" => nil }
+    end
+
+  end
+end

data/lib/ddr/models/attached_files_profile.rb

@@ -0,0 +1,21 @@
+module Ddr::Models
+  class AttachedFilesProfile
+    include ActiveModel::Serializers::JSON
+
+    attr_reader :files_hash
+
+    # @param files_hash [ActiveFedora::FilesHash]
+    def initialize(files_hash)
+      @files_hash = files_hash
+    end
+
+    def attributes
+      files_hash.keys.each_with_object({}) { |k, memo| memo[k.to_s] = nil }
+    end
+
+    def read_attribute_for_serialization(key)
+      AttachedFileProfile.new(files_hash[key])
+    end
+
+  end
+end

data/lib/ddr/models/base.rb

@@ -1,95 +1,98 @@
-module Ddr
-  module Models
-    class Base < ActiveFedora::Base
+module Ddr::Models
+  class Base < ActiveFedora::Base
 
-      include Describable
-      include Governable
-      include HasThumbnail
-      include EventLoggable
-      include FixityCheckable
-      include FileManagement
-      include Indexing
-      include Hydra::Validations
-      include HasAdminMetadata
+    include ObjectApi
+    include Describable
+    include Governable
+    include HasThumbnail
+    include EventLoggable
+    include FixityCheckable
+    include FileManagement
+    include Indexing
+    include Hydra::Validations
+    include HasAdminMetadata
 
-      after_destroy do
-        notify_event :deletion
-      end
+    after_destroy do
+      notify_event :deletion
+    end
 
-      def copy_admin_policy_or_roles_from(other)
-        copy_resource_roles_from(other) unless copy_admin_policy_from(other)
-      end
+    def attached_files_profile
+      AttachedFilesProfile.new(attached_files)
+    end
 
-      def association_query(association)
-        raise NotImplementedError, "The previous implementation does not work with ActiveFedora 9."
-      end
+    def copy_admin_policy_or_roles_from(other)
+      copy_resource_roles_from(other) unless copy_admin_policy_from(other)
+    end
 
-      # e.g., "Collection duke:1"
-      def model_pid
-        [self.class.to_s, pid].join(" ")
-      end
+    def association_query(association)
+      raise NotImplementedError, "The previous implementation does not work with ActiveFedora 9."
+    end
 
-      # @override ActiveFedora::Core
-      # See ActiveFedora overrides in engine initializers
-      def adapt_to_cmodel
-        super
-      rescue ::TypeError
-        raise ContentModelError, "Cannot adapt to nil content model."
-      end
+    # e.g., "Collection duke:1"
+    def model_pid
+      [self.class.to_s, pid].join(" ")
+    end
 
-      def has_extracted_text?
-        false
-      end
+    # @override ActiveFedora::Core
+    # See ActiveFedora overrides in engine initializers
+    def adapt_to_cmodel
+      super
+    rescue ::TypeError
+      raise ContentModelError, "Cannot adapt to nil content model."
+    end
 
-      def adminMetadata
-        self
-      end
+    def has_extracted_text?
+      false
+    end
 
-      # Moves the first (descriptive metadata) identifier into
-      # (administrative metadata) local_id according to the following
-      # rubric:
-      #
-      # No existing local_id:
-      #   - Set local_id to first identifier value
-      #   - Remove first identifier value
-      #
-      # Existing local_id:
-      #   Same as first identifier value
-      #     - Remove first identifier value
-      #   Not same as first identifier value
-      #     :replace option is true
-      #       - Set local_id to first identifier value
-      #       - Remove first identifier value
-      #     :replace option is false
-      #       - Do nothing
-      #
-      # Returns true or false depending on whether the object was
-      # changed by this method
-      def move_first_identifier_to_local_id(replace: true)
-        moved = false
-        identifiers = descMetadata.identifier.to_a
-        first_id = identifiers.shift
-        if first_id
-          if local_id.blank?
-            self.local_id = first_id
+    def adminMetadata
+      self
+    end
+
+    # Moves the first (descriptive metadata) identifier into
+    # (administrative metadata) local_id according to the following
+    # rubric:
+    #
+    # No existing local_id:
+    #   - Set local_id to first identifier value
+    #   - Remove first identifier value
+    #
+    # Existing local_id:
+    #   Same as first identifier value
+    #     - Remove first identifier value
+    #   Not same as first identifier value
+    #     :replace option is true
+    #       - Set local_id to first identifier value
+    #       - Remove first identifier value
+    #     :replace option is false
+    #       - Do nothing
+    #
+    # Returns true or false depending on whether the object was
+    # changed by this method
+    def move_first_identifier_to_local_id(replace: true)
+      moved = false
+      identifiers = descMetadata.identifier.to_a
+      first_id = identifiers.shift
+      if first_id
+        if local_id.blank?
+          self.local_id = first_id
+          self.descMetadata.identifier = identifiers
+          moved = true
+        else
+          if local_id == first_id
             self.descMetadata.identifier = identifiers
             moved = true
           else
-            if local_id == first_id
+            if replace
+              self.local_id = first_id
               self.descMetadata.identifier = identifiers
               moved = true
-            else
-              if replace
-                self.local_id = first_id
-                self.descMetadata.identifier = identifiers
-                moved = true
-              end
             end
           end
         end
-        moved
       end
-
+      moved
     end
+
   end
 end

data/lib/ddr/models/describable.rb

@@ -31,8 +31,8 @@ module Ddr::Models
               when :required
                 desc_metadata_terms(:defined_attributes).select {|t| required? t}
               when :dcterms
-                MetadataMapper.dc11.unqualified_names +
-                  (MetadataMapper.dcterms.unqualified_names - MetadataMapper.dc11.unqualified_names)
+                MetadataMapping.dc11.unqualified_names +
+                  (MetadataMapping.dcterms.unqualified_names - MetadataMapping.dc11.unqualified_names)
               when :dcterms_elements11
                 Ddr::Vocab::Vocabulary.term_names(RDF::DC11)
               when :duke
@@ -48,7 +48,7 @@ module Ddr::Models
     end
 
     def desc_metadata_attributes
-      MetadataMapper.dc11.unqualified_names
+      MetadataMapping.dc11.unqualified_names
     end
 
     def desc_metadata_values(term)

data/lib/ddr/models/governable.rb

@@ -36,7 +36,7 @@ module Ddr
         when other.has_admin_policy?
           other.admin_policy_id
         when other.is_a?(Collection)
-          other.pid
+          other.id
         end
         # self.admin_policy_id = other.admin_policy_id if other.has_admin_policy?
       end

data/lib/ddr/models/indexing.rb

@@ -13,6 +13,7 @@ module Ddr
         fields = {
           ACCESS_ROLE           => roles.to_json,
           ADMIN_SET             => admin_set,
+          ATTACHED_FILES        => attached_files_profile.to_json,
           BOX_NUMBER_FACET      => desc_metadata_values('box_number'),
           CREATOR_FACET         => descMetadata.creator,
           DATE_FACET            => descMetadata.date,

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

@@ -2,17 +2,23 @@ require "ddr_aux/client"
 
 module Ddr::Models
   class License < DdrAux::Client::License
+    extend Deprecation
 
-    attr_accessor :pid
+    attr_accessor :object_id
 
     def self.call(obj)
       if obj.license
         license = find(url: obj.license)
-        license.pid = obj.pid
+        license.object_id = obj.id
         license
       end
     end
 
+    def pid
+      Deprecation.warn(License, "Use `object_id` instead.")
+      object_id
+    end
+
     def to_s
       title
     end

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

@@ -5,21 +5,15 @@ module Ddr::Models
     extend Forwardable
     include Metadata
 
-    class << self
-      def mappers
-        [ MetadataMapper.dcterms, MetadataMapper.duketerms ]
-      end
-
-      def mapper
-        @mapper ||= mappers.reduce(&:merge)
-      end
+    class_attribute :mappings
 
+    class << self
       def mapping
-        mapper.mapping
+        @mapping ||= mappings.reduce(&:merge)
       end
 
       def unqualified_names
-        mapper.unqualified_names
+        mapping.unqualified_names
       end
 
       def field_names
@@ -32,6 +26,8 @@ module Ddr::Models
       end
     end
 
+    self.mappings = [ MetadataMapping.dcterms, MetadataMapping.duketerms ].freeze
+
     attr_reader :object
 
     def_delegators :object, *field_readers

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

@@ -0,0 +1,45 @@
+module Ddr::Models
+  class MetadataMapping < SimpleDelegator
+
+    class << self
+      def build(vocab, label=nil)
+        mapping = vocab.terms.each_with_object({}) do |term, memo|
+          memo[term.qualified_name] = term
+        end
+        new(mapping, label)
+      end
+
+      def dc11
+        @dc11 ||= build(MetadataVocabulary.dc11, "DC Elements").freeze
+      end
+
+      def dcterms
+        @dcterms ||= build(MetadataVocabulary.dcterms, "DC Terms").freeze
+      end
+
+      def duketerms
+        @duketerms ||= build(MetadataVocabulary.duketerms, "Duke Terms").freeze
+      end
+    end
+
+    attr_accessor :label
+
+    def initialize(mapping=Hash.new, label=nil)
+      super(mapping)
+      @label = label
+    end
+
+    def terms
+      values
+    end
+
+    def unqualified_names
+      terms.map(&:unqualified_name)
+    end
+
+    def merge(other)
+      MetadataMapping.new(__getobj__.merge(other))
+    end
+
+  end
+end

data/lib/ddr/models/object_api.rb

@@ -0,0 +1,11 @@
+module Ddr::Models
+  #
+  # ObjectApi
+  #
+  # Common methods abstracted from classes that represent repository objects,
+  # principally SolrDocument and subclasses of Ddr::Models::Base.
+  #
+  module ObjectApi
+
+  end
+end

data/lib/ddr/models/solr_document.rb

@@ -3,24 +3,26 @@ require 'json'
 module Ddr::Models
   module SolrDocument
     extend ActiveSupport::Concern
-
-    included do
-      alias_method :pid, :id
-    end
+    extend Deprecation
+    include ObjectApi
 
     class NotFound < Error; end
 
     module ClassMethods
-      def find(pid_or_uri)
-        pid = pid_or_uri.sub(/\Ainfo:fedora\//, "")
-        query = Ddr::Index::QueryBuilder.build { |q| q.id(pid) }
+      def find(id)
+        query = Ddr::Index::QueryBuilder.build { |q| q.id(id) }
         if doc = query.docs.first
           return doc
         end
-        raise NotFound, "SolrDocument not found for \"#{pid_or_uri}\"."
+        raise NotFound, "SolrDocument not found for \"#{id}\"."
       end
     end
 
+    def pid
+      Deprecation.warn(SolrDocument, "Use `id` instead.")
+      id
+    end
+
     def inspect
       "#<#{self.class.name} id=#{id.inspect}>"
     end
@@ -75,7 +77,12 @@ module Ddr::Models
     end
 
     def datastreams
-      object_profile["datastreams"]
+      Deprecation.warn(SolrDocument, "Use `attached_files` instead.")
+      attached_files
+    end
+
+    def attached_files
+      (get_json(Ddr::Index::Fields::ATTACHED_FILES) || {}).with_indifferent_access
     end
 
     def has_datastream?(dsID)

data/lib/ddr/models/url_safe_id.rb

@@ -0,0 +1,9 @@
+module Ddr::Models
+  class UrlSafeId
+
+    def self.call(obj)
+      obj.id.gsub(/\//, "%2F")
+    end
+
+  end
+end

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "3.0.0.alpha.2"
+    VERSION = "3.0.0.alpha.3"
   end
 end

data/lib/ddr/utils.rb

@@ -95,13 +95,13 @@ module Ddr::Utils
     objs = []
     ActiveFedora::Base.find_each( { Ddr::Index::Fields::IDENTIFIER_ALL => identifier }, { :cast => true } ) { |o| objs << o }
     pids = []
-    objs.each { |obj| pids << obj.pid }
+    objs.each { |obj| pids << obj.id }
     if model.present?
-      objs.each { |obj| pids.delete(obj.pid) unless obj.is_a?(model.constantize) }
+      objs.each { |obj| pids.delete(obj.id) unless obj.is_a?(model.constantize) }
     end
     if collection.present?
       objs.each do |obj|
-        pids.delete(obj.pid) unless obj == collection || obj.parent == collection
+        pids.delete(obj.id) unless obj == collection || obj.parent == collection
       end
     end
     case pids.size