adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_spatialReference.rb

@@ -4,6 +4,8 @@
 # History:
 # 	Stan Smith 2014-09-03 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -12,7 +14,7 @@ module ADIWG
 
                 module SpatialReferenceSystem
 
-                    def self.unpack(hSpatialRef)
+                    def self.unpack(hSpatialRef, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_taxonClass.rb

@@ -4,6 +4,8 @@
 # History:
 # 	Stan Smith 2013-11-21 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -12,7 +14,7 @@ module ADIWG
 
                 module TaxonCl
 
-                    def self.unpack(hTaxClass)
+                    def self.unpack(hTaxClass, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_taxonomy.rb

@@ -7,11 +7,13 @@
 #   Stan Smith 2014-05-02 fixed assignment problem with taxonomic procedures
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_citation')
-require $ReaderNS.readerModule('module_responsibleParty')
-require $ReaderNS.readerModule('module_voucher')
-require $ReaderNS.readerModule('module_taxonClass')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_voucher')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_taxonClass')
 
 module ADIWG
     module Mdtranslator
@@ -20,7 +22,7 @@ module ADIWG
 
                 module Taxonomy
 
-                    def self.unpack(hTaxonomy)
+                    def self.unpack(hTaxonomy, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -31,7 +33,7 @@ module ADIWG
                             aClassSys = hTaxonomy['classificationSystem']
                             unless aClassSys.empty?
                                 aClassSys.each do |hCitation|
-                                    intTaxSys[:taxClassSys] << $ReaderNS::Citation.unpack(hCitation)
+                                    intTaxSys[:taxClassSys] << Citation.unpack(hCitation, responseObj)
                                 end
                             end
                         end
@@ -52,7 +54,7 @@ module ADIWG
                             aObservers = hTaxonomy['observer']
                             unless aObservers.empty?
                                 aObservers.each do |observer|
-                                    intTaxSys[:taxObservers] << $ReaderNS::ResponsibleParty.unpack(observer)
+                                    intTaxSys[:taxObservers] << ResponsibleParty.unpack(observer, responseObj)
                                 end
                             end
                         end
@@ -69,7 +71,7 @@ module ADIWG
                         if hTaxonomy.has_key?('voucher')
                             hVoucher = hTaxonomy['voucher']
                             unless hVoucher.empty?
-                                intTaxSys[:taxVoucher] = $ReaderNS::Voucher.unpack(hVoucher)
+                                intTaxSys[:taxVoucher] = Voucher.unpack(hVoucher, responseObj)
                             end
                         end
 
@@ -78,7 +80,7 @@ module ADIWG
                             aTaxClass = hTaxonomy['taxonClass']
                             unless aTaxClass.empty?
                                 aTaxClass.each do |hTaxClass|
-                                    intTaxSys[:taxClasses] << $ReaderNS::TaxonCl.unpack(hTaxClass)
+                                    intTaxSys[:taxClasses] << TaxonCl.unpack(hTaxClass, responseObj)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_temporalElement.rb

@@ -11,10 +11,12 @@
 # 	Stan Smith 2013-12-11 modified to handle single temporal element
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_dateTime')
-require $ReaderNS.readerModule('module_timeInstant')
-require $ReaderNS.readerModule('module_timePeriod')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_timeInstant')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_timePeriod')
 
 module ADIWG
     module Mdtranslator
@@ -23,7 +25,7 @@ module ADIWG
 
                 module TemporalElement
 
-                    def self.unpack(hTempElement)
+                    def self.unpack(hTempElement, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -35,7 +37,7 @@ module ADIWG
                             unless aDates.empty?
                                 aDates.each do |s|
                                     intTempEle = intMetadataClass.newTemporalElement
-                                    intTempEle[:date] = $ReaderNS::DateTime.unpack(s)
+                                    intTempEle[:date] = DateTime.unpack(s, responseObj)
                                     aIntTempElements << intTempEle
                                 end
                             end
@@ -50,7 +52,7 @@ module ADIWG
                                         s = hTimeInst['timePosition']
                                         if s != ''
                                             intTempEle = intMetadataClass.newTemporalElement
-                                            intTempEle[:timeInstant] = $ReaderNS::TimeInstant.unpack(hTimeInst)
+                                            intTempEle[:timeInstant] = TimeInstant.unpack(hTimeInst, responseObj)
                                             aIntTempElements << intTempEle
                                         end
                                     end
@@ -64,7 +66,7 @@ module ADIWG
                             unless aTimePeriod.empty?
                                 aTimePeriod.each do |hTimePeriod|
                                     intTempEle = intMetadataClass.newTemporalElement
-                                    intTempEle[:timePeriod] = $ReaderNS::TimePeriod.unpack(hTimePeriod)
+                                    intTempEle[:timePeriod] = TimePeriod.unpack(hTimePeriod, responseObj)
                                     aIntTempElements << intTempEle
                                 end
                             end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_timeInstant.rb

@@ -5,8 +5,10 @@
 # 	Stan Smith 2013-12-11 original script
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_dateTime')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
 
 module ADIWG
     module Mdtranslator
@@ -15,7 +17,7 @@ module ADIWG
 
                 module TimeInstant
 
-                    def self.unpack(hTimeInst)
+                    def self.unpack(hTimeInst, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -41,7 +43,7 @@ module ADIWG
                         if hTimeInst.has_key?('timePosition')
                             s = hTimeInst['timePosition']
                             if s != ''
-                                intTimeInst[:timePosition] = $ReaderNS::DateTime.unpack(s)
+                                intTimeInst[:timePosition] = DateTime.unpack(s, responseObj)
                             end
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_timePeriod.rb

@@ -5,8 +5,10 @@
 # 	Stan Smith 2013-12-11 original script
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_dateTime')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
 
 module ADIWG
     module Mdtranslator
@@ -15,7 +17,7 @@ module ADIWG
 
                 module TimePeriod
 
-                    def self.unpack(hTimePeriod)
+                    def self.unpack(hTimePeriod, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -40,7 +42,7 @@ module ADIWG
                         if hTimePeriod.has_key?('beginPosition')
                             s = hTimePeriod['beginPosition']
                             if s != ''
-                                intTimePer[:beginTime] = $ReaderNS::DateTime.unpack(s)
+                                intTimePer[:beginTime] = DateTime.unpack(s, responseObj)
 
                             end
                         end
@@ -48,7 +50,7 @@ module ADIWG
                         if hTimePeriod.has_key?('endPosition')
                             s = hTimePeriod['endPosition']
                             if s != ''
-                                intTimePer[:endTime] = $ReaderNS::DateTime.unpack(s)
+                                intTimePer[:endTime] = DateTime.unpack(s, responseObj)
 
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_verticalElement.rb

@@ -5,6 +5,8 @@
 # 	Stan Smith 2013-11-18 original script
 # 	Stan Smith 2013-12-11 modified to handle single vertical element
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -13,7 +15,7 @@ module ADIWG
 
                 module VerticalElement
 
-                    def self.unpack(hVertElement)
+                    def self.unpack(hVertElement, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_voucher.rb

@@ -5,8 +5,10 @@
 # 	Stan Smith 2013-11-21 original script
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_responsibleParty')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
 
 module ADIWG
     module Mdtranslator
@@ -15,7 +17,7 @@ module ADIWG
 
                 module Voucher
 
-                    def self.unpack(hVoucher)
+                    def self.unpack(hVoucher, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -33,7 +35,7 @@ module ADIWG
                         if hVoucher.has_key?('repository')
                             hRepository = hVoucher['repository']
                             unless hRepository.empty?
-                                intTaxVoucher[:repository] = $ReaderNS::ResponsibleParty.unpack(hRepository)
+                                intTaxVoucher[:repository] = ResponsibleParty.unpack(hRepository, responseObj)
                             end
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/version.rb

@@ -0,0 +1,19 @@
+# mdJson version history
+# 1.1.0 2015-07-30 added support for locale in metadata record information
+# 1.1.0 2015-07-31 added support for grid information
+# 1.1.0 2015-08-04 added support for content coverage information
+# 1.1.0 2015-09-18 added elements to distributor information
+# 1.1.0 2015-09-18 moved distribution format into distributor transfer options
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                # current version of mdJson reader version 1
+                VERSION = '1.1.0'
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdReaders.rb

@@ -4,49 +4,52 @@
 # 	Stan Smith 2014-12-11 original script
 #   Stan Smith 2012-12-16 generalized handleReader to use :readerRequested
 #   Stan Smith 2015-03-04 changed method of setting $WriterNS
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
         module Readers
 
-            def self.handleReader(file)
+            def self.handleReader(file, responseObj)
 
-                # use reader name to load and initiate reader
-                # build directory path name for reader
-                readerDir = File.join(path_to_resources, $response[:readerRequested])
+                # use readerRequested from responseObj to build directory path to reader
+                # the readers's high level folder must be under the 'writers' directory
+                readerDir = File.join(path_to_readers, responseObj[:readerRequested])
                 if File.directory?(readerDir)
 
                     # if directory path exists, build reader file name and require it
-                    readerFile = File.join(readerDir, $response[:readerRequested] + '_reader')
+                    readerFile = File.join(readerDir, responseObj[:readerRequested] + '_reader')
                     require readerFile
-                    readerClassName = $response[:readerRequested].dup
-                    readerClassName[0] = readerClassName[0].upcase
-                    $ReaderNS = ADIWG::Mdtranslator::Readers.const_get(readerClassName)
 
+                    # build the namespace for the reader
+                    readerNS = responseObj[:readerRequested].dup
+                    readerNS[0] = readerNS[0].upcase
+
+                    # pass file and response object to requested reader
+                    # the reader will return the internal object with the metadata content loaded
+                    return ADIWG::Mdtranslator::Readers.const_get(readerNS).readFile(file, responseObj)
 
-                    # pass file to requested reader and return internal object
-                    # $ReaderNS is the reader namespace constant set in
-                    # ... readerRequested_reader.rb and initialized when the file is required
-                    return $ReaderNS.readFile(file)
                 else
-                    # directory path was not found
-                    $response[:readerValidationPass] = false
-                    $response[:readerValidationMessages] << "Validation Failed - see following message(s):\n"
-                    $response[:readerValidationMessages] << "Reader '#{$response[:readerRequested]}' is not supported."
+                    # the directory path was not found meaning there is no reader with that name
+                    # set the appropriate messages and report the failure
+                    responseObj[:readerValidationPass] = false
+                    responseObj[:readerValidationMessages] << "Validation Failed - see following message(s):\n"
+                    responseObj[:readerValidationMessages] << "Reader '#{responseObj[:readerRequested]}' is not supported."
                     return false
                 end
 
             end
 
             # return path to readers
-            def self.path_to_resources
+            def self.path_to_readers
                 File.dirname(File.expand_path(__FILE__))
             end
 
             # return reader readme text
             def self.get_reader_readme(reader)
                 readmeText = 'No readme found'
-                path = File.join(path_to_resources, reader, 'readme.md')
+                path = File.join(path_to_readers, reader, 'readme.md')
                 if File.exist?(path)
                     file = File.open(path, 'r')
                     readmeText = file.read

data/lib/adiwg/mdtranslator/version.rb

@@ -43,11 +43,25 @@
 #              --- 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.2.1"
+        VERSION = "1.3.0"
     end
 end
 

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

@@ -2,30 +2,33 @@
 
 # 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
 
 require 'builder'
-require 'adiwg/mdtranslator/writers/html/md_html_writer'
+require_relative 'version'
+require_relative 'md_html_writer'
 
 module ADIWG
     module Mdtranslator
         module Writers
             module Html
 
-                def self.startWriter(intObj)
+                def self.startWriter(intObj, responseObj, paramsObj)
 
                     # set the format of the output file based on the writer specified
-                    $response[:writerFormat] = 'html'
-                    $response[:writerVersion] = ADIWG::Mdtranslator::VERSION
+                    responseObj[:writerFormat] = 'html'
+                    responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Html::VERSION
 
                     # create new HTML document
                     html = Builder::XmlMarkup.new(indent: 3)
-                    metadataWriter = $WriterNS::MdHtmlWriter.new(html)
-                    metadata = metadataWriter.writeHtml(intObj)
+                    metadataWriter = MdHtmlWriter.new(html, intObj, paramsObj)
+                    metadata = metadataWriter.writeHtml()
 
                     # set writer pass to true if no messages
                     # false or warning will be set by code that places the message
-                    if $response[:writerMessages].length == 0
-                        $response[:writerPass] = true
+                    if responseObj[:writerMessages].length == 0
+                        responseObj[:writerPass] = true
                     end
 
                     return metadata

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

@@ -4,12 +4,11 @@
 # 	Stan Smith 2015-03-23 original script
 #   Stan Smith 2015-04-07 replaced instruct! with declare! and html to
 #      ... conform with w3 html encoding declarations
+#   Stan Smith 2015-06-23 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-16 refactored to remove global namespace $HtmlNS
 
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), './sections'))
-
-require 'html_head'
-require 'html_body'
+require_relative 'sections/html_head'
+require_relative 'sections/html_body'
 
 module ADIWG
     module Mdtranslator
@@ -17,37 +16,41 @@ module ADIWG
             module Html
 
                 class MdHtmlWriter
-                    def initialize(html)
+                    def initialize(html,intObj, paramsObj)
                         @html = html
+                        @@intObj = intObj
+                        @paramsObj = paramsObj
                     end
 
-                    def writeHtml(intObj)
-
-                        # set html section namespace
-                        $HtmlNS = ADIWG::Mdtranslator::Writers::Html
-
-                        # set contact array in a global
-                        $aContacts = intObj[:contacts]
+                    def writeHtml()
 
                         # classes used
-                        htmlHead = $HtmlNS::MdHtmlHead.new(@html)
-                        htmlBody = $HtmlNS::MdHtmlBody.new(@html)
+                        htmlHead = MdHtmlHead.new(@html, @paramsObj)
+                        htmlBody = MdHtmlBody.new(@html)
 
                         # page
                         metadata = @html.declare! :DOCTYPE, :html
                         @html.html(:lang=>'en') do
-                            @html.comment!('Report from mdTranslator HTML writer v1.0')
-
                             # head
                             htmlHead.writeHtml()
 
                             # body
-                            htmlBody.writeHtml(intObj)
+                            htmlBody.writeHtml(@@intObj)
                         end
 
                         return metadata
 
                     end
+
+                    def self.getContact(contactId)
+                        @@intObj[:contacts].each do |hCont|
+                            if hCont[:contactId] == contactId
+                                return hCont
+                            end
+                        end
+                        return nil
+                    end
+
                 end
 
             end