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

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

@@ -0,0 +1,118 @@
+# HTML writer
+# usage
+
+# 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-03-25 original script
+
+require_relative 'html_temporalExtent'
+require_relative 'html_citation'
+require_relative 'html_responsibility'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_Usage
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hUsage)
+
+                  # classes used
+                  temporalClass = Html_TemporalExtent.new(@html)
+                  citationClass = Html_Citation.new(@html)
+                  responsibilityClass = Html_Responsibility.new(@html)
+
+                  # resource usage - use
+                  @html.em('Usage: ')
+                  @html.div(:class => 'block') do
+                     @html.text!(hUsage[:specificUsage])
+                  end
+
+                  # resource usage - temporal extent
+                  unless hUsage[:temporalExtents].empty?
+                     @html.div do
+                        @html.div('Times and Periods of Usage', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           hUsage[:temporalExtents].each do |hTemporal|
+                              temporalClass.writeHtml(hTemporal)
+                           end
+                        end
+                     end
+                  end
+
+                  # resource usage - limitation
+                  unless hUsage[:userLimitation].nil? && hUsage[:limitationResponses].empty?
+                     @html.div do
+                        @html.div('User Defined Limitations', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+
+                           # user limitation
+                           unless hUsage[:userLimitation].nil?
+                              @html.em('Description')
+                              @html.div(:class => 'block') do
+                                 @html.text!(hUsage[:userLimitation])
+                              end
+                           end
+
+                           # limitation responses []
+                           hUsage[:limitationResponses].each do |response|
+                              @html.em('Response')
+                              @html.div(:class => 'block') do
+                                 @html.text!(response)
+                              end
+                           end
+
+                        end
+                     end
+                  end
+
+                  # resource usage - documented issue
+                  unless hUsage[:identifiedIssue].empty?
+                     @html.div do
+                        @html.div('Cited Issue', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hUsage[:identifiedIssue])
+                        end
+                     end
+                  end
+
+                  # resource usage - additional documentation
+                  hUsage[:additionalDocumentation].each do |hCitation|
+                     @html.div do
+                        @html.div('Additional Documentation', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           citationClass.writeHtml(hCitation)
+                        end
+                     end
+                  end
+
+                  # resource usage - user contacts
+                  unless hUsage[:userContacts].empty?
+                     @html.div do
+                        @html.div('Usage and Limitation Contacts', {'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           hUsage[:userContacts].each do |hContact|
+                              @html.div do
+                                 @html.div(hContact[:roleName], 'class' => 'h5')
+                                 @html.div(:class => 'block') do
+                                    responsibilityClass.writeHtml(hContact)
+                                 end
+                              end
+                           end
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_Usage
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,40 @@
+# HTML writer
+# vector object
+
+# History:
+#  Stan Smith 2017-03-28 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_VectorObject
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hObject)
+
+                  # vector object - type
+                  unless hObject[:objectType].nil?
+                     @html.em('Object Type: ')
+                     @html.text!(hObject[:objectType])
+                     @html.br
+                  end
+
+                  # vector object - count
+                  unless hObject[:objectCount].nil?
+                     @html.em('Object Count: ')
+                     @html.text!(hObject[:objectCount].to_s)
+                     @html.br
+                  end
+
+               end # writeHtml
+            end # Html_VectorObject
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,62 @@
+# HTML writer
+# vector representation
+
+# History:
+#  Stan Smith 2017-10-13 trap missing topology level
+#  Stan Smith 2017-03-28 original script
+
+require_relative 'html_vectorObject'
+require_relative 'html_scope'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_VectorRepresentation
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hVector)
+
+                  # classes used
+                  objectClass = Html_VectorObject.new(@html)
+                  scopeClass = Html_Scope.new(@html)
+
+                  # vector representation - scope
+                  hVector[:scope].each do |scope|
+                     @html.div do
+                        @html.div('Scope ', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           scopeClass.writeHtml(hVector[:scope])
+                        end
+                     end
+                  end
+
+
+                  # vector representation - topology level
+                  unless hVector[:topologyLevel].nil?
+                     @html.em('Topology Level: ')
+                     @html.text!(hVector[:topologyLevel])
+                     @html.br
+                  end
+
+                  # vector representation - vector object []
+                  hVector[:vectorObject].each do |hObject|
+                     @html.div do
+                        @html.div('Vector Object ', 'class' => 'h5')
+                        @html.div(:class => 'block') do
+                           objectClass.writeHtml(hObject)
+                        end
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_VectorRepresentation
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,70 @@
+# HTML writer
+# spatial reference system vertical datum parameters
+
+# History:
+#  Stan Smith 2018-09-26 deprecated verticalDatum.datumName
+#  Stan Smith 2017-10-24 original script
+
+require_relative 'html_identifier'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_VerticalDatumParameters
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hDatum)
+
+                  # classes used
+                  identifierClass = Html_Identifier.new(@html)
+
+                  # vertical datum - is depth system {Boolean}
+                  if hDatum[:encodingMethod]
+                     @html.text!('Depth System')
+                  else
+                     @html.text!('Altitude System')
+                  end
+                  @html.br
+
+                  # vertical datum parameters - vertical datum identifier
+                  unless hDatum[:datumIdentifier].empty?
+                     @html.div do
+                        @html.div('Vertical Datum Identifier', {'id' => 'datum-identifier', 'class' => 'h5'})
+                        @html.div(:class => 'block') do
+                           identifierClass.writeHtml(hDatum[:datumIdentifier])
+                        end
+                     end
+                  end
+
+                  # vertical datum - encoding method
+                  unless hDatum[:encodingMethod].nil?
+                     @html.em('Encoding Method: ')
+                     @html.text!(hDatum[:encodingMethod])
+                     @html.br
+                  end
+
+                  # vertical datum - vertical resolution
+                  unless hDatum[:verticalResolution].nil?
+                     @html.em('Vertical Resolution: ')
+                     @html.text!(hDatum[:verticalResolution].to_s)
+                     @html.br
+                  end
+
+                  # vertical datum - unit of measure
+                  unless hDatum[:unitOfMeasure].nil?
+                     @html.em('Unit of Measure: ')
+                     @html.text!(hDatum[:unitOfMeasure])
+                  end
+
+               end # writeHtml
+            end # Html_VerticalDatumParameters
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,62 @@
+# HTML writer
+# vertical extent
+
+# History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
+# 	Stan Smith 2015-04-03 original script
+
+require_relative 'html_spatialReference'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            class Html_VerticalExtent
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hExtent)
+
+                  # classes used
+                  referenceClass = Html_SpatialReference.new(@html)
+
+                  # vertical extent - description
+                  unless hExtent[:description].nil?
+                     @html.em('Description: ')
+                     @html.div(:class => 'block') do
+                        @html.text!(hExtent[:description])
+                     end
+                  end
+
+                  # vertical extent - min value
+                  unless hExtent[:minValue].nil?
+                     @html.em('Minimum Value: ')
+                     @html.text!(hExtent[:minValue].to_s)
+                     @html.br
+                  end
+
+                  # vertical extent - max value
+                  unless hExtent[:maxValue].nil?
+                     @html.em('Maximum Value: ')
+                     @html.text!(hExtent[:maxValue].to_s)
+                     @html.br
+                  end
+
+                  # vertical extent - CRS ID {spatialReference}
+                  unless hExtent[:crsId].empty?
+                     @html.em('Reference System: ')
+                     @html.div(:class => 'block') do
+                        referenceClass.writeHtml(hExtent[:crsId])
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_VerticalExtent
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/simple_html/simple_html_writer.rb

@@ -0,0 +1,44 @@
+# Writer - html metadata writer
+
+# History:
+#  Stan Smith 2017 03-21 refactored for mdTranslator 2.0
+#  Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+#  Stan Smith 2015-06-23 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2015-01-28 original script
+
+require 'builder'
+require_relative 'version'
+require_relative 'sections/html_document'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            def self.startWriter(intObj, responseObj)
+
+               # set the format and version of the output file
+               responseObj[:writerOutputFormat] = 'html'
+               responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Simple_html::VERSION
+
+               # create new HTML document
+               html = Builder::XmlMarkup.new(indent: 3)
+               # metadataWriter = MdHtmlWriter.new(html, intObj, paramsObj)
+               htmlDocument = Html_Document.new(html, intObj)
+               metadata = htmlDocument.writeHtml(responseObj)
+
+               # set writer pass to true if no messages
+               # false or warning will be set by code that places the message
+               if responseObj[:writerMessages].empty?
+                  responseObj[:writerPass] = true
+               end
+
+               return metadata
+
+            end # startWriter
+
+         end
+      end
+   end
+end
+

data/lib/adiwg/mdtranslator/writers/simple_html/version.rb

@@ -0,0 +1,19 @@
+# html version history
+#  Stan Smith 2.1.0 2017-11-13 added support for spatial reference, geologic time, others
+#  Stan Smith 2.0.0 2017-03-21 refactored for mdTranslator 2.0
+#  Stan Smith 1.1.0 2015-08-28 added support for content coverage information
+#  Stan Smith 1.1.0 2015-07-31 added support for grid information
+#  Stan Smith 1.1.0 2015-07-30 added support for locale in metadata record information
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Simple_html
+
+            # current version of html writer
+            VERSION = '2.1.0'
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator_cli.rb

@@ -39,7 +39,7 @@ and to choose the level of validation for mdJson input files.
                  :enum => %w{mdJson sbJson fgdc}, :required => true
    method_option :writer, :aliases => '-w',
                  :desc => 'Writer to create your output metadata file, leave blank to validate input only',
-                 :enum => %w{fgdc html iso19110 iso19115_1 iso19115_2 mdJson sbJson }
+                 :enum => %w{fgdc html iso19110 iso19115_1 iso19115_2 iso19115_3 mdJson sbJson simple_html }
    method_option :validate, :aliases => '-v', :desc => 'Specify level of validation to be performed',
                  :enum => %w{none normal strict}, :default => 'normal'
    method_option :forceValid, :aliases => '-f', :desc => 'Insert tags for required elements missing from input',
@@ -83,7 +83,7 @@ and to choose the level of validation for mdJson input files.
       mdReturn = ADIWG::Mdtranslator.translate(
          file: fileObj,
          reader: options[:reader],
-         writer: options[:writer],
+         writer: options[:writer] == 'iso19115_1' ? 'iso19115_3' : options[:writer], # iso19115_1 is a subset of iso19115_3
          validate: options[:validate],
          forceValid: options[:forceValid],
          showAllTags: options[:showAllTags],