adiwg-mdtranslator 1.4.0 → 2.0.0rc2

data/lib/adiwg/mdtranslator/readers/sbJson/sbJson_reader.rb

@@ -1,5 +1,4 @@
 require 'json'
-require_relative 'sbJson_validator'
 
 module ADIWG
     module Mdtranslator
@@ -9,32 +8,32 @@ module ADIWG
                 def self.readFile(file, responseObj)
 
                     # set reference to responseObj for use throughout this module
-                    @responseObj = responseObj
+                    @hResponseObj = responseObj
 
                     # receive json file into ruby hash
                     parseJson(file)
-                    if !@responseObj[:readerStructurePass]
+                    if !@hResponseObj[:readerStructurePass]
                         return false
                     end
 
                     # set format of file in $response
-                    @responseObj[:readerFormat] = 'json'
+                    @hResponseObj[:readerFormat] = 'json'
 
                     # check sbJson version name
                     checkVersionName
-                    if !@responseObj[:readerStructurePass]
+                    if !@hResponseObj[:readerStructurePass]
                         return false
                     end
 
                     # check sbJson version number
                     checkVersionNumber
-                    if !@responseObj[:readerStructurePass]
+                    if !@hResponseObj[:readerStructurePass]
                         return false
                     end
 
                     #validate file against sbJson schema definition
-                    validate(file, @responseObj)
-                    if !@responseObj[:readerValidationPass]
+                    validate(file, @hResponseObj)
+                    if !@hResponseObj[:readerValidationPass]
                         return false
                     end
 
@@ -47,7 +46,7 @@ module ADIWG
                     @intObj = intMetadataClass.newBase
 
                     #
-                    ADIWG::Mdtranslator::Readers::SbJson.unpack(@intObj, @hSbJson, @responseObj)
+                    ADIWG::Mdtranslator::Readers::SbJson.unpack(@intObj, @hSbJson, @hResponseObj)
                     return @intObj
 
                 end
@@ -64,11 +63,11 @@ module ADIWG
                           "version" => "0.0.0"
                         }
 
-                        @responseObj[:readerStructurePass] = true
+                        @hResponseObj[:readerStructurePass] = true
                     rescue JSON::JSONError => err
-                        @responseObj[:readerStructurePass] = false
-                        @responseObj[:readerStructureMessages] << 'JSON Parsing Failed - see following message(s):\n'
-                        @responseObj[:readerStructureMessages] << err.to_s.slice(0,300)
+                        @hResponseObj[:readerStructurePass] = false
+                        @hResponseObj[:readerStructureMessages] << 'JSON Parsing Failed - see following message(s):\n'
+                        @hResponseObj[:readerStructureMessages] << err.to_s.slice(0, 300)
                     end
                 end
 
@@ -77,9 +76,9 @@ module ADIWG
                     if @hSbJson.has_key?('version')
                         hVersion = @hSbJson['version']
                     else
-                        @responseObj[:readerStructurePass] = false
-                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        @responseObj[:readerStructureMessages] << 'The input file is missing the version:{} block.'
+                        @hResponseObj[:readerStructurePass] = false
+                        @hResponseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @hResponseObj[:readerStructureMessages] << 'The input file is missing the version:{} block.'
                         return
                     end
 
@@ -87,24 +86,24 @@ module ADIWG
                     if hVersion.has_key?('name')
                         s = hVersion['name']
                         if s.nil?
-                            @responseObj[:readerStructurePass] = false
-                            @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                            @responseObj[:readerStructureMessages] << 'The input file version: => name: is missing.'
+                            @hResponseObj[:readerStructurePass] = false
+                            @hResponseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                            @hResponseObj[:readerStructureMessages] << 'The input file version: => name: is missing.'
                             return
                         end
                     else
-                        @responseObj[:readerStructurePass] = false
-                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        @responseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'name:' attribute."
+                        @hResponseObj[:readerStructurePass] = false
+                        @hResponseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @hResponseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'name:' attribute."
                         return
                     end
 
                     # check the version name is 'sbJson'
                     if s != 'sbJson'
-                        @responseObj[:readerStructurePass] = false
-                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        @responseObj[:readerStructureMessages] << "The mdTranslator reader expected the input file version: name: to be 'sbJson'."
-                        @responseObj[:readerStructureMessages] << "Version name found was: '#{s}'."
+                        @hResponseObj[:readerStructurePass] = false
+                        @hResponseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @hResponseObj[:readerStructureMessages] << "The mdTranslator reader expected the input file version: name: to be 'sbJson'."
+                        @hResponseObj[:readerStructureMessages] << "Version name found was: '#{s}'."
                     end
                 end
 
@@ -114,12 +113,12 @@ module ADIWG
                     if hVersion.has_key?('version')
                         s = hVersion['version']
                         if !s.nil?
-                            @responseObj[:readerVersionRequested] = s
+                            @hResponseObj[:readerVersionRequested] = s
                         end
                     else
-                        @responseObj[:readerStructurePass] = false
-                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        @responseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'version:' number attribute."
+                        @hResponseObj[:readerStructurePass] = false
+                        @hResponseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @hResponseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'version:' number attribute."
                         return
                     end
 
@@ -135,10 +134,10 @@ module ADIWG
                     # look for a folder with modules for the major version number
                     dirName = File.join(File.dirname(__FILE__), 'modules_v' + reqMajor)
                     if !File.directory?(dirName)
-                        @responseObj[:readerStructurePass] = false
-                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        @responseObj[:readerStructureMessages] << 'A reader for the requested version is not supported.'
-                        @responseObj[:readerStructureMessages] << "sbJson version requested was '#{s}'"
+                        @hResponseObj[:readerStructurePass] = false
+                        @hResponseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @hResponseObj[:readerStructureMessages] << 'A reader for the requested version is not supported.'
+                        @hResponseObj[:readerStructureMessages] << "sbJson version requested was '#{s}'"
                         return false
                     end
 
@@ -146,7 +145,7 @@ module ADIWG
                     # get the full version number for this major version of sbJson
                     require File.join(dirName, 'version')
                     curVersion = ADIWG::Mdtranslator::Readers::SbJson::VERSION
-                    @responseObj[:readerVersionUsed] = curVersion
+                    @hResponseObj[:readerVersionUsed] = curVersion
                     aCurVersion = curVersion.split('.')
                     curMinor = aCurVersion[1]
 
@@ -155,10 +154,10 @@ module ADIWG
                     if !aReqVersion[1].nil?
                         reqMinor = aReqVersion[1]
                         if curMinor < reqMinor
-                            @responseObj[:readerStructurePass] = false
-                            @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                            @responseObj[:readerStructureMessages] << 'The requested reader minor version is not supported.'
-                            @responseObj[:readerStructureMessages] << "sbJson version requested was '#{s}'"
+                            @hResponseObj[:readerStructurePass] = false
+                            @hResponseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                            @hResponseObj[:readerStructureMessages] << 'The requested reader minor version is not supported.'
+                            @hResponseObj[:readerStructureMessages] << "sbJson version requested was '#{s}'"
                             return false
                         end
                     end
@@ -181,7 +180,7 @@ module ADIWG
 
                 # require modules for the requested version
                 def self.readerModule(moduleName)
-                    majVersion = @responseObj[:readerVersionUsed].split('.')[0]
+                    majVersion = @hResponseObj[:readerVersionUsed].split('.')[0]
                     dirName = File.join(File.dirname(__FILE__), 'modules_v' + majVersion.to_s)
                     fileName = File.join(dirName, moduleName)
 

data/lib/adiwg/mdtranslator/version.rb

@@ -1,7 +1,44 @@
 # adiwg mdTranslator
 
-# version history
+# version 2 history
+# 2016-10-01 start of version 2
 
+module ADIWG
+    module Mdtranslator
+        # current mdtranslator version
+        VERSION = "2.0.0rc2"
+    end
+end
+
+# version 2 history
+# 2.0.0rc2 2017-04-21 removed inline CSS option from CLI
+# 2.0.0rc1 2017-04-09 release candidate 1
+
+# version 1 history
+# 1.0.0rc1 2015-02-27 schema 1.0 support
+# 1.1.0 2015-04-13 added html writer
+# 1.2.0 2015-06-12 added mdCodes for source of codelists
+#              --- added comments to XML headers for citation of ADIwg
+#              --- added reader and writer names to CLI help
+#              --- added check in responsibleParty for valid contactId
+#              --- added characterSets to resource and metadata, updated iso19115_2 and html writers
+# 1.3.0 2015-06-22 removed global variables for the response object
+#              --- removed global for show all tags and placed in response object
+#              --- removed global for counter for missing ISO IDs and placed in response object
+#              --- removed global pointers to contacts and domain arrays and point to @intObj
+# 1.3.0 2015-07-14 removed global namespaces for readers and writers
+# 1.3.0 2015-07-16 added version number management for readers and writers
+#              --- moved module_coordinates to internal
+# 1.3.0 2015-07-17 suppress minor section anchor links when no section data available is in html writer
+#              --- added meta tags to the html writer
+#              --- added --css and --cssLink method_options to CLI
+# 1.3.0 2015-07-20 moved mdTranslator logo to css so it can be replaced using user provided css
+# 1.3.0 2015-07-30 added locale to metadata info and resource info
+# 1.3.0 2015-07-31 added grid information to resource info
+# 1.3.0 2015-08-19 added coverageInfo, imageInfo, sensorInfo, coverageItem, classifiedData, and classedDataItem
+
+
+# # version 0 history
 # 0.8.0 2014-09-26 first version to release
 # 0.8.1 2014-10-06 used uri from first onlineResource of the resource citation
 #              ... as source for datasetURI in iso19115-2 writer
@@ -36,31 +73,3 @@
 # 0.13.0 2015-01-28 made data dictionary an array
 #               ... added alias to entity and attribute
 #               ... added local names to iso 19110 writer
-# 1.0.0rc1 2015-02-27 schema 1.0 support
-# 1.1.0 2015-04-13 added html writer
-# 1.2.0 2015-06-12 added mdCodes for source of codelists
-#              --- added comments to XML headers for citation of ADIwg
-#              --- added reader and writer names to CLI help
-#              --- added check in responsibleParty for valid contactId
-#              --- added characterSets to resource and metadata, updated iso19115_2 and html writers
-# 1.3.0 2015-06-22 removed global variables for the response object
-#              --- removed global for show all tags and placed in response object
-#              --- removed global for counter for missing ISO IDs and placed in response object
-#              --- removed global pointers to contacts and domain arrays and point to @intObj
-# 1.3.0 2015-07-14 removed global namespaces for readers and writers
-# 1.3.0 2015-07-16 added version number management for readers and writers
-#              --- moved module_coordinates to internal
-# 1.3.0 2015-07-17 suppress minor section anchor links when no section data available is in html writer
-#              --- added meta tags to the html writer
-#              --- added --css and --cssLink method_options to CLI
-# 1.3.0 2015-07-20 moved mdTranslator logo to css so it can be replaced using user provided css
-# 1.3.0 2015-07-30 added locale to metadata info and resource info
-# 1.3.0 2015-07-31 added grid information to resource info
-# 1.3.0 2015-08-19 added coverageInfo, imageInfo, sensorInfo, coverageItem, classifiedData, and classedDataItem
-
-module ADIWG
-    module Mdtranslator
-        # current mdtranslator version
-        VERSION = "1.4.0"
-    end
-end

data/lib/adiwg/mdtranslator/writers/html/html_writer.rb

@@ -1,41 +1,44 @@
 # Writer - html metadata writer
 
 # History:
-# 	Stan Smith 2015-01-28 original script
-#   Stan Smith 2015-06-23 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
+#  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 'md_html_writer'
+require_relative 'sections/html_document'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
+   module Mdtranslator
+      module Writers
+         module Html
 
-                def self.startWriter(intObj, responseObj, paramsObj)
+            def self.startWriter(intObj, responseObj)
 
-                    # set the format of the output file based on the writer specified
-                    responseObj[:writerFormat] = 'html'
-                    responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Html::VERSION
+               # set the format and version of the output file
+               responseObj[:writerFormat] = 'html'
+               responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Html::VERSION
 
-                    # create new HTML document
-                    html = Builder::XmlMarkup.new(indent: 3)
-                    metadataWriter = MdHtmlWriter.new(html, intObj, paramsObj)
-                    metadata = metadataWriter.writeHtml()
+               # 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].length == 0
-                        responseObj[:writerPass] = true
-                    end
+               # 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
+               return metadata
 
-            end
-        end
-    end
+            end # startWriter
+
+         end
+      end
+   end
 end
 

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

@@ -3,12 +3,6 @@
 
 ### Writer for HTML 'human-readable' output of metadata
 
-The HTML version of metadata is intended to be a human readable
-version of the metadata content.  The HTML output does not mimic
-any established metadata standard but remains agnostic in its
-presentation.  The HTML metadata version will present the entire
-content of the metadata provided to the mdTranslator reader.
-
-The HTML writer can be use to allow users to conveniently scan
-metadata prior to downloading a data file or to generate a printed
-version of metadata to accompany a report.
+The HTML Metadata Record output from the mdTranslator is intended to be a human readable version of the metadata content read in by the translator.  The HTML output does not attempt mimic any established metadata standard but remains agnostic in its presentation.  The HTML metadata output will display the full content of the metadata record ingested by the mdTranslator while translation to established standards may not support all fields.
+
+The HTML output can be conveniently embedded in a users web page to present metadata content to visitors.

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

@@ -2,47 +2,48 @@
 # additional documentation
 
 # History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
 # 	Stan Smith 2015-08-21 original script
 
+require_relative 'html_resourceType'
 require_relative 'html_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
-
-                class MdHtmlAdditionalDocumentation
-                    def initialize(html)
-                        @html = html
-                    end
-
-                    def writeHtml(hAddDoc)
-
-                        # classes used
-                        htmlCitation = MdHtmlCitation.new(@html)
-
-                        # additional documentation - resource type
-                        s = hAddDoc[:resourceType]
-                        if !s.nil?
-                            @html.em('Resource type: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+   module Mdtranslator
+      module Writers
+         module Html
 
-                        # additional documentation - citation
-                        hCitation = hAddDoc[:citation]
-                        if !hCitation.empty?
-                            @html.em('Citation: ')
-                            @html.section(:class=>'block') do
-                                htmlCitation.writeHtml(hCitation)
-                            end
-                        end
+            class Html_AdditionalDocumentation
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hAddDoc)
 
-                    end # writeHtml
+                  # classes used
+                  typeClass = Html_ResourceType.new(@html)
+                  citationClass = Html_Citation.new(@html)
+
+                  # additional documentation - resource type [] {resourceType}
+                  hAddDoc[:resourceTypes].each do |hType|
+                     typeClass.writeHtml(hType)
+                  end
+
+                  # additional documentation - citation [] {citation}
+                  hAddDoc[:citation].each do |hCitation|
+                     @html.details do
+                        @html.summary(hCitation[:title], {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           citationClass.writeHtml(hCitation)
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_AdditionalDocumentation
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

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

@@ -0,0 +1,71 @@
+# HTML writer
+# allocation
+
+# History:
+#  Stan Smith 2017-04-04 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module Html
+
+            class Html_Allocation
+
+               def initialize(html)
+                  @html = html
+               end
+
+               def writeHtml(hAllocation)
+
+                  # allocation - amount
+                  unless hAllocation[:amount].nil?
+                     @html.em('Amount: ')
+                     @html.text!(hAllocation[:amount].to_s)
+                     @html.br
+                  end
+
+                  # allocation - currency
+                  unless hAllocation[:currency].nil?
+                     @html.em('Currency: ')
+                     @html.text!(hAllocation[:currency])
+                     @html.br
+                  end
+
+                  # allocation - sourceId
+                  unless hAllocation[:sourceId].nil?
+                     hContact = Html_Document.getContact(hAllocation[:sourceId])
+                     @html.em('Source Contact: ')
+                     @html.a(hContact[:contactId], 'href' => '#CID_'+hContact[:contactId])
+                     @html.br
+                  end
+
+                  # allocation - recipientId
+                  unless hAllocation[:recipientId].nil?
+                     hContact = Html_Document.getContact(hAllocation[:recipientId])
+                     @html.em('Recipient Contact: ')
+                     @html.a(hContact[:contactId], 'href' => '#CID_'+hContact[:contactId])
+                     @html.br
+                  end
+
+                  # allocation - matching {Boolean}
+                  unless hAllocation[:matching].nil?
+                     @html.em('Matching Funds Provided: ')
+                     @html.text!(hAllocation[:matching].to_s)
+                     @html.br
+                  end
+
+                  # allocation - comment
+                  unless hAllocation[:comment].nil?
+                     @html.em('Comment: ')
+                     @html.section(:class => 'block') do
+                        @html.text!(hAllocation[:comment])
+                     end
+                  end
+
+               end # writeHtml
+            end # Html_Allocation
+
+         end
+      end
+   end
+end

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

@@ -2,72 +2,72 @@
 # associated resource
 
 # History:
+#  Stan Smith 2017-04-04 refactored for mdTranslator 2.0
 # 	Stan Smith 2015-08-21 original script
 
+require_relative 'html_resourceType'
 require_relative 'html_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Html
+   module Mdtranslator
+      module Writers
+         module Html
 
-                class MdHtmlAssociatedResource
-                    def initialize(html)
-                        @html = html
-                    end
+            class Html_AssociatedResource
 
-                    def writeHtml(hAssRes)
+               def initialize(html)
+                  @html = html
+               end
 
-                        # classes used
-                        htmlCitation = MdHtmlCitation.new(@html)
+               def writeHtml(hResource)
 
-                        # associated resource - resource type
-                        s = hAssRes[:resourceType]
-                        if !s.nil?
-                            @html.em('Resource type: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+                  # classes used
+                  typeClass = Html_ResourceType.new(@html)
+                  citationClass = Html_Citation.new(@html)
 
-                        # associated resource - association type
-                        s = hAssRes[:associationType]
-                        if !s.nil?
-                            @html.em('Association type: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+                  # associated resource - resource type
+                  hResource[:resourceTypes].each do |hType|
+                     typeClass.writeHtml(hType)
+                  end
 
-                        # associated resource - initiative type
-                        s = hAssRes[:initiativeType]
-                        if !s.nil?
-                            @html.em('Initiative type: ')
-                            @html.text!(s)
-                            @html.br
-                        end
+                  # associated resource - association type {associationTypeCode}
+                  unless hResource[:associationType].nil?
+                     @html.em('Association type: ')
+                     @html.text!(hResource[:associationType])
+                     @html.br
+                  end
 
-                        # associated resource - citation
-                        hCitation = hAssRes[:resourceCitation]
-                        if !hCitation.empty?
-                            @html.em('Resource citation: ')
-                            @html.section(:class=>'block') do
-                                htmlCitation.writeHtml(hCitation)
-                            end
-                        end
+                  # associated resource - initiative type {initiativeTypeCode}
+                  unless hResource[:initiativeType].nil?
+                     @html.em('Initiative type: ')
+                     @html.text!(hResource[:initiativeType])
+                     @html.br
+                  end
 
-                        # associated resource - metadata citation
-                        hCitation = hAssRes[:metadataCitation]
-                        if !hCitation.empty?
-                            @html.em('Metadata citation: ')
-                            @html.section(:class=>'block') do
-                                htmlCitation.writeHtml(hCitation)
-                            end
+                  # associated resource - resource citation {citation}
+                  unless hResource[:resourceCitation].empty?
+                     @html.details do
+                        @html.summary('Resource citation', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           citationClass.writeHtml(hResource[:resourceCitation])
                         end
+                     end
+                  end
 
-                    end # writeHtml
+                  # associated resource - metadata citation
+                  unless hResource[:metadataCitation].empty?
+                     @html.details do
+                        @html.summary('Metadata citation', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           citationClass.writeHtml(hResource[:metadataCitation])
+                        end
+                     end
+                  end
 
-                end # class
+               end # writeHtml
+            end # Html_AssociatedResource
 
-            end
-        end
-    end
+         end
+      end
+   end
 end