curation_concerns 0.1.0 → 0.2.0

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

@@ -10,271 +10,15 @@ module CurationConcerns::CatalogController
     with_themed_layout 'catalog'
     helper CurationConcerns::CatalogHelper
     # These before_filters apply the hydra access controls
-    before_filter :enforce_show_permissions, only: :show
+    before_action :enforce_show_permissions, only: :show
     # This applies appropriate access controls to all solr queries
     CatalogController.search_params_logic += [:add_access_controls_to_solr_params]
     self.search_params_logic += [:filter_models]
-    self.search_params_logic += [:only_generic_files_and_curation_concerns]
-
-    configure_blacklight do |config|
-
-      config.search_builder_class = CurationConcerns::SearchBuilder
-      ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
-      config.default_solr_params = {
-        qf: search_config['qf'],
-        qt: search_config['qt'],
-        rows: search_config['rows']
-      }
-
-      # solr field configuration for search results/index views
-      config.index.title_field = solr_name("title", :stored_searchable)
-      config.index.display_type_field = solr_name("has_model", :symbol)
-
-      config.index.thumbnail_method = :thumbnail_tag
-      config.index.partials.delete(:thumbnail) # we render this inside _index_default.html.erb
-
-      # solr field configuration for document/show views
-      # config.show.title_field = solr_name("title", :stored_searchable)
-      # config.show.display_type_field = solr_name("has_model", :symbol)
-
-      # solr fields that will be treated as facets by the blacklight application
-      #   The ordering of the field names is the order of the display
-      config.add_facet_field solr_name("human_readable_type", :facetable)
-      config.add_facet_field solr_name('creator', :facetable), limit: 5
-      config.add_facet_field solr_name("tag", :facetable), limit: 5
-      config.add_facet_field solr_name("subject", :facetable), limit: 5
-      config.add_facet_field solr_name("language", :facetable), limit: 5
-      config.add_facet_field solr_name("based_near", :facetable), limit: 5
-      config.add_facet_field solr_name("publisher", :facetable), limit: 5
-      config.add_facet_field solr_name("file_format", :facetable), limit: 5
-      config.add_facet_field "generic_type_sim", show: false, single: true
-
-      # Have BL send all facet field names to Solr, which has been the default
-      # previously. Simply remove these lines if you'd rather use Solr request
-      # handler defaults, or have no facets.
-      config.add_facet_fields_to_solr_request!
-
-      # solr fields to be displayed in the index (search results) view
-      #   The ordering of the field names is the order of the display
-      config.add_index_field solr_name("description", :stored_searchable)
-      config.add_index_field solr_name("tag", :stored_searchable)
-      config.add_index_field solr_name("subject", :stored_searchable)
-      config.add_index_field solr_name("creator", :stored_searchable)
-      config.add_index_field solr_name("contributor", :stored_searchable)
-      config.add_index_field solr_name("publisher", :stored_searchable)
-      config.add_index_field solr_name("based_near", :stored_searchable)
-      config.add_index_field solr_name("language", :stored_searchable)
-      config.add_index_field solr_name("date_uploaded", :stored_sortable)
-      config.add_index_field solr_name("date_modified", :stored_sortable)
-      config.add_index_field solr_name("date_created", :stored_searchable)
-      config.add_index_field solr_name("rights", :stored_searchable)
-      config.add_index_field solr_name("human_readable_type", :stored_searchable)
-      config.add_index_field solr_name("format", :stored_searchable)
-      config.add_index_field solr_name("identifier", :stored_searchable)
-
-      # solr fields to be displayed in the show (single result) view
-      #   The ordering of the field names is the order of the display
-      config.add_show_field solr_name("title", :stored_searchable)
-      config.add_show_field solr_name("description", :stored_searchable)
-      config.add_show_field solr_name("tag", :stored_searchable)
-      config.add_show_field solr_name("subject", :stored_searchable)
-      config.add_show_field solr_name("creator", :stored_searchable)
-      config.add_show_field solr_name("contributor", :stored_searchable)
-      config.add_show_field solr_name("publisher", :stored_searchable)
-      config.add_show_field solr_name("based_near", :stored_searchable)
-      config.add_show_field solr_name("language", :stored_searchable)
-      config.add_show_field solr_name("date_uploaded", :stored_sortable)
-      config.add_show_field solr_name("date_modified", :stored_sortable)
-      config.add_show_field solr_name("date_created", :stored_searchable)
-      config.add_show_field solr_name("rights", :stored_searchable)
-      config.add_show_field solr_name("human_readable_type", :stored_searchable)
-      config.add_show_field solr_name("format", :stored_searchable)
-      config.add_show_field solr_name("identifier", :stored_searchable)
-
-      # "fielded" search configuration. Used by pulldown among other places.
-      # For supported keys in hash, see rdoc for Blacklight::SearchFields
-      #
-      # Search fields will inherit the :qt solr request handler from
-      # config[:default_solr_parameters], OR can specify a different one
-      # with a :qt key/value. Below examples inherit, except for subject
-      # that specifies the same :qt as default for our own internal
-      # testing purposes.
-      #
-      # The :key is what will be used to identify this BL search field internally,
-      # as well as in URLs -- so changing it after deployment may break bookmarked
-      # urls.  A display label will be automatically calculated from the :key,
-      # or can be specified manually to be different.
-      #
-      # This one uses all the defaults set by the solr request handler. Which
-      # solr request handler? The one set in config[:default_solr_parameters][:qt],
-      # since we aren't specifying it otherwise.
-      config.add_search_field('all_fields', label: 'All Fields', :include_in_advanced_search => false) do |field|
-        title_name = solr_name("title", :stored_searchable, type: :string)
-        label_name = solr_name("title", :stored_searchable, type: :string)
-        contributor_name = solr_name("contributor", :stored_searchable, type: :string)
-        field.solr_parameters = {
-          :qf => "#{title_name} #{label_name} file_format_tesim #{contributor_name}",
-          :pf => "#{title_name}"
-        }
-      end
-
-
-      # Now we see how to over-ride Solr request handler defaults, in this
-      # case for a BL "search field", which is really a dismax aggregate
-      # of Solr search fields.
-      # creator, title, description, publisher, date_created,
-      # subject, language, resource_type, format, identifier, based_near,
-      config.add_search_field('contributor') do |field|
-        # solr_parameters hash are sent to Solr as ordinary url query params.
-
-        # :solr_local_parameters will be sent using Solr LocalParams
-        # syntax, as eg {! qf=$title_qf }. This is neccesary to use
-        # Solr parameter de-referencing like $title_qf.
-        # See: http://wiki.apache.org/solr/LocalParams
-        solr_name = solr_name("contributor", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('creator') do |field|
-        solr_name = solr_name("creator", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('title') do |field|
-        solr_name = solr_name("title", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('description') do |field|
-        field.label = "Abstract or Summary"
-        solr_name = solr_name("description", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('publisher') do |field|
-        solr_name = solr_name("publisher", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('date_created') do |field|
-        solr_name = solr_name("created", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('subject') do |field|
-        solr_name = solr_name("subject", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('language') do |field|
-        solr_name = solr_name("language", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('human_readable_type') do |field|
-        solr_name = solr_name("human_readable_type", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('format') do |field|
-        field.include_in_advanced_search = false
-        solr_name = solr_name("format", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('identifier') do |field|
-        field.include_in_advanced_search = false
-        solr_name = solr_name("id", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('based_near') do |field|
-        field.label = "Location"
-        solr_name = solr_name("based_near", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('tag') do |field|
-        solr_name = solr_name("tag", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('depositor') do |field|
-        solr_name = solr_name("depositor", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-      config.add_search_field('rights') do |field|
-        solr_name = solr_name("rights", :stored_searchable, type: :string)
-        field.solr_local_parameters = {
-          :qf => solr_name,
-          :pf => solr_name
-        }
-      end
-
-
-      # "sort results by" select (pulldown)
-      # label in pulldown is followed by the name of the SOLR field to sort by and
-      # whether the sort is ascending or descending (it must be asc or desc
-      # except in the relevancy case).
-      # label is key, solr field is value
-      config.add_sort_field "score desc, #{uploaded_field} desc", label: "relevance \u25BC"
-      config.add_sort_field "#{uploaded_field} desc", label: "date uploaded \u25BC"
-      config.add_sort_field "#{uploaded_field} asc", label: "date uploaded \u25B2"
-      config.add_sort_field "#{modified_field} desc", label: "date modified \u25BC"
-      config.add_sort_field "#{modified_field} asc", label: "date modified \u25B2"
-
-      # If there are more than this many search results, no spelling ("did you
-      # mean") suggestion is offered.
-      config.spell_max = 5
-    end
   end
 
   module ClassMethods
-    def t *args
-      I18n.translate *args
+    def t(*args)
+      I18n.translate(*args)
     end
 
     def uploaded_field
@@ -283,39 +27,28 @@ module CurationConcerns::CatalogController
     end
 
     def modified_field
-      solr_name('date_modified', :stored_sortable , type: :date)
+      solr_name('date_modified', :stored_sortable, type: :date)
     end
 
     def search_config
-       {'qf' => ['title_tesim','name_tesim'], 'qt' => 'search', 'rows' => 10}
+      { 'qf' => %w(title_tesim name_tesim), 'qt' => 'search', 'rows' => 10 }
     end
   end
 
-
   protected
 
-
     # Overriding Blacklight so that the search results can be displayed in a way compatible with
     # tokenInput javascript library.  This is used for suggesting "Related Works" to attach.
     def render_search_results_as_json
-      {"docs" => @response["response"]["docs"].map {|solr_doc| serialize_work_from_solr(solr_doc) }}
+      { 'docs' => @response['response']['docs'].map { |solr_doc| serialize_work_from_solr(solr_doc) } }
     end
 
     def serialize_work_from_solr(solr_doc)
-      title = solr_doc["title_tesim"].first
-      title << " (#{solr_doc["human_readable_type_tesim"].first})" if solr_doc["human_readable_type_tesim"].present?
+      title = solr_doc['title_tesim'].first
+      title << " (#{solr_doc['human_readable_type_tesim'].first})" if solr_doc['human_readable_type_tesim'].present?
       {
-        pid: solr_doc["id"],
+        pid: solr_doc['id'],
         title: title
       }
     end
-
-    def depositor
-      #Hydra.config[:permissions][:owner] maybe it should match this config variable, but it doesn't.
-      Solrizer.solr_name('depositor', :stored_searchable, type: :string)
-    end
-
-    def sort_field
-      "#{Solrizer.solr_name('system_create', :sortable)} desc"
-    end
 end

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

@@ -2,11 +2,13 @@ module CurationConcerns
   module CollectionsControllerBehavior
     extend ActiveSupport::Concern
     include Hydra::CollectionsControllerBehavior
+    include Hydra::Controller::SearchBuilder
 
     included do
-      before_filter :filter_docs_with_read_access!, except: :show
+      before_action :filter_docs_with_read_access!, except: :show
       self.search_params_logic += [:add_access_controls_to_solr_params, :add_advanced_parse_q_to_solr]
-      layout "curation_concerns/1_column"
+      layout 'curation_concerns/1_column'
+      skip_load_and_authorize_resource only: :show
     end
 
     def new
@@ -20,57 +22,66 @@ module CurationConcerns
     end
 
     def show
-      super
       presenter
+      super
+    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 presenter
-      @presenter ||= presenter_class.new(@collection)
-    end
+      def filter_docs_with_read_access!
+        super
+        flash.delete(:notice) if flash.notice == 'Select something first'
+      end
 
-    def presenter_class
-      CurationConcerns::CollectionPresenter
-    end
+      def presenter
+        @presenter ||= begin
+          _, document_list = search_results(params, self.class.search_params_logic + [:find_one])
+          curation_concern = document_list.first
+          raise CanCan::AccessDenied unless curation_concern
+          presenter_class.new(curation_concern, current_ability)
+        end
+      end
 
-    def collection_member_search_builder_class
-      CurationConcerns::SearchBuilder
-    end
+      def presenter_class
+        CurationConcerns::CollectionPresenter
+      end
 
-    def collection_params
-      form_class.model_attributes(
-        params.require(:collection).permit(:title, :description, :members, part_of: [],
-          contributor: [], creator: [], publisher: [], date_created: [], subject: [],
-          language: [], rights: [], resource_type: [], identifier: [], based_near: [],
-          tag: [], related_url: [])
-      )
-    end
+      def collection_member_search_builder_class
+        CurationConcerns::SearchBuilder
+      end
 
-    def query_collection_members
-      flash[:notice]=nil if flash[:notice] == "Select something first"
-      params[:q] = params[:cq]
-      super
-    end
+      def collection_params
+        form_class.model_attributes(params[:collection])
+      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 }
+      def query_collection_members
+        params[:q] = params[:cq]
+        super
       end
-    end
 
-    def form
-      @form ||= form_class.new(@collection)
-    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 }
+        end
+      end
 
-    def form_class
-      CurationConcerns::Forms::CollectionEditForm
-    end
+      def form
+        @form ||= form_class.new(@collection)
+      end
 
-    # Include 'catalog' and 'curation_concerns/base' in the search path for views
-    def _prefixes
-      @_prefixes ||= super + ['catalog', 'curation_concerns/base']
-    end
+      def form_class
+        CurationConcerns::Forms::CollectionEditForm
+      end
+
+      # Include 'catalog' and 'curation_concerns/base' in the search path for views
+      def _prefixes
+        @_prefixes ||= super + ['catalog', 'curation_concerns/base']
+      end
   end
 end

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

@@ -1,8 +1,10 @@
 module CurationConcerns::CurationConcernController
   extend ActiveSupport::Concern
-  include Blacklight::Catalog::SearchContext
+  include Blacklight::Base
+  include Hydra::Controller::SearchBuilder
 
   included do
+    copy_blacklight_config_from(CatalogController)
     include CurationConcerns::ThemedLayoutController
     with_themed_layout '1_column'
     helper CurationConcerns::AbilityHelper
@@ -10,13 +12,11 @@ module CurationConcerns::CurationConcernController
     class_attribute :curation_concern_type
     attr_accessor :curation_concern
     helper_method :curation_concern
-
-    respond_to :html
   end
 
   module ClassMethods
     def set_curation_concern_type(curation_concern_type)
-      load_and_authorize_resource class: curation_concern_type, instance_name: :curation_concern
+      load_and_authorize_resource class: curation_concern_type, instance_name: :curation_concern, except: :show
       self.curation_concern_type = curation_concern_type
     end
 
@@ -34,16 +34,49 @@ module CurationConcerns::CurationConcernController
       after_create_response
     else
       setup_form
-      respond_with(:curation_concerns, curation_concern) do |wants|
+      respond_to do |wants|
         wants.html { render 'new', status: :unprocessable_entity }
+        wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: curation_concern.errors }) }
       end
     end
   end
 
+  # Finds a solr document matching the id and sets @presenter
+  # @raises CanCan::AccessDenied if the document is not found
+  #   or the user doesn't have access to it.
   def show
+    respond_to do |wants|
+      wants.html do
+        _, document_list = search_results(params, CatalogController.search_params_logic + [:find_one])
+        curation_concern = document_list.first
+        raise CanCan::AccessDenied.new(nil, :show) unless curation_concern
+        @presenter = show_presenter.new(curation_concern, current_ability)
+      end
+      wants.json do
+        # load and authorize @curation_concern manually because it's skipped for html
+        # This has to use #find instead of #load_instance_from_solr because
+        # we want to return values like file_set_ids in the json
+        @curation_concern = curation_concern_type.find(params[:id]) unless curation_concern
+        authorize! :show, @curation_concern
+        render :show, status: :ok
+      end
+    end
+  end
+
+  # Gives the class of the show presenter. Override this if you want
+  # to use a different presenter.
+  def show_presenter
+    CurationConcerns::WorkShowPresenter
+  end
+
+  # Gives the class of the form. Override this if you want
+  # to use a different form.
+  def form_class
+    CurationConcerns.const_get("#{self.class.curation_concern_type}Form")
   end
 
   def edit
+    @form = form_class.new(curation_concern, current_ability)
   end
 
   def update
@@ -51,8 +84,12 @@ module CurationConcerns::CurationConcernController
       after_update_response
     else
       setup_form
-      respond_with(:curation_concerns, curation_concern) do |wants|
-        wants.html { render 'edit', status: :unprocessable_entity }
+      respond_to do |wants|
+        wants.html do
+          @form = form_class.new(curation_concern, current_ability)
+          render 'edit', status: :unprocessable_entity
+        end
+        wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: curation_concern.errors }) }
       end
     end
   end
@@ -66,57 +103,50 @@ module CurationConcerns::CurationConcernController
   attr_writer :actor
 
   protected
+
     def actor
       @actor ||= CurationConcerns::CurationConcern.actor(curation_concern, current_user, attributes_for_actor)
     end
 
     # Override setup_form in concrete controllers to get the form ready for display
     def setup_form
-      if curation_concern.respond_to?(:contributor) && curation_concern.contributor.blank?
-        curation_concern.contributor << current_user.name
-      end
+      return unless curation_concern.respond_to?(:contributor) && curation_concern.contributor.blank?
+      curation_concern.contributor << current_user.user_key
     end
 
-    # def verify_acceptance_of_user_agreement!
-    #   return true if contributor_agreement.is_being_accepted?
-    #   # Calling the new action to make sure we are doing our best to preserve
-    #   # the input values; Its a stretch but hopefully it'll work
-    #   self.new
-    #   respond_with(:curation_concern, curation_concern) do |wants|
-    #     wants.html {
-    #       flash.now[:error] = "You must accept the contributor agreement"
-    #       render 'new', status: :conflict
-    #     }
-    #   end
-    #   false
-    # end
-
     def _prefixes
       @_prefixes ||= super + ['curation_concerns/base']
     end
 
     def after_create_response
-      respond_with(main_app, :curation_concerns, curation_concern)
+      respond_to do |wants|
+        wants.html { redirect_to [main_app, :curation_concerns, curation_concern] }
+        wants.json { render :show, status: :created, location: polymorphic_path([main_app, :curation_concerns, curation_concern]) }
+      end
     end
 
     def after_update_response
-      #TODO visibility or lease/embargo status
+      # TODO: visibility or lease/embargo status
       if actor.visibility_changed?
         redirect_to main_app.confirm_curation_concerns_permission_path(curation_concern)
       else
-        respond_with(main_app, :curation_concerns, curation_concern)
+        respond_to do |wants|
+          wants.html { redirect_to [main_app, :curation_concerns, curation_concern] }
+          wants.json { render :show, status: :ok, location: polymorphic_path([main_app, :curation_concerns, curation_concern]) }
+        end
       end
     end
 
     def after_destroy_response(title)
       flash[:notice] = "Deleted #{title}"
-      respond_with { |wants|
+      respond_to do |wants|
         wants.html { redirect_to main_app.catalog_index_path }
-      }
+        wants.json { render_json_response(response_type: :deleted, message: "Deleted #{curation_concern.id}") }
+      end
     end
 
     def attributes_for_actor
-      params.fetch(hash_key_for_curation_concern, {}).permit!
+      form_class.model_attributes(params[hash_key_for_curation_concern])
     end
 
     def hash_key_for_curation_concern