curation_concerns 0.12.0.pre1 → 0.12.0.pre2

data/app/assets/stylesheets/curation_concerns/modules/site_search.scss

@@ -1,46 +0,0 @@
-.search-form {
-  position:relative;
-
-  .search-query,
-  .search-submit {
-    -moz-box-sizing: border-box;
-    box-sizing:border-box;
-  }
-
-  .search-query {
-    width:100%;
-    padding-left:.6em;
-    padding-right:12%;
-    height: 2.1em;
-    border-radius: $input-border-radius;
-  }
-
-  .search-submit {
-    padding:2px;
-    position:absolute;
-    right:2px;
-    text-align:center;
-    top:2px;
-    white-space:nowrap;
-    width:9%;
-  }
-}
-
-.search-query-form {
-  margin-bottom:.3em;
-  padding-left:1em;
-
-  .search-scope {
-    display:block;
-    line-height:1.5em;
-    margin-bottom:.3em;
-
-    input {
-      margin-top:0;
-    }
-  }
-
-  .label-text {
-    padding-left:.3em;
-  }
-}

data/app/assets/stylesheets/curation_concerns.scss

@@ -0,0 +1,4 @@
+@import 'bootstrap-sprockets';
+@import 'bootstrap';
+
+@import 'curation_concerns/curation_concerns';

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

@@ -1,54 +1,150 @@
 module CurationConcerns
   module CollectionsControllerBehavior
     extend ActiveSupport::Concern
-    include Hydra::CollectionsControllerBehavior
     include Blacklight::AccessControls::Catalog
 
+    include Blacklight::Base
+    include CurationConcerns::SelectsCollections
+
     included do
       before_action :filter_docs_with_read_access!, except: :show
+      before_action :remove_select_something_first_flash, except: :show
       layout 'curation_concerns/1_column'
-      skip_load_and_authorize_resource only: :show
+
+      include CurationConcerns::Collections::AcceptsBatches
+
+      # This is needed as of BL 3.7
+      copy_blacklight_config_from(::CatalogController)
+
+      # Catch permission errors
+      rescue_from Hydra::AccessDenied, CanCan::AccessDenied do |exception|
+        if exception.action == :edit
+          redirect_to(collections.url_for(action: 'show'), alert: 'You do not have sufficient privileges to edit this document')
+        elsif current_user && current_user.persisted?
+          redirect_to root_url, alert: exception.message
+        else
+          session['user_return_to'] = request.url
+          redirect_to new_user_session_url, alert: exception.message
+        end
+      end
+
+      # actions: audit, index, create, new, edit, show, update, destroy, permissions, citation
+      before_action :authenticate_user!, except: [:show]
+      load_and_authorize_resource except: [:index, :show], instance_name: :collection
 
       class_attribute :presenter_class, :form_class
       self.presenter_class = CurationConcerns::CollectionPresenter
       self.form_class = CurationConcerns::Forms::CollectionEditForm
     end
 
+    def index
+      # run the solr query to find the collections
+      query = collections_search_builder.with(params).query
+      @response = repository.search(query)
+      @document_list = @response.documents
+    end
+
     def new
-      super
       form
     end
 
+    def show
+      presenter
+      query_collection_members
+    end
+
     def edit
-      super
+      query_collection_members
+      find_collections
       form
     end
 
-    def show
-      presenter
-      super
+    def after_create
+      form
+      respond_to do |format|
+        ActiveFedora::SolrService.instance.conn.commit
+        format.html { redirect_to collection_path(@collection), notice: 'Collection was successfully created.' }
+        format.json { render json: @collection, status: :created, location: @collection }
+      end
     end
 
     def after_create_error
       form
-      super
+
+      respond_to do |format|
+        format.html { render action: 'new' }
+        format.json { render json: @collection.errors, status: :unprocessable_entity }
+      end
+    end
+
+    def create
+      @collection.apply_depositor_metadata(current_user.user_key)
+      add_members_to_collection unless batch.empty?
+      if @collection.save
+        after_create
+      else
+        after_create_error
+      end
+    end
+
+    def after_update
+      if flash[:notice].nil?
+        flash[:notice] = 'Collection was successfully updated.'
+      end
+      respond_to do |format|
+        format.html { redirect_to collection_path(@collection) }
+        format.json { render json: @collection, status: :updated, location: @collection }
+      end
     end
 
     def after_update_error
       form
       query_collection_members
-      super
+
+      respond_to do |format|
+        format.html { render action: 'edit' }
+        format.json { render json: @collection.errors, status: :unprocessable_entity }
+      end
+    end
+
+    def update
+      process_member_changes
+      if @collection.update(collection_params.except(:members))
+        after_update
+      else
+        after_update_error
+      end
+    end
+
+    def after_destroy(id)
+      respond_to do |format|
+        format.html { redirect_to search_catalog_path, notice: 'Collection was successfully deleted.' }
+        format.json { render json: { id: id }, status: :destroyed, location: @collection }
+      end
+    end
+
+    def after_destroy_error(id)
+      respond_to do |format|
+        format.html { redirect_to search_catalog_path, notice: 'Collection could not be deleted.' }
+        format.json { render json: { id: id }, status: :destroy_error, location: @collection }
+      end
+    end
+
+    def destroy
+      if @collection.destroy
+        after_destroy(params[:id])
+      else
+        after_destroy_error(params[:id])
+      end
     end
 
-    # overriding the method in Hydra::Collections so the search builder can find the collection
     def collection
       action_name == 'show' ? @presenter : @collection
     end
 
     protected
 
-      def filter_docs_with_read_access!
-        super
+      def remove_select_something_first_flash
         flash.delete(:notice) if flash.notice == 'Select something first'
       end
 
@@ -81,25 +177,74 @@ module CurationConcerns
         form_class.model_attributes(params[:collection])
       end
 
+      def form
+        @form ||= form_class.new(@collection)
+      end
+
+      # Queries Solr for members of the collection.
+      # Populates @response and @member_docs similar to Blacklight Catalog#index populating @response and @documents
       def query_collection_members
         params[:q] = params[:cq]
-        super
+        @response = repository.search(query_for_collection_members)
+        @member_docs = @response.documents
+      end
+
+      # @return <Hash> a representation of the solr query that find the collection members
+      def query_for_collection_members
+        collection_member_search_builder.with(params_for_members_query).query
       end
 
-      def after_destroy(id)
-        respond_to do |format|
-          format.html { redirect_to collections_path, notice: 'Collection was successfully deleted.' }
-          format.json { render json: { id: id }, status: :destroyed, location: @collection }
+      # You can override this method if you need to provide additional inputs to the search
+      # builder. For example:
+      #   search_field: 'all_fields'
+      # @return <Hash> the inputs required for the collection member search builder
+      def params_for_members_query
+        params.symbolize_keys.merge(q: params[:cq])
+      end
+
+      def collection_member_search_builder
+        @collection_member_search_builder ||= collection_member_search_builder_class.new(self).tap do |builder|
+          builder.current_ability = current_ability
         end
       end
 
-      def form
-        @form ||= form_class.new(@collection)
+      def process_member_changes
+        case params[:collection][:members]
+        when 'add' then add_members_to_collection
+        when 'remove' then remove_members_from_collection
+        when 'move' then move_members_between_collections
+        when Array then assign_batch_to_collection
+        end
+      end
+
+      def add_members_to_collection(collection = nil)
+        collection ||= @collection
+        collection.add_members batch
+      end
+
+      def remove_members_from_collection
+        @collection.members.delete(batch.map { |pid| ActiveFedora::Base.find(pid) })
+      end
+
+      def assign_batch_to_collection
+        @collection.members(true) # Force the members to get cached before (maybe) removing some of them
+        @collection.member_ids = batch
+      end
+
+      def move_members_between_collections
+        destination_collection = ::Collection.find(params[:destination_collection_id])
+        remove_members_from_collection
+        add_members_to_collection(destination_collection)
+        if destination_collection.save
+          flash[:notice] = "Successfully moved #{batch.count} files to #{destination_collection.title} Collection."
+        else
+          flash[:error] = "An error occured. Files were not moved to #{destination_collection.title} Collection."
+        end
       end
 
       # Include 'catalog' and 'curation_concerns/base' in the search path for views
       def _prefixes
         @_prefixes ||= super + ['catalog', 'curation_concerns/base']
       end
-  end
-end
+  end # module CollectionsControllerBehavior
+end # module Hydra

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

@@ -2,7 +2,7 @@ module CurationConcerns
   module EmbargoesControllerBehavior
     extend ActiveSupport::Concern
     include CurationConcerns::ManagesEmbargoes
-    include Hydra::Collections::AcceptsBatches
+    include CurationConcerns::Collections::AcceptsBatches
 
     included do
       skip_before_action :normalize_identifier, only: :update

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

@@ -2,7 +2,7 @@ module CurationConcerns
   module LeasesControllerBehavior
     extend ActiveSupport::Concern
     include CurationConcerns::ManagesEmbargoes
-    include Hydra::Collections::AcceptsBatches
+    include CurationConcerns::Collections::AcceptsBatches
 
     included do
       skip_before_action :normalize_identifier, only: :update

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

@@ -0,0 +1,65 @@
+module CurationConcerns::SelectsCollections
+  extend ActiveSupport::Concern
+
+  included do
+    configure_blacklight do |config|
+      config.search_builder_class = CurationConcerns::CollectionSearchBuilder
+    end
+  end
+
+  def access_levels
+    { read: [:read, :edit], edit: [:edit] }
+  end
+
+  ##
+  # Return list of collections for which the current user has read access.
+  # Add this or find_collections_with_edit_access as a before filter on any page that shows the form_for_select_collection
+  #
+  # @return [Array<SolrDocument>] Solr documents for each collection the user has read access
+  def find_collections_with_read_access
+    find_collections(:read)
+  end
+
+  ##
+  # Return list of collections for which the current user has edit access.  Optionally prepend with default
+  # that can be used in a select menu to instruct user to select a collection.
+  # Add this or find_collections_with_read_access as a before filter on any page that shows the form_for_select_collection
+  #
+  # @param [TrueClass|FalseClass] :include_default if true, prepends the default_option; otherwise, if false, returns only collections
+  # @param [Fixnum] :default_id for select menus, this is the id of the first selection representing the instructions
+  # @param [String] :default_title for select menus, this is the text displayed as the first item serving as instructions
+  #
+  # @return [Array<SolrDocument>] Solr documents for each collection the user has edit access, plus optional instructions
+  def find_collections_with_edit_access(include_default = false, default_id = -1, default_title = 'Select collection...')
+    find_collections(:edit)
+    default_option = SolrDocument.new(id: default_id, title_tesim: default_title)
+    @user_collections.unshift(default_option) if include_default
+  end
+
+  ##
+  # Return list of collections matching the passed in access_level for the current user.
+  # @param [Symbol] :access_level one of :read or :edit
+  # @return [Array<SolrDocument>] Solr documents for each collection the user has the appropriate access level
+  def find_collections(access_level = nil)
+    # need to know the user if there is an access level applied otherwise we are just doing public collections
+    authenticate_user! unless access_level.blank?
+
+    # run the solr query to find the collections
+    query = collections_search_builder(access_level).with(q: '').query
+    response = repository.search(query)
+
+    # return the user's collections (or public collections if no access_level is applied)
+    @user_collections = response.documents
+  end
+
+  def collections_search_builder_class
+    CurationConcerns::CollectionSearchBuilder
+  end
+
+  def collections_search_builder(access_level = nil)
+    collections_search_builder_class.new(self).tap do |builder|
+      builder.current_ability = current_ability
+      builder.discovery_perms = access_levels[access_level] if access_level
+    end
+  end
+end

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

@@ -18,35 +18,6 @@ module CurationConcerns
         model_class.validators_on(key).any? { |v| v.is_a? ActiveModel::Validations::PresenceValidator }
       end
 
-      # The form only supports a single value for title, so use the first
-      # @return [String] the first title
-      def title
-        model.title.first
-      end
-
-      # The form only supports a single value for description, so use the first
-      # @return [String] the first description
-      def description
-        model.description.first
-      end
-
-      # @param [Symbol] key the property to test for cardinality
-      # @return [FalseClass,TrueClass] whether the value on the form is singular or multipl
-      def self.multiple?(key)
-        return false if [:title, :description].include? key
-        super
-      end
-
-      # @param [ActiveSupport::Parameters]
-      # @return [Hash] a hash suitable for populating Collection attributes.
-      def self.model_attributes(_)
-        attrs = super
-        # cast title and description back to multivalued
-        attrs[:title] = Array(attrs[:title]) if attrs[:title]
-        attrs[:description] = Array(attrs[:description]) if attrs[:description]
-        attrs
-      end
-
       # @return [Hash] All generic files in the collection, file.to_s is the key, file.id is the value
       def select_files
         Hash[all_files]

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

@@ -6,7 +6,8 @@ module CurationConcerns
 
       delegate :human_readable_type, :open_access?, :authenticated_only_access?,
                :open_access_with_embargo_release_date?, :private_access?,
-               :embargo_release_date, :lease_expiration_date, :member_ids, to: :model
+               :embargo_release_date, :lease_expiration_date, :member_ids,
+               :visibility, to: :model
 
       self.terms = [:title, :creator, :contributor, :description,
                     :tag, :rights, :publisher, :date_created, :subject, :language,

data/app/helpers/batch_select_helper.rb

@@ -0,0 +1,23 @@
+# View Helpers for Hydra Batch Edit functionality
+module BatchSelectHelper
+  # determines if the given document id is in the batch
+  # def item_in_batch?(doc_id)
+  #   session[:batch_document_ids] && session[:batch_document_ids].include?(doc_id) ? true : false
+  # end
+
+  # Displays the batch edit tools.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+  def batch_select_tools
+    render partial: '/batch_select/tools'
+  end
+
+  # Displays the button to select/deselect items for your batch.  Call this in the index partial that's rendered for each search result.
+  # @param [Hash] document the Hash (aka Solr hit) for one Solr document
+  def button_for_add_to_batch(document)
+    render partial: '/batch_select/add_button', locals: { document: document }
+  end
+
+  # Displays the check all button to select/deselect items for your batch.  Put this in your search result page template.  We put it in catalog/index.html
+  def batch_check_all(label = 'Use all results')
+    render partial: '/batch_select/check_all', locals: { label: label }
+  end
+end

data/app/helpers/collections_helper.rb

@@ -0,0 +1,4 @@
+# View Helpers for Hydra Collections functionality
+module CollectionsHelper
+  include CurationConcerns::CollectionsHelperBehavior
+end

data/app/helpers/curation_concerns/collections_helper.rb

@@ -14,8 +14,8 @@ module CurationConcerns::CollectionsHelper
   # override hydra-collections
   def link_to_remove_from_collection(document, label = 'Remove From Collection')
     collection_id = @collection ? @collection.id : @presenter.id
-    link_to collections.collection_path(collection_id, collection: { members: 'remove' },
-                                                       batch_document_ids: [document.id]), method: :put do
+    link_to collection_path(collection_id, collection: { members: 'remove' },
+                                           batch_document_ids: [document.id]), method: :put do
       icon('minus-sign') + ' ' + label
     end
   end

data/app/helpers/curation_concerns/collections_helper_behavior.rb

@@ -0,0 +1,56 @@
+# View Helpers for Hydra Collections functionality
+module CurationConcerns
+  module CollectionsHelperBehavior
+    def has_collection_search_parameters?
+      !params[:cq].blank?
+    end
+
+    # Displays the Collections create collection button.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+    def button_for_create_collection(label = 'Create Collection')
+      render '/collections/button_create_collection', label: label
+    end
+
+    # Displays the Collections update collection button.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+    def button_for_update_collection(label = 'Update Collection', collection_id = 'collection_replace_id')
+      render '/collections/button_for_update_collection', label: label, collection_id: collection_id
+    end
+
+    # Displays the Collections delete collection button.  Put this in your search result page for each collection found.
+    def button_for_delete_collection(collection, label = 'Delete Collection', confirm = 'Are you sure?')
+      render '/collections/button_for_delete_collection', collection: collection, label: label, confirm: confirm
+    end
+
+    def button_for_remove_from_collection(collection, document, label = 'Remove From Collection')
+      render '/collections/button_remove_from_collection', collection: collection, label: label, document: document
+    end
+
+    def button_for_remove_selected_from_collection(collection, label = 'Remove From Collection')
+      render '/collections/button_for_remove_selected_from_collection', collection: collection, label: label
+    end
+
+    # add hidden fields to a form for removing a single document from a collection
+    def single_item_action_remove_form_fields(form, document)
+      single_item_action_form_fields(form, document, 'remove')
+    end
+
+    # add hidden fields to a form for adding a single document to a collection
+    def single_item_action_add_form_fields(form, document)
+      single_item_action_form_fields(form, document, 'add')
+    end
+
+    # add hidden fields to a form for performing an action on a single document on a collection
+    def single_item_action_form_fields(form, document, action)
+      render '/collections/single_item_action_fields', form: form, document: document, action: action
+    end
+
+    def hidden_collection_members
+      erbout = ''
+      if params[:batch_document_ids].present?
+        params[:batch_document_ids].each do |batch_item|
+          erbout.concat hidden_field_tag('batch_document_ids[]', batch_item)
+        end
+      end
+      erbout.html_safe
+    end
+  end
+end

data/app/helpers/curation_concerns/render_constraints_helper.rb

@@ -1,42 +1,21 @@
 module CurationConcerns
   module RenderConstraintsHelper
-    # Overridden to remove the 'search_field' tag from the localized params when the query is cleared.
-    # This is because unlike Blacklight, there is no way to change the search_field in the curation_concerns UI
-    ##
-    # Render the query constraints
-    #
-    # @param [Hash] query parameters
-    # @return [String]
-    def render_constraints_query(localized_params = params)
-      # So simple don't need a view template, we can just do it here.
-      return ''.html_safe if localized_params[:q].blank?
-
-      render_constraint_element(constraint_query_label(localized_params),
-                                localized_params[:q],
-                                classes: ['query'],
-                                remove: url_for(localized_params.except(:search_field).merge(q: nil, action: 'index')))
-    end
-
-    ##
-    # We can remove this method once we use Blacklight > 5.4.0
-    ##
-    # Return a label for the currently selected search field.
-    # If no "search_field" or the default (e.g. "all_fields") is selected, then return nil
-    # Otherwise grab the label of the selected search field.
-    # @param [Hash] query parameters
-    # @return [String]
-    def constraint_query_label(localized_params = params)
-      label_for_search_field(localized_params[:search_field]) unless default_search_field?(localized_params[:search_field])
+    # This overrides Blacklight to remove the 'search_field' tag from the
+    # localized params when the query is cleared. This is because unlike
+    # Blacklight, there is no control to change the search_field in the
+    # curation_concerns UI
+    def remove_constraint_url(localized_params)
+      scope = localized_params.delete(:route_set) || self
+      options = localized_params.merge(q: nil, action: 'index')
+                                .except(*fields_to_exclude_from_constraint_element)
+      options.permit!
+      scope.url_for(options)
     end
 
-    ##
-    # We can remove this method once we use Blacklight > 5.4.0
-    ##
-    # Is the search form using the default search field ("all_fields" by default)?
-    # @param [String] the currently selected search_field
-    # @return [Boolean]
-    def default_search_field?(selected_search_field)
-      selected_search_field.blank? || (default_search_field && selected_search_field == default_search_field[:key])
+    # @return [Array<Symbol>] a list of fields to remove on the render_constraint_element
+    # You can override this if you have different fields to remove
+    def fields_to_exclude_from_constraint_element
+      [:search_field]
     end
   end
 end

data/app/helpers/curation_concerns/title_helper.rb

@@ -1,4 +1,8 @@
 module CurationConcerns::TitleHelper
+  def application_name
+    t('curation_concerns.product_name', default: super)
+  end
+
   def construct_page_title(*elements)
     (elements.flatten.compact + [application_name]).join(' // ')
   end

data/app/indexers/curation_concerns/collection_indexer.rb

@@ -0,0 +1,16 @@
+module CurationConcerns
+  class CollectionIndexer < Hydra::PCDM::CollectionIndexer
+    include IndexesThumbnails
+    STORED_LONG = Solrizer::Descriptor.new(:long, :stored)
+
+    def generate_solr_document
+      super.tap do |solr_doc|
+        # Makes Collections show under the "Collections" tab
+        Solrizer.set_field(solr_doc, 'generic_type', 'Collection', :facetable)
+        # Index the size of the collection in bytes
+        solr_doc[Solrizer.solr_name(:bytes, STORED_LONG)] = object.bytes
+        solr_doc['thumbnail_path_ss'] = thumbnail_path
+      end
+    end
+  end
+end

data/app/indexers/curation_concerns/file_set_indexer.rb

@@ -0,0 +1,46 @@
+module CurationConcerns
+  class FileSetIndexer < ActiveFedora::IndexingService
+    include IndexesThumbnails
+    STORED_INTEGER = Solrizer::Descriptor.new(:integer, :stored)
+
+    def generate_solr_document
+      super.tap do |solr_doc|
+        solr_doc[Solrizer.solr_name('hasRelatedMediaFragment', :symbol)] = object.representative_id
+        solr_doc[Solrizer.solr_name('hasRelatedImage', :symbol)] = object.thumbnail_id
+        # Label is the actual file name. It's not editable by the user.
+        solr_doc[Solrizer.solr_name('label')] = object.label
+        solr_doc[Solrizer.solr_name('label', :stored_sortable)] = object.label
+        solr_doc[Solrizer.solr_name('file_format')] = file_format
+        solr_doc[Solrizer.solr_name('file_format', :facetable)] = file_format
+        solr_doc[Solrizer.solr_name(:file_size, STORED_INTEGER)] = object.file_size[0]
+        solr_doc['all_text_timv'] = object.full_text.content
+        solr_doc[Solrizer.solr_name('generic_work_ids', :symbol)] = object.generic_work_ids unless object.generic_work_ids.empty?
+        solr_doc['height_is'] = Integer(object.height.first) if object.height.present?
+        solr_doc['width_is'] = Integer(object.width.first) if object.width.present?
+        solr_doc[Solrizer.solr_name('mime_type', :stored_sortable)] = object.mime_type
+        solr_doc['thumbnail_path_ss'] = thumbnail_path
+        # Index the Fedora-generated SHA1 digest to create a linkage
+        # between files on disk (in fcrepo.binary-store-path) and objects
+        # in the repository.
+        solr_doc[Solrizer.solr_name('digest', :symbol)] = digest_from_content
+      end
+    end
+
+    private
+
+      def digest_from_content
+        return unless object.original_file
+        object.original_file.digest.first.to_s
+      end
+
+      def file_format
+        if object.mime_type.present? && object.format_label.present?
+          "#{object.mime_type.split('/').last} (#{object.format_label.join(', ')})"
+        elsif object.mime_type.present?
+          object.mime_type.split('/').last
+        elsif object.format_label.present?
+          object.format_label
+        end
+      end
+  end
+end