commonwealth-vlr-engine 0.0.1

data/app/helpers/commonwealth_vlr_engine/collections_helper_behavior.rb

@@ -0,0 +1,19 @@
+module CommonwealthVlrEngine
+  module CollectionsHelperBehavior
+
+    # link to view all items in a collection
+    def link_to_all_col_items(col_title, institution_name=nil, link_class)
+      facet_params = {blacklight_config.collection_field => [col_title]}
+      facet_params[blacklight_config.institution_field] = institution_name if institution_name
+      link_to(t('blacklight.collections.browse.all'),
+              catalog_index_path(:f => facet_params),
+              :class => link_class)
+    end
+
+    # whether the A-Z link menu should be displayed in collections#index
+    def should_render_col_az?
+      false
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/component_helper.rb

@@ -0,0 +1,22 @@
+module CommonwealthVlrEngine
+
+  module ComponentHelper
+    include Blacklight::ComponentHelperBehavior
+
+    # add extra tools to show view -- folders, social sharing, etc.
+    def render_show_doc_actions(document=@document, options={})
+      wrapping_class = options.delete(:documentFunctions) || options.delete(:wrapping_class) || 'documentFunctions'
+      content = []
+      #content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
+
+      # social media:
+      content << render(:partial => 'catalog/add_this')
+      if has_user_authentication_provider? and current_or_guest_user
+        content << render(:partial => 'catalog/folder_item_control', :locals => {:document => document})
+      end
+      content_tag('div', content.join("\n").html_safe, :class=> wrapping_class)
+    end
+
+  end
+
+end

data/app/helpers/commonwealth_vlr_engine/facets_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module CommonwealthVlrEngine
+  module FacetsHelper
+    include Blacklight::FacetsHelperBehavior
+
+    # LOCAL OVERRIDE
+    # don't display 'Collections' genre_basic_ssim facet value
+    # on collections#index or collections#facet views
+    def render_facet_item(facet_field, item)
+      return if controller.controller_name == 'collections' && controller.action_name == 'index' && item.value == 'Collections'
+      if facet_in_params?(facet_field, item.value )
+        render_selected_facet_value(facet_field, item)
+      else
+        render_facet_value(facet_field, item)
+      end
+    end
+
+  end
+
+end

data/app/helpers/commonwealth_vlr_engine/feedback_helper_behavior.rb

@@ -0,0 +1,14 @@
+module CommonwealthVlrEngine
+  module FeedbackHelperBehavior
+
+    # returns an array of values for the message type select dropdown
+    def feedback_type_options
+      options_for_type_dropdown = []
+      t('blacklight.feedback.form.topic.options').each_value do |option|
+        options_for_type_dropdown << option[:option]
+      end
+      options_for_type_dropdown
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/folders_helper_behavior.rb

@@ -0,0 +1,9 @@
+module CommonwealthVlrEngine
+  module FoldersHelperBehavior
+
+    def folder_belongs_to_user
+      current_or_guest_user.folders.include? @folder
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/image_viewer_helper_behavior.rb

@@ -0,0 +1,14 @@
+module CommonwealthVlrEngine
+  module ImageViewerHelperBehavior
+
+    # return id for the book object, or parent book if @document is a volume
+    def book_id(document)
+      if document[:is_volume_of_ssim]
+        document[:is_volume_of_ssim].first.gsub(/info:fedora\//,'')
+      else
+        document.id
+      end
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/institutions_helper_behavior.rb

@@ -0,0 +1,31 @@
+module CommonwealthVlrEngine
+  module InstitutionsHelperBehavior
+
+    # link to view all items from an institution
+    def link_to_all_inst_items(link_class)
+      link_to(t('blacklight.institutions.browse.all'),
+              catalog_index_path(:f => {blacklight_config.institution_field => [@institution_title]}),
+              :class => link_class)
+    end
+
+    # replaces render_document_index in institutions/index partial
+    # so we can use local index_map_institutions partial for map view
+    def render_institutions_index documents = nil, locals = {}
+      documents ||= @document_list
+      if document_index_view_type.to_s == 'maps'
+        render :partial => 'catalog/index_map_institutions',
+               :locals => {:geojson_features => serialize_geojson(map_facet_values,
+                                                                  nil,
+                                                                  {partial: 'institutions/map_institutions_search'})}
+      else
+        render_document_index_with_view(document_index_view_type, documents, locals)
+      end
+    end
+
+    # whether the A-Z link menu should be displayed in institutions#index
+    def should_render_inst_az?
+      false
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/layout_helper.rb

@@ -0,0 +1,22 @@
+module CommonwealthVlrEngine
+  module LayoutHelper
+    include Blacklight::LayoutHelperBehavior
+
+    def main_content_classes
+      'col-sm-9'
+    end
+
+    def show_content_classes
+      'col-sm-12 show-document'
+    end
+
+    def show_sidebar_classes
+      'col-sm-4'
+    end
+
+    def sidebar_classes
+      'col-sm-3'
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/ocr_search_helper_behavior.rb

@@ -0,0 +1,48 @@
+module CommonwealthVlrEngine
+  module OcrSearchHelperBehavior
+
+    # return the term frequency as an integer
+    # if Solr returns 0, change to 1 (most likely phrase search)
+    def compute_term_freq(term_freq)
+      term_freq > 0 ? term_freq : term_freq+1
+    end
+
+    # if current_search_session exists, return query_params['q'], otherwise return nil
+    # @current_search_session is defined in Blacklight::SearchContext
+    def ocr_q_params(current_search_session)
+      if current_search_session
+        current_search_session.query_params['q']
+      else
+        nil
+      end
+    end
+
+    # print the ocr snippets. if more than one, separate with <br/>
+    def render_ocr_snippets options={}
+      snippets = options[:value]
+      snippets_content = [content_tag('div',
+                                      "... #{snippets.first} ...".html_safe,
+                                      class: 'ocr_snippet first_snippet')]
+      if snippets.length > 1
+        snippets_content << render(partial: 'ocr_search/snippets_more',
+                                   locals: {snippets: snippets.drop(1),
+                                            counter: options[:counter]})
+      end
+      snippets_content.join("\n").html_safe
+    end
+
+    # link to the book viewer, using page number or image index
+    # @document = SolrDocument (page object)
+    # @image_pid_list = an ordered Array of image pids for the book object
+    # @book_id = pid of book object
+    def render_page_link(document, image_pid_list, book_id)
+      index_of_doc = image_pid_list.index(document.id)
+      page_num = document[blacklight_config.page_num_field.to_sym]
+      link_to page_num ? "Page #{page_num}" : "Image #{index_of_doc+1}",
+              "#{book_viewer_path(book_id)}?ocr_q=#{url_encode(params[:ocr_q])}#1/#{index_of_doc+1}",
+              class: 'book_page_link',
+              rel: 'nofollow'
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/pages_helper_behavior.rb

@@ -0,0 +1,38 @@
+require 'rss'
+
+module CommonwealthVlrEngine
+  module PagesHelperBehavior
+
+    def render_blog_feed(source = t('blacklight.home.context.news.rss_link'))
+      if source.present?
+        feed = Rails.cache.fetch('dc_rss_feed', :expires_in => 60.minutes) do
+          RSS::Parser.parse(open(source).read, false).items[0..3]
+        end
+      end
+      if source.present? && feed.length > 0
+        content = []
+        feed.each do |item|
+          content << content_tag(:li,
+                                 link_to(item.title,
+                                         item.link,
+                                         :class => 'feed_item_link',
+                                         :target => '_blank'),
+                                 :class => 'feed_item')
+        end
+        content_tag(:ul, content.join().html_safe, :class => 'feed_items')
+      else
+        content_tag(:p,
+                    'Visit ' + link_to(t('blacklight.home.context.news.blog_title'),
+                                       t('blacklight.home.context.news.blog_url'),
+                                       :target => '_blank') + ' for the latest updates.')
+      end
+    rescue
+      content_tag(:p, 'No news at the moment, please check back later...')
+    end
+
+    def render_about_site_path
+      about_site_path
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/vlr_blacklight_maps_helper_behavior.rb

@@ -0,0 +1,59 @@
+module CommonwealthVlrEngine
+  module VlrBlacklightMapsHelperBehavior
+    include Blacklight::BlacklightMapsHelperBehavior
+
+    # OVERRIDE: convert state abbreviations, deal with complex locations, etc.
+    # create a link to a location name facet value
+    def link_to_placename_field field_value, field, displayvalue = nil, catalogpath = nil
+      search_path = catalogpath || 'catalog_index_path'
+      new_params = params
+      new_params[:view] = default_document_index_view_type
+      field_values = field_value.split(', ')
+      if field_values.last.match(/[\.\)]/) # Mass.)
+        field_values = [field_values.join(', ')]
+      end
+      if field_values.length > 2
+        new_field_values = []
+        new_field_values[0] = field_value.split(/[,][ \w]*\z/).first
+        new_field_values[1] = field_values.last
+        field_values = new_field_values
+      end
+      if field_values.length == 2 && field_values.last.length == 2
+        state_name = Madison.get_name(field_values.last)
+        field_values[field_values.length-1] = state_name if state_name
+      end
+      field_values.each do |val|
+        place = val.match(/\(county\)/) ? val : val.gsub(/\s\([a-z]*\)\z/,'')
+        new_params = add_facet_params(field, place, new_params) unless params[:f] && params[:f][field] && params[:f][field].include?(place)
+        new_params[:view] = default_document_index_view_type
+      end
+      link_to(displayvalue.presence || field_value,
+              self.send(search_path,new_params.except(:id, :spatial_search_type, :coordinates)))
+    end
+
+    # OVERRIDE: use a static file for catalog#map so page loads faster
+    # render the map for #index and #map views
+    def render_index_map
+      static_geojson_file_loc = "#{Rails.root.to_s}/#{GEOJSON_STATIC_FILE['filepath']}"
+      if Rails.env.to_s == 'production' && params[:action] == 'map' && File::exists?(static_geojson_file_loc)
+        geojson_for_map = File.open(static_geojson_file_loc).first
+      else
+        geojson_for_map = serialize_geojson(map_facet_values)
+      end
+      render :partial => 'catalog/index_map',
+             :locals => {:geojson_features => geojson_for_map}
+    end
+
+
+    # OVERRIDE: allow controller.action name to be passed, allow @controller
+    # pass the document or facet values to BlacklightMaps::GeojsonExport
+    def serialize_geojson(documents, action_name=nil, options={})
+      action = action_name || controller.action_name
+      cntrllr = @controller || controller
+      export = BlacklightMaps::GeojsonExport.new(cntrllr, action, documents, options)
+      export.to_geojson
+    end
+
+  end
+
+end

data/app/helpers/feedback_helper.rb

@@ -0,0 +1,3 @@
+module FeedbackHelper
+  include CommonwealthVlrEngine::FeedbackHelperBehavior
+end

data/app/helpers/folders_helper.rb

@@ -0,0 +1,3 @@
+module FoldersHelper
+  include CommonwealthVlrEngine::FoldersHelperBehavior
+end

data/app/helpers/image_viewer_helper.rb

@@ -0,0 +1,3 @@
+module ImageViewerHelper
+  include CommonwealthVlrEngine::ImageViewerHelperBehavior
+end

data/app/helpers/institutions_helper.rb

@@ -0,0 +1,3 @@
+module InstitutionsHelper
+  include CommonwealthVlrEngine::InstitutionsHelperBehavior
+end

data/app/helpers/ocr_search_helper.rb

@@ -0,0 +1,3 @@
+module OcrSearchHelper
+  include CommonwealthVlrEngine::OcrSearchHelperBehavior
+end

data/app/helpers/pages_helper.rb

@@ -0,0 +1,3 @@
+module PagesHelper
+  include CommonwealthVlrEngine::PagesHelperBehavior
+end

data/app/mailers/notifier.rb

@@ -0,0 +1,5 @@
+class Notifier < ActionMailer::Base
+
+  include CommonwealthVlrEngine::Notifier
+
+end

data/app/models/carousel_slide.rb

@@ -0,0 +1,7 @@
+class CarouselSlide < ActiveRecord::Base
+
+  #attr_accessible :context, :image_pid, :institution, :object_pid, :region, :scale, :sequence, :title
+
+  #serialize :region, Array
+
+end

data/app/models/record_mailer.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+# overriding Blacklight RecordMailer to add :from address in email
+# otherwise we get error: ArgumentError (An SMTP From address is required to send a message
+class RecordMailer < ActionMailer::Base
+  def email_record(documents, details, url_gen_params)
+
+    subject = I18n.t('blacklight.email.text.subject', :count => documents.length, :title => (documents.first.to_semantic_values[:title] rescue 'N/A') )
+
+    @documents      = documents
+    @message        = details[:message]
+    @url_gen_params = url_gen_params
+
+    mail(:to => details[:to],
+         :from => t('blacklight.email.record_mailer.name') + ' <' + t('blacklight.email.record_mailer.email') + '>',
+         :subject => subject)
+  end
+
+end

data/app/models/user.rb

@@ -0,0 +1,15 @@
+class User < ActiveRecord::Base
+  require 'base64'
+  require 'cgi'
+  require 'openssl'
+  require 'rest_client'
+
+  # Connects this user object to Blacklights Bookmarks.
+  include Blacklight::User
+
+  # Connects this user object to the BPL omniauth service
+  include Bpluser::User
+
+  self.table_name = "users"
+
+end

data/app/views/advanced/_advanced_search_date.html.erb

@@ -0,0 +1,23 @@
+<div id="date_range_limit" class="advanced_search_field">
+  <div class="form-group">
+    <label class="control-label col-sm-2 ">Year</label>
+    <div class="col-sm-8">
+      <div class="input-group col-sm-4">
+        <label id="date_range_start_label" class="input-group-addon" for="date_start">Start</label>
+        <%= text_field_tag 'date_start',
+                           nil,
+                           :id => 'date_range_start',
+                           :class => 'form-control',
+                           :maxlength => 4 %>
+      </div>
+      <div class="input-group col-sm-4">
+        <label id="date_range_end_label" class="input-group-addon" for="date_end">End</label>
+        <%= text_field_tag 'date_end',
+                           nil,
+                           :id => 'date_range_end',
+                           :class => 'form-control',
+                           :maxlength => 4 %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/advanced/_advanced_search_facets.html.erb

@@ -0,0 +1,5 @@
+<div id="advanced_search_facets" class="limit_input">
+  <div class="facets-collapse" id="facets">
+    <%= render_facet_partials facet_field_names %>
+  </div>
+</div>

data/app/views/advanced/_advanced_search_fields.html.erb

@@ -0,0 +1,39 @@
+<% search_fields_for_advanced_search.take(3).each_with_index do |(key, field_def), index| %>
+    <div class="advanced_search_field form-group">
+      <%= select_tag('search_index[]',
+                     options_for_select(search_fields,
+                                        search_fields[index]),
+                     :title => t('blacklight.search.basic_search.form.search_indexes'),
+                     :class=> 'btn btn-default search_index_select col-sm-2 control-label') %>
+      <%= label_tag('input' + (index+1).to_s,
+                    t('blacklight.search.basic_search.form.q') + ' (' + (index+1).to_s + ')',
+                    :class => 'sr-only') %>
+      <div class="col-sm-6">
+        <%= text_field_tag 'query[]',
+                           nil,
+                           :class => 'advanced_input_text form-control',
+                           :autofocus => index == 0 ? true : false %>
+      </div>
+    </div>
+<% end %>
+<div class="advanced_search_field">
+  <div id="advanced_operators" class="col-sm-offset-2 col-sm-6">
+    <label class="radio-inline">
+      <%= radio_button_tag(:op, 'AND', :checked) %> find all terms
+    </label>
+    <label class="radio-inline">
+      <%= radio_button_tag(:op, 'OR') %> find any terms
+    </label>
+  </div>
+</div>
+<div class="pull-right">
+  <%= submit_tag 'Search', :class=>'btn btn-primary advanced_submit', :id=>'advanced_search' %>
+  <%= link_to 'Start over', {:controller => 'advanced', :action => 'index'}, :class =>'reset btn btn-default' %>
+</div>
+
+<%# search_fields_for_advanced_search.each do |key, field_def| -%>
+    <!-- <div class="advanced_search_field"> -->
+      <%# label_tag key, "#{field_def.label }:" %>
+      <%# text_field_tag key, label_tag_default_for(key), :class => 'input-block-level' %>
+    <!-- </div> -->
+<%# end -%>