adiwg-mdtranslator 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1813b83d6f06fc269f456df155da5a49c0112c29
-  data.tar.gz: 906191f4ca3c3e77999c0e8c6862adeab1869eb3
+  metadata.gz: 874e4c69c1bbc8d2aaf5a6754802325a65526750
+  data.tar.gz: e205f480b6a18acc9b0575449cb783d01397c1a7
 SHA512:
-  metadata.gz: c9fbf80823eb3c40554a4f558134efe194bec90c6e4a6ed4d73a78752aec1e721cf79027fd412942db399c1d80583790cccb85ab83ae2334db774270c41df79d
-  data.tar.gz: 144975542009eaa78cc12520a30a81a7a189871b3de16630aa07c46820aad5474695bf067f85312355a8d667c07c0c11ee6312129163dbdc2bdf01f7448389eb
+  metadata.gz: d6cfe28c5a9154da568b2e60560c72a4ae7090732570c74e5b65227f22b83d03eb777588064bb7b124dd5afeea03b5a41613174ead01811a5ec8c31809418a45
+  data.tar.gz: 2523859c1310086ef1a58ae9dd33288e0c38f875145617d4f13db5e4fdfc9626959869685f8b34be3c78dbec619529dc8d13d75e77bf8d383600cb907eed9532

data/adiwg-mdtranslator.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 	spec.authors       = ["Stan Smith", "Josh Bradley"]
 	spec.email         = ["stansmith@usgs.gov", "joshua_bradley@fws.gov"]
 	spec.summary       = %q{The mdtranslator (metadata translator) is a tool for translating metadata in one format to another. The tool is written and maintained by the Alaska Data Integration Working Group (ADIwg).}
-	spec.description   = %q{The mdtranslator was written by the Alaska Data Integration Working Group (ADIwg) to assist with creating ISO 19139 metadata records.  Input to the mdtranslator is simple JSON using the mdJson-schema.  The mdtranslator architecture allows developers to write additional readers for other input formats and/or write additional writers for other output other than ISO 19139.}
+	spec.description   = %q{The mdtranslator was written by the Alaska Data Integration Working Group (ADIwg) to assist with creating ISO 19139 metadata records.  Input to the mdtranslator is JSON conforming to the mdJson-schema.  The mdtranslator architecture allows developers to write additional readers for other input formats and/or write additional writers for other output other than ISO 19139.}
 	spec.homepage      = "http://www.adiwg.org/mdTranslator"
 	spec.license       = "UNLICENSED"
 
@@ -31,4 +31,6 @@ Gem::Specification.new do |spec|
 	spec.add_runtime_dependency "uuidtools", "~> 2.1"
 	spec.add_runtime_dependency "json-schema", "~> 2.4.0", "< 2.5.0"
 	spec.add_runtime_dependency "adiwg-mdjson_schemas", "~> 1.0.0"
+  spec.add_runtime_dependency "adiwg-mdcodes", "~> 1.0"
+
 end

data/bin/mdtranslator

@@ -23,13 +23,13 @@ class Mdtranslator < Thor
 	# basic cli description
 	desc 'translate [FILE]', %q{Pass JSON string or filename plus parameters to mdtranslator translate}
 	long_desc <<-LONGDESC
-	    'mdtranslator translate' provides command line access to the ADIWG metadata translator
- with options to select the input file reader, select writer output format, show empty tags
- in XML outputs, and choose level of validation for JSON inputs.
+	'mdtranslator translate' provides command line access to the ADIWG metadata translator
+with options to select the input file reader, select writer output format, show empty tags
+in XML outputs, and choose level of validation for JSON inputs.
 	LONGDESC
 	# define cli options
-	method_option :reader, :aliases => '-r', :desc => 'Name of reader to read your input', :default => 'mdJson'
-	method_option :writer, :aliases => '-w', :desc => 'Name of writer to create your metadata, or leave blank to validate input only'
+	method_option :reader, :aliases => '-r', :desc => 'Reader to read your input metadata file', :enum => %w{mdJson}, :required => true
+	method_option :writer, :aliases => '-w', :desc => 'Writer to create your output metadata file, leave blank to validate input only', :enum => %w{iso19115_2 iso19110 html}
 	method_option :validate, :aliases => '-v', :desc => 'Specify level of validation to be performed', :enum => %w{none normal strict}, :default => 'normal'
 	method_option :showAllTags, :aliases => '-s', :desc => 'Include tags for unused attributes', :type => :boolean, :default => false
 	method_option :messages, :aliases => '-m', :desc => 'On error return messages as formatted text or json object', :enum => %w{json text}, :default => 'text'

data/lib/adiwg/mdtranslator.rb

@@ -33,24 +33,6 @@ require 'adiwg/mdtranslator/writers/mdWriters'
 module ADIWG
     module Mdtranslator
 
-        def self.addFinalMessages
-            if $response[:readerStructurePass].nil?
-                $response[:readerStructureMessages].insert(0, 'Input file structure was not checked \n')
-            end
-
-            if $response[:readerValidationPass].nil?
-                $response[:readerValidationMessages].insert(0, 'Validator was not called \n')
-            end
-
-            if $response[:readerExecutionPass].nil?
-                $response[:readerExecutionMessages].insert(0, 'Reader was not called \n')
-            end
-
-            if $response[:writerPass].nil?
-                $response[:writerMessages].insert(0, 'Writer not called \n')
-            end
-        end
-
         def self.translate(file:, reader:, validate: 'normal', writer: nil, showAllTags: false)
 
             $showAllTags = showAllTags
@@ -80,7 +62,7 @@ module ADIWG
             #    is 'false', set one or more messages to assist user fixing file schema validation
             #    problems.  Set by reader.
             # readerExecutionPass: 'true' if the reader completes the import of the input file into
-            #    the internal object without errors set by reader
+            #    the internal object without errors. set by reader.
             # readerExecutionMessages: an array of quoted string messages. If readerExecutionPass is
             #    'false', set one or more messages to assist user in fixing file data problems.
             #    Set by reader.
@@ -88,7 +70,7 @@ module ADIWG
             #    list.  if nil no write was requested and only validation of the input file will
             #    be performed.
             # writerVersion: current version of the writer requested, set by writer
-            # writerFormat: format of the output from the writer, set by writer
+            # writerFormat: format of the output from the writer. Set by writer.
             # writerPass: true if the writer completes the creation of the output file without errors,
             #    set by writer
             # writerMessages: an array of quoted string messages.  If writerPass is 'false', set one
@@ -118,20 +100,18 @@ module ADIWG
 
             # handle readers
             if reader.nil? || reader == ''
-                $response[:readerStructureMessages] << 'Reader name is missing.'
-                $response[:readerValidationMessages] << 'Reader name is missing.'
-                $response[:readerExecutionMessages] << 'Reader name is missing.'
-                $response[:writerMessages] << 'Input file was not read.'
-                addFinalMessages()
+                $response[:readerExecutionPass] = false
+                $response[:readerExecutionMessages] << 'Reader name was not provided'
                 return $response
             else
                 require File.join(File.dirname(__FILE__), 'mdtranslator/readers/mdReaders')
                 intObj = ADIWG::Mdtranslator::Readers.handleReader(file)
 
-                if intObj
+                # if readerExecutionPass is nil no error messages were set during exection
+                # and the execution is assumed to have been successful
+                if $response[:readerExecutionPass].nil?
                     $response[:readerExecutionPass] = true
-                else
-                    addFinalMessages()
+                elsif !$response[:readerExecutionPass]
                     return $response
                 end
             end
@@ -143,7 +123,6 @@ module ADIWG
                 require File.join(File.dirname(__FILE__), 'mdtranslator/writers/mdWriters')
                 ADIWG::Mdtranslator::Writers.handleWriter(intObj)
             end
-            addFinalMessages()
             return $response
 
         end

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

@@ -127,6 +127,7 @@ class InternalMetadata
             metadataCustodians: [],
             metadataCreateDate: {},
             metadataUpdateDate: {},
+            metadataCharacterSet: nil,
             metadataURI: nil,
             metadataStatus: nil,
             maintInfo: {},
@@ -168,6 +169,7 @@ class InternalMetadata
             graphicOverview: [],
             resourceFormats: [],
             resourceLanguages: [],
+            resourceCharacterSets: [],
             descriptiveKeywords: [],
             resourceUses: [],
             useConstraints: [],

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

@@ -12,6 +12,7 @@
 #   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
+#   Stan Smith 2015-06-12 added method to lookup contact in contact array
 
 require 'json'
 
@@ -51,8 +52,13 @@ module ADIWG
 
                     # load mdJson file into internal object
                     require readerModule('module_mdJson')
-                    intObj = $ReaderNS.unpack(@hMdJson)
-                    return intObj
+                    # instance classes needed in script
+                    intMetadataClass = InternalMetadata.new
+
+                    # create new internal metadata container for the reader
+                    @intObj = intMetadataClass.newBase
+                    $ReaderNS.unpack(@intObj, @hMdJson)
+                    return @intObj
 
                 end
 
@@ -164,6 +170,19 @@ module ADIWG
                     return file
                 end
 
+                # find the array pointer for a contact
+                def self.findContact(contactId)
+                    pointer = nil
+                    i = 0
+                    @intObj[:contacts].each do |contact|
+                        if contact[:contactId] == contactId
+                            pointer = i
+                        end
+                        i += 1
+                    end
+                    return pointer
+                end
+
             end
         end
     end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_1.0/module_contacts.rb

@@ -37,19 +37,21 @@ module ADIWG
                         intCont = intMetadataClass.newContact
 
                         # contact ID - required
-                        # return nil contact if contactId is '' or missing
+                        # each contact must have a 'contactId' provided by the user
+                        # ... the contactId is used by responsibleParty to reference a contact
+                        # ... return nil contact if contactId is '' or missing
                         if hContact.has_key?('contactId')
                             s = hContact['contactId']
                             if s != ''
                                 intCont[:contactId] = s
                             else
                                 $response[:readerExecutionPass] =  false
-                                $response[:readerExecutionMessages] << 'Contact ID is blank.'
+                                $response[:readerExecutionMessages] << 'contact: {contactId: } is blank.'
                                 return nil
                             end
                         else
                             $response[:readerExecutionPass] =  false
-                            $response[:readerExecutionMessages] << 'Contact ID is missing.'
+                            $response[:readerExecutionMessages] << 'contact: {contactId: } is missing.'
                             return nil
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules_1.0/module_mdJson.rb

@@ -5,6 +5,7 @@
 # 	Stan Smith 2014-12-12 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-02-17 added support for multiple data dictionaries
+#   Stan Smith 2015-06-12 moved instantiation of intObj up to module mdJson_reader.rb
 
 require $ReaderNS.readerModule('module_contacts')
 require $ReaderNS.readerModule('module_metadata')
@@ -16,13 +17,7 @@ module ADIWG
         module Readers
             module MdJson
 
-                def self.unpack(hMdJson)
-
-                    # instance classes needed in script
-                    intMetadataClass = InternalMetadata.new
-
-                    # create new internal metadata container for the reader
-                    intObj = intMetadataClass.newBase
+                def self.unpack(intObj, hMdJson)
 
                     # get json schema name and version
                     hVersion = hMdJson['version']
@@ -31,8 +26,6 @@ module ADIWG
 
                     # contact array
                     # load the array of contacts from the json input
-                    # ... the program uses the 'contactId' provided by the user
-                    # ... to reference a contact
                     if hMdJson.has_key?('contact')
                     	aContacts = hMdJson['contact']
                     	aContacts.each do |hContact|
@@ -45,14 +38,14 @@ module ADIWG
                     # add default contacts
                     intObj[:contacts].concat($ReaderNS::Contact.setDefaultContacts)
 
-                    # metadata
+                    # metadata section
                     # load metadata from the hash object
                     if hMdJson.has_key?('metadata')
                     	hMetadata = hMdJson['metadata']
                     	intObj[:metadata] = $ReaderNS::Metadata.unpack(hMetadata)
                     end
 
-                    # data dictionary
+                    # data dictionary section
                     if hMdJson.has_key?('dataDictionary')
                         aDictionary = hMdJson['dataDictionary']
                         aDictionary.each do |hDictionary|

data/lib/adiwg/mdtranslator/readers/mdJson/modules_1.0/module_metadataInfo.rb

@@ -8,6 +8,7 @@
 #   Stan Smith 2014-09-19 changed parent metadata identifier type citation json 0.8.0
 #   Stan Smith 2014-11-06 removed metadataScope, moved to resourceType under resourceInfo json 0.9.0
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-12 added support for metadataCharacterSet
 
 require $ReaderNS.readerModule('module_responsibleParty')
 require $ReaderNS.readerModule('module_dateTime')
@@ -76,6 +77,14 @@ module ADIWG
                             end
                         end
 
+                        # metadata - characterSet - default 'utf8'
+                        if hMetadataInfo.has_key?('metadataCharacterSet')
+                            s = hMetadataInfo['metadataCharacterSet']
+                            if s != ''
+                                intMetadataInfo[:metadataCharacterSet] = s
+                            end
+                        end
+
                         # metadata - metadata URI
                         if hMetadataInfo.has_key?('metadataUri')
                             s = hMetadataInfo['metadataUri']

data/lib/adiwg/mdtranslator/readers/mdJson/modules_1.0/module_resourceInfo.rb

@@ -16,6 +16,7 @@
 #   Stan Smith 2014-10-29 added support for resource time period
 #   Stan Smith 2014-11-06 added resourceType for 0.9.0
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-12 added support for resource characterSets
 
 require $ReaderNS.readerModule('module_citation')
 require $ReaderNS.readerModule('module_resourceIdentifier')
@@ -131,6 +132,14 @@ module ADIWG
                             end
                         end
 
+                        # resource information - characterSet [] - default 'utf8'
+                        if hResourceInfo.has_key?('characterSet')
+                            aCharSet = hResourceInfo['characterSet']
+                            aCharSet.each do |charSet|
+                                intResInfo[:resourceCharacterSets] << charSet
+                            end
+                        end
+
                         # resource information - purpose
                         if hResourceInfo.has_key?('purpose')
                             s = hResourceInfo['purpose']

data/lib/adiwg/mdtranslator/readers/mdJson/modules_1.0/module_responsibleParty.rb

@@ -7,6 +7,8 @@
 #   ... removed resource IDs associated with contact
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-01-18 added nil return if hRParty empty
+#   Stan Smith 2015-06-12 added check that contactId for responsibleParty
+#   ... matches an actual contact in the contact array
 
 module ADIWG
     module Mdtranslator
@@ -30,6 +32,13 @@ module ADIWG
                             s = hRParty['contactId']
                             if s != ''
                                 intResById[:contactId] = s
+                                if (!$ReaderNS.findContact(s))
+                                    $response[:readerExecutionPass] = false
+                                    $response[:readerExecutionMessages] << "Responsible Party contact ID #{s} does not match with any contact provided\n"
+                                end
+                            else
+                                $response[:readerExecutionPass] = false
+                                $response[:readerExecutionMessages] << 'Responsible Party is missing the contact ID\n'
                             end
                         end
 
@@ -38,6 +47,9 @@ module ADIWG
                             s = hRParty['role']
                             if s != ''
                                 intResById[:roleName] = s
+                            else
+                                $response[:readerExecutionPass] = false
+                                $response[:readerExecutionMessages] << 'Responsible Party is missing the contact role\n'
                             end
                         end
 

data/lib/adiwg/mdtranslator/version.rb

@@ -38,11 +38,16 @@
 #               ... added local names to iso 19110 writer
 # 1.0.0rc1 2015-02-27 schema 1.0 support
 # 1.1.0 2015-04-13 added html writer
+# 1.2.0 2015-06-12 added mdCodes for source of codelists
+#              --- added comments to XML headers for citation of ADIwg
+#              --- added reader and writer names to CLI help
+#              --- added check in responsibleParty for valid contactId
+#              --- added characterSets to resource and metadata, updated iso19115_2 and html writers
 
 module ADIWG
     module Mdtranslator
         # current mdtranslator version
-        VERSION = "1.1.1"
+        VERSION = "1.2.0"
     end
 end
 

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

@@ -52,12 +52,15 @@ module ADIWG
                             logo = file.read
                             file.close
 
+                            # side navigation
+                            @html.div('id'=>'sideNav') do
                             # add top anchor and button
-                            @html.a(' Top', {'href'=>'#', 'class'=>'btn icon-caret-up', 'style'=>'position:fixed; bottom:6em; right:1em'})
+                              @html.a(' Top', {'href'=>'#', 'class'=>'btn icon-caret-up'})
 
-                            # add open and close buttons
-                            @html.span(' Open',{'class'=>'btn icon-caret-down', 'style'=>'position:fixed; bottom:1em; right:1em', 'onclick'=>'openAllDetails();'})
-                            @html.span(' Close',{'class'=>'btn icon-caret-right', 'style'=>'position:fixed; bottom:3.5em; right:1em', 'onclick'=>'closeAllDetails();'})
+                              # add open and close buttons
+                              @html.span(' Open',{'id'=>'openAllDetails', 'class'=>'btn icon-caret-down', 'onclick'=>'openAllDetails();'})
+                              @html.span(' Close',{'class'=>'btn icon-caret-right', 'onclick'=>'closeAllDetails();'})
+                            end
 
                             # main header
                             @html.h2('id'=>'mainHeader') do

data/lib/adiwg/mdtranslator/writers/html/sections/html_bodyScript.js

@@ -69,26 +69,34 @@ if ( typeof L === "object") {
             geoArray.forEach(function(geo, geoIdx, geoArr) {
                 var json = JSON.parse(geo.textContent || geo.innerText);
                 var bbox = json.bbox;
+
+                if (!json.properties) {
+                    json.properties = {};
+                }
+
                 if (json.geometry === null && bbox) {
                     json.geometry = {
                         "type": "Polygon",
                         "coordinates": [[[bbox[2], bbox[3]], [bbox[0], bbox[3]], [bbox[0], bbox[1]], [bbox[2], bbox[1]], [bbox[2], bbox[3]]]]
                     };
-                    if (!json.properties) {
-                        json.properties = {};
-                    }
                     json.properties.style = {
                         color: '#f00',
                         fill: false
                     };
                 }
 
+                json.properties.popup = geo.getAttribute('data-popup');
                 geojson.push(json);
             });
 
             var geoLayer = L.geoJson(geojson, {
                 style: function(feature) {
                     return feature.properties.style || {};
+                },
+                onEachFeature: function (feature, layer) {
+                    layer.bindPopup(feature.properties.popup,{
+                        closeButton: false
+                    });
                 }
             }).addTo(map);
 
@@ -104,6 +112,16 @@ if ( typeof L === "object") {
 
             }, map);
 
+            L.DomEvent.addListener(L.DomUtil.get('openAllDetails'), 'click', function() {
+                var me = this;
+                var i = 0;
+
+                setTimeout(function() {
+                    check(i, me, bnds);
+                }, 100);
+
+            }, map);
+
             map.fitBounds(bnds);
             map.addLayer(new L.TileLayer.OSM());
         });

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

@@ -132,7 +132,8 @@ module ADIWG
                                 @html.em('GeoJSON format: ')
                                 @html.section(:class=>'block') do
                                     geoJson = AdiwgGeoFormat.internal_to_geoJson(hGeoEle)
-                                    @html.div({'id'=>'geojson-' + geoPre, 'class'=>'geojson'}) do
+                                    popData = hGeoEle[:elementName] || hGeoEle[:elementDescription] || hGeoEle[:elementId]
+                                    @html.div({'id'=>'geojson-' + geoPre, 'class'=>'geojson', 'data-popup' => popData}) do
                                         @html.text!(geoJson)
                                     end
                                 end