newspaper_works 0.1.0

data/Rakefile

@@ -0,0 +1,38 @@
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'engine_cart/rake_task'
+
+# Bundler.require(*Rails.groups)
+
+# Rails.application.load_tasks
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+# task :ci => ['engine_cart:generate'] do
+# run the tests
+# end
+
+# RSpec::Core::RakeTask.new(:spec)
+
+# task :default => :spec
+# RSpec::Core::RakeTask.new
+
+# Set up the test application prior to running jasmine tasks.
+task :setup_test_server do
+  require 'engine_cart'
+  EngineCart.load_application!
+end
+
+Dir.glob('tasks/*.rake').each { |r| import r }
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+task default: :ci

data/app/actors/hyrax/actors/newspaper_article_actor.rb

@@ -0,0 +1,8 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperArticle`
+module Hyrax
+  module Actors
+    class NewspaperArticleActor < Hyrax::Actors::BaseActor
+    end
+  end
+end

data/app/actors/hyrax/actors/newspaper_container_actor.rb

@@ -0,0 +1,8 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperContainer`
+module Hyrax
+  module Actors
+    class NewspaperContainerActor < Hyrax::Actors::BaseActor
+    end
+  end
+end

data/app/actors/hyrax/actors/newspaper_issue_actor.rb

@@ -0,0 +1,8 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperIssue`
+module Hyrax
+  module Actors
+    class NewspaperIssueActor < Hyrax::Actors::BaseActor
+    end
+  end
+end

data/app/actors/hyrax/actors/newspaper_page_actor.rb

@@ -0,0 +1,8 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperPage`
+module Hyrax
+  module Actors
+    class NewspaperPageActor < Hyrax::Actors::BaseActor
+    end
+  end
+end

data/app/actors/hyrax/actors/newspaper_title_actor.rb

@@ -0,0 +1,8 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperTitle`
+module Hyrax
+  module Actors
+    class NewspaperTitleActor < Hyrax::Actors::BaseActor
+    end
+  end
+end

data/app/actors/newspaper_works/actors/newspaper_works_upload_actor.rb

@@ -0,0 +1,88 @@
+module NewspaperWorks
+  module Actors
+    class NewspaperWorksUploadActor < Hyrax::Actors::AbstractActor
+      def create(env)
+        # Ensure that work has title, set from form data if present
+        ensure_title(env)
+        # If NewspaperIssue, we might have a PDF to split; make a list of
+        #   paths to PDF uploads before next_actor removes them
+        #   from env.attributes, with state kept in instance variable
+        #   until late in "heading back up" phase of the actor stack, where
+        #   correct depositor value is already set on the issue (only
+        #   at that point should we queue the job to create child pages).
+        @pdf_paths = []
+        hold_upload_paths(env) if env.curation_concern.class == NewspaperIssue
+        # pass to next actor, then handle issue uploads after other actors
+        #   that are lower on the stack
+        next_actor.create(env) && after_other_actors(env)
+      end
+
+      def after_other_actors(env)
+        handle_issue_upload(env) if env.curation_concern.class == NewspaperIssue
+        # needs to return true to not break actor stack traversal
+        true
+      end
+
+      # Work must have a title to save, and this actor's .create/.update
+      #   methods run prior to the setting of form data.  This ensures
+      #   appropriate title is set on model.
+      def ensure_title(env)
+        form_title = env.attributes['title']
+        return if form_title.nil?
+        env.curation_concern.title = form_title
+      end
+
+      def update(env)
+        # Ensure that work has title, set from form data if present
+        ensure_title(env)
+        @pdf_paths = []
+        hold_upload_paths(env) if env.curation_concern.class == NewspaperIssue
+        # pass to next actor, then handle issue uploads after other actors
+        #   that are lower on the stack
+        next_actor.update(env) && after_other_actors(env)
+      end
+
+      def default_admin_set
+        AdminSet.find_or_create_default_admin_set_id
+      end
+
+      def queue_job(work, paths, user, admin_set_id)
+        NewspaperWorks::CreateIssuePagesJob.perform_later(
+          work,
+          paths,
+          user,
+          admin_set_id
+        )
+      end
+
+      def hold_upload_paths(env)
+        return unless env.attributes.keys.include? 'uploaded_files'
+        upload_ids = filter_file_ids(env.attributes['uploaded_files'])
+        return if upload_ids.empty?
+        uploads = Hyrax::UploadedFile.find(upload_ids)
+        paths = uploads.map(&method(:upload_path))
+        @pdf_paths = paths.select { |path| path.end_with?('.pdf') }
+      end
+
+      def handle_issue_upload(env)
+        return if @pdf_paths.empty?
+        work = env.curation_concern
+        # must persist work to serialize job using it
+        work.save!(validate: false)
+        user = env.current_ability.current_user.user_key
+        env.attributes[:admin_set_id] ||= default_admin_set
+        queue_job(work, @pdf_paths, user, env.attributes[:admin_set_id])
+      end
+
+      # Given Hyrax::Upload object, return path to file on local filesystem
+      def upload_path(upload)
+        # so many layers to this onion:
+        upload.file.file.file
+      end
+
+      def filter_file_ids(input)
+        Array.wrap(input).select(&:present?)
+      end
+    end
+  end
+end

data/app/assets/config/newspaper_works_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/newspaper_works .js
+//= link_directory ../stylesheets/newspaper_works .css

data/app/assets/javascripts/newspaper_works/autocomplete_fix.js

@@ -0,0 +1,33 @@
+/*jshint browser: true, nomen: false, eqnull: true, es5:true, trailing:true */
+
+(function () {
+  "use strict";
+  var work_form = $("form[data-behavior='work-form']"),
+      Autocomplete = require('hyrax/autocomplete'),
+      LinkedData = require('hyrax/autocomplete/linked_data');
+
+  function patch_autocomplete() {
+    var method = Autocomplete.prototype.setup;
+    if (!window._autocomplete_patched) {
+      Autocomplete.prototype.setup = function (element, fieldName, url) {
+        // defer to original method for relevant BasicMetadata fields:
+        var defer = ['based_near', 'language', 'work'],
+            autourl = element.attr('data-autocomplete-url'),
+            declared = (element.attr('data-autocomplete') === fieldName),
+            ld = (declared && autourl && autourl.indexOf('authorities') !== -1),
+            additionalField = element.context === undefined;
+        if (additionalField || (ld && defer.indexOf(fieldName) == -1)) {
+          new LinkedData(element, url);
+          console.log('Using patched autocomplete for field', fieldName);
+        } else {
+          method(element, fieldName, url);
+        }
+      };
+      window._autocomplete_patched = true;
+    }
+  }
+
+  if (work_form.length && work_form.attr('id').indexOf('newspaper_') != -1) {
+    patch_autocomplete();
+  }
+}());

data/app/assets/javascripts/newspaper_works/ocr_search.js.erb

@@ -0,0 +1,6 @@
+/* toggle the ocr snippets collapse link text */
+$(document).ready(function(){
+  $('.ocr_snippets_expand').click(function() {
+    $(this).text($(this).text() == '<%= I18n.t('blacklight.search.results.snippets.more') %>' ? '<%= I18n.t('blacklight.search.results.snippets.less') %>' : '<%= I18n.t('blacklight.search.results.snippets.more') %>');
+  });
+});

data/app/assets/javascripts/newspaper_works/thumbnail_highlights.js.erb

@@ -0,0 +1,102 @@
+/* highlight the query term on the search result thumbnail */
+/* heavily based on https://github.com/mlibrary/fishrappr -> results_page_highlighting.js */
+
+$().ready(function() {
+    // we use dummy value so we can use rails url_helper for URL (have to pass id)
+    var coordsUrl = '<%= Hyrax::Engine.routes.url_helpers.download_path("xyz", file: "json") %>';
+    var $thumbs = $("#documents .thumbnail img, #search-results .list-thumbnail img");
+
+    if ( $thumbs.length == 0 ) { return ; }
+
+    var viewType = 'list';
+    if ($('#documents.gallery').length) {
+        viewType = 'gallery';
+    }
+
+    $thumbs.each(function() {
+        var $thumb = $(this);
+        $thumb.on('load', function() {
+            addHighlights($(this));
+        });
+    })
+
+    var addHighlights = function($thumb) {
+        var $div = $thumb.closest(".thumbnail, .list-thumbnail");
+        var filesetId = $div.data('fileset');
+        var query = $div.data('query');
+        if ( query === undefined || query.length == 0 || filesetId === undefined || filesetId.length == 0 ) {
+            return ;
+        }
+
+        $.ajax({
+            url: coordsUrl.replace("xyz", filesetId),
+            method: 'GET',
+            dataType: 'json',
+            success: function (data) {
+
+                var thumbWidth = $thumb.width();
+                var thumbHeight = $thumb.height();
+                var trueWidth = data['width'];
+                var trueHeight = data['height'];
+                var hScale = thumbWidth / trueWidth;
+                var vScale = thumbHeight / trueHeight;
+                var paddingLeft, paddingTop;
+
+                // check if this is gallery or list view
+                if (viewType === 'gallery') {
+                    var offset = $thumb.position();
+                    paddingTop = offset.top;
+                    var thumbOuterWidth = $thumb.outerWidth(true);
+                    var thumbPaddingLeft = parseInt($div.css("padding-left"));
+                    var documentPaddingLeft = parseInt($div.closest(".document").css("padding-left"));
+                    paddingLeft = Math.round(((thumbOuterWidth - thumbWidth) / 2) + thumbPaddingLeft + documentPaddingLeft);
+                } else {
+                    paddingLeft = parseInt($div.closest(".search-result-wrapper .col-md-2").css("padding-left"));
+                    paddingTop = 0;
+                }
+
+                var queries = query.split(' ');
+
+                $.each(data['coords'], function (k, v) {
+                    if (!inTerms(k, queries)) {
+                        return;
+                    }
+
+                    for (var i=0; i < v.length; i++) {
+                        var coords = v[i];
+                        if ( coords == null ) { return; }
+
+                        // decrease left, top; increase height, width
+                        // so that highlight surrounds image with a bit of padding
+                        var left = Math.round(coords[0] * hScale) + paddingLeft - 2;
+                        var top = Math.round(coords[1] * vScale) + paddingTop - 2;
+                        var width = Math.round(coords[2] * hScale) + 3;
+                        var height = Math.round(coords[3] * vScale) + 3;
+                        var unit = 'px';
+
+                        // make sure highlight div isn't too small, else won't be visible
+                        if ( height < 5 ) { height = 5; }
+                        if ( width < 10 ) { width = 10; }
+
+                        var $span = $('<div class="thumbnail_highlight"></div>').css({ top: top + unit, left: left + unit, width: width + unit, height: height + unit });
+                        $span.appendTo($div);
+                    }
+                })
+            }
+        });
+    };
+})
+
+function matchesTerm(ocr_string, query) {
+    var key = ocr_string.toLocaleLowerCase();
+    return key.indexOf(query.toLocaleLowerCase()) > -1;
+}
+
+function inTerms(ocr_string, queries) {
+    for (var i = 0; i < queries.length; i++) {
+        if (matchesTerm(ocr_string, queries[i])) {
+            return true;
+        }
+    }
+    return false;
+}

data/app/assets/javascripts/newspaper_works.js

@@ -0,0 +1,4 @@
+// this file gets included in downstream application.js by installer
+
+//= require newspaper_works/thumbnail_highlights
+//= require newspaper_works/ocr_search

data/app/assets/stylesheets/newspaper_works/_issue_search.scss

@@ -0,0 +1,13 @@
+#issue_search_form_wrapper {
+  #q_issues {
+    width: 250px;
+  }
+
+  .input-group {
+    margin-bottom: 5px;
+  }
+}
+
+#front_page_search_form {
+  margin-top: 20px;
+}

data/app/assets/stylesheets/newspaper_works/_issues_calendar.scss

@@ -0,0 +1,18 @@
+.calendar_day {
+  display: inline-block;
+  width: 17px;
+  height: 10px;
+  text-align: center;
+}
+
+.calendar_day_inactive {
+  color: gray;
+}
+
+.issues_calendar {
+  margin-bottom: 25px;
+}
+
+#issues_calendar_title h2 select {
+  font-size: 0.6em;
+}

data/app/assets/stylesheets/newspaper_works/_newspaper_works.scss

@@ -0,0 +1,4 @@
+@import 'issues_calendar';
+@import 'issue_search';
+@import 'newspapers_search';
+@import 'search_results';

data/app/assets/stylesheets/newspaper_works/_newspapers_search.scss

@@ -0,0 +1,38 @@
+#newspapers_search_form_wrapper {
+
+  #newspapers_search_form{
+    margin-top: 25px;
+
+    #keyword_input {
+      padding-bottom: 20px;
+    }
+
+    #date_range_limit_wrapper {
+      padding-bottom: 10px;
+
+      .date_input {
+        float: left;
+        margin-right: 20px;
+      }
+    }
+
+    .facet_scrollbox_wrapper {
+      margin-left: 15px;
+    }
+  }
+
+}
+
+#newspapers_search_help_wrapper {
+
+  ul.newspapers_help {
+    font-size: 12px;
+    padding-left: 24px;
+
+    li {
+      padding-bottom:10px;
+    }
+
+  }
+
+}

data/app/assets/stylesheets/newspaper_works/_search_results.scss

@@ -0,0 +1,12 @@
+$highlight-background-color: rgba(5,166,86,0.36);
+
+#search-results .thumbnail_highlight, #documents .thumbnail_highlight {
+  background-color: $highlight-background-color;
+  z-index: 1000;
+  position: absolute;
+}
+
+.metadata em {
+  background-color: $highlight-background-color;
+  font-weight: bold;
+}

data/app/controllers/hyrax/newspaper_articles_controller.rb

@@ -0,0 +1,14 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperArticle`
+
+module Hyrax
+  class NewspaperArticlesController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+    self.curation_concern_type = ::NewspaperArticle
+
+    # Use this line if you want to use a custom presenter
+    self.show_presenter = Hyrax::NewspaperArticlePresenter
+  end
+end

data/app/controllers/hyrax/newspaper_containers_controller.rb

@@ -0,0 +1,14 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperContainer`
+
+module Hyrax
+  class NewspaperContainersController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+    self.curation_concern_type = ::NewspaperContainer
+
+    # Use this line if you want to use a custom presenter
+    self.show_presenter = Hyrax::NewspaperContainerPresenter
+  end
+end

data/app/controllers/hyrax/newspaper_issues_controller.rb

@@ -0,0 +1,14 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperIssue`
+
+module Hyrax
+  class NewspaperIssuesController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+    self.curation_concern_type = ::NewspaperIssue
+
+    # Use this line if you want to use a custom presenter
+    self.show_presenter = Hyrax::NewspaperIssuePresenter
+  end
+end

data/app/controllers/hyrax/newspaper_pages_controller.rb

@@ -0,0 +1,14 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperPage`
+
+module Hyrax
+  class NewspaperPagesController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+    self.curation_concern_type = ::NewspaperPage
+
+    # Use this line if you want to use a custom presenter
+    self.show_presenter = Hyrax::NewspaperPagePresenter
+  end
+end

data/app/controllers/hyrax/newspaper_titles_controller.rb

@@ -0,0 +1,13 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperTitle`
+module Hyrax
+  class NewspaperTitlesController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+    self.curation_concern_type = ::NewspaperTitle
+
+    # Use this line if you want to use a custom presenter
+    self.show_presenter = Hyrax::NewspaperTitlePresenter
+  end
+end

data/app/controllers/newspaper_works/newspapers_controller.rb

@@ -0,0 +1,117 @@
+module NewspaperWorks
+  class NewspapersController < ApplicationController
+    # Adds Hyrax behaviors to the controller.
+    include Hyrax::WorksControllerBehavior
+    include Hyrax::BreadcrumbsForWorks
+
+    include NewspaperWorks::PageFinder
+
+    before_action :find_title
+    before_action :find_issue, only: [:issue, :page]
+    before_action :build_breadcrumbs
+
+    def title
+      if @title
+        params[:id] = @title['id']
+        @presenter = Hyrax::NewspaperTitlePresenter.new(@title, current_ability, request)
+        render 'hyrax/newspaper_titles/show'
+      else
+        bad_url_handler
+      end
+    end
+
+    def issue
+      if @issue
+        params[:id] = @issue['id']
+        @presenter = Hyrax::NewspaperIssuePresenter.new(@issue, current_ability, request)
+        render 'hyrax/newspaper_issues/show'
+      else
+        bad_url_handler
+      end
+    end
+
+    def page
+      @page = find_page
+      if @page
+        params[:id] = @page['id']
+        @presenter = Hyrax::NewspaperPagePresenter.new(@page, current_ability, request)
+        render 'hyrax/newspaper_pages/show'
+      else
+        bad_url_handler
+      end
+    end
+
+    private
+
+      # override from Hyrax::WorksControllerBehavior
+      # or else this evals to 'dashboard'
+      def decide_layout
+        File.join(theme, '1_column')
+      end
+
+      # override from Hyrax::BreadcrumbsForWorks; copy of Hyrax::Breadcrumbs
+      # so method gets called despite action_name != 'show'
+      def build_breadcrumbs
+        if request.referer
+          trail_from_referer
+        else
+          default_trail
+        end
+      end
+
+      def bad_url_handler
+        raise(ActionController::RoutingError, 'Not Found')
+      end
+
+      def find_title
+        unique_id_field = NewspaperWorks.config.publication_unique_id_field
+        solr_params = ["has_model_ssim:\"NewspaperTitle\""]
+        solr_params << "#{unique_id_field}:\"#{params[:unique_id]}\""
+        @title = find_object(solr_params.join(' AND '))
+      end
+
+      def find_issue
+        return nil unless @title
+        solr_params = ["has_model_ssim:\"NewspaperIssue\""]
+        solr_params << "publication_id_ssi:\"#{@title['id']}\""
+        solr_params << "publication_date_dtsi:\"#{params[:date]}T00:00:00Z\""
+        solr_params << "edition_number_tesim:\"#{edition_for_search}\""
+        @issue = find_object(solr_params.join(' AND '))
+      end
+
+      def find_page
+        return nil unless @issue
+        page_index = pagenum_to_index
+        pages = pages_for_issue(@issue['id'])
+        return nil if pages.blank? || pages[page_index].blank?
+        search_result_document(id: pages[page_index]['id'])
+      end
+
+      def find_object(solr_params)
+        begin
+          solr_resp = Blacklight.default_index.search(fq: solr_params)
+        rescue # in case of RSolr::Error, etc.
+          return nil
+        end
+        return nil unless solr_resp.documents.count == 1
+        object_id = solr_resp.documents.first['id']
+        # we run the search again, to add permissions/access filters
+        # invoked by Hyrax::WorkSearchBuilder
+        search_result_document(id: object_id)
+      end
+
+      def edition_for_search
+        edition = params[:edition]
+        default = '1'
+        return default if edition.nil?
+        edition = edition.gsub(/\Aed-/, '')
+        return default unless edition.to_i.positive?
+        edition
+      end
+
+      def pagenum_to_index
+        page_i = params[:page].gsub(/\Aseq-/, '').to_i
+        (page_i - 1).negative? ? 0 : (page_i - 1)
+      end
+  end
+end

data/app/controllers/newspaper_works/newspapers_search_controller.rb

@@ -0,0 +1,26 @@
+# based heavily on BlacklightAdvancedSearch::AdvancedController
+module NewspaperWorks
+  class NewspapersSearchController < CatalogController
+    def search_builder_class
+      NewspaperWorks::NewspapersSearchBuilder
+    end
+
+    def search
+      @response = newspaper_search_facets
+    end
+
+    private
+
+      # we need this for proper routing of search forms/links
+      def search_action_url(*args)
+        main_app.search_catalog_url(*args)
+      end
+
+      def newspaper_search_facets
+        response, = search_results(params) do |search_builder|
+          search_builder.except(:add_advanced_search_to_solr)
+        end
+        response
+      end
+  end
+end

data/app/forms/hyrax/newspaper_article_form.rb

@@ -0,0 +1,11 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperArticle`
+module Hyrax
+  class NewspaperArticleForm < ::NewspaperWorks::NewspaperCoreFormData
+    self.model_class = ::NewspaperArticle
+    self.terms += [:alternative_title, :genre, :author, :photographer,
+                   :publication_date, :volume, :edition_number, :edition_name,
+                   :issue_number, :geographic_coverage, :extent, :page_number,
+                   :section]
+  end
+end

data/app/forms/hyrax/newspaper_container_form.rb

@@ -0,0 +1,11 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperContainer`
+module Hyrax
+  # Newspaper Container Form Class
+  class NewspaperContainerForm < ::NewspaperWorks::NewspaperCoreFormData
+    self.model_class = ::NewspaperContainer
+    self.terms += [:alternative_title, :extent, :publication_date_start,
+                   :publication_date_end]
+    self.terms -= [:creator, :contributor, :description, :subject]
+  end
+end