worthwhile 0.0.1.alpha → 0.0.1

data/app/helpers/worthwhile/attribute_helper.rb

@@ -0,0 +1,67 @@
+module Worthwhile
+  module AttributeHelper
+
+    # If options[:catalog_search_link] is false,
+    # it will return the attribute value as text.
+    # If options[:catalog_search_link] is true,
+    # it will return a link to a catalog search for that text.
+    #
+    # If the method_name of the attribute is different than
+    # how the attribute name should appear on the search URL,
+    # you can explicitly set the URL's search field name using
+    # options[:search_field].
+    def curation_concern_attribute_to_html(curation_concern, method_name, label = nil, options = {})
+      if curation_concern.respond_to?(method_name)
+        markup = ""
+        label ||= derived_label_for(curation_concern, method_name)
+        subject = curation_concern.send(method_name)
+        return markup if !subject.present? && !options[:include_empty]
+        markup << %(<tr><th>#{label}</th>\n<td><ul class='tabular'>)
+        [subject].flatten.compact.each do |value|
+          if method_name == :rights
+            # Special treatment for license/rights.  A URL from the Sufia gem's config/sufia.rb is stored in the descMetadata of the
+            # curation_concern.  If that URL is valid in form, then it is used as a link.  If it is not valid, it is used as plain text.
+            parsedUri = URI.parse(value) rescue nil
+            if parsedUri.nil?
+              markup << %(<li class="attribute #{method_name}">#{h(value)}</li>\n)
+            else
+              markup << %(<li class="attribute #{method_name}"><a href=#{h(value)} target="_blank"> #{h(Sufia.config.cc_licenses_reverse[value])}</a></li>\n)
+            end
+          else
+            search_field = options[:search_field] || method_name
+            li_value = link_to_if(options[:catalog_search_link], h(value), catalog_index_path(search_field: search_field, q: h(value)))
+            markup << %(<li class="attribute #{method_name}"> #{li_value} </li>\n)
+          end
+        end
+        markup << %(</ul></td></tr>)
+        markup.html_safe
+      end
+    end
+
+    def permission_badge_for(curation_concern, solr_document = nil)
+      solr_document ||= curation_concern.to_solr
+      dom_label_class, link_title = extract_dom_label_class_and_link_title(solr_document)
+      %(<span class="label #{dom_label_class}" title="#{link_title}">#{link_title}</span>).html_safe
+    end
+
+    private
+      def extract_dom_label_class_and_link_title(document)
+        hash = document.stringify_keys
+        dom_label_class, link_title = "label-danger", "Private"
+        if hash[Hydra.config.permissions.read.group].present?
+          if hash[Hydra.config.permissions.read.group].include?('public')
+            if hash[Hydra.config.permissions.embargo.release_date].present?
+              dom_label_class, link_title = 'label-warning', 'Open Access with Embargo'
+            else
+              dom_label_class, link_title = 'label-success', 'Open Access'
+            end
+          elsif hash[Hydra.config.permissions.read.group].include?('registered')
+            dom_label_class, link_title = "label-info", t('sufia.institution_name')
+          end
+        end
+        return dom_label_class, link_title
+      end
+
+
+  end
+end

data/app/helpers/worthwhile/catalog_helper.rb

@@ -0,0 +1,38 @@
+module Worthwhile::CatalogHelper
+  def type_tab(label, key=label)
+    if params[:f] && params[:f][type_field] == [key]
+      content_tag(:li, link_to(label, "#"), class: "active")
+    else
+      facet_solr_field = facet_configuration_for_field(type_field)
+      path = search_action_path(add_facet_params_and_redirect(type_field, key))
+      # local_params = params.dup
+      # local_facet_params = local_params[:f] || {}.with_indifferent_access
+      # local_params[:f] = local_facet_params.select{|k,_| k != type_field }
+      # puts "local #{local_params}"
+      # path = add_facet_params(type_field, key, local_params)
+      content_tag(:li, link_to(label, path))
+    end
+  end
+
+  def all_type_tab(label = t('worthwhile.catalog.index.type_tabs.all'))
+    if params[:f] && params[:f][type_field]
+      facet_solr_field = facet_configuration_for_field(type_field)
+      new_params = remove_facet_params(type_field, params[:f][type_field].first)
+
+      # Delete any request params from facet-specific action, needed
+      # to redir to index action properly.
+      new_params.except! *Blacklight::Solr::FacetPaginator.request_keys.values
+      path = search_action_path(new_params)
+      content_tag(:li, link_to(label, path))
+    else
+      content_tag(:li, link_to(label, '#'), class: "active")
+    end
+  end
+
+  private
+
+    def type_field
+      Solrizer.solr_name("generic_type", :facetable)
+    end
+
+end

data/app/helpers/worthwhile/collections_helper.rb

@@ -0,0 +1,19 @@
+module Worthwhile::CollectionsHelper
+  def has_collection_search_parameters?
+    params[:cq].present?
+  end
+
+  def collection_modal_id(collectible)
+    "#{collectible.to_param.gsub(/:/, '-')}-modal"
+  end
+
+  def link_to_select_collection(collectible, opts={}) 
+    html_class = opts[:class]
+    link_to add_member_form_collections_path(collectible_id: collectible.id),
+      data: { toggle: "modal", target: '#' + collection_modal_id(collectible) },
+      class: "add-to-collection #{html_class}", title: "Add #{collectible.human_readable_type} to Collection" do
+      raw('<span class="glyphicon glyphicon-folder-open"></span> Add to a Collection')
+    end
+  end
+
+end

data/app/helpers/worthwhile/embargo_helper.rb

@@ -0,0 +1,17 @@
+module Worthwhile
+  module EmbargoHelper
+
+    def assets_with_expired_embargoes
+      @assets_with_expired_embargoes ||= EmbargoService.assets_with_expired_embargoes
+    end
+
+    def assets_under_embargo
+      @assets_under_embargo ||= EmbargoService.assets_under_embargo
+    end
+
+    def assets_with_deactivated_embargoes
+      @assets_with_deactivated_embargoes ||= EmbargoService.assets_with_deactivated_embargoes
+    end
+
+  end
+end

data/app/helpers/worthwhile/generic_file_helper.rb

@@ -0,0 +1,19 @@
+module Worthwhile::GenericFileHelper
+
+  def generic_file_title(gf)
+    can?(:read, gf) ? gf.to_s : "File"
+  end
+
+  def generic_file_link_name(gf)
+    can?(:read, gf) ? gf.filename : "File"
+  end
+
+  def parent_path(parent)
+    if parent.is_a?(Collection)
+      collection_path(parent)
+    else
+      polymorphic_path([:curation_concern, parent])
+    end
+  end
+    
+end

data/app/helpers/worthwhile/lease_helper.rb

@@ -0,0 +1,18 @@
+module Worthwhile
+  module LeaseHelper
+
+    def assets_with_expired_leases
+      @assets_with_expired_leases ||= LeaseService.assets_with_expired_leases
+    end
+
+    def assets_under_lease
+      @assets_under_lease ||= LeaseService.assets_under_lease
+    end
+
+    def assets_with_deactivated_leases
+      @assets_with_deactivated_leases ||= LeaseService.assets_with_deactivated_leases
+    end
+
+  end
+end
+

data/app/helpers/worthwhile/main_app_helpers.rb

@@ -0,0 +1,14 @@
+module Worthwhile::MainAppHelpers
+  include Worthwhile::TitleHelper
+  include Worthwhile::AttributeHelper
+  include Worthwhile::GenericFileHelper
+  include Worthwhile::SearchPathsHelper
+  include Worthwhile::RenderConstraintsHelper
+  include Worthwhile::AbilityHelper
+  include Worthwhile::CollectionsHelper
+  include Curate::CollectionsHelper
+  include Worthwhile::ThumbnailHelper
+  include Worthwhile::UrlHelper
+  include Worthwhile::EmbargoHelper
+  include Worthwhile::LeaseHelper
+end

data/app/helpers/worthwhile/render_constraints_helper.rb

@@ -0,0 +1,42 @@
+module Worthwhile
+  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 worthwhile 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])
+    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])
+    end
+  end
+end

data/app/helpers/worthwhile/search_paths_helper.rb

@@ -0,0 +1,13 @@
+module Worthwhile::SearchPathsHelper
+
+  def search_path_for_my_works(opts={})
+    params_for_my_works = {:'f[generic_type_sim][]'=>'Work', works: 'mine'}
+    main_app.catalog_index_path(params_for_my_works.merge(opts))
+  end
+
+  def search_path_for_my_collections(opts={})
+    params_for_my_collections = {:'f[generic_type_sim][]'=>'Collection', works: 'mine'}
+    main_app.catalog_index_path(params_for_my_collections.merge(opts))
+  end
+
+end

data/app/helpers/worthwhile/thumbnail_helper.rb

@@ -0,0 +1,11 @@
+module Worthwhile
+  module ThumbnailHelper
+    def thumbnail_tag(document, image_options)
+      if document.representative.present?
+        image_tag download_path(document.representative, datastream_id: 'thumbnail'), alt: 'Thumbnail', class: "canonical-image"
+      else
+        content_tag :span, '', class: 'canonical-image'
+      end
+    end
+  end
+end

data/app/helpers/worthwhile/title_helper.rb

@@ -0,0 +1,23 @@
+module Worthwhile::TitleHelper
+
+  def construct_page_title(*elements)
+    (elements.flatten.compact + [application_name]).join(" // ")
+  end
+
+  def curation_concern_page_title(curation_concern)
+    if curation_concern.persisted?
+      construct_page_title(curation_concern.title, "#{curation_concern.human_readable_type} [#{curation_concern.to_param}]")
+    else
+      construct_page_title("New #{curation_concern.human_readable_type}")
+    end
+  end
+
+  def default_page_title
+    text = controller_name.singularize.titleize
+    if action_name
+      text = "#{action_name.titleize} " + text
+    end
+    construct_page_title(text)
+  end
+
+end

data/app/helpers/worthwhile/url_helper.rb

@@ -0,0 +1,16 @@
+module Worthwhile
+  module UrlHelper
+
+    # override Blacklight so we can use our 'curation_concern' namespace
+    # We may also pass in a ActiveFedora document instead of a SolrDocument
+    def url_for_document doc, options = {}
+      if doc.kind_of? Worthwhile::GenericFile
+        curation_concern_generic_file_path(doc)
+      elsif doc.collection?
+        doc
+      else
+        polymorphic_path([:curation_concern, doc])
+      end
+    end 
+  end
+end

data/app/inputs/multi_value_input.rb

@@ -0,0 +1,72 @@
+class MultiValueInput < SimpleForm::Inputs::CollectionInput
+  def input(wrapper_options)
+    @rendered_first_element = false
+    input_html_classes.unshift("string")
+    #input_html_options[:type] ||= 'text'
+    input_html_options[:name] ||= "#{object_name}[#{attribute_name}][]"
+    markup = <<-HTML
+
+
+        <ul class="listing">
+    HTML
+
+    collection.each_with_index do |value, i|
+      unless value.to_s.strip.blank?
+        markup << <<-HTML
+          <li class="field-wrapper">
+            #{build_text_field(value)}
+          </li>
+        HTML
+      end
+    end
+
+    markup << <<-HTML
+          <li class="field-wrapper">
+            #{build_text_field('')}
+          </li>
+        </ul>
+
+    HTML
+  end
+
+  private
+
+
+  def build_text_field(value)
+    options = input_html_options.dup
+
+    options[:value] = value
+    if @rendered_first_element
+      options[:id] = nil
+      options[:required] = nil
+    else
+      options[:id] ||= input_dom_id
+    end
+    options[:class] ||= []
+    options[:class] += ["#{input_dom_id} form-control multi-text-field"]
+    options[:'aria-labelledby'] = label_id
+    @rendered_first_element = true
+    if options.delete(:type) == 'textarea'.freeze
+      @builder.text_area(attribute_name, options)
+    else
+      @builder.text_field(attribute_name, options)
+    end
+  end
+
+
+  def label_id
+    input_dom_id + '_label'
+  end
+
+  def input_dom_id
+    input_html_options[:id] || "#{object_name}_#{attribute_name}"
+  end
+
+  def collection
+    @collection ||= begin
+      object.send(attribute_name)
+    end
+  end
+
+  def multiple?; true; end
+end

data/app/models/collection.rb

@@ -0,0 +1,15 @@
+class Collection < ActiveFedora::Base
+  include Hydra::Collection
+  include CurationConcern::CollectionModel
+  include Hydra::Collections::Collectible
+  include CurationConcern::WithBasicMetadata
+  include CurationConcern::WithGenericFiles
+
+  # override the default Hydra properties so we don't get a prefix deprecation warning.
+  has_metadata "properties", type: Worthwhile::PropertiesDatastream
+
+  # override Hydra::Collection to add :solr_page_size
+  has_and_belongs_to_many :members, property: :has_collection_member, class_name: "ActiveFedora::Base" , after_remove: :update_member,
+    solr_page_size: 70
+
+end

data/app/models/concerns/curation_concern/collection_model.rb

@@ -0,0 +1,62 @@
+module CurationConcern
+  module CollectionModel
+    extend ActiveSupport::Concern
+
+    include Hydra::AccessControls::Permissions
+    include Hydra::AccessControls::WithAccessRight
+    include Sufia::Noid
+    include CurationConcern::HumanReadableType
+    include Hydra::Collection
+    include Hydra::Collections::Collectible
+    include CurationConcern::HasRepresentative
+
+    def add_member(collectible)
+      if can_add_to_members?(collectible)
+        collectible.collections << self
+        collectible.save
+        self.members << collectible
+        self.save
+      end
+    end
+
+    def to_s
+      self.title.present? ? title : "No Title"
+    end
+
+    def to_solr(solr_doc={}, opts={})
+      super.tap do |solr_doc|
+        Solrizer.set_field(solr_doc, 'generic_type', human_readable_type, :facetable)
+        solr_doc[Solrizer.solr_name('noid', Sufia::GenericFile.noid_indexer)] = noid
+        index_collection_pids(solr_doc)
+      end
+    end
+
+    def can_be_member_of_collection?(collection)
+      collection == self ? false : true
+    end
+
+
+    # ------------------------------------------------
+    # overriding method from active-fedora:
+    # lib/active_fedora/semantic_node.rb
+    #
+    # The purpose of this override is to ensure that
+    # a collection cannot contain itself.
+    #
+    # TODO:  After active-fedora 7.0 is released, this
+    # logic can be moved into a before_add callback.
+    # ------------------------------------------------
+    def add_relationship(predicate, target, literal=false)
+      return if self == target
+      super
+    end
+
+    private
+    def can_add_to_members?(collectible)
+      collectible.can_be_member_of_collection?(self)
+    rescue NoMethodError
+      false
+    end
+
+  end
+end