adiwg-mdtranslator 2.0.0rc8 → 2.0.0rc9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13bbb8eca7807bfba16ecf13280d1a558c347677
-  data.tar.gz: d5a3d8d0dea0fd2a0ef8165aeeae4c335782ab4e
+  metadata.gz: ad510fae06cdf03810393ba683686f22f9fe569e
+  data.tar.gz: 24acaf6b181b68e723835ab70648b76481abfac3
 SHA512:
-  metadata.gz: 9ef6d70c38ce2070c82b4511ba0fbdccb704bf7963ebc90468e02cd7a40fdacefff5613ed0da2f18cdf74e4941869bc126f1532f09f3dbc26041456b5596c438
-  data.tar.gz: 317c72de89f921ead67cc611b9b7f480d1bd6020b1024923db3f44684d7eb48930b11c941b84c9c57838a4cdfe3ef34ba1837eb6ce43369dab3a1ab4227a8f61
+  metadata.gz: 9476a3bc114e8c5d5f98fa695f629b857b6a530ecceaa254b60cc9dfb33c1a9628de3c73ed47ea6d233746caa9575cb6c0e1df4c969bda4ab41b7068c7d97029
+  data.tar.gz: 9f5c4dac97608fc35749ee8e5f407c26deb48c00c7d5dcf885c14b1fb8dd7b81cafe895ec20fc52364a0c9c8640a0598e97b0c1ec44c0b3ff38d6f855cb57d63

data/lib/adiwg/mdtranslator/internal/module_coordinates.rb

@@ -13,6 +13,8 @@
 
 module AdiwgCoordinates
 
+   @spanWorld = 0
+
    # repack coordinate array into single string for ISO
    def self.stringifyCoords(aCoords, responseObj)
 
@@ -63,6 +65,9 @@ module AdiwgCoordinates
    # compute bounding box
    def self.computeBbox(aGeo)
 
+      # reset spanned world to 0 before computing bounding box
+      @spanWorld = 0
+
       # find all the eastings (x) and northings (y) in the GeoJSON object
       aNorthings = []
       aEastings = []
@@ -155,7 +160,8 @@ module AdiwgCoordinates
 
    end
 
-   # move geometry to real world if necessary
+   # move geometry to real world if possible
+   # move geometry to a single spanned meridian
    def self.checkGeometry(aCoords, aNorthings, aEastings)
 
       aGeoNorthings = []
@@ -165,6 +171,8 @@ module AdiwgCoordinates
 
       minEast = aGeoEastings.min
       maxEast = aGeoEastings.max
+
+      # if all coordinates in -1 or +1 world, move back to real world
       if maxEast < -180
          aGeoEastings.collect! { |x| x + 360 }
       end
@@ -172,6 +180,23 @@ module AdiwgCoordinates
          aGeoEastings.collect! { |x| x - 360 }
       end
 
+      minEast = aGeoEastings.min
+      maxEast = aGeoEastings.max
+
+      # if geoObject spans a meridian, find out which one and make it default
+      if @spanWorld == 0
+         @spanWorld = -1 if maxEast < 0 && minEast < -180
+         @spanWorld = 1 if minEast > 0 && maxEast > 180
+      end
+
+      # bring -1 and +1 world objects back into default meridian world
+      if @spanWorld == -1 && maxEast > 180
+         aGeoEastings.collect! { |x| x - 360 }
+      end
+      if @spanWorld == 1 && minEast < -180
+         aGeoEastings.collect! { |x| x + 360 }
+      end
+
       aEastings.concat(aGeoEastings)
       aNorthings.concat(aGeoNorthings)
 

data/lib/adiwg/mdtranslator/version.rb

@@ -1,6 +1,9 @@
 # adiwg mdTranslator
 
 # version 2 history
+# 2.0.0rc9 2017-05-26 allow choice of which dictionary to translate
+#                 ... fix bug when no dictionary is provided in mdJson
+#                 ... add sbJson writer
 # 2.0.0rc6 2017-05-24 move geometries to real world if in -1 or +1 world
 #                 --- removed special characters from ids for gml:id= in iso writers
 # 2.0.0rc5 2017-05-20 Fixed bug with no writer provided
@@ -13,7 +16,7 @@
 module ADIWG
    module Mdtranslator
       # current mdtranslator version
-      VERSION = "2.0.0rc8"
+      VERSION = "2.0.0rc9"
    end
 end
 

data/lib/adiwg/mdtranslator/writers/html/readme.md

@@ -1,6 +1,10 @@
 
 ## html
 
+### Supported versions
+
+> Supports mdTranslator version 2.x
+
 ### Writer for HTML 'human-readable' output of metadata
 
 The HTML Metadata Record output from the mdTranslator is intended to 

data/lib/adiwg/mdtranslator/writers/iso19110/iso19110_writer.rb

@@ -1,68 +1,79 @@
 # Writer - internal data structure to ISO 19110:2003
 
 # History:
-#   Stan Smith 2017-01-20 refactor for mdJson/mdTranslator 2.0
+#  Stan Smith 2017-05-26 allow choice of which dictionary to translate
+#                    ... fix bug when no dictionary is provided in mdJson
+#  Stan Smith 2017-01-20 refactor for mdJson/mdTranslator 2.0
+#  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
+#  Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2015-03-02 added test and return for missing data dictionary
+#  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
 # 	Stan Smith 2014-12-01 original script
-#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-03-02 added test and return for missing data dictionary
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
-#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
 require 'builder'
 require_relative 'classes/class_fcFeatureCatalogue'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19110
+   module Mdtranslator
+      module Writers
+         module Iso19110
 
-                def self.startWriter(intObj, responseObj)
+            def self.startWriter(intObj, responseObj, whichDict: 0)
 
-                    # make contacts and domains available to the instance
-                    @contacts = intObj[:contacts]
-                    @domains = intObj[:dataDictionaries][0][:domains]
+               # Iso19110 can only output one dictionary at a time
+               # test if requested dictionary is in input file
+               if intObj[:dataDictionaries][whichDict].nil?
+                  responseObj[:writerMessages] << 'Dictionary is missing'
+                  responseObj[:writerPass] = false
+                  return nil
+               end
 
-                    # set the format of the output file based on the writer specified
-                    responseObj[:writerFormat] = 'xml'
+               # make contacts and domains available to the instance
+               @contacts = intObj[:contacts]
+               dictionary = intObj[:dataDictionaries][whichDict]
+               @domains = dictionary[:domains]
 
-                    # create new XML document
-                    xml = Builder::XmlMarkup.new(indent: 3)
+               # set the format of the output file based on the writer specified
+               responseObj[:writerFormat] = 'xml'
 
-                    # start writing the ISO 19110 XML record
-                    metadataWriter = FC_FeatureCatalogue.new(xml, responseObj)
-                    metadata = metadataWriter.writeXML(intObj)
+               # create new XML document
+               xml = Builder::XmlMarkup.new(indent: 3)
 
-                    return metadata
+               # start writing the ISO 19110 XML record
+               metadataWriter = FC_FeatureCatalogue.new(xml, responseObj)
+               metadata = metadataWriter.writeXML(intObj)
 
-                end
+               return metadata
 
-                # find contact in contact array and return the contact hash
-                def self.getContact(contactId)
+            end
 
-                    @contacts.each do |contact|
-                        if contact[:contactId] == contactId
-                            return contact
-                        end
-                    end
-                    return {}
+            # find contact in contact array and return the contact hash
+            def self.getContact(contactId)
 
-                end
+               @contacts.each do |contact|
+                  if contact[:contactId] == contactId
+                     return contact
+                  end
+               end
+               return {}
 
-                # find domain in domain array and return the domain hash
-                def self.getDomain(domainId)
+            end
 
-                    @domains.each do |domain|
-                        if domain[:domainId] == domainId
-                            return domain
-                        end
-                    end
-                    return {}
+            # find domain in domain array and return the domain hash
+            def self.getDomain(domainId)
 
-                end
+               @domains.each do |domain|
+                  if domain[:domainId] == domainId
+                     return domain
+                  end
+               end
+               return {}
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end
 

data/lib/adiwg/mdtranslator/writers/sbJson/readme.md

@@ -3,7 +3,7 @@
 
 ### Supported versions
 
-> 0.0.x
+> 0.0.x (sbJSON is not currently versioned)
 
 ### Writer for ScienceBase JSON metadata format (sbJSON)
 
@@ -17,3 +17,10 @@ information assets important to science teams using ScienceBase.
 
 The sbJSON format is fully documented on 
 the [ScienceBase Confluence page](https://my.usgs.gov/confluence/display/sciencebase/ScienceBase+Information+Model).
+
+The U.S. Geological Survey (USGS) ScienceBase Catalog contains 
+metadata about digital and non-digital scientific data assets. 
+The ScienceBase Catalog provides the central information about 
+everything in ScienceBase using a flexible information model 
+based on the simple metadata elements of the Dublin Core Metadata 
+Element Set.

data/lib/adiwg/mdtranslator/writers/sbJson/sbJson_writer.rb

@@ -35,13 +35,23 @@ module ADIWG
             end
 
             # find contact in contact array and return the contact hash
-            def self.getContact(contactIndex)
+            def self.get_contact_by_index(contactIndex)
                if @contacts[contactIndex]
                   return @contacts[contactIndex]
                end
                {}
             end
 
+            # find contact in contact array and return the contact hash
+            def self.get_contact_by_id(contactId)
+               @contacts.each do |hContact|
+                  if hContact[:contactId] == contactId
+                     return hContact
+                  end
+               end
+               {}
+            end
+
             # ignore jBuilder object mapping when array is empty
             def self.json_map(collection = [], _class)
                if collection.nil? || collection.empty?
@@ -51,6 +61,25 @@ module ADIWG
                end
             end
 
+            # find all nested objects in 'obj' that contain the element 'ele'
+            def self.nested_objs_by_element(obj, ele)
+               aCollected = []
+               obj.each do |key, value|
+                  if key == ele.to_sym
+                     aCollected << obj
+                  elsif obj.is_a?(Array)
+                     if key.respond_to?(:each)
+                        aReturn = nested_objs_by_element(key, ele)
+                        aCollected = aCollected.concat(aReturn) unless aReturn.empty?
+                     end
+                  elsif obj[key].respond_to?(:each)
+                     aReturn = nested_objs_by_element(value, ele)
+                     aCollected = aCollected.concat(aReturn) unless aReturn.empty?
+                  end
+               end
+               aCollected
+            end
+
          end
       end
    end

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_browseCategory.rb

@@ -0,0 +1,39 @@
+# sbJson 1.0 writer browse categories
+
+# History:
+#  Stan Smith 2017-05-31 original script
+
+require 'jbuilder'
+require_relative 'sbJson_codelists'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module SbJson
+
+            module BrowseCategory
+
+               def self.build(aTypes)
+
+                  aCategories = []
+
+                  aTypes.each do |hType|
+                     type = hType[:type]
+                     sbType = Codelists.codelist_iso_to_sb('iso_sb_scope', :isoCode => type)
+                     aCategories << sbType unless sbType.nil?
+                  end
+
+                  if aCategories.empty?
+                     return nil
+                  end
+
+                  aCategories = aCategories.uniq
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_budget.rb

@@ -0,0 +1,63 @@
+# sbJson 1.0 writer budget
+
+# History:
+#  Stan Smith 2017-06-02 original script
+
+require_relative 'sbJson_codelists'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module SbJson
+
+            module Budget
+
+               def self.build(aFunding)
+
+                  hBudget = {}
+                  hBudget[:className] = 'gov.sciencebase.catalog.item.facet.BudgetFacet'
+                  hBudget[:annualBudgets] = []
+
+                  aFunding.each do |hFunding|
+                     budget = {}
+                     fundingSources = []
+                     hFunding[:allocations].each do |hAllocation|
+                        hSource = {}
+                        hSource[:amount] = hAllocation[:amount] unless hAllocation[:amount].nil?
+                        hSource[:matching] = hAllocation[:matching].to_s
+                        hSource[:recipient] = hAllocation[:recipientId] unless hAllocation[:recipientId].nil?
+                        hSource[:source] = hAllocation[:sourceId] unless hAllocation[:sourceId].nil?
+                        fundingSources << hSource
+                     end
+                     unless fundingSources.empty?
+                        budget[:fundingSources] = fundingSources
+                     end
+
+                     # year only
+                     unless hFunding[:timePeriod].empty?
+                        unless hFunding[:timePeriod][:startDateTime].empty?
+                           startDateTime = hFunding[:timePeriod][:startDateTime][:dateTime]
+                        end
+                        unless hFunding[:timePeriod][:endDateTime].empty?
+                           endDateTime = hFunding[:timePeriod][:endDateTime][:dateTime]
+                        end
+                        dateTime = startDateTime.nil? ? endDateTime : startDateTime
+                        unless dateTime.nil?
+                           budget[:year] = AdiwgDateTimeFun.stringDateFromDateTime(dateTime, 'Y')
+                        end
+                     end
+
+                     hBudget[:annualBudgets] << budget
+
+                  end
+
+                  hBudget
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_citation.rb

@@ -1,8 +1,10 @@
-# sbJson 1.0 writer
+# sbJson 1.0 writer citation
 
 # History:
 #  Stan Smith 2017-05-16 original script
 
+require_relative 'sbJson_codelists'
+
 module ADIWG
    module Mdtranslator
       module Writers
@@ -39,7 +41,7 @@ module ADIWG
                   end
                   aIndexes.uniq!
                   aIndexes.each do |hIndex|
-                     hContact = ADIWG::Mdtranslator::Writers::SbJson.getContact(hIndex[:index])
+                     hContact = ADIWG::Mdtranslator::Writers::SbJson.get_contact_by_index(hIndex[:index])
                      unless hContact.empty?
                         unless hContact[:name].nil?
                            citation += hContact[:name] + '(' + hIndex[:role] + '), '
@@ -50,7 +52,12 @@ module ADIWG
                   # dates
                   hCitation[:dates].each do |hDate|
                      dateStr = AdiwgDateTimeFun.stringFromDateObject(hDate)
-                     citation += dateStr + '(' + hDate[:dateType] + '), '
+                     dateType = Codelists.codelist_iso_to_sb('iso_sb_date', :isoCode => hDate[:dateType])
+                     if dateType.nil?
+                        citation += dateStr + ', '
+                     else
+                        citation += dateStr + '(' + dateType + '), '
+                     end
                   end
 
                   # title

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_codelists.rb

@@ -0,0 +1,170 @@
+# sbJson 1.0 writer
+
+# History:
+#  Stan Smith 2017-05-26 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module SbJson
+
+            module Codelists
+
+               @iso_sb_role = [
+                  {iso: 'resourceProvider', sb: 'Resource Provider'},
+                  {iso: 'custodian', sb: 'Custodian'},
+                  {iso: 'rightsHolder', sb: 'Data Owner'},
+                  {iso: 'use', sb: 'User'},
+                  {iso: 'distributor', sb: 'Distributor'},
+                  {iso: 'originator', sb: 'Originator'},
+                  {iso: 'pointOfContact', sb: 'Point of Contact'},
+                  {iso: 'principalInvestigator', sb: 'Principal Investigator'},
+                  {iso: 'processor', sb: 'Processor'},
+                  {iso: 'author', sb: 'Author'},
+                  {iso: 'coAuthor', sb: 'Author'},
+                  {iso: 'collaborator', sb: 'Cooperator/Partner'},
+                  {iso: 'contributor', sb: 'Cooperator/Partner'},
+                  {iso: 'editor', sb: 'Editor'},
+                  {iso: 'coPrincipalInvestigator', sb: 'Co-Investigator'},
+                  {iso: 'publisher', sb: 'publisher'},
+                  {iso: 'sponsor', sb: 'sponsor'},
+                  {iso: 'stakeholder', sb: 'stakeholder'},
+                  {iso: 'administrator', sb: 'administrator'},
+                  {iso: 'client', sb: 'client'},
+                  {iso: 'logistics', sb: 'logistics'},
+                  {iso: 'mediator', sb: 'mediator'}
+               ]
+
+               @iso_sb_onlineFunction = [
+                  {iso: 'information', sb: 'webLink'},
+                  {iso: 'completeMetadata', sb: 'originalMetadata'},
+                  {iso: 'browseGraphic', sb: 'browseImage'},
+                  {iso: 'webApplication', sb: 'webapp'},
+                  {iso: 'download', sb: 'download'},
+                  {iso: 'offlineAccess', sb: 'offlineAccess'},
+                  {iso: 'order', sb: 'order'},
+                  {iso: 'search', sb: 'search'},
+                  {iso: 'upload', sb: 'upload'},
+                  {iso: 'emailService', sb: 'emailService'},
+                  {iso: 'browsing', sb: 'browsing'},
+                  {iso: 'fileAccess', sb: 'fileAccess'}
+               ]
+
+               @iso_sb_scope = [
+                  {iso: 'collectionHardware', sb: 'Collection'},
+                  {iso: 'collectionSession', sb: 'Collection'},
+                  {iso: 'dataset', sb: 'Data'},
+                  {iso: 'document', sb: 'Document'},
+                  {iso: 'collection', sb: 'Collection'},
+                  {iso: 'application', sb: 'Application'},
+                  {iso: 'sciencePaper', sb: 'Report'},
+                  {iso: 'project', sb: 'Project'},
+                  {iso: 'map', sb: 'Data'},
+                  {iso: 'photographicImage', sb: 'Image'},
+                  {iso: 'publication', sb: 'Publication'},
+                  {iso: 'tabularDataset', sb: 'Data'},
+                  {iso: 'report', sb: 'Report'},
+                  {iso: 'sample', sb: 'Physical Item'},
+                  {iso: 'attribute', sb: nil},
+                  {iso: 'attributeType', sb: nil},
+                  {iso: 'series', sb: nil},
+                  {iso: 'nonGeographicDataset', sb: nil},
+                  {iso: 'dimensionGroup', sb: nil},
+                  {iso: 'feature', sb: nil},
+                  {iso: 'featureType', sb: nil},
+                  {iso: 'propertyType', sb: nil},
+                  {iso: 'fieldSession', sb: nil},
+                  {iso: 'software', sb: nil},
+                  {iso: 'model', sb: nil},
+                  {iso: 'tile', sb: nil},
+                  {iso: 'metadata', sb: nil},
+                  {iso: 'repository', sb: nil},
+                  {iso: 'aggregate', sb: nil},
+                  {iso: 'product', sb: nil},
+                  {iso: 'coverage', sb: nil},
+                  {iso: 'userGuide', sb: nil},
+                  {iso: 'dataDictionary', sb: nil},
+                  {iso: 'website', sb: nil},
+                  {iso: 'publication', sb: nil},
+                  {iso: 'awardInfo', sb: nil},
+                  {iso: 'collectionSite', sb: nil},
+                  {iso: 'factSheet', sb: nil},
+                  {iso: 'drawing', sb: nil},
+                  {iso: 'presentation', sb: nil}
+               ]
+
+               @iso_sb_date = [
+                  {iso: 'creation', sb: 'Creation'},
+                  {iso: 'publication', sb: 'Publication'},
+                  {iso: 'revision', sb: 'Revision'},
+                  {iso: 'expiry', sb: nil},
+                  {iso: 'lastUpdate', sb: 'lastUpdate'},
+                  {iso: 'lastRevision', sb: 'lastRevision'},
+                  {iso: 'nextUpdate', sb: 'nextUpdate'},
+                  {iso: 'unavailable', sb: 'unavailable'},
+                  {iso: 'inForce', sb: 'inForce'},
+                  {iso: 'adopted', sb: 'adopted'},
+                  {iso: 'deprecated', sb: 'deprecated'},
+                  {iso: 'suspended', sb: 'suspended'},
+                  {iso: 'validityBegins', sb: 'validityBegins'},
+                  {iso: 'validityExpires', sb: 'validityExpires'},
+                  {iso: 'released', sb: 'Release'},
+                  {iso: 'distribution', sb: 'date identifiers when an instance of the resource was distributed'}
+               ]
+
+               @iso_sb_progress = [
+                  {iso: 'completed', sb: 'Completed'},
+                  {iso: 'historicalArchive', sb: nil},
+                  {iso: 'obsolete', sb: nil},
+                  {iso: 'onGoing', sb: 'In Progress'},
+                  {iso: 'onGoing', sb: 'Active'},
+                  {iso: 'planned', sb: nil},
+                  {iso: 'required', sb: nil},
+                  {iso: 'underDevelopment', sb: nil},
+                  {iso: 'final', sb: nil},
+                  {iso: 'pending', sb: nil},
+                  {iso: 'retired', sb: nil},
+                  {iso: 'superseded', sb: nil},
+                  {iso: 'tentative', sb: nil},
+                  {iso: 'valid', sb: nil},
+                  {iso: 'accepted', sb: 'Approved'},
+                  {iso: 'notAccepted', sb: nil},
+                  {iso: 'withdrawn', sb: nil},
+                  {iso: 'proposed', sb: 'Proposed'},
+                  {iso: 'deprecated', sb: nil},
+                  {iso: 'funded', sb: nil},
+                  {iso: 'cancelled', sb: nil},
+                  {iso: 'suspended', sb: nil}
+               ]
+
+                  def self.codelist_iso_to_sb(codelist, isoCode: nil, sbCode: nil)
+
+                  codeList = instance_variable_get("@#{codelist}")
+
+                  unless isoCode.nil?
+                     codeList.each do |obj|
+                        if obj[:iso] == isoCode
+                           return obj[:sb]
+                        end
+                     end
+                  end
+
+                  unless sbCode.nil?
+                     codeList.each do |obj|
+                        if obj[:sb] == sbCode
+                           return obj[:iso]
+                        end
+                     end
+                  end
+
+                  # not found
+                  return nil
+
+               end
+
+            end
+
+         end
+      end
+   end
+end