hydra-works 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6c159583f12e0a02124bcf92dce3d86fc33736a
+  data.tar.gz: 182817aa5b0783ec5f25ff9491c31c1cb69816f1
+SHA512:
+  metadata.gz: f644d698b6e0d8a4260b4b42b45abf73ac69b8bdd85b837570edde1ff2d4e00c9520c0e9f3fc2b631b465a74f1643aeca55224ddf444cf74d3dce77de78e10d8
+  data.tar.gz: 1db7afa2cfdc7635f96f86f2d64664cfac6123ec0dd73714bb6540783af845ecf4ed9484a0fff632d3afa9bb75151e8fc4a6885ddfa4f34cff89ef0ac19ca964

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+spec/internal
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+jetty
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+sudo: false
+bundler_args: --without debug
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+rvm:
+  - 2.1
+  - 2.2
+  - jruby-19mode
+matrix:
+  allow_failures:
+      - rvm: jruby-19mode

data/CONTRIBUTING.md

@@ -0,0 +1,115 @@
+# How to Contribute
+
+We want your help to make Project Hydra great.
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+
+## Hydra Project Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
+If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+
+https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+
+You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Submitting Changes
+* Merging Changes
+
+### Reporting Issues
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a [Github issue](./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
+
+### Making Changes
+
+* Fork the repository on GitHub
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
+  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
+  * Please avoid working directly on the `master` branch.
+  * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
+* Make commits of logical units.
+  * Your commit should include a high level description of your work in HISTORY.textile 
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_with Post.limit(10)
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters
+```
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+* When you are ready to submit a pull request
+
+### Submitting Changes
+
+* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
+* Make sure your branch is up to date with its parent branch (i.e. master)
+  * `git checkout master`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * It is likely a good idea to run your tests again.
+* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
+  * [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+  * `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l`
+  * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request from your fork to the project.
+
+### Merging Changes
+
+* It is considered "poor from" 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_
+  * 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.
+
+## New Developers
+A great way to get new developers involved and to learn the process is to have them go through the Hierarchy of Promises and create a pull request to improve it.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
+* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hydra-works.gemspec
+gemspec
+
+gem 'activefedora-aggregation', github: 'projecthydra-labs/activefedora-aggregation'
+gem 'active-fedora', github: 'projecthydra/active_fedora', branch: 'master'
+gem 'slop', '~> 3.6' # For byebug
+
+unless ENV['CI']
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'byebug'
+end

data/LICENSE

@@ -0,0 +1,16 @@
+##########################################################################
+#
+# Copyright 2014 University of Notre Dame, Northwestern University, and Data Curation Experts
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# 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,80 @@
+# Hydra::Works
+[![Build Status](https://travis-ci.org/projecthydra-labs/hydra-works.svg?branch=master)](https://travis-ci.org/projecthydra-labs/hydra-works)
+[![Coverage Status](https://coveralls.io/repos/projecthydra-labs/hydra-works/badge.svg?branch=master)](https://coveralls.io/r/projecthydra-labs/hydra-works?branch=master)
+
+The Hydra::Works gem provides a set of [Portland Common Data Model](https://wiki.duraspace.org/display/FF/Portland+Common+Data+Model)-compliant 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:
+
+ * **GenericFile**: a *pcdm:Object* that encapsulates one or more directly related *pcdm:File*s, such as a PDF document, its derivatives, and extracted full-text
+ * **GenericWork**: a *pcdm:Object* that holds zero or more **GenericFile**s and zero or more **GenericWork**s
+ * **Collection**: a *pcdm:Collection* that indirectly contains zero or more **GenericWork**s and zero or more **Collection**s
+
+View [a diagram of the domain model](https://docs.google.com/drawings/d/1-NkkRPpGpZGoTimEpYTaGM1uUPRaT0SamuWDITvtG_8/edit).
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+    # hydra-pcdm requires an unreleased version of ActiveFedora
+    gem 'active-fedora', github: 'projecthydra/active_fedora'
+    gem 'hydra-pcdm', github: 'projecthydra-labs/hydra-pcdm'
+    gem 'hydra-works', github: 'projecthydra-labs/hydra-works'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself:
+
+    $ gem install hydra-works
+
+## Usage
+
+Usage involves extending the behavior provided by this gem. In your application, you can create Hydra::Works-based models like so:
+
+```ruby
+class Collection < ActiveFedora::Base
+  include Hydra::Works::CollectionBehavior
+end
+
+class BookWork < ActiveFedora::Base
+  include Hydra::Works::GenericWorkBehavior
+end
+
+class BookFiles < ActiveFedora::Base
+  include Hydra::Works::GenericFileBehavior
+end
+
+c1 = Collection.create
+bw1 = BookWork.create
+bf1 = BookFiles.create
+
+Hydra::Works::AddGenericWorkToCollection(c1,bw1)
+Hydra::Works::AddGenericFileToGenericWork(bw1,bf1)
+c1.save
+bw1.save
+bf1.save
+
+f1 = bf1.files.build
+f1.content = "The quick brown fox jumped over the lazy dog."
+bf1.save
+```
+
+## Access controls
+
+We are using [Web ACL](http://www.w3.org/wiki/WebAccessControl) as implemented by [hydra-access-controls](https://github.com/projecthydra/hydra-head/tree/master/hydra-access-controls).
+
+## How to contribute
+
+If you'd like to contribute to this effort, please check out the [Contributing Guide](CONTRIBUTING.md)
+
+## Development
+
+To set up for running the test suite, you need a copy of jetty
+
+    $ rake jetty:clean
+
+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

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require 'jettywrapper'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'engine_cart/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+Jettywrapper.hydra_jetty_version = "master"
+
+desc 'Spin up hydra-jetty and run specs'
+task ci: ['jetty:clean'] 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
+  end
+  raise "test failures: #{error}" if error
+end
+
+task default: :ci
+
+

data/hydra-works.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hydra/works/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hydra-works"
+  spec.version       = Hydra::Works::VERSION
+  spec.authors       = ["Justin Coyne"]
+  spec.email         = ["justin@curationexperts.com"]
+  spec.summary       = %q{Fundamental repository data model for hydra}
+  spec.description   = %q{Using this data model should enable easy collaboration amongst hydra projects.}
+  spec.homepage      = ""
+  spec.license       = "APACHE2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hydra-pcdm", "~> 0.0.1"
+  spec.add_dependency "hydra-derivatives", "~> 1.1.0"
+  spec.add_dependency "activefedora-aggregation", "~> 0.2.0"
+
+  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 'coveralls'
+  spec.add_development_dependency 'rspec'
+end

data/lib/hydra/works.rb

@@ -0,0 +1,81 @@
+require 'hydra/works/version'
+require 'active_fedora/aggregation'
+require 'hydra/pcdm'
+require 'hydra/derivatives'
+require 'hydra/works/processor'
+
+module Hydra
+  module Works
+
+    # vocabularies
+    autoload :WorksVocabularies,      'hydra/works/vocab/works_terms'
+
+    # models
+    autoload :Collection,             'hydra/works/models/collection'
+    autoload :GenericWork,            'hydra/works/models/generic_work'
+    autoload :GenericFile,            'hydra/works/models/generic_file'
+    
+    #behaviors
+    autoload :CollectionBehavior,     'hydra/works/models/concerns/collection_behavior'
+    autoload :GenericWorkBehavior,    'hydra/works/models/concerns/generic_work_behavior'
+    autoload :GenericFileBehavior,    'hydra/works/models/concerns/generic_file_behavior'
+    autoload :AggregatesGenericFiles, 'hydra/works/models/concerns/aggregates_generic_files'
+    autoload :AggregatesGenericWorks, 'hydra/works/models/concerns/aggregates_generic_works'
+    autoload :AggregatesCollections,  'hydra/works/models/concerns/aggregates_collections'
+    autoload :GenericFile,            'hydra/works/models/generic_file'
+
+    # collection services
+    autoload :AddCollectionToCollection,           'hydra/works/services/collection/add_collection'
+    autoload :AddGenericWorkToCollection,          'hydra/works/services/collection/add_generic_work'
+    autoload :AddRelatedObjectToCollection,        'hydra/works/services/collection/add_related_object'
+    autoload :GetCollectionsFromCollection,        'hydra/works/services/collection/get_collections'
+    autoload :GetGenericWorksFromCollection,       'hydra/works/services/collection/get_generic_works'
+    autoload :GetRelatedObjectsFromCollection,     'hydra/works/services/collection/get_related_objects'
+    autoload :RemoveCollectionFromCollection,      'hydra/works/services/collection/remove_collection'
+    autoload :RemoveGenericWorkFromCollection,     'hydra/works/services/collection/remove_generic_work'
+    autoload :RemoveRelatedObjectFromCollection,   'hydra/works/services/collection/remove_related_object'
+
+    # generic_work services
+    autoload :AddGenericWorkToGenericWork,         'hydra/works/services/generic_work/add_generic_work'
+    autoload :AddGenericFileToGenericWork,         'hydra/works/services/generic_work/add_generic_file'
+    autoload :AddRelatedObjectToGenericWork,       'hydra/works/services/generic_work/add_related_object'
+    autoload :GetGenericWorksFromGenericWork,      'hydra/works/services/generic_work/get_generic_works'
+    autoload :GetGenericFilesFromGenericWork,      'hydra/works/services/generic_work/get_generic_files'
+    autoload :GetRelatedObjectsFromGenericWork,    'hydra/works/services/generic_work/get_related_objects'
+    autoload :MoveGenericFileToGenericWork,        'hydra/works/services/generic_work/move_generic_file'
+    autoload :RemoveGenericWorkFromGenericWork,    'hydra/works/services/generic_work/remove_generic_work'
+    autoload :RemoveGenericFileFromGenericWork,    'hydra/works/services/generic_work/remove_generic_file'
+    autoload :RemoveRelatedObjectFromGenericWork,  'hydra/works/services/generic_work/remove_related_object'
+
+    # generic_file services
+    autoload :AddGenericFileToGenericFile,         'hydra/works/services/generic_file/add_generic_file'
+    autoload :AddFileToGenericFile,                'hydra/works/services/generic_file/add_file'
+    autoload :AddRelatedObjectToGenericFile,       'hydra/works/services/generic_file/add_related_object'
+    autoload :GetGenericWorksFromGenericFile,      'hydra/works/services/generic_file/get_generic_works'
+    autoload :GetGenericFilesFromGenericFile,      'hydra/works/services/generic_file/get_generic_files'
+    autoload :GetRelatedObjectsFromGenericFile,    'hydra/works/services/generic_file/get_related_objects'
+    autoload :RemoveGenericFileFromGenericFile,    'hydra/works/services/generic_file/remove_generic_file'
+    autoload :RemoveRelatedObjectFromGenericFile,  'hydra/works/services/generic_file/remove_related_object'
+    autoload :UploadFileToGenericFile,             'hydra/works/services/generic_file/upload_file'
+    autoload :AddOriginalFile,                     'hydra/works/services/generic_file/add_original_file'
+    autoload :AddVersionedOriginalFile,            'hydra/works/services/generic_file/add_versioned_original_file'
+    autoload :GenerateThumbnail,                   'hydra/works/services/generic_file/generate/thumbnail'
+
+    # model validations
+    def self.collection? collection
+      return false unless collection.respond_to? :type
+      collection.type.include? WorksVocabularies::WorksTerms.Collection
+    end
+
+    def self.generic_work? generic_work
+      return false unless generic_work.respond_to? :type
+      generic_work.type.include? WorksVocabularies::WorksTerms.GenericWork
+    end
+
+    def self.generic_file? generic_file
+      return false unless generic_file.respond_to? :type
+      generic_file.type.include? WorksVocabularies::WorksTerms.GenericFile
+    end
+
+  end
+end

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

@@ -0,0 +1,5 @@
+module Hydra::Works
+  class Collection < ActiveFedora::Base
+    include Hydra::Works::CollectionBehavior
+  end
+end

data/lib/hydra/works/models/concerns/aggregates_collections.rb

@@ -0,0 +1,16 @@
+module Hydra::Works
+  # Allows instances of a class to aggregate (pcdm:hasMember) hydra-works collections
+  module AggregatesCollections
+
+    def collections= collections
+      raise ArgumentError, "each collection must be a hydra works collection" unless collections.all? { |c| Hydra::Works.collection? c }
+      raise ArgumentError, "a collection can't be an ancestor of itself" if collection_ancestor?(collections)
+      self.members = self.generic_works + collections
+    end
+
+    def collections
+      members.to_a.select { |m| Hydra::Works.collection? m }
+    end
+
+  end
+end

data/lib/hydra/works/models/concerns/aggregates_generic_files.rb

@@ -0,0 +1,20 @@
+module Hydra::Works
+  # Allows instances of a class to aggregate (pcdm:hasMember) hydra-works generic files
+  module AggregatesGenericFiles
+
+    def generic_files= generic_files
+      raise ArgumentError, "each generic_file must be a hydra works generic file" unless generic_files.all? { |w| Hydra::Works.generic_file? w }
+      raise ArgumentError, "a generic file can't be an ancestor of itself" if object_ancestor?(generic_files)
+      if self.respond_to?(:generic_works)
+        self.members = self.generic_works + generic_files
+      else
+        self.members = generic_files
+      end
+    end
+
+    def generic_files
+      members.to_a.select { |m| Hydra::Works.generic_file? m }
+    end
+  end
+
+end