spotlight-dor-resources 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b86fa8d9250353055a9f68632944a996fa4e0523
+  data.tar.gz: d53448b9b23303463ed7db3c54d7f02bff763739
+SHA512:
+  metadata.gz: 7df884fe6f4617270b56b97dccb83630f6cae9ac2640c6a28d4a7763c702ae1e3b77f4ca300647b952b185fefd577096742ceedd4e17f584b34ffee1068ec676
+  data.tar.gz: a9757073e8b1e7a92df0e2cc39d00ba8df3d028aed15c9f776a907c0b546b19405b08a46535742bd09700819f1e8480c673443ad59e0589912c6ce70beb07608

data/.gitignore

@@ -0,0 +1,23 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+.rvmrc
+.ruby-version
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+.project
+config/initializers/secret_token.rb
+spec/internal
+Gemfile.lock
+jetty

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'spec/internal/**/*'
+    - 'spec/test_app_templates/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,191 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-29 09:20:45 -0700 using RuboCop version 0.34.2.
+# 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: 2
+Metrics/AbcSize:
+  Max: 33
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 102
+
+# Offense count: 84
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 171
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/StringReplacement:
+  Exclude:
+    - 'lib/spotlight/dor/indexer.rb'
+
+# Offense count: 2
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration/gdor_integration_spec.rb'
+    - 'spec/integration/indexer_integration_spec.rb'
+
+# Offense count: 4
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/models/spotlight/resources/purl_spec.rb'
+    - 'spec/models/spotlight/resources/searchworks_spec.rb'
+
+# Offense count: 26
+# Configuration parameters: CustomTransform, IgnoredWords.
+RSpec/ExampleWording:
+  Exclude:
+    - 'spec/integration/gdor_integration_spec.rb'
+    - 'spec/models/spotlight/resources/purl_spec.rb'
+    - 'spec/models/spotlight/resources/searchworks_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Exclude:
+    - 'lib/spotlight/dor/indexer.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 11
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'spec/models/spotlight/resources/purl_spec.rb'
+    - 'spec/models/spotlight/resources/searchworks_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'app/models/spotlight/resources/dor_resource.rb'
+    - 'app/models/spotlight/resources/harvestdor.rb'
+    - 'app/models/spotlight/resources/purl.rb'
+    - 'app/models/spotlight/resources/searchworks.rb'
+    - 'lib/spotlight/dor/indexer.rb'
+    - 'lib/spotlight/dor/resources/engine.rb'
+
+# Offense count: 7
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'app/models/spotlight/resources/dor_resource.rb'
+    - 'app/models/spotlight/resources/purl.rb'
+    - 'app/models/spotlight/resources/searchworks.rb'
+    - 'lib/spotlight/dor/indexer.rb'
+    - 'lib/spotlight/dor/resources.rb'
+    - 'lib/spotlight/dor/resources/engine.rb'
+    - 'lib/spotlight/dor/resources/version.rb'
+
+# Offense count: 2
+Style/DoubleNegation:
+  Exclude:
+    - 'app/models/spotlight/resources/purl.rb'
+    - 'app/models/spotlight/resources/searchworks.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'app/models/spotlight/resources/purl.rb'
+    - 'app/models/spotlight/resources/searchworks.rb'
+    - 'lib/spotlight/dor/resources/engine.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/spotlight/dor/resources.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Exclude:
+    - 'app/models/spotlight/resources/purl.rb'
+    - 'app/models/spotlight/resources/searchworks.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SpaceAfterComma:
+  Exclude:
+    - 'lib/spotlight/dor/indexer.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+Style/SpaceInsideBlockBraces:
+  Enabled: false
+
+# Offense count: 31
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Offense count: 122
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoredMethods.
+Style/SymbolProc:
+  Exclude:
+    - 'lib/spotlight/dor/indexer.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/TrailingBlankLines:
+  Exclude:
+    - 'spec/models/spotlight/resources/searchworks_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+Style/TrailingWhitespace:
+  Exclude:
+    - 'lib/spotlight/dor/resources.rb'
+    - 'spec/models/spotlight/resources/searchworks_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+Style/TrivialAccessors:
+  Exclude:
+    - 'lib/spotlight/dor/indexer.rb'
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/VariableName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.2.2
+
+env:
+  global:
+    - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+sudo: false
+language: ruby
+
+script:
+  - bundle exec rake
+  - bundle exec rake rubocop

data/Gemfile

@@ -0,0 +1,32 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spotlight-dor-resources.gemspec
+gemspec
+
+group :test do
+  gem 'simplecov', '~> 0.10', require: false
+  gem 'coveralls', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'pry', require: false
+  gem 'pry-byebug', require: false
+end
+
+# 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("../spec/internal", __FILE__))
+if File.exist?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+else
+  gem 'rails', ENV['RAILS_VERSION']
+
+  # explicitly include sass-rails to get compatible sprocket dependencies
+  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
+    gem 'sass-rails', '~> 5.0'
+    gem 'responders', "~> 2.0"
+  else
+    gem 'sass-rails', "< 5.0"
+    gem 'coffee-rails', "~> 4.0.0"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 The Board of Trustees of the Leland Stanford Junior University.
+
+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,65 @@
+[![Build Status](https://travis-ci.org/sul-dlss/spotlight-dor-resources.png?branch=master)](https://travis-ci.org/sul-dlss/spotlight-dor-resources) | [![Coverage Status](https://coveralls.io/repos/sul-dlss/spotlight-dor-resources/badge.png?branch=master)](https://coveralls.io/r/sul-dlss/spotlight-dor-resources) | [![Gem Version](https://badge.fury.io/rb/spotlight-dor-resources.png)](http://badge.fury.io/rb/spotlight-dor-resources)
+
+# Spotlight::Dor::Resources
+
+ Harvest Stanford DOR resources into a Spotlight exhibit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spotlight-dor-resources'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spotlight-dor-resources
+
+## Usage
+
+Within a Spotlight application with `spotlight-dor-resources` installed, you could index a set of records the ["gdor-indexer"](https://github.com/sul-dlss/gdor-indexer) way.
+
+Note that Spotlight:
+
+* is a Rails engine and needs to be used in the context of a Rails application. We use [engine_cart](https://github.com/cbeer/engine_cart) to create an internal test application at spec/internal.
+* uses Solr as part of its integration tests. We use [jettywrapper](https://github.com/projecthydra/jettywrapper) to manage the Solr instance used for development and test.
+
+Our `$ rake ci` task utilizes Solr and the testing rails app, with Spotlight installed, automatically.
+
+For access to a Rails console with the gem loaded up for testing purposes, you can use an engine-cart generated Spotlight app.
+
+### First time only configuration for local testing
+
+    $ bundle
+    $ bundle exec rake:ci
+
+This will download a test jetty instance (to run Solr), generate a testing app at ```spec/internal``` and run the tests.
+
+### Indexing with the generated test app
+
+    $ cd spec/internal
+
+    $ bundle exec rails console
+
+```ruby
+purl=Spotlight::Resources::Purl.new({:url=>'https://purl.stanford.edu/cx709ty7769'})
+puts purl.to_solr.first # the solr document as a hash
+public_xml=purl.resource.public_xml # nokogiri doc with all public XML
+mods=purl.resource.mods # nokogiri doc with just the MODs
+smods_rec=purl.resource.smods_rec # a Stanford::Mods::Record Object (which inherits from the MODS gem)
+
+purl.resource.indexer.config.solr.url # the configured solr server (should be localhost in development)
+purl.save # save and index to solr
+purl.reindex # reindex once saved the first time
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/sul-dlss/spotlight-dor-resources/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

data/Rakefile

@@ -0,0 +1,48 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+ZIP_URL = 'https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip'
+
+Bundler::GemHelper.install_tasks
+
+task default: [:ci, :rubocop]
+
+namespace :spotlight do
+  desc 'Copies the default SOLR config for the bundled Testing Server'
+  task :configure_jetty do
+    FileList['solr_conf/conf/*'].each do |f|
+      cp("#{f}", 'jetty/solr/blacklight-core/conf/', verbose: true)
+    end
+  end
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+require 'jettywrapper'
+require 'engine_cart/rake_task'
+task ci: ['engine_cart:generate', 'jetty:clean', 'spotlight:configure_jetty'] do
+  ENV['environment'] = 'test'
+  jetty_params = Jettywrapper.load_config
+  jetty_params[:startup_wait] = 60
+
+  Jettywrapper.wrap(jetty_params) do
+    # run the tests
+    Rake::Task['spec'].invoke
+  end
+end
+
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Spotlight::Dor::Resources'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/models/spotlight/resources/dor_resource.rb

@@ -0,0 +1,17 @@
+module Spotlight::Resources
+  class DorResource < Spotlight::Resource
+    def to_solr
+      return to_enum :to_solr unless block_given?
+
+      base_doc = super
+
+      [resource, (resource.items if resource.collection?)].flatten.compact.each do |res|
+        yield base_doc.merge(Spotlight::Dor::Resources.indexer.solr_document(res))
+      end
+    end
+
+    def resource
+      @resource ||= Spotlight::Dor::Resources.indexer.resource doc_id
+    end
+  end
+end

data/app/models/spotlight/resources/harvestdor.rb

@@ -0,0 +1,4 @@
+module Spotlight::Resources
+  class Harvestdor < Spotlight::Resource
+  end
+end