arclight 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da7dfb3d7dc685b9162a9cfb6f1493eefea226ff
-  data.tar.gz: a353787fa5e7d1db16180272c9c9acb28fde663c
+  metadata.gz: 8e7c36b89eeff34447138302c2d94e7e636fcff9
+  data.tar.gz: 69bd0a266a8f52c56bdca6adf416885bbfe07467
 SHA512:
-  metadata.gz: 2ea749f25b499d904c9609bc2b5733dd92ad78a27640b2f8c90aa0ba478fb9e2d24f36d61e135cc87fcc855faf0024ebbb497deae23cab8ef3f837dfcd7feb18
-  data.tar.gz: 97eaad0541a49445d6bcd41bf52e8a565baf50f3bae66de50c27db6224c2e81f94acdb7aa045f08d096523165fcb679e5b2eae9d322477399384c29af20e8f94
+  metadata.gz: f3d3fba678027f1c08cee5c6e261a71fc44167cf7dbb8e9203cb35780c6de8db447a0f58613f0cac1844ae460d3893ee96d54de4b5533a31d9de6eaf2f2db54f
+  data.tar.gz: 95216eaeba2998d57beafce31831a93172efcbb3ca6d0a196c9fd295f880ac0ad6e9c592c9decbee7ab458ba28181e2bfdc0fbd288c11c8c2591b9a2c640d064

data/.eslintrc

@@ -0,0 +1,12 @@
+{
+  "extends": "airbnb-base/legacy",
+  "globals": {
+    "jQuery": true,
+    "$": true,
+    "Blacklight": true
+  },
+  "rules": {
+    "no-param-reassign": [2, { "props": false }],
+    "func-names": ["error", "never"]
+  }
+}

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.ruby-version
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -10,3 +11,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+.internal_test_app
+
+/node_modules/

data/.rubocop.yml

@@ -0,0 +1,66 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - '.internal_test_app/**/*'
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'lib/generators/arclight/templates/**/*'
+    - 'vendor/**/*'
+  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
+
+Metrics/BlockLength:
+  Exclude:
+    - !ruby/regexp /\.rake$/
+    - 'arclight.gemspec'
+    - 'spec/**/*'
+    - 'lib/arclight/custom_document.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/arclight/custom_document.rb' # arclight_field_definitions too long
+
+Performance/RegexpMatch:
+  Enabled: false
+
+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
+
+RSpec/FilePath:
+  Exclude:
+    - 'spec/lib/arclight/viewers/oembed_spec.rb' # Default file path is o_embed, and that looks weird
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/arclight.rb'
+
+Bundler/DuplicatedGem:
+  Enabled: false

data/.solr_wrapper

@@ -0,0 +1,5 @@
+# Place any default configuration for solr_wrapper here
+# port: 8983
+collection:
+  dir: solr/conf/
+  name: blacklight-core

data/.travis.yml

@@ -1,5 +1,33 @@
 sudo: false
 language: ruby
+notifications:
+  email: false
 rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.14.6
+  - 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"
+
+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"
+
+before_script:
+  - find spec/fixtures/ead -name '*.xml' | xargs xmllint --noout --schema spec/fixtures/xsd/ead.xsd
+addons:
+  apt:
+    sources:
+      - libxml2-utils

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+## Contributing
+
+ArcLight is a collaborative open source project where contributions are welcome. This contributing guide is borrowed in part from the [GeoBlacklight Contributing Guide](https://github.com/geoblacklight/geoblacklight/blob/master/CONTRIBUTING.md).
+
+### Reporting issues
+
+Did you find a bug in ArcLight or interested in a new feature? Please make sure to add an issue for it in the [issue tracker](https://github.com/sul-dlss/arclight/issues) as follows:
+
+ - Make sure you have a [GitHub account](https://github.com/signup/free)
+ - Submit a new [Github issue](https://github.com/sul-dlss/arclight/issues) by:
+    - Clearly describing the issue
+    - Provide a descriptive summary
+    - Explain the expected behavior
+    - Explain the actual behavior
+    - Provide steps to reproduce the actual behavior
+
+### Contributing code or documentation
+
+ArcLight also welcomes code and documentation contributions. We follow the [pull request](https://help.github.com/articles/using-pull-requests/) model for contributing on GitHub.
+
+#### Pull request overview
+
+1. Fork it ( http://github.com/sul-dlss/arclight/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+#### Merging Changes
+
+Here are some general rules to follow for merging pull requests.
+
+- It is considered "poor form" to merge your own request.
+- Please take the time to review the changes and get a sense of what is being changed. Things to consider:
+  - Does the commit message explain what is going on?
+  - Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
+  - Do all new methods, modules, and classes have comments? Do changed methods, modules, and classes have comments?
+  - Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  - Did the Travis tests complete successfully?
+- If you are uncertain, bring other contributors into the conversation by creating a comment that includes their `@username`.
+- If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+If you wish to ask questions or participate further, see our general [README](https://github.com/sul-dlss/arclight/blob/master/README.md).

data/Gemfile

@@ -1,4 +1,40 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in arclight.gemspec
 gemspec
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 1.1.0
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  end
+end
+# END ENGINE_CART BLOCK

data/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright 2017 The Board of Trustees of the Leland Stanford Junior University
+Copyright (c) 2017, Regents of the University of Michigan.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,12 +1,23 @@
+[![Build Status](https://travis-ci.org/sul-dlss/arclight.svg?branch=master)](https://travis-ci.org/sul-dlss/arclight)
+
+[![Coverage Status](https://coveralls.io/repos/github/sul-dlss/arclight/badge.svg?branch=master)](https://coveralls.io/github/sul-dlss/arclight?branch=master)
+
 # Arclight
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/arclight`. To experiment with that code, run `bin/console` for an interactive prompt.
+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.
+
+## Requirements
 
-TODO: Delete this and the text above, and describe your gem
+* [Ruby](https://www.ruby-lang.org/en/) 2.2 or later
+* [Rails](http://rubyonrails.org) 5.0 or later
 
 ## Installation
 
-Add this line to your application's Gemfile:
+[Installing ArcLight](https://github.com/sul-dlss/arclight/wiki/Creating,-installing,-and-running-your-ArcLight-application) is straightforward in a Rails environment.
+
+Basically, add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'arclight'
@@ -14,28 +25,90 @@ gem 'arclight'
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install arclight
+```sh
+$ gem install arclight
+```
+
+For further details, see our [Installing ArcLight](https://github.com/sul-dlss/arclight/wiki/Creating,-installing,-and-running-your-ArcLight-application) documentation.
 
 ## Usage
 
-TODO: Write usage instructions here
+Arclight is a Ruby gem designed to work with archival data. It can be installed on a server or virtual server. Once running, finding aids in the form of archival collection data can be imported into Arclight through an indexing process. Institutional and repositories data can also be added to Arclight (Currently this requires a developer. Configuration pages will be added for this in future versions). Additional finding aids can be added at any time.
+
+After data indexing, Arclight can to be used to search, browse, and display the repositories (sets of collections), collections, and components within collections. Globally available search allows filtering on several types of terms (Keyword, Name, Place, etc.). Once a search is begun, it can be further narrowed using facets on the left side of the search page. Selecting a search result goes directly to that results show or display page. Also global available are buttons for Repositories and Collections which can be used an any time.
+
+Browsing allows you to view the Overview or Contents (when it exists) of a collection. The Overview tab displays top level metadata about the collection. The Contents tab displays an outline view of a next level of the collection. You can expand each level by selecting (clicking). Selecting a component in the Contents views goes to a component page which shows the metadata for it.
+
+Some pages include an inline view tab to the right of an item which will expand the Contents further.
+
+See the [ArcLight demo](https://arclight-demo.projectblacklight.org/) and [ArcLight MVP Wiki](https://github.com/sul-dlss/arclight/wiki) for usage.
+
+See [Arclight Major Features](https://github.com/sul-dlss/arclight/wiki/Arclight-Major-Features) for a list of features.
+
+## 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)
+  * [Blacklight wiki](https://github.com/projectblacklight/blacklight/wiki)
+
+## ArcLight MVP Development team
+
+* 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 Michagan
+  * [Gordon Leacock](https://github.com/gordonleacock)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+ArcLight development uses [`solr_wrapper`](https://rubygems.org/gems/solr_wrapper/versions/0.18.1) and [`engine_cart`](https://rubygems.org/gems/engine_cart) to host development instances of Solr and Rails server on your local machine.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Run the test suite
 
-## Contributing
+Ensure Solr and Rails are _not_ running (ports 8983 and 3000 respectively), then:
+
+```sh
+$ bundle exec rake
+```
+
+### Run a development server
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/arclight.
+```sh
+$ bundle exec rake arclight:server
+```
 
+Then visit http://localhost:3000. It will also start a Solr instance on port 8983.
 
-## License
+### Run a console
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Release a new version of the gem
+
+To release a new version:
+
+1. Update the version number in `lib/arclight/version.rb`
+2. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, build the gem file (e.g., `gem build arclight.gemspec`) and push the `.gem` file to [rubygems.org](https://rubygems.org) (e.g., `gem push arclight-x.y.z.gem`).
+
+## Contributing
+
+[Bug reports](https://github.com/sul-dlss/arclight/issues) and [pull requests](https://github.com/sul-dlss/arclight/pulls) are welcome on ArcLight -- see [CONTRIBUTING.md](https://github.com/sul-dlss/arclight/blob/master/CONTRIBUTING.md) for details.
+## License
 
+The gem is available as open source under the terms of the [Apache 2 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -1,6 +1,17 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+Dir.glob('./tasks/*.rake').each { |f| load f }
+Dir.glob('./lib/tasks/*.rake').each { |f| load f }
+
+require 'engine_cart/rake_task'
+require 'solr_ead'
+
+task default: %i[rubocop eslint ci]

data/app/assets/images/blacklight/compact.svg

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="16px" height="16px" viewBox="0 0 16 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 44.1 (41455) - http://www.bohemiancoding.com/sketch -->
+    <title>Compact</title>
+    <desc>Created with Sketch.</desc>
+    <defs></defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" stroke-linecap="square">
+        <g id="Compact" stroke="#000000">
+            <path d="M1.43885093,2.44444444 L6.83349609,2.44444444" id="Line"></path>
+            <path d="M1.43885093,4.44444444 L6.83349609,4.44444444" id="Line"></path>
+            <path d="M1.43885093,6.44444444 L6.83349609,6.44444444" id="Line"></path>
+            <path d="M1.43885093,8.44444444 L6.83349609,8.44444444" id="Line"></path>
+            <path d="M1.43885093,10.4444444 L6.83349609,10.4444444" id="Line"></path>
+            <path d="M1.43885093,12.4444444 L6.83349609,12.4444444" id="Line"></path>
+            <path d="M1.43885093,14.4444444 L6.83349609,14.4444444" id="Line"></path>
+            <path d="M9.43885093,2.44444444 L14.8334961,2.44444444" id="Line"></path>
+            <path d="M9.43885093,4.44444444 L14.8334961,4.44444444" id="Line"></path>
+            <path d="M9.43885093,6.44444444 L14.8334961,6.44444444" id="Line"></path>
+            <path d="M9.43885093,8.44444444 L14.8334961,8.44444444" id="Line"></path>
+            <path d="M9.43885093,10.4444444 L14.8334961,10.4444444" id="Line"></path>
+            <path d="M9.43885093,12.4444444 L14.8334961,12.4444444" id="Line"></path>
+            <path d="M9.43885093,14.4444444 L14.8334961,14.4444444" id="Line"></path>
+        </g>
+    </g>
+</svg>

data/app/assets/javascripts/arclight/arclight.js

@@ -0,0 +1,9 @@
+//= require arclight/collection_scrollspy
+//= require arclight/collection_navigation
+//= require arclight/collection_context
+//= require arclight/component_ancestors
+//= require arclight/oembed_viewer
+//= require arclight/truncator
+
+// Vendor Scripts
+//= require responsiveTruncator

data/app/assets/javascripts/arclight/collection_context.js

@@ -0,0 +1,18 @@
+Blacklight.onLoad(function () {
+  'use strict';
+
+  $('[data-arclight-collection-context="true"]').each(function (i, element) {
+    var $el = $(element);
+    var data = $el.data();
+    $.ajax({
+      url: data.arclightCollectionContextUrl
+    }).done(function (response) {
+      var resp = $.parseHTML(response);
+      var $doc = $(resp);
+      var link = $('<a></a>').attr('href', data.arclightCollectionContextUrl);
+      var addedSection = $doc.find('.al-show-header-section');
+      addedSection.find('h1').wrapInner(link);
+      $el.hide().html(addedSection).fadeIn(500);
+    });
+  });
+});