hydra-pbcore 2.4.0 → 3.0.0.rc1

data/spec/instantiation_spec.rb

@@ -154,7 +154,7 @@ describe HydraPbcore::Datastream::Instantiation do
           @digital.send("#{field}=".to_sym, field)
         end
         # Use a real date
-        @digital.date = "2012-11"
+        @digital.date = "2012-11-01"
       end
 
       it "should match an exmplar" do
@@ -163,11 +163,11 @@ describe HydraPbcore::Datastream::Instantiation do
       end
 
       it "should display dates as they were entered" do
-        @digital.to_solr["date_display"].should == ["2012-11"]
+        @digital.to_solr["date_ssm"].should == ["2012-11-01"]
       end
 
       it "should have dates converted to ISO 8601" do
-        @digital.to_solr["date_dt"].should == ["2012-11-01T00:00:00Z"]
+        @digital.to_solr["date_dtsim"].should == ["2012-11-01T00:00:00Z"]
       end
 
       it "should not index dates as text" do
@@ -236,7 +236,7 @@ describe HydraPbcore::Datastream::Instantiation do
           @physical.send("#{field}=".to_sym, field)
         end
         # Use a real date
-        @physical.date = "2012-11"
+        @physical.date = "2012-11-01"
       end
 
       it "should match an exmplar" do
@@ -245,11 +245,11 @@ describe HydraPbcore::Datastream::Instantiation do
       end
 
       it "should display dates as they were entered" do
-        @physical.to_solr["date_display"].should == ["2012-11"]
+        @physical.to_solr["date_ssm"].should == ["2012-11-01"]
       end
 
       it "should have dates converted to ISO 8601" do
-        @physical.to_solr["date_dt"].should == ["2012-11-01T00:00:00Z"]
+        @physical.to_solr["date_dtsim"].should == ["2012-11-01T00:00:00Z"]
       end
 
       it "should not index dates as text" do
@@ -259,4 +259,36 @@ describe HydraPbcore::Datastream::Instantiation do
 
   end
 
+    describe "solrization of dates" do
+
+    before :each do
+      @ds = HydraPbcore::Datastream::Instantiation.new(nil, nil)
+    end
+
+    it "creates dateable and displayable fields for complete dates" do
+      @ds.date = "1898-11-12"
+      @ds.to_solr["date_dtsim"].should == ["1898-11-12T00:00:00Z"]
+      @ds.to_solr["date_ssm"].should == ["1898-11-12"]
+    end
+
+    it "creates only displayable fields for dates without day" do
+      @ds.date = "1911-07"
+      @ds.to_solr["date_dtsim"].should be_empty
+      @ds.to_solr["date_ssm"].should == ["1911-07"]
+    end
+
+    it "creates only displayable fields for dates without day and month" do
+      @ds.date = "1945"
+      @ds.to_solr["date_dtsim"].should be_empty
+      @ds.to_solr["date_ssm"].should == ["1945"]
+    end
+
+    it "creates only displayable for non-parseable dates" do
+      @ds.date = "crap"
+      @ds.to_solr["date_dtsim"].should be_empty
+      @ds.to_solr["date_ssm"].should == ["crap"]
+    end
+
+  end 
+
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # :nodoc
 require "hydra-pbcore"
 require "equivalent-xml"
+require "pry"
 
 RSpec.configure do |config|
   config.color = true

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: hydra-pbcore
 version: !ruby/object:Gem::Version
-  version: 2.4.0
-  prerelease: 
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Adam Wead
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,23 +27,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: solrizer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - <
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - <
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -134,7 +118,34 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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: pry
+  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
@@ -149,127 +160,71 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - hydra-pbcore.gemspec
 - lib/hydra-pbcore.rb
 - lib/hydra_pbcore/behaviors.rb
-- lib/hydra_pbcore/conversions.rb
 - lib/hydra_pbcore/datastream.rb
-- lib/hydra_pbcore/datastream/deprecated.rb
-- lib/hydra_pbcore/datastream/deprecated/digital_document.rb
-- lib/hydra_pbcore/datastream/deprecated/document.rb
-- lib/hydra_pbcore/datastream/deprecated/instantiation.rb
 - lib/hydra_pbcore/datastream/document.rb
 - lib/hydra_pbcore/datastream/instantiation.rb
-- lib/hydra_pbcore/mapper.rb
 - lib/hydra_pbcore/methods.rb
 - lib/hydra_pbcore/templates.rb
 - lib/hydra_pbcore/version.rb
-- spec/deprecated/digital_document_spec.rb
-- spec/deprecated/document_spec.rb
-- spec/deprecated/instantiation_spec.rb
+- spec/config_spec.rb
 - spec/document_spec.rb
-- spec/fixtures/converted_digital_document_rrhof_1904.xml
-- spec/fixtures/converted_digital_document_rrhof_2405.xml
-- spec/fixtures/converted_document_rrhof_2439.xml
-- spec/fixtures/converted_document_rrhof_524.xml
-- spec/fixtures/converted_instantiation_rrhof_1184.xml
-- spec/fixtures/converted_rrhof_524.xml
-- spec/fixtures/converted_rrhof_524_instantiation.xml
-- spec/fixtures/deprecated/pbcore_digital_document_template.xml
-- spec/fixtures/deprecated/pbcore_document_template.xml
-- spec/fixtures/deprecated/pbcore_instantiation_template.xml
-- spec/fixtures/deprecated/pbcore_solr_digital_document_template.xml
-- spec/fixtures/deprecated/pbcore_solr_document_template.xml
-- spec/fixtures/deprecated/pbcore_solr_instantiation_template.xml
 - spec/fixtures/digital_instantiation.xml
 - spec/fixtures/digital_instantiation_solr.xml
 - spec/fixtures/digital_instantiation_template.xml
 - spec/fixtures/document.xml
 - spec/fixtures/document_solr.xml
 - spec/fixtures/document_template.xml
-- spec/fixtures/integration/digital_document_rrhof_1904.xml
-- spec/fixtures/integration/digital_document_rrhof_2405.xml
-- spec/fixtures/integration/document_rrhof_2439.xml
-- spec/fixtures/integration/document_rrhof_524.xml
-- spec/fixtures/integration/instantiation_rrhof_1184.xml
 - spec/fixtures/physical_instantiation.xml
 - spec/fixtures/physical_instantiation_solr.xml
 - spec/fixtures/physical_instantiation_template.xml
 - spec/instantiation_spec.rb
-- spec/integration/conversions_spec.rb
-- spec/mapper_spec.rb
 - spec/methods_spec.rb
 - spec/spec_helper.rb
 - spec/templates_spec.rb
 - tmp/.gitkeep
 homepage: ''
 licenses: []
+metadata: {}
 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: 3882171645005853524
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3882171645005853524
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Hydra gem that offers PBCore datastream definitions using OM
 test_files:
-- spec/deprecated/digital_document_spec.rb
-- spec/deprecated/document_spec.rb
-- spec/deprecated/instantiation_spec.rb
+- spec/config_spec.rb
 - spec/document_spec.rb
-- spec/fixtures/converted_digital_document_rrhof_1904.xml
-- spec/fixtures/converted_digital_document_rrhof_2405.xml
-- spec/fixtures/converted_document_rrhof_2439.xml
-- spec/fixtures/converted_document_rrhof_524.xml
-- spec/fixtures/converted_instantiation_rrhof_1184.xml
-- spec/fixtures/converted_rrhof_524.xml
-- spec/fixtures/converted_rrhof_524_instantiation.xml
-- spec/fixtures/deprecated/pbcore_digital_document_template.xml
-- spec/fixtures/deprecated/pbcore_document_template.xml
-- spec/fixtures/deprecated/pbcore_instantiation_template.xml
-- spec/fixtures/deprecated/pbcore_solr_digital_document_template.xml
-- spec/fixtures/deprecated/pbcore_solr_document_template.xml
-- spec/fixtures/deprecated/pbcore_solr_instantiation_template.xml
 - spec/fixtures/digital_instantiation.xml
 - spec/fixtures/digital_instantiation_solr.xml
 - spec/fixtures/digital_instantiation_template.xml
 - spec/fixtures/document.xml
 - spec/fixtures/document_solr.xml
 - spec/fixtures/document_template.xml
-- spec/fixtures/integration/digital_document_rrhof_1904.xml
-- spec/fixtures/integration/digital_document_rrhof_2405.xml
-- spec/fixtures/integration/document_rrhof_2439.xml
-- spec/fixtures/integration/document_rrhof_524.xml
-- spec/fixtures/integration/instantiation_rrhof_1184.xml
 - spec/fixtures/physical_instantiation.xml
 - spec/fixtures/physical_instantiation_solr.xml
 - spec/fixtures/physical_instantiation_template.xml
 - spec/instantiation_spec.rb
-- spec/integration/conversions_spec.rb
-- spec/mapper_spec.rb
 - spec/methods_spec.rb
 - spec/spec_helper.rb
 - spec/templates_spec.rb

data/lib/hydra_pbcore/conversions.rb

@@ -1,107 +0,0 @@
-# Methods for converting HydraPbcore 1.x datastreams to HydraPbcore 2.x datastreams
-#
-# Verion 1.x of the HydraPbcore gem uses two kinds of pbcoreDocuments, one which includes an instantation
-# and one which does not.  Version 2 of the gem refactors these so that there
-# is only one kind of pbcoreDocument and two kinds of instatiations.  This offers greater flexibility
-# as any number of instantiations may be attached to a document.  Instatntiations come in two types,
-# one is physical, meaning it represents a tape or other
-# tangible object on which the video content resides, while the other kind is
-# digital, representing a video file.
-#
-# These methods attempt to correct invalid or inconsistent xml created using the first version of the 
-# gem.
-
-module HydraPbcore::Conversions
-
-  # Converts a HydraPbcore::Datastream::Deprecated::Document to a HydraPbcore::Datastream::Document
-  # - the existing pbcoreInstantiation node is removed and returned
-  def to_document xml = self.ng_xml
-    xml.search("//pbcoreInstantiation").remove
-  end
-
-  # Extracts the instantation from a HydraPbcore::Datastream::Deprecated::Document and returns
-  # a physical HydraPbcore::Datastream::Instantion
-  # - removes all instantiationRelation nodes
-  # - adds source="PBCore instantiationColors" to instantiationColors node
-  # - extracts the pbcoreInstantiation node and returns new Instantiation object
-  def to_physical_instantiation xml = self.ng_xml 
-    xml.search("//instantiationRelation").each do |node|  
-      node.remove
-    end
-    xml.search("//instantiationColors").first["source"] = "PBCore instantiationColors"
-    inst_xml = xml.xpath("//pbcoreInstantiation")
-    HydraPbcore::Datastream::Instantiation.from_xml(inst_xml.to_xml)
-  end
-
-  # Converts a HydraPbcore::Datastream::Deprecated::Instantiation to a HydraPbcore::Datastream::Instantiation
-  # Modifies the exiting xml to exclude any parent nodes of the pbcoreInstantiation node
-  def to_instantiation
-    self.ng_xml = self.ng_xml.xpath("//pbcoreInstantiation").to_xml
-  end
-
-  # Corrects errors in HydraPbcore::Datastream::Deprecated::Document
-  # - removes all pbcoreRelation nodes, except those that define event_series
-  # - removes orphaned pbcoreRelationIdentifier nodes
-  # - corrects invalid usage of event_place and event_series terms
-  def clean_document xml = self.ng_xml
-    xml.search("//pbcoreRelation").each do |node|  
-      node.remove unless is_relation?("Event Series", node)
-    end
-    xml.search("/pbcoreDescriptionDocument/pbcoreRelationIdentifier").collect {|n| n.remove}
-    xml.search("/pbcoreDescriptionDocument/instantiationRelationIdentifier").collect {|n| n.remove}
-    xml.search("//pbcoreCoverage").each do |node|
-      node.children.each do |c|
-        if c.attribute("annotation").nil? and c.name == "coverage"
-          self.send(("insert_"+coverage_type(node)), c.text)
-          c.remove
-        end
-      end
-    end
-  end
-
-  # Corrects errors in HydraPbcore::Datastream::Deprecated::DigitalDocument
-  # - finds the current archival collection
-  # - removes all pbcoreRelation nodes, except those that define event_series
-  # - re-inserts the collection
-  # - removes orphaned pbcoreRelationIdentifier nodes
-  # - corrects invalid usage of event_place and event_series terms
-  def clean_digital_document xml = self.ng_xml
-    collection = xml.search("//pbcoreRelationIdentifier[@annotation='Archival Collection']").text
-    xml.search("//pbcoreRelation").each do |node|  
-      unless is_relation?("Accession Number", node) or is_relation?("Event Series", node)
-        node.remove
-      end
-    end
-    xml.search("/pbcoreDescriptionDocument/pbcoreRelationIdentifier").collect {|n| n.remove}
-    xml.search("/pbcoreDescriptionDocument/instantiationRelationIdentifier").collect {|n| n.remove}
-    self.insert_relation(collection, "Archival Collection") unless collection.nil?
-    xml.search("//pbcoreCoverage").each do |node|
-      node.children.each do |c|
-        if c.attribute("annotation").nil? and c.name == "coverage"
-          self.send(("insert_"+coverage_type(node)), c.text)
-          c.remove
-        end
-      end
-    end
-  end
-
-  # Determines if the given node defines a relation of a give type
-  def is_relation? type, node
-    unless node.at_xpath("pbcoreRelationIdentifier").nil?
-      if node.at_xpath("pbcoreRelationIdentifier").attribute("annotation").to_s == type
-        return true
-      end
-    end
-  end
-
-  # Determines if a coverage node that has no annotation attribute should be either an event_date term or an event_date term.
-  # Returns the first instance of an annotation attribute, processing it so that may be sent directly to 
-  # the datastream as a method.
-  def coverage_type node
-    node.children.each do |c|
-      return c.attribute("annotation").to_s.split.last.downcase unless c.attribute("annotation").nil?
-    end
-  end
-
-
-end