adiwg-mdtranslator 0.10.2 → 0.12.0

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

@@ -9,90 +9,90 @@ require 'date'
 
 module AdiwgDateTimeFun
 
-	def self.dateTimeFromString(inDateTime)
-		hFormats = {'YMDhmsLZ'=> '%Y-%m-%dT%H:%M:%S.%L%z',
-					'YMDhmsL'=> '%Y-%m-%dT%H:%M:%S.%L',
-					'YMDhmsZ'=> '%Y-%m-%dT%H:%M:%S%z',
-					'YMDhms'=> '%Y-%m-%dT%H:%M:%S',
-					'YMDhmZ'=> '%Y-%m-%dT%H:%M%z',
-					'YMDhm'=> '%Y-%m-%dT%H:%M',
-					'YMDhZ'=> '%Y-%m-%dT%H%z',
-					'YMDh'=> '%Y-%m-%dT%H',
-					'YMD'=> '%Y-%m-%d',
-					'YM'=> '%Y-%m',
-					'Y'=> '%Y'}
-		hFormats.each do |dateResolution, format|
-			myDateTime = DateTime.strptime(inDateTime,format) rescue false
-			return myDateTime, dateResolution if myDateTime
-		end
+    def self.dateTimeFromString(inDateTime)
+        hFormats = {'YMDhmsLZ' => '%Y-%m-%dT%H:%M:%S.%L%z',
+                    'YMDhmsL' => '%Y-%m-%dT%H:%M:%S.%L',
+                    'YMDhmsZ' => '%Y-%m-%dT%H:%M:%S%z',
+                    'YMDhms' => '%Y-%m-%dT%H:%M:%S',
+                    'YMDhmZ' => '%Y-%m-%dT%H:%M%z',
+                    'YMDhm' => '%Y-%m-%dT%H:%M',
+                    'YMDhZ' => '%Y-%m-%dT%H%z',
+                    'YMDh' => '%Y-%m-%dT%H',
+                    'YMD' => '%Y-%m-%d',
+                    'YM' => '%Y-%m',
+                    'Y' => '%Y'}
+        hFormats.each do |dateResolution, format|
+            myDateTime = DateTime.strptime(inDateTime, format) rescue false
+            return myDateTime, dateResolution if myDateTime
+        end
 
-		return nil, 'ERROR'
-	end
+        return nil, 'ERROR'
+    end
 
-	def self.stringDateFromDateTime(myDateTime,dateResolution)
-		s = case dateResolution
-				when 'YMDhmsLZ','YMDhmsL','YMDhmsZ', 'YMDhms',
-					'YMDhmZ', 'YMDhm', 'YMDhZ', 'YMDh','YMD'
-					myDateTime.strftime('%Y-%m-%d')
-				when 'YM'
-					myDateTime.strftime('%Y-%m')
-				when 'Y'
-					myDateTime.strftime('%Y')
-				else
-					'ERROR'
-			end
+    def self.stringDateFromDateTime(myDateTime, dateResolution)
+        s = case dateResolution
+                when 'YMDhmsLZ', 'YMDhmsL', 'YMDhmsZ', 'YMDhms',
+                    'YMDhmZ', 'YMDhm', 'YMDhZ', 'YMDh', 'YMD'
+                    myDateTime.strftime('%Y-%m-%d')
+                when 'YM'
+                    myDateTime.strftime('%Y-%m')
+                when 'Y'
+                    myDateTime.strftime('%Y')
+                else
+                    'ERROR'
+            end
 
-		return s
-	end
+        return s
+    end
 
-	def self.stringDateTimeFromDateTime(myDateTime,dateResolution)
-		s = case dateResolution
-				when 'YMDhmsLZ'
-					myDateTime.strftime('%Y-%m-%dT%H:%M:%S.%L%:z')
-				when 'YMDhmsL'
-					myDateTime.strftime('%Y-%m-%dT%H:%M:%S.%L')
-				when 'YMDhmsZ'
-					myDateTime.strftime('%Y-%m-%dT%H:%M:%S%:z')
-				when 'YMDhms', 'YMD', 'YM', 'Y'
-					myDateTime.strftime('%Y-%m-%dT%H:%M:%S')
-				when 'YMDhmZ'
-					myDateTime.strftime('%Y-%m-%dT%H:%M%:z')
-				when 'YMDhm'
-					myDateTime.strftime('%Y-%m-%dT%H:%M')
-				when 'YMDhZ'
-					myDateTime.strftime('%Y-%m-%dT%H%:z')
-				when 'YMDh'
-					myDateTime.strftime('%Y-%m-%dT%H')
-				else
-					'ERROR'
-			end
+    def self.stringDateTimeFromDateTime(myDateTime, dateResolution)
+        s = case dateResolution
+                when 'YMDhmsLZ'
+                    myDateTime.strftime('%Y-%m-%dT%H:%M:%S.%L%:z')
+                when 'YMDhmsL'
+                    myDateTime.strftime('%Y-%m-%dT%H:%M:%S.%L')
+                when 'YMDhmsZ'
+                    myDateTime.strftime('%Y-%m-%dT%H:%M:%S%:z')
+                when 'YMDhms', 'YMD', 'YM', 'Y'
+                    myDateTime.strftime('%Y-%m-%dT%H:%M:%S')
+                when 'YMDhmZ'
+                    myDateTime.strftime('%Y-%m-%dT%H:%M%:z')
+                when 'YMDhm'
+                    myDateTime.strftime('%Y-%m-%dT%H:%M')
+                when 'YMDhZ'
+                    myDateTime.strftime('%Y-%m-%dT%H%:z')
+                when 'YMDh'
+                    myDateTime.strftime('%Y-%m-%dT%H')
+                else
+                    'ERROR'
+            end
 
-		return s
-	end
+        return s
+    end
 
-	def self.stringTimeFromDateTime(myDateTime,dateResolution)
-		s = case dateResolution
-				when 'YMDhmsLZ'
-					myDateTime.strftime('%H:%M:%S.%L%:z')
-				when 'YMDhmsL'
-					myDateTime.strftime('%H:%M:%S.%L')
-				when 'YMDhmsZ'
-					myDateTime.strftime('%H:%M:%S%:z')
-				when 'YMDhms'
-					myDateTime.strftime('%H:%M:%S')
-				when 'YMDhmZ'
-					myDateTime.strftime('%H:%M%:z')
-				when 'YMDhm'
-					myDateTime.strftime('%H:%M')
-				when 'YMDhZ'
-					myDateTime.strftime('%H%:z')
-				when 'YMDh'
-					myDateTime.strftime('%H')
-				else
-					'ERROR'
-			end
+    def self.stringTimeFromDateTime(myDateTime, dateResolution)
+        s = case dateResolution
+                when 'YMDhmsLZ'
+                    myDateTime.strftime('%H:%M:%S.%L%:z')
+                when 'YMDhmsL'
+                    myDateTime.strftime('%H:%M:%S.%L')
+                when 'YMDhmsZ'
+                    myDateTime.strftime('%H:%M:%S%:z')
+                when 'YMDhms'
+                    myDateTime.strftime('%H:%M:%S')
+                when 'YMDhmZ'
+                    myDateTime.strftime('%H:%M%:z')
+                when 'YMDhm'
+                    myDateTime.strftime('%H:%M')
+                when 'YMDhZ'
+                    myDateTime.strftime('%H%:z')
+                when 'YMDh'
+                    myDateTime.strftime('%H')
+                else
+                    'ERROR'
+            end
 
-		return s
-	end
+        return s
+    end
 
 end

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

@@ -11,79 +11,158 @@
 #   Stan Smith 2014-08-18 add json name/version to internal object
 #   Stan Smith 2014-12-01 add data dictionary
 #   Stan Smith 2014-12-03 changed class name to MdJsonReader from AdiwgJsonReader
+#   Stan Smith 2014-12-11 refactored to handle namespacing readers and writers
 
 require 'json'
-require ADIWG::Mdtranslator.reader_module('module_contacts', $response[:readerVersionUsed])
-require ADIWG::Mdtranslator.reader_module('module_metadata', $response[:readerVersionUsed])
-require ADIWG::Mdtranslator.reader_module('module_dataDictionary', $response[:readerVersionUsed])
-
-class MdJsonReader
-
-	def initialize
-	end
-
-	def unpack(jsonObj)
-
-		# instance classes needed in script
-		intMetadataClass = InternalMetadata.new
-
-		# create new internal metadata container for the reader
-		intBase = intMetadataClass.newBase
-
-		# convert the received JSON to a Ruby hash
-		hashObj = JSON.parse(jsonObj)
-
-		# get json schema name and version
-		if hashObj.has_key?('version')
-			hVersion = hashObj['version']
-		    unless hVersion.empty?
-				if hVersion.has_key?('name')
-					s = hVersion['name']
-					if !s.nil?
-						intBase[:jsonVersion][:name] = s
-					end
-				end
-				if hVersion.has_key?('version')
-					s = hVersion['version']
-					if !s.nil?
-						intBase[:jsonVersion][:version] = s
-					end
-				end
-			end
-		end
-
-		# contact
-		# load the array of contacts from the json object
-		# ... the contacts array uses a local id to reference the
-		# ... contact in the array from elsewhere in the json metadata
-		if hashObj.has_key?('contact')
-			aContacts = hashObj['contact']
-			aContacts.each do |hContact|
-				unless hContact.empty?
-					intBase[:contacts] << Md_Contact.unpack(hContact)
-				end
-			end
-		end
-
-		# add default contacts
-		intBase[:contacts].concat(Md_Contact.setDefaultContacts)
-
-		# metadata
-		# load metadata from the hash object
-		if hashObj.has_key?('metadata')
-			hMetadata = hashObj['metadata']
-			intBase[:metadata] = Md_Metadata.unpack(hMetadata)
-		end
-
-		# data dictionary
-		if hashObj.has_key?('dataDictionary')
-			hDictionary = hashObj['dataDictionary']
-			intBase[:dataDictionary] = Md_DataDictionary.unpack(hDictionary)
-		end
-
-		# return ADIwg internal container
-		return intBase
-
-	end
-
-end
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                # set reader namespace
+                $ReaderNS = ADIWG::Mdtranslator::Readers::MdJson
+
+                def self.readFile(file)
+                    # set anticipated format of file in $response
+                    $response[:readerFormat] = 'json'
+
+                    # receive json file into ruby hash
+                    parseJson(file)
+                    if !$response[:readerStructurePass]
+                        return false
+                    end
+
+                    # check mdJson version name
+                    checkVersionName
+                    if !$response[:readerStructurePass]
+                        return false
+                    end
+
+                    # check mdJson version number
+                    checkVersionNumber
+                    if !$response[:readerStructurePass]
+                        return false
+                    end
+
+                    # validate file against mdJson schema definition
+                    require 'adiwg/mdtranslator/readers/mdJson/mdJson_validator'
+                    $ReaderNS.validate(file)
+                    if !$response[:readerValidationPass]
+                        return false
+                    end
+
+                    # unpack mdJson file
+                    require readerModule('module_mdJson')
+                    intObj = $ReaderNS.unpack(@hMdJson)
+                    return intObj
+
+                end
+
+                def self.parseJson(file)
+                    # validate the input file structure
+                    # test for valid json syntax by attempting to parse the file
+                    begin
+                        @hMdJson = JSON.parse(file)
+                        $response[:readerStructurePass] = true
+                    rescue JSON::JSONError => err
+                        $response[:readerStructurePass] = false
+                        $response[:readerStructureMessages] << err
+                        return
+                    end
+                end
+
+                def self.checkVersionName
+                    # find version name on the input json file
+                    if @hMdJson.has_key?('version')
+                        hVersion = @hMdJson['version']
+                    else
+                        $response[:readerStructurePass] = false
+                        $response[:readerStructureMessages] << 'The input file is missing the version:{} block.'
+                        return
+                    end
+
+                    # check the version name
+                    if hVersion.has_key?('name')
+                        s = hVersion['name']
+                        if !s.nil?
+                            $response[:readerFound] = s
+                        else
+                            $response[:readerStructurePass] = false
+                            $response[:readerStructureMessages] << 'The input file version name is missing.'
+                            return
+                        end
+                    else
+                        $response[:readerStructurePass] = false
+                        $response[:readerStructureMessages] << "The input file version:{} block is missing the 'name' attribute."
+                        return
+                    end
+
+                    # check the version name is 'mdJson'
+                    if s != 'mdJson'
+                        $response[:readerStructurePass] = false
+                        $response[:readerStructureMessages] << "The mdTranslator reader expected the input file version name to be 'mdJson'."
+                        $response[:readerStructureMessages] << "Version name found was: '#{s}'."
+                        return
+                    end
+                end
+
+                def self.checkVersionNumber
+                    # find version number on the input json file
+                    hVersion = @hMdJson['version']
+                    if hVersion.has_key?('version')
+                        s = hVersion['version']
+                        if !s.nil?
+                            $response[:readerVersionFound] = s
+                        end
+                    else
+                        $response[:readerStructurePass] = false
+                        $response[:readerStructureMessages] << "The input file version:{} block is missing the 'version' number attribute."
+                        return
+                    end
+
+                    # test the reader version requested is supported
+                    # remove maintenance release number first
+                    # ... then look for a module folder name ending with the requested version
+                    # ... example: 'modules_1.2'
+                    aVersionParts = s.split('.')
+                    if aVersionParts.length >= 2
+                        readerVersion = aVersionParts[0] +'.' + aVersionParts[1]
+                        dir = File.join(File.dirname(__FILE__), 'modules_' + readerVersion)
+                        if !File.directory?(dir)
+                            $response[:readerStructurePass] = false
+                            $response[:readerStructureMessages] << 'The input file version is not supported.'
+                            $response[:readerStructureMessages] << "mdJson version requested was '#{s}'"
+                            return
+                        end
+                        $response[:readerVersionUsed] = readerVersion
+                    else
+                        $response[:readerStructurePass] = false
+                        $response[:readerStructureMessages] << 'The input file version number must be in the form MAJOR.MINOR.PATCH, e.g. 1.2.3'
+                        $response[:readerStructureMessages] << 'Note the PATCH number is optional.'
+                        return
+                    end
+                end
+
+                # require modules for the requested version
+                def self.readerModule(moduleName)
+                    dir = File.join(File.dirname(__FILE__), 'modules_' + $response[:readerVersionUsed])
+                    file = File.join(dir, moduleName)
+
+                    # test for the existance of the module in the current mdJson version directory
+                    if !File.exist?(File.join(dir, moduleName + '.rb'))
+                        # file not found
+                        # ... look for module in previous version directory
+                        # ... note: no previous version directories exist yet
+
+                        # no prior version directory found
+                        # ... file not found
+                        return nil
+                    end
+                    return file
+                end
+
+            end
+        end
+    end
+end

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

@@ -7,117 +7,50 @@
 #   Stan Smith 2014-09-26 added processing of minor release numbers
 #   Stan Smith 2014-12-01 changed adiwgJson to mdJson in version name check
 #   Stan Smith 2014-12-03 changed class name to MdJsonValidation from AdiwgJsonValidation
+#   Stan Smith 2014-12-11 added namespace
 
 require 'json'
 require 'json-schema'
 require 'adiwg-json_schemas'
-#json-schema patch
-require 'validator.rb'
+# temporary json-schema patch
+# waiting for rubygem json-schema patch
+require 'adiwg/mdtranslator/readers/mdJson/validator.rb'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                # validate json against the adiwg-json_schemas
+                # only one schema version is supported at this time
+                def self.validate(file)
+                    begin
+
+                        schema = ADIWG::JsonSchemas::Utils.schema_path
+                        aValErrs = Array.new
+                        if $response[:readerValidationLevel] == 'strict'
+                            aValErrs = JSON::Validator.fully_validate(schema, file, :strict => true, :errors_as_objects => true)
+                        elsif $response[:readerValidationLevel] == 'normal'
+                            aValErrs = JSON::Validator.fully_validate(schema, file, :errors_as_objects => true)
+                        end
+
+                        if aValErrs.length > 0
+                            $response[:readerValidationPass] = false
+                            $response[:readerValidationMessages] = aValErrs
+                            return
+                        end
+                    rescue JSON::Schema::ValidationError
+                        $response[:readerValidationPass] = false
+                        $response[:readerValidationMessages] << $!.message
+                        return
+                    end
+
+                    $response[:readerValidationPass] = true
+                end
+
+            end
+        end
+    end
+end
 
-module MdJsonValidation
 
-	def self.validate(file)
-
-		# set the anticipated format of the input file based on the reader specified
-		$response[:readerFormat] = 'json'
-
-		# validate the input file structure
-		# test for valid json syntax by attempting to parse the file
-		begin
-			hashObj = JSON.parse(file)
-			$response[:readerStructurePass] = true
-		rescue JSON::JSONError => err
-			$response[:readerStructurePass] = false
-			$response[:readerStructureMessages] << err
-			return
-		end
-
-		# find name and version of input json file
-		if hashObj.has_key?('version')
-			hVersion = hashObj['version']
-		else
-			$response[:readerStructurePass] = false
-			$response[:readerStructureMessages] << 'input file is missing the version:{} block'
-			return
-		end
-
-		# get the version name
-		if hVersion.has_key?('name')
-			s = hVersion['name']
-			if !s.nil?
-				$response[:readerFound] = s
-				if s != 'mdJson'
-					$response[:readerStructurePass] = false
-					$response[:readerStructureMessages] << "input file version name must be 'mdJson'"
-					$response[:readerStructureMessages] << "found version name '#{s}'"
-					return
-				end
-			end
-		else
-			$response[:readerStructurePass] = false
-			$response[:readerStructureMessages] << "input file version:{} block is missing the 'name' attribute"
-			return
-		end
-
-		# get version number
-		if hVersion.has_key?('version')
-			requestReaderVersion = hVersion['version']
-			$response[:readerVersionFound] = requestReaderVersion
-			# test if reader version is supported
-			# remove minor release number
-			# ...and look for a module folder name ending with the requested version
-			# ...example: 'modules_1.2.0'
-			if !requestReaderVersion.nil?
-				aVersionParts = requestReaderVersion.split('.')
-				if 3 == aVersionParts.length
-					readerVersion = aVersionParts[0] +'.' + aVersionParts[1] + '.0'
-					dir = File.join(File.dirname(__FILE__),'modules_' + readerVersion)
-					if !File.directory?(dir)
-						$response[:readerStructurePass] = false
-						$response[:readerStructureMessages] << 'input file version is not supported'
-						$response[:readerStructureMessages] << "mdJson version requested was '#{requestReaderVersion}'"
-						return
-					end
-					$response[:readerVersionUsed] = readerVersion
-				else
-					$response[:readerStructurePass] = false
-					$response[:readerStructureMessages] << "input file version must be in the form MAJOR.MINOR.PATCH, e.g. 1.2.3"
-					return
-				end
-			end
-		else
-			$response[:readerStructurePass] = false
-			$response[:readerStructureMessages] << "input file version:{} block is missing the 'version' attribute"
-			return
-		end
-
-		# validate json against the adiwg-json_schemas
-		# only one schema version is supported at this time
-		begin
-
-			schema = ADIWG::JsonSchemas::Utils.schema_path
-			aValErrs = Array.new
-			if $response[:readerValidationLevel] == 'strict'
-				aValErrs = JSON::Validator.fully_validate(schema, file, :strict => true, :errors_as_objects => true)
-			elsif $response[:readerValidationLevel] == 'normal'
-				aValErrs = JSON::Validator.fully_validate(schema, file, :errors_as_objects => true)
-			end
-
-			if aValErrs.length > 0
-				$response[:readerValidationPass] = false
-				$response[:readerValidationMessages] = aValErrs
-				return
-			end
-
-		rescue JSON::Schema::ValidationError
-			$response[:readerValidationPass] = false
-			$response[:readerValidationMessages] << $!.message
-			return
-		end
-
-		$response[:readerValidationPass] = true
-		return
-
-	end
-
-end