hydra-pcdm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08bc42e4a5ea8d987f0830db5474b9e2d7c1ada
-  data.tar.gz: 7f3e582637ddb0254b8cc399ab71d45f9f7ac482
+  metadata.gz: a31e7e8302b6fa6566390c103c94e588199f2d50
+  data.tar.gz: 35d89b527d58013dd4c4aa0477a59ac6a0235d56
 SHA512:
-  metadata.gz: 70d9932eddb9b3c3581ef2d14e7628fa15b6034d4dc607d3d92df74ea92ce19d40b5f5712b6eb2ef8421f3f4cd59a382dc683368eec2a2a123f8a4790bdcd913
-  data.tar.gz: b5b4827cc4a421cb9f35821d48504c0cbf4c072e191fad3bf29bcdbcdcb76275de3846c0e124f60e47c45d606a8a4b80967f6ee2cb780c29a03a1c84009e41a3
+  metadata.gz: 95ea6fa959fb711e4ca1e5a32e92e3e834d42987c00232353111da00bd7a5a5fb50dcced29ff87e3f5d3bbd4e4a08373a1337bac8acb4e1ba37ca3134f5bc417
+  data.tar.gz: 3549b065504e7bed1b1b8ecdbe941618b2000c73006b0cfe471e0250f79b5f4ec70ff9ea6dbbfb31d09ea73d32623378f71b13211071c29011eadc8ce89bc60a

data/.rubocop.yml

@@ -0,0 +1,38 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Include:
+    - '**/Rakefile'
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleWording:
+  CustomTransform:
+    be: is
+    have: has
+    not: does not
+    NOT: does NOT
+  IgnoredWords:
+    - only
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false

data/Gemfile

@@ -1,8 +1,11 @@
 source 'https://rubygems.org'
 
-unless ENV['CI']
-  gem 'pry'
-  gem 'pry-byebug'
+group :development, :test do
+  gem 'rubocop', require: false
+  gem 'haml-lint', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'pry' unless ENV['CI']
+  gem 'pry-byebug' unless ENV['CI']
 end
 
 # Specify your gem's dependencies in hydra-pcdm.gemspec

data/README.md

@@ -1,68 +1,60 @@
 # Hydra::PCDM
+
+[![Version](https://badge.fury.io/rb/hydra-pcdm.png)](http://badge.fury.io/rb/hydra-pcdm)
 [![Build Status](https://travis-ci.org/projecthydra-labs/hydra-pcdm.svg?branch=master)](https://travis-ci.org/projecthydra-labs/hydra-pcdm)
 [![Coverage Status](https://coveralls.io/repos/projecthydra-labs/hydra-pcdm/badge.svg?branch=master)](https://coveralls.io/r/projecthydra-labs/hydra-pcdm?branch=master)
+[![Code Climate](https://codeclimate.com/github/projecthydra-labs/hydra-pcdm/badges/gpa.svg)](https://codeclimate.com/github/projecthydra-labs/hydra-pcdm)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/hydra-pcdm)
+[![Stories in Ready](https://badge.waffle.io/projecthydra-labs/hydra-works.png?source=projecthydra-labs%2Fhydra-pcdm&label=ready&title=Ready)](https://waffle.io/projecthydra-labs/hydra-works?source=projecthydra-labs%2Fhydra-pcdm)
 
-Hydra implementation of Portland Common Data Models (PCDM)
+Hydra implementation of the Portland Common Data Model (PCDM)
 
 ## Installation
 
 Add these lines to your application's Gemfile:
 
 ```ruby
-  gem 'active-fedora', github: 'projecthydra/active_fedora' # hydra-pcdm requires an unreleased version of ActiveFedora
-  gem 'hydra-pcdm', github: 'projecthydra-labs/hydra-pcdm'
+  gem 'active-fedora', '~> 9.3'
+  gem 'hydra-pcdm', '~> 0.1'
 ```
 
-Substitute another branch name for 'master' to test out a branch under development.    
-<!-- Temporarily comment out until gem is published.
-    gem 'hydra-pcdm' 
--->
-
 And then execute:
-```
-    $ bundle
-```
-<!-- Temporarily comment out until gem is published.
-Or install it yourself as:
+
+    $ bundle install
+
+Or install it yourself:
 
     $ gem install hydra-pcdm
--->
 
 ## Access Controls
-We are using [Web ACL](http://www.w3.org/wiki/WebAccessControl) as implemented by [hydra-access](https://github.com/projecthydra/hydra-head/tree/master/hydra-access-controls) controls
 
-## PCDM Model
+We are using [Web ACL](http://www.w3.org/wiki/WebAccessControl) as implemented in [hydra-access-controls](https://github.com/projecthydra/hydra-head/tree/master/hydra-access-controls).
 
-Reference:  [Portland Common Data Model](https://github.com/duraspace/pcdm/wiki)
+## Portland Common Data Model
 
+Reference: [Portland Common Data Model](https://github.com/duraspace/pcdm/wiki)
 
 ### Model Definition
 
 ![PCDM Model Definition](https://raw.githubusercontent.com/wiki/duraspace/pcdm/images/coll-object-file.png)
 
-
-### Example
-
-To test the model and provide clarity we have included a sample mode that exercises the interfaces provided by the gem.
-The sample model may change over time to reflect the state of the gam and what it supports.  
-
-![Sandwich Objet Model](https://docs.google.com/drawings/d/1wI4H3AH9pdIPllKIMO356c1cFHUN57azDlgIqMVODSw/pub?w=1369&h=727)
-
 ## Usage
 
-Hydra-pcdm provides three classes:
+Hydra::PCDM provides three core classes:
+
 ```
 Hydra::PCDM::Object
 Hydra::PCDM::Collection
 Hydra::PCDM::File
 ```
 
-A `Hydra::PCDM::File` is a NonRDFSource &emdash; a bitstream.  You can use this to store content. A PCDM::File is contained by a PCDM::Object. A `File` has some attached technical metadata, but no descriptive metadata.  A `Hydra::PCDM::Object` contains files and other objects and may have descriptive metadata.  A `Hydra::PCDM::Collection` can contain other `Collection`s or `Object`s but not `File`s.  A `Collection` also may have descriptive metadata.
+A `Hydra::PCDM::File` is a NonRDFSource (in [LDP](http://www.w3.org/TR/ldp/) parlance) &emdash; a bitstream. You can use this to store content. A PCDM::File is contained by a PCDM::Object. A `File` may have some attached technical metadata, but no descriptive metadata. A `Hydra::PCDM::Object` may contain `File`s, may have descriptive metadata, and may declare other `Object`s as members (for complex object hierarchies). A `Hydra::PCDM::Collection` may contain other `Collection`s or `Object`s but may not directly contain `File`s. A `Collection` may also have descriptive metadata.
 
-Typically usage involves extending the behavior provided by this gem. In your application you can write something like this:
+Typically, usage involves extending the behavior provided by this gem. In your application you can write something like this:
 
 ```ruby
-
 class Book < ActiveFedora::Base
   include Hydra::PCDM::ObjectBehavior
 end
@@ -71,17 +63,18 @@ class Collection < ActiveFedora::Base
   include Hydra::PCDM::CollectionBehavior
 end
 
-c1 = Collection.create
-b1 = Book.create
+collection = Collection.create
+book = Book.create
 
-c1.members = [b1]
-# c1.members << b1 # This should work in the future
-c1.save
+collection.members = [book]
+# or: collection.members << book
+collection.save
 
-f1 = b1.files.build
-f1.content = "The quick brown fox jumped over the lazy dog."
-b1.save
+file = book.files.build
+file.content = "The quick brown fox jumped over the lazy dog."
+book.save
 ```
 
-## How to contribute
+## Contributing
+
 If you'd like to contribute to this effort, please check out the [Contributing Guide](CONTRIBUTING.md)

data/Rakefile

@@ -2,19 +2,29 @@ require 'bundler/gem_tasks'
 require 'jettywrapper'
 require 'rspec/core'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-Jettywrapper.hydra_jetty_version = "master"
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
+  task.fail_on_error = true
+end
+
+desc 'Run test suite and style checker'
+task :spec do
+  Rake::Task['rubocop'].invoke
+  RSpec::Core::RakeTask.new(:spec)
+end
 
 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
+  jetty_params[:startup_wait] = 90
   error = Jettywrapper.wrap(jetty_params) do
     Rake::Task['spec'].invoke
   end
-  raise "test failures: #{error}" if error
+  fail "test failures: #{error}" if error
 end
 
 task default: :ci

data/hydra-pcdm.gemspec

@@ -4,21 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hydra/pcdm/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "hydra-pcdm"
+  spec.name          = 'hydra-pcdm'
   spec.version       = Hydra::PCDM::VERSION
-  spec.authors       = ["E. Lynette Rayle"]
-  spec.email         = ["elr37@cornell.edu"]
-  spec.summary       = %q{Portland Common Data Model (PCDM)}
-  spec.description   = %q{Portland Common Data Model (PCDM)}
-  spec.homepage      = "https://github.com/projecthydra-labs/hydra-pcdm"
-  spec.license       = "APACHE2"
-  spec.required_ruby_version     = '>= 1.9.3'
+  spec.authors       = ['E. Lynette Rayle']
+  spec.email         = ['elr37@cornell.edu']
+  spec.summary       = 'Portland Common Data Model (PCDM)'
+  spec.description   = 'Portland Common Data Model (PCDM)'
+  spec.homepage      = 'https://github.com/projecthydra-labs/hydra-pcdm'
+  spec.license       = 'APACHE2'
+  spec.required_ruby_version = '>= 1.9.3'
 
   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.require_paths = ['lib']
 
+  spec.add_dependency 'active-fedora', '>= 9.4.1'
   spec.add_dependency 'activefedora-aggregation', '~> 0.4'
   spec.add_dependency 'mime-types', '>= 1'
 
@@ -27,5 +28,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rspec'
-
 end

data/lib/hydra/pcdm.rb

@@ -2,15 +2,17 @@ require 'active_support'
 require 'mime/types'
 require 'active_fedora/aggregation'
 
-
 module Hydra
   module PCDM
     extend ActiveSupport::Autoload
 
-    # vocabularies
-    autoload :RDFVocabularies,        'hydra/pcdm/vocab/pcdm_terms'
-    autoload :EBUCoreVocabularies,    'hydra/pcdm/vocab/ebucore_terms'
-    autoload :SweetjplVocabularies,   'hydra/pcdm/vocab/sweetjpl_terms'
+    module Vocab
+      extend ActiveSupport::Autoload
+      eager_autoload do
+        autoload :PCDMTerms
+        autoload :SweetJPLTerms
+      end
+    end
 
     # models
     autoload_under 'models' do
@@ -41,20 +43,19 @@ module Hydra
     autoload :Validators,                        'hydra/pcdm/validators'
 
     # model validations
-    def self.collection? collection
+    def self.collection?(collection)
       return false unless collection.respond_to? :type
-      Array(collection.type).include? RDFVocabularies::PCDMTerms.Collection
+      Array(collection.type).include? Vocab::PCDMTerms.Collection
     end
 
-    def self.object? object
+    def self.object?(object)
       return false unless object.respond_to? :type
-      Array(object.type).include? RDFVocabularies::PCDMTerms.Object
+      Array(object.type).include? Vocab::PCDMTerms.Object
     end
 
-    def self.file? file
+    def self.file?(file)
       return false unless file.respond_to? :metadata_node
-      Array(file.metadata_node.type).include? RDFVocabularies::PCDMTerms.File
+      Array(file.metadata_node.type).include? Vocab::PCDMTerms.File
     end
-
   end
 end

data/lib/hydra/pcdm/collection_indexer.rb

@@ -1,12 +1,10 @@
 module Hydra::PCDM
   class CollectionIndexer < ObjectIndexer
-
     def generate_solr_document
       super.tap do |solr_doc|
-        solr_doc["member_ids_ssim"]           = object.member_ids
-        solr_doc["child_collection_ids_ssim"] = object.child_collection_ids
+        solr_doc['member_ids_ssim'] = object.member_ids
+        solr_doc['collection_ids_ssim'] = object.collection_ids
       end
     end
-
   end
 end

data/lib/hydra/pcdm/deep_member_iterator.rb

@@ -1,5 +1,5 @@
 module Hydra::PCDM
-  ## 
+  ##
   # Iterates over a record's members and all of their members in a breadth-first
   # search.
   class DeepMemberIterator

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

@@ -3,4 +3,3 @@ module Hydra::PCDM
     include Hydra::PCDM::CollectionBehavior
   end
 end
-

data/lib/hydra/pcdm/models/concerns/collection_behavior.rb

@@ -1,5 +1,4 @@
 module Hydra::PCDM
-
   # behavior:
   #   1) Hydra::PCDM::Collection can aggregate (pcdm:hasMember)  Hydra::PCDM::Collection (no infinite loop, e.g., A -> B -> C -> A)
   #   2) Hydra::PCDM::Collection can aggregate (pcdm:hasMember)  Hydra::PCDM::Object
@@ -15,17 +14,17 @@ module Hydra::PCDM
     extend ActiveSupport::Concern
 
     included do
-      type RDFVocabularies::PCDMTerms.Collection
+      type Vocab::PCDMTerms.Collection
       include ::Hydra::PCDM::PcdmBehavior
 
-      filters_association :members, as: :child_collections, condition: :pcdm_collection?
+      filters_association :members, as: :collections, condition: :pcdm_collection?
     end
 
     module ClassMethods
       def indexer
         Hydra::PCDM::CollectionIndexer
       end
-      
+
       def type_validator
       end
     end
@@ -37,6 +36,20 @@ module Hydra::PCDM
     def pcdm_collection?
       true
     end
+
+    def child_collections
+      warn '[DEPRECATION] `child_collections` is deprecated in Hydra::PCDM.  Please use `collections` instead.  This has a target date for removal of 10-31-2015'
+      collections
+    end
+
+    def child_collections=(new_collections)
+      warn '[DEPRECATION] `child_collections=` is deprecated in Hydra::PCDM.  Please use `collections=` instead.  This has a target date for removal of 10-31-2015'
+      self.collections = new_collections
+    end
+
+    def child_collection_ids
+      warn '[DEPRECATION] `child_collection_ids` is deprecated in Hydra::PCDM.  Please use `collection_ids` instead.  This has a target date for removal of 10-31-2015'
+      collection_ids
+    end
   end
 end
-

data/lib/hydra/pcdm/models/concerns/object_behavior.rb

@@ -1,5 +1,4 @@
 module Hydra::PCDM
-
   # behavior:
   #   1) Hydra::PCDM::Object can aggregate (pcdm:hasMember) Hydra::PCDM::Object
   #   2) Hydra::PCDM::Object can aggregate (ore:aggregates) Hydra::PCDM::Object  (Object related to the Object)
@@ -13,11 +12,11 @@ module Hydra::PCDM
     extend ActiveSupport::Concern
 
     included do
-      type RDFVocabularies::PCDMTerms.Object
+      type Vocab::PCDMTerms.Object
       include ::Hydra::PCDM::PcdmBehavior
 
-      directly_contains :files, has_member_relation: RDFVocabularies::PCDMTerms.hasFile,
-        class_name: "Hydra::PCDM::File"
+      directly_contains :files, has_member_relation: Vocab::PCDMTerms.hasFile,
+                                class_name: 'Hydra::PCDM::File'
     end
 
     module ClassMethods
@@ -40,23 +39,21 @@ module Hydra::PCDM
       false
     end
 
-    def parent_objects
+    def in_objects
       aggregated_by.select(&:pcdm_object?)
     end
 
-    def contains= files
-      # check that file is an instance of Hydra::PCDM::File
-      raise ArgumentError, "each file must be a pcdm file" unless
-          files.all? { |f| Hydra::PCDM.file? f }
-      super(files)
+    def parent_objects
+      warn '[DEPRECATION] `parent_objects` is deprecated in Hydra::PCDM.  Please use `in_objects` instead.  This has a target date for removal of 10-31-2015'
+      in_objects
     end
 
     # Returns directly contained files that have the requested RDF Type
     # @param [RDF::URI] uri for the desired Type
     # @example
     #   filter_files_by_type(::RDF::URI("http://pcdm.org/ExtractedText"))
-    def filter_files_by_type uri
-      self.files.reject do |file|
+    def filter_files_by_type(uri)
+      files.reject do |file|
         !file.metadata_node.type.include?(uri)
       end
     end
@@ -65,10 +62,10 @@ module Hydra::PCDM
     # @param [RDF::URI] uri for the desired Type
     # @example
     #   file_of_type(::RDF::URI("http://pcdm.org/ExtractedText"))
-    def file_of_type uri
-      matching_files =  filter_files_by_type(uri)
-      if  matching_files.empty?
-        file = self.files.build
+    def file_of_type(uri)
+      matching_files = filter_files_by_type(uri)
+      if matching_files.empty?
+        file = files.build
         Hydra::PCDM::AddTypeToFile.call(file, uri)
       else
         return matching_files.first
@@ -76,4 +73,3 @@ module Hydra::PCDM
     end
   end
 end
-