adiwg-mdtranslator 2.20.0.pre.beta.5 → 2.21.0.pre.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d8a5f731fb5ada7138ee650206ed3a6f81d36ffcbbb52fece5f13befb9bcce
-  data.tar.gz: a2023846f039cdfe3dde6f851f13ad463afd36644e9a5a460c2d6416e644c450
+  metadata.gz: 24a46249aaab639bcbfcf96546503546a9474db0aaf8d3d9136190cbd7ae2c19
+  data.tar.gz: da85309bcd6c126043a653d5e436535d7d29c4eb2107a416acb1cdc4575d3696
 SHA512:
-  metadata.gz: d297c28d28dc4f19840b476ba86fb6e89b36d106019a20f7ceedd58b9f36f27e8006eb8c49dcc0de935b060557e25466f7d3deeef8f3de6d05bc7ea981f189d0
-  data.tar.gz: 8093a1f20c10929bb69aa9635a6b7f1e2532300f8db5f6761e025651fde5a0ea1ca9b89d8e2111eb8d5da1b98db995f6ca66e50e49fbbfc95ec3d6cfd72027e5
+  metadata.gz: 966ff66ba5977d8f190b38535637cf43b0d346291ed81928179814b8bbb081a2967d56bba02f80847525e0f86fce8c0e1d405d71fbd7dcf1338c7cc5e2c2a31c
+  data.tar.gz: ae9ec9bd0c85646c0b7b99d79adda40be5ea40de1bb14eb133471028a3b9800b86138591abf2e1c87d6c3bc8e5e07741a66f816755558823cdc76697d30b9845

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
         with:
           ruby-version: "3.1" # Not needed with a .ruby-version file
       - run: bundle install

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    adiwg-mdtranslator (2.20.0.pre.beta.0)
+    adiwg-mdtranslator (2.21.0.pre.beta.0)
       adiwg-mdcodes (= 2.10.0)
-      adiwg-mdjson_schemas (= 2.9.5)
+      adiwg-mdjson_schemas (= 2.10.0.pre.beta.5)
       builder (~> 3.2)
       coderay (~> 1.1)
       jbuilder (~> 2.5)
@@ -37,7 +37,7 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     adiwg-mdcodes (2.10.0)
       json (~> 2.0)
-    adiwg-mdjson_schemas (2.9.5)
+    adiwg-mdjson_schemas (2.10.0.pre.beta.5)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     builder (3.2.4)

data/README.md

@@ -23,27 +23,6 @@ Or install it yourself as:
 
     $ mdtranslator help translate
 
-## Development
-
-### Requirements
-
-Requires
-- [Ruby](https://www.ruby-lang.org/en/documentation/installation/)
-- bundler (`gem install bundler`)
-- rake (`gem install rake`)
-
-### Tests
-
-In order to run the tests, first install the dependencies
-
-    $ bundle install
-
-Then, run the rake command
-
-    $ bundle exec rake
-
-_TODO: There are currently 4 tests that are not passing, related to mdJSON readers and writers_
-
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/mdTranslator/fork )

data/Rakefile

@@ -23,7 +23,6 @@ Rake::TestTask.new do |t|
       'test/writers/iso19115-3/tc*.rb',
       'test/writers/mdJson/tc*.rb',
       'test/writers/sbJson/tc*.rb',
-      'test/writers/dcat_us/tc*.rb',
       'test/translator/tc*.rb'
    ]
    t.verbose = true

data/adiwg-mdtranslator.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
    spec.add_runtime_dependency "thor", "~> 0.19"
    spec.add_runtime_dependency "uuidtools", "~> 2.1"
    spec.add_runtime_dependency "json-schema", "~> 2.7"
-   spec.add_runtime_dependency "adiwg-mdjson_schemas", "2.9.5"
+   spec.add_runtime_dependency "adiwg-mdjson_schemas", "2.10.0.pre.beta.5"
    spec.add_runtime_dependency "adiwg-mdcodes", "2.10.0"
    spec.add_runtime_dependency "jbuilder", "~> 2.5"
    spec.add_runtime_dependency "kramdown", ">= 1.13", "< 3.0"

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

@@ -143,7 +143,8 @@ class InternalMetadata
          associatedResources: [],
          additionalDocuments: [],
          funding: [],
-         dataQuality: []
+         dataQuality: [],
+         acquisitions: []
       }
    end
 
@@ -158,6 +159,7 @@ class InternalMetadata
    # acquisition ----------------------------
    def newAcquisition
       {
+         scope: {},
          plans: [],
          requirements: [],
          objectives: [],
@@ -175,19 +177,23 @@ class InternalMetadata
          averageAirTemperature: nil,
          maxRelativeHumidity: nil,
          maxAltitude: nil,
-         meteorologicalConditions: nil
+         meteorologicalConditions: nil,
+         solarAzimuth: nil,
+         solarElevation: nil
+         
       }
    end
 
    def newEvent
       {
          eventId: nil,
+         identifier: {},
          trigger: nil,
          context: nil,
          sequence: nil,
          dateTime: nil,
          expectedObjectives: [],
-         relatedPass: nil,
+         relatedPass: {},
          relatedSensors: []
       }
    end
@@ -199,7 +205,29 @@ class InternalMetadata
          identifier: {},
          instrumentType: nil,
          description: nil,
-         mountedOn: nil
+         mountedOn: {},
+         histories: [],
+         hostId: {}
+      }
+   end
+
+   def newInstrumentationEvent
+      {
+         citations: [],
+         description: nil,
+         extent: {},
+         eventType: nil,
+         revisionHistories: [],
+      }
+   end
+
+   def newInstrumentationEventList
+      {
+         citation: {},
+         description: nil,
+         locale: {},
+         constraints: [],
+         instrumentationEvents: []
       }
    end
 
@@ -240,14 +268,15 @@ class InternalMetadata
    def newOperation
       {
          operationId: nil,
+         description: nil,
          citation: {},
          identifier: {},
          status: nil,
          operationType: nil,
          objectives: [],
-         parentOperations: nil,
+         parentOperation: {},
          childOperations: [],
-         plan: nil,
+         plan: {},
          platforms: [],
          significantEvents: []
       }
@@ -267,6 +296,14 @@ class InternalMetadata
       }
    end
 
+   def newRevision
+      {
+         description: nil,
+         responsibleParty: {},
+         dateInfo: []
+      }
+   end
+
    def newPlatform
       {
          platformId: nil,
@@ -274,7 +311,8 @@ class InternalMetadata
          identifier: {},
          description: nil,
          sponsors: [],
-         instruments: []
+         instruments: [],
+         history: []
       }
    end
 

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

@@ -0,0 +1,133 @@
+require_relative 'module_scope'
+require_relative 'module_objective'
+require_relative 'module_requirement'
+require_relative 'module_platform'
+require_relative 'module_instrument'
+require_relative 'module_operation'
+require_relative 'module_pass'
+require_relative 'module_event'
+require_relative 'module_environment'
+require_relative 'module_plan'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module MdJson
+ 
+            module Acquisition
+ 
+               def self.unpack(hAcquisition, responseObj, inContext = nil)
+ 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                  outContext = 'acquisition'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAcquisition = intMetadataClass.newAcquisition
+ 
+                  if hAcquisition.has_key?('scope')
+                     unless hAcquisition['scope'].empty?
+                        hReturn = Scope.unpack(hAcquisition['scope'], responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:scope] = hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('plan')
+                     aItems = hAcquisition['plan']
+                     aItems.each do |item|
+                        hReturn = Plan.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:plans] << hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('requirement')
+                     aItems = hAcquisition['requirement']
+                     aItems.each do |item|
+                        hReturn = Requirement.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:requirements] << hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('objective')
+                     aItems = hAcquisition['objective']
+                     aItems.each do |item|
+                        hReturn = Objective.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:objectives] << hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('platform')
+                     aItems = hAcquisition['platform']
+                     aItems.each do |item|
+                        hReturn = Platform.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:platforms] << hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('instrument')
+                     aItems = hAcquisition['instrument']
+                     aItems.each do |item|
+                        hReturn = Instrument.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:instruments] << hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('operation')
+                     aItems = hAcquisition['operation']
+                     aItems.each do |item|
+                        hReturn = Operation.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:operations] << hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('event')
+                     aItems = hAcquisition['event']
+                     aItems.each do |item|
+                        hReturn = Event.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:events] << hReturn
+                        end
+                     end
+                  end
+
+                  if hAcquisition.has_key?('pass')
+                     aItems = hAcquisition['pass']
+                     aItems.each do |item|
+                        hReturn = Pass.unpack(item, responseObj, outContext)
+                        unless hReturn.nil?
+                           intAcquisition[:passes] << hReturn
+                        end
+                     end
+                  end
+                  
+                  if hAcquisition.has_key?('environment')
+                     intAcquisition[:environment] = Environment.unpack(hAcquisition['environment'], responseObj, outContext)
+                  end
+                  
+                  return intAcquisition
+
+               end
+
+            end
+ 
+         end
+      end
+   end
+end
+ 

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

@@ -0,0 +1,47 @@
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+  
+                module Environment
+                    def self.unpack(hEnvironment, responseObj, inContext = nil)
+
+                        intMetadataClass = InternalMetadata.new
+                        intEnvironment = intMetadataClass.newEnvironment
+
+                        outContext = 'environment'
+                        outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                        if hEnvironment.has_key?('averageAirTemperature')
+                            intEnvironment[:averageAirTemperature] = hEnvironment['averageAirTemperature']
+                        end
+
+                        if hEnvironment.has_key?('maxRelativeHumidity')
+                            intEnvironment[:maxRelativeHumidity] = hEnvironment['maxRelativeHumidity']
+                        end
+
+                        if hEnvironment.has_key?('maxAltitude')
+                            intEnvironment[:maxAltitude] = hEnvironment['maxAltitude']
+                        end
+
+                        if hEnvironment.has_key?('meteorologicalConditions')
+                            intEnvironment[:meteorologicalConditions] = hEnvironment['meteorologicalConditions']
+                        end
+
+                        if hEnvironment.has_key?('solarAzimuth')
+                            intEnvironment[:solarAzimuth] = hEnvironment['solarAzimuth']
+                        end
+
+                        if hEnvironment.has_key?('solarElevation')
+                            intEnvironment[:solarElevation] = hEnvironment['solarElevation']
+                        end
+
+                        intEnvironment
+
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,88 @@
+require_relative 'module_identifier'
+require_relative 'module_dateTime'
+require_relative 'module_objective'
+require_relative 'module_pass'
+require_relative 'module_instrument'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+  
+                module Event
+                    def self.unpack(hEvent, responseObj, inContext = nil)
+                        @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                        intMetadataClass = InternalMetadata.new
+                        intEvent = intMetadataClass.newEvent
+
+                        outContext = 'Event'
+                        outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                        if hEvent.has_key?('eventId')
+                            intEvent[:eventId] = hEvent['eventId']
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hEvent.has_key?('identifier')
+                            intEvent[:identifier] = Identifier.unpack(hEvent['identifier'], responseObj, outContext)
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hEvent.has_key?('trigger')
+                            intEvent[:trigger] = hEvent['trigger']
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hEvent.has_key?('context')
+                            intEvent[:context] = hEvent['context']
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hEvent.has_key?('sequence')
+                            intEvent[:sequence] = hEvent['sequence']
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext,)
+                        end
+
+                        if hEvent.has_key?('time')
+                            intEvent[:time] = DateTime.unpack(hEvent['time'], responseObj, outContext)
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hEvent.has_key?('expectedObjective')
+                            hEvent['expectedObjective'].each do |item|
+                                hReturn = Objective.unpack(item, responseObj, outContext)
+                                unless hReturn.nil?
+                                    intEvent[:expectedObjectives] << hReturn
+                                end
+                            end
+                        end
+
+                        if hEvent.has_key?('relatedPass')
+                            intEvent[:relatedPass] = Pass.unpack(hEvent['relatedPass'], responseObj, outContext)
+                        end
+
+                        if hEvent.has_key?('relatedSensor')
+                            hEvent['relatedSensor'].each do |item|
+                                hReturn = Instrument.unpack(item, responseObj, outContext)
+                                unless hReturn.nil?
+                                    intEvent[:relatedSensors] << hReturn
+                                end
+                            end
+                        end
+
+                        intEvent
+
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,73 @@
+require_relative 'module_citation'
+require_relative 'module_platform'
+require_relative 'module_instrumentationEventList'
+require_relative 'module_identifier'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+  
+                module Instrument
+                    def self.unpack(hInstrument, responseObj, inContext = nil)
+
+                        @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                        intMetadataClass = InternalMetadata.new
+                        intInstrument = intMetadataClass.newInstrument
+
+                        outContext = 'instrument'
+                        outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                        if hInstrument.has_key?('instrumentId')
+                            intInstrument[:instrumentId] = hInstrument['instrumentId']
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hInstrument.has_key?('citation')
+                            intInstrument[:citation] = Citation.unpack(hInstrument['citation'], responseObj, outContext)
+                        end
+
+                        if hInstrument.has_key?('identifier')
+                            intInstrument[:identifier] = Identifier.unpack(hInstrument['identifier'], responseObj, outContext)
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hInstrument.has_key?('instrumentType')
+                            intInstrument[:instrumentType] = hInstrument['instrumentType']
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hInstrument.has_key?('description')
+                            intInstrument[:description] = hInstrument['description']
+                        end
+
+                        if hInstrument.has_key?('mountedOn')
+                            intInstrument[:mountedOn] = Platform.unpack(hInstrument['mountedOn'], responseObj, outContext)
+                        end
+
+                        if hInstrument.has_key?('history')
+                            hInstrument['history'].each do |item|
+                                hReturn = InstrumentationEventList.unpack(item, responseObj, outContext)
+                                unless hReturn.nil?
+                                    intInstrument[:histories] << hReturn
+                                end
+                            end
+                        end
+
+                        if hInstrument.has_key?('hostId')
+                            intInstrument[:hostId] = Identifier.unpack(hInstrument['hostId'], responseObj, outContext)
+                        end
+
+                        intInstrument
+
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,77 @@
+require_relative 'module_citation'
+require_relative 'module_extent'
+require_relative 'module_revision'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+  
+                module InstrumentationEvent
+                    def self.unpack(hInstrumentationEvent, responseObj, inContext = nil)
+                        @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
+                        intMetadataClass = InternalMetadata.new
+                        intInstrumentationEvent = intMetadataClass.newInstrumentationEvent
+
+                        outContext = 'instrumentation event'
+                        outContext = inContext + ' > ' + outContext unless inContext.nil?
+
+                        eventTypeArray = [
+                            "announcement",
+                            "calibration",
+                            "calibrationCoefficientUpdate",
+                            "dataLoss",
+                            "fatal",
+                            "manoeuvre",
+                            "missingData",
+                            "notice",
+                            "prelaunch",
+                            "severe",
+                            "switchOff",
+                            "switchOn",
+                            "clean"
+                        ]
+
+                        if hInstrumentationEvent.has_key?('citation')
+                            hInstrumentationEvent['citation'].each do |citation|
+                                hReturn = Citation.unpack(citation, responseObj, outContext)
+                                unless hReturn.nil?
+                                    intInstrumentationEvent[:citations] << hReturn
+                                end
+                            end
+                        end
+
+                        if hInstrumentationEvent.has_key?('description')
+                            intInstrumentationEvent[:description] = hInstrumentationEvent['description']
+                        else
+                            @MessagePath.issueWarning(40, responseObj, outContext)
+                        end
+
+                        if hInstrumentationEvent.has_key?('extent')
+                            intInstrumentationEvent[:extent] = Extent.unpack(hInstrumentationEvent['extent'], responseObj, outContext)
+                        end
+
+                        if hInstrumentationEvent.has_key?('eventType') && eventTypeArray.include?(hInstrumentationEvent['eventType'])
+                            intInstrumentationEvent[:eventType] = hInstrumentationEvent['eventType']
+                        else
+                            @MessagePath.issueWarning(41, responseObj, outContext)
+                        end
+
+                        if hInstrumentationEvent.has_key?('revisionHistory')
+                            hInstrumentationEvent['revisionHistory'].each do |item|
+                                hReturn = Revision.unpack(item, responseObj, outContext)
+                                unless hReturn.nil?
+                                    intInstrumentationEvent[:revisionHistories] << hReturn
+                                end
+                            end
+                        end
+
+                        intInstrumentationEvent
+                    end
+                end
+
+            end
+        end
+    end
+end