adiwg-mdtranslator 2.0.0rc11 → 2.0.0rc13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbce410a9f43321f9019509cb844144ff5ca950b
-  data.tar.gz: b9576143da46802dda31de1d03b0f56c6049c3b1
+  metadata.gz: e6dae2d4d0b4f056465097adf48a786332a8e1ac
+  data.tar.gz: 4d120c45abcf7459c45271c4e4a626e4bc2aa426
 SHA512:
-  metadata.gz: c9c62887d1941434a579619e3bed5a691c77652e87280e7e667d2683ae6d6a0cdab75caba2af26e824c50e1ab906e89b3625ee089e2ec75858ea300dddd5ac5e
-  data.tar.gz: aeb48e161931209ec8a077d1509ea8072eebd0e95727dd2f0ab3a45be0a9f67626563428983135f05732937453e838f712b1be5d0dbbabd8a339e92d7a1e87a5
+  metadata.gz: 59a2afd957514a20c5d2497d6627a08516dcfb40df807fb9fcbd6039263bb83ec512717b141abfe43153b91fe4430877e360964bdcdb51c82e195826c9017941
+  data.tar.gz: 1e080a421fad0efb0139437922a021d5b7402c252ed2dda1ca3fbd0695eed882309c2f345a4170e015606142689a17364914b1784df99c7ccce3610568412c4f

data/.travis.yml

@@ -3,7 +3,6 @@ sudo: false
 language: ruby
 before_install: 'gem install bundler'
 rvm:
-  - 2.1
   - 2.2
   - "2.3.3"
   - "2.4.0"

data/Rakefile

@@ -5,6 +5,7 @@ Rake::TestTask.new do |t|
 	t.libs << 'test'
 	t.test_files = FileList[
 		'test/readers/mdJson/tc*.rb',
+		'test/readers/sbJson/tc*.rb',
 		'test/writers/iso19115-2/tc*.rb',
 		'test/writers/iso19110/tc*.rb',
 		'test/writers/mdJson/tc*.rb',

data/adiwg-mdtranslator.gemspec

@@ -36,5 +36,7 @@ Gem::Specification.new do |spec|
    spec.add_runtime_dependency "adiwg-mdjson_schemas", ">= 2.2"
    spec.add_runtime_dependency "adiwg-mdcodes", "~> 2.1"
    spec.add_runtime_dependency "jbuilder", "~> 2.5"
+   spec.add_runtime_dependency "kramdown", "~> 1.13"
+   spec.add_runtime_dependency "coderay", "~> 1.1"
 
 end

data/lib/adiwg/mdtranslator/internal/module_dateTimeFun.rb

@@ -140,23 +140,37 @@ module AdiwgDateTimeFun
         return sDuration
     end
 
-   def self.stringFromDateObject(obj)
-
-      date = obj[:date]
-      if date.nil?
-         date = obj[:dateTime]
-      end
-      dateRes = obj[:dateResolution]
-      unless date.nil?
-         case dateRes
-            when 'Y', 'YM', 'YMD'
-               dateStr = stringDateFromDateTime(date, dateRes)
-            else
-               dateStr = stringDateTimeFromDateTime(date, dateRes)
-         end
-      end
-
-      return dateStr
-   end
+    def self.stringDateFromDateObject(obj)
+
+       date = obj[:date]
+       if date.nil?
+          date = obj[:dateTime]
+       end
+       dateRes = obj[:dateResolution]
+       unless date.nil?
+          dateStr = stringDateFromDateTime(date, dateRes)
+       end
+       return dateStr
+
+    end
+
+    def self.stringDateTimeFromDateObject(obj)
+
+       date = obj[:date]
+       if date.nil?
+          date = obj[:dateTime]
+       end
+       dateRes = obj[:dateResolution]
+       unless date.nil?
+          case dateRes
+             when 'Y', 'YM', 'YMD'
+                dateStr = stringDateFromDateTime(date, dateRes)
+             else
+                dateStr = stringDateTimeFromDateTime(date, dateRes)
+          end
+       end
+
+       return dateStr
+    end
 
 end

data/lib/adiwg/mdtranslator/readers/mdJson/mdJson_reader.rb

@@ -1,20 +1,20 @@
 # mdJson reader - process and direct mdJson ingest to internal data structure
 
 # History:
-#   Stan Smith 2016-11-12 refactor for mdTranslator 2.0
-#   Stan Smith 2016-10-09 modify 'findContact' to also return contact index and type
-#   Stan Smith 2016-10-07 refactored 'readerModule' to remove mdJson version checking
-#   Stan Smith 2015-07-14 added support for mdJson version numbers
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
-#   Stan Smith 2015-06-12 added method to lookup contact in contact array
-#   Stan Smith 2014-12-11 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-12-03 changed class name to MdJsonReader from AdiwgJsonReader
-#   Stan Smith 2014-12-01 add data dictionary
-#   Stan Smith 2014-08-18 add json name/version to internal object
-#   Stan Smith 2014-07-08 moved json schema version testing to 'adiwg_1_get_version'
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
-#   Stan Smith 2014-06-05 capture an test json version
+#  Stan Smith 2016-11-12 refactor for mdTranslator 2.0
+#  Stan Smith 2016-10-09 modify 'findContact' to also return contact index and type
+#  Stan Smith 2016-10-07 refactored 'readerModule' to remove mdJson version checking
+#  Stan Smith 2015-07-14 added support for mdJson version numbers
+#  Stan Smith 2015-07-14 refactored to remove global namespace constants
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (hResponseObj)
+#  Stan Smith 2015-06-12 added method to lookup contact in contact array
+#  Stan Smith 2014-12-11 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-12-03 changed class name to MdJsonReader from AdiwgJsonReader
+#  Stan Smith 2014-12-01 add data dictionary
+#  Stan Smith 2014-08-18 add json name/version to internal object
+#  Stan Smith 2014-07-08 moved json schema version testing to 'adiwg_1_get_version'
+#  Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#  Stan Smith 2014-06-05 capture an test json version
 #	Stan Smith 2014-04-23 add json schema version to internal object
 # 	Stan Smith 2013-08-23 split out metadata to module_metadata
 # 	Stan Smith 2013-08-19 split out contacts to module_contacts
@@ -26,97 +26,97 @@ require_relative 'version'
 require_relative 'modules/module_mdJson'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                def self.readFile(file, hResponseObj)
+            def self.readFile(file, hResponseObj)
 
-                    # parse mdJson file
-                    begin
-                        hMdJson = JSON.parse(file)
-                    rescue JSON::JSONError => err
-                        hResponseObj[:readerStructureMessages] << 'Parsing mdJson Failed - see following message(s):\n'
-                        hResponseObj[:readerStructureMessages] << err.to_s.slice(0,300)
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
+               # parse mdJson file
+               begin
+                  hMdJson = JSON.parse(file)
+               rescue JSON::JSONError => err
+                  hResponseObj[:readerStructureMessages] << 'Parsing mdJson Failed - see following message(s):\n'
+                  hResponseObj[:readerStructureMessages] << err.to_s.slice(0, 300)
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
 
-                    # file must contain an mdJson object
-                    if hMdJson.empty?
-                        hResponseObj[:readerStructureMessages] << 'mdJson object is empty'
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
+               # file must contain an mdJson object
+               if hMdJson.empty?
+                  hResponseObj[:readerStructureMessages] << 'mdJson object is empty'
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
 
-                    # schema - (required)
-                    unless hMdJson.has_key?('schema')
-                        hResponseObj[:readerStructureMessages] << 'mdJson is missing schema object'
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
+               # schema - (required)
+               unless hMdJson.has_key?('schema')
+                  hResponseObj[:readerStructureMessages] << 'mdJson is missing schema object'
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
 
-                    # schema - name (required) (must = 'mdJson')
-                    unless hMdJson['schema'].has_key?('name')
-                        hResponseObj[:readerStructureMessages] << 'mdJson schema:name attribute is missing'
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
-                    schemaName = hMdJson['schema']['name']
-                    if schemaName.nil? || schemaName == ''
-                        hResponseObj[:readerStructureMessages] << 'mdJson schema name is missing'
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
-                    unless schemaName.downcase == 'mdjson'
-                        hResponseObj[:readerStructureMessages] << "mdJson schema name is '#{schemaName}', should be mdJson"
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
+               # schema - name (required) (must = 'mdJson')
+               unless hMdJson['schema'].has_key?('name')
+                  hResponseObj[:readerStructureMessages] << 'mdJson schema:name attribute is missing'
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
+               schemaName = hMdJson['schema']['name']
+               if schemaName.nil? || schemaName == ''
+                  hResponseObj[:readerStructureMessages] << 'mdJson schema name is missing'
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
+               unless schemaName.downcase == 'mdjson'
+                  hResponseObj[:readerStructureMessages] << "mdJson schema name is '#{schemaName}', should be mdJson"
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
 
-                    # schema - version (required)
-                    unless hMdJson['schema'].has_key?('version')
-                        hResponseObj[:readerStructureMessages] << 'mdJson schema:version attribute is missing'
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
-                    requestedVersion = hMdJson['schema']['version']
-                    if requestedVersion.nil? || requestedVersion == ''
-                        hResponseObj[:readerStructureMessages] << 'mdJson schema version is missing'
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
+               # schema - version (required)
+               unless hMdJson['schema'].has_key?('version')
+                  hResponseObj[:readerStructureMessages] << 'mdJson schema:version attribute is missing'
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
+               requestedVersion = hMdJson['schema']['version']
+               if requestedVersion.nil? || requestedVersion == ''
+                  hResponseObj[:readerStructureMessages] << 'mdJson schema version is missing'
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
 
-                    # schema - 2.0.0 =< requested version =< current version
-                    currentVersion = ADIWG::Mdtranslator::Readers::MdJson::VERSION
-                    hResponseObj[:readerVersionRequested] = requestedVersion
-                    hResponseObj[:readerVersionUsed] = currentVersion
-                    aCurVersion = currentVersion.split('.')
-                    aReqVersion = requestedVersion.split('.')
-                    approved = false
-                    if aReqVersion[0] == aCurVersion[0]
-                        if aReqVersion[1] <= aCurVersion[1]
-                            approved = true
-                        end
-                    end
-                    unless approved
-                        hResponseObj[:readerStructureMessages] << "mdJson schema version '#{requestedVersion}' is not supported"
-                        hResponseObj[:readerStructurePass] = false
-                        return {}
-                    end
+               # schema - 2.0.0 =< requested version =< current version
+               currentVersion = ADIWG::Mdtranslator::Readers::MdJson::VERSION
+               hResponseObj[:readerVersionRequested] = requestedVersion
+               hResponseObj[:readerVersionUsed] = currentVersion
+               aCurVersion = currentVersion.split('.')
+               aReqVersion = requestedVersion.split('.')
+               approved = false
+               if aReqVersion[0] == aCurVersion[0]
+                  if aReqVersion[1] <= aCurVersion[1]
+                     approved = true
+                  end
+               end
+               unless approved
+                  hResponseObj[:readerStructureMessages] << "mdJson schema version '#{requestedVersion}' is not supported"
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
 
-                    # validate file against mdJson schema definition
-                    validate(hMdJson, hResponseObj)
-                    unless hResponseObj[:readerValidationPass]
-                        return {}
-                    end
+               # validate file against mdJson schema definition
+               validate(hMdJson, hResponseObj)
+               unless hResponseObj[:readerValidationPass]
+                  return {}
+               end
 
-                    # unpack the mdJson into the internal object
-                    return MdJson.unpack(hMdJson, hResponseObj)
-
-                end
+               # unpack the mdJson into the internal object
+               return MdJson.unpack(hMdJson, hResponseObj)
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/mdJson_validator.rb

@@ -17,43 +17,43 @@ require 'json-schema'
 require 'adiwg-mdjson_schemas'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                # validate json against the adiwg-json_schemas
-                # only a single schema version is supported at this time
-                def self.validate(file, responseObj)
-
-                    bStrict = false
-                    if responseObj[:readerValidationLevel] == 'strict'
-                        bStrict = true
-                    end
-                    ADIWG::MdjsonSchemas::Utils.load_schemas(false)
-
-                    begin
-                        aErrors = []
-                        aErrors = JSON::Validator.fully_validate('schema.json', file, :strict=>bStrict)
-
-                        if aErrors.length > 0
-                            responseObj[:readerValidationPass] = false
-                            responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
-                            responseObj[:readerValidationMessages] << aErrors
-                            return
-                        end
-
-                    rescue JSON::Schema::ValidationError
-                        responseObj[:readerValidationPass] = false
-                        responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
-                        responseObj[:readerValidationMessages] << $!.message
-                        return
-                    end
-
-                end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            # validate json against the adiwg-json_schemas
+            # only a single schema version is supported at this time
+            def self.validate(file, responseObj)
+
+               bStrict = false
+               if responseObj[:readerValidationLevel] == 'strict'
+                  bStrict = true
+               end
+               ADIWG::MdjsonSchemas::Utils.load_schemas(false)
+
+               begin
+                  aErrors = []
+                  aErrors = JSON::Validator.fully_validate('schema.json', file, :strict => bStrict)
+
+                  if aErrors.length > 0
+                     responseObj[:readerValidationPass] = false
+                     responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
+                     responseObj[:readerValidationMessages] << aErrors
+                     return
+                  end
+
+               rescue JSON::Schema::ValidationError
+                  responseObj[:readerValidationPass] = false
+                  responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
+                  responseObj[:readerValidationMessages] << $!.message
+                  return
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end
 
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_mdJson.rb

@@ -12,125 +12,122 @@ require_relative 'module_dataDictionary'
 require_relative 'module_metadataRepository'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                    def self.unpack(hMdJson, responseObj)
+            module MdJson
 
-                        # return nil object if input is empty
-                        if hMdJson.empty?
-                            responseObj[:readerExecutionMessages] << 'mdJson object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+               def self.unpack(hMdJson, responseObj)
+
+                  # return nil object if input is empty
+                  if hMdJson.empty?
+                     responseObj[:readerExecutionMessages] << 'mdJson object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intObj = intMetadataClass.newBase
+
+                  # mdJson - schema {schema} (required)
+                  if hMdJson.has_key?('schema')
+                     hObject = hMdJson['schema']
+                     unless hObject.empty?
+                        hReturn = Schema.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intObj[:schema] = hReturn
                         end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intObj = intMetadataClass.newBase
-
-                        # mdJson - schema {schema} (required)
-                        if hMdJson.has_key?('schema')
-                            hObject = hMdJson['schema']
-                            unless hObject.empty?
-                                hReturn = Schema.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intObj[:schema] = hReturn
-                                end
-                            end
+                     end
+                  end
+                  if intObj[:schema].empty?
+                     responseObj[:readerExecutionMessages] << 'mdJson object is missing schema'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # mdJson - contact [] {contact} (required)
+                  if hMdJson.has_key?('contact')
+                     aItems = hMdJson['contact']
+                     aItems.each do |item|
+                        hReturn = Contact.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intObj[:contacts] << hReturn
+                           @contacts = intObj[:contacts]
                         end
-                        if intObj[:schema].empty?
-                            responseObj[:readerExecutionMessages] << 'mdJson object is missing schema'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+                  if intObj[:contacts].empty?
+                     responseObj[:readerExecutionMessages] << 'mdJson object is missing contact'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # mdJson - metadata {metadata}
+                  if hMdJson.has_key?('metadata')
+                     hObject = hMdJson['metadata']
+                     unless hObject.empty?
+                        hReturn = Metadata.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intObj[:metadata] = hReturn
                         end
-
-                        # mdJson - contact [] {contact} (required)
-                        if hMdJson.has_key?('contact')
-                            aItems = hMdJson['contact']
-                            aItems.each do |item|
-                                hReturn = Contact.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intObj[:contacts] << hReturn
-                                    @contacts = intObj[:contacts]
-                                end
-                            end
+                     end
+                  end
+
+                  # mdJson - data dictionary [] {dataDictionary}
+                  if hMdJson.has_key?('dataDictionary')
+                     aItems = hMdJson['dataDictionary']
+                     aItems.each do |hItem|
+                        hReturn = DataDictionary.unpack(hItem, responseObj)
+                        unless hReturn.nil?
+                           intObj[:dataDictionaries] << hReturn
                         end
-                        if intObj[:contacts].empty?
-                            responseObj[:readerExecutionMessages] << 'mdJson object is missing contact'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # metadata - metadata distribution [] {metadataDistribution}
+                  if hMdJson.has_key?('metadataRepository')
+                     aItems = hMdJson['metadataRepository']
+                     aItems.each do |item|
+                        hReturn = MetadataRepository.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intObj[:metadataRepositories] << hReturn
                         end
+                     end
+                  end
 
-                        # mdJson - metadata {metadata}
-                        if hMdJson.has_key?('metadata')
-                            hObject = hMdJson['metadata']
-                            unless hObject.empty?
-                                hReturn = Metadata.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intObj[:metadata] = hReturn
-                                end
-                            end
-                        end
+                  return intObj
 
-                        # mdJson - data dictionary [] {dataDictionary}
-                        if hMdJson.has_key?('dataDictionary')
-                            aItems = hMdJson['dataDictionary']
-                            aItems.each do |hItem|
-                                hReturn = DataDictionary.unpack(hItem, responseObj)
-                                unless hReturn.nil?
-                                    intObj[:dataDictionaries] << hReturn
-                                end
-                            end
-                        end
+               end
 
-                        # metadata - metadata distribution [] {metadataDistribution}
-                        if hMdJson.has_key?('metadataRepository')
-                            aItems = hMdJson['metadataRepository']
-                            aItems.each do |item|
-                                hReturn = MetadataRepository.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intObj[:metadataRepositories] << hReturn
-                                end
-                            end
-                        end
+               # find the array pointer and type for a contact
+               def self.findContact(contactId)
 
-                        return intObj
-
-                    end
-
-                    # find the array pointer and type for a contact
-                    def self.findContact(contactId)
-
-                        contactIndex = nil
-                        contactType = nil
-                        i = 0
-                        @contacts.each do |contact|
-                            if contact[:contactId] == contactId
-                                contactIndex = i
-                                if contact[:isOrganization]
-                                    contactType = 'organization'
-                                else
-                                    contactType = 'individual'
-                                end
-                            end
-                            i += 1
+                  contactIndex = nil
+                  contactType = nil
+                  @contacts.each_with_index do |contact, i|
+                     if contact[:contactId] == contactId
+                        contactIndex = i
+                        if contact[:isOrganization]
+                           contactType = 'organization'
+                        else
+                           contactType = 'individual'
                         end
+                     end
+                  end
+                  return contactIndex, contactType
 
-                        return contactIndex, contactType
-
-                    end
+               end
 
-                    # set contacts array for reader test modules
-                    def self.setContacts(contacts)
-                        @contacts = contacts
-                    end
-
-                end
+               # set contacts array for reader test modules
+               def self.setContacts(contacts)
+                  @contacts = contacts
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end