adiwg-mdtranslator 2.1.2 → 2.2.0

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

@@ -2,83 +2,104 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-30 original script
+#  Stan Smith 2017-08-30 refactored for mdJson schema 2.3
+#  Stan Smith 2016-10-30 original script
 
-module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Allocation
-
-                    def self.unpack(hAlloc, responseObj)
-
-                        # return nil object if input is empty
-                        if hAlloc.empty?
-                            responseObj[:readerExecutionMessages] << 'Allocation object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAlloc = intMetadataClass.newAllocation
-
-                        # allocation - amount (required)
-                        if hAlloc.has_key?('amount')
-                            intAlloc[:amount] = hAlloc['amount']
-                        end
-                        if intAlloc[:amount].nil? || intAlloc[:amount] == ''
-                            responseObj[:readerExecutionMessages] << 'Allocation attribute is missing amount'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # allocation - currency (required)
-                        if hAlloc.has_key?('currency')
-                            intAlloc[:currency] = hAlloc['currency']
-                        end
-                        if intAlloc[:currency].nil? || intAlloc[:currency] == ''
-                            responseObj[:readerExecutionMessages] << 'Allocation attribute is missing currency'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # allocation - source ID {contactId}
-                        if hAlloc.has_key?('sourceId')
-                            if hAlloc['sourceId'] != ''
-                                intAlloc[:sourceId] = hAlloc['sourceId']
-                            end
-                        end
-
-                        # allocation - recipient ID {contactId}
-                        if hAlloc.has_key?('recipientId')
-                            if hAlloc['recipientId'] != ''
-                                intAlloc[:recipientId] = hAlloc['recipientId']
-                            end
-                        end
-
-                        # allocation - matching {Boolean}
-                        if hAlloc.has_key?('matching')
-                            if hAlloc['matching'] === true
-                                intAlloc[:matching] = hAlloc['matching']
-                            end
-                        end
+require_relative 'module_onlineResource'
 
-                        # allocation - comment
-                        if hAlloc.has_key?('comment')
-                            if hAlloc['comment'] != ''
-                                intAlloc[:comment] = hAlloc['comment']
-                            end
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Allocation
+
+               def self.unpack(hAlloc, responseObj)
+
+                  # return nil object if input is empty
+                  if hAlloc.empty?
+                     responseObj[:readerExecutionMessages] << 'Allocation object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAlloc = intMetadataClass.newAllocation
+
+                  # allocation - id
+                  if hAlloc.has_key?('sourceAllocationId')
+                     if hAlloc['sourceAllocationId'] != ''
+                        intAlloc[:id] = hAlloc['sourceAllocationId']
+                     end
+                  end
+
+                  # allocation - amount (required)
+                  if hAlloc.has_key?('amount')
+                     intAlloc[:amount] = hAlloc['amount']
+                  end
+                  if intAlloc[:amount].nil? || intAlloc[:amount] == ''
+                     responseObj[:readerExecutionMessages] << 'Allocation attribute is missing amount'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # allocation - currency (required)
+                  if hAlloc.has_key?('currency')
+                     intAlloc[:currency] = hAlloc['currency']
+                  end
+                  if intAlloc[:currency].nil? || intAlloc[:currency] == ''
+                     responseObj[:readerExecutionMessages] << 'Allocation attribute is missing currency'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # allocation - source ID {contactId}
+                  if hAlloc.has_key?('sourceId')
+                     if hAlloc['sourceId'] != ''
+                        intAlloc[:sourceId] = hAlloc['sourceId']
+                     end
+                  end
+
+                  # allocation - recipient ID {contactId}
+                  if hAlloc.has_key?('recipientId')
+                     if hAlloc['recipientId'] != ''
+                        intAlloc[:recipientId] = hAlloc['recipientId']
+                     end
+                  end
+
+                  # allocation - matching {Boolean}
+                  if hAlloc.has_key?('matching')
+                     if hAlloc['matching'] === true
+                        intAlloc[:matching] = hAlloc['matching']
+                     end
+                  end
+
+                  # allocation - online resource [] {onlineResource}
+                  if hAlloc.has_key?('onlineResource')
+                     aOnlines = hAlloc['onlineResource']
+                     aOnlines.each do |hOnline|
+                        hReturn = OnlineResource.unpack(hOnline, responseObj)
+                        unless hReturn.nil?
+                           intAlloc[:onlineResources] << hReturn
                         end
+                     end
+                  end
 
-                        return intAlloc
+                  # allocation - comment
+                  if hAlloc.has_key?('comment')
+                     if hAlloc['comment'] != ''
+                        intAlloc[:comment] = hAlloc['comment']
+                     end
+                  end
 
-                    end
+                  return intAlloc
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,66 +2,72 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-30 original script
+#  Stan Smith 2017-08-30 refactored for mdJson schema 2.3
+#  Stan Smith 2016-10-30 original script
 
 require_relative 'module_allocation'
 require_relative 'module_timePeriod'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Funding
+            module Funding
 
-                    def self.unpack(hFunding, responseObj)
+               def self.unpack(hFunding, responseObj)
 
-                        # return nil object if input is empty
-                        if hFunding.empty?
-                            responseObj[:readerExecutionMessages] << 'Funding object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hFunding.empty?
+                     responseObj[:readerExecutionMessages] << 'Funding object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intFunding = intMetadataClass.newFunding
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intFunding = intMetadataClass.newFunding
 
-                        # funding - allocation []
-                        if hFunding.has_key?('allocation')
-                            aItems = hFunding['allocation']
-                            aItems.each do |item|
-                                hReturn = Allocation.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intFunding[:allocations] << hReturn
-                                end
-                            end
-                        end
+                  # funding - description
+                  if hFunding.has_key?('description')
+                     intFunding[:description] = hFunding['description']
+                  end
 
-                        # funding - timePeriod
-                        if hFunding.has_key?('timePeriod')
-                            hObject = hFunding['timePeriod']
-                            unless hObject.empty?
-                                hReturn = TimePeriod.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intFunding[:timePeriod] = hReturn
-                                end
-                            end
+                  # funding - timePeriod
+                  if hFunding.has_key?('timePeriod')
+                     hObject = hFunding['timePeriod']
+                     unless hObject.empty?
+                        hReturn = TimePeriod.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intFunding[:timePeriod] = hReturn
                         end
+                     end
+                  end
 
-                        if intFunding[:allocations].empty? && intFunding[:timePeriod].empty?
-                            responseObj[:readerExecutionMessages] << 'Funding must have either an allocation or timePeriod'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # funding - allocation []
+                  if hFunding.has_key?('allocation')
+                     aItems = hFunding['allocation']
+                     aItems.each do |item|
+                        hReturn = Allocation.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intFunding[:allocations] << hReturn
                         end
+                     end
+                  end
 
-                        return intFunding
+                  if intFunding[:allocations].empty? && intFunding[:timePeriod].empty?
+                     responseObj[:readerExecutionMessages] << 'Funding must have either an allocation or timePeriod'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intFunding
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,10 +2,11 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-15 refactored for mdJson 2.0
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#  Stan Smith 2017-08-30 added support for process step sources
+#  Stan Smith 2016-10-15 refactored for mdJson 2.0
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 # 	Stan Smith 2013-11-26 original script
 
 require_relative 'module_timePeriod'
@@ -14,100 +15,122 @@ require_relative 'module_citation'
 require_relative 'module_scope'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ProcessStep
-
-                    def self.unpack(hProcStep, responseObj)
-
-                        # return nil object if input is empty
-                        if hProcStep.empty?
-                            responseObj[:readerExecutionMessages] << 'Process Step object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intProcStep = intMetadataClass.newProcessStep
-
-                        # process step - step ID
-                        if hProcStep.has_key?('stepId')
-                            if hProcStep['stepId'] != ''
-                                intProcStep[:stepId] = hProcStep['stepId']
-                            end
-                        end
-
-                        # process step - description - required
-                        if hProcStep.has_key?('description')
-                            intProcStep[:description] = hProcStep['description']
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ProcessStep
+
+               def self.unpack(hProcStep, responseObj)
+
+                  # return nil object if input is empty
+                  if hProcStep.empty?
+                     responseObj[:readerExecutionMessages] << 'Process Step object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intProcStep = intMetadataClass.newProcessStep
+
+                  # process step - step ID
+                  if hProcStep.has_key?('stepId')
+                     if hProcStep['stepId'] != ''
+                        intProcStep[:stepId] = hProcStep['stepId']
+                     end
+                  end
+
+                  # process step - description - required
+                  if hProcStep.has_key?('description')
+                     intProcStep[:description] = hProcStep['description']
+                  end
+                  if intProcStep[:description].nil? || intProcStep[:description] == ''
+                     responseObj[:readerExecutionMessages] << 'Process Step attribute description is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # process step - rationale
+                  if hProcStep.has_key?('rationale')
+                     if hProcStep['rationale'] != ''
+                        intProcStep[:rationale] = hProcStep['rationale']
+                     end
+                  end
+
+                  # process step - time period
+                  if hProcStep.has_key?('timePeriod')
+                     hObject = hProcStep['timePeriod']
+                     unless hObject.empty?
+                        hReturn = TimePeriod.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intProcStep[:timePeriod] = hReturn
                         end
-                        if intProcStep[:description].nil? || intProcStep[:description] == ''
-                            responseObj[:readerExecutionMessages] << 'Process Step attribute description is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # process step - step processors [responsible party]
+                  if hProcStep.has_key?('processor')
+                     aProc = hProcStep['processor']
+                     aProc.each do |item|
+                        hParty = ResponsibleParty.unpack(item, responseObj)
+                        unless hParty.nil?
+                           intProcStep[:processors] << hParty
                         end
-
-                        # process step - rationale
-                        if hProcStep.has_key?('rationale')
-                            if hProcStep['rationale'] != ''
-                                intProcStep[:rationale] = hProcStep['rationale']
-                            end
-                        end
-
-                        # process step - time period
-                        if hProcStep.has_key?('timePeriod')
-                            hObject = hProcStep['timePeriod']
-                            unless hObject.empty?
-                                hReturn = TimePeriod.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intProcStep[:timePeriod] = hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # process step - reference [citation]
+                  if hProcStep.has_key?('reference')
+                     aReference = hProcStep['reference']
+                     aReference.each do |item|
+                        hReference = Citation.unpack(item, responseObj)
+                        unless hReference.nil?
+                           intProcStep[:references] << hReference
                         end
-
-                        # process step - step processors [responsible party]
-                        if hProcStep.has_key?('processor')
-                            aProc = hProcStep['processor']
-                            aProc.each do |item|
-                                hParty = ResponsibleParty.unpack(item, responseObj)
-                                unless hParty.nil?
-                                    intProcStep[:processors] << hParty
-                                end
-                            end
+                     end
+                  end
+
+                  # process step - step sources [source]
+                  if hProcStep.has_key?('stepSource')
+                     aSources = hProcStep['stepSource']
+                     aSources.each do |item|
+                        hSource = Source.unpack(item, responseObj)
+                        unless hSource.nil?
+                           intProcStep[:stepSources] << hSource
                         end
-
-                        # process step - reference [citation]
-                        if hProcStep.has_key?('reference')
-                            aReference = hProcStep['reference']
-                            aReference.each do |item|
-                                hReference = Citation.unpack(item, responseObj)
-                                unless hReference.nil?
-                                    intProcStep[:references] << hReference
-                                end
-                            end
+                     end
+                  end
+
+                  # process step - step products [source]
+                  if hProcStep.has_key?('stepProduct')
+                     aSources = hProcStep['stepProduct']
+                     aSources.each do |item|
+                        hSource = Source.unpack(item, responseObj)
+                        unless hSource.nil?
+                           intProcStep[:stepProducts] << hSource
                         end
-
-                        # process step - scope {scope}
-                        if hProcStep.has_key?('scope')
-                            hObject = hProcStep['scope']
-                            unless hObject.empty?
-                                hReturn = Scope.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intProcStep[:scope] = hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # process step - scope {scope}
+                  if hProcStep.has_key?('scope')
+                     hObject = hProcStep['scope']
+                     unless hObject.empty?
+                        hReturn = Scope.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intProcStep[:scope] = hReturn
                         end
+                     end
+                  end
 
-                        return intProcStep
+                  return intProcStep
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_sbJson.rb

@@ -6,6 +6,7 @@
 #  Josh Bradley original script
 
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative '../version'
 require_relative 'module_titles'
 require_relative 'module_id'
 require_relative 'module_body'
@@ -52,7 +53,7 @@ module ADIWG
 
                   # schema
                   hSchema[:name] = 'sbJson'
-                  hSchema[:version] = '0.0.0'
+                  hSchema[:version] = ADIWG::Mdtranslator::Readers::SbJson::VERSION
 
                   # titles / alternateTitles
                   Title.unpack(hSbJson, hCitation, hResponseObj)

data/lib/adiwg/mdtranslator/version.rb

@@ -1,6 +1,7 @@
 # adiwg mdTranslator
 
 # version 2 history
+# 2.2.0 2017-08-31 refactor for schema changes to Lineage and Funding
 # 2.1.2 2017-08-24 remove schema version from sbJson
 # 2.1.0 2017-08-10 revisions to sbJson reader
 # 2.0.0 2017-06-28 added sbJson reader
@@ -23,7 +24,7 @@
 module ADIWG
    module Mdtranslator
       # current mdtranslator version
-      VERSION = "2.1.2"
+      VERSION = "2.2.0"
    end
 end
 

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

@@ -2,8 +2,11 @@
 # allocation
 
 # History:
+#  Stan Smith 2017-08-31 refactored for mdJson 2.3 schema update
 #  Stan Smith 2017-04-04 original script
 
+require_relative 'html_onlineResource'
+
 module ADIWG
    module Mdtranslator
       module Writers
@@ -17,6 +20,16 @@ module ADIWG
 
                def writeHtml(hAllocation)
 
+                  # classes used
+                  onlineClass = Html_OnlineResource.new(@html)
+
+                  # allocation - id
+                  unless hAllocation[:id].nil?
+                     @html.em('Source Allocation ID: ')
+                     @html.text!(hAllocation[:id])
+                     @html.br
+                  end
+
                   # allocation - amount
                   unless hAllocation[:amount].nil?
                      @html.em('Amount: ')
@@ -54,6 +67,16 @@ module ADIWG
                      @html.br
                   end
 
+                  # allocation - online resource []
+                  hAllocation[:onlineResources].each do |hOnline|
+                     @html.details do
+                        @html.summary('Online Resource', {'class' => 'h5'})
+                        @html.section(:class => 'block') do
+                           onlineClass.writeHtml(hOnline)
+                        end
+                     end
+                  end
+
                   # allocation - comment
                   unless hAllocation[:comment].nil?
                      @html.em('Comment: ')

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

@@ -2,6 +2,7 @@
 # funding
 
 # History:
+#  Stan Smith 2017-08-31 refactored for mdJson 2.3 schema update
 #  Stan Smith 2017-04-04 original script
 
 require_relative 'html_allocation'
@@ -24,6 +25,14 @@ module ADIWG
                   allocationClass = Html_Allocation.new(@html)
                   temporalClass = Html_TemporalExtent.new(@html)
 
+                  # funding - description
+                  unless hFunding[:description].nil?
+                     @html.em('Description:')
+                     @html.section(:class => 'block') do
+                        @html.text!(hFunding[:description])
+                     end
+                  end
+
                   # funding - timePeriod {timePeriod}
                   unless hFunding[:timePeriod].empty?
                      temporalObj = {}