warclight 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a490a534549e6f25e2ec78306e1d9e1fba105b9a
+  data.tar.gz: 5af34c38dfcc2e36232cfeeb8bf860b960da0f04
+SHA512:
+  metadata.gz: 72004ef5451f292f2c2f5689de959ce09a39b0c939bf8e0e6979a09a74379a263eaadb9d9a73b0b3ae3482fbda05fd74721957eaf25765f90654a1c9fc37e248
+  data.tar.gz: b0c5cd52cca6f885ede22fd0bd28df60b7f3989bf83121e39c85b95fdab9980566d0fd6c668b384f6d2c6788f4408e6c54ca4ba3e9f3f05510eec8ce3052af4d

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

@@ -0,0 +1,19 @@
+/.bundle/
+/.ruby-version
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/spec/reports/
+/tmp/
+log/*.log
+pkg/
+
+# rspec failure tracking
+.rspec_status
+rspec_status
+
+.internal_test_app
+
+/node_modules/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,66 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - '.internal_test_app/**/*'
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'lib/generators/warclight/templates/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+
+Rails:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'Gemfile'
+    - 'lib/warclight/custom_document.rb'  # XPaths get long
+    - 'lib/warclight/custom_component.rb' # XPaths get long
+
+Metrics/ModuleLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - !ruby/regexp /\.rake$/
+    - 'warclight.gemspec'
+    - 'spec/**/*'
+    - 'lib/warclight/custom_document.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/warclight/custom_document.rb' # warclight_field_definitions too long
+
+Performance/RegexpMatch:
+  Enabled: false
+
+Rails/OutputSafety:
+  Exclude:
+    - 'app/controllers/concerns/warclight/field_config_helpers.rb' # html_safe needs to be called to mimic BL JOIN behavior
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Exclude:
+    - 'spec/lib/warclight/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/warclight.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

@@ -0,0 +1,31 @@
+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"
+
+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"
+
+notifications:
+  email: false
+  slack:
+    secure: 1iYPmf/YSm31fZTPiM4OxG/Ii9H8J1eE/jNN0eCnA4wYPGh3SaoeCw9GpsnGWZ4wSuXUdRmGn5s5BFfTCp1RVcjJSo2TZnhhdIAavWlhmgnrdInQdXfZNfTKE7xCCAW+rW4pjrZZorEAGTYPNXV39AyNDMUsGF0sAnjM56ODXa93Xy+1+enIP95Pprxnqk2usxOlsLoQkVthMTFGgche5W1yEqY/rZxyIl3Q0YacVZpEzmPwsFG/Vgq7Vl8iLNcDzngNYeGmmomlR9WOw/DyHSag6FDb2AE1crXlx7yrBsbSo0sFKmDaJvjJrIDY2wkq/M75vMPwiOjzXVcXE1Tj1+LzJ1fbjEaEIoXwLGXtnSUC2u96je0iJSeudTLc2J7ah6vdec4H/tUPjXv9QLbKrP5xQlFItaks4J8DHVNUe22vVyFg6VVs5ZBkOqzwLH0Bj12vRKlW+P7xDF0mKYZRqigLeTqWJEpMRozlBycUXpdCxL2JVbzDd6q57mq67YPhVo5HNIlBfPt8nYlfx1gXJeyMj/cBu3sQSXsKXff6h+wjLUFsSO1il95BulrpRFO8THGOIJHsJlwgE11c+/3DZCU/lHYMY+XfS6qhoDWgKqhDl/8wie/THtaWX+VOEDxRdCES1GTn2x+R/jN6wp02zBPGsTASDCY0UXwQXv3ENB4=

data/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Welcome!
+
+If you are reading this document then you are interested in contributing Warclight. All contributions are welcome: use-cases, documentation, code, ptatches, bug reports, feature requests, etc. You do not need to be a programmer to speak up!
+
+### Use cases
+
+If you would like to submit a use case for Warclight, please submit and issue [here](https://github.com/archivesunleashed/warclight/issues/new), and begin the issue title with "Use Case:".
+
+### Documentation
+
+You can contribute documentation in two different ways. One way is to create an issue [here](https://github.com/archivesunleashed/warclight/issues/new) and begin the issue title with "Documentation:".
+
+### Request a new feature
+
+To request a new feature you should [open an issue](https://github.com/archivesunleashed/warclight/issues/new) or create a use case as described above (see _use case_ section above), and summarize the desired functionality. Begin the issue title with "Enhancement:".
+
+### Report a bug
+
+To report a bug you should [open an issue](https://github.com/archivesunleashed/warclight/issues/new) that summarizes the bug, and begin the issue title with "Bug".
+
+In order to help us understand and fix the bug it would be great if you could provide us with:
+
+1. The steps to reproduce the bug. This includes information about e.g. The Warclight version you were using.
+2. The expected behavior.
+3. The actual, incorrect behavior.
+
+Feel free to search the issue queue for existing issues (aka tickets) that already describe the problem; if there is such a ticket please add your information as a comment.
+
+### Contribute code
+
+_If you are interested in contributing code to Warclight but do not know where to begin:_
+
+In this case you should [browse open issues](https://github.com/archivesunleashed/warclight/issues).
+
+Contributions to Warclight codebase should be sent as GitHub pull requests. See section _Create a pull request_ below for details. If there is any problem with the pull request we can work through it using the commenting features of GitHub.
+
+* For _small patches_, feel free to submit pull requests directly for those patches.
+* For _larger code contributions_, please use the following process. The idea behind this process is to prevent any wasted work and catch design issues early on.
+
+    1. [Open an issue](https://github.com/archivesunleashed/warclight/issues), if a similar issue does not exist already. If a similar issue does exist, then you may consider participating in the work on the existing issue.
+    2. Comment on the issue with your plan for implementing the issue. Explain what pieces of the codebase you are going to touch and how everything is going to fit together.
+    3. The Warclight committers will work with you on the design to make sure you are on the right track.
+    4. Implement your issue, create a pull request (see below), and iterate from there.
+
+### Create a pull request
+
+Take a look at [Creating a pull request](https://help.github.com/articles/creating-a-pull-request). In a nutshell you need to:
+
+1. [Fork](https://help.github.com/articles/fork-a-repo) the Warclight GitHub repository at [https://github.com/archivesunleashed/warclight](https://github.com/archivesleashed/warclight) to your personal GitHub account.
+2. Commit any changes to your fork.
+3. Send a [pull request](https://help.github.com/articles/creating-a-pull-request) to Warclight GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a [bug/issue](https://github.com/archivesunleashed/aut/issues) earlier -- prefix the title of your pull request with the corresponding issue number (e.g. `issue-123: ...`). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from.
+
+You may want to read [Syncing a fork](https://help.github.com/articles/syncing-a-fork) for instructions on how to keep your fork up to date with the latest changes of the upstream (official) `aut` repository.

data/Gemfile

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'codecov', require: false, group: :test
+
+# Declare your gem's dependencies in warclight.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

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,79 @@
+# Warclight
+[![Build Status](https://travis-ci.org/archivesunleashed/warclight.svg?branch=master)](https://travis-ci.org/archivesunleashed/warclight)
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![LICENSE](https://img.shields.io/badge/license-Apache-blue.svg?style=flat-square)](./LICENSE.txt)
+[![codecov](https://codecov.io/gh/archivesunleashed/warclight/branch/master/graph/badge.svg)](https://codecov.io/gh/archivesunleashed/warclight)
+
+A Rails engine supporting the discovery of web archives.
+
+## Requirements
+
+* [Ruby](https://www.ruby-lang.org/en/) 2.2 or later
+* [Rails](http://rubyonrails.org) 5.1.2 or later
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'warclight'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install warclight
+```
+
+## Usage
+
+Warclight is designed to work with web archive data that is indexed via the UK Web Archive's [webarchive-discovery](webarchive-discovery) project.
+
+## Development
+
+Warclight 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.
+
+### Run the test suite
+
+Ensure Solr and Rails are _not_ running (ports 8983 and 3000 respectively), then:
+
+```sh
+$ bundle exec rake
+```
+
+### Run a development server
+
+```sh
+$ bundle exec rake warclight:server
+```
+
+Then visit http://localhost:3000. It will also start a Solr instance on port 8983.
+
+### Run a console
+
+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/warclight/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 warclight.gemspec`) and push the `.gem` file to [rubygems.org](https://rubygems.org) (e.g., `gem push warclight-x.y.z.gem`).
+
+## Contributing
+
+[Bug reports](https://github.com/archivesunleashed/warclight/issues) and [pull requests](https://github.com/archivesunleashed/warclight/pulls) are welcome on WarcLight -- see [CONTRIBUTING.md](https://github.com/archivesunleashed/warclight/blob/master/CONTRIBUTING.md) for details.
+
+## License
+
+The gem is available as open source under the terms of the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+## Acknowledgments
+
+This work is primarily supported by the [Andrew W. Mellon Foundation](https://uwaterloo.ca/arts/news/multidisciplinary-project-will-help-historians-unlock). Any opinions, findings, and conclusions or recommendations expressed are those of the researchers and do not necessarily reflect the views of the sponsors.
+
+This project drew inspiration from the [Arclight](https://github.com/sul-dlss/arclight), and would like to thank those creators and contributors.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(: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'
+
+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/warclight/oembed_viewer.js

@@ -0,0 +1,39 @@
+Blacklight.onLoad(function () {
+  'use strict';
+  var onlineContentTabSelector = '[data-arclight-online-content-tab="true"]';
+  var oEmbedViewerSelector = '[data-arclight-oembed="true"]';
+
+  $(onlineContentTabSelector).on('shown.bs.tab', function() {
+    var $viewerElements = $(oEmbedViewerSelector);
+    if($viewerElements.length === 0) {
+      return;
+    }
+
+    $viewerElements.each(function (i, element) {
+      var $el = $(element);
+      var data = $el.data();
+      var resourceUrl = data.arclightOembedUrl;
+      $.ajax({
+        url: resourceUrl,
+        dataType: 'html'
+      }).done(function (response) {
+        var links = $('<div>' + response.match(/<link .*>/g).join('') + '</div>'); // Parse out link elements so image assets are not loaded
+        var oEmbedEndPoint = links.find('link[rel="alternate"][type="application/json+oembed"]').prop('href');
+
+        if(!oEmbedEndPoint || oEmbedEndPoint.length === 0) {
+          return;
+        }
+
+        $.ajax({
+          url: oEmbedEndPoint
+        }).done(function (oEmbedResponse) {
+          if(oEmbedResponse.html) {
+            $el.hide()
+               .html(oEmbedResponse.html)
+               .fadeIn(500);
+          }
+        });
+      });
+    });
+  });
+});

data/app/assets/javascripts/warclight/warclight.js

@@ -0,0 +1,4 @@
+//= require warclight/oembed_viewer
+
+// Vendor Scripts
+//= require responsiveTruncator

data/app/assets/stylesheets/warclight/application.scss

@@ -0,0 +1 @@
+/* Warclight application scss */

data/app/assets/stylesheets/warclight/warclight.scss

@@ -0,0 +1 @@
+/* warclight specific scss */