curation_concerns 1.0.0.beta1 → 1.0.0.beta2

data/app/actors/curation_concerns/actors/lease_actor.rb

@@ -0,0 +1,21 @@
+module CurationConcerns
+  module Actors
+    class LeaseActor
+      attr_reader :work
+
+      # @param [Hydra::Works::Work] work
+      def initialize(work)
+        @work = work
+      end
+
+      # Update the visibility of the work to match the correct state of the lease, then clear the lease date, etc.
+      # Saves the lease and the work
+      def destroy
+        work.lease_visibility! # If the lease has lapsed, update the current visibility.
+        work.deactivate_lease!
+        work.lease.save!
+        work.save!
+      end
+    end
+  end
+end

data/app/actors/curation_concerns/actors/root_actor.rb

@@ -0,0 +1,19 @@
+module CurationConcerns
+  module Actors
+    class RootActor
+      attr_reader :curation_concern, :user, :cloud_resources
+      def initialize(curation_concern, user, _more_actors)
+        @curation_concern = curation_concern
+        @user = user
+      end
+
+      def create(_)
+        true
+      end
+
+      def update(_)
+        true
+      end
+    end
+  end
+end

data/app/actors/curation_concerns/actors/work_actor_behavior.rb

@@ -0,0 +1,12 @@
+module CurationConcerns
+  module Actors
+    module WorkActorBehavior
+      extend ActiveSupport::Concern
+      extend Deprecation
+
+      included do
+        Deprecation.warn(CurationConcerns::WorkActorBehavior, "CurationConcerns::WorkActorBehavior is deprecated and will be removed in CurationConcerns 1.0")
+      end
+    end
+  end
+end

data/app/actors/curation_concerns/actors.rb

@@ -0,0 +1,18 @@
+module CurationConcerns
+  # Module for containing Actors
+  # @since 0.14.0
+  # An Actor coordinates the response to a user command
+  # (often via user http request to a controller).  It
+  # performs one or more steps in the business process of a
+  # create, update, or destroy command issued by a user.
+  # You may a have a stack of multiple actors that each
+  # perform one action.  Actors should have a specific task
+  # and be chained together to execute more complex business
+  # purposes.
+  # @example A series of actors responsible for creating an object:
+  #   Metadata Writing Actor, Rights Assignment Actor,
+  #   Indexing Actor
+  # @see CurationConcerns::AbstractActor for primitive interface definition
+  module Actors
+  end
+end

data/app/controllers/concerns/curation_concerns/embargoes_controller_behavior.rb

@@ -14,7 +14,7 @@ module CurationConcerns
 
     # Removes a single embargo
     def destroy
-      EmbargoActor.new(curation_concern).destroy
+      CurationConcerns::Actors::EmbargoActor.new(curation_concern).destroy
       flash[:notice] = curation_concern.embargo_history.last
       if curation_concern.work? && curation_concern.file_sets.present?
         redirect_to confirm_curation_concerns_permission_path(curation_concern)
@@ -28,7 +28,7 @@ module CurationConcerns
       filter_docs_with_edit_access!
       copy_visibility = params[:embargoes].values.map { |h| h[:copy_visibility] }
       ActiveFedora::Base.find(batch).each do |curation_concern|
-        EmbargoActor.new(curation_concern).destroy
+        CurationConcerns::Actors::EmbargoActor.new(curation_concern).destroy
         curation_concern.copy_visibility_to_files if copy_visibility.include?(curation_concern.id)
       end
       redirect_to embargoes_path

data/app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb

@@ -15,10 +15,16 @@ module CurationConcerns
       class_attribute :show_presenter, :form_class
       self.show_presenter = CurationConcerns::FileSetPresenter
       self.form_class = CurationConcerns::Forms::FileSetEditForm
-    end
 
-    def curation_concern
-      @file_set
+      # A little bit of explanation, CanCan(Can) sets the @file_set via the .load_and_authorize_resource
+      # method. However the interface for various CurationConcern modules leverages the #curation_concern method
+      # Thus we have file_set and curation_concern that are aliases for each other.
+      attr_accessor :file_set
+      alias_method :curation_concern, :file_set
+      private :file_set=
+      alias_method :curation_concern=, :file_set=
+      private :curation_concern=
+      helper_method :file_set
     end
 
     # routed to /files/new
@@ -61,8 +67,8 @@ module CurationConcerns
         wants.html { presenter }
         wants.json do
           # load and authorize @curation_concern manually because it's skipped for html
-          @file_set = curation_concern_type.load_instance_from_solr(params[:id]) unless curation_concern
-          authorize! :show, @file_set
+          self.curation_concern ||= curation_concern_type.load_instance_from_solr(params[:id])
+          authorize! :show, curation_concern
           render :show, status: :ok
         end
         additional_response_formats(wants)
@@ -70,7 +76,7 @@ module CurationConcerns
     end
 
     def destroy
-      parent = @file_set.parent
+      parent = curation_concern.parent
       actor.destroy
       redirect_to [main_app, parent], notice: 'The file has been deleted.'
     end
@@ -95,7 +101,7 @@ module CurationConcerns
             flash[:error] = "There was a problem processing your request."
             render 'edit', status: :unprocessable_entity
           end
-          wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: @file_set.errors }) }
+          wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: curation_concern.errors }) }
         end
       end
     rescue RSolr::Error::Http => error
@@ -107,9 +113,9 @@ module CurationConcerns
     def after_update_response
       respond_to do |wants|
         wants.html do
-          redirect_to [main_app, @file_set], notice: "The file #{view_context.link_to(@file_set, [main_app, @file_set])} has been updated."
+          redirect_to [main_app, curation_concern], notice: "The file #{view_context.link_to(curation_concern, [main_app, curation_concern])} has been updated."
         end
-        wants.json { render :show, status: :ok, location: polymorphic_path([main_app, @file_set]) }
+        wants.json { render :show, status: :ok, location: polymorphic_path([main_app, curation_concern]) }
       end
     end
 
@@ -154,15 +160,15 @@ module CurationConcerns
       end
 
       def version_list
-        CurationConcerns::VersionListPresenter.new(@file_set.original_file.versions.all)
+        CurationConcerns::VersionListPresenter.new(curation_concern.original_file.versions.all)
       end
 
       def wants_to_revert?
-        params.key?(:revision) && params[:revision] != @file_set.latest_content_version.label
+        params.key?(:revision) && params[:revision] != curation_concern.latest_content_version.label
       end
 
       def actor
-        @actor ||= ::CurationConcerns::FileSetActor.new(@file_set, current_user)
+        @actor ||= ::CurationConcerns::Actors::FileSetActor.new(curation_concern, current_user)
       end
 
       def attributes
@@ -194,7 +200,7 @@ module CurationConcerns
               if request.xhr?
                 render 'jq_upload', formats: 'json', content_type: 'text/html'
               else
-                redirect_to [main_app, @file_set.parent]
+                redirect_to [main_app, curation_concern.parent]
               end
             end
             format.json do
@@ -202,7 +208,7 @@ module CurationConcerns
             end
           end
         else
-          msg = @file_set.errors.full_messages.join(', ')
+          msg = curation_concern.errors.full_messages.join(', ')
           flash[:error] = msg
           json_error "Error creating file #{file.original_filename}: #{msg}"
         end
@@ -211,7 +217,7 @@ module CurationConcerns
       # this is provided so that implementing application can override this behavior and map params to different attributes
       def update_metadata_from_upload_screen
         # Relative path is set by the jquery uploader when uploading a directory
-        @file_set.relative_path = params[:relative_path] if params[:relative_path]
+        curation_concer.relative_path = params[:relative_path] if params[:relative_path]
       end
 
       def curation_concern_type

data/app/controllers/concerns/curation_concerns/leases_controller_behavior.rb

@@ -14,7 +14,7 @@ module CurationConcerns
 
     # Removes a single lease
     def destroy
-      LeaseActor.new(curation_concern).destroy
+      CurationConcerns::Actors::LeaseActor.new(curation_concern).destroy
       flash[:notice] = curation_concern.lease_history.last
       if curation_concern.work? && curation_concern.file_sets.present?
         redirect_to confirm_curation_concerns_permission_path(curation_concern)
@@ -27,7 +27,7 @@ module CurationConcerns
       filter_docs_with_edit_access!
       copy_visibility = params[:leases].values.map { |h| h[:copy_visibility] }
       ActiveFedora::Base.find(batch).each do |curation_concern|
-        LeaseActor.new(curation_concern).destroy
+        CurationConcerns::Actors::LeaseActor.new(curation_concern).destroy
         curation_concern.copy_visibility_to_files if copy_visibility.include?(curation_concern.id)
       end
       redirect_to leases_path

data/app/forms/curation_concerns/forms/collection_edit_form.rb

@@ -7,7 +7,7 @@ module CurationConcerns
       delegate :human_readable_type, :member_ids, to: :model
 
       self.terms = [:resource_type, :title, :creator, :contributor, :description,
-                    :tag, :rights, :publisher, :date_created, :subject, :language,
+                    :keyword, :rights, :publisher, :date_created, :subject, :language,
                     :representative_id, :thumbnail_id, :identifier, :based_near,
                     :related_url, :visibility]
 

data/app/forms/curation_concerns/forms/file_set_edit_form.rb

@@ -1,12 +1,12 @@
 module CurationConcerns::Forms
   class FileSetEditForm
     include HydraEditor::Form
-    self.required_fields = [:title, :creator, :tag, :rights]
+    self.required_fields = [:title, :creator, :keyword, :rights]
 
     self.model_class = ::FileSet
 
     self.terms = [:resource_type, :title, :creator, :contributor, :description,
-                  :tag, :rights, :publisher, :date_created, :subject, :language,
+                  :keyword, :rights, :publisher, :date_created, :subject, :language,
                   :identifier, :based_near, :related_url,
                   :visibility_during_embargo, :visibility_after_embargo, :embargo_release_date,
                   :visibility_during_lease, :visibility_after_lease, :lease_expiration_date,

data/app/forms/curation_concerns/forms/work_form.rb

@@ -10,7 +10,7 @@ module CurationConcerns
                :visibility, to: :model
 
       self.terms = [:title, :creator, :contributor, :description,
-                    :tag, :rights, :publisher, :date_created, :subject, :language,
+                    :keyword, :rights, :publisher, :date_created, :subject, :language,
                     :identifier, :based_near, :related_url,
                     :representative_id, :thumbnail_id, :files,
                     :visibility_during_embargo, :embargo_release_date, :visibility_after_embargo,

data/app/forms/curation_concerns/forms.rb

@@ -0,0 +1,14 @@
+module CurationConcerns
+  # This will be the module for containing forms
+  # @since 0.14.0
+  # Forms are a type of data structures that include validation that leverage hydra editor
+  # capabilities. Their purpose is to allow users to edit and save objects based on models.
+  # The impetus for their creation was to remove validation from models, and perhaps
+  # demultiplex fields from one form to multiple objects. A form must define the model
+  # it uses and attributes it manipulates. It may include default values and define required
+  # required fields. They are ruby objects that are typically instantiated by the controller
+  # to facilitate user creation, editing, or deleting of an object. They can also be used to
+  # sanitize attributes passed along to actors, as they are in curation concerns.
+  module Forms
+  end
+end

data/app/helpers/curation_concerns/collections_helper.rb

@@ -60,14 +60,16 @@ module CurationConcerns::CollectionsHelper
     end
 
     def convert_solr_docs_to_select_options(results)
-      results
-        .map { |r| [SolrDocument.new(r).title, r['id']] }
-        .sort do |a, b|
-          if a.first && b.first
-            a.first <=> b.first
-          else
-            a.first ? -1 : 1
-          end
+      option_values = results.map do |r|
+        title = SolrDocument.new(r).title
+        [title.present? ? title.join(', ') : nil, r['id']]
+      end
+      option_values.sort do |a, b|
+        if a.first && b.first
+          a.first <=> b.first
+        else
+          a.first ? -1 : 1
         end
+      end
     end
 end

data/app/jobs/audit_job.rb

@@ -1,6 +1,4 @@
 class AuditJob < ActiveJob::Base
-  queue_as :audit
-
   # URI of the resource to audit.
   # This URI could include the actual resource (e.g. content) and the version to audit:
   #     http://localhost:8983/fedora/rest/test/a/b/c/abcxyz/content/fcr:versions/version1

data/app/jobs/characterize_job.rb

@@ -1,5 +1,5 @@
 class CharacterizeJob < ActiveJob::Base
-  queue_as :characterize
+  queue_as CurationConcerns.config.ingest_queue_name
 
   # @param [FileSet] file_set
   # @param [String] filename a local path for the file to characterize. By using this, we don't have to pull a copy out of fedora.

data/app/jobs/create_derivatives_job.rb

@@ -1,5 +1,5 @@
 class CreateDerivativesJob < ActiveJob::Base
-  queue_as :derivatives
+  queue_as CurationConcerns.config.ingest_queue_name
 
   # @param [FileSet] file_set
   # @param [String] file_name

data/app/jobs/import_url_job.rb

@@ -3,7 +3,7 @@ require 'uri'
 require 'tempfile'
 
 class ImportUrlJob < ActiveJob::Base
-  queue_as :import_url
+  queue_as CurationConcerns.config.ingest_queue_name
 
   before_enqueue do |job|
     log = job.arguments.last
@@ -21,7 +21,7 @@ class ImportUrlJob < ActiveJob::Base
       file_set.reload
 
       # attach downloaded file to FileSet stubbed out
-      if CurationConcerns::FileSetActor.new(file_set, user).create_content(f)
+      if CurationConcerns::Actors::FileSetActor.new(file_set, user).create_content(f)
         # send message to user on download success
         CurationConcerns.config.callback.run(:after_import_url_success, file_set, user)
         log.success!

data/app/jobs/ingest_file_job.rb

@@ -1,5 +1,5 @@
 class IngestFileJob < ActiveJob::Base
-  queue_as :ingest
+  queue_as CurationConcerns.config.ingest_queue_name
 
   # @param [FileSet] file_set
   # @param [String] filename

data/app/jobs/ingest_local_file_job.rb

@@ -1,5 +1,5 @@
 class IngestLocalFileJob < ActiveJob::Base
-  queue_as :ingest_local
+  queue_as CurationConcerns.config.ingest_queue_name
 
   # @param [FileSet] file_set
   # @param [String] path
@@ -7,7 +7,7 @@ class IngestLocalFileJob < ActiveJob::Base
   def perform(file_set, path, user)
     file_set.label ||= File.basename(path)
 
-    actor = CurationConcerns::FileSetActor.new(file_set, user)
+    actor = CurationConcerns::Actors::FileSetActor.new(file_set, user)
 
     if actor.create_content(File.open(path))
       FileUtils.rm(path)

data/app/jobs/resolrize_job.rb

@@ -1,6 +1,4 @@
 class ResolrizeJob < ActiveJob::Base
-  queue_as :resolrize
-
   def perform
     ActiveFedora::Base.reindex_everything
   end

data/app/jobs/visibility_copy_job.rb

@@ -1,6 +1,4 @@
 class VisibilityCopyJob < ActiveJob::Base
-  queue_as :permissions
-
   def perform(work)
     work.file_sets.each do |file|
       file.visibility = work.visibility # visibility must come first, because it can clear an embargo/lease

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

@@ -25,7 +25,7 @@ module CurationConcerns
         index.type :text
         index.as :stored_searchable
       end
-      property :tag, predicate: ::RDF::Vocab::DC11.relation do |index|
+      property :keyword, predicate: ::RDF::Vocab::DC11.relation do |index|
         index.as :stored_searchable, :facetable
       end
       property :rights, predicate: ::RDF::Vocab::DC.rights do |index|

data/app/models/concerns/curation_concerns/characterization.rb

@@ -0,0 +1,41 @@
+# 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 CurationConcerns::FileSetBehavior
+# end
+#
+# MyFileSet.characterization_proxy = :master_file
+# MyFileSet.characterization_terms = [:term1, :term2, :term3]
+module CurationConcerns
+  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
+      ]
+      self.characterization_proxy = :original_file
+
+      delegate(*characterization_terms, to: :characterization_proxy)
+
+      def characterization_proxy
+        send(self.class.characterization_proxy) || NullCharacterizationProxy.new
+      end
+    end
+
+    class NullCharacterizationProxy
+      def method_missing(*_args)
+        []
+      end
+
+      def mime_type
+      end
+    end
+  end
+end

data/app/models/concerns/curation_concerns/collection.rb

@@ -2,7 +2,6 @@ module CurationConcerns
   module Collection
     extend ActiveSupport::Concern
     extend Deprecation
-    include Hydra::Works::CollectionBehavior
     include Hydra::WithDepositor # for access to apply_depositor_metadata
     include Hydra::AccessControls::Permissions
     include CurationConcerns::RequiredMetadata

data/app/models/concerns/curation_concerns/file_set_behavior.rb

@@ -9,7 +9,7 @@ module CurationConcerns
     include CurationConcerns::BasicMetadata
     include Hydra::Works::FileSetBehavior
     include Hydra::Works::VirusCheck
-    include Hydra::Works::Characterization
+    include CurationConcerns::Characterization
     include Hydra::WithDepositor
     include CurationConcerns::Serializers
     include CurationConcerns::Noid

data/app/models/concerns/curation_concerns/solr_document_behavior.rb

@@ -4,7 +4,8 @@ module CurationConcerns
     include Hydra::Works::MimeTypes
 
     def title_or_label
-      title || label
+      return label if title.blank?
+      title.join(', ')
     end
 
     def to_param
@@ -63,11 +64,11 @@ module CurationConcerns
     end
 
     def title
-      Array.wrap(self[Solrizer.solr_name('title')]).first
+      Array.wrap(self[Solrizer.solr_name('title')])
     end
 
     def description
-      Array.wrap(self[Solrizer.solr_name('description')]).first
+      Array.wrap(self[Solrizer.solr_name('description')])
     end
 
     def label
@@ -98,8 +99,8 @@ module CurationConcerns
       fetch(Solrizer.solr_name('language'), [])
     end
 
-    def tags
-      fetch(Solrizer.solr_name('tag'), [])
+    def keyword
+      fetch(Solrizer.solr_name('keyword'), [])
     end
 
     def embargo_release_date

data/app/presenters/curation_concerns/collection_presenter.rb

@@ -14,7 +14,7 @@ module CurationConcerns
 
     # CurationConcern methods
     delegate :stringify_keys, :human_readable_type, :collection?, :representative_id,
-             to: :solr_document
+             :to_s, to: :solr_document
 
     # Metadata Methods
     delegate :title, :description, :creator, :contributor, :subject, :publisher, :language,

data/app/presenters/curation_concerns/file_set_presenter.rb

@@ -22,7 +22,7 @@ module CurationConcerns
     delegate :title, :description, :creator, :contributor, :subject, :publisher,
              :language, :date_uploaded, :rights,
              :embargo_release_date, :lease_expiration_date,
-             :depositor, :tags, :title_or_label, to: :solr_document
+             :depositor, :keyword, :title_or_label, to: :solr_document
 
     def page_title
       Array.wrap(solr_document['label_tesim']).first

data/app/presenters/curation_concerns/presents_attributes.rb

@@ -14,7 +14,7 @@ module CurationConcerns
         Rails.logger.warn("#{self.class} attempted to render #{field}, but no method exists with that name.")
         return
       end
-      AttributeRenderer.new(field, send(field), options).render
+      CurationConcerns::Renderers::AttributeRenderer.new(field, send(field), options).render
     end
 
     def permission_badge

data/app/renderers/curation_concerns/renderers/attribute_renderer.rb

@@ -0,0 +1,100 @@
+require "rails_autolink/helpers"
+
+module CurationConcerns
+  module Renderers
+    class AttributeRenderer
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Helpers::TranslationHelper
+      include ActionView::Helpers::TextHelper
+      include ConfiguredMicrodata
+
+      attr_reader :field, :values, :options
+
+      # @param [Symbol] field
+      # @param [Array] values
+      # @param [Hash] options
+      def initialize(field, values, options = {})
+        @field = field
+        @values = values
+        @options = options
+      end
+
+      # Draw the table row for the attribute
+      def render
+        markup = ''
+
+        return markup if !values.present? && !options[:include_empty]
+        markup << %(<tr><th>#{label}</th>\n<td><ul class='tabular'>)
+        attributes = microdata_object_attributes(field).merge(class: "attribute #{field}")
+        Array(values).each do |value|
+          markup << "<li#{html_attributes(attributes)}>#{attribute_value_to_html(value.to_s)}</li>"
+        end
+        markup << %(</ul></td></tr>)
+        markup.html_safe
+      end
+
+      # @return The human-readable label for this field.
+      # @note This is a central location for determining the label of a field
+      #   name. Can be overridden if more complicated logic is needed.
+      def label
+        translate(
+          :"blacklight.search.fields.show.#{field}",
+          default: [:"blacklight.search.fields.#{field}", options.fetch(:label, field.to_s.humanize)])
+      end
+
+      private
+
+        def attribute_value_to_html(value)
+          if field == :rights
+            rights_attribute_to_html(value)
+          elsif microdata_value_attributes(field).present?
+            "<span#{html_attributes(microdata_value_attributes(field))}>#{li_value(value)}</span>"
+          else
+            li_value(value)
+          end
+        end
+
+        def html_attributes(attributes)
+          buffer = ""
+          attributes.each do |k, v|
+            buffer << " #{k}"
+            buffer << %(="#{v}") unless v.blank?
+          end
+          buffer
+        end
+
+        def search_field
+          options.fetch(:search_field, field)
+        end
+
+        def li_value(value)
+          if options[:catalog_search_link]
+            link_to(ERB::Util.h(value), search_path(value))
+          else
+            auto_link(ERB::Util.h(value))
+          end
+        end
+
+        def search_path(value)
+          Rails.application.routes.url_helpers.search_catalog_path(
+            search_field: search_field, q: ERB::Util.h(value))
+        end
+
+        ##
+        # Special treatment for license/rights.  A URL from the Sufia gem's config/sufia.rb is stored in the descMetadata of the
+        # curation_concern.  If that URL is valid in form, then it is used as a link.  If it is not valid, it is used as plain text.
+        def rights_attribute_to_html(value)
+          begin
+            parsed_uri = URI.parse(value)
+          rescue
+            nil
+          end
+          if parsed_uri.nil?
+            ERB::Util.h(value)
+          else
+            %(<a href=#{ERB::Util.h(value)} target="_blank">#{RightsService.label(value)}</a>)
+          end
+        end
+    end
+  end
+end

data/app/renderers/curation_concerns/renderers/configured_microdata.rb

@@ -0,0 +1,42 @@
+module CurationConcerns
+  module Renderers
+    module ConfiguredMicrodata
+      def microdata?(field)
+        return false unless CurationConcerns.config.display_microdata
+        key = "curation_concerns.schema_org.#{field}.property"
+        t(key, default: false)
+      end
+
+      def microdata_object?(field)
+        return false unless CurationConcerns.config.display_microdata
+        key = "curation_concerns.schema_org.#{field}.type"
+        t(key, default: false)
+      end
+
+      def microdata_object_attributes(field)
+        if microdata_object?(field)
+          { itemprop: microdata_property(field), itemscope: '', itemtype: microdata_type(field) }
+        else
+          {}
+        end
+      end
+
+      def microdata_property(field)
+        t("curation_concerns.schema_org.#{field}.property")
+      end
+
+      def microdata_type(field)
+        t("curation_concerns.schema_org.#{field}.type")
+      end
+
+      def microdata_value_attributes(field)
+        if microdata?(field)
+          key = microdata_object?(field) ? :value : :property
+          { itemprop: t("curation_concerns.schema_org.#{field}.#{key}") }
+        else
+          {}
+        end
+      end
+    end
+  end
+end