hyrax 3.0.0.pre.beta2 → 3.0.0.pre.beta3

data/lib/wings/hydra/pcdm/models/concerns/collection_valkyrie_behavior.rb

@@ -0,0 +1,27 @@
+require 'wings/hydra/pcdm/models/concerns/pcdm_valkyrie_behavior'
+
+module Wings
+  module Pcdm
+    module CollectionValkyrieBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        include Wings::Pcdm::PcdmValkyrieBehavior
+      end
+
+      ##
+      # @return [Boolean] whether this instance is a PCDM Object.
+      def pcdm_object?
+        false
+      end
+
+      ##
+      # @return [Boolean] whether this instance is a PCDM Collection.
+      def pcdm_collection?
+        true
+      end
+
+      # TODO: Add translated methods
+    end
+  end
+end

data/lib/wings/hydra/pcdm/models/concerns/object_valkyrie_behavior.rb

@@ -0,0 +1,27 @@
+require 'wings/active_fedora_converter'
+
+module Wings
+  module Pcdm
+    module ObjectValkyrieBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        include Wings::Pcdm::PcdmValkyrieBehavior
+      end
+
+      ##
+      # @return [Boolean] whether this instance is a PCDM Object.
+      def pcdm_object?
+        true
+      end
+
+      ##
+      # @return [Boolean] whether this instance is a PCDM Collection.
+      def pcdm_collection?
+        false
+      end
+
+      # TODO: Add translated methods
+    end
+  end
+end

data/lib/wings/hydra/pcdm/models/concerns/pcdm_valkyrie_behavior.rb

@@ -0,0 +1,172 @@
+require 'wings/active_fedora_converter'
+
+module Wings
+  module Pcdm
+    module PcdmValkyrieBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        attribute :member_of_collection_ids, ::Valkyrie::Types::Set.of(::Valkyrie::Types::ID)
+        attribute :member_ids, ::Valkyrie::Types::Array.of(::Valkyrie::Types::ID).meta(ordered: true)
+        # TODO: get/set via members and ordered_members
+        #   * get objs - For both, this is the same as #objects. Because the Array in Valkyrie is ordered, everything will be ordered
+        #   * get ids - always returns valkyrie ids -- can't define a method for member_ids(valkyrie: false) which would return af ids
+        #   * set - In AF, members and ordered_members are enumerable and can be set using operators << and +=.
+        #           Since member_ids is all that keeps these in wings, how can we do that here?
+      end
+
+      # TODO: Methods requiring further investigation...
+      #   #type_validator class method
+      #   #ancestor?
+
+      # TODO: Should these method NOT USED BY HYRAX be converted...
+      #   #related_object_ids
+      #   #related_objects
+
+      ##
+      # @return [Enumerable<ActiveFedora::Base> | Enumerable<Valkyrie::Resource>] an enumerable over the parent collections
+      def parent_collections(valkyrie: false)
+        af_collections = parent_collection_ids.map { |id| ActiveFedora::Base.find(id) }
+        return af_collections unless valkyrie
+        af_collections.map(&:valkyrie_resource)
+      end
+      alias member_of_collections parent_collections
+
+      ##
+      # @return [Enumerable<String> | Enumerable<Valkyrie::ID] the parent collection ids
+      def parent_collection_ids(valkyrie: false)
+        return member_of_collection_ids if valkyrie
+        member_of_collection_ids.map(&:id)
+      end
+      # alias member_of_collection_ids child_object_ids # TODO: Cannot alias in this way because member_of_collection_ids method is already defined thru the attribute definition.
+
+      ##
+      # @return [Enumerable<ActiveFedora::Base> | Enumerable<Valkyrie::Resource>] an enumerable over the child collections
+      # @todo There is no guarantee to collection ordering until Hyrax is fully valkyrie-native, see issue 3784
+      def child_collections(valkyrie: false)
+        resources = Hyrax.query_service.custom_queries.find_child_collections(resource: self)
+        return resources if valkyrie
+        resources.map { |r| Wings::ActiveFedoraConverter.new(resource: r).convert }
+      end
+      alias collections child_collections
+      alias member_collections child_collections
+      alias ordered_collections child_collections
+
+      ##
+      # @return [Enumerable<String> | Enumerable<Valkyrie::ID] the child collection ids
+      # @todo There is no guarantee to collection ordering until Hyrax is fully valkyrie-native, see issue 3784
+      def child_collection_ids(valkyrie: false)
+        child_collections(valkyrie: valkyrie).map(&:id)
+      end
+      alias collection_ids child_collection_ids
+      alias member_collection_ids child_collection_ids
+      alias ordered_collection_ids child_collection_ids
+
+      ##
+      # Gives the subset of #members that are PCDM objects
+      # @return [Enumerable<ActiveFedora::Base> | Enumerable<Valkyrie::Resource>] an enumerable over the members
+      #   that are PCDM objects
+      # @note A collection could be added to members, but for Hyrax collections are stored using member_of_collection_ids.
+      #       As long as this rule holds, then members and ordered_members are equivalent to objects/child_objects.
+      # @todo Do we want to support members separate from child_objects (see NOTE)
+      def child_objects(valkyrie: false)
+        af_objects = Wings::ActiveFedoraConverter.new(resource: self).convert.objects
+        return af_objects unless valkyrie
+        af_objects.map(&:valkyrie_resource)
+      end
+      alias objects child_objects
+      alias ordered_objects child_objects
+      alias members child_objects
+      alias ordered_members child_objects
+      alias member_works child_objects
+
+      ##
+      # Gives a subset of #member_ids, where all elements are PCDM objects.
+      # @return [Enumerable<String> | Enumerable<Valkyrie::ID] the object ids
+      # @note A collection could be added to member_ids, but for Hyrax collections are stored using member_of_collection_ids.
+      #       As long as this rule holds, then member_ids and ordered_member_ids are equivalent to object_ids/child_object_ids.
+      # @todo Do we want to support member_ids separate from child_objects (see NOTE)
+      def child_object_ids(valkyrie: false)
+        child_objects(valkyrie: valkyrie).map(&:id)
+      end
+      alias object_ids child_object_ids
+      alias ordered_object_ids child_object_ids
+      # alias member_ids child_object_ids # TODO: Cannot alias in this way because member_ids method is already defined thru the attribute definition.
+      alias ordered_members_ids child_object_ids
+      alias member_work_ids child_object_ids
+
+      ##
+      # @return [Enumerable<ActiveFedora::Base> | Enumerable<Valkyrie::Resource>] the collections the
+      #    collection or object is a member of.
+      # @note For Hyrax, member_of_collection_ids is used to hold the parent collections.
+      #       members is used to hold the child works and child filesets.  This method looks
+      #       in solr for the members relationship and infers a member_of relationship through
+      #       a solr query by looking for all parents that have self's id in their members list.
+      def member_of(valkyrie: false)
+        af_id = valkyrie ? id : id.id
+        return [] if af_id.nil?
+        af_parents = Wings::ActiveFedoraConverter.new(resource: self).convert.member_of
+        return af_parents unless valkyrie
+        af_parents.map(&:valkyrie_resource)
+      end
+      alias parent_objects member_of
+
+      # @return [Enumerable<ActiveFedora::Base> | Enumerable<Valkyrie::Resource>] the collections the
+      #   object is a member of.
+      # @todo This is using the member_of method which uses the members relationship.  That should
+      #       never return any collections since they are stored using the member_of_collection
+      #       relationship.  But this method is called in characterize_job.rb and collection_indexer.rb.
+      #       It could be that these are no-ops because nothing is ever returned, but more exploration
+      #       is needed to determine this.
+      def in_collections(valkyrie: false)
+        member_of(valkyrie: valkyrie).select(&:pcdm_collection?).to_a
+      end
+
+      # @return [Enumerable<String> | Enumerable<Valkyrie::ID] ids for collections the object is a member of
+      # @todo This is using the member_of method which uses the members relationship.  That should
+      #       never return any collections since they are stored using the member_of_collection
+      #       relationship.  But this method is called in base_actor.rb #destroy.
+      #       It could be that these are no-ops because nothing is ever returned, but more exploration
+      #       is needed to determine this.
+      def in_collection_ids(valkyrie: false)
+        in_collections(valkyrie: valkyrie).map(&:id)
+      end
+
+      ##
+      # Any method not implemented is sent to the ActiveFedora version of the resource.
+      def method_missing(name, *args, &block)
+        # TODO: Remove the puts and this method when all methods are valkyrized
+        af_object = Wings::ActiveFedoraConverter.new(resource: self).convert
+        unless af_object.respond_to? name
+          Rails.logger.warn "#{af_object.class} does not respond to method #{name}"
+          super
+        end
+        Rails.logger.info "Calling through Method Missing with name: #{name}    args: #{args}   block_given? #{block_given?}"
+        args.delete_if { |arg| arg.is_a?(Hash) && arg.key?(:valkyrie) }
+        return af_object.send(name, args, block) if block_given?
+        return af_object.send(name, args) if args.present?
+        af_object.send(name)
+      end
+
+      def respond_to_missing?(_name, _include_private = false)
+        true
+      end
+
+      # @param valkyrie [Boolean] Should the returned ids be for Valkyrie or AF objects?
+      # @return [Enumerable<Hydra::Works::Work>] The works this work is contained in
+      # @note This method avoids using the Hydra::Works version of parent_works because of Issue #361
+      def parent_works(valkyrie: false)
+        af_child = Wings::ActiveFedoraConverter.new(resource: self).convert
+        af_parents = af_child.member_of_works
+        return af_parents unless valkyrie
+        af_parents.map(&:valkyrie_resource)
+      end
+
+      # @param valkyrie [Boolean] Should the returned ids be for Valkyrie or AF objects?
+      # @return [Enumerable<String> | Enumerable<Valkyrie::ID>] The ids of the works this work is contained in
+      def parent_work_ids(valkyrie: false)
+        parent_works(valkyrie: valkyrie).map(&:id)
+      end
+    end
+  end
+end

data/lib/wings/hydra/works/models/concerns/collection_valkyrie_behavior.rb

@@ -0,0 +1,30 @@
+require 'wings/hydra/pcdm/models/concerns/collection_valkyrie_behavior'
+
+module Wings
+  module Works
+    module CollectionValkyrieBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        include Wings::Pcdm::CollectionValkyrieBehavior
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works Collection.
+      def collection?
+        true
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
+      def work?
+        false
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works::FileSet.
+      def file_set?
+        false
+      end
+
+      # TODO: Add translated methods
+    end
+  end
+end

data/lib/wings/hydra/works/models/concerns/file_set_valkyrie_behavior.rb

@@ -0,0 +1,30 @@
+require 'wings/hydra/pcdm/models/concerns/object_valkyrie_behavior'
+
+module Wings
+  module Works
+    module FileSetValkyrieBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        include Wings::Pcdm::ObjectValkyrieBehavior
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works Collection.
+      def collection?
+        false
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
+      def work?
+        false
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works::FileSet.
+      def file_set?
+        true
+      end
+
+      # TODO: Add translated methods
+    end
+  end
+end

data/lib/wings/hydra/works/models/concerns/work_valkyrie_behavior.rb

@@ -0,0 +1,59 @@
+require 'wings/hydra/pcdm/models/concerns/object_valkyrie_behavior'
+
+module Wings
+  module Works
+    module WorkValkyrieBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        include Wings::Pcdm::ObjectValkyrieBehavior
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works Collection.
+      def collection?
+        false
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
+      def work?
+        true
+      end
+
+      # @return [Boolean] whether this instance is a Hydra::Works::FileSet.
+      def file_set?
+        false
+      end
+
+      # @param valkyrie [Boolean] Should the returned resources be Valkyrie or AF objects?
+      # @return [Enumerable<Hydra::Works::Work>] The works this work contains
+      def child_works(valkyrie: false)
+        child_objects(valkyrie: valkyrie).select(&:work?)
+      end
+      alias works child_works
+      alias member_works child_works
+
+      # @param valkyrie [Boolean] Should the returned ids be for Valkyrie or AF objects?
+      # @return [Enumerable<String> | Enumerable<Valkerie::ID] The ids of the works this work contains
+      def child_work_ids(valkyrie: false)
+        child_works(valkyrie: valkyrie).map(&:id)
+      end
+      alias work_ids child_work_ids
+
+      # @param valkyrie [Boolean] Should the returned resources be Valkyrie or AF objects?
+      # @return [Enumerable<Hydra::Works::FileSet>] The file sets this work contains
+      def child_file_sets(valkyrie: false)
+        child_objects(valkyrie: valkyrie).select(&:file_set?)
+      end
+      alias file_sets child_file_sets
+
+      # @param valkyrie [Boolean] Should the returned ids be for Valkyrie or AF objects?
+      # @return [Enumerable<String> | Enumerable<Valkerie::ID] The ids of the file sets this work contains
+      def child_file_set_ids(valkyrie: false)
+        child_file_sets(valkyrie: valkyrie).map(&:id)
+      end
+      alias file_set_ids child_file_set_ids
+
+      # TODO: Add translated methods
+    end
+  end
+end

data/lib/wings/hydra/works/services/add_file_metadata_to_file_set.rb

@@ -0,0 +1,113 @@
+# TODO: This should live in Hyrax::AddFileMetadataToFileSet service and should work for all valkyrie adapters.
+module Wings::Works
+  class AddFileMetadataToFileSet
+    # Adds a file to the file_set
+    # @param file_set [Valkyrie::Resource] adding file to this file set
+    # @param file_metadata [Hyrax::FileMetadata] uploaded file and its metadata
+    # @param update_existing [Boolean] whether to update an existing file if there is one. When set to true, performs a create_or_update.
+    #   When set to false, always creates a new file within file_set.files.
+    # @param versioning [Boolean] whether to create new version entries (only applicable if file_metadata's +type+ corresponds to a versionable file)
+
+    def self.call(file_set:, file_metadata:, file:, update_existing: true, versioning: true)
+      raise ArgumentError, 'supplied object must be a file set' unless file_set.file_set?
+      raise ArgumentError, 'supplied object must be an instance of Hyrax::FileMetadata' unless file_metadata.is_a? Hyrax::FileMetadata
+      raise ArgumentError, 'supplied file must respond to read' unless file.respond_to? :read
+
+      # TODO: required as a workaround for https://github.com/samvera/active_fedora/pull/858
+      # file_set.save unless file_set.persisted? # TODO: May not need to do the save first when this is a resource.
+
+      af_file_set = Wings::ActiveFedoraConverter.new(resource: file_set).convert
+
+      updater_class = versioning ? VersioningUpdater : Updater
+      updater = updater_class.new(af_file_set, file_metadata, file, update_existing)
+      status = updater.update
+      status ? file_set : false
+    end
+
+    class Updater
+      attr_reader :af_file_set, :file_metadata, :file, :current_file
+
+      def initialize(af_file_set, file_metadata, file, update_existing)
+        @af_file_set = af_file_set
+        @file_metadata = file_metadata
+        @file = file
+        @current_file = find_or_create_file(association_type(file_metadata.use), update_existing)
+      end
+
+      # @param [#read] file object that will be interrogated using the methods: :path, :original_name, :original_filename, :mime_type, :content_type
+      # None of the attribute description methods are required.
+      def update
+        attach_attributes
+        persist
+      end
+
+      private
+
+        # @param [RDF::URI] the identified use of the file (e.g. Valkyrie::Vocab::PCDMUse.OriginalFile, Valkyrie::Vocab::PCDMUse.ThumbnailImage, etc.)
+        # @param [true, false] update_existing when true, try to retrieve existing element before building one
+        def find_or_create_file(type, update_existing)
+          association = af_file_set.association(type)
+          raise ArgumentError, "you're attempting to add a file to a file_set using '#{type}' association but the file_set does not have an association called '#{type}''" unless association
+          current_file = association.reader if update_existing
+          current_file || association.build
+        end
+
+        def association_type(use)
+          use.first.to_s.split('#').second.underscore.to_sym
+        end
+
+        # Persist a new file with its containing file set; otherwise, just save the file itself
+        def persist
+          if current_file.new_record?
+            af_file_set.save
+          else
+            current_file.save
+          end
+          file_metadata.file_identifiers = [current_file.id.split('/')[-1]]
+        end
+
+        def attach_attributes
+          current_file.content = file
+          current_file.original_name = file_metadata.original_filename.first
+          current_file.mime_type = file_metadata.mime_type.first
+          set_active_fedora_metadata_node_values(current_file.metadata_node, attributes_from_file_metadata)
+          persist
+        end
+
+        def set_active_fedora_metadata_node_values(metadata_node, attributes)
+          metadata_node.label = attributes[:label]
+          metadata_node.mime_type = attributes[:mime_type]
+          metadata_node.format_label = attributes[:format_label]
+          metadata_node.height = attributes[:height]
+          metadata_node.width = attributes[:width]
+          metadata_node.original_checksum = attributes[:checksum]
+          metadata_node.file_size = attributes[:size]
+          metadata_node.file_name = attributes[:original_filename]
+          # TODO: May need to add others.  FileMetadata class definition has the full list of attrs for metadata_node
+        end
+
+        def attributes_from_file_metadata
+          attrs = file_metadata.attributes.dup
+          attrs.delete(:file_identifiers)
+          attrs.delete(:id)
+          attrs.delete(:alternate_ids)
+          attrs.delete(:internal_resource)
+          attrs.delete(:new_record)
+          attrs.delete(:created_at)
+          attrs.delete(:updated_at)
+          attrs.delete(:content)
+          attrs.delete(:mime_type)
+          attrs.delete(:use)
+          attrs.delete(:original_name)
+          attrs.compact
+          attrs
+        end
+    end
+
+    class VersioningUpdater < Updater
+      def update(*)
+        super && current_file.create_version
+      end
+    end
+  end
+end