adiwg-mdtranslator 2.18.2 → 2.19.0.pre.beta.7

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_bearingDistanceResolution.rb

@@ -0,0 +1,68 @@
+# HTML writer
+# bearing distance resolution
+
+# History:
+#  Stan Smith 2017-10-20 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_BearingDistanceResolution
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hBearRes)
+
+                  # bearing distance resolution - distance resolution
+                  unless hBearRes[:distanceResolution].nil?
+                     @html.em('Distance Resolution: ')
+                     @html.text!(hBearRes[:distanceResolution].to_s)
+                     @html.br
+                  end
+
+                  # bearing distance resolution - distance unit of measure
+                  unless hBearRes[:distanceUnitOfMeasure].nil?
+                     @html.em('Distance Unit of Measure: ')
+                     @html.text!(hBearRes[:distanceUnitOfMeasure])
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing resolution
+                  unless hBearRes[:bearingResolution].nil?
+                     @html.em('Bearing Resolution: ')
+                     @html.text!(hBearRes[:bearingResolution].to_s)
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing unit of measure
+                  unless hBearRes[:bearingUnitOfMeasure].nil?
+                     @html.em('Bearing Unit of Measure: ')
+                     @html.text!(hBearRes[:bearingUnitOfMeasure])
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing reference direction
+                  unless hBearRes[:bearingReferenceDirection].nil?
+                     @html.em('Bearing Reference Direction: ')
+                     @html.text!(hBearRes[:bearingReferenceDirection])
+                     @html.br
+                  end
+
+                  # bearing distance resolution - bearing reference meridian
+                  unless hBearRes[:bearingReferenceMeridian].nil?
+                     @html.em('Bearing Reference Meridian: ')
+                     @html.text!(hBearRes[:bearingReferenceMeridian])
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_BearingDistanceResolution
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_body.rb

@@ -0,0 +1,319 @@
+# HTML writer
+# html body
+
+# History:
+#  Stan Smith 2018-01-19 add resource citation title to report header
+#  Stan Smith 2017-03-22 refactor for mdTranslator 2.0
+#  Stan Smith 2015-07-20 moved mdTranslator logo to html_inlineCss.css
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+#  Stan Smith 2014-04-10 add open and close buttons
+#  Stan Smith 2015-03-23 original script
+
+require_relative 'html_contact'
+require_relative 'html_metadataInfo'
+require_relative 'html_resourceInfo'
+require_relative 'html_dataQuality'
+require_relative 'html_lineage'
+require_relative 'html_distribution'
+require_relative 'html_associatedResource'
+require_relative 'html_additionalDocumentation'
+require_relative 'html_funding'
+require_relative 'html_dataDictionary'
+require_relative 'html_metadataRepository'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Body
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(version, intObj)
+                  @html.body do
+
+                     # classes used
+                     metaInfoClass = Html_MetadataInfo.new(@html)
+                     contactClass = Html_Contact.new(@html)
+                     resourceClass = Html_ResourceInfo.new(@html)
+                     dataQualityClass = Html_DataQuality.new(@html)
+                     lineageClass = Html_Lineage.new(@html)
+                     distributionClass = Html_Distribution.new(@html)
+                     associatedClass = Html_AssociatedResource.new(@html)
+                     additionalClass = Html_AdditionalDocumentation.new(@html)
+                     fundingClass = Html_Funding.new(@html)
+                     dictionaryClass = Html_DataDictionary.new(@html)
+                     repositoryClass = Html_Repository.new(@html)
+
+                     # make sections of the internal data store convenient
+                     hSchema = intObj[:schema]
+                     aContacts = intObj[:contacts]
+                     hMetaInfo = intObj[:metadata][:metadataInfo]
+                     hResourceInfo = intObj[:metadata][:resourceInfo]
+                     aDataQuality = intObj[:metadata][:dataQuality]
+                     aLineage = intObj[:metadata][:lineageInfo]
+                     aDistribution = intObj[:metadata][:distributorInfo]
+                     aAssociated = intObj[:metadata][:associatedResources]
+                     aAdditional = intObj[:metadata][:additionalDocuments]
+                     aFunding = intObj[:metadata][:funding]
+                     aDictionaries = intObj[:dataDictionaries]
+                     aRepositories = intObj[:metadataRepositories]
+
+                     # set page title and logo
+                     # side navigation
+                     @html.div('id' => 'sideNav') do
+
+                        # add section buttons
+                        @html.a(' Top', {'href' => '#', 'class' => 'btn'})
+                        @html.a(' Contacts', {'href' => '#body-contacts', 'class' => 'btn navBtn', 'id' => 'contactButton'})
+                        @html.a(' Metadata', {'href' => '#body-metadataInfo', 'class' => 'btn navBtn', 'id' => 'metadataButton'})
+                        @html.a(' Resource', {'href' => '#body-resourceInfo', 'class' => 'btn navBtn', 'id' => 'resourceButton'})
+                        @html.a(' Lineage', {'href' => '#body-lineage', 'class' => 'btn navBtn', 'id' => 'lineageButton'})
+                        @html.a(' Distribution', {'href' => '#body-distribution', 'class' => 'btn navBtn', 'id' => 'distributionButton'})
+                        @html.a(' Associated', {'href' => '#body-associatedResource', 'class' => 'btn navBtn', 'id' => 'associatedButton'})
+                        @html.a(' Additional', {'href' => '#body-additionalDocument', 'class' => 'btn navBtn', 'id' => 'additionalButton'})
+                        @html.a(' Dictionary', {'href' => '#body-dataDictionary', 'class' => 'btn navBtn', 'id' => 'dictionaryButton'})
+                        @html.a(' Funding', {'href' => '#body-funding', 'class' => 'btn navBtn', 'id' => 'fundingButton'})
+                        @html.a(' Repository', {'href' => '#body-repository', 'class' => 'btn navBtn', 'id' => 'repositoryButton'})
+
+                        # add open and close buttons
+                        @html.span(' Open', {'class' => 'btn icon-caret-down', 'id' => 'openAllButton'})
+                        @html.span(' Close', {'class' => 'btn icon-caret-right', 'id' => 'closeAllButton'})
+
+                     end
+
+                     # main header
+                     @html.h2('id' => 'mainHeader') do
+                        # added blank to span tag to force builder to create closing tag
+                        @html.span('', 'id' => 'logo')
+                        @html.span('Metadata Record')
+                        @html.span('HTML5', 'class' => 'version')
+                     end
+
+                     # report title
+                     # aShortVersion = version.split('.')
+                     # shortVersion = aShortVersion[0].to_s + '.' + aShortVersion[1].to_s
+                     @html.h1('mdTranslator ' + version + ' HTML Metadata Record', 'id' => 'mdtranslator-metadata-report')
+
+                     # resource citation title
+                     unless hResourceInfo.empty?
+                        unless hResourceInfo[:citation].empty?
+                           unless hResourceInfo[:citation][:title].nil?
+                              @html.h2(hResourceInfo[:citation][:title])
+                           end
+                        end
+                     end
+
+                     # report date
+                     @html.div(:class => 'block') do
+                        @html.em('Report Generated:')
+                        @html.text!(Time.new.inspect)
+                     end
+
+                     # metadata source
+                     @html.h3('Metadata Source', 'id' => 'metadataSource')
+                     @html.div(:class => 'block') do
+                        @html.em('Metadata schema:')
+                        @html.text!(hSchema[:name])
+                        @html.br
+
+                        @html.em('Schema version:')
+                        @html.text!(hSchema[:version])
+                     end
+                     @html.hr
+
+                     # contacts [] section
+                     unless aContacts.empty?
+                        @html.div do
+                           @html.h2('Contacts', {'id' => 'body-contacts', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-contacts'})
+                           @html.div(:class => 'block') do
+                              aContacts.each do |hContact|
+                                 @html.div(:class => 'block') do
+                                    contactClass.writeHtml(hContact)
+                                 end
+                              end
+                              @html.hr
+                           end
+                        end
+                     end
+
+                     # metadata information section
+                     unless hMetaInfo.empty?
+                        @html.div do
+                        @html.h2('Metadata Information', {'id' => 'body-metadataInfo', 'class' => 'h2'})
+                        @html.span('', {'style' => 'mso-bookmark:body-metadataInfo'})
+                        @html.div(:class => 'block') do
+                              @html.div(:class => 'block') do
+                                 metaInfoClass.writeHtml(hMetaInfo)
+                              end
+                           end
+                           @html.hr
+                        end
+                     end
+
+                     # resource information section
+                     unless hResourceInfo.empty?
+                        @html.div do
+                           @html.h2('Resource Information', {'id' => 'body-resourceInfo', 'class' => 'h2'})
+                        @html.span('', {'style' => 'mso-bookmark:body-resourceInfo'})
+                        @html.div(:class => 'block') do
+                              resourceClass.writeHtml(hResourceInfo)
+                           end
+                           @html.hr
+                        end
+                     end
+
+                     unless aDataQuality.nil? || aDataQuality.empty?
+                        @html.div do
+                           @html.h2('Data Quality', {'id' => 'body-dataQuality', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-dataQuality'})
+                           aDataQuality.each do |hDataQuality|
+                              @html.div(:class => 'block') do
+                                 dataQualityClass.writeHtml(hDataQuality)
+                              end
+                           end
+                        end
+                     end
+
+                     # lineage section
+                     unless aLineage.empty?
+                        @html.div do
+                           @html.h2('Resource Lineage', {'id' => 'body-lineage', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-lineage'})
+                           @html.div(:class => 'block') do
+                              aLineage.each do |hLineage|
+                                 @html.div do
+                                    @html.h3('Lineage', {'class' => 'h3'})
+                                    @html.div(:class => 'block') do
+                                       lineageClass.writeHtml(hLineage)
+                                    end
+                                 end
+                              end
+                           end
+                           @html.hr
+                        end
+                     end
+
+                     # distribution section
+                     unless aDistribution.empty?
+                        @html.div do
+                           @html.h2('Resource Distribution', {'id' => 'body-distribution', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-distribution'})
+                           @html.div(:class => 'block') do
+                              aDistribution.each do |hDistribution|
+                                 @html.div do
+                                    @html.h3('Distribution', {'class' => 'h3'})
+                                    @html.div(:class => 'block') do
+                                       distributionClass.writeHtml(hDistribution)
+                                    end
+                                 end
+                              end
+                           end
+                           @html.hr
+                        end
+                     end
+
+                     # associated resource section
+                     unless aAssociated.empty?
+                        @html.div do
+                           @html.h2('Associated Resources', {'id' => 'body-associatedResource', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-associatedResource'})
+                           @html.div(:class => 'block') do
+                              aAssociated.each do |hAssociated|
+                                 @html.div do
+                                    @html.h3('Resource', {'class' => 'h3'})
+                                    @html.div(:class => 'block') do
+                                       associatedClass.writeHtml(hAssociated)
+                                    end
+                                 end
+                              end
+                           end
+                           @html.hr
+                        end
+                     end
+
+                     # additional documentation section
+                     unless aAdditional.empty?
+                        @html.div do
+                           @html.h2('Additional Documentation', {'id' => 'body-additionalDocument', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-additionalDocument'})
+                           @html.div(:class => 'block') do
+                              aAdditional.each do |hAdditional|
+                                 @html.div do
+                                    @html.h3('Document', {'class' => 'h3'})
+                                    @html.div(:class => 'block') do
+                                       additionalClass.writeHtml(hAdditional)
+                                    end
+                                 end
+                              end
+                           end
+                           @html.hr
+                        end
+                     end
+
+                     # data dictionary section
+                     unless aDictionaries.empty?
+                        @html.div do
+                           @html.h2('Data Dictionaries', {'id' => 'body-dataDictionary', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-dataDictionary'})
+                           @html.div(:class => 'block') do
+                              aDictionaries.each do |hDictionary|
+                                 @html.div do
+                                    @html.h3('Dictionary', {'class' => 'h3'})
+                                    @html.div(:class => 'block') do
+                                       dictionaryClass.writeHtml(hDictionary)
+                                    end
+                                 end
+                              end
+                           end
+                        end
+                     end
+
+                     # funding section
+                     unless aFunding.empty?
+                        @html.div do
+                           @html.h2('Funding', {'id' => 'body-funding', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-funding'})
+                           @html.div(:class => 'block') do
+                              aFunding.each do |hFunding|
+                                 @html.div do
+                                    @html.h3('Funds', {'class' => 'h3'})
+                                    @html.div(:class => 'block') do
+                                       fundingClass.writeHtml(hFunding)
+                                    end
+                                 end
+                              end
+                           end
+                        end
+                     end
+
+                     # metadata repository section
+                     unless aRepositories.empty?
+                        @html.div do
+                           @html.h2('Metadata Repositories', {'id' => 'body-repository', 'class' => 'h2'})
+                           @html.span('', {'style' => 'mso-bookmark:body-repository'})
+                           @html.div(:class => 'block') do
+                              aRepositories.each do |hRepository|
+                                 @html.div do
+                                    @html.h3('Repository', {'class' => 'h3'})
+                                    @html.div(:class => 'block') do
+                                       repositoryClass.writeHtml(hRepository)
+                                    end
+                                 end
+                              end
+                           end
+                        end
+                     end
+
+                  end # body
+               end # writeHtml
+            end # Html_Body
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_boundingBox.rb

@@ -0,0 +1,69 @@
+# HTML writer
+# bounding box
+
+# History:
+#  Stan Smith 2017-04-06 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_BoundingBox
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hBox)
+
+                  # bounding box - edges
+                  unless hBox[:westLongitude].nil?
+                     @html.em('West Longitude:')
+                     @html.text!(hBox[:westLongitude].to_s)
+                     @html.br
+                  end
+
+                  unless hBox[:eastLongitude].nil?
+                     @html.em('East Longitude:')
+                     @html.text!(hBox[:eastLongitude].to_s)
+                     @html.br
+                  end
+
+                  unless hBox[:southLatitude].nil?
+                     @html.em('South Latitude:')
+                     @html.text!(hBox[:southLatitude].to_s)
+                     @html.br
+                  end
+
+                  unless hBox[:northLatitude].nil?
+                     @html.em('North Latitude:')
+                     @html.text!(hBox[:northLatitude].to_s)
+                     @html.br
+                  end
+
+                  unless hBox[:minimumAltitude].nil?
+                     @html.em('Minimum Altitude:')
+                     @html.text!(hBox[:minimumAltitude].to_s)
+                     @html.br
+                  end
+
+                  unless hBox[:maximumAltitude].nil?
+                     @html.em('Maximum Altitude:')
+                     @html.text!(hBox[:maximumAltitude].to_s)
+                     @html.br
+                  end
+
+                  unless hBox[:unitsOfAltitude].nil?
+                     @html.em('Altitude Units of Measure:')
+                     @html.text!(hBox[:unitsOfAltitude].to_s)
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_BoundingBox
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_citation.rb

@@ -0,0 +1,165 @@
+# HTML writer
+# citation
+
+# History:
+#  Stan Smith 2017-03-23 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-03-23 original script
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+#  Stan Smith 2015-08-26 added alternate title
+
+require_relative 'html_date'
+require_relative 'html_responsibility'
+require_relative 'html_identifier'
+require_relative 'html_onlineResource'
+require_relative 'html_graphic'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Citation
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hCitation)
+
+                  # classes used
+                  dateClass = Html_Date.new(@html)
+                  responsibilityClass = Html_Responsibility.new(@html)
+                  identifierClass = Html_Identifier.new(@html)
+                  onlineClass = Html_OnlineResource.new(@html)
+                  graphicClass = Html_Graphic.new(@html)
+
+                  # citation - title
+                  @html.em('Title: ')
+                  unless hCitation[:title].nil?
+                     @html.text!(hCitation[:title])
+                  else
+                     @html.text!('*MISSING*')
+                  end
+                  @html.br
+
+                  # citation - alternate title
+                  unless hCitation[:alternateTitles].empty?
+                     hCitation[:alternateTitles].each do |altTitle|
+                        @html.em('Alternate title: ')
+                        @html.text!(altTitle)
+                        @html.br
+                     end
+                  end
+
+                  # citation - date [] {}
+                  hCitation[:dates].each do |hDate|
+                     @html.em('Date: ')
+                     dateClass.writeHtml(hDate)
+                     @html.br
+                  end
+
+                  # citation - edition
+                  unless hCitation[:edition].nil?
+                     @html.em('Edition: ')
+                     @html.text!(hCitation[:edition])
+                     @html.br
+                  end
+
+                  # citation - responsibilities [] {responsibility}
+                  hCitation[:responsibleParties].each do |hResponsibility|
+                     @html.div do
+                        @html.h5(hResponsibility[:roleName], 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           responsibilityClass.writeHtml(hResponsibility)
+                        end
+                     end
+                  end
+
+                  # citation - identifier []
+                  hCitation[:identifiers].each do |hIdentifier|
+                     @html.div do
+                        @html.h5('Identifier', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           identifierClass.writeHtml(hIdentifier)
+                        end
+                     end
+                  end
+
+                  # citation - series
+                  unless hCitation[:series].empty?
+                     @html.div do
+                        @html.h5('Publication Series', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+
+                           hSeries = hCitation[:series]
+
+                           # series - name
+                           unless hSeries[:seriesName].nil?
+                              @html.em('Series Name: ')
+                              @html.text!(hSeries[:seriesName])
+                              @html.br
+                           end
+
+                           # series - issue
+                           unless hSeries[:seriesIssue].nil?
+                              @html.em('Series Issue: ')
+                              @html.text!(hSeries[:seriesIssue])
+                              @html.br
+                           end
+
+                           # series - page
+                           unless hSeries[:issuePage].nil?
+                              @html.em('Issue Page: ')
+                              @html.text!(hSeries[:issuePage])
+                              @html.br
+                           end
+
+                        end
+                     end
+                  end
+
+                  # citation - online resource []
+                  hCitation[:onlineResources].each do |hOnline|
+                     @html.div do
+                        @html.h5('Online Resource', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           onlineClass.writeHtml(hOnline)
+                        end
+                     end
+                  end
+
+                  # citation - browse graphic []
+                  hCitation[:browseGraphics].each do |hGraphic|
+                     @html.div do
+                        @html.h5('Graphic Overview', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           graphicClass.writeHtml(hGraphic)
+                        end
+                     end
+                  end
+
+                  # citation - presentation form []
+                  unless hCitation[:presentationForms].empty?
+                     hCitation[:presentationForms].each do |forms|
+                        @html.em('Presentation Form: ')
+                        @html.text!(forms)
+                        @html.br
+                     end
+                  end
+
+                  # citation - other div []
+                  # unless hCitation[:otherdiv].empty?
+                  #    hCitation[:otherdiv].each do |detail|
+                  #       @html.em('Other div: ')
+                  #       @html.text!(detail)
+                  #       @html.br
+                  #    end
+                  # end
+
+               end # writeHtml
+            end # Html_Citation
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/sections/html_classedData.rb

@@ -0,0 +1,50 @@
+# HTML writer
+# classed data
+
+# History:
+# 	Stan Smith 2015-08-21 original script
+
+require_relative 'html_classedDataItem'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Simple_html
+
+                class MdHtmlClassedData
+                    def initialize(html)
+                        @html = html
+                    end
+
+                    def writeHtml(hClassD)
+
+                        # classes used
+                        htmlClassItem = MdHtmlClassedDataItem.new(@html)
+
+                        # classed data - number of classes
+                        s = hClassD[:numberOfClasses]
+                        if !s.nil?
+                            @html.em('Number of classes: ')
+                            @html.text!(s.to_s)
+                            @html.br
+                        end
+
+                        # classed data - data items
+                        aClassItems = hClassD[:classedDataItems]
+                        aClassItems.each do |hClassItem|
+                            @html.div do
+                                @html.h5(hClassItem[:className], {'class'=>'h5'})
+                                @html.div(:class=>'block') do
+                                    htmlClassItem.writeHtml(hClassItem)
+                                end
+                            end
+                        end
+
+                    end # writeHtml
+
+                end # class
+
+            end
+        end
+    end
+end