hyrax 2.0.3 → 2.1.0.beta1

data/app/forms/hyrax/forms/work_form.rb

@@ -10,20 +10,21 @@ module Hyrax
       # This is required so that fields_for will draw a nested form.
       # See ActionView::Helpers#nested_attributes_association?
       #   https://github.com/rails/rails/blob/v5.0.2/actionview/lib/action_view/helpers/form_helper.rb#L1890
-      delegate :work_members_attributes=, to: :model
+      delegate :work_members_attributes=, :member_of_collections_attributes=, to: :model
+
       delegate :human_readable_type, :open_access?, :authenticated_only_access?,
                :open_access_with_embargo_release_date?, :private_access?,
                :visibility_during_embargo, :embargo_release_date, :visibility_after_embargo,
                :visibility_during_lease, :lease_expiration_date, :visibility_after_lease,
                :visibility, :in_works_ids, :depositor, :on_behalf_of, :permissions,
-               :member_ids, :member_of_collection_ids, to: :model
+               :member_ids, to: :model
 
       attr_reader :agreement_accepted
 
       self.terms = [:title, :creator, :contributor, :description,
                     :keyword, :license, :rights_statement, :publisher, :date_created,
                     :subject, :language, :identifier, :based_near, :related_url,
-                    :representative_id, :thumbnail_id, :files,
+                    :representative_id, :thumbnail_id, :rendering_ids, :files,
                     :visibility_during_embargo, :embargo_release_date, :visibility_after_embargo,
                     :visibility_during_lease, :lease_expiration_date, :visibility_after_lease,
                     :visibility, :ordered_member_ids, :source, :in_works_ids,
@@ -41,11 +42,43 @@ module Hyrax
         super(model)
       end
 
+      # when the add_works_to_collection parameter is set, they mean to create
+      # a new work and add it to that collection.
+      def member_of_collections
+        base = model.member_of_collections
+        return base unless @controller.params[:add_works_to_collection]
+        base + [Collection.find(@controller.params[:add_works_to_collection])]
+      end
+
       # @return [String] an etag representing the current version of this form
       def version
         model.etag
       end
 
+      # backs the child work search element
+      # @return [NilClass]
+      def find_child_work; end
+
+      def member_of_collections_json
+        member_of_collections.map do |coll|
+          {
+            id: coll.id,
+            label: coll.to_s,
+            path: @controller.url_for(coll)
+          }
+        end.to_json
+      end
+
+      def work_members_json
+        work_members.map do |child|
+          {
+            id: child.id,
+            label: child.to_s,
+            path: @controller.url_for(child)
+          }
+        end.to_json
+      end
+
       # The value for some fields should not be set to the defaults ([''])
       # because it should be an empty array instead
       def initialize_field(key)
@@ -73,18 +106,33 @@ module Hyrax
         Hash[file_presenters.map { |file| [file.to_s, file.id] }]
       end
 
+      ##
       # Fields that are automatically drawn on the page above the fold
+      #
+      # @return [Enumerable<Symbol>] symbols representing each primary term
       def primary_terms
-        required_fields
+        primary = (required_fields & terms)
+
+        (required_fields - primary).each do |missing|
+          Rails.logger.warn("The form field #{missing} is configured as a " \
+                            'required field, but not as a term. This can lead ' \
+                            'to unexpected behavior. Did you forget to add it ' \
+                            "to `#{self.class}#terms`?")
+        end
+
+        primary
       end
 
+      ##
       # Fields that are automatically drawn on the page below the fold
+      #
+      # @return [Enumerable<Symbol>]
       def secondary_terms
         terms - primary_terms -
           [:files, :visibility_during_embargo, :embargo_release_date,
            :visibility_after_embargo, :visibility_during_lease,
            :lease_expiration_date, :visibility_after_lease, :visibility,
-           :thumbnail_id, :representative_id, :ordered_member_ids,
+           :thumbnail_id, :representative_id, :rendering_ids, :ordered_member_ids,
            :member_of_collection_ids, :in_works_ids, :admin_set_id]
       end
 
@@ -104,12 +152,7 @@ module Hyrax
         service = Hyrax::CollectionsService.new(@controller)
         CollectionOptionsPresenter.new(service).select_options(:edit)
       end
-
-      # Select collection(s) based on passed-in params and existing memberships.
-      # @return [Array] a list of collection identifiers
-      def member_of_collections(collection_ids)
-        (member_of_collection_ids + Array.wrap(collection_ids)).uniq
-      end
+      deprecation_deprecate collections_for_select: "will be removed in Hyrax 3"
 
       # Sanitize the parameters coming from the form. This ensures that the client
       # doesn't send us any more parameters than we expect.
@@ -132,8 +175,9 @@ module Hyrax
           :version,
           :add_works_to_collection,
           {
-            work_members_attributes: [:id, :_destroy],
-            based_near_attributes: [:id, :_destroy]
+            based_near_attributes: [:id, :_destroy],
+            member_of_collections_attributes: [:id, :_destroy],
+            work_members_attributes: [:id, :_destroy]
           }
         ]
       end
@@ -143,7 +187,7 @@ module Hyrax
       # @return Sipity::Workflow the current active workflow for the given AdminSet
       def self.workflow_for(admin_set_id:)
         begin
-          workflow = Hyrax::PermissionTemplate.find_by!(admin_set_id: admin_set_id).active_workflow
+          workflow = Hyrax::PermissionTemplate.find_by!(source_id: admin_set_id).active_workflow
         rescue ActiveRecord::RecordNotFound
           raise "Missing permission template for AdminSet(id:#{admin_set_id})"
         end

data/app/helpers/hyrax/ability_helper.rb

@@ -21,6 +21,9 @@ module Hyrax
     end
 
     def render_visibility_link(document)
+      # Admin Sets do not have a visibility property.
+      return if document.respond_to?(:admin_set?) && document.admin_set?
+
       # Anchor must match with a tab in
       # https://github.com/samvera/hyrax/blob/master/app/views/hyrax/base/_guts4form.html.erb#L2
       path = if document.collection?

data/app/helpers/hyrax/citations_behaviors/formatters/chicago_formatter.rb

@@ -17,11 +17,11 @@ module Hyrax
           end
           # Get Pub Date
           pub_date = setup_pub_date(work)
-          text << " #{whitewash(pub_date)}." unless pub_date.nil?
+          text << " #{pub_date}." unless pub_date.nil?
 
           text << format_title(work.to_s)
           pub_info = setup_pub_info(work, false)
-          text << " #{whitewash(pub_info)}." if pub_info.present?
+          text << " #{pub_info}." if pub_info.present?
           text.html_safe
         end
 
@@ -40,7 +40,7 @@ module Hyrax
           # if for some reason the first author ended with a comma
           text.gsub!(',,', ',')
           text << "." unless text =~ /\.$/
-          whitewash(text)
+          text
         end
         # rubocop:enable Metrics/MethodLength
 
@@ -50,15 +50,8 @@ module Hyrax
           return "" if title_info.blank?
           title_text = chicago_citation_title(title_info)
           title_text << '.' unless title_text =~ /\.$/
-          title_text = whitewash(title_text)
           " <i class=\"citation-title\">#{title_text}</i>"
         end
-
-        private
-
-          def whitewash(text)
-            Loofah.fragment(text.to_s).scrub!(:whitewash).to_s
-          end
       end
     end
   end

data/app/helpers/hyrax/collections_helper.rb

@@ -22,8 +22,8 @@ module Hyrax
       params[:cq].present?
     end
 
-    def button_for_remove_from_collection(collection, document, label = 'Remove From Collection')
-      render 'hyrax/dashboard/collections/button_remove_from_collection', collection: collection, label: label, document: document
+    def button_for_remove_from_collection(collection, document, label: 'Remove From Collection', btn_class: 'btn-primary')
+      render 'hyrax/dashboard/collections/button_remove_from_collection', collection: collection, label: label, document: document, btn_class: btn_class
     end
 
     def button_for_remove_selected_from_collection(collection, label = 'Remove From Collection')
@@ -35,6 +35,14 @@ module Hyrax
       single_item_action_form_fields(form, document, 'remove')
     end
 
+    # @param collection_type_gid [String] The gid of the CollectionType to be looked up
+    # @return [String] The CollectionType's title if found, else the gid
+    def collection_type_label(collection_type_gid)
+      CollectionType.find_by_gid!(collection_type_gid).title
+    rescue ActiveRecord::RecordNotFound, URI::BadURIError
+      CollectionType.find_or_create_default_collection_type.title
+    end
+
     private
 
       # add hidden fields to a form for performing an action on a single document on a collection

data/app/helpers/hyrax/dashboard_helper_behavior.rb

@@ -4,10 +4,6 @@ module Hyrax
       params[:controller].match(%r{^hyrax/dashboard|hyrax/my})
     end
 
-    def on_my_works?
-      params[:controller].match(%r{^hyrax/my/works})
-    end
-
     def number_of_works(user = current_user)
       Hyrax::WorkRelation.new.where(DepositSearchBuilder.depositor_field => user.user_key).count
     rescue RSolr::Error::ConnectionRefused

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -33,12 +33,14 @@ module Hyrax
     end
 
     def orcid_label(style_class = '')
-      "#{image_tag 'orcid.png', alt: t('hyrax.user_profile.orcid.alt'), class: style_class} #{t('hyrax.user_profile.orcid.label')}".html_safe
+      safe_join([image_tag('orcid.png', alt: t('hyrax.user_profile.orcid.alt'), class: style_class),
+                 t('hyrax.user_profile.orcid.label')], ' ')
     end
 
     def zotero_label(opts = {})
       html_class = opts[:html_class] || ''
-      "#{image_tag 'zotero.png', alt: t('hyrax.user_profile.zotero.alt'), class: html_class} #{t('hyrax.user_profile.zotero.label')}".html_safe
+      safe_join([image_tag('zotero.png', alt: t('hyrax.user_profile.zotero.alt'), class: html_class),
+                 t('hyrax.user_profile.zotero.label')], ' ')
     end
 
     def zotero_profile_url(zotero_user_id)
@@ -84,7 +86,7 @@ module Hyrax
     # @param empty_message [String] message to display if no values are passed in
     # @param separator [String] value to join with
     # @return [ActiveSupport::SafeBuffer] the html_safe link
-    def link_to_facet_list(values, solr_field, empty_message = "No value entered".html_safe, separator = ", ")
+    def link_to_facet_list(values, solr_field, empty_message = "No value entered", separator = ", ")
       return empty_message if values.blank?
       facet_field = Solrizer.solr_name(solr_field, :facetable)
       safe_join(values.map { |item| link_to_facet(item, facet_field) }, separator)
@@ -200,7 +202,7 @@ module Hyrax
     # @return [ActiveSupport::SafeBuffer] license links, html_safe
     def license_links(options)
       service = Hyrax::LicenseService.new
-      options[:value].map { |right| link_to service.label(right), right }.to_sentence.html_safe
+      to_sentence(options[:value].map { |right| link_to service.label(right), right })
     end
 
     # A Blacklight index field helper_method
@@ -208,7 +210,19 @@ module Hyrax
     # @return [ActiveSupport::SafeBuffer] rights statement links, html_safe
     def rights_statement_links(options)
       service = Hyrax::RightsStatementService.new
-      options[:value].map { |right| link_to service.label(right), right }.to_sentence.html_safe
+      to_sentence(options[:value].map { |right| link_to service.label(right), right })
+    end
+
+    # A Blacklight facet field helper_method
+    # @param [String] value from blacklight helper_method invocation.
+    # @return [String] the decoded meaning of the boolean field
+    def suppressed_to_status(value)
+      case value
+      when 'false'
+        t('hyrax.admin.workflows.index.tabs.published')
+      else
+        t('hyrax.admin.workflows.index.tabs.under_review')
+      end
     end
 
     def link_to_telephone(user)

data/app/helpers/hyrax/trophy_helper.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 module Hyrax
   module TrophyHelper
     # rubocop:disable Metrics/MethodLength

data/app/indexers/hyrax/indexes_workflow.rb

@@ -26,7 +26,7 @@ module Hyrax
       return unless object.persisted?
       entity = PowerConverter.convert_to_sipity_entity(object)
       return if entity.nil?
-      solr_document[workflow_role_field] = workflow_roles(entity).map { |role| "#{entity.workflow.permission_template.admin_set_id}-#{entity.workflow.name}-#{role}" }
+      solr_document[workflow_role_field] = workflow_roles(entity).map { |role| "#{entity.workflow.permission_template.source_id}-#{entity.workflow.name}-#{role}" }
       solr_document[workflow_state_name_field] = entity.workflow_state.name if entity.workflow_state
     end
 

data/app/indexers/hyrax/repository_reindexer.rb

@@ -0,0 +1,19 @@
+require 'active_fedora/base'
+require 'active_fedora/version'
+raise "Verify this override is still needed for non 11.5.2 versions" unless ActiveFedora::VERSION == '11.5.2'
+
+module Hyrax
+  module RepositoryReindexer
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # overrides https://github.com/samvera/active_fedora/blob/master/lib/active_fedora/indexing.rb#L95-L125
+      # see implementation details in adapters/nesting_index_adapter.rb#each_perservation_document_id_and_parent_ids
+      def reindex_everything(*)
+        Samvera::NestingIndexer.reindex_all!
+      end
+    end
+  end
+end
+
+ActiveFedora::Base.module_eval { include Hyrax::RepositoryReindexer }

data/app/jobs/hyrax/application_job.rb

@@ -2,6 +2,6 @@ module Hyrax
   # A common base class for all Hyrax jobs.
   # This allows downstream applications to manipulate all the hyrax jobs by
   # including modules on this class.
-  class ApplicationJob < ActiveJob::Base
+  class ApplicationJob < ::ApplicationJob
   end
 end

data/app/jobs/import_export_job.rb

@@ -1,6 +1,6 @@
 require 'open3'
 
-class ImportExportJob < ActiveJob::Base
+class ImportExportJob < ApplicationJob
   include Open3
 
   # @param resource [String] uri of the resource

data/app/jobs/user_edit_profile_event_job.rb

@@ -6,6 +6,6 @@ class UserEditProfileEventJob < EventJob
   end
 
   def action
-    "User #{link_to_profile @editor} has edited his or her profile"
+    "User #{link_to_profile @editor} has edited their profile"
   end
 end

data/app/models/admin_set.rb

@@ -39,9 +39,11 @@ class AdminSet < ActiveFedora::Base
     index.as :symbol
   end
 
+  # rubocop:disable Rails/HasManyOrHasOneDependent
   has_many :members,
            predicate:  Hyrax.config.admin_set_predicate,
            class_name: 'ActiveFedora::Base'
+  # rubocop:enable Rails/HasManyOrHasOneDependent
 
   before_destroy :check_if_not_default_set, :check_if_empty
   after_destroy :destroy_permission_template
@@ -71,7 +73,7 @@ class AdminSet < ActiveFedora::Base
   # @return [Hyrax::PermissionTemplate]
   # @raise [ActiveRecord::RecordNotFound]
   def permission_template
-    Hyrax::PermissionTemplate.find_by!(admin_set_id: id)
+    Hyrax::PermissionTemplate.find_by!(source_id: id)
   end
 
   # @api public
@@ -84,7 +86,8 @@ class AdminSet < ActiveFedora::Base
 
   # Calculate and update who should have edit access based on who
   # has "manage" access in the PermissionTemplateAccess
-  def update_access_controls!
+  def reset_access_controls!
+    # NOTE: This is different from Collections in that it doesn't update read access.  See the notes in services/hyrax/collections/permissions_service.rb
     update!(edit_users: permission_template.agent_ids_for(access: 'manage', agent_type: 'user'),
             edit_groups: permission_template.agent_ids_for(access: 'manage', agent_type: 'group'))
   end

data/app/models/collection_branding_info.rb

@@ -0,0 +1,39 @@
+class CollectionBrandingInfo < ApplicationRecord
+  # i = ColectionImageInfo.new()
+
+  def initialize(collection_id:,
+                 filename:,
+                 role:,
+                 alt_txt: "",
+                 target_url: "")
+
+    super()
+    self.collection_id = collection_id
+    self.role = role
+    self.alt_text = alt_txt
+    self.target_url = target_url
+
+    self.local_path = find_local_filename(collection_id, role, filename)
+  end
+
+  def save(file_location, copy_file = true)
+    local_dir = find_local_dir_name(collection_id, role)
+    FileUtils.mkdir_p local_dir
+    FileUtils.cp file_location, local_path unless file_location == local_path || !copy_file
+    FileUtils.remove_file(file_location) if File.exist?(file_location) && copy_file
+    super()
+  end
+
+  def delete(location_path)
+    FileUtils.remove_file(location_path) if File.exist?(location_path)
+  end
+
+  def find_local_filename(collection_id, role, filename)
+    local_dir = find_local_dir_name(collection_id, role)
+    File.join(local_dir, filename)
+  end
+
+  def find_local_dir_name(collection_id, role)
+    File.join(Hyrax.config.branding_path, collection_id.to_s, role.to_s)
+  end
+end

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

@@ -3,8 +3,15 @@ module Hyrax
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :admin_group_name
+      include Hyrax::Ability::AdminSetAbility
+      include Hyrax::Ability::CollectionAbility
+      include Hyrax::Ability::CollectionTypeAbility
+      include Hyrax::Ability::PermissionTemplateAbility
+      include Hyrax::Ability::SolrDocumentAbility
+
+      class_attribute :admin_group_name, :registered_group_name
       self.admin_group_name = 'admin'
+      self.registered_group_name = 'registered'
       self.ability_logic += [:admin_permissions,
                              :curation_concerns_permissions,
                              :operation_abilities,
@@ -18,6 +25,10 @@ module Hyrax
                              :uploaded_file_abilities,
                              :feature_abilities,
                              :admin_set_abilities,
+                             :collection_abilities,
+                             :collection_type_abilities,
+                             :permission_template_abilities,
+                             :solr_document_abilities,
                              :trophy_abilities]
     end
 
@@ -45,7 +56,7 @@ module Hyrax
     def can_create_any_work?
       Hyrax.config.curation_concerns.any? do |curation_concern_type|
         can?(:create, curation_concern_type)
-      end && admin_set_ids_for_deposit.any?
+      end && admin_set_with_deposit?
     end
 
     # Override this method in your ability model if you use a different group
@@ -54,37 +65,18 @@ module Hyrax
       user_groups.include? admin_group_name
     end
 
-    # @return [Array<String>] a list of admin set ids for admin sets the user
-    #   has deposit or manage permissions to.
-    def admin_set_ids_for_deposit
-      admin_set_ids_for_roles(['deposit', 'manage'])
-    end
-
-    # @return [Array<String>] a list of admin set ids for admin sets the user
-    #   has manage permissions to.
-    def admin_set_ids_for_management
-      admin_set_ids_for_roles(['manage'])
-    end
-
-    # @param [Array<String>] roles the roles to be used when searching for admin
-    #   sets for the user
-    # @return [Array<String>] a list of admin set ids for admin sets the user
-    #   that match the roles
-    def admin_set_ids_for_roles(roles)
-      PermissionTemplateAccess.joins(:permission_template)
-                              .where(agent_type: 'user',
-                                     agent_id: current_user.user_key,
-                                     access: roles)
-                              .or(
-                                PermissionTemplateAccess.joins(:permission_template)
-                                                        .where(agent_type: 'group',
-                                                               agent_id: user_groups,
-                                                               access: roles)
-                              ).pluck('DISTINCT admin_set_id')
-    end
-
     private
 
+      # @return [Boolean] true if the user has at least one admin set they can deposit into.
+      def admin_set_with_deposit?
+        ids = PermissionTemplateAccess.for_user(ability: self,
+                                                access: ['deposit', 'manage'])
+                                      .joins(:permission_template)
+                                      .pluck('DISTINCT source_id')
+        query = "_query_:\"{!raw f=has_model_ssim}AdminSet\" AND {!terms f=id}#{ids.join(',')}"
+        ActiveFedora::SolrService.count(query) > 0
+      end
+
       # This overrides hydra-head, (and restores the method from blacklight-access-controls)
       def download_permissions
         can :download, String do |id|
@@ -161,23 +153,6 @@ module Hyrax
         can :manage, Hyrax::Feature if admin?
       end
 
-      def admin_set_abilities
-        can :manage, [AdminSet, Hyrax::PermissionTemplate, Hyrax::PermissionTemplateAccess] if admin?
-        can :manage_any, AdminSet if admin? || admin_set_ids_for_management.present?
-
-        can [:create, :edit, :update, :destroy], Hyrax::PermissionTemplate do |template|
-          test_edit(template.admin_set_id)
-        end
-
-        can [:create, :edit, :update, :destroy], Hyrax::PermissionTemplateAccess do |access|
-          test_edit(access.permission_template.admin_set_id)
-        end
-
-        can :review, :submissions do
-          can_review_submissions?
-        end
-      end
-
       def operation_abilities
         can :read, Hyrax::Operation, user_id: current_user.id
       end
@@ -213,8 +188,10 @@ module Hyrax
         can :manage, String # The identifier of a work or FileSet
         can :manage, curation_concerns_models
         can :manage, Sipity::WorkflowResponsibility
+        can :manage, :collection_types
       end
 
+      # TODO: elr - How is this used?  How does it fit with collection participants?
       def add_to_collection
         return unless registered_user?
         alias_action :files, to: :read # members will be filtered separately
@@ -223,7 +200,7 @@ module Hyrax
 
       def registered_user?
         return false if current_user.guest?
-        user_groups.include? 'registered'
+        user_groups.include? registered_group_name
       end
 
       # Returns true if the current user is the depositor of the specified work