ruby-avm-library 0.0.1

data/spec/avm/observation_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+require 'avm/image'
+require 'avm/observation'
+
+describe AVM::Observation do
+  let(:image) { AVM::Image.new }
+  let(:observation) { image.create_observation(options) }
+
+  subject { observation }
+
+  let(:facility) { 'HST' }
+  let(:instrument) { 'ACS' }
+  let(:color_assignment) { 'Blue' }
+  let(:band) { 'em.opt' }
+  let(:bandpass) { 'B' }
+  let(:wavelength) { 2.5 }
+  let(:start_time) { '2010-01-01' }
+  let(:start_time_string) { '2010-01-01T00:00' }
+  let(:integration_time) { '300' }
+  let(:dataset_id) { '12345' }
+
+  let(:options) { {
+    :facility => facility,
+    :instrument => instrument,
+    :color_assignment => color_assignment,
+    :band => band,
+    :bandpass => bandpass,
+    :wavelength => wavelength,
+    :start_time => start_time,
+    :integration_time => integration_time,
+    :dataset_id => dataset_id,
+  } }
+
+  let(:second_facility) { 'Chandra' }
+  let(:second_instrument) { 'X-Ray' }
+  let(:second_color_assignment) { 'Green' }
+  let(:second_band) { 'em.x-ray' }
+  let(:second_bandpass) { 'C' }
+  let(:second_wavelength) { nil }
+  let(:second_start_time) { '2010-01-02' }
+  let(:second_start_time_string) { '2010-01-02T00:00' }
+  let(:second_integration_time) { '400' }
+  let(:second_dataset_id) { '23456' }
+
+  let(:second_options) { {
+    :facility => second_facility,
+    :instrument => second_instrument,
+    :color_assignment => second_color_assignment,
+    :band => second_band,
+    :bandpass => second_bandpass,
+    :wavelength => second_wavelength,
+    :start_time => second_start_time,
+    :integration_time => second_integration_time,
+    :dataset_id => second_dataset_id,
+  } }
+
+  def self.check_defaults
+    its(:facility) { should == facility }
+    its(:instrument) { should == instrument }
+    its(:color_assignment) { should == color_assignment }
+    its(:band) { should == band }
+    its(:bandpass) { should == bandpass }
+    its(:wavelength) { should == wavelength }
+    its(:start_time) { should == Time.parse(start_time) }
+    its(:integration_time) { should == integration_time }
+    its(:dataset_id) { should == dataset_id }
+
+    its(:to_h) { should == {
+      :facility => facility,
+      :instrument => instrument,
+      :color_assignment => color_assignment,
+      :band => band,
+      :bandpass => bandpass,
+      :wavelength => wavelength,
+      :start_time => Time.parse(start_time),
+      :integration_time => integration_time,
+      :dataset_id => dataset_id
+    } }
+  end
+
+  context 'defaults' do
+    check_defaults
+  end
+
+  describe '.from_xml' do
+    let(:image) { AVM::Image.from_xml(File.read(file_path)) }
+    let(:observations) { image.observations }
+
+    subject { observations }
+
+    context 'no observations' do
+      let(:file_path) { 'spec/sample_files/observation/none.xmp' }
+
+      it { should == [] }
+    end
+
+    context 'one observation' do
+      let(:file_path) { 'spec/sample_files/observation/one.xmp' }
+
+      its(:length) { should == 1 }
+
+      context 'first observation' do
+        subject { observations.first }
+
+        check_defaults
+      end
+    end
+
+    context 'two observations' do
+      let(:file_path) { 'spec/sample_files/observation/two.xmp' }
+
+      its(:length) { should == 2 }
+
+      context 'first observation' do
+        subject { observations.first }
+
+        check_defaults
+      end
+
+      context 'second observation' do
+        subject { observations.last }
+
+        its(:facility) { should == second_facility }
+        its(:instrument) { should == second_instrument }
+        its(:color_assignment) { should == second_color_assignment }
+        its(:band) { should == second_band }
+        its(:bandpass) { should == second_bandpass }
+        its(:wavelength) { should == second_wavelength }
+        its(:start_time) { should == Time.parse(second_start_time) }
+        its(:integration_time) { should == second_integration_time }
+        its(:dataset_id) { should == second_dataset_id }
+      end
+    end
+  end
+
+  describe '.add_to_document' do
+    let(:xml) { image.to_xml }
+    let(:avm) { xml.at_xpath('//rdf:Description[@rdf:about="AVM"]') }
+
+    context 'none' do
+      it "should not have any observation information" do
+        %w{Facility Instrument Spectral.ColorAssignment Spectral.Band Spectral.Bandpass Spectral.CentralWavelength Temporal.StartTime Temporal.IntegrationTime DatasetID}.each do |name|
+          avm.at_xpath("//avm:#{name}").should be_nil
+        end
+      end
+    end
+
+    context 'one' do
+      before { observation }
+
+      it "should have the AVM values" do
+        {
+          'Facility' => facility,
+          'Instrument' => instrument,
+          'Spectral.ColorAssignment' => color_assignment,
+          'Spectral.Band' => band,
+          'Spectral.Bandpass' => bandpass,
+          'Spectral.CentralWavelength' => wavelength,
+          'Temporal.StartTime' => start_time_string,
+          'Temporal.IntegrationTime' => integration_time,
+          'DatasetID' => dataset_id
+        }.each do |name, value|
+          avm.at_xpath("//avm:#{name}").text.should == value.to_s
+        end
+      end
+    end
+
+    context 'two' do
+      let(:second_observation) { image.create_observation(second_options) }
+
+
+      before { observation ; second_observation }
+
+      it "should have the AVM values" do
+        {
+          'Facility' => [ facility, second_facility ].join(','),
+          'Instrument' => [ instrument, second_instrument ].join(','),
+          'Spectral.ColorAssignment' => [ color_assignment, second_color_assignment ].join(','),
+          'Spectral.Band' => [ band, second_band ].join(','),
+          'Spectral.Bandpass' => [ bandpass, second_bandpass ].join(','),
+          'Spectral.CentralWavelength' => [ wavelength, second_wavelength || '-' ].join(','),
+          'Temporal.StartTime' => [ start_time_string, second_start_time_string ].join(','),
+          'Temporal.IntegrationTime' => [ integration_time, second_integration_time ].join(','),
+          'DatasetID' => [ dataset_id, second_dataset_id ].join(',')
+        }.each do |name, value|
+          avm.at_xpath("//avm:#{name}").text.should == value.to_s
+        end
+      end
+    end
+  end
+end

data/spec/avm/xmp_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require 'avm/xmp'
+
+describe AVM::XMP do
+  let(:xmp) { self.class.describes.new }
+
+  subject { xmp }
+
+  describe '#initialize' do
+    context 'not a nokogiri document' do
+      let(:xmp) { self.class.describes.new("definitely not nokogiri node") }
+
+      it { expect { xmp }.to raise_error(StandardError, /not a Nokogiri node/) }
+    end
+  end
+
+  describe '#get_refs' do
+    before {
+      xmp.get_refs do |refs|
+        refs[:dublin_core] << "<rdf:addedToDublinCore />"
+        refs[:iptc] << "<rdf:addedToIPTC />"
+        refs[:photoshop] << '<rdf:addedToPhotoshop />'
+        refs[:avm] << '<rdf:addedToAVM />'
+      end
+    }
+
+    it "should have gotten the refs correctly" do
+      xmp.doc.at_xpath('//rdf:Description[@rdf:about="Dublin Core"]//rdf:addedToDublinCore').should_not be_nil
+      xmp.doc.at_xpath('//rdf:Description[@rdf:about="IPTC"]//rdf:addedToIPTC').should_not be_nil
+      xmp.doc.at_xpath('//rdf:Description[@rdf:about="Photoshop"]//rdf:addedToPhotoshop').should_not be_nil
+      xmp.doc.at_xpath('//rdf:Description[@rdf:about="AVM"]//rdf:addedToAVM').should_not be_nil
+    end
+  end
+
+  describe 'xml from string' do
+    let(:xmp) { self.class.describes.from_string(string) }
+    let(:doc) { xmp.doc }
+
+    describe '.from_string' do
+      let(:string) { '<xml xmlns:rdf="cats"><rdf:RDF><node /></rdf:RDF></xml>' }
+
+      specify { xmp.doc.at_xpath('//node').should_not be_nil }
+    end
+
+    describe '#ensure_namespaces! and #ensure_xmlns' do
+      let(:rdf_namespace) { AVM::XMP::REQUIRED_NAMESPACES[:rdf] }
+
+      def self.all_default_namespaces
+        it "should have all the namespaces with the default prefixes" do
+          namespaces = doc.document.collect_namespaces
+
+          namespaces_to_test = AVM::XMP::REQUIRED_NAMESPACES.dup
+          yield namespaces_to_test if block_given?
+
+          namespaces_to_test.each do |prefix, namespace|
+            if namespace
+              namespaces["xmlns:#{prefix}"].should == namespace
+            end
+          end
+        end
+      end
+
+      before { doc }
+
+      context 'none of the namespaces exist' do
+        let(:string) { '<xml><node /></xml>' }
+
+        all_default_namespaces
+
+        specify { xmp.ensure_xmlns('.//rdf:what').should == './/rdf:what' }
+      end
+
+      context 'one namespace exists with the same prefix' do
+        let(:string) { %{<xml xmlns:rdf="#{rdf_namespace}"><node /></xml>} }
+
+        all_default_namespaces
+
+        specify { xmp.ensure_xmlns('.//rdf:what').should == './/rdf:what' }
+      end
+
+      context 'one namespace exists with a different prefix' do
+        let(:string) { %{<xml xmlns:r="#{rdf_namespace}"><node /></xml>} }
+
+        all_default_namespaces { |namespaces|
+          namespaces.delete(:rdf)
+          namespaces[:r] = AVM::XMP::REQUIRED_NAMESPACES[:rdf]
+        }
+
+        specify { xmp.ensure_xmlns('.//rdf:what').should == './/r:what' }
+      end
+    end
+  end
+
+  describe '#ensure_descriptions_findable!' do
+    let(:document) { <<-XML }
+<x:xmpmeta xmlns:x="adobe:ns:meta/">
+  <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+    #{content}
+  </rdf:RDF>
+</x:xmpmeta>
+    XML
+
+    let(:xmp) { self.class.describes.new(Nokogiri::XML(document)) }
+
+    context 'no nodes within' do
+      let(:content) { '' }
+
+      [ 'Dublin Core', 'IPTC', 'Photoshop', 'AVM' ].each do |which|
+        specify { xmp.at_xpath(%{//rdf:Description[@rdf:about="#{which}"]}).children.should be_empty }
+      end
+    end
+
+    context 'has identifying nodes within' do
+      let(:content) { <<-XML }
+<rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:creator />
+</rdf:Description>
+<rdf:Description rdf:about="" xmlns:Iptc4xmpCore="http://itpc.org/stf/Iptc4xmpCore/1.0/xmlns/">
+  <Iptc4xmpCore:CreatorContactInfo rdf:parseType="Resource" />
+</rdf:Description>
+<rdf:Description rdf:about="" xmlns:Photoshop="http://ns.adobe.com/photoshop/1.0/">
+  <photoshop:Something />
+</rdf:Description>
+<rdf:Description rdf:about="" xmlns:avm="http://www.communicatingastronomy.org/avm/1.0/">
+  <avm:Something />
+</rdf:Description>
+      XML
+
+      [ 'Dublin Core', 'IPTC', 'Photoshop', 'AVM' ].each do |which|
+        specify { xmp.at_xpath(%{//rdf:Description[@rdf:about="#{which}"]}).should_not be_nil }
+      end
+    end
+
+    context 'has a namespace it should know about with a different prefix' do
+      let(:content) { <<-XML }
+<rdf:Description rdf:about="" xmlns:whatever="http://purl.org/dc/elements/1.1/">
+  <whatever:creator />
+</rdf:Description>
+      XML
+
+      specify { xmp.at_xpath(%{//rdf:Description[@rdf:about="Dublin Core"]}).should_not be_nil }
+    end
+
+    context 'has a namespace it knows nothing about' do
+      let(:content) { <<-XML }
+<rdf:Description rdf:about="" xmlns:whatever="http://example.com">
+  <whatever:creator />
+</rdf:Description>
+      XML
+
+      it { expect { xmp }.to_not raise_error }
+    end
+  end
+end

data/spec/quick_fix_formatter.rb

@@ -0,0 +1,26 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+module RSpec
+  module Core
+    module Formatters
+      class QuickFixFormatter < BaseTextFormatter
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+
+        def dump_profile
+        end
+
+        def dump_pending
+        end
+
+        def dump_failures
+          failed_examples.each do |example|
+            output.puts "%s:%s:%s" % [ example.file_path, example.metadata[:line_number], example.metadata[:execution_result][:exception].message ]
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/spec/sample_files/creator/no_creator.xmp

@@ -0,0 +1,14 @@
+<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 4.2.2-c063 53.352624, 2008/07/30-18:05:41        ">
+  <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+    <rdf:Description rdf:about=""
+      xmlns:dc="http://purl.org/dc/elements/1.1/">
+      <dc:creator />
+    </rdf:Description>
+    <rdf:Description rdf:about=""
+      xmlns:Iptc4xmpCore="http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/">
+      <Iptc4xmpCore:CreatorContactInfo rdf:parseType="Resource">
+      </Iptc4xmpCore:CreatorContactInfo>
+    </rdf:Description>
+  </rdf:RDF>
+</x:xmpmeta>
+

data/spec/sample_files/creator/one_creator.xmp

@@ -0,0 +1,28 @@
+<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 4.2.2-c063 53.352624, 2008/07/30-18:05:41        ">
+  <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+    <rdf:Description rdf:about=""
+      xmlns:dc="http://purl.org/dc/elements/1.1/">
+      <dc:creator>
+        <rdf:Seq><rdf:li>John Bintz</rdf:li></rdf:Seq>
+      </dc:creator>
+      <dc:title>
+        <rdf:Alt>
+          <rdf:li xml:lang="x-default">This is an image</rdf:li>
+        </rdf:Alt>
+      </dc:title>
+    </rdf:Description>
+    <rdf:Description rdf:about=""
+      xmlns:Iptc4xmpCore="http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/">
+      <Iptc4xmpCore:CreatorContactInfo rdf:parseType="Resource">
+        <Iptc4xmpCore:CiAdrExtadr>3700 San Martin Drive</Iptc4xmpCore:CiAdrExtadr>
+        <Iptc4xmpCore:CiAdrCity>Baltimore</Iptc4xmpCore:CiAdrCity>
+        <Iptc4xmpCore:CiAdrRegion>Maryland</Iptc4xmpCore:CiAdrRegion>
+        <Iptc4xmpCore:CiAdrPcode>21218</Iptc4xmpCore:CiAdrPcode>
+        <Iptc4xmpCore:CiAdrCtry>USA</Iptc4xmpCore:CiAdrCtry>
+        <Iptc4xmpCore:CiTelWork>800-555-1234</Iptc4xmpCore:CiTelWork>
+        <Iptc4xmpCore:CiEmailWork>bintz@stsci.edu</Iptc4xmpCore:CiEmailWork>
+        <Iptc4xmpCore:CiUrlWork>http://hubblesite.org</Iptc4xmpCore:CiUrlWork>
+      </Iptc4xmpCore:CreatorContactInfo>
+    </rdf:Description>
+  </rdf:RDF>
+</x:xmpmeta>

data/spec/sample_files/creator/two_creators.xmp

@@ -0,0 +1,26 @@
+<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 4.2.2-c063 53.352624, 2008/07/30-18:05:41        ">
+  <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+    <rdf:Description rdf:about=""
+      xmlns:dc="http://purl.org/dc/elements/1.1/">
+      <dc:creator>
+        <rdf:Seq>
+          <rdf:li>John Bintz</rdf:li>
+          <rdf:li>Aohn Bintz</rdf:li>
+        </rdf:Seq>
+      </dc:creator>
+    </rdf:Description>
+    <rdf:Description rdf:about=""
+      xmlns:Iptc4xmpCore="http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/">
+      <Iptc4xmpCore:CreatorContactInfo rdf:parseType="Resource">
+        <Iptc4xmpCore:CiAdrExtadr>3700 San Martin Drive</Iptc4xmpCore:CiAdrExtadr>
+        <Iptc4xmpCore:CiAdrCity>Baltimore</Iptc4xmpCore:CiAdrCity>
+        <Iptc4xmpCore:CiAdrRegion>Maryland</Iptc4xmpCore:CiAdrRegion>
+        <Iptc4xmpCore:CiAdrPcode>21218</Iptc4xmpCore:CiAdrPcode>
+        <Iptc4xmpCore:CiAdrCtry>USA</Iptc4xmpCore:CiAdrCtry>
+        <Iptc4xmpCore:CiTelWork>800-555-1234,800-555-2345</Iptc4xmpCore:CiTelWork>
+        <Iptc4xmpCore:CiEmailWork>bintz@stsci.edu,aohn@stsci.edu</Iptc4xmpCore:CiEmailWork>
+        <Iptc4xmpCore:CiUrlWork>http://hubblesite.org</Iptc4xmpCore:CiUrlWork>
+      </Iptc4xmpCore:CreatorContactInfo>
+    </rdf:Description>
+  </rdf:RDF>
+</x:xmpmeta>

data/spec/sample_files/image/both.xmp

@@ -0,0 +1,101 @@
+<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 4.2.2-c063 53.352624, 2008/07/30-18:05:41        ">
+  <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+    <rdf:Description rdf:about=""
+      xmlns:dc="http://purl.org/dc/elements/1.1/">
+      <dc:title>:
+        <rdf:Alt>
+          <rdf:li xml:lang="x-default">My title</rdf:li>
+        </rdf:Alt>
+      </dc:title>
+      <dc:description>
+        <rdf:Alt>
+          <rdf:li xml:lang="x-default">Description</rdf:li>
+        </rdf:Alt>
+      </dc:description>
+      <dc:subject>
+        <rdf:Bag>
+          <rdf:li>Name one</rdf:li>
+          <rdf:li>Name two</rdf:li>
+        </rdf:Bag>
+      </dc:subject>
+    </rdf:Description>
+    <rdf:Description rdf:about=""
+      xmlns:Iptc4xmpCore="http://iptc.org/std/Iptc4xmpCore/1.0/xmlns/">
+      <Iptc4xmpCore:CreatorContactInfo rdf:parseType="Resource">
+      </Iptc4xmpCore:CreatorContactInfo>
+    </rdf:Description>
+    <rdf:Description rdf:about=""
+      xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/">
+      <photoshop:Headline>Headline</photoshop:Headline>
+      <photoshop:Credit>Credit</photoshop:Credit>
+      <photoshop:DateCreated>2010-01-01</photoshop:DateCreated>
+    </rdf:Description>
+    <rdf:Description rdf:about=""
+      xmlns:avm="http://www.communicatingastronomy.org/avm/1.0/">
+      <avm:Spectral.Notes>Spectral Notes</avm:Spectral.Notes>
+      <avm:Distance.Notes>Distance Notes</avm:Distance.Notes>
+      <avm:ReferenceURL>Reference URL</avm:ReferenceURL>
+      <avm:ID>ID</avm:ID>
+      <avm:Type>Observation</avm:Type>
+      <avm:Image.ProductQuality>Good</avm:Image.ProductQuality>
+      <avm:Subject.Category>Category one; Category two</avm:Subject.Category>
+      <avm:Distance>
+        <rdf:Seq>
+          <rdf:li>Light years</rdf:li>
+          <rdf:li>Redshift</rdf:li>
+        </rdf:Seq>
+      </avm:Distance>
+      <avm:Spatial.CoordinateFrame>ICRS</avm:Spatial.CoordinateFrame>
+      <avm:Spatial.Equinox>100</avm:Spatial.Equinox>
+      <avm:Spatial.ReferenceValue>
+        <rdf:Seq>
+          <rdf:li>100</rdf:li>
+          <rdf:li>50</rdf:li>
+        </rdf:Seq>
+      </avm:Spatial.ReferenceValue>
+      <avm:Spatial.ReferenceDimension>
+        <rdf:Seq>
+          <rdf:li>200</rdf:li>
+          <rdf:li>150</rdf:li>
+        </rdf:Seq>
+      </avm:Spatial.ReferenceDimension>
+      <avm:Spatial.ReferencePixel>
+        <rdf:Seq>
+          <rdf:li>25</rdf:li>
+          <rdf:li>15</rdf:li>
+        </rdf:Seq>
+      </avm:Spatial.ReferencePixel>
+      <avm:Spatial.Scale>
+        <rdf:Seq>
+          <rdf:li>40</rdf:li>
+          <rdf:li>35</rdf:li>
+        </rdf:Seq>
+      </avm:Spatial.Scale>
+      <avm:Spatial.Rotation>10</avm:Spatial.Rotation>
+      <avm:Spatial.CoordsystemProjection>TAN</avm:Spatial.CoordsystemProjection>
+      <avm:Spatial.Quality>Full</avm:Spatial.Quality>
+      <avm:Spatial.Notes>Spatial Notes</avm:Spatial.Notes>
+      <avm:Spatial.FITSheader>FITS header</avm:Spatial.FITSheader>
+      <avm:Spatial.CDMatrix>
+        <rdf:Seq>
+          <rdf:li>1</rdf:li>
+          <rdf:li>2</rdf:li>
+          <rdf:li>3</rdf:li>
+          <rdf:li>4</rdf:li>
+        </rdf:Seq>
+      </avm:Spatial.CDMatrix>
+      <avm:Publisher>Publisher</avm:Publisher>
+      <avm:PublisherID>Publisher ID</avm:PublisherID>
+      <avm:ResourceID>Resource ID</avm:ResourceID>
+      <avm:ResourceURL>Resource URL</avm:ResourceURL>
+      <avm:RelatedResources>
+        <rdf:Bag>
+          <rdf:li>Resource 1</rdf:li>
+          <rdf:li>Resource 2</rdf:li>
+        </rdf:Bag>
+      </avm:RelatedResources>
+      <avm:MetadataDate>2010-01-05</avm:MetadataDate>
+      <avm:MetadataVersion>1.2</avm:MetadataVersion>
+    </rdf:Description>
+  </rdf:RDF>
+</x:xmpmeta>