adiwg-mdtranslator 2.12.0 → 2.13.0

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_vouchers.rb

@@ -2,62 +2,65 @@
 # 19115-2 writer output in XML
 
 # History:
-#   Stan Smith 2016-12-09 refactored for mdTranslator/mdJson 2.0
-#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
-#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
-#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#  Stan Smith 2018-04-10 add error and warning messaging
+#  Stan Smith 2016-12-09 refactored for mdTranslator/mdJson 2.0
+#  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
+#  Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
+#  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
 # 	Stan Smith 2013-11-19 original script
 
+require_relative '../iso19115_2_writer'
 require_relative 'class_responsibleParty'
 
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module Iso19115_2
-
-                class MD_Vouchers
-
-                    def initialize(xml, hResponseObj)
-                        @xml = xml
-                        @hResponseObj = hResponseObj
-                    end
-
-                    def writeXML(hVoucher)
-
-                        # classes used in MD_Vouchers
-                        partyClass =  CI_ResponsibleParty.new(@xml, @hResponseObj)
-
-                        @xml.tag!('gmd:MD_Vouchers') do
-
-                            # voucher - specimen (required)
-                            s = hVoucher[:specimen]
-                            if s.nil?
-                                @xml.tag!('gmd:specimen', {'gco:nilReason' => 'missing'})
-                            else
-                                @xml.tag!('gmd:specimen') do
-                                    @xml.tag!('gco:CharacterString', s)
-                                end
-                            end
-
-                            # voucher - repository (required) {MD_ResponsibleParty}
-                            hRParty = hVoucher[:repository]
-                            if hRParty.empty?
-                                @xml.tag!('gmd:reposit', {'gco:nilReason' => 'missing'})
-                            else
-                                role = hRParty[:roleName]
-                                hParty = hRParty[:parties][0]
-                                @xml.tag!('gmd:reposit') do
-                                    partyClass.writeXML(role, hParty)
-                                end
-                            end
-
-                        end # gmd:MD_Vouchers tag
-                    end # writeXML
-                end # MD_Vouchers class
-
-            end
-        end
-    end
+   module Mdtranslator
+      module Writers
+         module Iso19115_2
+
+            class MD_Vouchers
+
+               def initialize(xml, hResponseObj)
+                  @xml = xml
+                  @hResponseObj = hResponseObj
+                  @NameSpace = ADIWG::Mdtranslator::Writers::Iso19115_2
+               end
+
+               def writeXML(hVoucher)
+
+                  # classes used in MD_Vouchers
+                  partyClass = CI_ResponsibleParty.new(@xml, @hResponseObj)
+
+                  @xml.tag!('gmd:MD_Vouchers') do
+
+                     # voucher - specimen (required)
+                     s = hVoucher[:specimen]
+                     if s.nil?
+                        @NameSpace.issueWarning(340, 'gmd:specimen')
+                     else
+                        @xml.tag!('gmd:specimen') do
+                           @xml.tag!('gco:CharacterString', s)
+                        end
+                     end
+
+                     # voucher - repository (required) {MD_ResponsibleParty}
+                     hRParty = hVoucher[:repository]
+                     if hRParty.empty?
+                        @NameSpace.issueWarning(341, 'gmd:specimen')
+                     else
+                        role = hRParty[:roleName]
+                        hParty = hRParty[:parties][0]
+                        @xml.tag!('gmd:reposit') do
+                           partyClass.writeXML(role, hParty, 'taxonomic voucher repository')
+                        end
+                     end
+
+                  end # gmd:MD_Vouchers tag
+               end # writeXML
+            end # MD_Vouchers class
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/writers/iso19115_2/iso19115_2_writer.rb

@@ -1,15 +1,16 @@
 # Writer - internal data structure to ISO 19115-2:2009
 
 # History:
-#   Stan Smith 2016-11-14 refactor for mdJson/mdTranslator 2.0
-#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
-#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
-#   Stan Smith 2015-06-11 change all codelists to use 'class_codelist' method
-#   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
-#   Stan Smith 2014-06-04 add internal object pre-scan to create extents
-#   ... for geometry supplemental information
+#  Stan Smith 2018-04-09 add error/warning/notice message methods
+#  Stan Smith 2016-11-14 refactor for mdJson/mdTranslator 2.0
+#  Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
+#  Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
+#  Stan Smith 2015-06-11 change all codelists to use 'class_codelist' method
+#  Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
+#  Stan Smith 2014-06-04 add internal object pre-scan to create extents
+#  ... for geometry supplemental information
 # 	Stan Smith 2013-08-10 original script
 
 require 'builder'
@@ -25,16 +26,22 @@ module ADIWG
 
                # make contact available to the instance
                @contacts = intObj[:contacts]
+               @hResponseObj = hResponseObj
+
+               # load error message array
+               file = File.join(File.dirname(__FILE__), 'iso19115_2_writer_messages_eng') + '.yml'
+               hMessageList = YAML.load_file(file)
+               @aMessagesList = hMessageList['messageList']
 
                # set the format of the output file based on the writer specified
                hResponseObj[:writerOutputFormat] = 'xml'
                hResponseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Iso19115_2::VERSION
 
                # create new XML document
-               xml = Builder::XmlMarkup.new(indent: 3)
+               @xml = Builder::XmlMarkup.new(indent: 3)
 
                # start writing the ISO 19115-2 XML record
-               metadataWriter = MI_Metadata.new(xml, hResponseObj)
+               metadataWriter = MI_Metadata.new(@xml, hResponseObj)
                metadata = metadataWriter.writeXML(intObj)
 
                return metadata
@@ -53,6 +60,49 @@ module ADIWG
 
             end
 
+            def self.findMessage(messageId)
+               @aMessagesList.each do |hMessage|
+                  if hMessage['id'] == messageId
+                     return hMessage['message']
+                  end
+               end
+               return nil
+            end
+
+            def self.issueError(messageId, context = nil)
+               message = findMessage(messageId)
+               unless message.nil?
+                  message += ': CONTEXT is ' + context unless context.nil?
+                  @hResponseObj[:writerMessages] << 'ERROR: ISO-19115-2 writer: ' + message
+                  @hResponseObj[:writerPass] = false
+               end
+            end
+
+            def self.issueWarning(messageId, tag = nil, context = nil)
+               message = findMessage(messageId)
+               unless message.nil?
+                  message += ': CONTEXT is ' + context unless context.nil?
+                  if @hResponseObj[:writerForceValid]
+                     if tag.nil?
+                        issueError(messageId, context)
+                     else
+                        @xml.tag!(tag, {'gco:nilReason' => 'missing'})
+                        @hResponseObj[:writerMessages] << 'WARNING: ISO-19115-2 writer: ' + message
+                     end
+                  else
+                     @hResponseObj[:writerMessages] << 'WARNING: ISO-19115-2 writer: ' + message
+                  end
+               end
+            end
+
+            def self.issueNotice(messageId, context = nil)
+               message = findMessage(messageId)
+               unless message.nil?
+                  message += ': CONTEXT is ' + context unless context.nil?
+                  @hResponseObj[:writerMessages] << 'NOTICE: ISO-19115-2 writer: ' + message
+               end
+            end
+
          end
       end
    end

data/lib/adiwg/mdtranslator/writers/iso19115_2/iso19115_2_writer_messages_eng.yml

@@ -0,0 +1,109 @@
+# Writer - messages for ISO 19115-2:2003
+
+# History:
+#  Stan Smith 2018-04-09 original script
+
+messageList:
+   - {id: 1, message: "associated resource association type is missing"}
+
+   - {id: 10, message: "bounding box west longitude is missing"}
+   - {id: 11, message: "bounding box east longitude is missing"}
+   - {id: 12, message: "bounding box south latitude is missing"}
+   - {id: 13, message: "bounding box north latitude is missing"}
+
+   - {id: 20, message: "browse graphic file name is missing"}
+
+   - {id: 30, message: "citation title is missing"}
+   - {id: 31, message: "citation dates are missing"}
+
+   - {id: 40, message: "coverage attribute description is missing"}
+   - {id: 41, message: "coverage content type is missing"}
+
+   - {id: 50, message: "resource citation is missing"}
+   - {id: 51, message: "resource abstract is missing"}
+   - {id: 52, message: "resource point of contact is missing"}
+
+   - {id: 60, message: "data quality scope is missing"}
+
+   - {id: 70, message: "date is missing"}
+   - {id: 71, message: "date type is missing"}
+
+   - {id: 80, message: "dimension type is missing"}
+   - {id: 81, message: "dimension size is missing"}
+
+   - {id: 90, message: "distributor contact is missing"}
+
+   - {id: 100, message: "extension extended element name is missing"}
+   - {id: 101, message: "extension extended element definition is missing"}
+   - {id: 102, message: "extension extended element entity type is missing"}
+   - {id: 103, message: "extension extended element parent entity is missing"}
+   - {id: 104, message: "extension extended element rule is missing"}
+   - {id: 105, message: "extension extended element source is missing"}
+
+   - {id: 110, message: "GeoJSON geometry object type is not recognized"}
+
+   - {id: 120, message: "format name is missing"}
+   - {id: 121, message: "format version is missing"}
+
+   - {id: 130, message: "spatial resolution representative fraction denominator is missing"}
+
+   - {id: 140, message: "GeoJSON geometry is not supported by feature"}
+
+   - {id: 150, message: "vector object type is missing"}
+
+   - {id: 160, message: "GeoJSON geometry is not supported by geometry collection"}
+
+   - {id: 170, message: "georectified corner points are missing"}
+   - {id: 171, message: "georectified point in pixel is missing"}
+
+   - {id: 180, message: "georeferenced parameter is missing"}
+
+   - {id: 190, message: "grid representation number of dimensions is missing"}
+   - {id: 191, message: "grid representation dimensions are missing"}
+   - {id: 192, message: "grid representation cell geometry is missing"}
+
+   - {id: 200, message: "keyword section keywords are missing"}
+
+   - {id: 210, message: "locale language code is missing"}
+   - {id: 211, message: "locale character encoding is missing"}
+
+   - {id: 220, message: "maintenance update frequency is missing"}
+
+   - {id: 230, message: "identifier code is missing"}
+
+   - {id: 240, message: "metadata contacts are missing"}
+   - {id: 241, message: "data identification section (resourceInfo) missing"}
+
+   - {id: 250, message: "online resource URL is missing"}
+
+   - {id: 260, message: "process step description is missing"}
+
+   - {id: 270, message: "responsible party role is missing"}
+
+   - {id: 280, message: "scope level (code) is missing"}
+
+   - {id: 290, message: "security constraint classification is missing"}
+
+   - {id: 300, message: "taxonomic level is missing"}
+   - {id: 301, message: "taxonomic name is missing"}
+
+   - {id: 310, message: "taxonomic classification system is missing"}
+   - {id: 311, message: "taxonomic identification reference is missing"}
+   - {id: 312, message: "taxonomic observer is missing"}
+   - {id: 313, message: "taxonomic procedures are missing"}
+   - {id: 314, message: "taxonomic classification is missing"}
+
+   - {id: 320, message: "resource specific usage is missing"}
+   - {id: 321, message: "resource specific usage contact is missing"}
+
+   - {id: 330, message: "vertical extent minimum is missing"}
+   - {id: 331, message: "vertical extent maximum is missing"}
+   - {id: 332, message: "vertical extent coordinate reference system is missing"}
+
+   - {id: 340, message: "taxonomic voucher specimen is missing"}
+   - {id: 341, message: "taxonomic voucher repository is missing"}
+
+   - {id: 350, message: "attribute sequence identifier is missing"}
+   - {id: 351, message: "attribute sequence identifier type is missing"}
+
+   - {id: 360, message: "measure type is invalid; must be one of [distance, length, angle, measure, scale]"}

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

@@ -1,5 +1,6 @@
 # iso19115-2 version history
-#  Stan Smith 2.1.0 2017-11-13 added support for spatial reference, geologic time, others
+#  2.2.0 2018-04-09 add error and warning messaging
+#  2.1.0 2017-11-13 added support for spatial reference, geologic time, others
 
 module ADIWG
    module Mdtranslator
@@ -7,7 +8,7 @@ module ADIWG
          module Iso19115_2
 
             # current version of html writer
-            VERSION = '2.1.0'
+            VERSION = '2.2.0'
 
          end
       end

data/lib/adiwg/mdtranslator_cli.rb

@@ -2,6 +2,7 @@
 # ADIwg mdTranslator - Thor CLI for mdtranslator
 
 # History:
+#  Stan Smith 2018-05-04 add support for reader execution messages
 #  Stan Smith 2018-04-07 add 'fgdc' option to reader and writer enum list
 #  Stan Smith 2018-02-26 add 'forceValid' parameter
 #  Stan Smith 2017-04-21 removed inline CSS option
@@ -71,6 +72,7 @@ and to choose the level of validation for mdJson input files.
       # puts 'writer: ' + options[:writer]
       # puts 'validation level: ' + options[:validate]
       # puts 'showAllTags: ' + options[:showAllTags].to_s
+      # puts 'forceValid: ' + options[:forceValid].to_s
       # puts 'message format: ' + options[:messages]
       # puts 'return object: ' + options[:returnObject].to_s
       # puts 'css link: ' + options[:cssLink]
@@ -87,7 +89,7 @@ and to choose the level of validation for mdJson input files.
          cssLink: options[:cssLink])
 
       # determine return content and type of return ...
-      if mdReturn[:readerStructurePass] && mdReturn[:readerValidationPass]
+      if mdReturn[:readerStructurePass] && mdReturn[:readerValidationPass] && mdReturn[:readerExecutionPass]
 
          # no problem was found with the input file
          if options[:writer].nil?
@@ -124,7 +126,7 @@ and to choose the level of validation for mdJson input files.
                   # build a string with messages issues from parser and validator
                   s = ''
                   s += "Failed\n"
-                  s += "Writer failed to generate output or issued significant warnings\n"
+                  s += "Writer failed to generate output or issued ERROR OR WARNING messages \n"
                   s += "See following messages for further information\n"
 
                   # post structure messages
@@ -153,10 +155,10 @@ and to choose the level of validation for mdJson input files.
             $stdout.write mdReturn.to_json
             return
          else
-            # build a string with messages issues from parser and validator
+            # build a string with messages issues from parser, validator, or reader
             s = ''
             s += "Failed\n"
-            s += "Input failed to pass either file structure validation or content does not match schema\n"
+            s += "Input failed to pass either file structure, validation, or content requirements\n"
             s += "See following messages for further information\n"
 
             # post structure messages
@@ -187,6 +189,21 @@ and to choose the level of validation for mdJson input files.
                end
             end
 
+            # post reader execution messages
+            unless mdReturn[:readerExecutionPass].nil?
+               if mdReturn[:readerExecutionPass]
+                  s += "Success - Reader execution successful\n"
+               else
+                  s += "Fail - Reader execution failed - see following message(s):\n"
+                  i = 0
+                  mdReturn[:readerExecutionMessages].each do |message|
+                     i += 1
+                     s += "\nMessage: #{i}\n"
+                     s += message.to_s + "\n"
+                  end
+               end
+            end
+
             $stdout.write s
             return
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adiwg-mdtranslator
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Stan Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.8
+        version: 2.4.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.8
+        version: 2.4.9
 - !ruby/object:Gem::Dependency
   name: adiwg-mdcodes
   requirement: !ruby/object:Gem::Requirement
@@ -625,7 +625,7 @@ files:
 - lib/adiwg/mdtranslator/writers/iso19110/version.rb
 - lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_address.rb
 - lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_aggregateInformation.rb
-- lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_attributeGroup.rb
+- lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_attribute.rb
 - lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_baseUnit.rb
 - lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_boundingBox.rb
 - lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_browseGraphic.rb
@@ -712,6 +712,7 @@ files:
 - lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_verticalExtent.rb
 - lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_vouchers.rb
 - lib/adiwg/mdtranslator/writers/iso19115_2/iso19115_2_writer.rb
+- lib/adiwg/mdtranslator/writers/iso19115_2/iso19115_2_writer_messages_eng.yml
 - lib/adiwg/mdtranslator/writers/iso19115_2/readme.md
 - lib/adiwg/mdtranslator/writers/iso19115_2/version.rb
 - lib/adiwg/mdtranslator/writers/mdJson/mdJson_writer.rb