stanford-mods 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.travis
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+*.tmproj
+tmtags
+.idea/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@stanford-mods --create

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+script: rake rspec
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+notifications:
+  email:
+    - ndushay@stanford.edu

data/.yardopts

@@ -0,0 +1,3 @@
+--title 'Stanford-Mods Documentation'
+lib/**/*.rb -
+README.rdoc LICENSE 

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# See stanford-mods.gemspec for this gem's dependencies
+gemspec

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 20XX-2012.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
+
+Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
+
+THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN NO EVENT SHALL THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.rdoc

@@ -0,0 +1,40 @@
+= Stanford::Mods
+
+{<img src="https://secure.travis-ci.org/sul-dlss/stanford-mods.png?branch=master" alt="Build Status" />}[http://travis-ci.org/sul-dlss/stanford-mods]
+
+A Gem with Stanford specific wranglings of MODS (Metadata Object Description Schema) metadata from DOR, the Stanford Digital Object Repository.
+
+Source code at https://github.com/sul-dlss/stanford-mods/
+
+Generated API docs at  http://rubydoc.info/github/sul-dlss/stanford-mods/
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stanford-mods'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stanford-mods
+
+== Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write code and tests.
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+== Releases
+
+0.0.1 

data/Rakefile

@@ -0,0 +1,46 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'bundler'
+
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+task :default => :ci  
+
+desc "run continuous integration suite (tests, coverage, docs)" 
+task :ci => [:rspec, :doc]
+
+task :spec => :rspec
+
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+end
+
+# Use yard to build docs
+begin
+  project_root = File.expand_path(File.dirname(__FILE__) + "/../..")
+  doc_dest_dir = File.join(project_root, 'doc')
+
+  YARD::Rake::YardocTask.new(:doc) do |yt|
+    yt.files = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
+                 [ File.join(project_root, 'README.rdoc') ]
+    yt.options = ['--output-dir', doc_dest_dir, '--readme', 'README.rdoc', '--title', 'Stanford-Mods Documentation']
+  end
+rescue LoadError
+  desc "Generate YARD Documentation"
+  task :doc do
+    abort "Please install the YARD gem to generate rdoc."
+  end
+end  
+

data/config/mappings_hash.rb

@@ -0,0 +1,79 @@
+# key: method name
+# value:  xpath
+name_to_xpath = {
+  # are we deliberately seeking nested values, or just incidentally?
+  # some string, some array
+  # some return nil if missing -- do all?
+
+# TOP_LEVEL_SIMPLE
+  'abstract' => '//abstract/text()', # .to_s
+  'access_condition' => '//accessCondition/text()',  # .to_s
+  'genre' => '//genre/text()', #.to_s as array
+  'type_of_resource' => '//typeOfResource/text()', # .to_s
+
+# name
+  'corporate_authors' => '//mods/name[@type="corporate"]', # .ea .xpath('namePart').collect{ |a| a.text }.join(' ') 
+  'personal_authors' => '//mods/name[@type="personal"]', # .ea .xpath('namePart').collect{ |a| a.text }.join(' ') 
+
+# titleInfo
+  'title' => '//mods/titleInfo[not(@type="alternative")]', # .first, extract_title_from_title_info(node)
+  'subtitle' => '//mods/titleInfo/subTitle' #.first.text
+  'full_title' => '//mods/titleInfo', # .first, extract_full_title_from_title_info(node)
+  'title_variant' => '//mods/titleInfo[@type="alternative"]', # .first, extract_title_from_title_info(node)
+
+# language
+  'language_codes' => "//language/languageTerm[@authority='iso639-2b'][@type='code']/text()", 
+  'language_words' => "//language/languageTerm[@type='text']/text()|//language/text()", 
+
+# physicalDescription
+  'physical_description_extent' => '//physicalDescription/extent/text()', # .to_s
+  'physical_description_form' => '//physicalDescription/form/text()', # .to_s
+  'physical_description_media_type' => '//physicalDescription/internetMediaType/text()', # .to_s
+
+# location
+  'physical_location' => '//location/physicalLocation/text()', # .to_s
+  'location_url' => '//location/url/text()', # .to_s
+
+# relatedItem
+  'relateditem_location_url' => '//relatedItem/location/url/text()', # .to_s
+  'relateditem_title' => '//relatedItem/titleInfo/title/text()', # .to_s
+
+# originInfo
+  'create_start_date' => '//originInfo/dateCreated[@point="start"]/text()', #.to_s  - comes from passed node, not root
+  'create_end_date' => '//originInfo/dateCreated[@point="end"]/text()', #.to_s  - comes from passed node, not root
+  'date_issued' => '//originInfo/dateIssued/text()', #.to_s  - comes from passed node, not root
+  'place_terms' => '//originInfo/place/placeTerm/text()', # .to_s  put in array, then .flatten.uniq
+  'publishers' => '//originInfo/publisher/text()', # .to_s  put in array, then .flatten.uniq
+  # pub_date / pub_year
+
+# subject
+  'subject_names' => '//subject/name', # .ea .xpath('namePart/text().to_a.join(' ')  then .uniq
+  'subject_topics' => '//subject/topic/text()', # .ea .to_s  as array then .uniq
+  'subject_geographic' => '//subject/geographic/text()', # .ea .to_s  as array then .uniq
+  'subject_temporal' => '//subject/temporal/text()', # .ea .to_s  as array then .uniq
+  #  # TODO: subject/temporal can be either a string or an iso8601 date
+  # At some point we may need to handle date parsing here, but as a first
+  # pass, just assume everything is a string
+  # if mt.xpath('@encoding="iso8601"')
+  #   begin
+  #     d = DateTime.iso8601(mt.xpath('text()').to_s)
+  #   rescue
+  #     puts "#{mt.xpath('text()').to_s} is not a valid iso8601 date"
+  #   end
+  # else
+  'subject_title_info' => '//subject/titleInfo', # .ea  extract_full_title_from_title_info(node), then .flatten.uniq
+  
+  'fulltext' => '//text()', #  .collect { |n| n.to_s }.join(' ')
+  
+  # TODO:  simple element variants:
+  # 
+  # genre authority
+  # accessCondition type
+  # note displayLabel
+  # MISSING:
+  #   date_created
+  
+  # TODO:  collections
+  
+}
+

data/lib/stanford-mods/mappings.rb

@@ -0,0 +1,153 @@
+module Stanford
+  module Mods
+
+    def empty?
+      mods_xml.xpath('//text()').empty?
+    end
+
+    # Determine what language(s) this record declares
+    # Use iso-639 to translate codes into English words 
+    # @return Array
+    def language
+      languages = []
+      language_codes.each do |code|
+        begin
+          csv_codes = code.to_s.split(/[,|\ ]/)
+          csv_codes = csv_codes.delete_if {|x| x.strip.length==0 } 
+          csv_codes.each do |c|
+            languages << ISO_639.find(c.to_s.strip).english_name
+          end
+        rescue => e
+          SearchWorksOaiHarvester.logger.error "Couldn't find english name for #{code.to_s}"
+          # SearchWorksOaiHarvester.logger.error e
+          languages << code.to_s
+        end
+      end
+
+      language_words.each do |word|
+        if word.to_s.strip.length > 0
+          languages << word.to_s.strip
+        end
+      end
+      return nil if languages.uniq.empty?
+      return languages.uniq
+    end
+
+    # Interpret the various permutations of dateCreated
+    # @param [Nokogiri::XML::Element] node
+    def date_created
+      if create_start_date.length > 0 && create_end_date.length > 0
+        return "#{start_date} - #{end_date}"
+      else
+        return node.xpath('//dateCreated/text()').to_s
+      end
+    end
+
+    def date_created_or_issued
+      begin
+        return date_created unless date_created.nil? or date_created.length == 0
+        return date_issued unless date_issued.nil? or date_issued.length == 0
+        nil
+      rescue
+        nil
+      end
+    end
+
+    # A single value for publication year (this will need refinement over time)
+    # @return String
+    def pub_year(year = date_created_or_issued)
+      year[/[0-9]{4}/]
+    end
+
+
+
+
+    # TODO: Ask Jessie what the valid values are here
+    # @return String
+    def display_type
+      return "image" if is_an_image?
+      return "image" if is_a_map?
+      return "collection" if is_a_collection?
+      nil
+    end
+
+    # Check to see if this item is a map
+    # @return Boolean
+    def is_a_map?
+      return true if mods_xml.xpath('//typeOfResource/text()').to_s.match(/^[Cc]artographic/)
+      return true if mods_xml.xpath('//genre[@authority="marcgt"]/text()').to_s.match(/^[Mm]ap/)
+      return true if mods_xml.xpath('//physicalDescription/form/text()').to_s.match(/[Mm]ap/)
+      return true if mods_xml.xpath('//physicalDescription/internetMediaType/text()').to_s.match(/[Mm]ap/)
+      false
+    end
+
+    # Check to see if this item is an Image
+    # @return Boolean
+    def is_an_image?
+      return true if mods_xml.xpath('//typeOfResource/text()').to_s.match(/still image/)
+      false
+    end
+
+    # Objects can belong to a collection by reference (handled in solr_mapper.rb), 
+    # or they can declare themselves part of a collection in MODS
+    # e.g., Revs does it like this:
+    # <mods:relatedItem type="host">
+    #   <mods:titleInfo>
+    #     <mods:title>The Collier Collection of the Revs Institute for Automotive Research</mods:title>
+    #   </mods:titleInfo>
+    #   <mods:typeOfResource collection="yes"/>
+    # </mods:relatedItem>
+    def declared_collections
+      c = []
+      collection_nodes = mods_xml.xpath("//relatedItem/typeOfResource[@collection='yes']")
+      collection_nodes.each do |node|
+        c << node.xpath('../titleInfo/title/text()').to_s
+      end
+      c
+    end
+
+    # Check to see if this item is a collection
+    # @return Boolean
+    def is_a_collection?
+      return true if mods_xml.xpath("/mods/typeOfResource/@collection").to_s == 'yes'
+      false
+    end
+
+    def physical_description_form
+      form = mods_xml.xpath('//physicalDescription/form/text()').to_s
+      media_type = mods_xml.xpath('//physicalDescription/internetMediaType/text()').to_s
+      if form != media_type && form
+        form
+      elsif media_type
+        media_type
+      else
+        nil
+      end
+    end
+
+
+
+    # Accept a nokogiri representation of a mods titleInfo element
+    # Return a formatted string of the title it describes
+    # @param node Nokogiri::XML::Element 
+    # @return String
+    def extract_title_from_title_info(node)
+      "#{node.xpath('nonSort/text()')} #{node.xpath('title/text()')}".strip
+    end
+
+    # Accept a nokogiri representation of a mods titleInfo element
+    # Return a formatted string of the title it describes
+    # @param node Nokogiri::XML::Element 
+    # @return String
+    def extract_full_title_from_title_info(node)
+      title = "#{node.xpath('nonSort/text()')} #{node.xpath('title/text()')}".strip
+      unless node.xpath('subTitle/text()').empty?
+        title = "#{title}: #{node.xpath('subTitle/text()')}"
+      end
+      return title
+    end
+
+    
+
+  end
+end

data/lib/stanford-mods/version.rb

@@ -0,0 +1,5 @@
+module Stanford
+  module Mods
+    VERSION = "0.0.1"
+  end
+end

data/lib/stanford-mods.rb

@@ -0,0 +1,18 @@
+require "stanford-mods/mappings"
+require "stanford-mods/version"
+require 'mods'
+
+# Stanford specific wranglings of MODS metadata as an extension of the Mods::Record object
+module Stanford
+  module Mods
+
+    class Record < ::Mods::Record
+      
+      # proof of concept method
+      def to_be_removed
+        puts "in to_be_removed!"
+      end
+      
+    end
+  end
+end

data/stanford-mods.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/stanford-mods/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "stanford-mods"
+  gem.version       = Stanford::Mods::VERSION
+  gem.authors       = ["Naomi Dushay", "Bess Sadler"]
+  gem.email         = ["ndushay AT stanford.edu", "bess AT stanford.edu"]
+  gem.description   = "Stanford specific wrangling of MODS metadata from DOR, the Stanford Digital Object Repository"
+  gem.summary       = "Stanford specific wrangling of MODS metadata"
+  gem.homepage      = "https://github.com/sul-dlss/stanford-mods"
+
+  gem.extra_rdoc_files = ["LICENSE", "README.rdoc"]
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'mods'
+  
+  # Runtime dependencies
+  # gem.add_runtime_dependency 'nokogiri'
+
+  # Development dependencies
+  # Bundler will install these gems too if you've checked out solrmarc-wrapper source from git and run 'bundle install'
+  # It will not add these as dependencies if you require solrmarc-wrapper for other projects
+  gem.add_development_dependency "rake"
+  # docs
+  gem.add_development_dependency "rdoc"
+  gem.add_development_dependency "yard"
+  # tests
+	gem.add_development_dependency 'rspec'
+	gem.add_development_dependency 'simplecov'
+	gem.add_development_dependency 'simplecov-rcov'
+	# gem.add_development_dependency 'ruby-debug19'
+
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: stanford-mods
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Naomi Dushay
+- Bess Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mods
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stanford specific wrangling of MODS metadata from DOR, the Stanford Digital
+  Object Repository
+email:
+- ndushay AT stanford.edu
+- bess AT stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- config/mappings_hash.rb
+- lib/stanford-mods.rb
+- lib/stanford-mods/mappings.rb
+- lib/stanford-mods/version.rb
+- stanford-mods.gemspec
+homepage: https://github.com/sul-dlss/stanford-mods
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3964216596678128240
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3964216596678128240
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Stanford specific wrangling of MODS metadata
+test_files: []
+has_rdoc: