adiwg-mdtranslator 2.5.0 → 2.6.0

data/lib/adiwg/mdtranslator/version.rb

@@ -1,6 +1,8 @@
 # adiwg mdTranslator
 
 # version 2 history
+# 2.6.0 2017-11-09 added data dictionary description
+# 2.6.0 2017-11-09 added readers and writers for geologic age
 # 2.5.0 2017-11-03 bug fix, add test to verify mdJson reader version is compatible with schema version
 # 2.5.0 2017-11-03 added support for additional fgdc and bio data dictionary element
 # 2.4.1 2017-11-02 refactored mdJson writer for added entity, attribute, and domain elements
@@ -44,7 +46,7 @@
 module ADIWG
    module Mdtranslator
       # current mdtranslator version
-      VERSION = "2.5.0"
+      VERSION = "2.6.0"
    end
 end
 

data/lib/adiwg/mdtranslator/writers/html/sections/html_dataDictionary.rb

@@ -2,6 +2,7 @@
 # data dictionary
 
 # History:
+#  Stan Smith 2017-11-09 add data dictionary description
 #  Stan Smith 2017-04-05 refactored for mdTranslator 2.0
 #  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-03-26 original script
@@ -32,6 +33,14 @@ module ADIWG
                   domainClass = Html_Domain.new(@html)
                   entityClass = Html_Entity.new(@html)
 
+                  # dictionary -  description
+                  unless hDictionary[:description].nil?
+                     @html.em('Dictionary Description:')
+                     @html.section(:class => 'block') do
+                        @html.text!(hDictionary[:description])
+                     end
+                  end
+
                   # dictionary - subjects []
                   hDictionary[:subjects].each do |subject|
                      @html.em('Subject: ')

data/lib/adiwg/mdtranslator/writers/html/sections/html_domain.rb

@@ -23,11 +23,11 @@ module ADIWG
 
                def writeHtml(aDomains)
 
-                  aDomains.each do |hDomain|
+                  # classes used
+                  itemClass = Html_DomainItem.new(@html)
+                  citationClass = Html_Citation.new(@html)
 
-                     # classes used
-                     itemClass = Html_DomainItem.new(@html)
-                     citationClass = Html_Citation.new(@html)
+                  aDomains.each do |hDomain|
 
                      dName = 'domain'
                      dName = hDomain[:domainCode] unless hDomain[:domainCode].nil?

data/lib/adiwg/mdtranslator/writers/html/sections/html_entity.rb

@@ -25,13 +25,13 @@ module ADIWG
 
                def writeHtml(aEntities)
 
-                  aEntities.each do |hEntity|
+                  # classes used
+                  indexClass = Html_EntityIndex.new(@html)
+                  attributeClass = Html_EntityAttribute.new(@html)
+                  foreignClass = Html_EntityForeignKey.new(@html)
+                  citationClass = Html_Citation.new(@html)
 
-                     # classes used
-                     indexClass = Html_EntityIndex.new(@html)
-                     attributeClass = Html_EntityAttribute.new(@html)
-                     foreignClass = Html_EntityForeignKey.new(@html)
-                     citationClass = Html_Citation.new(@html)
+                  aEntities.each do |hEntity|
 
                      eName = 'entity'
                      eName = hEntity[:entityCode] unless hEntity[:entityCode].nil?

data/lib/adiwg/mdtranslator/writers/html/sections/html_geologicAge.rb

@@ -0,0 +1,71 @@
+# HTML writer
+# geologic age
+
+# History:
+#  Stan Smith 2017-11-09 original script
+
+require_relative 'html_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_GeologicAge
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hGeoAge)
+
+                  # classes used
+                  citationClass = Html_Citation.new(@html)
+
+                  # geologic age - age time scale
+                  unless hGeoAge[:ageTimeScale].nil?
+                     @html.em('Age Time Scale: ')
+                     @html.text!(hGeoAge[:ageTimeScale])
+                     @html.br
+                  end
+
+                  # geologic age - age estimate
+                  unless hGeoAge[:ageEstimate].nil?
+                     @html.em('Age Estimate: ')
+                     @html.text!(hGeoAge[:ageEstimate])
+                     @html.br
+                  end
+
+                  # geologic age - age uncertainty
+                  unless hGeoAge[:ageUncertainty].nil?
+                     @html.em('Age Uncertainty: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hGeoAge[:ageUncertainty])
+                     end
+                  end
+
+                  # geologic age - age explanation
+                  unless hGeoAge[:ageExplanation].nil?
+                     @html.em('Age Determination Methodology: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hGeoAge[:ageExplanation])
+                     end
+                  end
+
+                  # geologic age - age references [] {citation}
+                  hGeoAge[:ageReferences].each do |hCitation|
+                     @html.details do
+                        @html.summary('Age Reference', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           citationClass.writeHtml(hCitation)
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_GeologicAge
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/html/sections/html_temporalExtent.rb

@@ -2,11 +2,12 @@
 # temporal extent
 
 # History:
+#  Stan Smith 2017-11-09 remove subheadings
+#  Stan Smith 2017-11-09 add geologic age
 #  Stan Smith 2017-03-25 refactored for mdTranslator 2.0
 #  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-04-03 original script
 
-require_relative 'html_datetime'
 require_relative 'html_timePeriod'
 require_relative 'html_timeInstant'
 
@@ -24,37 +25,35 @@ module ADIWG
                def writeHtml(hExtent)
 
                   # classes used
-                  datetimeClass = Html_Datetime.new(@html)
                   periodClass = Html_TimePeriod.new(@html)
                   instantClass = Html_TimeInstant.new(@html)
 
                   # temporal element - time instant {timeInstant}
                   unless hExtent[:timeInstant].empty?
-                     @html.details do
-                        dateStr = datetimeClass.writeHtml(hExtent[:timeInstant][:timeInstant])
-                        @html.summary('Time ' +  dateStr + ' ', 'class' => 'h5')
-                        @html.section(:class => 'block') do
-                           instantClass.writeHtml(hExtent[:timeInstant])
-                        end
+                     hInstant = hExtent[:timeInstant][:timeInstant]
+                     hGeoAge = hExtent[:timeInstant][:geologicAge]
+                     unless hInstant.empty?
+                        @html.h5('Time Instant')
                      end
+                     unless hGeoAge.empty?
+                        @html.h5('Geologic Age')
+                     end
+                     instantClass.writeHtml(hExtent[:timeInstant])
                   end
 
                   # temporal element - time period {timePeriod}
                   unless hExtent[:timePeriod].empty?
-                     startStr = datetimeClass.writeHtml(hExtent[:timePeriod][:startDateTime])
-                     endStr = datetimeClass.writeHtml(hExtent[:timePeriod][:endDateTime])
-                     @html.details do
-                        if startStr == ''
-                           @html.summary('Period Ending ' + endStr, 'class' => 'h5')
-                        elsif endStr == ''
-                           @html.summary('Period Beginning ' + startStr, 'class' => 'h5')
-                        else
-                           @html.summary('Period ' + startStr + ' to ' + endStr, 'class' => 'h5')
-                        end
-                        @html.section(:class => 'block') do
-                           periodClass.writeHtml(hExtent[:timePeriod])
-                        end
+                     hStartDate = hExtent[:timePeriod][:startDateTime]
+                     hEndDate = hExtent[:timePeriod][:endDateTime]
+                     hStartAge = hExtent[:timePeriod][:startGeologicAge]
+                     hEndAge = hExtent[:timePeriod][:endGeologicAge]
+                     unless hStartDate.empty? && hEndDate.empty?
+                        @html.h5('Time Period')
+                     end
+                     unless hStartAge.empty? && hEndAge.empty?
+                        @html.h5('Geologic Period')
                      end
+                     periodClass.writeHtml(hExtent[:timePeriod])
                   end
 
                end # writeHtml

data/lib/adiwg/mdtranslator/writers/html/sections/html_timeInstant.rb

@@ -2,12 +2,14 @@
 # time instant
 
 # History:
+#  Stan Smith 2017-11-09 add geologic age
 #  Stan Smith 2017-03-26 refactored for mdTranslator 2.0
 #  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-04-03 original script
 
 require_relative 'html_identifier'
 require_relative 'html_datetime'
+require_relative 'html_geologicAge'
 
 module ADIWG
    module Mdtranslator
@@ -25,6 +27,7 @@ module ADIWG
                   # classes used
                   identifierClass = Html_Identifier.new(@html)
                   datetimeClass = Html_Datetime.new(@html)
+                  geoAgeClass = Html_GeologicAge.new(@html)
 
                   # time instant - id
                   unless hInstant[:timeId].nil?
@@ -55,6 +58,11 @@ module ADIWG
                      end
                   end
 
+                  # time instant - geologic age
+                  unless hInstant[:geologicAge].empty?
+                     geoAgeClass.writeHtml(hInstant[:geologicAge])
+                  end
+
                   # time instant - identifier {identifier}
                   unless hInstant[:identifier].empty?
                      @html.details do

data/lib/adiwg/mdtranslator/writers/html/sections/html_timePeriod.rb

@@ -2,11 +2,13 @@
 # time period
 
 # History:
+#  Stan Smith 2017-11-09 add geologic age
 #  Stan Smith 2017-03-26 refactored for mdTranslator 2.0
 #  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-03-23 original script
 
 require_relative 'html_datetime'
+require_relative 'html_geologicAge'
 require_relative 'html_identifier'
 require_relative 'html_timeInterval'
 require_relative 'html_duration'
@@ -26,6 +28,7 @@ module ADIWG
 
                   # classes used
                   datetimeClass = Html_Datetime.new(@html)
+                  geoAgeClass = Html_GeologicAge.new(@html)
                   identifierClass = Html_Identifier.new(@html)
                   intervalClass = Html_TimeInterval.new(@html)
                   durationClass = Html_Duration.new(@html)
@@ -66,6 +69,26 @@ module ADIWG
                      end
                   end
 
+                  # time period - start geologic age {geologic age}
+                  unless hPeriod[:startGeologicAge].empty?
+                     @html.details do
+                        @html.summary('Starting Geologic Age', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           geoAgeClass.writeHtml(hPeriod[:startGeologicAge])
+                        end
+                     end
+                  end
+
+                  # time period - end geologic age {geologic age}
+                  unless hPeriod[:endGeologicAge].empty?
+                     @html.details do
+                        @html.summary('Ending Geologic Age', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           geoAgeClass.writeHtml(hPeriod[:endGeologicAge])
+                        end
+                     end
+                  end
+
                   # time period - identifier {identifier}
                   unless hPeriod[:identifier].empty?
                      @html.details do

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_dictionary.rb

@@ -1,8 +1,9 @@
 # mdJson 2.0 writer - dictionary
 
 # History:
-#   Stan Smith 2017-03-11 refactored for mdJson/mdTranslator 2.0
-#   Josh Bradley original script
+#  Stan Smith 2017-11-09 add data dictionary description
+#  Stan Smith 2017-03-11 refactored for mdJson/mdTranslator 2.0
+#  Josh Bradley original script
 
 require 'jbuilder'
 require_relative 'mdJson_citation'
@@ -23,8 +24,9 @@ module ADIWG
                def self.build(hDictionary)
 
                   Jbuilder.new do |json|
-                     json.citation Citation.build(hDictionary[:citation]) unless hDictionary[:citation].empty?
+                     json.description hDictionary[:description]
                      json.subject hDictionary[:subjects] unless hDictionary[:subjects].empty?
+                     json.citation Citation.build(hDictionary[:citation]) unless hDictionary[:citation].empty?
                      json.recommendedUse hDictionary[:recommendedUses] unless hDictionary[:recommendedUses].empty?
                      json.locale @Namespace.json_map(hDictionary[:locales], Locale)
                      json.responsibleParty ResponsibleParty.build(hDictionary[:responsibleParty])

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_geologicAge.rb

@@ -0,0 +1,34 @@
+# mdJson 2.0 writer - geologic age
+
+# History:
+#   Stan Smith 2017-11-08 original script
+
+require 'jbuilder'
+require_relative 'mdJson_citation'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module MdJson
+
+            module GeologicAge
+
+               def self.build(hGeoAge)
+
+                  @Namespace = ADIWG::Mdtranslator::Writers::MdJson
+
+                  Jbuilder.new do |json|
+                     json.ageTimeScale hGeoAge[:ageTimeScale]
+                     json.ageEstimate hGeoAge[:ageEstimate]
+                     json.ageUncertainty hGeoAge[:ageUncertainty]
+                     json.ageExplanation hGeoAge[:ageExplanation]
+                     json.ageReference @Namespace.json_map(hGeoAge[:ageReferences], Citation)
+                  end
+
+               end # build
+            end # GeologicAge
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_timeInstant.rb

@@ -1,11 +1,13 @@
 # mdJson 2.0 writer - time instant
 
 # History:
-#   Stan Smith 2017-03-15 original script
+#  Stan Smith 2017-11-08 add geologic age
+#  Stan Smith 2017-03-15 original script
 
 require 'jbuilder'
 require_relative 'mdJson_identifier'
 require_relative 'mdJson_dateTime'
+require_relative 'mdJson_geologicAge'
 
 module ADIWG
    module Mdtranslator
@@ -22,6 +24,7 @@ module ADIWG
                      json.identifier Identifier.build(hTimeInstant[:identifier]) unless hTimeInstant[:identifier].empty?
                      json.instantName hTimeInstant[:instantNames] unless hTimeInstant[:instantNames].empty?
                      json.dateTime DateTime.build(hTimeInstant[:timeInstant]) unless hTimeInstant[:timeInstant].empty?
+                     json.geologicAge GeologicAge.build(hTimeInstant[:geologicAge]) unless hTimeInstant[:geologicAge].empty?
                   end
 
                end # build

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_timePeriod.rb

@@ -1,12 +1,14 @@
 # mdJson 2.0 writer - time period
 
 # History:
-#   Stan Smith 2017-03-14 refactored for mdJson/mdTranslator 2.0
-#   Josh Bradley original script
+#  Stan Smith 2017-11-08 add geologic age
+#  Stan Smith 2017-03-14 refactored for mdJson/mdTranslator 2.0
+#  Josh Bradley original script
 
 require 'jbuilder'
 require_relative 'mdJson_identifier'
 require_relative 'mdJson_dateTime'
+require_relative 'mdJson_geologicAge'
 require_relative 'mdJson_timeInterval'
 require_relative 'mdJson_duration'
 
@@ -26,6 +28,8 @@ module ADIWG
                      json.periodName hTimePeriod[:periodNames] unless hTimePeriod[:periodNames].empty?
                      json.startDateTime DateTime.build(hTimePeriod[:startDateTime]) unless hTimePeriod[:startDateTime].empty?
                      json.endDateTime DateTime.build(hTimePeriod[:endDateTime]) unless hTimePeriod[:endDateTime].empty?
+                     json.startGeologicAge GeologicAge.build(hTimePeriod[:startGeologicAge]) unless hTimePeriod[:startGeologicAge].empty?
+                     json.endGeologicAge GeologicAge.build(hTimePeriod[:endGeologicAge]) unless hTimePeriod[:endGeologicAge].empty?
                      json.timeInterval TimeInterval.build(hTimePeriod[:timeInterval]) unless hTimePeriod[:timeInterval].empty?
                      json.duration Duration.build(hTimePeriod[:duration]) unless hTimePeriod[:duration].empty?
                   end

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

@@ -4,8 +4,6 @@
 #  Stan Smith 2017-05-15 refactored for mdJson/mdTranslator 2.0
 #  Josh Bradley original script
 
-require 'uuidtools'
-
 module ADIWG
    module Mdtranslator
       module Writers

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

@@ -1,6 +1,8 @@
 # sbJson 1.0 writer
 
 # History:
+#  Stan Smith 2017-11-09 add metadata identifier to output identifiers
+#  Stan Smith 2017-11-08 remove identifier which is the primary resource
 #  Stan Smith 2017-05-12 refactored for mdJson/mdTranslator 2.0
 #  Josh Bradley original script
 
@@ -38,13 +40,32 @@ module ADIWG
 
                Jbuilder.new do |json|
 
-                  json.id Id.build(intObj)
+                  resourceId = Id.build(intObj)
+                  json.id resourceId
                   json.title hCitation[:title] unless hCitation.empty?
                   json.alternateTitles hCitation[:alternateTitles] unless hCitation[:alternateTitles].empty?
                   json.body Abstract.build(resourceInfo[:abstract])
                   json.summary resourceInfo[:shortAbstract]
                   json.citation Citation.build(hCitation) unless hCitation.empty?
-                  json.identifiers @Namespace.json_map(hCitation[:identifiers], Identifier) unless hCitation.empty?
+
+                  # gather all identifiers
+                  # include the metadataIdentifier if it is not in the 'gov.sciencebase.catalog' namespace
+                  aIdentifiers = []
+                  unless metadataInfo[:metadataIdentifier].empty?
+                     unless metadataInfo[:metadataIdentifier][:namespace] == 'gov.sciencebase.catalog'
+                        aIdentifiers << metadataInfo[:metadataIdentifier]
+                     end
+                  end
+                  # do not duplicate the identifier which is the primary resource
+                  unless hCitation.empty?
+                     hCitation[:identifiers].each do |hIdentifier|
+                        unless hIdentifier[:identifier] == resourceId
+                           aIdentifiers << hIdentifier
+                        end
+                     end
+                  end
+                  json.identifiers @Namespace.json_map(aIdentifiers, Identifier) unless aIdentifiers.empty?
+
                   json.purpose resourceInfo[:purpose]
                   json.rights Rights.build(resourceInfo[:constraints]) unless resourceInfo[:constraints].empty?
                   json.provenance Provenance.build