adiwg-mdtranslator 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 424da312bdcfc7617f563857a6e8767ebb3b3c4c
-  data.tar.gz: f35fdf24c6a34dd418bab443b39d4050a748cdbc
+  metadata.gz: d2be0aaa21383741efd06ac414b0ba47453777e6
+  data.tar.gz: 5eb25c34b45babdff52a7fadaa0e32668d2b0c9a
 SHA512:
-  metadata.gz: 4fb9075e39f5f0406ca5196353a7dd75a19735b0a72870f0d7a7814a3361a0390feec8080a6fa6fbf458fb7d46dd382f816e42db3fe955d1462e2248b0d51b38
-  data.tar.gz: 8db4fd7f94bac35cf98473c353dde6513e9dfc56347ca71218bf719d5919e28c533a47e532620d19ae52305c71c424a18e6d9055f1b8eb520cad16e016c24aad
+  metadata.gz: b085419641422ad940aec5f9bbc2b014585f76a1063750012bb2274711f934cc126e32a62d1e2783855d0f4ee6f321ab21632ca07f65d7e3d69f896b54bd1ff5
+  data.tar.gz: 7e5912f670bacbdca633ec763742be8f703a95c0b5fd107407eaf3f7a875cb6e23995001557b37844b74db21c07f3db106f4e77212ae8b5a0b32870e8e1c16a7

data/Rakefile

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

data/adiwg-mdtranslator.gemspec

@@ -38,5 +38,6 @@ Gem::Specification.new do |spec|
    spec.add_runtime_dependency "jbuilder", "~> 2.5"
    spec.add_runtime_dependency "kramdown", "~> 1.13"
    spec.add_runtime_dependency "coderay", "~> 1.1"
+   spec.add_runtime_dependency "nokogiri", "~> 1.7"
 
 end

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

@@ -1,6 +1,7 @@
 # repack coordinates
 
 # History:
+#  Stan Smith 2017-08-23 added is_polygon_clockwise method
 #  Stan Smith 2017-05-24 added checkGeometry method to move objects to real world
 #  Stan Smith 2016-11-10 added computedBbox computation
 #  Stan Smith 2015-07-16 moved module_coordinates from mdJson reader to internal
@@ -219,4 +220,16 @@ module AdiwgCoordinates
       aNorthings << aPoint[1]
    end
 
+   def self.is_polygon_clockwise(aCoords)
+      area = 0.0
+      i = 0
+      n = aCoords.length - 1
+      until i == n
+         area += (aCoords[i][0] * aCoords[i+1][1]) - (aCoords[i][1] * aCoords[i+1][0])
+         i += 1
+      end
+      area += (aCoords[n][0] * aCoords[0][1]) - (aCoords[n][1] * aCoords[0][0])
+      return area >= 0 ? false : true
+   end
+
 end

data/lib/adiwg/mdtranslator/readers/fgdc/fgdc_reader.rb

@@ -0,0 +1,49 @@
+# fgdc reader
+
+# History:
+#  Stan Smith 2017-08-10 original script
+
+require 'nokogiri'
+require_relative 'modules/module_fgdc'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            def self.readFile(file, hResponseObj)
+
+               # receive XML file
+               if file.nil? || file == ''
+                  hResponseObj[:readerStructureMessages] << 'XML file is missing'
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
+
+               # file must be well formed XML
+               begin
+                  xDoc = Nokogiri::XML(file) { |form| form.strict }
+               rescue Nokogiri::XML::SyntaxError => err
+                  hResponseObj[:readerStructureMessages] << 'XML file is not well formed'
+                  hResponseObj[:readerStructureMessages] << err
+                  hResponseObj[:readerStructurePass] = false
+                  return {}
+               end
+
+               # file must contain an fgdc <metadata> tag
+               xMetadata = xDoc.xpath('/metadata')
+               if xMetadata.empty?
+                  hResponseObj[:readerValidationMessages] << 'FGDC file did not contain a <metadata> tag'
+                  hResponseObj[:readerValidationPass] = false
+                  return {}
+               end
+
+               # load fgdc file into internal object
+               return Fgdc.unpack(xDoc, hResponseObj)
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_citation.rb

@@ -0,0 +1,144 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc citation
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'uuidtools'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_fgdc'
+require_relative 'module_date'
+require_relative 'module_series'
+require_relative 'module_publication'
+require_relative 'module_onlineResource'
+require_relative 'module_citation'
+require_relative 'module_responsibility'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Citation
+
+               def self.unpack(xCitation, hResponseObj)
+
+                  xCiteInfo = xCitation.xpath('./citeinfo')
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hCitation = intMetadataClass.newCitation
+
+                  # citation 8.1 (origin) - originator [] (required)
+                  aContacts = []
+                  axOrigins = xCiteInfo.xpath('./origin')
+                  axOrigins.each do |xOrigin|
+                     name = xOrigin.text
+                     unless name.empty?
+                        contactId = Fgdc.find_contact_by_name(name)
+                        if contactId.nil?
+                           # add a new contact for this originator
+                           contactId = Fgdc.add_contact(name, false)
+                           aContacts << contactId
+                        else
+                           aContacts << contactId
+                        end
+                     end
+                  end
+                  unless aContacts.empty?
+                     hResponsibility = Responsibility.unpack(aContacts, 'originator', hResponseObj)
+                     unless hResponsibility.nil?
+                        hCitation[:responsibleParties] << hResponsibility
+                     end
+                  end
+
+                  # citation 8.2/8.3 (pubdate/pubtime) - publication date/time {date} (required) {time} (optional)
+                  pubDate = xCiteInfo.xpath('./pubdate').text
+                  pubTime = xCiteInfo.xpath('./pubtime').text
+                  unless pubDate.empty?
+                     hDate = Date.unpack(pubDate, pubTime, 'publication', hResponseObj)
+                     unless hDate.nil?
+                        hCitation[:dates] << hDate
+                     end
+                  end
+
+                  # citation 8.4 (title) - citation title (required)
+                  title = xCiteInfo.xpath('./title').text
+                  unless title.empty?
+                     hCitation[:title] = title
+                  end
+
+                  # citation 8.5 (edition) - edition
+                  edition = xCiteInfo.xpath('./edition').text
+                  unless edition.empty?
+                     hCitation[:edition] = edition
+                  end
+
+                  # citation 8.6 (geoform) - edition
+                  presentationForm = xCiteInfo.xpath('./geoform').text
+                  unless presentationForm.empty?
+                     hCitation[:presentationForms] << presentationForm
+                  end
+
+                  # citation 8.7 (serinfo) - series information
+                  xSeries = xCiteInfo.xpath('./serinfo')
+                  unless xSeries.empty?
+                     hSeries = Series.unpack(xSeries, hResponseObj)
+                     unless hSeries.nil?
+                        hCitation[:series] = hSeries
+                     end
+                  end
+
+                  # citation 8.8 (pubinfo) - publication information
+                  xPublication = xCiteInfo.xpath('./pubinfo')
+                  unless xPublication.empty?
+                     hResponsibility = Publication.unpack(xPublication, hResponseObj)
+                     unless hResponsibility.nil?
+                        hCitation[:responsibleParties] << hResponsibility
+                     end
+                  end
+
+                  # citation 8.9 (othercit) - other citation details
+                  other = xCiteInfo.xpath('./othercit').text
+                  unless other.empty?
+                     hCitation[:otherDetails] << other
+                  end
+
+                  # citation 8.10 (onlink) - online linkage []
+                  axOnLink = xCiteInfo.xpath('./onlink')
+                  unless axOnLink.empty?
+                     description = 'Link to the resource described in this citation'
+                     axOnLink.each do |xLink|
+                        onLink = xLink.text
+                        unless onLink.empty?
+                           hURI = OnlineResource.unpack(onLink, description, hResponseObj)
+                           unless hURI.nil?
+                              hCitation[:onlineResources] << hURI
+                           end
+                        end
+                     end
+                  end
+
+                  # citation 8.11 (lworkcit) - larger work citation
+                  xLWCitation = xCiteInfo.xpath('./lworkcit')
+                  unless xLWCitation.empty?
+                     hLWCitation = Citation.unpack(xLWCitation, hResponseObj)
+                     unless hLWCitation.nil?
+                        hAssResource = intMetadataClass.newAssociatedResource
+                        hAssResource[:associationType] = 'largerWorkCitation'
+                        hAssResource[:resourceCitation] = hLWCitation
+                        Fgdc.add_associated_resource(hAssResource)
+                     end
+                  end
+
+                  return hCitation
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_date.rb

@@ -0,0 +1,57 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc metadata date
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'date'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+require_relative 'module_fgdc'
+require_relative 'module_dateTime'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Date
+
+               def self.unpack(date, time, type, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hDate = intMetadataClass.newDate
+
+                  if date.nil? || date == ''
+                     hResponseObj[:readerExecutionMessages] << 'date string is missing from date conversion'
+                     hResponseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  if type.nil? || type == ''
+                     hResponseObj[:readerExecutionMessages] << 'date type is missing from date conversion'
+                     hResponseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  hDateTime = DateTime.unpack(date, time, hResponseObj)
+
+                  # build internal date object
+                  unless hDateTime.nil?
+                     hDate[:date] = hDateTime[:dateTime]
+                     hDate[:dateResolution] = hDateTime[:dateResolution]
+                     hDate[:dateType] = type
+                     return hDate
+                  end
+
+                  return nil
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_dateTime.rb

@@ -0,0 +1,108 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc metadata date
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'date'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+require_relative 'module_fgdc'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module DateTime
+
+               def self.unpack(date, time, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  hDateTime = intMetadataClass.newDateTime
+
+                  if date.nil? || date == ''
+                     hResponseObj[:readerExecutionMessages] << 'date string is missing from dateTime conversion'
+                     hResponseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # convert date from fgdc to iso format
+                  year = date.byteslice(0,4)
+                  month = date.byteslice(4,2)
+                  day = date.byteslice(6,2)
+                  month = '01' if month.nil? || month == ''
+                  day = '01' if day.nil? || day == ''
+                  dtIn = year + '-' + month + '-' + day
+
+                  # add time element to date string
+                  if time.empty?
+                     dtIn = dtIn + 'T' + '00:00:00'
+                  else
+                     aScan = time.scan(/:/)
+                     if aScan.empty?
+                        hour = time.byteslice(0,2)
+                        minute = time.byteslice(2,2)
+                        second = time.byteslice(4,2)
+                     else
+                        aTime = time.split(':')
+                        hour = aTime[0]
+                        minute = aTime[1]
+                        second = aTime[2]
+                     end
+                     minute = '00' if minute.nil? || minute == ''
+                     second = '00' if second.nil? || second == ''
+                     dtIn = dtIn + 'T' + hour + ':' + minute + ':' + second
+                  end
+
+                  # determine if date/time is 'universal time' or other
+                  timeFlag = Fgdc.get_metadata_time_convention
+                  timeFlag = 'local time' if timeFlag.nil? || timeFlag == ''
+
+                  # add offset to date/time string
+                  if timeFlag == 'universal time'
+                     dtIn = dtIn + '+00:00'
+                  else
+                     timeOffset = Time.now.gmt_offset
+                     aOffset = timeOffset.divmod(3600)
+                     hOffset = aOffset[0]
+                     mOffset = aOffset[1] * 60
+                     if hOffset >= 0
+                        zone = '+' + '%02d' % hOffset + ':' + '%02d' % mOffset
+                     else
+                        zone = '%03d' % hOffset + ':' + '%02d' % mOffset
+                     end
+                     dtIn = dtIn + zone
+                  end
+
+                  # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
+                  aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(dtIn)
+                  if aDateTimeReturn[1] == 'ERROR'
+                     hResponseObj[:readerExecutionMessages] << 'Date string is invalid'
+                     hResponseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # if not 'universal time' change the offset to utc
+                  dateTimeReturn = aDateTimeReturn[0]
+                  if timeFlag == 'universal time'
+                     utc = dateTimeReturn
+                  else
+                     utc = dateTimeReturn.new_offset(Rational(0,24))
+                  end
+
+                  # build internal dateTime object
+                  hDateTime[:dateTime] = utc
+                  hDateTime[:dateResolution] = aDateTimeReturn[1]
+
+                  return hDateTime
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_distribution.rb

@@ -0,0 +1,28 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc distribution
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Distribution
+
+               def self.unpack(xDistribution, hResponseObj)
+
+
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_entityAttribute.rb

@@ -0,0 +1,28 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc entity and attribute
+
+# History:
+#  Stan Smith 2017-08-15 original script
+
+require 'nokogiri'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module EntityAttribute
+
+               def self.unpack(xEntity, hResponseObj)
+
+
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_fgdc.rb

@@ -0,0 +1,193 @@
+# Reader - fgdc to internal data structure
+# unpack fgdc metadata
+
+# History:
+#  Stan Smith 2017-08-10 original script
+
+require 'nokogiri'
+require 'uuidtools'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_identification'
+require_relative 'module_quality'
+require_relative 'module_spatialOrganization'
+require_relative 'module_spatialReference'
+require_relative 'module_entityAttribute'
+require_relative 'module_distribution'
+require_relative 'module_metadataInfo'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module Fgdc
+
+            module Fgdc
+
+               def self.unpack(xDoc, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  intObj = intMetadataClass.newBase
+                  @intObj = intObj
+                  @contacts = intObj[:contacts]
+                  @xDoc = xDoc
+
+                  # build basic mdTranslator internal object
+                  hMetadata = intMetadataClass.newMetadata
+                  hMetadataInfo = intMetadataClass.newMetadataInfo
+                  hResourceInfo = intMetadataClass.newResourceInfo
+                  hMetadata[:metadataInfo] = hMetadataInfo
+                  hMetadata[:resourceInfo] = hResourceInfo
+                  intObj[:metadata] = hMetadata
+
+                  xMetadata = xDoc.xpath('./metadata')
+
+                  # metadata (idinfo 1) - identification information (required)
+                  xIdInfo = xMetadata.xpath('./idinfo')
+                  unless xIdInfo.empty?
+                     Identification.unpack(xIdInfo, intObj, hResponseObj)
+                  end
+                  if xIdInfo.empty?
+                     hResponseObj[:readerExecutionMessages] << 'FGDC is missing identification information section (idinfo)'
+                  end
+
+                  # metadata (dataqual 2) - data quality
+                  xDataQual = xMetadata.xpath('./dataqual')
+                  unless xDataQual.empty?
+                     Quality.unpack(xDataQual, hResponseObj)
+                  end
+
+                  # metadata (spdoinfo 3) - spatial data organization
+                  xSpatialOrg = xMetadata.xpath('./spdoinfo')
+                  unless xSpatialOrg.empty?
+                     SpatialOrganization.unpack(xSpatialOrg, hResponseObj)
+                  end
+
+                  # metadata (spref 4) - spatial reference
+                  xSpatialRef = xMetadata.xpath('./spref')
+                  unless xSpatialRef.empty?
+                     SpatialReference.unpack(xSpatialRef, hResponseObj)
+                  end
+
+                  # metadata (eainfo 5) - entity and attribute
+                  xEntity = xMetadata.xpath('./eainfo')
+                  unless xEntity.empty?
+                     EntityAttribute.unpack(xEntity, hResponseObj)
+                  end
+
+                  # metadata (distinfo 6) - distribution information
+                  xDistribution = xMetadata.xpath('./distinfo')
+                  unless xDistribution.empty?
+                     Distribution.unpack(xDistribution, hResponseObj)
+                  end
+
+                  # metadata (metainfo 7) - metadata reference (required)
+                  xMetaInfo = xMetadata.xpath('./metainfo')
+                  unless xMetaInfo.empty?
+                     MetadataInformation.unpack(xMetaInfo, hResponseObj)
+                  end
+                  if xMetaInfo.empty?
+                     hResponseObj[:readerExecutionMessages] << 'FGDC is missing metadata information section (metainfo)'
+                  end
+
+                  return intObj
+
+               end
+
+               # find the array pointer and type for a contact
+               def self.find_contact_by_id(contactId)
+                  contactIndex = nil
+                  contactType = nil
+                  unless @contacts.empty?
+                     @contacts.each_with_index do |contact, i|
+                        if contact[:contactId] == contactId
+                           if contact[:isOrganization]
+                              contactType = 'organization'
+                           else
+                              contactType = 'individual'
+                           end
+                           contactIndex = i
+                        end
+                     end
+                  end
+                  return contactIndex, contactType
+               end
+
+               # find contact id for a name
+               def self.find_contact_by_name(contactName)
+                  @contacts.each do |contact|
+                     if contact[:name] == contactName
+                        return contact[:contactId]
+                     end
+                  end
+                  return nil
+               end
+
+               # add new contact to contacts array
+               def self.add_contact(name, isOrg)
+                  contactId = find_contact_by_name(name)
+                  if contactId.nil?
+                     intMetadataClass = InternalMetadata.new
+                     hContact = intMetadataClass.newContact
+                     contactId = UUIDTools::UUID.random_create.to_s
+                     hContact[:contactId] = contactId
+                     hContact[:name] = name
+                     hContact[:isOrganization] = isOrg
+                     @contacts << hContact
+                  end
+                  return contactId
+               end
+
+               # return contact by id
+               def self.get_contact_by_id(contactId)
+                  index = find_contact_by_id(contactId)[0]
+                  unless index.nil?
+                     return @contacts[index]
+                  end
+                  return nil
+               end
+
+               # add or replace the contact
+               def self.set_contact(hContact)
+                  index = find_contact_by_id(hContact[:contactId])[0]
+                  if index.nil?
+                     @contacts << hContact
+                     index = @contacts.length - 1
+                  else
+                     @contacts[index] = hContact
+                  end
+                  return index
+               end
+
+               # set an internal object for tests
+               def self.set_intObj(intObj)
+                  @intObj = intObj
+                  @contacts = @intObj[:contacts]
+               end
+
+               # get internal object for test modules
+               def self.get_intObj
+                  return @intObj
+               end
+
+               # get metadata time convention
+               def self.get_metadata_time_convention
+                  return @xDoc.xpath('./metadata/metainfo/mettc').text
+               end
+
+               # set @xDoc for minitests
+               def self.set_xDoc(xDoc)
+                  @xDoc = xDoc
+               end
+
+               # add new associated resource
+               def self.add_associated_resource(hResource)
+                  @intObj[:metadata][:associatedResources] << hResource
+               end
+
+            end
+
+         end
+      end
+   end
+end