worthwhile 0.0.1.alpha → 0.0.1

data/app/assets/stylesheets/worthwhile/modules/pagination.css.scss

@@ -0,0 +1,4 @@
+.pager .active a {
+  background-color: $pagination-border;
+  color: $pagination-bg;
+}

data/app/assets/stylesheets/worthwhile/modules/search_results.css.scss

@@ -0,0 +1,55 @@
+.search-results-list {
+}
+
+#documents .document {
+  border-top: 1px solid $gray-lighter;
+  margin-top: 1em;
+  padding-top:.5em;
+
+  &:before {
+    //Overwrite blacklight
+    content: none;
+  }
+  &:first-child {
+    border-top:none;
+    margin-top:0;
+    padding-top:0;
+  }
+  .search-result-actions {
+    @include make-xs-column(8);
+    @include make-xs-column-offset(4);
+    @include make-sm-column(2);
+    @include make-sm-column-offset(0);
+  }
+
+  .document-thumbnail {
+    @include make-xs-column(4);
+    @include make-sm-column(2);
+  }
+
+  .document-metadata {
+    @include make-xs-column(8);
+  }
+
+  .canonical-image {
+    width: 100%; // no bigger than the parent
+  }
+
+  .resource-type {
+    margin-bottom:0;
+    position:absolute;
+    right:0;
+    text-align:center;
+    top:0;
+    width:80%;
+  }
+
+  .modal {
+    text-align:left;
+  }
+}
+
+
+.search-result-details {
+}
+

data/app/assets/stylesheets/worthwhile/modules/site_actions.css.scss

@@ -0,0 +1,53 @@
+#site-actions {
+  .dropdown-menu {
+    text-align:left;
+  }
+
+  // Overriding default boostrap behavior
+  .btn-group + .btn-group {
+    margin-left:0;
+  }
+}
+
+.dropdown-menu {
+  .item-with-options,
+  .item-option {
+    display:block;
+    padding:3px 20px;
+    line-height:20px;
+    color:#333;
+  }
+
+  .item-options{
+    margin:0;
+    padding:0;
+    list-style-type:none;
+  }
+
+  .item-option{
+    padding-left:30px;
+  }
+
+  /* TODO: convert this from compiled bootstrap styles to SASS mixins if available. */
+  .item-option:hover,
+  .item-option:focus {
+    text-decoration: none;
+    color: white;
+    background-color: #0056b7;
+    background-image: -moz-linear-gradient(top, #005bc1, #004fa8);
+    background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#005bc1), to(#004fa8));
+    background-image: -webkit-linear-gradient(top, #005bc1, #004fa8);
+    background-image: -o-linear-gradient(top, #005bc1, #004fa8);
+    background-image: linear-gradient(to bottom, #005bc1, #004fa8);
+    background-repeat: repeat-x;
+    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FF005BC1', endColorstr='#FF004FA8', GradientType=0);
+  }
+
+  .menu-heading {
+    font-weight:bold;
+  }
+
+  .link-to-full-list {
+    font-style:italic;
+  }
+}

data/app/assets/stylesheets/worthwhile/modules/site_search.css.scss

@@ -0,0 +1,46 @@
+.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/controllers/catalog_controller.rb

@@ -0,0 +1,3 @@
+class CatalogController < ApplicationController
+  include Worthwhile::CatalogController
+end

data/app/controllers/collections_controller.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+class CollectionsController < ApplicationController
+  include Hydra::CollectionsControllerBehavior
+  include Blacklight::Catalog::SearchContext
+  include Worthwhile::ThemedLayoutController
+  include Hydra::AccessControlsEnforcement
+  include Worthwhile::WithoutNamespace
+  before_filter :filter_docs_with_read_access!, except: [:show, :new]
+  CollectionsController.solr_search_params_logic += [:add_access_controls_to_solr_params]
+
+  with_themed_layout '1_column'
+
+  helper Worthwhile::CatalogHelper
+
+  protected
+
+  # Override Hydra::PolicyAwareAccessControlsEnforcement
+  def gated_discovery_filters
+    return [] if current_user && (current_user.groups.include? 'admin')
+    super
+  end
+
+  def query_collection_members
+    flash[:notice]=nil if flash[:notice] == "Select something first"
+    query = params[:cq]
+
+    #merge in the user parameters and the attach the collection query
+    solr_params =  (params.symbolize_keys).merge(q: query)
+
+    # run the solr query to find the collections
+    (@response, @member_docs) = get_search_results(solr_params)
+  end
+
+  def after_destroy(id)
+    respond_to do |format|
+      format.html { redirect_to main_app.root_path, notice: 'Collection was successfully deleted.' }
+      format.json { render json: {id: id}, status: :destroyed, location: @collection }
+    end
+  end
+  
+  def initialize_fields_for_edit
+    @collection.initialize_fields
+  end
+
+  # If they've selected "owner=mine" then restrict to files I have edit access to
+  def discovery_permissions
+    if params[:owner]=="mine"
+      ["edit"]
+    else
+      super
+    end
+  end
+
+  # Include 'catalog' and 'curation_concern/base' in search path for views
+  def _prefixes
+    @_prefixes ||= super + ['catalog', 'curation_concern/base']
+  end
+
+end

data/app/controllers/concerns/worthwhile/application_controller_behavior.rb

@@ -0,0 +1,23 @@
+module Worthwhile
+  # Inherit from the host app's ApplicationController
+  # This will configure e.g. the layout used by the host
+  module ApplicationControllerBehavior
+    extend ActiveSupport::Concern
+    
+    included do
+      helper Worthwhile::MainAppHelpers
+      
+      rescue_from CanCan::AccessDenied do |exception|
+        if [:show, :edit, :update, :destroy].include? exception.action
+          render 'unauthorized', status: :unauthorized
+        else
+          redirect_to main_app.root_url, alert: exception.message
+        end
+      end
+
+      rescue_from ActiveFedora::ObjectNotFoundError do |exception|
+        render file: "#{Rails.root}/public/404", format: :html, status: :not_found, layout: false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,347 @@
+module Worthwhile::CatalogController
+  extend ActiveSupport::Concern
+  include Blacklight::Catalog
+  # Extend Blacklight::Catalog with Hydra behaviors (primarily editing).
+  include Hydra::Controller::ControllerBehavior
+  include BreadcrumbsOnRails::ActionController
+  include Worthwhile::ThemedLayoutController
+
+  included do
+    with_themed_layout 'catalog'
+    helper Worthwhile::CatalogHelper
+    # These before_filters apply the hydra access controls
+    before_filter :enforce_show_permissions, only: :show
+    # This applies appropriate access controls to all solr queries
+    CatalogController.solr_search_params_logic += [:add_access_controls_to_solr_params]
+    CatalogController.solr_search_params_logic += [:filter_models]
+
+    configure_blacklight do |config|
+      ## 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("desc_metadata__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("desc_metadata__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('desc_metadata__creator', :facetable), limit: 5
+      config.add_facet_field solr_name("desc_metadata__tag", :facetable), limit: 5
+      config.add_facet_field solr_name("desc_metadata__subject", :facetable), limit: 5
+      config.add_facet_field solr_name("desc_metadata__language", :facetable), limit: 5
+      config.add_facet_field solr_name("desc_metadata__based_near", :facetable), limit: 5
+      config.add_facet_field solr_name("desc_metadata__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("desc_metadata__description", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__tag", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__subject", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__creator", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__contributor", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__publisher", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__based_near", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__language", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__date_uploaded", :stored_sortable)
+      config.add_index_field solr_name("desc_metadata__date_modified", :stored_sortable)
+      config.add_index_field solr_name("desc_metadata__date_created", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__rights", :stored_searchable)
+      config.add_index_field solr_name("human_readable_type", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__format", :stored_searchable)
+      config.add_index_field solr_name("desc_metadata__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("desc_metadata__title", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__description", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__tag", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__subject", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__creator", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__contributor", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__publisher", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__based_near", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__language", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__date_uploaded", :stored_sortable)
+      config.add_show_field solr_name("desc_metadata__date_modified", :stored_sortable)
+      config.add_show_field solr_name("desc_metadata__date_created", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__rights", :stored_searchable)
+      config.add_show_field solr_name("human_readable_type", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__format", :stored_searchable)
+      config.add_show_field solr_name("desc_metadata__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("desc_metadata__title", :stored_searchable, type: :string)
+        label_name = solr_name("desc_metadata__title", :stored_searchable, type: :string)
+        contributor_name = solr_name("desc_metadata__contributor", :stored_searchable, type: :string)
+        field.solr_parameters = {
+          :qf => "#{title_name} noid_tsi #{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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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("desc_metadata__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
+    end
+
+    def uploaded_field
+      #  system_create_dtsi
+      solr_name('desc_metadata__date_uploaded', :stored_sortable, type: :date)
+    end
+
+    def modified_field
+      solr_name('desc_metadata__date_modified', :stored_sortable , type: :date)
+    end
+
+    def search_config
+       {'qf' => ['desc_metadata__title_tesim','desc_metadata__name_tesim'], 'qt' => 'search', 'rows' => 10}
+    end
+  end
+
+
+  protected
+
+    # Override Hydra::PolicyAwareAccessControlsEnforcement
+    def gated_discovery_filters
+      return [] if current_user && (current_user.groups.include? 'admin')
+      super
+    end
+
+    # 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) }}
+    end
+
+    def serialize_work_from_solr(solr_doc)
+      title = solr_doc["desc_metadata__title_tesim"].first
+      title << " (#{solr_doc["human_readable_type_tesim"].first})" if solr_doc["human_readable_type_tesim"].present?
+      {
+        pid: solr_doc["id"],
+        title: title
+      }
+    end
+
+    # show only files with edit permissions in lib/hydra/access_controls_enforcement.rb apply_gated_discovery
+    def discovery_permissions
+      return ["edit"] if params[:works] == 'mine'
+      super
+    end
+
+    # This is included as part of blacklight search solr params logic
+    def filter_models(solr_parameters, user_parameters)
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << '(' + (work_clauses + collection_clauses).join(' OR ') + ')'
+    end
+
+    def work_clauses
+      return [] if params.has_key?(:f) && Array(params[:f][:generic_type_sim]).include?('Collection')
+      Worthwhile.configuration.registered_curation_concern_types.map(&:constantize).map do |klass|
+        ActiveFedora::SolrService.construct_query_for_rel(has_model: klass.to_class_uri)
+      end
+    end
+
+    def collection_clauses 
+      return [] if params.has_key?(:f) && Array(params[:f][:generic_type_sim]).include?('Work')
+      [ActiveFedora::SolrService.construct_query_for_rel(has_model: Collection.to_class_uri)]
+    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