hydra-works 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc76ae65e10c75f045b933e2b8de237292821b2d
-  data.tar.gz: 20c76bd9fb5e0002a74f279efa932ab0685618e5
+  metadata.gz: 56fe0f1919fdd32fe127f5d3e0fc759eb781d74d
+  data.tar.gz: a6f9183d56fd7911150ca4ce152bb5280471135c
 SHA512:
-  metadata.gz: 7e97285baab41bb01e5ab16541057e6a50fee7630eb48daeb92eb8d7d64ef3cfd50878520533e1ee7e34fe6b5f74b8ad015b7756a99661aa9cd234bdbc0401e6
-  data.tar.gz: 35363e268e45beaf3331bd7976ad99b8a269850e8a51ef4c00380f98b6f9b8e9526fc3244a59ceb8f79fc0a51b9d36e3ebbe13bb3853f461d0396370a035b911
+  metadata.gz: 98a261ed13442400b6f41cb607d4b32e0f9fe8297ddd463d919ee1b69e19cb5704c1d41659566ad0f77b2f521b3ec140f3990b7eddc8b78af203bafbfc562eff
+  data.tar.gz: 65a823283ea04b931451b685c8dc19bed6b666ea18199cc7a23c6140e463c243c2eb6b1afa5b47e8df18b2eea0d4839acb632eaf2df3d6ff812162d94169d3e3

data/.gitignore

@@ -15,6 +15,7 @@ spec/internal
 *.a
 mkmf.log
 jetty
+fcrepo4-data
 .DS_Store
 .ruby-gemset
-.ruby-version
+.ruby-version

data/.rubocop.yml

@@ -1,7 +1,6 @@
 require: rubocop-rspec
 
 AllCops:
-  RunRailsCops: true
   DisplayCopNames: true
   Include:
     - '**/Rakefile'

data/README.md

@@ -11,9 +11,9 @@
 
 The Hydra::Works gem provides a set of [Portland Common Data Model](https://github.com/duraspace/pcdm/wiki)-compliant ActiveFedora models and associated behaviors around the broad concept of multi-file "works", the need for which was expressed by a variety of [community use cases](https://github.com/projecthydra-labs/hydra-works/tree/master/use-cases). The Hydra::Works domain model includes:
 
- * **FileSet**: a *Hydra::PCDM::Object* that encapsulates one or more directly related *Hydra::PCDM::File*s, such as a PDF document, its derivatives, and extracted full-text
- * **GenericWork**: a *Hydra::PCDM::Object* that holds zero or more **FileSets**s and zero or more **Work**s (often you won't use GenericWork, but instead write your own Work class)
- * **Collection**: a *Hydra::PCDM::Collection* that indirectly contains zero or more **Work**s and zero or more **Collection**s
+ * **FileSet**: a *Hydra::PCDM::Object* that encapsulates one or more directly related *Hydra::PCDM::Files*, such as a PDF document, its derivatives, and extracted full-text
+ * **Work**: a *Hydra::PCDM::Object* that holds zero or more **FileSets** and zero or more **Works** (often you won't use Work directly, but instead write your own class that mixes in `Hydra::Works::WorkBehavior`)
+ * **Collection**: a *Hydra::PCDM::Collection* that indirectly contains zero or more **Works** and zero or more **Collection**s
 
 View [a diagram of the domain model](https://docs.google.com/drawings/d/1-NkkRPpGpZGoTimEpYTaGM1uUPRaT0SamuWDITvtG_8/edit).
 
@@ -51,12 +51,13 @@ class Page < ActiveFedora::Base
 end
 
 collection = Collection.create
-book = BookWork.create
+book = Book.create
 page = Page.create
 
-collection.works << book
+collection.members << book
 collection.save
-book.generic_files << page
+
+book.members << page
 book.save
 
 file = page.files.build
@@ -73,7 +74,7 @@ To turn on virus detection, install clamav on your system and add the `clamav` g
 Then include the `VirusCheck` module in your `FileSet` class:
 
 ```ruby
-class BookFiles < ActiveFedora::Base
+class Page < ActiveFedora::Base
   include Hydra::Works::FileSetBehavior
   include Hydra::Works::VirusCheck
 end
@@ -92,10 +93,9 @@ If you'd like to contribute to this effort, please check out the [contributing g
 To set up for running the test suite, you need a copy of jetty
 
     $ rake jetty:clean
-    $ rake jetty:config
+    $ rake hydra_works:jetty:config
 
 To run the test suite, generate the test app (which goes into spec/internal) and start jetty (if it's not already running)
 
-    $ rails engine_cart:generate
     $ rake jetty:start
     $ rake spec

data/Rakefile

@@ -1,11 +1,9 @@
 require 'bundler/gem_tasks'
-require 'jettywrapper'
 require 'rspec/core'
 require 'rspec/core/rake_task'
-require 'engine_cart/rake_task'
 require 'rubocop/rake_task'
-
-Dir.glob('lib/tasks/*.rake').each { |r| import r }
+require 'solr_wrapper'
+require 'fcrepo_wrapper'
 
 desc 'Run style checker'
 RuboCop::RakeTask.new(:rubocop) do |task|
@@ -19,15 +17,17 @@ task :spec do
   RSpec::Core::RakeTask.new(:spec)
 end
 
-desc 'Spin up hydra-jetty and run specs'
-task ci: ['jetty:clean', 'jetty:config'] do
-  puts 'running continuous integration'
-  jetty_params = Jettywrapper.load_config
-  jetty_params[:startup_wait] = 90
-  error = Jettywrapper.wrap(jetty_params) do
-    Rake::Task['spec'].invoke
+desc 'Spin up Solr & Fedora and run the test suite'
+task :ci do
+  solr_params = { port: 8983, verbose: true, managed: true }
+  fcrepo_params = { port: 8984, verbose: true, managed: true }
+  SolrWrapper.wrap(solr_params) do |solr|
+    solr.with_collection(name: 'hydra-test', dir: File.join(File.expand_path('.', File.dirname(__FILE__)), 'solr', 'config')) do
+      FcrepoWrapper.wrap(fcrepo_params) do
+        Rake::Task['spec'].invoke
+      end
+    end
   end
-  fail "test failures: #{error}" if error
 end
 
 task default: :ci

data/hydra-works.gemspec

@@ -18,16 +18,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'hydra-pcdm', '~> 0.3'
+  spec.add_dependency 'hydra-pcdm', '~> 0.4'
   spec.add_dependency 'hydra-derivatives', '~> 3.0'
   spec.add_dependency 'hydra-file_characterization', '~> 0.3', '>= 0.3.3'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec-rails', '~> 3.1'
-  spec.add_development_dependency 'engine_cart', '~> 0'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'jettywrapper', '>= 2.0.0'
+  spec.add_development_dependency 'solr_wrapper', '~> 0.4'
+  spec.add_development_dependency 'fcrepo_wrapper', '~> 0.1'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rspec'
 end

data/lib/hydra/works/models/characterization/fits_datastream.rb

@@ -100,7 +100,7 @@ module Hydra::Works::Characterization
       t.copyright_note(proxy: [:fileinfo, :copyright_note])
       t.well_formed(proxy: [:filestatus, :well_formed])
       t.valid(proxy: [:filestatus, :valid])
-      t.status_message(proxy: [:filestatus, :status_message])
+      t.filestatus_message(proxy: [:filestatus, :status_message])
       t.file_title(proxy: [:metadata, :document, :file_title])
       t.file_author(proxy: [:metadata, :document, :file_author])
       t.page_count(proxy: [:metadata, :document, :page_count])

data/lib/hydra/works/models/work.rb

@@ -1,5 +1,8 @@
 module Hydra::Works
-  # Namespace for Modules with functionality specific to Works
+  # Typically used for very generic applications that don't differentiate
+  # between specific content types. If you want a specific type of work
+  # extend ActiveFedora::Base and include the following:
+  #   include Hydra::Works::WorkBehavior
   class Work < ActiveFedora::Base
     include Hydra::Works::WorkBehavior
   end

data/lib/hydra/works/services/add_file_to_file_set.rb

@@ -8,7 +8,7 @@ module Hydra::Works
     # @param [Boolean] versioning whether to create new version entries (only applicable if +type+ corresponds to a versionable file)
 
     def self.call(file_set, file, type, update_existing: true, versioning: true)
-      fail ArgumentError, 'supplied object must be a generic file' unless file_set.file_set?
+      fail ArgumentError, 'supplied object must be a file set' unless file_set.file_set?
       fail ArgumentError, 'supplied file must respond to read' unless file.respond_to? :read
 
       # TODO: required as a workaround for https://github.com/projecthydra/active_fedora/pull/858
@@ -71,13 +71,13 @@ module Hydra::Works
         # @param object for original name to be determined. Attempts to use methods: :original_name, :original_filename, and :path.
         def determine_original_name(file)
           if file.respond_to? :original_name
-            return file.original_name
+            file.original_name
           elsif file.respond_to? :original_filename
-            return file.original_filename
+            file.original_filename
           elsif file.respond_to? :path
-            return ::File.basename(file.path)
+            ::File.basename(file.path)
           else
-            return ''
+            ''
           end
         end
 

data/lib/hydra/works/services/characterization_service.rb

@@ -105,8 +105,8 @@ module Hydra::Works
       def property_for(term)
         if mapping.key?(term) && object.respond_to?(mapping[term])
           mapping[term]
-        else
-          term if object.respond_to?(term)
+        elsif object.respond_to?(term)
+          term
         end
       end
 

data/lib/hydra/works/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Works
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'.freeze
   end
 end

data/lib/hydra/works.rb

@@ -27,7 +27,7 @@ module Hydra
     autoload_under 'models' do
       autoload :Collection
       autoload :FileSet
-      autoload :GenericWork
+      autoload :Work
     end
 
     autoload_under 'models/concerns' do

data/solr/config/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}

data/solr/config/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/solr/config/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>

data/solr/config/mapping-ISOLatin1Accent.txt

@@ -0,0 +1,246 @@
+# The ASF licenses this file to You 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.
+
+# Syntax:
+#   "source" => "target"
+#     "source".length() > 0 (source cannot be empty.)
+#     "target".length() >= 0 (target can be empty.)
+
+# example:
+#   "??" => "A"
+#   "\u00C0" => "A"
+#   "\u00C0" => "\u0041"
+#   "??" => "ss"
+#   "\t" => " "
+#   "\n" => ""
+
+# ?? => A
+"\u00C0" => "A"
+
+# ?? => A
+"\u00C1" => "A"
+
+# ?? => A
+"\u00C2" => "A"
+
+# ?? => A
+"\u00C3" => "A"
+
+# ?? => A
+"\u00C4" => "A"
+
+# ?? => A
+"\u00C5" => "A"
+
+# ?? => AE
+"\u00C6" => "AE"
+
+# ?? => C
+"\u00C7" => "C"
+
+# ?? => E
+"\u00C8" => "E"
+
+# ?? => E
+"\u00C9" => "E"
+
+# ?? => E
+"\u00CA" => "E"
+
+# ?? => E
+"\u00CB" => "E"
+
+# ?? => I
+"\u00CC" => "I"
+
+# ?? => I
+"\u00CD" => "I"
+
+# ?? => I
+"\u00CE" => "I"
+
+# ?? => I
+"\u00CF" => "I"
+
+# ?? => IJ
+"\u0132" => "IJ"
+
+# ?? => D
+"\u00D0" => "D"
+
+# ?? => N
+"\u00D1" => "N"
+
+# ?? => O
+"\u00D2" => "O"
+
+# ?? => O
+"\u00D3" => "O"
+
+# ?? => O
+"\u00D4" => "O"
+
+# ?? => O
+"\u00D5" => "O"
+
+# ?? => O
+"\u00D6" => "O"
+
+# ?? => O
+"\u00D8" => "O"
+
+# ?? => OE
+"\u0152" => "OE"
+
+# ??
+"\u00DE" => "TH"
+
+# ?? => U
+"\u00D9" => "U"
+
+# ?? => U
+"\u00DA" => "U"
+
+# ?? => U
+"\u00DB" => "U"
+
+# ?? => U
+"\u00DC" => "U"
+
+# ?? => Y
+"\u00DD" => "Y"
+
+# ?? => Y
+"\u0178" => "Y"
+
+# ?? => a
+"\u00E0" => "a"
+
+# ?? => a
+"\u00E1" => "a"
+
+# ?? => a
+"\u00E2" => "a"
+
+# ?? => a
+"\u00E3" => "a"
+
+# ?? => a
+"\u00E4" => "a"
+
+# ?? => a
+"\u00E5" => "a"
+
+# ?? => ae
+"\u00E6" => "ae"
+
+# ?? => c
+"\u00E7" => "c"
+
+# ?? => e
+"\u00E8" => "e"
+
+# ?? => e
+"\u00E9" => "e"
+
+# ?? => e
+"\u00EA" => "e"
+
+# ?? => e
+"\u00EB" => "e"
+
+# ?? => i
+"\u00EC" => "i"
+
+# ?? => i
+"\u00ED" => "i"
+
+# ?? => i
+"\u00EE" => "i"
+
+# ?? => i
+"\u00EF" => "i"
+
+# ?? => ij
+"\u0133" => "ij"
+
+# ?? => d
+"\u00F0" => "d"
+
+# ?? => n
+"\u00F1" => "n"
+
+# ?? => o
+"\u00F2" => "o"
+
+# ?? => o
+"\u00F3" => "o"
+
+# ?? => o
+"\u00F4" => "o"
+
+# ?? => o
+"\u00F5" => "o"
+
+# ?? => o
+"\u00F6" => "o"
+
+# ?? => o
+"\u00F8" => "o"
+
+# ?? => oe
+"\u0153" => "oe"
+
+# ?? => ss
+"\u00DF" => "ss"
+
+# ?? => th
+"\u00FE" => "th"
+
+# ?? => u
+"\u00F9" => "u"
+
+# ?? => u
+"\u00FA" => "u"
+
+# ?? => u
+"\u00FB" => "u"
+
+# ?? => u
+"\u00FC" => "u"
+
+# ?? => y
+"\u00FD" => "y"
+
+# ?? => y
+"\u00FF" => "y"
+
+# ??? => ff
+"\uFB00" => "ff"
+
+# ??? => fi
+"\uFB01" => "fi"
+
+# ??? => fl
+"\uFB02" => "fl"
+
+# ??? => ffi
+"\uFB03" => "ffi"
+
+# ??? => ffl
+"\uFB04" => "ffl"
+
+# ??? => ft
+"\uFB05" => "ft"
+
+# ??? => st
+"\uFB06" => "st"

data/solr/config/protwords.txt

@@ -0,0 +1,21 @@
+# The ASF licenses this file to You 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.
+
+#-----------------------------------------------------------------------
+# Use a protected word file to protect against the stemmer reducing two
+# unrelated words to the same base word.
+
+# Some non-words that normally won't be encountered,
+# just to test that they won't be stemmed.
+dontstems
+zwhacky
+