sufia 4.0.0.beta2 → 4.0.0.beta3

data/app/controllers/dashboard/files_controller.rb

@@ -0,0 +1,13 @@
+module Dashboard
+  class FilesController < ListsController
+    self.solr_search_params_logic += [
+      :show_only_files_deposited_by_current_user,
+      :show_only_generic_files
+    ]
+
+    def index
+      super
+      @selected_tab = :files
+    end
+  end
+end

data/app/controllers/dashboard/highlights_controller.rb

@@ -0,0 +1,20 @@
+module Dashboard
+  class HighlightsController < ListsController
+    self.solr_search_params_logic += [
+      :show_only_highlighted_files
+    ]
+
+    def show_only_highlighted_files(solr_parameters, user_parameters)
+      pids = current_user.trophies.pluck(:generic_file_id).map{|id| Sufia::Noid.namespaceize(id)}
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] += [
+        ActiveFedora::SolrService.construct_query_for_pids(pids)
+      ]
+    end
+
+    def index
+      super
+      @selected_tab = :highlighted
+    end
+  end
+end

data/app/controllers/dashboard/lists_controller.rb

@@ -0,0 +1,13 @@
+module Dashboard
+  class ListsController < DashboardController
+    # specify the controller_name here to specify where we should look for
+    # the batch_edit menu options (_batch_edits_actions.html.erb)
+    def controller_name
+      :dashboard
+    end
+
+    def search_action_url(opts={})
+      sufia.url_for(opts)
+    end
+  end
+end

data/app/controllers/dashboard/shares_controller.rb

@@ -0,0 +1,19 @@
+module Dashboard
+  class SharesController < ListsController
+    self.solr_search_params_logic += [
+      :show_only_shared_files,
+    ]
+
+    def show_only_shared_files(solr_parameters, user_parameters)
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] += [
+        "-" + ActiveFedora::SolrService.construct_query_for_rel(depositor: current_user.user_key)
+      ]
+    end
+
+    def index
+      super
+      @selected_tab = :shared
+    end
+  end
+end

data/app/controllers/directory_controller.rb

@@ -2,8 +2,8 @@ class DirectoryController < ApplicationController
 
   # Stub method.  Override this in your application if you want directory lookups
   def user
-    #render :json => User.directory_attributes(params[:uid])
-    render :json => "" 
+    #render json: User.directory_attributes(params[:uid])
+    render json: ''
   end
 
   # Stub method.  Override this in your application if you want directory lookups
@@ -13,19 +13,19 @@ class DirectoryController < ApplicationController
     # else
     #   res = User.directory_attributes(params[:uid], params[:attribute])
     # end
-    # render :json => res
-    render :json => "" 
+    # render json: res
+    render json: ''
   end
 
   # Stub method.  Override this in your application if you want directory lookups
   def user_groups
-    # render :json => User.groups(params[:uid])
-    render :json => [] 
+    # render json: User.groups(params[:uid])
+    render json: []
   end
 
   # Stub method.  Override this in your application if you want directory lookups
   def group
-    #render :json => Group.exists?(params[:cn])
-    render :json => false 
+    #render json: Group.exists?(params[:cn])
+    render json: false
   end
 end

data/app/controllers/featured_work_lists_controller.rb

@@ -10,7 +10,7 @@ class FeaturedWorkListsController < ApplicationController
 
   protected
     def list_params
-      params.require(:featured_work_list).permit(:featured_works_attributes => [:id, :order])
+      params.require(:featured_work_list).permit(featured_works_attributes: [:id, :order])
     end
 end
 

data/app/controllers/homepage_controller.rb

@@ -0,0 +1,4 @@
+class HomepageController < ApplicationController
+  include Sufia::HomepageController
+
+end

data/app/controllers/single_use_links_controller.rb

@@ -9,32 +9,32 @@ class SingleUseLinksController < ApplicationController
   before_filter :authorize_user!
 
   def new_download
-    @su = SingleUseLink.create :itemId => params[:id], :path => sufia.download_path(:id => @asset)
+    @su = SingleUseLink.create itemId: params[:id], path: sufia.download_path(id: @asset)
     @link = sufia.download_single_use_link_path(@su.downloadKey)
 
     respond_to do |format|
       format.html
-      format.js  { render :js => @link }
+      format.js  { render js: @link }
     end
   end
 
   def new_show
-    @su = SingleUseLink.create :itemId => params[:id], :path => sufia.polymorphic_path(@asset)
+    @su = SingleUseLink.create itemId: params[:id], path: sufia.polymorphic_path(@asset)
     @link = sufia.show_single_use_link_path(@su.downloadKey)
 
     respond_to do |format|
       format.html
-      format.js  { render :js => @link }
+      format.js  { render js: @link }
     end
   end
 
   # Catch permission errors
   rescue_from Hydra::AccessDenied, CanCan::AccessDenied do |exception|
     if current_user and current_user.persisted?
-      redirect_to root_url, :alert => "You do not have sufficient privileges to create links to this document"
+      redirect_to root_url, alert: "You do not have sufficient privileges to create links to this document"
     else
       session["user_return_to"] = request.url
-      redirect_to new_user_session_url, :alert => exception.message
+      redirect_to new_user_session_url, alert: exception.message
     end
   end
 

data/app/controllers/single_use_links_viewer_controller.rb

@@ -5,7 +5,7 @@ class SingleUseLinksViewerController < ApplicationController
   include Sufia::DownloadsControllerBehavior
 
   skip_filter :normalize_identifier
-  skip_before_filter :load_datastream, :except => :download
+  skip_before_filter :load_datastream, except: :download
 
   class Ability
     include CanCan::Ability
@@ -25,13 +25,13 @@ class SingleUseLinksViewerController < ApplicationController
     end
   end
 
-  rescue_from Sufia::SingleUseError, :with => :render_single_use_error
-  rescue_from CanCan::AccessDenied, :with => :render_single_use_error
-  rescue_from ActiveRecord::RecordNotFound, :with => :render_single_use_error
+  rescue_from Sufia::SingleUseError, with: :render_single_use_error
+  rescue_from CanCan::AccessDenied, with: :render_single_use_error
+  rescue_from ActiveRecord::RecordNotFound, with: :render_single_use_error
 
   def download
     # send the data content
-    raise not_found_exception unless single_use_link.path == sufia.download_path(:id => @asset)
+    raise not_found_exception unless single_use_link.path == sufia.download_path(id: @asset)
     send_content
   end
 
@@ -42,7 +42,7 @@ class SingleUseLinksViewerController < ApplicationController
     @terms = @asset.terms_for_display
 
     # create a dowload link that is single use for the user since we do not just want to show metadata we want to access it too
-    @su = single_use_link.create_for_path sufia.download_path(:id => @asset)
+    @su = single_use_link.create_for_path sufia.download_path(id: @asset)
     @download_link = sufia.download_single_use_link_path(@su.downloadKey)
   end
 

data/app/controllers/static_controller.rb

@@ -1,16 +1,17 @@
 class StaticController < ApplicationController
-  rescue_from AbstractController::ActionNotFound, :with => :render_404
+  rescue_from AbstractController::ActionNotFound, with: :render_404
+  layout 'homepage'
 
   def zotero
     respond_to do |format|
       format.html
-      format.js { render :layout => false }
+      format.js { render layout: false }
     end
   end
   def mendeley
     respond_to do |format|
       format.html
-      format.js { render :layout => false }
+      format.js { render layout: false }
     end
   end
 end

data/app/helpers/batch_edits_helper.rb

@@ -1,10 +1,7 @@
 # View Helpers for Hydra Batch Edit functionality
-module BatchEditsHelper 
-  
-
+module BatchEditsHelper
   # Displays the delete button for batch editing
   def batch_delete
-    render :partial=>'/batch_edits/delete_selected'
+    render partial: '/batch_edits/delete_selected'
   end
-  
-end
+end

data/app/helpers/content_block_helper.rb

@@ -10,10 +10,15 @@ module ContentBlockHelper
         }
       } 
       concat form_for([sufia, content_block] ) { |f|
-        concat f.text_area :value, class: "tinymce", rows: 20, cols: 120
+        concat f.text_area :value, id: "text_area_#{content_block.name}", class: "tinymce", rows: 20, cols: 120
         concat f.submit 'Save', class: "btn btn-primary"
-      } 
+      }
 
+    end
+  end
+
+  def tiny_mce_stuff
+    capture do
       concat tinymce_assets
       concat tinymce
     end

data/app/helpers/generic_file_helper.rb

@@ -4,30 +4,6 @@ module GenericFileHelper
     gf.to_s
   end
 
-  def add_field (key)
-    more_or_less_button(key, 'adder', '+')
-  end
-
-  def subtract_field (key)
-   more_or_less_button(key, 'remover', '-')
-  end
-
-  def help_icon(key)
-    link_to '#', id: "generic_file_#{key.to_s}_help", rel: 'popover', 
-      'data-content' => metadata_help(key),
-      'data-original-title' => get_label(key) do
-        content_tag 'i', '', class: "glyphicon glyphicon-question-sign icon-large"
-    end
-  end
-
-  def metadata_help(key)
-    I18n.t("sufia.metadata_help.#{key}", default: key.to_s.humanize)
-  end
-
-  def get_label(key)
-    I18n.t("sufia.field_label.#{key}", default: key.to_s.humanize)
-  end
-
   def required?(key)
     [:title, :creator, :tag, :rights].include?(key)
   end
@@ -39,45 +15,63 @@ module GenericFileHelper
   def render_batch_edit_field_partial(key, locals)
     render_edit_field_partial_with_action('batch_edit', key, locals)
   end
-  
+
   def render_show_field_partial(key, locals)
     render_show_field_partial_with_action('generic_files', key, locals)
   end
 
- private 
+  def render_download_icon title = nil
+    if title.nil?
+      link_to download_image_tag, sufia.download_path(@generic_file.id), { target: "_blank", title: "Download the document", id: "file_download", data: { label: @generic_file.id } }
+    else
+      link_to (download_image_tag(title) + title), sufia.download_path(@generic_file), { target: "_blank", title: title, id: "file_download", data: { label: @generic_file.id } }
+    end
+  end
+
+  def render_download_link text = nil
+    link_to (text || "Download"), sufia.download_path(@generic_file.noid), { id: "file_download", target: "_new", data: { label: @generic_file.id } }
+  end
+
+  private
 
   def render_edit_field_partial_with_action(action, key, locals)
     ["#{action}/edit_fields/#{key}", "#{action}/edit_fields/default"].each do |str|
       # XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
       # for determining if a partial template exists..
       begin
-        return render :partial => str, :locals=>locals.merge({key: key})
+        return render partial: str, locals: locals.merge({ key: key })
       rescue ActionView::MissingTemplate
         nil
       end
     end
   end
-  
+
   def render_show_field_partial_with_action(action, key, locals)
     ["#{action}/show_fields/#{key}", "#{action}/show_fields/default"].each do |str|
       # XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
       # for determining if a partial template exists..
       begin
-        return render :partial => str, :locals=>locals.merge({key: key})
+        return render partial: str, locals: locals.merge({ key: key })
       rescue ActionView::MissingTemplate
         nil
       end
     end
   end
-  
 
- def more_or_less_button(key, html_class, symbol)
-   # TODO, there could be more than one element with this id on the page, but the fuctionality doesn't work without it.
-   content_tag('button', class: "#{html_class} btn", id: "additional_#{key}_submit", name: "additional_#{key}") do
-     (symbol + 
-     content_tag('span', class: 'sr-only') do
-       "add another #{key.to_s}"
-     end).html_safe
-   end
- end
+  def more_or_less_button(key, html_class, symbol)
+    # TODO, there could be more than one element with this id on the page, but the fuctionality doesn't work without it.
+    content_tag('button', class: "#{html_class} btn", id: "additional_#{key}_submit", name: "additional_#{key}") do
+      (symbol + content_tag('span', class: 'sr-only') do
+        "add another #{key.to_s}"
+      end).html_safe
+    end
+  end
+
+  def download_image_tag title = nil
+    if title.nil?
+      image_tag "default.png", { alt: "No preview available", class: "img-responsive" }
+    else
+      image_tag sufia.download_path(@generic_file, datastream_id: 'thumbnail'), { class: "img-responsive", alt: "#{title} of #{@generic_file.title.first}" }
+    end
+  end
 end

data/app/helpers/records_helper.rb

@@ -0,0 +1,4 @@
+module RecordsHelper
+  include RecordsHelperBehavior # from hydra-editor
+  include Sufia::RecordsHelperBehavior
+end

data/app/helpers/sufia/blacklight_override.rb

@@ -0,0 +1,11 @@
+module Sufia
+  module BlacklightOverride
+    def render_bookmarks_control?
+      false
+    end
+
+   def url_for_document doc, options = {}
+     [sufia, doc]
+   end
+  end
+end

data/app/helpers/sufia/records_helper_behavior.rb

@@ -0,0 +1,38 @@
+module Sufia
+  module RecordsHelperBehavior
+    def add_field(key)
+      more_or_less_button(key, 'adder', '+')
+    end
+
+    def subtract_field(key)
+     more_or_less_button(key, 'remover', '-')
+    end
+
+    def help_icon(key)
+      link_to '#', id: "generic_file_#{key.to_s}_help", rel: 'popover', 
+        'data-content' => metadata_help(key),
+        'data-original-title' => get_label(key) do
+          content_tag 'i', '', class: "glyphicon glyphicon-question-sign icon-large"
+      end
+    end
+
+    def metadata_help(key)
+      I18n.t("sufia.metadata_help.#{key}", default: key.to_s.humanize)
+    end
+
+    def get_label(key)
+      I18n.t("sufia.field_label.#{key}", default: key.to_s.humanize)
+    end
+  
+    private
+
+    def more_or_less_button(key, html_class, symbol)
+      # TODO, there could be more than one element with this id on the page, but the fuctionality doesn't work without it.
+      content_tag('button', class: "#{html_class} btn", id: "additional_#{key}_submit", name: "additional_#{key}") do
+        (symbol + content_tag('span', class: 'sr-only') do
+          "add another #{key.to_s}"
+        end).html_safe
+      end
+    end
+  end
+end

data/app/helpers/sufia/sufia_helper_behavior.rb

@@ -0,0 +1,109 @@
+module Sufia
+  module SufiaHelperBehavior
+
+    # You can configure blacklight to use this as the thumbnail
+    # example:
+    #   config.index.thumbnail_method = :sufia_thumbnail_tag
+    def sufia_thumbnail_tag(document, options)
+      path = if document.image? || document.pdf? || document.video?
+        sufia.download_path document.noid, datastream_id: 'thumbnail'
+      elsif document.audio?
+        "audio.png"
+      else
+        "default.png"
+      end
+      image_tag path, options
+    end
+
+    # Create a link back to the dashboard screen, keeping the user's facet, query and paging choices intact by using session.
+    def link_back_to_dashboard(opts = { label: 'Back to Search' })
+      query_params = session[:search] ? session[:search].dup : {}
+      query_params.delete :counter
+      query_params.delete :total
+      link_url = dashboard_index_path + "?" + query_params.to_query
+      link_to opts[:label], link_url
+    end
+
+    def link_to_dashboard_query(query)
+      p = params.dup
+      p.delete :page
+      p.delete :action
+      p[:q] = query
+      link_url = dashboard_index_path(p)
+      link_to(query, link_url)
+    end
+
+    def has_collection_search_parameters?
+      !params[:cq].blank?
+    end
+
+    def display_user_name(recent_document)
+      return "no display name" unless recent_document.depositor
+      ::User.find_by_user_key(recent_document.depositor).name rescue recent_document.depositor
+    end
+
+    def number_of_deposits(user)
+      ActiveFedora::Base.where(Solrizer.solr_name('depositor', :stored_searchable) => user.user_key).count
+    end
+
+    def link_to_facet(field, field_string)
+      link_to(field, add_facet_params(field_string, field).merge!(controller: "catalog", action: "index"))
+    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=", ")
+      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
+
+    def link_to_field(fieldname, fieldvalue, displayvalue = nil)
+      p = { search_field: 'advanced', fieldname => '"'+fieldvalue+'"' }
+      link_url = catalog_index_path(p)
+      display = displayvalue.blank? ? fieldvalue : displayvalue
+      link_to(display, link_url)
+    end
+
+    def iconify_auto_link(text, showLink = true)
+      auto_link(text) do |value|
+        "<i class='icon-external-link'></i>&nbsp;#{value if showLink}<br />"
+      end
+    end
+
+    def link_to_profile(login)
+      user = ::User.find_by_user_key(login)
+      return login if user.nil?
+
+      text = if user.respond_to? :name
+        user.name
+      else
+        login
+      end
+
+      link_to text, Sufia::Engine.routes.url_helpers.profile_path(user)
+    end
+
+    def linkify_chat_id(chat_id)
+      if chat_id.end_with? '@chat.psu.edu'
+        "<a href=\"xmpp:#{chat_id}\">#{chat_id}</a>"
+      else
+        chat_id
+      end
+    end
+
+    # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
+    # We should be able to do away with this method in Blacklight 5
+    # @example
+    #   link_back_to_catalog(label: 'Back to Search')
+    def link_back_to_catalog(opts = { label: nil })
+      scope = opts.delete(:route_set) || self
+      query_params = current_search_session.try(:query_params) || {}
+      link_url = scope.url_for(query_params)
+      opts[:label] ||= t('blacklight.back_to_search')
+      link_to opts[:label], link_url
+    end
+  end
+end