test_hyrax 0.0.1.alpha

data/app/models/concerns/hyrax/admin_set_behavior.rb

@@ -0,0 +1,59 @@
+module Hyrax
+  # There is an interplay between an AdminSet and a PermissionTemplate. Given
+  # that AdminSet is an ActiveFedora::Base and PermissionTemplate is ActiveRecord::Base
+  # we don't have the usual :has_many or :belongs_to methods to assist in defining that
+  # relationship. However, from a conceptual standpoint:
+  #
+  # * An AdminSet has_one :permission_tempate
+  # * A PermissionTemplate belongs_to :admin_set
+  #
+  # When an object is added as a member of an AdminSet, the AdminSet's associated
+  # PermissionTemplate is applied to that object (e.g. some of the object's attributes
+  # are updated as per the rules of the permission template)
+  #
+  # @see AdminSet
+  # @see Hyrax::PermissionTemplate
+  # @see Hyrax::AdminSetService
+  # @see Hyrax::Forms::PermissionTemplateForm for validations and creation process
+  # @see Hyrax::DefaultAdminSetActor
+  # @see Hyrax::ApplyPermissionTemplateActor  module AdminSetBehavior
+  module AdminSetBehavior
+    extend ActiveSupport::Concern
+
+    include Hydra::AccessControls::WithAccessRight
+    include Hyrax::Noid
+    include Hyrax::HumanReadableType
+    include Hyrax::HasRepresentative
+
+    included do
+      validates_with HasOneTitleValidator
+      class_attribute :human_readable_short_description, :indexer
+      self.indexer = Hyrax::AdminSetIndexer
+      property :title, predicate: ::RDF::Vocab::DC.title do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :description, predicate: ::RDF::Vocab::DC.description do |index|
+        index.as :stored_searchable
+      end
+
+      property :creator, predicate: ::RDF::Vocab::DC11.creator do |index|
+        index.as :symbol
+      end
+
+      has_many :members,
+               predicate: ::RDF::Vocab::DC.isPartOf,
+               class_name: 'ActiveFedora::Base'
+    end
+
+    def to_s
+      title.present? ? title : 'No Title'
+    end
+
+    # A bit of an analogue for a `has_one :admin_set` as it crosses from Fedora to the DB
+    # @return [Hyrax::PermissionTemplate]
+    # @raise [ActiveRecord::RecordNotFound]
+    def permission_template
+      Hyrax::PermissionTemplate.find_by!(admin_set_id: id)
+    end
+  end
+end

data/app/models/concerns/hyrax/basic_metadata.rb

@@ -0,0 +1,72 @@
+module Hyrax
+  module BasicMetadata
+    extend ActiveSupport::Concern
+
+    included do
+      property :label, predicate: ActiveFedora::RDF::Fcrepo::Model.downloadFilename, multiple: false
+
+      property :relative_path, predicate: ::RDF::URI.new('http://scholarsphere.psu.edu/ns#relativePath'), multiple: false
+
+      property :import_url, predicate: ::RDF::URI.new('http://scholarsphere.psu.edu/ns#importUrl'), multiple: false do |index|
+        index.as :symbol
+      end
+
+      property :part_of, predicate: ::RDF::Vocab::DC.isPartOf
+      property :resource_type, predicate: ::RDF::Vocab::DC.type do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :creator, predicate: ::RDF::Vocab::DC11.creator do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :contributor, predicate: ::RDF::Vocab::DC11.contributor do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :description, predicate: ::RDF::Vocab::DC11.description do |index|
+        index.type :text
+        index.as :stored_searchable
+      end
+      property :keyword, predicate: ::RDF::Vocab::DC11.relation do |index|
+        index.as :stored_searchable, :facetable
+      end
+
+      # Used for a license
+      property :rights, predicate: ::RDF::Vocab::DC.rights do |index|
+        index.as :stored_searchable
+      end
+
+      # This is for the rights statement
+      property :rights_statement, predicate: ::RDF::Vocab::EDM.rights do |index|
+        index.as :stored_searchable
+      end
+
+      property :publisher, predicate: ::RDF::Vocab::DC11.publisher do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :date_created, predicate: ::RDF::Vocab::DC.created do |index|
+        index.as :stored_searchable
+      end
+
+      property :subject, predicate: ::RDF::Vocab::DC11.subject do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :language, predicate: ::RDF::Vocab::DC11.language do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :identifier, predicate: ::RDF::Vocab::DC.identifier do |index|
+        index.as :stored_searchable
+      end
+      property :based_near, predicate: ::RDF::Vocab::FOAF.based_near do |index|
+        index.as :stored_searchable, :facetable
+      end
+      property :related_url, predicate: ::RDF::RDFS.seeAlso do |index|
+        index.as :stored_searchable
+      end
+      property :bibliographic_citation, predicate: ::RDF::Vocab::DC.bibliographicCitation do |index|
+        index.as :stored_searchable
+      end
+      property :source, predicate: ::RDF::Vocab::DC.source do |index|
+        index.as :stored_searchable
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/collection_behavior.rb

@@ -0,0 +1,87 @@
+module Hyrax
+  module CollectionBehavior
+    extend ActiveSupport::Concern
+    include Hydra::AccessControls::WithAccessRight
+    include Hydra::WithDepositor # for access to apply_depositor_metadata
+    include Hydra::AccessControls::Permissions
+    include Hyrax::RequiredMetadata
+    include Hydra::Works::CollectionBehavior
+    include Hyrax::Noid
+    include Hyrax::HumanReadableType
+    include Hyrax::HasRepresentative
+    include Hyrax::Permissions
+
+    included do
+      validates_with HasOneTitleValidator
+      self.indexer = Hyrax::CollectionIndexer
+    end
+
+    # Add members using the members association.
+    def add_members(new_member_ids)
+      return if new_member_ids.nil? || new_member_ids.empty?
+      members << ActiveFedora::Base.find(new_member_ids)
+    end
+
+    # Add member objects by adding this collection to the objects' member_of_collection association.
+    def add_member_objects(new_member_ids)
+      Array(new_member_ids).each do |member_id|
+        member = ActiveFedora::Base.find(member_id)
+        member.member_of_collections << self
+        member.save!
+      end
+    end
+
+    def member_objects
+      ActiveFedora::Base.where("member_of_collection_ids_ssim:#{id}")
+    end
+
+    def to_s
+      title.present? ? title.join(' | ') : 'No Title'
+    end
+
+    module ClassMethods
+      # This governs which partial to draw when you render this type of object
+      def _to_partial_path #:nodoc:
+        @_to_partial_path ||= begin
+          element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
+          collection = ActiveSupport::Inflector.tableize(name)
+          "hyrax/#{collection}/#{element}".freeze
+        end
+      end
+    end
+
+    # Compute the sum of each file in the collection using Solr to
+    # avoid having to access Fedora
+    #
+    # @return [Fixnum] size of collection in bytes
+    # @raise [RuntimeError] unsaved record does not exist in solr
+    def bytes
+      return 0 if member_ids.empty?
+
+      raise "Collection must be saved to query for bytes" if new_record?
+
+      # One query per member_id because Solr is not a relational database
+      sizes = member_ids.collect do |work_id|
+        argz = { fl: "id, #{file_size_field}",
+                 fq: "{!join from=#{member_ids_field} to=id}id:#{work_id}" }
+        files = ::FileSet.search_with_conditions({}, argz)
+        files.reduce(0) { |sum, f| sum + f[file_size_field].to_i }
+      end
+
+      sizes.reduce(0, :+)
+    end
+
+    private
+
+      # Field name to look up when locating the size of each file in Solr.
+      # Override for your own installation if using something different
+      def file_size_field
+        Solrizer.solr_name(:file_size, Hyrax::FileSetIndexer::STORED_LONG)
+      end
+
+      # Solr field name collections and works use to index member ids
+      def member_ids_field
+        Solrizer.solr_name('member_ids', :symbol)
+      end
+  end
+end

data/app/models/concerns/hyrax/content_block_behavior.rb

@@ -0,0 +1,47 @@
+module Hyrax
+  module ContentBlockBehavior
+    extend ActiveSupport::Concern
+
+    MARKETING  = 'marketing_text'.freeze
+    RESEARCHER = 'featured_researcher'.freeze
+    ANNOUNCEMENT = 'announcement_text'.freeze
+
+    def external_key_name
+      self.class.external_keys.fetch(name) { 'External Key' }
+    end
+
+    class_methods do
+      def marketing_text
+        find_or_create_by(name: MARKETING)
+      end
+
+      def marketing_text=(value)
+        marketing_text.update(value: value)
+      end
+
+      def announcement_text
+        find_or_create_by(name: ANNOUNCEMENT)
+      end
+
+      def announcement_text=(value)
+        announcement_text.update(value: value)
+      end
+
+      def recent_researchers
+        where(name: RESEARCHER).order('created_at DESC')
+      end
+
+      def featured_researcher
+        recent_researchers.first_or_create(name: RESEARCHER)
+      end
+
+      def featured_researcher=(value)
+        create(name: RESEARCHER, value: value)
+      end
+
+      def external_keys
+        { RESEARCHER => 'User' }
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/file_set/belongs_to_works.rb

@@ -0,0 +1,49 @@
+module Hyrax
+  module FileSet
+    module BelongsToWorks
+      extend ActiveSupport::Concern
+
+      included do
+        before_destroy :remove_representative_relationship
+      end
+
+      def parents
+        in_works
+      end
+
+      # Returns the first parent object
+      # This is a hack to handle things like FileSets inheriting access controls from their parent.  (see Hyrax::ParentContainer in app/controllers/concerns/curation_concers/parent_container.rb)
+      def parent
+        parents.first
+      end
+
+      # Returns the id of first parent object
+      # This is a hack to handle things like FileSets inheriting access controls from their parent.  (see Hyrax::ParentContainer in app/controllers/concerns/curation_concers/parent_container.rb)
+      delegate :id, to: :parent, prefix: true
+
+      # Files with sibling relationships
+      # Returns all FileSets aggregated by any of the parent objects that
+      # aggregate the current object
+      def related_files
+        parent_objects = parents
+        return [] if parent_objects.empty?
+        parent_objects.flat_map do |work|
+          work.file_sets.select do |file_set|
+            file_set.id != id
+          end
+        end
+      end
+
+      # If any parent objects are pointing at this object as their
+      # representative, remove that pointer.
+      def remove_representative_relationship
+        parent_objects = parents
+        return if parent_objects.empty?
+        parent_objects.each do |work|
+          work.update(representative_id: nil) if work.representative_id == id
+        end
+      end
+    end
+  end
+end
+\

data/app/models/concerns/hyrax/file_set/characterization.rb

@@ -0,0 +1,51 @@
+# This module points the FileSet to the location of the technical metdata.
+# By default, the file holding the metadata is :original_file and the terms
+# are listed under ::characterization_terms.
+# Implementations may define their own terms or use a different source file, but
+# any terms must be set on the ::characterization_proxy by the Hydra::Works::CharacterizationService
+#
+# class MyFileSet
+#   include Hyrax::FileSetBehavior
+# end
+#
+# MyFileSet.characterization_proxy = :master_file
+# MyFileSet.characterization_terms = [:term1, :term2, :term3]
+module Hyrax
+  module FileSet
+    module Characterization
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :characterization_terms, :characterization_proxy
+        self.characterization_terms = [
+          :format_label, :file_size, :height, :width, :filename, :well_formed,
+          :page_count, :file_title, :last_modified, :original_checksum, :mime_type,
+          :duration, :sample_rate
+        ]
+        self.characterization_proxy = :original_file
+
+        delegate(*characterization_terms, to: :characterization_proxy)
+
+        def characterization_proxy
+          send(self.class.characterization_proxy) || NullCharacterizationProxy.new
+        end
+
+        def characterization_proxy?
+          !characterization_proxy.is_a?(NullCharacterizationProxy)
+        end
+      end
+
+      class NullCharacterizationProxy
+        def method_missing(*_args)
+          []
+        end
+
+        def respond_to_missing?(_method_name, _include_private = false)
+          super
+        end
+
+        def mime_type; end
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/file_set/derivatives.rb

@@ -0,0 +1,61 @@
+module Hyrax
+  module FileSet
+    module Derivatives
+      extend ActiveSupport::Concern
+
+      included do
+        # TODO: These should be moved to an initializer. However, there is a timing bug in place.
+        #       If the following Hydra::Derivatives configuration is moved to an initializer, then the
+        #       Hydra::Works configuration obliterates our new configuration.
+        #       https://github.com/projecthydra/hydra-works/blob/d0e87d017c20ffbecbaeda8c09b376747b9cdebc/lib/hydra/works/models/concerns/file_set/derivatives.rb
+        #
+        #       This manifests as the following errors:
+        #
+        #       The following errors were encountered by moving the following class variables
+        #       Failures:
+        #
+        #       1) IngestFileJob with two existing versions from different users has two versions
+        #          Failure/Error: yield ::File.open(file_name)
+        #
+        #          KeyError:
+        #            key not found: :object
+        #          # ./app/services/hyrax/local_file_service.rb:7:in `call'
+        #          # ./app/services/hyrax/file_set_derivatives_service.rb:60:in `create_image_derivatives'
+        #          # ./app/services/hyrax/file_set_derivatives_service.rb:24:in `create_derivatives'
+        #          # ./app/models/concerns/hyrax/file_set/derivatives.rb:11:in `create_derivatives'
+        #          # ./app/jobs/create_derivatives_job.rb:11:in `perform'
+        #          # ./app/jobs/characterize_job.rb:15:in `perform'
+        #          # ./app/jobs/ingest_file_job.rb:35:in `perform'
+        #          # ./spec/jobs/ingest_file_job_spec.rb:61:in `block (3 levels) in <top (required)>'
+        #
+        #       2) CreateDerivativesJob with a pdf file searches the extracted content
+        #          Failure/Error: yield ::File.open(file_name)
+        #
+        #          KeyError:
+        #            key not found: :object
+        #          # ./app/services/hyrax/local_file_service.rb:7:in `call'
+        #          # ./app/services/hyrax/file_set_derivatives_service.rb:31:in `create_pdf_derivatives'
+        #          # ./app/services/hyrax/file_set_derivatives_service.rb:20:in `create_derivatives'
+        #          # ./app/models/concerns/hyrax/file_set/derivatives.rb:11:in `create_derivatives'
+        #          # ./app/jobs/create_derivatives_job.rb:11:in `perform'
+        #          # ./spec/jobs/create_derivatives_job_spec.rb:88:in `block (3 levels) in <top (required)>'
+        #          # ./spec/jobs/create_derivatives_job_spec.rb:7:in `block (2 levels) in <top (required)>'
+        #
+        Hydra::Derivatives.source_file_service = Hyrax::LocalFileService
+        Hydra::Derivatives.output_file_service = Hyrax::PersistDerivatives
+        Hydra::Derivatives::FullTextExtract.output_file_service = Hyrax::PersistDirectlyContainedOutputFileService
+        after_destroy :cleanup_derivatives
+        # This completely overrides the version in Hydra::Works so that we
+        # read and write to a local file. It's important that characterization runs
+        # before derivatives so that we have a credible mime_type field to work with.
+        delegate :cleanup_derivatives, :create_derivatives, to: :file_set_derivatives_service
+      end
+
+      private
+
+        def file_set_derivatives_service
+          @file_set_derivatives_service ||= Hyrax::FileSetDerivativesService.new(self)
+        end
+    end
+  end
+end

data/app/models/concerns/hyrax/file_set/indexing.rb

@@ -0,0 +1,13 @@
+module Hyrax
+  module FileSet
+    module Indexing
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :indexer
+        # the default indexing service
+        self.indexer = Hyrax::FileSetIndexer
+      end
+    end
+  end
+end