arclight 0.1.4 → 0.3.3

data/.babelrc

@@ -0,0 +1,3 @@
+{
+    "presets": ["@babel/preset-env"]
+}

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+version: "2"
+exclude_patterns:
+  - "app/assets/javascripts/arclight/context_navigation.js"
+  - "vendor/assets/javascripts/**/*.js"
+  - "spec/**/*.rb"

data/.eslintrc

@@ -1,4 +1,7 @@
 {
+  "env": {
+    "es6": true
+  },
   "extends": "airbnb-base/legacy",
   "globals": {
     "jQuery": true,

data/.gitignore

@@ -2,6 +2,7 @@
 /.ruby-version
 /.yardoc
 /Gemfile.lock
+/yarn.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,5 +1,8 @@
 require: rubocop-rspec
 
+inherit_from:
+  - .rubocop_todo.yml
+
 AllCops:
   Exclude:
     - '.internal_test_app/**/*'
@@ -7,60 +10,35 @@ AllCops:
     - 'db/**/*'
     - 'lib/generators/arclight/templates/**/*'
     - 'vendor/**/*'
+    - 'node_modules/**/*'
   TargetRubyVersion: 2.4
   DisplayCopNames: true
 
-Rails:
-  Enabled: true
-
-Metrics/LineLength:
-  Max: 120
-  Exclude:
-    - 'Gemfile'
-    - 'lib/arclight/custom_document.rb'  # XPaths get long
-    - 'lib/arclight/custom_component.rb' # XPaths get long
-
 Metrics/ModuleLength:
-  Max: 120
-
-Metrics/ClassLength:
-  Max: 120
+  Exclude:
+    - 'app/helpers/arclight_helper.rb'
+    - 'app/models/concerns/arclight/solr_document.rb'
 
 Metrics/BlockLength:
   Exclude:
-    - !ruby/regexp /\.rake$/
     - 'arclight.gemspec'
+    - 'lib/arclight/traject/ead2_config.rb'
+    - 'lib/tasks/**/*'
+    - 'spec/features/traject/ead2_indexing_spec.rb'
+    - 'spec/helpers/arclight_helper_spec.rb'
+    - 'spec/features/collection_page_spec.rb'
     - 'spec/**/*'
-    - 'lib/arclight/custom_document.rb'
-
-Metrics/MethodLength:
-  Exclude:
-    - 'lib/arclight/custom_document.rb' # arclight_field_definitions too long
-
-Performance/RegexpMatch:
-  Enabled: false
+    - 'tasks/**/*'
 
-Rails/OutputSafety:
-  Exclude:
-    - 'app/controllers/concerns/arclight/field_config_helpers.rb' # html_safe needs to be called to mimic BL JOIN behavior
-
-RSpec/ExampleLength:
-  Enabled: false
+Metrics/LineLength:
+  Max: 160
 
-RSpec/FilePath:
-  Exclude:
-    - 'spec/lib/arclight/viewers/oembed_spec.rb' # Default file path is o_embed, and that looks weird
+Rails:
+  Enabled: true
 
-RSpec/MultipleExpectations:
+Bundler/DuplicatedGem:
   Enabled: false
 
-RSpec/NestedGroups:
-  Max: 4
-
-Style/Documentation:
+Style/FormatStringToken:
   Exclude:
-    - 'spec/**/*'
-    - 'lib/arclight.rb'
-
-Bundler/DuplicatedGem:
-  Enabled: false
+    - 'spec/test_app_templates/lib/generators/test_app_generator.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,139 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-09-05 15:26:25 -0600 using RuboCop version 0.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'lib/arclight/traject/ead2_config.rb'
+
+# Offense count: 1
+# Configuration parameters: CheckForMethodsWithNoSideEffects.
+Lint/Void:
+  Exclude:
+    - 'lib/arclight/year_range.rb'
+
+# Offense count: 68
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 278
+  Exclude:
+    - 'spec/features/collection_page_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 11
+  Exclude:
+    - 'app/helpers/arclight_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: Blacklist.
+# Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'spec/features/autocomplete_spec.rb'
+
+# Offense count: 91
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: SkipBlocks, EnforcedStyle.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/presenters/arclight/show_presenter_spec.rb'
+
+# Offense count: 61
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterExampleGroup:
+  Enabled: false
+
+# Offense count: 12
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterHook:
+  Exclude:
+    - 'spec/features/collection_page_spec.rb'
+    - 'spec/features/home_page_spec.rb'
+    - 'spec/features/many_component_ead_spec.rb'
+    - 'spec/features/search_results_spec.rb'
+    - 'spec/helpers/arclight_helper_spec.rb'
+    - 'spec/views/_collection_count.html.erb_spec.rb'
+    - 'spec/views/repositories/index.html.erb_spec.rb'
+
+# Offense count: 49
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Enabled: false
+
+# Offense count: 2
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/helpers/arclight_helper_spec.rb'
+    - 'spec/presenters/arclight/index_presenter_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CustomTransform, IgnoreMethods.
+RSpec/FilePath:
+  Exclude:
+    - 'spec/lib/arclight/viewers/oembed_spec.rb'
+
+# Offense count: 107
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 26
+
+# Offense count: 8
+RSpec/NestedGroups:
+  Max: 4
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: Strict, EnforcedStyle.
+# SupportedStyles: inflected, explicit
+RSpec/PredicateMatcher:
+  Exclude:
+    - 'spec/helpers/arclight_helper_spec.rb'
+    - 'spec/lib/arclight/year_range_spec.rb'
+
+# Offense count: 1
+Security/Open:
+  Exclude:
+    - 'lib/tasks/index.rake'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/tasks/index.rake'
+
+# Offense count: 1
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/arclight/year_range.rb'
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/arclight.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'app/models/concerns/arclight/search_behavior.rb'

data/.travis.yml

@@ -2,32 +2,36 @@ sudo: false
 language: ruby
 notifications:
   email: false
-rvm:
-  - 2.4.1
-jdk:
-  - oraclejdk8
 
-# Update to phantomjs 2.1.1 to fix issues with < 2
-# See https://github.com/travis-ci/travis-ci/issues/3225#issuecomment-177592725
-# and https://github.com/travis-ci/travis-ci/issues/3225#issuecomment-200965782
-cache:
-  bundler: true
-  directories:
-    - "travis_phantomjs"
+matrix:
+  include:
+    - rvm: 2.7.1
+      env: RAILS_VERSION=6.0.3.2
+    - rvm: 2.7.1
+      env: RAILS_VERSION=5.2.4.3
+    - rvm: 2.6.6
+      env: RAILS_VERSION=6.0.3.2
+    - rvm: 2.6.6
+      env: RAILS_VERSION=5.2.4.3
 
-before_install:
-  - "phantomjs --version"
-  - "export PATH=$PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64/bin:$PATH"
-  - "phantomjs --version"
-  - "if [ $(phantomjs --version) != '2.1.1' ]; then rm -rf $PWD/travis_phantomjs; mkdir -p $PWD/travis_phantomjs; fi"
-  - "if [ $(phantomjs --version) != '2.1.1' ]; then wget https://assets.membergetmember.co/software/phantomjs-2.1.1-linux-x86_64.tar.bz2 -O $PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64.tar.bz2; fi"
-  - "if [ $(phantomjs --version) != '2.1.1' ]; then tar -xvf $PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64.tar.bz2 -C $PWD/travis_phantomjs; fi"
-  - "hash -r"
-  - "phantomjs --version"
+jdk:
+  - openjdk11
 
 before_script:
   - find spec/fixtures/ead -name '*.xml' | xargs xmllint --noout --schema spec/fixtures/xsd/ead.xsd
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - yarn install
 addons:
   apt:
     packages:
     - libxml2-utils
+  chrome: stable
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=0bbc7b5fd7f6bab0c0517183ae34a4d2f6010ca1ef2d1c7c3ccdec55ea823115
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CONTRIBUTORS.md

@@ -0,0 +1,79 @@
+## Contributors ✨
+
+ArcLight is a cross-institutional project led by Stanford University, with contributions from Duke University, Georgia Tech, Indiana University, LYRASIS, the National Library of Medicine, University of Michigan, Princeton University, and Rockefeller Archive Center.
+
+Individual project contributors include ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/seanaery"><img src="https://avatars3.githubusercontent.com/u/3933756?v=4" width="125px;" alt="Sean Aery"/><br /><sub><b>Sean Aery</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=seanaery" title="Code">💻</a></td>
+    <td align="center"><a href="http://hillelarnold.com"><img src="https://avatars0.githubusercontent.com/u/607621?v=4" width="125px;" alt="Hillel Arnold"/><br /><sub><b>Hillel Arnold</b></sub></a><br /><a href="#analysis-helrond" title="Functional requirements and related research">🔬</a> <a href="#userTesting-helrond" title="User Testing">📓</a></td>
+    <td align="center"><a href="http://cbeer.info"><img src="https://avatars1.githubusercontent.com/u/111218?v=4" width="125px;" alt="Chris Beer"/><br /><sub><b>Chris Beer</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=cbeer" title="Code">💻</a> <a href="https://github.com/projectblacklight/arclight/commits?author=cbeer" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://leaannbradford.com"><img src="https://avatars3.githubusercontent.com/u/18175797?v=4" width="125px;" alt="Lea Ann Bradford"/><br /><sub><b>Lea Ann Bradford</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=labradford" title="Code">💻</a></td>
+    <td align="center"><a href="http://actspatial.com"><img src="https://avatars0.githubusercontent.com/u/9905193?v=4" width="125px;" alt="Christina Chortaria"/><br /><sub><b>Christina Chortaria</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=christinach" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/mark-cooper"><img src="https://avatars1.githubusercontent.com/u/551470?v=4" width="125px;" alt="Mark Cooper"/><br /><sub><b>Mark Cooper</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=mark-cooper" title="Code">💻</a> <a href="#plugin-mark-cooper" title="Plugin/utility libraries">🔌</a></td>
+    <td align="center"><a href="http://knittles.ticklefish.org/"><img src="https://avatars3.githubusercontent.com/u/856924?v=4" width="125px;" alt="Esmé Cowles"/><br /><sub><b>Esmé Cowles</b></sub></a><br /><a href="#business-escowles" title="Business development">💼</a> <a href="#analysis-escowles" title="Functional requirements and related research">🔬</a></td>
+    <td align="center"><a href="https://github.com/tomcramer"><img src="https://avatars3.githubusercontent.com/u/1054837?v=4" width="125px;" alt="Tom Cramer"/><br /><sub><b>Tom Cramer</b></sub></a><br /><a href="#business-tomcramer" title="Business development">💼</a></td>
+    <td align="center"><a href="https://github.com/mdalmau"><img src="https://avatars0.githubusercontent.com/u/573273?v=4" width="125px;" alt="Michelle Dalmau"/><br /><sub><b>Michelle Dalmau</b></sub></a><br /><a href="#business-mdalmau" title="Business development">💼</a></td>
+    <td align="center"><a href="http://robotlibrarian.billdueber.com/"><img src="https://avatars0.githubusercontent.com/u/114006?v=4" width="125px;" alt="Bill Dueber"/><br /><sub><b>Bill Dueber</b></sub></a><br /><a href="#analysis-billdueber" title="Functional requirements and related research">🔬</a> <a href="https://github.com/projectblacklight/arclight/commits?author=billdueber" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/jwd"><img src="https://avatars1.githubusercontent.com/u/842343?v=4" width="125px;" alt="Jon Dunn"/><br /><sub><b>Jon Dunn</b></sub></a><br /><a href="#business-jwd" title="Business development">💼</a></td>
+    <td align="center"><a href="https://github.com/eckardm"><img src="https://avatars1.githubusercontent.com/u/7072443?v=4" width="125px;" alt="Max Eckard"/><br /><sub><b>Max Eckard</b></sub></a><br /><a href="#analysis-eckardm" title="Functional requirements and related research">🔬</a> <a href="#productOwner-eckardm" title="Product owner">🗺</a> <a href="#userTesting-eckardm" title="User Testing">📓</a></td>
+    <td align="center"><a href="https://github.com/jrgriffiniii"><img src="https://avatars0.githubusercontent.com/u/1443986?v=4" width="125px;" alt="James R. Griffin III"/><br /><sub><b>James R. Griffin III</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=jrgriffiniii" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/p-galligan"><img src="https://avatars2.githubusercontent.com/u/2585069?v=4" width="125px;" alt="Patrick Galligan"/><br /><sub><b>Patrick Galligan</b></sub></a><br /><a href="#userTesting-p-galligan" title="User Testing">📓</a></td>
+    <td align="center"><a href="http://ggeisler.com"><img src="https://avatars1.githubusercontent.com/u/101482?v=4" width="125px;" alt="Gary Geisler"/><br /><sub><b>Gary Geisler</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=ggeisler" title="Code">💻</a> <a href="#design-ggeisler" title="Design">🎨</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/bonniegee"><img src="https://avatars3.githubusercontent.com/u/8737364?v=4" width="125px;" alt="Bonnie Gordon"/><br /><sub><b>Bonnie Gordon</b></sub></a><br /><a href="#userTesting-bonniegee" title="User Testing">📓</a></td>
+    <td align="center"><a href="https://github.com/mswendyh"><img src="https://avatars1.githubusercontent.com/u/7033667?v=4" width="125px;" alt="Wendy Hagenmaier"/><br /><sub><b>Wendy Hagenmaier</b></sub></a><br /><a href="#analysis-mswendyh" title="Functional requirements and related research">🔬</a></td>
+    <td align="center"><img src="http://gravatar.com/avatar/8b53dcb509d4b1fe8dd74da6a94395ef.jpg?d=retro" width="125px;" alt="Jim Halliday"/><br /><sub><b>Jim Halliday</b></sub><br /><a href="#business" title="Business development">💼</a></td>
+    <td align="center"><a href="https://github.com/jlhardes"><img src="https://avatars1.githubusercontent.com/u/3440166?v=4" width="125px;" alt="Julie Hardesty"/><br /><sub><b>Julie Hardesty</b></sub></a><br /><a href="#analysis-jlhardes" title="Functional requirements and related research">🔬</a> <a href="#productOwner-jlhardes" title="Product owner">🗺</a></td>
+    <td align="center"><a href="http://stanford.edu/~drh"><img src="https://avatars3.githubusercontent.com/u/1861171?v=4" width="125px;" alt="Darren Hardy"/><br /><sub><b>Darren Hardy</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=drh-stanford" title="Code">💻</a> <a href="https://github.com/projectblacklight/arclight/commits?author=drh-stanford" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/drhardy"><img src="https://avatars3.githubusercontent.com/u/25580222?v=4" width="125px;" alt="Darren Hardy"/><br /><sub><b>Darren Hardy</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=drhardy" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/regineheberlein"><img src="https://avatars1.githubusercontent.com/u/5940563?v=4" width="125px;" alt="Regine Heberlein"/><br /><sub><b>Regine Heberlein</b></sub></a><br /><a href="#analysis-regineheberlein" title="Functional requirements and related research">🔬</a> <a href="#productOwner-regineheberlein" title="Product owner">🗺</a></td>
+    <td align="center"><a href="https://github.com/noahgh221"><img src="https://avatars3.githubusercontent.com/u/7328518?v=4" width="125px;" alt="Noah Huffman"/><br /><sub><b>Noah Huffman</b></sub></a><br /><a href="#analysis-noahgh221" title="Functional requirements and related research">🔬</a> <a href="#productOwner-noahgh221" title="Product owner">🗺</a></td>
+    <td align="center"><a href="https://github.com/njaffer"><img src="https://avatars0.githubusercontent.com/u/12487929?v=4" width="125px;" alt="Nabeela Jaffer"/><br /><sub><b>Nabeela Jaffer</b></sub></a><br /><a href="#analysis-njaffer" title="Functional requirements and related research">🔬</a> <a href="#business-njaffer" title="Business development">💼</a></td>
+    <td align="center"><a href="https://github.com/jkeck"><img src="https://avatars0.githubusercontent.com/u/96776?v=4" width="125px;" alt="Jessie Keck"/><br /><sub><b>Jessie Keck</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=jkeck" title="Code">💻</a> <a href="https://github.com/projectblacklight/arclight/commits?author=jkeck" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/gordonleacock"><img src="https://avatars3.githubusercontent.com/u/12927191?v=4" width="125px;" alt="Gordon Leacock"/><br /><sub><b>Gordon Leacock</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=gordonleacock" title="Code">💻</a> <a href="https://github.com/projectblacklight/arclight/commits?author=gordonleacock" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://matienzo.org/"><img src="https://avatars0.githubusercontent.com/u/73732?v=4" width="125px;" alt="Mark A. Matienzo"/><br /><sub><b>Mark A. Matienzo</b></sub></a><br /><a href="#projectManagement-anarchivist" title="Project Management">📆</a> <a href="#business-anarchivist" title="Business development">💼</a> <a href="#analysis-anarchivist" title="Functional requirements and related research">🔬</a> <a href="#productOwner-anarchivist" title="Product owner">🗺</a></td>
+    <td align="center"><a href="https://github.com/archivistsarah"><img src="https://avatars0.githubusercontent.com/u/25084902?v=4" width="125px;" alt="Sarah Newhouse"/><br /><sub><b>Sarah Newhouse</b></sub></a><br /><a href="#analysis-archivistsarah" title="Functional requirements and related research">🔬</a></td>
+    <td align="center"><a href="https://github.com/grepcats"><img src="https://avatars0.githubusercontent.com/u/7513448?v=4" width="125px;" alt="Kayla Ondracek"/><br /><sub><b>Kayla Ondracek</b></sub></a><br /><a href="#analysis-grepcats" title="Functional requirements and related research">🔬</a></td>
+    <td align="center"><a href="https://github.com/djpillen"><img src="https://avatars3.githubusercontent.com/u/11635158?v=4" width="125px;" alt="Dallas Pillen"/><br /><sub><b>Dallas Pillen</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=djpillen" title="Code">💻</a> <a href="#userTesting-djpillen" title="User Testing">📓</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/cmkpowell"><img src="https://avatars1.githubusercontent.com/u/16540397?v=4" width="125px;" alt="Chris Powell"/><br /><sub><b>Chris Powell</b></sub></a><br /><a href="#analysis-cmkpowell" title="Functional requirements and related research">🔬</a> <a href="#productOwner-cmkpowell" title="Product owner">🗺</a></td>
+    <td align="center"><a href="https://www.jack-reed.com/"><img src="https://avatars0.githubusercontent.com/u/1656824?v=4" width="125px;" alt="Jack Reed"/><br /><sub><b>Jack Reed</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=mejackreed" title="Code">💻</a> <a href="https://github.com/projectblacklight/arclight/commits?author=mejackreed" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/John-Rees"><img src="https://avatars1.githubusercontent.com/u/29233549?v=4" width="125px;" alt="John Rees"/><br /><sub><b>John Rees</b></sub></a><br /><a href="#analysis-John-Rees" title="Functional requirements and related research">🔬</a></td>
+    <td align="center"><a href="https://github.com/joshschneider"><img src="https://avatars3.githubusercontent.com/u/12468197?v=4" width="125px;" alt="Josh Schneider"/><br /><sub><b>Josh Schneider</b></sub></a><br /><a href="#analysis-joshschneider" title="Functional requirements and related research">🔬</a> <a href="#productOwner-joshschneider" title="Product owner">🗺</a></td>
+    <td align="center"><a href="https://github.com/willsexton"><img src="https://avatars2.githubusercontent.com/u/1359320?v=4" width="125px;" alt="Will Sexton"/><br /><sub><b>Will Sexton</b></sub></a><br /><a href="#business-willsexton" title="Business development">💼</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/shallcro"><img src="https://avatars2.githubusercontent.com/u/43279347?v=4" width="125px;" alt="Mike Shallcross"/><br /><sub><b>Mike Shallcross</b></sub></a><br /><a href="#analysis-shallcro" title="Functional requirements and related research">🔬</a></td>
+    <td align="center"><a href="https://github.com/remocrevo"><img src="https://avatars1.githubusercontent.com/u/8701105?v=4" width="125px;" alt="Remington Steed"/><br /><sub><b>Remington Steed</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=remocrevo" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/tampakis"><img src="https://avatars2.githubusercontent.com/u/4650153?v=4" width="125px;" alt="Nikitas Tampakis"/><br /><sub><b>Nikitas Tampakis</b></sub></a><br /><a href="#analysis-tampakis" title="Functional requirements and related research">🔬</a></td>
+    <td align="center"><a href="https://github.com/estelendur"><img src="https://avatars0.githubusercontent.com/u/10409866?v=4" width="125px;" alt="Esty Thomas"/><br /><sub><b>Esty Thomas</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=estelendur" title="Code">💻</a></td>
+    <td align="center"><a href="http://camillevilla.github.io"><img src="https://avatars2.githubusercontent.com/u/5402927?v=4" width="125px;" alt="Camille Villa"/><br /><sub><b>Camille Villa</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=camillevilla" title="Code">💻</a> <a href="https://github.com/projectblacklight/arclight/commits?author=camillevilla" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/jvine"><img src="https://avatars0.githubusercontent.com/u/6945691?v=4" width="125px;" alt="Jennifer Vine"/><br /><sub><b>Jennifer Vine</b></sub></a><br /><a href="#design-jvine" title="Design">🎨</a></td>
+    <td align="center"><a href="https://github.com/jweise"><img src="https://avatars2.githubusercontent.com/u/114413?v=4" width="125px;" alt="John Weise"/><br /><sub><b>John Weise</b></sub></a><br /><a href="#business-jweise" title="Business development">💼</a></td>
+    <td align="center"><a href="https://github.com/gwiedeman"><img src="https://avatars0.githubusercontent.com/u/10030353?v=4" width="125px;" alt="Gregory Wiedeman"/><br /><sub><b>Gregory Wiedeman</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=gwiedeman" title="Code">💻</a> <a href="https://github.com/projectblacklight/arclight/issues?q=author%3Agwiedeman" title="Bug reports">🐛</a> <a href="#userTesting-gwiedeman" title="User Testing">📓</a> <a href="#inProduction-gwiedeman" title="Has a production implementation">🏆</a></td>
+    <td align="center"><a href="https://github.com/lauraw15"><img src="https://avatars2.githubusercontent.com/u/6343788?v=4" width="125px;" alt="Laura Wilsey"/><br /><sub><b>Laura Wilsey</b></sub></a><br /><a href="#analysis-lauraw15" title="Functional requirements and related research">🔬</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/README.md

@@ -1,17 +1,18 @@
-[![Build Status](https://travis-ci.org/sul-dlss/arclight.svg?branch=master)](https://travis-ci.org/sul-dlss/arclight)
+[![Build Status](https://travis-ci.org/projectblacklight/arclight.svg?branch=master)](https://travis-ci.org/projectblacklight/arclight)
+[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](CONTRIBUTORS.md)
+[![Code Climate Test Coverage](https://codeclimate.com/github/projectblacklight/arclight/badges/coverage.svg)](https://codeclimate.com/github/projectblacklight/arclight/coverage)
 
-[![Coverage Status](https://coveralls.io/repos/github/sul-dlss/arclight/badge.svg?branch=master)](https://coveralls.io/github/sul-dlss/arclight?branch=master)
+# ArcLight
 
-# Arclight
+A Rails engine supporting discovery of archival materials, based on [Blacklight](https://projectblacklight.org/)
 
-A Rails engine supporting discovery of archival materials.
-
-During April - June 2017, ArcLight underwent its initial development as a Minimally Viable Product (MVP). The MVP is targeted for content that is described in the [Encoded Archival Description](http://eadiva.com/2/) (EAD) format. Future development is in the planning phase with no definitive timeline as yet.
+> ℹ️ From August-October 2019, Stanford University, University of Michigan, Indiana University, Princeton University, and Duke University are collaborating on a second phase of ArcLight! See the [project board](https://github.com/projectblacklight/arclight/projects/2) or our [demo videos](https://www.youtube.com/playlist?list=PLMdUaIJ0G8QiIXZ_SFHASJErD14CJW-p5) to follow our work.
 
 ## Requirements
 
-* [Ruby](https://www.ruby-lang.org/en/) 2.2 or later
+* [Ruby](https://www.ruby-lang.org/en/) 2.5 or later
 * [Rails](http://rubyonrails.org) 5.0 or later
+* Solr 8.1 or later
 
 ## Installation
 
@@ -51,29 +52,36 @@ See the [ArcLight demo](https://arclight-demo.projectblacklight.org/) and [ArcLi
 
 See [Arclight Major Features](https://github.com/sul-dlss/arclight/wiki/Arclight-Major-Features) for a list of features.
 
+### Traject indexing of EAD content
+[Traject](https://github.com/traject/traject) is a high performance way of transforming documents for indexing into Solr and how ArcLight does indexing. An EAD2 can be indexed by doing the following:
+
+```sh
+bundle exec traject -u http://127.0.0.1:8983/solr/blacklight-core -i xml -c lib/arclight/traject/ead2_config.rb spec/fixtures/ead/sample/large-components-list.xml
+```
+
+Or
+
+```sh
+bundle exec rake arclight:seed
+```
+
 ## Resources
 
 * General
-  * [ArcLight team wiki](https://wiki.duraspace.org/display/hydra/ArcLight): includes design process documentation
-  * Use the [ArcLight Google Group](http://groups.google.com/d/forum/arclight-community) to contact us with questions
-* MVP Implementation:
   * [ArcLight demo site](https://arclight-demo.projectblacklight.org/)
-  * [YouTube channel](https://www.youtube.com/channel/UCbSaP93HdypsW6hXy7V1nFQ): MVP sprint demo videos
-  * [ArcLight MVP Wiki](https://github.com/sul-dlss/arclight/wiki)
+  * [ArcLight project wiki](https://bit.ly/arclightproject): includes design process documentation
+  * [ArcLight Github Wiki](https://github.com/sul-dlss/arclight/wiki): developer/implementor documentation
   * [Blacklight wiki](https://github.com/projectblacklight/blacklight/wiki)
+  * Use the [ArcLight Google Group](http://groups.google.com/d/forum/arclight-community) to contact us with questions
+* ArcLight Phase II:
+  * [Project overview](https://wiki.duraspace.org/display/samvera/ArcLight+Phase+II)
+* ArcLight MVP:
+  * [MVP sprint demo videos](https://www.youtube.com/playlist?list=PLMdUaIJ0G8QgbuDCUVvFhTSTO96N37lRA)
+  * [Project overview](https://wiki.duraspace.org/display/samvera/ArcLight+MVP)
 
-## ArcLight MVP Development team
+## Contributors
 
-* Stanford University
-  * [Camille Villa](https://github.com/camillevilla)
-  * [Darren Hardy](https://github.com/drh-stanford)
-  * [Gary Geisler](https://github.com/ggeisler)
-  * [Jack Reed](https://github.com/mejackreed)
-  * [Jennifer Vine](https://github.com/jvine)
-  * [Jessie Keck](https://github.com/jkeck)
-  * [Mark Matienzo](https://github.com/anarchivist)
-* University of Michigan
-  * [Gordon Leacock](https://github.com/gordonleacock)
+See the [CONTRIBUTORS](CONTRIBUTORS.md) file.
 
 ## Development
 
@@ -86,6 +94,7 @@ Ensure Solr and Rails are _not_ running (ports 8983 and 3000 respectively), then
 ```sh
 $ bundle exec rake
 ```
+If you find that the tests are failing when you run them on a Linux computer, you might need to install Google Chrome so the Selenium testing framework can run properly.
 
 ### Run a development server
 
@@ -112,3 +121,5 @@ To release a new version:
 ## License
 
 The gem is available as open source under the terms of the [Apache 2 License](https://opensource.org/licenses/Apache-2.0).
+
+ArcLight also uses embedded SVG icons from the [FontAwesome](https://fontawesome.com) project. These icons are unmodified and licensed [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). All of these icons have the license and attribution embedded in them.