newspaper_works 0.1.0

data/app/models/newspaper_page.rb

@@ -0,0 +1,70 @@
+# Newspaper Page
+class NewspaperPage < ActiveFedora::Base
+  # WorkBehavior mixes in minimal ::Hyrax::CoreMetadata fields of
+  # depositor, title, date_uploaded, and date_modified.
+  # https://samvera.github.io/customize-metadata-model.html#core-metadata
+  include ::Hyrax::WorkBehavior
+  include NewspaperWorks::ScannedMediaMetadata
+
+  self.indexer = NewspaperPageIndexer
+
+  # containment/aggregation:
+  # self.valid_child_concerns = []
+
+  # Validation and required fields:
+  validates :title, presence: { message: 'A newspaper page requires a label.' }
+  # TODO: Implement validations
+  # validates :height, presence: { message: 'A newspaper page requires a height.' }
+  # validates :width, presence: { message: 'A newspaper page requires a width.' }
+
+  # == Type-specific properties ==
+
+  # - Height
+  property(
+    :height,
+    predicate: ::RDF::URI.new('http://dbpedia.org/ontology/height'),
+    multiple: false
+  ) do |index|
+    index.as :stored_searchable
+  end
+
+  # - Width
+  property(
+    :width,
+    predicate: ::RDF::URI.new('http://dbpedia.org/ontology/width'),
+    multiple: false
+  ) do |index|
+    index.as :stored_searchable
+  end
+
+  # TODO: Add Reel number: https://github.com/samvera-labs/uri_selection_wg/issues/2
+
+  # BasicMetadata must be included last
+  include ::Hyrax::BasicMetadata
+
+  # relationship methods
+
+  # get publication (transitive)
+  def publication
+    # try transitive relation via issue first:
+    issue = self.issue
+    return issue.publication unless issue.nil?
+    # fallback to trying to see if there is an issue-less container with title:
+    container = self.container
+    return container.publication unless container.nil?
+  end
+
+  def articles
+    member_of.select { |v| v.instance_of?(NewspaperArticle) }
+  end
+
+  def issue
+    result = member_of.select { |v| v.instance_of?(NewspaperIssue) }
+    result[0] unless result.empty?
+  end
+
+  def container
+    result = member_of.select { |v| v.instance_of?(NewspaperContainer) }
+    result[0] unless result.empty?
+  end
+end

data/app/models/newspaper_title.rb

@@ -0,0 +1,111 @@
+# NewspaperTitle: object for a publication/title
+class NewspaperTitle < ActiveFedora::Base
+  # WorkBehavior mixes in minimal ::Hyrax::CoreMetadata fields of
+  # depositor, title, date_uploaded, and date_modified.
+  # https://samvera.github.io/customize-metadata-model.html#core-metadata
+  include ::Hyrax::WorkBehavior
+  include NewspaperWorks::NewspaperCoreMetadata
+
+  self.indexer = NewspaperTitleIndexer
+
+  # containment/aggregation:
+  self.valid_child_concerns = [NewspaperContainer, NewspaperIssue]
+
+  # Validation and required fields:
+  validates :title, presence: {
+    message: 'A newspaper title requires a title (publication name).'
+  }
+
+  validates_with NewspaperWorks::PublicationDateStartEndValidator
+
+  # TODO: Implement validations
+  # validates :resource_type, presence: {
+  #   message: 'A newspaper article requires a resource type.'
+  # }
+  # validates :language, presence: {
+  #   message: 'A newspaper article requires a language.'
+  # }
+  # validates :held_by, presence: {
+  #   message: 'A newspaper article requires a holding location.'
+  # }
+
+  # validations below causing save failures
+  # TODO: get them working || enforce validation elsewhere || remove
+
+  # validates :type, presence: {
+  #   message: 'A newspaper title requires a type.'
+  # }
+
+  # == Type-specific properties ==
+
+  # - Edition name
+  property(
+    :edition_name,
+    predicate: ::RDF::Vocab::BF2.editionStatement,
+    multiple: false
+  ) do |index|
+    index.as :stored_searchable
+  end
+
+  # - Frequency
+  property(
+    :frequency,
+    predicate: ::RDF::URI.new('http://www.rdaregistry.info/Elements/u/P60538'),
+    multiple: true
+  ) do |index|
+    index.as :stored_searchable
+  end
+
+  # - Preceded by
+  property(
+    :preceded_by,
+    predicate: ::RDF::URI.new('http://rdaregistry.info/Elements/u/P60261'),
+    multiple: true
+  ) do |index|
+    index.as :stored_searchable, :facetable
+  end
+
+  # - Succeeded by
+  property(
+    :succeeded_by,
+    predicate: ::RDF::URI.new('http://rdaregistry.info/Elements/u/P60278'),
+    multiple: true
+  ) do |index|
+    index.as :stored_searchable, :facetable
+  end
+
+  # - Publication date start
+  property(
+    :publication_date_start,
+    predicate: ::RDF::Vocab::SCHEMA.startDate,
+    multiple: false
+  ) do |index|
+    index.type :date
+    index.as :stored_sortable
+  end
+
+  # - Publication date end
+  property(
+    :publication_date_end,
+    predicate: ::RDF::Vocab::SCHEMA.endDate,
+    multiple: false
+  ) do |index|
+    index.type :date
+    index.as :stored_sortable
+  end
+
+  # BasicMetadata must be included last
+  include ::Hyrax::BasicMetadata
+
+  # for GeoNames autocomplete lookup
+  include NewspaperWorks::PlaceOfPublicationBehavior
+
+  # relationship methods:
+  def issues
+    members.select { |v| v.instance_of?(NewspaperIssue) }
+  end
+
+  def containers
+    members.select { |v| v.instance_of?(NewspaperContainer) }
+  end
+end

data/app/models/newspaper_works/application_record.rb

@@ -0,0 +1,6 @@
+module NewspaperWorks
+  # Application Record Class
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/newspaper_works/derivative_attachment.rb

@@ -0,0 +1,8 @@
+module NewspaperWorks
+  class DerivativeAttachment < ApplicationRecord
+    # We can store nil/optional fileset as interim value before fileset
+    #   construction, but we require at minimum, path, destination_name
+    validates :path, presence: true
+    validates :destination_name, presence: true
+  end
+end

data/app/models/newspaper_works/ingest_file_relation.rb

@@ -0,0 +1,14 @@
+module NewspaperWorks
+  class IngestFileRelation < ApplicationRecord
+    validates :file_path, presence: true
+    validates :derivative_path, presence: true
+
+    # Query by file path for all derivatives, as de-duplicated array of
+    #   derivative paths.
+    # @param path [String] Path to primary file
+    # @return [Array<String>] de-duplicated array of derivative paths.
+    def self.derivatives_for_file(path)
+      where(file_path: path).pluck(:derivative_path).uniq
+    end
+  end
+end

data/app/presenters/hyrax/newspaper_article_presenter.rb

@@ -0,0 +1,38 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperArticle`
+module Hyrax
+  class NewspaperArticlePresenter < Hyrax::WorkShowPresenter
+    include NewspaperWorks::NewspaperCorePresenter
+    include NewspaperWorks::ScannedMediaPresenter
+    include NewspaperWorks::TitleInfoPresenter
+    include NewspaperWorks::IssueInfoPresenter
+    include NewspaperWorks::IiifManifestPresenterBehavior
+
+    delegate :author, :photographer, :volume, :edition_number,
+             :edition_name, :issue_number, :geographic_coverage, :extent,
+             :genre, to: :solr_document
+
+    def publication_date
+      solr_document["publication_date_dtsi"]
+    end
+
+    def page_ids
+      solr_document['page_ids_ssim']
+    end
+
+    def page_titles
+      solr_document['page_titles_ssim']
+    end
+
+    private
+
+      def iiif_metadata_fields
+        [:title, :alternative_title, :place_of_publication, :issn, :lccn,
+         :oclcnum, :held_by, :text_direction, :page_number, :section, :genre,
+         :author, :photographer, :volume, :edition, :issue_number,
+         :geographic_coverage, :extent, :publication_date, :resource_type,
+         :creator, :contributor, :description, :license, :rights_statement,
+         :publisher, :subject, :language, :identifier]
+      end
+  end
+end

data/app/presenters/hyrax/newspaper_container_presenter.rb

@@ -0,0 +1,11 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperContainer`
+module Hyrax
+  class NewspaperContainerPresenter < Hyrax::WorkShowPresenter
+    include NewspaperWorks::NewspaperCorePresenter
+    include NewspaperWorks::TitleInfoPresenter
+
+    delegate :extent, :publication_date_start, :publication_date_end,
+             to: :solr_document
+  end
+end

data/app/presenters/hyrax/newspaper_issue_presenter.rb

@@ -0,0 +1,62 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperIssue`
+module Hyrax
+  class NewspaperIssuePresenter < Hyrax::WorkShowPresenter
+    include NewspaperWorks::NewspaperCorePresenter
+    include NewspaperWorks::TitleInfoPresenter
+    include NewspaperWorks::IiifManifestPresenterBehavior
+
+    delegate :volume, :edition_number, :edition_name,
+             :issue_number, :extent, to: :solr_document
+
+    # @return [Boolean] render the UniversalViewer
+    def iiif_viewer?
+      Hyrax.config.iiif_image_server? && members_include_viewable_page?
+    end
+
+    def publication_date
+      solr_document["publication_date_dtsi"]
+    end
+
+    def persistent_url
+      return nil unless publication_unique_id && issue_date_for_url
+      NewspaperWorks::Engine.routes.url_helpers.newspaper_issue_edition_url(unique_id: publication_unique_id,
+                                                                            date: issue_date_for_url,
+                                                                            edition: edition_for_url,
+                                                                            host: request.host)
+    end
+
+    private
+
+      # modeled on Hyrax::WorkShowPresenter#members_include_viewable_image?
+      # @return [Boolean] whether the member works will show in the IIIF viewer
+      def members_include_viewable_page?
+        work_presenters.any? do |presenter|
+          presenter.model_name == 'NewspaperPage' &&
+            presenter.iiif_viewer? &&
+            current_ability.can?(:read, presenter.id)
+        end
+      end
+
+      def publication_unique_id
+        solr_document['publication_unique_id_ssi'] || nil
+      end
+
+      def issue_date_for_url
+        return nil unless publication_date
+        publication_date.match(/\A[\d]{4}-[\d]{2}-[\d]{2}/).to_s
+      end
+
+      def edition_for_url
+        "ed-#{edition_number ? edition_number.first : '1'}"
+      end
+
+      def iiif_metadata_fields
+        [:title, :alternative_title, :place_of_publication_label, :issn, :lccn,
+         :oclcnum, :held_by, :volume, :edition_name, :edition_number,
+         :issue_number, :extent, :publication_date, :resource_type, :creator,
+         :contributor, :description, :license, :rights_statement, :publisher,
+         :language, :identifier]
+      end
+  end
+end

data/app/presenters/hyrax/newspaper_page_presenter.rb

@@ -0,0 +1,72 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperPage`
+module Hyrax
+  class NewspaperPagePresenter < Hyrax::WorkShowPresenter
+    include NewspaperWorks::ScannedMediaPresenter
+    include NewspaperWorks::TitleInfoPresenter
+    include NewspaperWorks::IssueInfoPresenter
+    include NewspaperWorks::IiifManifestPresenterBehavior
+    include NewspaperWorks::PersistentUrlPresenterBehavior
+    include NewspaperWorks::PageFinder
+    include NewspaperWorks::PlaceOfPublicationPresenterBehavior
+
+    delegate :height, :width, to: :solr_document
+
+    def persistent_url
+      return nil unless publication_unique_id && issue_date_for_url
+      NewspaperWorks::Engine.routes.url_helpers.newspaper_page_url(unique_id: publication_unique_id,
+                                                                   date: issue_date_for_url,
+                                                                   edition: edition_for_url,
+                                                                   page: page_index_for_url,
+                                                                   host: request.host)
+    end
+
+    def previous_page_id
+      solr_document['is_following_page_of_ssi']
+    end
+
+    def next_page_id
+      solr_document['is_preceding_page_of_ssi']
+    end
+
+    def container_id
+      solr_document['container_id_ssi']
+    end
+
+    def container_title
+      solr_document['container_title_ssi']
+    end
+
+    def article_ids
+      solr_document['article_ids_ssim']
+    end
+
+    def article_titles
+      solr_document['article_titles_ssim']
+    end
+
+    private
+
+      def publication_unique_id
+        solr_document['publication_unique_id_ssi'] || nil
+      end
+
+      def issue_date_for_url
+        return nil unless publication_date
+        publication_date.match(/\A[\d]{4}-[\d]{2}-[\d]{2}/).to_s
+      end
+
+      def edition_for_url
+        "ed-#{solr_document['issue_edition_number_ssi'] || '1'}"
+      end
+
+      def page_index_for_url
+        "seq-#{(get_page_index(id, solr_document['issue_id_ssi']) + 1)}"
+      end
+
+      def iiif_metadata_fields
+        [:title, :text_direction, :page_number, :section, :resource_type,
+         :license, :rights_statement, :identifier, :publication_date]
+      end
+  end
+end

data/app/presenters/hyrax/newspaper_title_presenter.rb

@@ -0,0 +1,86 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperTitle`
+module Hyrax
+  class NewspaperTitlePresenter < Hyrax::WorkShowPresenter
+    include NewspaperWorks::NewspaperCorePresenter
+    delegate :edition_name, :frequency, :preceded_by,
+             :succeeded_by, to: :solr_document
+
+    def title_search_params
+      { f: { "publication_title_ssi" => title } }
+    end
+
+    def front_page_search_params
+      { f: { "publication_title_ssi" => title, "first_page_bsi" => [true] }, sort: 'publication_date_dtsi asc' }
+    end
+
+    def issues
+      all_title_issues.select { |issue| year_or_nil(issue["publication_date_dtsi"]) == year }
+    end
+
+    def issue_years
+      all_title_issue_dates.map { |issue_date| year_or_nil(issue_date) }.compact.uniq.sort
+    end
+
+    def prev_year
+      return nil if issue_years.empty?
+      index = issue_years.index(year) - 1
+      return nil if index.negative?
+      issue_years[index]
+    end
+
+    def next_year
+      return nil if issue_years.empty?
+      issue_years[issue_years.index(year) + 1]
+    end
+
+    def publication_date_start
+      solr_document["publication_date_start_dtsi"]
+    end
+
+    def publication_date_end
+      solr_document["publication_date_end_dtsi"]
+    end
+
+    def year
+      return nil if issue_years.empty?
+      number_or_nil(request.params[:year]) || issue_years.first
+    end
+
+    def all_title_issues
+      issue_query = Blacklight.default_index.search(q: "has_model_ssim:NewspaperIssue AND publication_id_ssi:#{id} AND visibility_ssi:#{solr_document.visibility}",
+                                                    rows: 50_000,
+                                                    fl: "id, publication_date_dtsi")
+      issue_query.documents
+    end
+
+    def publication_unique_id
+      solr_document[NewspaperWorks.config.publication_unique_id_field]
+    end
+
+    def persistent_url
+      return nil unless publication_unique_id
+      NewspaperWorks::Engine.routes.url_helpers.newspaper_title_url(unique_id: publication_unique_id.first,
+                                                                    host: request.host)
+    end
+
+    private
+
+      def all_title_issue_dates
+        all_title_issues.pluck("publication_date_dtsi")
+      end
+
+      def number_or_nil(string)
+        Integer(string || '')
+      rescue ArgumentError
+        nil
+      end
+
+      def year_or_nil(date_value)
+        return nil unless date_value.is_a?(String)
+        Date.parse(date_value).year
+      rescue TypeError
+        nil
+      end
+  end
+end

data/app/presenters/newspaper_works/iiif_manifest_presenter_behavior.rb

@@ -0,0 +1,29 @@
+# mixin to provide URL for IIIF Content Search service
+module NewspaperWorks
+  module IiifManifestPresenterBehavior
+    extend ActiveSupport::Concern
+
+    def search_service
+      Rails.application.routes.url_helpers.solr_document_iiif_search_url(id,
+                                                                         host: request.base_url)
+    end
+
+    # based on Hyrax::WorkShowPresenter#manifest_metadata
+    # expects that individual presenters define #iiif_metadata_fields
+    def manifest_metadata
+      fields = iiif_metadata_fields || []
+      metadata = []
+      fields.each do |field|
+        label = Hyrax::Renderers::AttributeRenderer.new(field, nil).label
+        value = send(field)
+        next if value.blank?
+        value = Array.wrap(value) if value.is_a?(String)
+        metadata << {
+          'label' => label,
+          'value' => Array.wrap(value.map { |f| Loofah.fragment(f.to_s).scrub!(:whitewash).to_s })
+        }
+      end
+      metadata
+    end
+  end
+end

data/app/presenters/newspaper_works/issue_info_presenter.rb

@@ -0,0 +1,29 @@
+# NewspaperIssue ancestor data
+module NewspaperWorks
+  # shared NewspaperIssue info for multiple newspaper models
+  module IssueInfoPresenter
+    def issue_id
+      solr_document['issue_id_ssi']
+    end
+
+    def issue_title
+      solr_document['issue_title_ssi']
+    end
+
+    def publication_date
+      solr_document['publication_date_dtsi']
+    end
+
+    def issue_volume
+      solr_document['issue_volume_ssi']
+    end
+
+    def issue_edition
+      solr_document['issue_edition_number_ssi']
+    end
+
+    def issue_number
+      solr_document['issue_number_ssi']
+    end
+  end
+end

data/app/presenters/newspaper_works/newspaper_core_presenter.rb

@@ -0,0 +1,9 @@
+# module comment...
+module NewspaperWorks
+  # core presenter for newspaper models
+  module NewspaperCorePresenter
+    include NewspaperWorks::PersistentUrlPresenterBehavior
+    include NewspaperWorks::PlaceOfPublicationPresenterBehavior
+    delegate :alternative_title, :issn, :lccn, :oclcnum, :held_by, to: :solr_document
+  end
+end

data/app/presenters/newspaper_works/persistent_url_presenter_behavior.rb

@@ -0,0 +1,16 @@
+# mixin to provide persistent URL methods
+module NewspaperWorks
+  module PersistentUrlPresenterBehavior
+    # Default for NewspaperContainer and NewspaperArticle,
+    # since we don't support ChronAm-style URLs for those object types.
+    # Override in individual presenters as needed.
+    def persistent_url
+      nil
+    end
+
+    def persistent_url_attribute
+      return nil unless persistent_url
+      renderer_for(:persistent_url, {}).new(:persistent_url, persistent_url).render_dl_row
+    end
+  end
+end

data/app/presenters/newspaper_works/place_of_publication_presenter_behavior.rb

@@ -0,0 +1,8 @@
+# mixin to provide methods to render place_of_publication
+module NewspaperWorks
+  module PlaceOfPublicationPresenterBehavior
+    def place_of_publication_label
+      solr_document["place_of_publication_label_tesim"]
+    end
+  end
+end

data/app/presenters/newspaper_works/scanned_media_presenter.rb

@@ -0,0 +1,7 @@
+# Scanned Media: Shared Metadata
+module NewspaperWorks
+  # scanned media metadata for newspaper models (e.g. page, article images)
+  module ScannedMediaPresenter
+    delegate :text_direction, :page_number, :section, to: :solr_document
+  end
+end

data/app/presenters/newspaper_works/title_info_presenter.rb

@@ -0,0 +1,13 @@
+# NewspaperTitle ancestor data
+module NewspaperWorks
+  # shared NewspaperTitle info for multiple newspaper models
+  module TitleInfoPresenter
+    def publication_id
+      solr_document['publication_id_ssi']
+    end
+
+    def publication_title
+      solr_document['publication_title_ssi']
+    end
+  end
+end

data/app/search_builders/concerns/newspaper_works/exclude_models.rb

@@ -0,0 +1,16 @@
+module NewspaperWorks
+  # hide Title, Container, and Issue objects if this is a keyword search
+  # can be added to default_processor_chain in a SearchBuilder class
+  module ExcludeModels
+    extend ActiveSupport::Concern
+
+    def exclude_models(solr_parameters)
+      return unless solr_parameters[:q] || solr_parameters[:all_fields]
+      type_field = 'human_readable_type_sim'
+      solr_parameters[:fq] ||= []
+      %w[Title Container Issue].each do |model|
+        solr_parameters[:fq] << '-' + type_field + ':"Newspaper ' + model + '"'
+      end
+    end
+  end
+end

data/app/search_builders/concerns/newspaper_works/highlight_search_params.rb

@@ -0,0 +1,14 @@
+module NewspaperWorks
+  # add highlighting on _stored_ full text field if this is a keyword search
+  # can be added to default_processor_chain in a SearchBuilder class
+  module HighlightSearchParams
+    # add highlights on full text field, if there is a keyword query
+    def highlight_search_params(solr_parameters = {})
+      return unless solr_parameters[:q] || solr_parameters[:all_fields]
+      solr_parameters[:hl] = true
+      solr_parameters[:'hl.fl'] = 'all_text_tsimv'
+      solr_parameters[:'hl.fragsize'] = 100
+      solr_parameters[:'hl.snippets'] = 5
+    end
+  end
+end

data/app/search_builders/newspaper_works/newspapers_search_builder.rb

@@ -0,0 +1,26 @@
+# based heavily on BlacklightAdvancedSearch::AdvancedSearchBuilder
+# this class is used to set params on the search that is performed to
+# display facet values on the Newspapers Search form,
+# NOT the search results when a user submits the form
+module NewspaperWorks
+  class NewspapersSearchBuilder < Hyrax::SearchBuilder
+    self.default_processor_chain += [:facets_for_newspapers_search_form, :newspaper_pages_only]
+
+    def facets_for_newspapers_search_form(solr_params)
+      # we only care about facets, we don't need any rows.
+      solr_params["rows"] = "0"
+
+      # add anything set in config as a literal
+      newspaper_facet_config = blacklight_config.advanced_search[:newspapers_search]
+      return if newspaper_facet_config.blank?
+      solr_params.merge!(newspaper_facet_config[:form_solr_parameters])
+    end
+
+    def newspaper_pages_only(solr_params)
+      type_field = Solrizer.solr_name('human_readable_type', :facetable)
+      type_value = NewspaperPage.human_readable_type
+      solr_params[:fq] ||= []
+      solr_params[:fq] << "#{type_field}:\"#{type_value}\""
+    end
+  end
+end

data/app/services/hyrax/article_genre_service.rb

@@ -0,0 +1,9 @@
+# based on Hyrax::RightsStatementService
+module Hyrax
+  # Provide select options for the NewspaperArticle genre (edm:hasType) field
+  class ArticleGenreService < QaSelectService
+    def initialize(_authority_name = nil)
+      super('newspaper_article_genres')
+    end
+  end
+end