cul_hydra_models 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 572252de6bc635f3ee42e3bf6984cb03b31fca8c
+  data.tar.gz: 37e796f0288e6d74bc5b277bbe0fbd15c4c6b211
+SHA512:
+  metadata.gz: bb25208b04d0a6f0c651d933ecfdbde052103832d51e3ab4fb5f65a6b724738f1df1e91685b5a5470f30652b83c05b82e8bd4c371db182f18b54229e2685969f
+  data.tar.gz: 9008924b9e5be9a6045ce1ee1bf6406f8f0b8c5a78b0bc6549458605ae699279a43d422681f097b140b3e9bc3a71f23a1d43b2a5b63032b55ce159e7fd88fbb7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Eric O
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# CUL Hydra Models for repository applications
+
+- Requires Rails 5.1.1 or later.
+- Relies on ActiveFedora 8 gem.
+- Works with Fedora 3.8.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cul_hydra_models'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cul_hydra_models
+```
+
+## To Run Integration Tests (coming soon)
+```
+bundle exec rake cul_hydra:ci
+```
+## To Run Unit Tests
+```
+bundle exec rspec spec/unit
+```

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CulHydraModels'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+# Add our gem's rake task files
+Dir.glob("lib/tasks/*.rake").each do |rakefile|
+  load rakefile
+end
+
+# require 'rake/testtask'
+#
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << 'test'
+#   t.pattern = 'test/**/*_test.rb'
+#   t.verbose = false
+# end
+#
+# task default: :test

data/app/models/collection.rb

@@ -0,0 +1,4 @@
+require 'active-fedora'
+class Collection < ActiveFedora::Base
+  include CulHydraModels::Common
+end

data/app/models/concept.rb

@@ -0,0 +1,4 @@
+require 'active-fedora'
+class Concept < ActiveFedora::Base
+  include CulHydraModels::Common
+end

data/app/models/concerns/cul_hydra_models/common.rb

@@ -0,0 +1,23 @@
+require 'active-fedora'
+module CulHydraModels
+  module Common
+    extend ActiveSupport::Concern
+
+    included do
+      extend ActiveModel::Callbacks
+      has_metadata "descMetadata", type: Datastreams::ModsDocument, versionable: true
+    end
+
+    module ClassMethods
+    end
+
+    # A Fedora object label can only contain a string value of up to 255 characters.  If we try to
+    # set a longer value, it causes errors upon object save.  Truncate labels to 255 characters.
+    # Note: this method maps to a method_missing hanlder that converts input into a String, so
+    # we use the super method first, and then post-process the output of that super method call.
+    def label=(new_label)
+      super(new_label)
+      super(self.label[0, 255])
+    end
+  end
+end

data/app/models/content_aggregator.rb

@@ -0,0 +1,4 @@
+require 'active-fedora'
+class ContentAggregator < ActiveFedora::Base
+  include CulHydraModels::Common
+end

data/app/models/datastreams/mods_document.rb

@@ -0,0 +1,3 @@
+require 'active-fedora'
+class Datastreams::ModsDocument < ActiveFedora::OmDatastream
+end

data/app/models/generic_resource.rb

@@ -0,0 +1,4 @@
+require 'active-fedora'
+class GenericResource < ActiveFedora::Base
+  include CulHydraModels::Common
+end

data/config/predicate_mappings.yml

@@ -0,0 +1,107 @@
+# The default namespace maps to the default namespace for generating rels_ext from solr
+:default_namespace: info:fedora/fedora-system:def/relations-external#
+
+# namespace mappings--- 
+# you can add specific mappings for your institution by providing the following:
+#   namespace_uri:
+#     :relationship_symbol: relationship_identifier
+# 
+# For example, if you have the following element in your rels_ext:
+#  
+#  <oai:itemID>oai:example.edu:changeme:500</oai:itemID>
+# 
+# With the last two lines of this file uncommented, the relationships hash of your object will include:
+#   :oai_item_id => ["info:fedora/oai:example.edu:changeme:500"]
+#
+:predicate_mapping:
+  http://purl.oclc.org/NET/CUL/:
+    :cul_has_member: hasMember
+    :cul_member_of: memberOf
+    :cul_metadata_for: metadataFor
+    :cul_obsolete_from: obsoleteFrom
+  http://creativecommons.org/ns#:
+    :cc_license: license
+  info:fedora/fedora-system:def/relations-external#: 
+    :conforms_to: conformsTo
+    :has_annotation: hasAnnotation
+    :has_collection_member: hasCollectionMember
+    :has_constituent: hasConstituent
+    :has_dependent: hasDependent
+    :has_derivation: hasDerivation
+    :has_description: hasDescription
+    :has_equivalent: hasEquivalent
+    :has_metadata: hasMetadata
+    :has_member: hasMember
+    :has_model: hasModel
+    :has_part: hasPart
+    :has_subset: hasSubset
+    :is_annotation_of: isAnnotationOf
+    :is_constituent_of: isConstituentOf
+    :is_dependent_of: isDependentOf
+    :is_derivation_of: isDerivationOf
+    :is_description_of: isDescriptionOf
+    :is_member_of: isMemberOf
+    :is_member_of_collection: isMemberOfCollection
+    :is_metadata_for: isMetadataFor
+    :is_part_of: isPartOf
+    :is_subset_of: isSubsetOf
+  info:fedora/fedora-system:def/model#:
+    :has_model: hasModel
+  http://purl.oclc.org/NET/CUL/RESOURCE/STILLIMAGE/BASIC/:
+    :cul_image_width: imageWidth
+    :cul_image_length: imageLength
+  http://purl.oclc.org/NET/CUL/RESOURCE/STILLIMAGE/ASSESSMENT/:
+    :x_sampling: xSamplingFrequency
+    :y_sampling: ySamplingFrequency
+    :sampling_unit: samplingFrequencyUnit
+  http://purl.org/dc/terms/:
+    :abstract: abstract
+    :alternative: alternative
+    :contributor: contributor
+    :description: description
+    :extent: extent
+    :format: format
+    :format_of: isFormatOf
+    :publisher: publisher
+    :source: source
+    :title: title
+  http://www.w3.org/2003/12/exif/ns#:
+    :image_width: imageWidth
+    :image_length: imageLength
+    :x_resolution: xResolution
+    :y_resolution: yResolution
+    :resolution_unit: resolutionUnit
+    :orientation: orientation
+  http://xmlns.com/foaf/0.1/:
+    :foaf_image: image
+    :foaf_thumbnail: thumbnail
+    :foaf_zooming: zoomingImage
+    :foaf_depicts: depicts
+    :foaf_depiction: depiction
+  http://www.w3.org/1999/02/22-rdf-syntax-ns#:
+    :rdf_type: type
+  http://www.loc.gov/premis/rdf/v1#:
+    :original_name: hasOriginalName
+    :restriction: hasRestriction
+  http://pcdm.org/models#:
+    :pcdm_has_file: hasFile
+    :pcdm_file_of: fileOf
+    :pcdm_has_member: hasMember
+    :pcdm_member_of: memberOf
+    :pcdm_has_related_file: hasRelatedFile
+    :pcdm_related_file_of: relatedFileOf
+    :pcdm_has_related_object: hasRelatedObject
+    :pcdm_related_object_of: relatedObjectOf
+  http://purl.org/ontology/bibo/:
+    :short_title: shortTitle
+    :ezid_doi: doi
+  http://www.bbc.co.uk/ontologies/coreconcepts/:
+    :slug: slug
+  https://schema.org/:
+    :schema_image: image
+  http://www.openarchives.org/ore/terms/:
+    :lineage: lineage
+  http://www.w3.org/ns/ldp#:
+    :ldp_contains: contains
+  http://iiif.io/api/image/2#:
+    :region_featured: regionFeatured

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/cul_hydra_models/engine.rb

@@ -0,0 +1,19 @@
+module CulHydraModels
+  class Engine < ::Rails::Engine
+    isolate_namespace CulHydraModels
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.before_configuration do
+      # If no config/predicate_mappings.yml file exists in the project this gem is pulled into, load predicates from the gem
+      unless File.exists?('config/predicate_mappings.yml')
+        require 'active-fedora'
+        cul_hydra_models_gem_location = Bundler.rubygems.find_name('cul_hydra_models').first.full_gem_path
+        config_path = File.join(cul_hydra_models_gem_location, 'config/predicate_mappings.yml')
+        ActiveFedora.init(predicate_mappings_config_path: config_path)
+      end
+    end
+  end
+end

data/lib/cul_hydra_models/engine.rb~

@@ -0,0 +1,4 @@
+module CulHydraModels
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/cul_hydra_models/version.rb

@@ -0,0 +1,3 @@
+module CulHydraModels
+  VERSION = '0.1.1'
+end

data/lib/cul_hydra_models/version.rb~

@@ -0,0 +1,3 @@
+module CulHydraModels
+  VERSION = '0.1.0'
+end

data/lib/cul_hydra_models.rb

@@ -0,0 +1,4 @@
+require "cul_hydra_models/engine"
+
+module CulHydraModels
+end

data/lib/tasks/ci.rake

@@ -0,0 +1,73 @@
+namespace :cul_hydra_models do
+
+  begin
+    # This code is in a begin/rescue block so that the Rakefile is usable
+    # in an environment where RSpec is unavailable (i.e. production).
+
+    require 'rspec/core/rake_task'
+
+    RSpec::Core::RakeTask.new(:rspec) do |spec|
+      spec.pattern = FileList['spec/**/*_spec.rb']
+      spec.pattern += FileList['spec/*_spec.rb']
+      spec.rspec_opts = ['--backtrace'] if ENV['CI']
+    end
+
+    RSpec::Core::RakeTask.new(:rcov) do |spec|
+      spec.pattern = FileList['spec/**/*_spec.rb']
+      spec.pattern += FileList['spec/*_spec.rb']
+      spec.rcov = true
+    end
+
+    require 'rubocop/rake_task'
+
+    desc 'Run style checker'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.requires << 'rubocop-rspec'
+      task.fail_on_error = true
+    end
+
+  rescue LoadError => e
+    puts "[Warning] Exception creating rspec rake tasks.  This message can be ignored in environments that intentionally do not pull in the RSpec gem (i.e. production)."
+    puts e
+  end
+
+  desc "CI build without rubocop"
+  task :ci_nocop do
+    exec({ 'RAILS_ENV' => 'test' }, 'bundle', 'exec', 'rake', 'cul_hydra_models:ci_task')
+  end
+
+  desc "CI build with Rubocop validation"
+  task ci: ['cul_hydra_models:rubocop'] do
+    exec({ 'RAILS_ENV' => 'test' }, 'bundle', 'exec', 'rake', 'cul_hydra_models:ci_task')
+  end
+
+  desc "CI build"
+  task :ci_task do
+    require 'jettywrapper'
+    Jettywrapper.url = "https://github.com/projecthydra/hydra-jetty/archive/7.x-stable.zip"
+    Jettywrapper.jetty_dir = File.join(Rails.root, 'tmp', 'jetty-test')
+
+    unless File.exists?(Jettywrapper.jetty_dir)
+      puts "\nNo test jetty found.  Will download / unzip a copy now.\n"
+    end
+    Rake::Task["jetty:clean"].invoke
+
+    jetty_params = Jettywrapper.load_config.merge(jetty_home: Jettywrapper.jetty_dir)
+    puts "Starting Fedora 3 (jettywrapper)...\n"
+    error = Jettywrapper.wrap(jetty_params) do
+      Rake::Task["cul_hydra_models:cmodel:reload_all"].invoke
+      Rake::Task['cul_hydra_models:coverage'].invoke
+      puts 'Stopping Fedora 3 (jettywrapper)...'
+    end
+    raise "test failures: #{error}" if error
+  end
+
+  desc "Execute specs with coverage"
+  task :coverage do
+    # Put spec opts in a file named .rspec in root
+    ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+    ENV['COVERAGE'] = 'true' unless ruby_engine == 'jruby'
+    Rake::Task["cul_hydra_models:rspec"].invoke
+  end
+
+end

data/lib/tasks/cmodel.rake

@@ -0,0 +1,120 @@
+APP_ROOT = File.expand_path("#{File.dirname(__FILE__)}/../../") unless defined?(APP_ROOT)
+require 'active-fedora'
+
+def logger
+  @logger ||= Logger.new($stdout)
+end
+
+def filename_for_pid(pid)
+  pid.gsub(/\:/, '_') + '.xml'
+end
+
+def pid_for_filename(fname)
+  fname.sub(/\.xml$/, '').sub(/_/, ':')
+end
+
+def cmodel_fixture(name)
+  path = File.join(APP_ROOT, 'spec', 'fixtures', 'cmodels', name)
+  File.open(path, 'rb')
+end
+
+def each_cmodel
+  path = File.join(APP_ROOT, 'spec', 'fixtures', 'cmodels')
+  Dir.new(path).each do |fname|
+    if fname =~ /\.xml$/
+      yield pid_for_filename(fname)
+    end
+  end
+end
+
+def config_subs
+  @subs ||= begin
+    cfile = File.join(APP_ROOT, 'config', 'subs.yml')
+    subs = {}
+    if File.exists? cfile
+      open(cfile) { |blob| subs = YAML::load(blob)[ENV['RAILS_ENV'] || 'test'] }
+    else
+      logger.warn("No subs.yml found; CModels will be loaded without inline substitutions")
+    end
+    subs
+  end
+  @subs
+end
+
+def do_subs(orig)
+  content = orig.clone
+  config_subs.each do |key, val|
+    content.gsub!(/\$#{key.to_s}\$/, val)
+  end
+  content
+end
+
+def connection
+  # no need to go through AF for this except laziness re: finding the YAML
+  @connection ||= (ActiveFedora::Base.fedora_connection[0] ||= ActiveFedora::RubydoraConnection.new(ActiveFedora.config.credentials)).connection
+end
+
+def content_for(pid)
+  fname = filename_for_pid(pid)
+  fcontent = cmodel_fixture(fname).read
+  fcontent = do_subs(fcontent)
+end
+
+def load_content(content, pid)
+  begin
+    connection.ingest(file: StringIO.new(content), pid: pid)
+  rescue Exception => e
+    puts "possible problem with ingest of #{pid}: #{e.message}"
+    raise e
+  end
+end
+
+def purge(pid)
+  begin
+    connection.purge_object(pid: pid)
+  rescue Exception => e
+    puts "possible problem with purge of #{pid}: #{e.message}"
+  end
+end
+
+def reload(pid)
+  fcontent = content_for(pid)
+  purge(pid)
+  load_content(fcontent, pid)
+end
+
+namespace :cul_hydra_models do
+  namespace :cmodel do
+    task :test do #=> :environment do
+      pid = ENV["PID"]
+      puts content_for(pid)
+    end
+
+    task :load do #=> :environment do
+      pid = ENV["PID"]
+      load_content(content_for(pid), pid)
+    end
+
+    task :purge do #=> :environment do
+      pid = ENV["PID"]
+      purge(pid)
+    end
+
+    task :reload do #=> :environment do
+      pid = ENV["PID"]
+      reload(pid)
+    end
+
+    task :reload_all do #=> :environment do
+      pattern = ENV["PATTERN"]
+      pattern = Regexp.compile(pattern) if pattern
+      reload("ldpd:nullbind")
+      each_cmodel do |pid|
+        unless (pattern && pid !~ pattern)
+          puts "reloading #{pid}"
+          reload(pid)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: cul_hydra_models
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Eric O'Hanlon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: active-fedora
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.4'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: jettywrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hydra models for CUL repository apps.
+email:
+- elo2112@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/cul_hydra_models_manifest.js
+- app/models/collection.rb
+- app/models/concept.rb
+- app/models/concerns/cul_hydra_models/common.rb
+- app/models/content_aggregator.rb
+- app/models/datastreams/mods_document.rb
+- app/models/generic_resource.rb
+- config/predicate_mappings.yml
+- config/routes.rb
+- lib/cul_hydra_models.rb
+- lib/cul_hydra_models/engine.rb
+- lib/cul_hydra_models/engine.rb~
+- lib/cul_hydra_models/version.rb
+- lib/cul_hydra_models/version.rb~
+- lib/tasks/ci.rake
+- lib/tasks/cmodel.rake
+homepage: https://github.com/cul/cul_hydra_models
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Hydra models for CUL repository apps.
+test_files: []