arclight 0.0.1 → 0.1.0

data/app/views/shared/_main_menu_links.html.erb

@@ -0,0 +1,6 @@
+<li class="nav-item <%= repositories_active_class %>">
+  <%= link_to t('arclight.routes.repositories'), arclight_engine.repositories_path, class: 'nav-link' %>
+</li>
+<li class="nav-item <%= collection_active_class %>">
+  <%= link_to t('arclight.routes.collections'), arclight_engine.collections_path, class: 'nav-link' %>
+</li>

data/arclight.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -7,8 +8,8 @@ require 'arclight/version'
 Gem::Specification.new do |spec|
   spec.name          = 'arclight'
   spec.version       = Arclight::VERSION
-  spec.authors       = ['Jack Reed']
-  spec.email         = ['phillipjreed@gmail.com']
+  spec.authors       = ['Darren Hardy', 'Jessie Keck', 'Gordon Leacock', 'Jack Reed']
+  spec.email         = ['drh@stanford.edu', 'jessie.keck@gmail.com', 'gordonl@umich.edu', 'phillipjreed@gmail.com']
 
   spec.summary       = ''
   spec.description   = ''
@@ -22,7 +23,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'blacklight'
+  spec.add_dependency 'blacklight_range_limit'
+  spec.add_dependency 'rails', '~> 5.0'
+  spec.add_dependency 'solr_ead'
+
   spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'engine_cart'
+  spec.add_development_dependency 'poltergeist'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.48.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.15.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0'
+  spec.add_development_dependency 'solr_wrapper'
 end

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/arclight/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/arclight.en.yml

@@ -0,0 +1,65 @@
+en:
+  arclight:
+    masthead_heading: 'Archival Collections at Institution'
+    date_range_histogram:
+      show_hide: 'Show/hide date distribution'
+    hierarchy:
+      view_all: 'View'
+      scope_and_contents: 'Scope and Contents'
+    request:
+      container: 'Request container(s)'
+    routes:
+      home: 'Home'
+      collections: 'Collections'
+      repositories: 'Repositories'
+      search_results: 'Search results'
+    views:
+      index:
+        number_of_children:
+          zero: 'No children'
+          one: '1 child'
+          other: '%{count} children'
+        collection_search:
+          count: 'collection'
+      online_content_indicator: 'online content'
+      show:
+        collection_id: 'Collection ID: %{id}'
+        overview: 'Overview'
+        online_content: 'Online content'
+        no_online_content: 'No online content'
+        no_contents: 'No content inventory'
+        search_within: 'Search within this collection'
+        navigation_sidebar:
+          title: 'Navigation overview'
+        context_sidebar:
+          in_person_field: 'In person'
+          terms_field: 'Terms & Conditions'
+          cite_field: 'How to cite this collection'
+          component_terms_field: "Terms & Conditions"
+        sections:
+          summary_field: 'Summary'
+          access_field: 'Access and Use'
+          background_field: 'Background'
+          scope_and_arrangement_field: 'Scope and Arrangement'
+          related_field: 'Related'
+          indexed_terms_field: 'Indexed Terms'
+          admin_info_field: 'Administrative Information'
+          component_field: 'About this %{level}'
+          component_indexed_terms_field: 'Indexed Terms'
+          collection_context_field: 'Collection Context'
+        our_collections: 'Our Collections'
+        download:
+          default: 'Download'
+          pdf: 'Collection PDF (%{size})'
+          ead: 'Collection EAD (%{size})'
+      repositories:
+        number_of_collections:
+          zero: 'No collections'
+          one: '1 collection'
+          other: '%{count} collections'
+        view_more: 'View more'
+        view_all_collections: 'View all of our collections'
+    breadcrumb_separator: ' » '
+    truncation:
+      view_more: 'view more ▶'
+      view_less: 'view less ▼'

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Arclight::Engine.routes.draw do
+  get 'collections' => 'catalog#index', defaults: { f: { level_sim: ['Collection'] } }, as: :collections
+  resources :repositories, only: %i[index show], controller: 'arclight/repositories'
+end

data/lib/arclight.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 require 'arclight/version'
+require 'arclight/engine'
+require 'arclight/repository'
+require 'arclight/year_range'
 
 module Arclight
   # Your code goes here...

data/lib/arclight/custom_component.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # An Arclight custom component indexing code
+  class CustomComponent < SolrEad::Component
+    extend Arclight::SharedTerminologyBehavior
+    include Arclight::SharedIndexingBehavior
+    use_terminology SolrEad::Component
+
+    # we extend the terminology to provide additional fields and/or indexing strategies
+    # than `solr_ead` provides as-is. in many cases we're doing redundant indexing, but
+    # we're trying to modify the `solr_ead` gem as little as possible
+    extend_terminology do |t|
+      # identifiers
+      t.level(path: 'c/@level', index_as: %i[displayable]) # machine-readable for string `level_ssm`
+      t.otherlevel(path: 'c/@otherlevel', index_as: %i[displayable])
+      t.ref_(path: '/c/@id', index_as: %i[displayable])
+
+      # facets
+      t.creator(path: "c/did/origination[@label='creator']/*/text()", index_as: %i[displayable facetable symbol])
+      t.places(path: 'c/controlaccess/geogname/text()', index_as: %i[displayable facetable symbol])
+
+      add_unitid(t, 'c/')
+      add_extent(t, 'c/')
+      add_dates(t, 'c/')
+      add_searchable_notes(t, 'c/')
+    end
+
+    def to_solr(solr_doc = {})
+      super
+      solr_doc['id'] = Arclight::NormalizedId.new(solr_doc['id']).to_s
+      solr_doc['creator_sort'] = creator.to_a.join(', ') if creator.present?
+      add_component_fields(solr_doc)
+      solr_doc
+    end
+
+    private
+
+    def add_component_fields(solr_doc)
+      component_field_definitions.each do |field|
+        # we want to use `set_field` rather than `insert_field` since we may be overriding fields
+        Solrizer.set_field(solr_doc, field[:name], field[:value], field[:index_as])
+      end
+      add_date_ranges(solr_doc)
+      add_normalized_title(solr_doc)
+      resolve_repository(solr_doc)
+      add_digital_content(prefix: 'c/did', solr_doc: solr_doc)
+    end
+
+    def component_field_definitions
+      [
+        { name: 'level', value: formatted_level, index_as: :facetable },
+        { name: 'names', value: names, index_as: :symbol },
+        { name: 'access_subjects', value: access_subjects, index_as: :symbol },
+        { name: 'containers', value: containers, index_as: :symbol },
+        { name: 'has_online_content', value: online_content?, index_as: :symbol }
+      ]
+    end
+
+    def resolve_repository(solr_doc)
+      repository = solr_doc[Solrizer.solr_name('repository', :displayable)]
+      %i[displayable facetable].each do |index_as|
+        Solrizer.set_field(solr_doc, 'repository', repository_as_configured(repository), index_as)
+      end
+    end
+
+    # @see http://eadiva.com/2/c/
+    def formatted_level
+      # terminology definitions for level yield Arrays and in this case single values
+      # TODO: OM changes the behavior of `level = level.first` such that it always returns `nil`
+      #       so need our own local variable here
+      actual_level = level.first.to_s if level.respond_to? :first
+
+      if actual_level == 'otherlevel'
+        alternative_level = otherlevel.first.to_s if otherlevel.respond_to? :first
+        alternative_level.present? ? alternative_level : 'Other'
+      elsif actual_level.present?
+        actual_level.capitalize
+      end
+    end
+
+    def names
+      names_array(%w[corpname famname name persname], parent: 'c')
+    end
+
+    def access_subjects
+      subjects_array(%w[subject function occupation genreform], parent: 'c')
+    end
+
+    def containers
+      contains = search('//container').to_a
+      contains.map do |c|
+        "#{c.attributes['type'].try(:value)} #{c.text}".strip
+      end
+    end
+  end
+end

data/lib/arclight/custom_document.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # An Arclight custom document indexing code
+  class CustomDocument < SolrEad::Document
+    extend Arclight::SharedTerminologyBehavior
+    include Arclight::SharedIndexingBehavior
+    use_terminology SolrEad::Document
+
+    # we extend the terminology to provide additional fields and/or indexing strategies
+    # than `solr_ead` provides as-is. in many cases we're doing redundant indexing, but
+    # we're trying to modify the `solr_ead` gem as little as possible
+    extend_terminology do |t|
+      # facets
+      t.repository(path: 'archdesc/did/repository/corpname/text() | archdesc/did/repository/name/text()', index_as: %i[displayable facetable])
+      t.creator(path: "archdesc/did/origination[@label='creator']/*/text()", index_as: %i[displayable facetable symbol])
+      t.creator_persname(path: "archdesc/did/origination[@label='creator']/persname/text()", index_as: %i[displayable facetable symbol])
+      t.creator_corpname(path: "archdesc/did/origination[@label='creator']/corpname/text()", index_as: %i[displayable facetable symbol])
+      t.creator_famname(path: "archdesc/did/origination[@label='creator']/famname/text()", index_as: %i[displayable facetable symbol])
+      t.function(path: 'archdesc/controlaccess/function/text()', index_as: %i[displayable facetable])
+      t.occupation(path: 'archdesc/controlaccess/occupation/text()', index_as: %i[displayable facetable])
+      t.places(path: 'archdesc/controlaccess/geogname/text()', index_as: %i[displayable facetable symbol])
+
+      add_unitid(t, 'archdesc/')
+      add_extent(t, 'archdesc/')
+      add_dates(t, 'archdesc/')
+      add_searchable_notes(t, 'archdesc/')
+    end
+
+    def to_solr(solr_doc = {})
+      super
+      solr_doc['id'] = Arclight::NormalizedId.new(eadid.first).to_s
+      solr_doc['creator_sort'] = creator.to_a.join(', ') if creator.present?
+      add_document_fields(solr_doc)
+      solr_doc
+    end
+
+    private
+
+    def add_document_fields(solr_doc)
+      arclight_field_definitions.each do |field|
+        # we want to use `set_field` rather than `insert_field` since we may be overriding fields
+        Solrizer.set_field(solr_doc, field[:name], field[:value], field[:index_as])
+      end
+
+      add_date_ranges(solr_doc)
+      add_digital_content(prefix: 'ead/archdesc', solr_doc: solr_doc)
+      add_normalized_titles(solr_doc)
+    end
+
+    def add_normalized_titles(solr_doc)
+      title = add_normalized_title(solr_doc)
+      Solrizer.set_field(solr_doc, 'collection', title, :facetable)
+      Solrizer.set_field(solr_doc, 'collection', title, :displayable)
+    end
+
+    def arclight_field_definitions
+      [
+        { name: 'level', value: 'collection', index_as: :displayable },
+        { name: 'level', value: 'Collection', index_as: :facetable },
+        { name: 'names', value: names, index_as: :symbol },
+        { name: 'access_subjects', value: access_subjects, index_as: :symbol },
+        { name: 'creators', value: creators, index_as: :symbol },
+        { name: 'has_online_content', value: online_content?, index_as: :symbol },
+        { name: 'repository', value: repository_as_configured(repository), index_as: :displayable },
+        { name: 'repository', value: repository_as_configured(repository), index_as: :facetable },
+        { name: 'names_coll', value: names_coll, index_as: :symbol }
+      ]
+    end
+
+    def names
+      [corpname, famname, name, persname].flatten.compact.uniq - repository
+    end
+
+    def names_coll
+      names_array(%w[corpname famname name persname], parent: 'archdesc')
+    end
+
+    def creators
+      [creator_persname, creator_corpname, creator_famname].flatten.compact.uniq - repository
+    end
+
+    # Combine subjets into one group from
+    #  <controlaccess/><subject></subject>
+    #  <controlaccess/><function></function>
+    #  <controlaccess/><genreform></genreform>
+    #  <controlaccess/><occupation></occupation>
+    def access_subjects
+      subjects_array(%w[subject function occupation genreform], parent: 'archdesc')
+    end
+  end
+end

data/lib/arclight/digital_object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # Plain ruby class to model serializing/deserializing digital object data
+  class DigitalObject
+    attr_reader :label, :href
+    def initialize(label:, href:)
+      @label = label.present? ? label : href
+      @href = href
+    end
+
+    def to_json(*)
+      { label: label, href: href }.to_json
+    end
+
+    def self.from_json(json)
+      object_data = JSON.parse(json)
+      new(label: object_data['label'], href: object_data['href'])
+    end
+
+    def ==(other)
+      href == other.href && label == other.label
+    end
+  end
+end

data/lib/arclight/engine.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'blacklight'
+require 'solr_ead'
+require 'arclight/exceptions'
+require 'arclight/normalized_date'
+require 'arclight/normalized_id'
+require 'arclight/normalized_title'
+require 'arclight/digital_object'
+require 'arclight/shared_indexing_behavior'
+require 'arclight/shared_terminology_behavior'
+require 'arclight/custom_document'
+require 'arclight/custom_component'
+require 'arclight/solr_ead_indexer_ext'
+require 'arclight/indexer'
+require 'arclight/viewer'
+
+module Arclight
+  ##
+  # This is the defining class for the Arclight Rails Engine
+  class Engine < ::Rails::Engine
+    config.viewer_class = Arclight::Viewers::OEmbed
+    config.oembed_resource_exclude_patterns = [/\.pdf$/, /\.ppt$/]
+
+    Arclight::Engine.config.catalog_controller_field_accessors = %i[
+      summary_field
+      access_field
+      background_field
+      related_field
+      admin_info_field
+      terms_field
+      cite_field
+      indexed_terms_field
+      in_person_field
+      component_field
+      online_field
+      component_terms_field
+      component_indexed_terms_field
+    ]
+
+    initializer 'arclight.fields' do
+      Arclight::Engine.config.catalog_controller_field_accessors.each do |field|
+        Blacklight::Configuration.define_field_access field
+      end
+    end
+
+    initializer 'arclight.helpers' do
+      ActionView::Base.send :include, ArclightHelper
+    end
+
+    initializer 'arclight.views' do
+      Blacklight::Configuration.default_values[:view].hierarchy
+    end
+  end
+end

data/lib/arclight/exceptions.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Exceptions
+    # Id's must be present on all documents and components
+    class IDNotFound < StandardError
+      def message
+        'id must be present for all documents and components'
+      end
+    end
+    # Unittitle or unitdate must be present on all documents and components
+    class TitleNotFound < StandardError
+      def message
+        '<unittitle/> or <unitdate/> must be present for all documents and components'
+      end
+    end
+  end
+end

data/lib/arclight/indexer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Arclight
+  ##
+  # A simple wrapper class around the SolrEad::Indexer so we can add our own behavior
+  class Indexer < SolrEad::Indexer
+    include Arclight::SolrEadIndexerExt
+  end
+end