sufia 7.0.0.beta4 → 7.0.0.rc1

data/app/assets/stylesheets/sufia/_fixedsticky.scss

@@ -1,26 +1,28 @@
-.fixedsticky {
-  position: -webkit-sticky;
-  position: -moz-sticky;
-  position: -ms-sticky;
-  position: -o-sticky;
-  position: sticky;
-}
+@media (min-width: $screen-sm-min) {
+  .fixedsticky {
+    position: -webkit-sticky;
+    position: -moz-sticky;
+    position: -ms-sticky;
+    position: -o-sticky;
+    position: sticky;
+  }
 
-/* When position: sticky is supported but native behavior is ignored */
-.fixedsticky-withoutfixedfixed .fixedsticky-off,
-.fixed-supported .fixedsticky-off {
-  position: static;
-}
+  /* When position: sticky is supported but native behavior is ignored */
+  .fixedsticky-withoutfixedfixed .fixedsticky-off,
+  .fixed-supported .fixedsticky-off {
+    position: static;
+  }
 
-.fixedsticky-withoutfixedfixed .fixedsticky-on,
-.fixed-supported .fixedsticky-on {
-  position: fixed;
-}
+  .fixedsticky-withoutfixedfixed .fixedsticky-on,
+  .fixed-supported .fixedsticky-on {
+    position: fixed;
+  }
 
-.fixedsticky-dummy {
-  display: none;
-}
+  .fixedsticky-dummy {
+    display: none;
+  }
 
-.fixedsticky-on + .fixedsticky-dummy {
-  display: block;
+  .fixedsticky-on + .fixedsticky-dummy {
+    display: block;
+  }
 }

data/app/assets/stylesheets/sufia/_form-progress.scss

@@ -1,12 +1,21 @@
-.fixedsticky {
-  top: 0; /* Required to get consistent results in Safari and Chrome */
+@media (min-width: $screen-xs-min) {
+  .fixedsticky {
+    margin-top: 1em;
+  }
 }
 
-.fixedsticky-withoutfixedfixed .fixedsticky-on,
-.fixed-supported .fixedsticky-on {
-  left: $save-viz-widget-left;
-  /* Required so that the widget doesn't pop back to top when public desc long */
-  bottom: $save-viz-widget-bottom;
+@media (min-width: $screen-sm-min) {
+  .fixedsticky {
+    margin-top: 0;
+    top: 0; /* Required to get consistent results in Safari and Chrome */
+  }
+
+  .fixedsticky-withoutfixedfixed .fixedsticky-on,
+  .fixed-supported .fixedsticky-on {
+    left: $save-viz-widget-left;
+    /* Required so that the widget doesn't pop back to top when public desc long */
+    bottom: $save-viz-widget-bottom;
+  }
 }
 
 aside.form-progress {

data/app/assets/stylesheets/sufia/_header.scss

@@ -1,5 +1,6 @@
 #search-form-header {
-  margin-top: 6px;
+  margin-top: $search-bar-margin-top;
+  margin-right: $search-bar-margin-right;
 }
 
 #masthead {

data/app/assets/stylesheets/sufia/_settings.scss

@@ -6,6 +6,10 @@
 $classic-white: #FFF !default;
 $vermilion: #F30 !default;
 
+// Nav and Search Bar
+$search-bar-margin-top: 0.50em;
+$search-bar-margin-right: 0.95em;
+
 // Dashboard
 $dashboard-border-color: $gray-lighter !default;
 

data/app/controllers/api/items_controller.rb

@@ -1,7 +1,7 @@
 module API
   # Adds an endpoint that consumes and RESTfully emits JSON from Arkivo
   # representing new and updated Zotero-managed publications. An item in the
-  # Zotero parlance is mapped to a GenericWork in Sufia.
+  # Zotero parlance is mapped to a work in Sufia.
   class ItemsController < ApplicationController
     skip_before_action :verify_authenticity_token
     before_action :validate_item, only: [:create, :update]
@@ -31,7 +31,7 @@ module API
     private
 
       def my_load_and_authorize_resource
-        @work = GenericWork.find(params[:id])
+        @work = CurationConcerns::WorkRelation.new.find(params[:id])
 
         unless user.can? :edit, @work
           return render plain: "#{user} lacks access to #{@work}", status: :unauthorized

data/app/controllers/api/zotero_controller.rb

@@ -34,7 +34,7 @@ module API
     private
 
       def authorize_user!
-        authorize! :create, ::GenericWork
+        authorize! :create, Sufia.primary_work_type
       rescue CanCan::AccessDenied
         return redirect_to root_url, alert: 'You are not authorized to perform this operation'
       end

data/app/controllers/citations_controller.rb

@@ -6,13 +6,11 @@ class CitationsController < ApplicationController
   before_action :build_breadcrumbs, only: [:work, :file]
 
   def work
-    @curation_concern_type = GenericWork
     @presenter_class = Sufia::WorkShowPresenter
     show
   end
 
   def file
-    @curation_concern_type = FileSet
     @presenter_class = Sufia::FileSetPresenter
     show
   end

data/app/controllers/concerns/sufia/batch_edits_controller_behavior.rb

@@ -10,9 +10,9 @@ module Sufia
 
     def edit
       super
-      generic_work = ::GenericWork.new
-      generic_work.depositor = current_user.user_key
-      @form = form_class.new(generic_work, current_user, batch)
+      work = form_class.model_class.new
+      work.depositor = current_user.user_key
+      @form = form_class.new(work, current_user, batch)
     end
 
     def after_update
@@ -27,7 +27,7 @@ module Sufia
     end
 
     def update_document(obj)
-      obj.attributes = generic_work_params
+      obj.attributes = work_params
       obj.date_modified = Time.current.ctime
       obj.visibility = params[:visibility]
     end
@@ -65,9 +65,9 @@ module Sufia
         form_class.terms
       end
 
-      def generic_work_params
-        generic_work_params = params[:generic_work] || ActionController::Parameters.new
-        form_class.model_attributes(generic_work_params)
+      def work_params
+        work_params = params[form_class.model_name.param_key] || ActionController::Parameters.new
+        form_class.model_attributes(work_params)
       end
 
       def redirect_to_return_controller

data/app/controllers/concerns/sufia/batch_uploads_controller_behavior.rb

@@ -6,22 +6,28 @@ module Sufia
 
     included do
       layout "sufia-one-column"
-      self.curation_concern_type = GenericWork
+      self.curation_concern_type = form_class.model_class
     end
 
     def create
       authenticate_user!
       create_update_job
-      flash[:notice] = t('sufia.generic_works.new.after_create_html', application_name: view_context.application_name)
+      flash[:notice] = t('sufia.works.new.after_create_html', application_name: view_context.application_name)
       redirect_after_update
     end
 
+    module ClassMethods
+      def form_class
+        ::Sufia::Forms::BatchUploadForm
+      end
+    end
+
     protected
 
       # Gives the class of the form.
       # This overrides CurationConcerns
       def form_class
-        ::Sufia::Forms::BatchUploadForm
+        self.class.form_class
       end
 
       def redirect_after_update

data/app/controllers/concerns/sufia/singular_subresource_controller.rb

@@ -2,8 +2,9 @@ module Sufia::SingularSubresourceController
   extend ActiveSupport::Concern
 
   included do
+    before_action :find_work, only: :work
+    load_and_authorize_resource :work, only: :work
     load_and_authorize_resource :file, class: 'FileSet', only: :file, id_param: :id
-    load_and_authorize_resource :work, class: 'GenericWork', only: :work, id_param: :id
   end
 
   # Overriding the default behavior from Hydra::Core::ControllerBehavior
@@ -15,4 +16,8 @@ module Sufia::SingularSubresourceController
       redirect_to new_user_session_path, alert: exception.message
     end
   end
+
+  def find_work
+    @work = CurationConcerns::WorkRelation.new.find(params[:id])
+  end
 end

data/app/controllers/concerns/sufia/transfers_controller_behavior.rb

@@ -20,7 +20,7 @@ module Sufia
     end
 
     def new
-      @generic_work = ::GenericWork.load_instance_from_solr(@id)
+      @work = CurationConcerns::WorkRelation.new.find(params[:id])
     end
 
     def create

data/app/controllers/concerns/sufia/users_controller_behavior.rb

@@ -5,9 +5,9 @@ module Sufia::UsersControllerBehavior
     include Blacklight::SearchContext
     layout "sufia-one-column"
     prepend_before_action :find_user, except: [:index, :search, :notifications_number]
-    before_action :authenticate_user!, only: [:edit, :update, :follow, :unfollow, :toggle_trophy]
+    before_action :authenticate_user!, only: [:edit, :update, :follow, :unfollow]
     before_action :user_not_current_user, only: [:follow, :unfollow]
-    authorize_resource only: [:edit, :update, :toggle_trophy]
+    authorize_resource only: [:edit, :update]
     # Catch permission errors
     rescue_from CanCan::AccessDenied, with: :deny_access
   end
@@ -33,7 +33,7 @@ module Sufia::UsersControllerBehavior
 
   # Display form for users to edit their profile information
   def edit
-    @trophies = @user.trophy_works
+    @trophies = Sufia::TrophyPresenter.find_by_user(@user)
   end
 
   # Process changes from profile form

data/app/controllers/concerns/sufia/works_controller_behavior.rb

@@ -6,12 +6,19 @@ module Sufia
     include CurationConcerns::CurationConcernController
 
     included do
-      before_action :build_breadcrumbs, only: [:edit, :show]
-      self.curation_concern_type = GenericWork
       self.show_presenter = Sufia::WorkShowPresenter
       layout "sufia-one-column"
     end
 
+    module ClassMethods
+      # We don't want the breadcrumb action to occur until after the concern has
+      # been loaded and authorized
+      def curation_concern_type=(curation_concern_type)
+        super
+        before_action :build_breadcrumbs, only: [:edit, :show]
+      end
+    end
+
     def new
       curation_concern.depositor = current_user.user_key
       super
@@ -46,7 +53,7 @@ module Sufia
       def after_create_response
         respond_to do |wants|
           wants.html do
-            flash[:notice] = t('sufia.generic_works.new.after_create_html', application_name: view_context.application_name)
+            flash[:notice] = t('sufia.works.new.after_create_html', application_name: view_context.application_name)
             redirect_to [main_app, curation_concern]
           end
           wants.json { render :show, status: :created, location: polymorphic_path([main_app, curation_concern]) }
@@ -65,7 +72,7 @@ module Sufia
       def add_breadcrumb_for_action
         case action_name
         when 'edit'.freeze
-          add_breadcrumb I18n.t("sufia.work.browse_view"), main_app.curation_concerns_generic_work_path(params["id"])
+          add_breadcrumb I18n.t("sufia.work.browse_view"), main_app.polymorphic_path(curation_concern)
         when 'show'.freeze
           add_breadcrumb presenter.to_s, main_app.polymorphic_path(presenter)
         end

data/app/controllers/my/highlights_controller.rb

@@ -16,7 +16,7 @@ module My
       end
 
       def query_solr
-        return empty_search_result if @user.trophy_works.count == 0
+        return empty_search_result if Sufia::TrophyPresenter.find_by_user(@user).count == 0
         super
       end
 

data/app/forms/sufia/forms/batch_edit_form.rb

@@ -2,14 +2,17 @@ module Sufia
   module Forms
     class BatchEditForm < Sufia::Forms::WorkForm
       self.terms = [:creator, :contributor, :description,
-                    :keyword, :rights, :publisher, :date_created,
+                    :keyword, :resource_type, :rights, :publisher, :date_created,
                     :subject, :language, :identifier, :based_near,
                     :related_url]
       self.required_fields = []
-      self.model_class = ::GenericWork
+      self.model_class = Sufia.primary_work_type
 
       attr_accessor :names
 
+      # @param [ActiveFedora::Base] model the model backing the form
+      # @param [Ability] current_ability the user authorization model
+      # @param [Array<String>] batch a list of document ids in the batch
       def initialize(model, current_ability, batch)
         super(model, current_ability)
         @names = []
@@ -19,18 +22,19 @@ module Sufia
       private
 
         # override this method if you need to initialize more complex RDF assertions (b-nodes)
+        # @param [Array<String>] batch a list of document ids in the batch
         def initialize_combined_fields(batch)
           combined_attributes = {}
           permissions = []
           # For each of the files in the batch, set the attributes to be the concatination of all the attributes
           batch.each do |doc_id|
-            gw = ::GenericWork.load_instance_from_solr(doc_id)
+            work = model_class.load_instance_from_solr(doc_id)
             terms.each do |key|
               combined_attributes[key] ||= []
-              combined_attributes[key] = (combined_attributes[key] + gw[key]).uniq
+              combined_attributes[key] = (combined_attributes[key] + work[key]).uniq
             end
-            names << gw.to_s
-            permissions = (permissions + gw.permissions).uniq
+            names << work.to_s
+            permissions = (permissions + work.permissions).uniq
           end
 
           terms.each do |key|

data/app/forms/sufia/forms/batch_upload_form.rb

@@ -1,13 +1,13 @@
 module Sufia
   module Forms
     class BatchUploadForm < Sufia::Forms::WorkForm
-      self.model_class = ::GenericWork
+      self.model_class = BatchUploadItem
       include HydraEditor::Form::Permissions
 
       self.terms -= [:title, :resource_type]
 
       # The WorkForm delegates `#depositor` to `:model`, but `:model` in the
-      # BatchUpload context is a blank GenericWork with a `nil` depositor
+      # BatchUpload context is a blank work with a `nil` depositor
       # value. This causes the "Sharing With" widget to display the Depositor as
       # "()". We should be able to reliably pull back the depositor of the new
       # batch of works by asking the form's Ability what its `current_user` is.

data/app/forms/sufia/forms/collection_form.rb

@@ -2,6 +2,10 @@ module Sufia::Forms
   class CollectionForm < CurationConcerns::Forms::CollectionEditForm
     delegate :id, to: :model
 
+    # TODO: remove this when https://github.com/projecthydra/hydra-editor/pull/115
+    # is merged and hydra-editor 3.0.0 is released
+    delegate :model_name, to: :model
+
     def primary_terms
       [:title]
     end

data/app/forms/sufia/forms/work_form.rb

@@ -3,6 +3,10 @@ module Sufia::Forms
     delegate :depositor, :on_behalf_of, :permissions, to: :model
     include HydraEditor::Form::Permissions
 
+    # TODO: remove this when https://github.com/projecthydra/hydra-editor/pull/115
+    # is merged and hydra-editor 3.0.0 is released
+    delegate :model_name, to: :model
+
     attr_reader :agreement_accepted
 
     self.terms += [:collection_ids]

data/app/helpers/sufia/blacklight_override.rb

@@ -1,25 +1,5 @@
 module Sufia
   module BlacklightOverride
-    # TODO: we can remove this override when we can depend on https://github.com/projecthydra-labs/curation_concerns/pull/711
-    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: remove_constraint_url(localized_params))
-    end
-
-    # TODO: we can remove this override when we can depend on https://github.com/projecthydra-labs/curation_concerns/pull/711
-    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
-
     # This overrides curation_concerns so we aren't removing any fields.
     # @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

data/app/helpers/sufia/collections_helper.rb

@@ -0,0 +1,12 @@
+module Sufia
+  module CollectionsHelper
+    def render_collection_links(solr_doc)
+      collection_list = Sufia::CollectionMemberService.run(solr_doc)
+      return if collection_list.empty?
+      links = collection_list.map do |collection|
+        link_to collection.title_or_label, collection_path(collection.id)
+      end
+      content_tag :span, safe_join([t('sufia.collection.is_part_of'), ': '] + links)
+    end
+  end
+end

data/app/helpers/sufia/sufia_helper_behavior.rb

@@ -1,6 +1,7 @@
 module Sufia
   module SufiaHelperBehavior
     include Sufia::CitationsBehavior
+    include ERB::Util # provides html_escape
 
     def application_name
       t('sufia.product_name', default: super)
@@ -28,39 +29,34 @@ module Sufia
     end
 
     # Only Chrome supports this
+    # @return [Boolean]
+    # @todo Replace uses with more granular client-side detection (as jQuery-fileuploader already does)
     def browser_supports_directory_upload?
       user_agent.include? 'Chrome'
     end
 
-    # @param [Hash] options a list of options that blacklight passes from helper_method
-    #                       invocation.
-    def human_readable_date(options)
-      Date.parse(options[:value]).to_formatted_s(:standard)
-    end
-
     def error_messages_for(object)
-      if object.try(:errors) && object.errors.full_messages.any?
-        content_tag(:div, class: 'alert alert-block alert-error validation-errors') do
-          content_tag(:h4, I18n.t('sufia.errors.header', model: object.class.model_name.human.downcase), class: 'alert-heading') +
-            content_tag(:ul) do
-              object.errors.full_messages.map do |message|
-                content_tag(:li, message)
-              end.join('').html_safe
-            end
-        end
-      else
-        '' # return empty string
+      return '' unless object.try(:errors) && object.errors.full_messages.any?
+      content_tag(:div, class: 'alert alert-block alert-error validation-errors') do
+        content_tag(:h4, I18n.t('sufia.errors.header', model: object.class.model_name.human.downcase), class: 'alert-heading') +
+          content_tag(:ul) do
+            object.errors.full_messages.map do |message|
+              content_tag(:li, message)
+            end.join('').html_safe
+          end
       end
     end
 
+    # @param [ProxyDepositRequest] req
     def show_transfer_request_title(req)
       if req.deleted_work? || req.canceled?
         req.to_s
       else
-        link_to(req.to_s, curation_concerns_generic_work_path(req.work_id))
+        link_to(req.to_s, req.work)
       end
     end
 
+    # @return [Boolean]
     def has_collection_search_parameters?
       !params[:cq].blank?
     end
@@ -69,21 +65,31 @@ module Sufia
       ActiveFedora::Base.where(DepositSearchBuilder.depositor_field => user.user_key).count
     end
 
-    def link_to_facet(field, field_string)
-      path = search_action_path(search_state.add_facet_params_and_redirect(field_string, field))
-      link_to(field, path)
+    # @param item [Object]
+    # @param field [String]
+    # @return [ActiveSupport::SafeBuffer] the html_safe link
+    def link_to_facet(item, field)
+      path = search_action_path(search_state.add_facet_params_and_redirect(field, item))
+      link_to(item, path)
     end
 
-    # @param values [Array] The values to display
-    # @param solr_field [String] The name of the solr field to link to without its suffix (:facetable)
-    # @param empty_message [String] ('No value entered') The message to display if no values are passed in.
-    # @param separator [String] (', ') The value to join with.
-    def link_to_facet_list(values, solr_field, empty_message = "No value entered", separator = ", ")
+    # @param values [Array{String}] strings to display
+    # @param solr_field [String] name of the solr field to link to, without its suffix (:facetable)
+    # @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 = ", ")
       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)
     end
 
+    # @param name [String] field name
+    # @param value [String] field value
+    # @param label [String] defaults to value
+    # @param facet_hash [Hash] first argument to Blacklight::SearchState.new
+    # @return [ActiveSupport::SafeBuffer] the html_safe link
+    # @see Blacklight::SearchState#initialize
     def link_to_field(name, value, label = nil, facet_hash = {})
       label ||= value
       params = { search_field: 'advanced', name => "\"#{value}\"" }
@@ -91,30 +97,57 @@ module Sufia
       link_to(label, main_app.search_catalog_path(state))
     end
 
-    def index_field_link(options = {})
-      field_name = options[:config][:field_name]
-      values = options[:value]
-      safe_join(values.map { |item| link_to_index_field(item, field_name) }, ", ")
-    end
+    ## GROUP: helper_methods
 
-    def link_to_index_field(name, value)
-      params = { search_field: 'advanced', name => "\"#{value}\"" }
-      state = search_state.params_for_search(params)
-      link_to(name, main_app.search_catalog_path(state))
+    # A Blacklight helper_method
+    # @param [Hash] options from blacklight invocation of helper_method
+    # @see #index_field_link params
+    # @return [Date]
+    def human_readable_date(options)
+      Date.parse(options[:value]).to_formatted_s(:standard)
     end
 
-    # @param [String,Hash] text either the string to escape or a hash containing the
-    #                           string to escape under the :value key.
-    def iconify_auto_link(text, showLink = true)
-      text = presenter(text[:document]).render_values(text[:value], text[:config]) if text.is_a? Hash
+    # A Blacklight helper_method
+    # @param options [Hash{Symbol=>Object}] Blacklight sends :document, :field, :config, :value and whatever else was in options
+    # @option options [Array{String}] :value
+    # @option options [Hash] :config including {:field_name => "my_name"}
+    # @option options [Hash] :document
+    # @option options [Array{String}] :value the strings you might otherwise have passed to this method singly
+    # @return [ActiveSupport::SafeBuffer] the html_safe link
+    def index_field_link(options)
+      raise ArgumentError unless options[:config] && options[:config][:field_name]
+      name = options[:config][:field_name]
+      values = options[:value]
+      safe_join(values.map { |item| link_to_field(name, item, item) }, ", ".html_safe)
+    end
+
+    # Uses Rails auto_link to add links to fields
+    #
+    # @param field [String,Hash] string to format and escape, or a hash as per helper_method
+    # @option field [SolrDocument] :document
+    # @option field [String] :field name of the solr field
+    # @option field [Blacklight::Configuration::IndexField, Blacklight::Configuration::ShowField] :config
+    # @option field [Array] :value array of values for the field
+    # @param show_link [Boolean]
+    # @return [ActiveSupport::SafeBuffer]
+    # @todo stop being a helper_method, start being part of the Blacklight render stack?
+    def iconify_auto_link(field, show_link = true)
+      if field.is_a? Hash
+        options = field[:config].separator_options || {}
+        text = field[:value].to_sentence(options)
+      else
+        text = field
+      end
       # this block is only executed when a link is inserted;
       # if we pass text containing no links, it just returns text.
       auto_link(html_escape(text)) do |value|
-        "<span class='glyphicon glyphicon-new-window'></span>#{('&nbsp;' + value) if showLink}"
+        "<span class='glyphicon glyphicon-new-window'></span>#{('&nbsp;' + value) if show_link}"
       end
     end
 
-    # @param [String,User,Hash] args if a hash, the user_key must be under :value
+    # *Sometimes* a Blacklight helper_method
+    # @param [String,User,Hash{Symbol=>Array}] args if a hash, the user_key must be under :value
+    # @return [ActiveSupport::SafeBuffer] the html_safe link
     def link_to_profile(args)
       user_or_key = args.is_a?(Hash) ? args[:value].first : args
       user = case user_or_key
@@ -124,19 +157,14 @@ module Sufia
                ::User.find_by_user_key(user_or_key)
              end
       return user_or_key if user.nil?
-
-      text = if user.respond_to? :name
-               user.name
-             else
-               user_or_key
-             end
-
+      text = user.respond_to?(:name) ? user.name : user_or_key
       link_to text, Sufia::Engine.routes.url_helpers.profile_path(user)
     end
 
-    # @param [Hash] options hash from blacklight passes from helper_method
-    #                       invocation. Maps rights URIs to links with labels.
-    def rights_statement_links(options = {})
+    # A Blacklight helper_method
+    # @param [Hash] options from blacklight helper_method invocation. Maps rights URIs to links with labels.
+    # @return [ActiveSupport::SafeBuffer] rights statement links, html_safe
+    def rights_statement_links(options)
       options[:value].map { |right| link_to RightsService.label(right), right }.to_sentence.html_safe
     end
 
@@ -146,15 +174,13 @@ module Sufia
     end
 
     # Only display the current search parameters if the user is not in the dashboard.
-    # If they are in the dashboard, then the search defaults to the user's works and not
-    # all of Sufia.
+    # Otherwise, search defaults to the user's works and not all of Sufia.
     def current_search_parameters
       return if on_the_dashboard?
       params[:q]
     end
 
-    # Depending on which page we're landed on, we'll need to set the appropriate action url for
-    # our search form.
+    # @return [String] the appropriate action url for our search form (depending on our current page)
     def search_form_action
       if on_the_dashboard?
         search_action_for_dashboard
@@ -174,7 +200,6 @@ module Sufia
     def user_display_name_and_key(user_key)
       user = ::User.find_by_user_key(user_key)
       return user_key if user.nil?
-
       user.respond_to?(:name) ? "#{user.name} (#{user_key})" : user_key
     end
 
@@ -213,6 +238,9 @@ module Sufia
         end
       end
 
+      # @param [ActionController::Parameters] params first argument for Blacklight::SearchState.new
+      # @param [Hash] facet
+      # @note Ignores all but the first facet.  Probably a bug.
       def search_state_with_facets(params, facet = {})
         state = Blacklight::SearchState.new(params, CatalogController.blacklight_config)
         return state.params if facet.none?