adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -2,108 +2,156 @@
 # taxonomy
 
 # History:
+#  Stan Smith 2015-03-30 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 # 	Stan Smith 2015-03-25 original script
-#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 
 require_relative 'html_citation'
-require_relative 'html_responsibleParty'
+require_relative 'html_identifier'
+require_relative 'html_responsibility'
 require_relative 'html_taxonomyClass'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
-
-                class MdHtmlTaxonomy
-                    def initialize(html)
-                        @html = html
-                    end
-
-                    def writeHtml(hTaxon)
-
-                        # classes used
-                        htmlCitation = MdHtmlCitation.new(@html)
-                        htmlRParty = MdHtmlResponsibleParty.new(@html)
-                        htmlTaxClass = MdHtmlTaxonomyClass.new(@html)
-
-                        # taxonomy - taxonomic class system - citation
-                        aTaxSys = hTaxon[:taxClassSys]
-                        if !aTaxSys.empty?
-                            @html.em('Taxonomic class system: ')
-                            aTaxSys.each do |hCitation|
-                                @html.section(:class=>'block') do
-                                    htmlCitation.writeHtml(hCitation)
-                                end
-                            end
-                        end
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_Taxonomy
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hTaxonomy)
+
+                  # classes used
+                  citationClass = Html_Citation.new(@html)
+                  identifierClass = Html_Identifier.new(@html)
+                  responsibilityClass = Html_Responsibility.new(@html)
+                  taxonomicClass = Html_TaxonomyClass.new(@html)
+
+                  # taxonomy - taxonomic general scope
+                  unless hTaxonomy[:generalScope].nil?
+                     @html.em('General scope: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hTaxonomy[:generalScope])
+                     end
+                  end
+
+                  # taxonomy - identification procedures
+                  unless hTaxonomy[:idProcedure].nil?
+                     @html.em('Identification Procedures: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hTaxonomy[:idProcedure])
+                     end
+                  end
+
+                  # taxonomy - completeness
+                  unless hTaxonomy[:idCompleteness].nil?
+                     @html.em('Identification Completeness Statement: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hTaxonomy[:idCompleteness])
+                     end
+                  end
+
+                  # taxonomy - taxonomic classification system [] {citation}
+                  hTaxonomy[:taxonSystem].each do |hSystem|
+                     @html.details do
+                        @html.summary('Classification System', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+
+                           # classification system citation
+                           @html.details do
+                              @html.summary(hSystem[:citation][:title], {'class' => 'h5'})
+                              @html.section(:class => 'block') do
+                                 citationClass.writeHtml(hSystem[:citation])
+                              end
+                           end
+
+                           # modifications
+                           unless hSystem[:modifications].nil?
+                              @html.em('Modifications to Classification System:')
+                              @html.section(:class => 'block') do
+                                 @html.text!(hSystem[:modifications])
+                              end
+                           end
 
-                        # taxonomy - taxonomic general scope
-                        s = hTaxon[:taxGeneralScope]
-                        if !s.nil?
-                            @html.em('General scope: ')
-                            @html.section(:class=>'block') do
-                                @html.text!(s)
-                            end
                         end
-
-                        # taxonomy - taxonomic observers - responsible party
-                        aTaxObs = hTaxon[:taxObservers]
-                        if !aTaxObs.empty?
-                            @html.em('Taxonomic observer: ')
-                            aTaxObs.each do |hResParty|
-                                @html.section(:class=>'block') do
-                                    htmlRParty.writeHtml(hResParty)
-                                end
-                            end
+                     end
+                  end
+
+                  # taxonomy - taxonomic class
+                  unless hTaxonomy[:taxonClass].empty?
+                     @html.details do
+                        @html.summary('Taxonomic Classification', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           taxonomicClass.writeHtml(hTaxonomy[:taxonClass])
                         end
-
-                        # taxonomy - taxonomic identification procedures
-                        s = hTaxon[:taxIdProcedures]
-                        if !s.nil?
-                            @html.em('Taxonomic identification procedures: ')
-                            @html.section(:class=>'block') do
-                                @html.text!(s)
-                            end
+                     end
+                  end
+
+                  # taxonomy - identification references
+                  hTaxonomy[:idReferences].each do |hReference|
+                     @html.details do
+                        @html.summary('Non-Authoritative Reference', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           identifierClass.writeHtml(hReference)
                         end
-
-                        # taxonomy - taxonomic voucher
-                        # note: should be an array according to ISO docs,
-                        # but NOAA 19115_2 XSD does not allow
-                        #     specimen: nil,
-                        #     repository: {}
-                        hTaxVoucher = hTaxon[:taxVoucher]
-                        if !hTaxVoucher.empty?
-
-                            # taxonomic voucher - specimen
-                            s = hTaxVoucher[:specimen]
-                            if !s.nil?
-                                @html.em('Specimen: ')
-                                @html.text!(s)
-                                @html.br
-                            end
-
-                            # taxonomic voucher - repository - responsible party
-                            hResParty = hTaxVoucher[:repository]
-                            if !hResParty.empty?
-                            @html.em('Specimen repository: ')
-                                @html.section(:class=>'block') do
-                                    htmlRParty.writeHtml(hResParty)
-                                end
-                            end
+                     end
+                  end
+
+                  # taxonomy - observers {responsibility}
+                  unless hTaxonomy[:observers].empty?
+                     @html.details do
+                        @html.summary('Observers', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           hTaxonomy[:observers].each do |hObserver|
+                              @html.details do
+                                 @html.summary(hObserver[:roleName], 'class' => 'h5')
+                                 @html.section(:class => 'block') do
+                                    responsibilityClass.writeHtml(hObserver)
+                                 end
+                              end
+                           end
                         end
-
-                        # taxonomy - taxonomic class - array
-                        aTaxClass = hTaxon[:taxClasses]
-                        if !aTaxClass.empty?
-                            @html.em('Taxonomic class structure: ')
-                            htmlTaxClass.writeHtml(aTaxClass)
+                     end
+                  end
+
+                  # taxonomy - voucher []
+                  unless hTaxonomy[:observers].empty?
+                     @html.details do
+                        @html.summary('Specimen Repositories', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           hTaxonomy[:vouchers].each do |hVoucher|
+
+                              # voucher - specimen
+                              unless hVoucher[:specimen].nil?
+                                 @html.em('Specimen: ')
+                                 @html.text!(hVoucher[:specimen])
+                                 @html.br
+                              end
+
+                              # voucher - repository {responsibility}
+                              unless hVoucher[:repository].empty?
+                                 @html.section(:class => 'block') do
+                                    @html.details do
+                                       @html.summary(hVoucher[:repository][:roleName], {'class' => 'h5'})
+                                       @html.section(:class => 'block') do
+                                          responsibilityClass.writeHtml(hVoucher[:repository])
+                                       end
+                                    end
+                                 end
+                              end
+
+                           end
                         end
+                     end
+                  end
 
-                    end # writeHtml
-
-                end # class
+               end # writeHtml
+            end # Html_Taxonomy
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -1,62 +1,75 @@
 # HTML writer
-# resource specific usage
+# taxonomic classification
 
 # History:
+#  Stan Smith 2017-03-30 refactored for mdTranslator
 # 	Stan Smith 2015-03-25 original script
 
+require_relative 'html_taxonomyClass'
+
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
-
-                class MdHtmlTaxonomyClass
-                    def initialize(html)
-                        @html = html
-                    end
-
-                    def writeHtml(aTaxClass)
-
-                        hTaxonCl = aTaxClass[0]
-
-                        @html.section(:class=>'block') do
-
-                            # taxonomic class - taxonomic rank
-                            s = hTaxonCl[:taxRankName]
-                            if !s.nil?
-                                @html.em('Taxonomic Rank: ')
-                                @html.text!(s)
-                                @html.br
-                            end
-
-                            # taxonomic class - taxonomic value
-                            s = hTaxonCl[:taxRankValue]
-                            if !s.nil?
-                                @html.em('Taxonomic Value: ')
-                                @html.text!(s)
-                                @html.br
-                            end
-
-                            # taxonomic class - common name
-                            s = hTaxonCl[:commonName]
-                            if !s.nil?
-                                @html.em('Common name: ')
-                                @html.text!(s)
-                                @html.br
-                            end
-
-                            # taxon class - classification - recursive
-                            aTaxClass.slice!(0)
-                            unless aTaxClass.empty?
-                                writeHtml(aTaxClass)
-                            end
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_TaxonomyClass
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hTaxon)
+
+                  # classes used
+                  subClass = Html_TaxonomyClass.new(@html)
 
+                  # taxonomic classification - id
+                  unless hTaxon[:taxonId].nil?
+                     @html.em('Taxonomic ID: ')
+                     @html.text!(hTaxon[:taxonId])
+                     @html.br
+                  end
+
+                  # taxonomic classification - rank
+                  unless hTaxon[:taxonRank].nil?
+                     @html.em('Taxonomic Rank: ')
+                     @html.text!(hTaxon[:taxonRank])
+                     @html.br
+                  end
+
+                  # taxonomic classification - value
+                  unless hTaxon[:taxonValue].nil?
+                     @html.em('Taxonomic Value: ')
+                     @html.text!(hTaxon[:taxonValue])
+                     @html.br
+                  end
+
+                  # taxonomic classification - common names []
+                  unless hTaxon[:commonNames].empty?
+                     @html.em('Common Names:')
+                     @html.ul do
+                        hTaxon[:commonNames].each do |common|
+                           @html.li(common)
                         end
+                     end
+                  end
 
-                    end # writeHtml
+                  # taxonomic classification - sub-classification
+                  unless hTaxon[:subClasses].empty?
+                     hTaxon[:subClasses].each do |hSubClass|
+                        @html.details do
+                           @html.summary('Sub-Classification', {'class' => 'h5'})
+                           @html.section(:class => 'block') do
+                              subClass.writeHtml(hSubClass)
+                           end
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_TaxonomyClass
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -0,0 +1,66 @@
+# HTML writer
+# temporal extent
+
+# History:
+#  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'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_TemporalExtent
+
+               def initialize(html)
+                  @html = html
+               end
+
+               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
+                     end
+                  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
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_TemporalExtent
+
+         end
+      end
+   end
+end

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

@@ -2,55 +2,73 @@
 # time instant
 
 # History:
+#  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
-#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 
-require_relative 'html_dateTime'
+require_relative 'html_identifier'
+require_relative 'html_datetime'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
-
-                class MdHtmlTimeInstant
-                    def initialize(html)
-                        @html = html
-                    end
-
-                    def writeHtml(hTimeInstant)
-
-                        # classes used
-                        htmlDT = MdHtmlDateTime.new(@html)
-
-                        # time instant - id
-                        s = hTimeInstant[:timeId]
-                        if !s.nil?
-                            @html.em('Time ID: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+   module Mdtranslator
+      module Writers
+         module Html
 
-                        # time instant - description
-                        s = hTimeInstant[:description]
-                        if !s.nil?
-                            @html.em('Description: ')
-                            @html.section(:class=>'block') do
-                                @html.text!(s)
-                            end
-                        end
+            class Html_TimeInstant
 
-                        # time instant - time instant - dateTime - required
-                        hDatetime = hTimeInstant[:timePosition]
-                        if !hDatetime.empty?
-                            @html.em('DateTime: ')
-                            htmlDT.writeHtml(hDatetime)
-                        end
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hInstant)
+
+                  # classes used
+                  identifierClass = Html_Identifier.new(@html)
+                  datetimeClass = Html_Datetime.new(@html)
 
-                    end # writeHtml
+                  # time instant - id
+                  unless hInstant[:timeId].nil?
+                     @html.em('Instant ID: ')
+                     @html.text!(hInstant[:timeId])
+                     @html.br
+                  end
+
+                  # time instant - instant name []
+                  hInstant[:instantNames].each do |iName|
+                     @html.em('Instant Name: ')
+                     @html.text!(iName)
+                     @html.br
+                  end
+
+                  # time instant - dateTime
+                  unless hInstant[:timeInstant].empty?
+                     @html.em('DateTime: ')
+                     @html.text!(datetimeClass.writeHtml(hInstant[:timeInstant]))
+                     @html.br
+                  end
+
+                  # time instant - description
+                  unless hInstant[:description].nil?
+                     @html.em('Description: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hInstant[:description])
+                     end
+                  end
+
+                  # time instant - identifier {identifier}
+                  unless hInstant[:identifier].empty?
+                     @html.details do
+                        @html.summary('Identifier', 'class' => 'h5')
+                        @html.section(:class => 'block') do
+                           identifierClass.writeHtml(hInstant[:identifier])
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_TimeInstant
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -0,0 +1,40 @@
+# HTML writer
+# time interval
+
+# History:
+#  Stan Smith 2017-03-27 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_TimeInterval
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hInterval)
+
+                  # time interval - interval
+                  unless hInterval[:interval].nil?
+                     @html.em('Interval: ')
+                     @html.text!(hInterval[:interval].to_s)
+                     @html.br
+                  end
+
+                  # time interval - units
+                  unless hInterval[:units].nil?
+                     @html.em('Units: ')
+                     @html.text!(hInterval[:units])
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_TimeInterval
+
+         end
+      end
+   end
+end