adiwg-mdtranslator 2.0.0rc2 → 2.0.0rc3

data/lib/adiwg/mdtranslator/version.rb

@@ -1,19 +1,18 @@
 # adiwg mdTranslator
 
 # version 2 history
-# 2016-10-01 start of version 2
+# 2.0.0rc3 2017-05-16 removed topicCategory from schema and manage as keyword
+# 2.0.0rc2 2017-04-21 removed inline CSS option from CLI
+# 2.0.0rc1 2017-04-09 release candidate 1
+# 2.0.0    2016-10-01 start of version 2
 
 module ADIWG
-    module Mdtranslator
-        # current mdtranslator version
-        VERSION = "2.0.0rc2"
-    end
+   module Mdtranslator
+      # current mdtranslator version
+      VERSION = "2.0.0rc3"
+   end
 end
 
-# version 2 history
-# 2.0.0rc2 2017-04-21 removed inline CSS option from CLI
-# 2.0.0rc1 2017-04-09 release candidate 1
-
 # version 1 history
 # 1.0.0rc1 2015-02-27 schema 1.0 support
 # 1.1.0 2015-04-13 added html writer

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_resourceInfo.rb

@@ -1,6 +1,7 @@
 # mdJson 2.0 writer - resource information
 
 # History:
+#   Stan Smith 2017-05-16 deprecated topicCategory
 #   Stan Smith 2017-03-11 refactored for mdJson/mdTranslator 2.0
 #   Josh Bradley original script
 
@@ -43,7 +44,6 @@ module ADIWG
                      json.credit hResInfo[:credits] unless hResInfo[:credits].empty?
                      json.timePeriod TimePeriod.build(hResInfo[:timePeriod]) unless hResInfo[:timePeriod].empty?
                      json.status hResInfo[:status] unless hResInfo[:status].empty?
-                     json.topicCategory hResInfo[:topicCategories] unless hResInfo[:topicCategories].empty?
                      json.pointOfContact @Namespace.json_map(hResInfo[:pointOfContacts], ResponsibleParty)
                      json.spatialReferenceSystem @Namespace.json_map(hResInfo[:spatialReferenceSystems], SpatialReference)
                      json.spatialRepresentationType hResInfo[:spatialRepresentationTypes] unless hResInfo[:spatialRepresentationTypes].empty?

data/lib/adiwg/mdtranslator/writers/sbJson/sbJson_writer.rb

@@ -1,135 +1,57 @@
+# sbJson 1.0 writer
+
+# History:
+#  Stan Smith 2017-05-12 refactored for mdJson/mdTranslator 2.0
+#  Josh Bradley original script
+
 require 'jbuilder'
 require_relative 'version'
-require_relative 'sections/sbJson_base'
-require_relative 'sections/sbJson_contact'
-require_relative 'sections/sbJson_identifier'
-require_relative 'sections/sbJson_spatial'
-require_relative 'sections/sbJson_facet'
+require_relative 'sections/sbJson_sbJson'
 
 module ADIWG
-  module Mdtranslator
-    module Writers
-      module SbJson
-        extend SbJson::Base
-        def self.startWriter(_intObj, responseObj, _paramsObj)
-          @intObj = _intObj
-
-          # set output flag for null properties
-          Jbuilder.ignore_nil(!responseObj[:writerShowTags])
-          # set the format of the output file based on the writer specified
-          responseObj[:writerFormat] = 'json'
-          responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::SbJson::VERSION
-
-          rInfo = _intObj[:metadata][:resourceInfo]
-          mInfo = _intObj[:metadata][:metadataInfo]
-          dInfo = _intObj[:metadata][:distributorInfo]
-          cite = rInfo[:citation]
-          ids = cite[:citResourceIds]
+   module Mdtranslator
+      module Writers
+         module SbJson
 
-          metadata = Jbuilder.new do |json|
-            parentId = mInfo[:parentMetadata][:citResourceIds].find {
-                |i| i[:identifierType] == 'scienceBase'
-            } unless mInfo[:parentMetadata].nil? || mInfo[:parentMetadata][:citResourceIds].nil?
-            json.parentId parentId.nil? ? '' : parentId[:identifier]
-
-            json.identifiers json_map(ids, Identifier)
-            json.title cite[:citTitle]
-            json.alternateTitles([cite[:citAltTitle]]) unless cite[:citAltTitle].nil?
-            json.body rInfo[:abstract]
-            json.citation do
-              names = cite[:citResponsibleParty].map do |rp|
-                cnt = getContact(rp[:contactId])
-                cnt[:indName]
-              end
-              names = names.select! { |s| s }.nil? ? 'Unknown' : names.join(', ')
-              dates = cite[:citDate].map { |dt| dt[:dateTime].strftime('%F') + '(' + dt[:dateType] + ')' }
-              url = cite[:citOlResources].map { |ol| ol[:olResURI] }
-              json.merge! sprintf('%s, %s, %s, %s', names, dates.join(', '), cite[:citTitle], url.join(', '))
-            end
-            json.purpose rInfo[:purpose]
-
-            legal = []
-            rInfo[:legalConstraints].each do |lc|
-              legal += lc[:accessCodes] += lc[:useCodes] += lc[:otherCons]
-            end
-            json.rights legal.empty? ? nil : legal.join('; ')
-            json.provenance do
-              json.annotation 'Generated using the ADIwg mdTranslator, http://mdtranslator.adiwg.org'
-            end
+            def self.startWriter(intObj, responseObj)
+               @contacts = intObj[:contacts]
 
-            mri = []
-            dInfo.each { |di| di[:distOrderProcs].each { |dop| mri << dop[:orderInstructions] } }
-            json.materialRequestInstructions mri.empty? ? nil : mri.join('; ')
+               # set output flag for null properties
+               Jbuilder.ignore_nil(!responseObj[:writerShowTags])
 
-            json.contacts json_map(_intObj[:contacts].select! { |c| !(c[:internal]) }, Contact)
+               # set the format of the output file based on the writer specified
+               responseObj[:writerFormat] = 'json'
+               responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::SbJson::VERSION
 
-            # grab links from citation, additionalDocumentation, distributionInfo
-            wl = []
-            wl += cite[:citOlResources]
-            dInfo.each { |di| di[:distTransOptions].each { |dto| wl += dto[:online] } }
-            _intObj[:metadata][:additionalDocuments].each { |ad| wl += ad[:citation][:citOlResources] }
+               # write the sbJson metadata record
+               metadata = SbJson.build(intObj, responseObj)
 
-            json.webLinks(wl) do |lnk|
-              json.type 'webLink'
-              json.typeLabel 'Web Link'
-              json.uri lnk[:olResURI]
-              json.title lnk[:olResName]
-            end unless wl.empty?
+               # set writer pass to true if no messages
+               # false or warning state will be set by writer code
+               responseObj[:writerPass] = true if responseObj[:writerMessages].empty?
 
-            tags = []
-            rInfo[:topicCategories].each do |tc|
-              tags << { type: 'Label',
-                        scheme: 'ISO 19115 Topic Categories',
-                        name: tc }
-            end
-            rInfo[:descriptiveKeywords].each do |kw|
-              type = kw[:keyTheCitation].fetch(:citTitle, kw[:keywordType]) || 'Theme'
-              scheme = kw[:keyTheCitation].fetch(:citOlResources, [])
-              kw[:keyword].each do |_k|
-                tags << { type: type,
-                          scheme: scheme.empty? ? 'None' : scheme.first[:olResURI],
-                          name: _k }
-              end
+               # encode the metadata target as JSON
+               metadata.target!
             end
-            json.tags(tags)
 
-            dates = cite[:citDate]
-            tp = rInfo[:timePeriod]
-            unless  tp.empty?
-              dates << { dateType: 'Start', dateTime: tp[:beginTime][:dateTime].to_datetime
-              } unless tp[:beginTime].empty?
-              dates << { dateType: 'End', dateTime: tp[:endTime][:dateTime].to_datetime
-              } unless tp[:endTime].empty?
-
-            end
-            json.dates(dates) do |dt|
-              json.type dt[:dateType]
-              json.dateString dt[:dateTime].strftime('%F')
-              json.label dt[:dateType].split(/(?=[A-Z])/).join(' ').capitalize
+            # find contact in contact array and return the contact hash
+            def self.getContact(contactIndex)
+               if @contacts[contactIndex]
+                  return @contacts[contactIndex]
+               end
+               {}
             end
 
-            json.spatial Spatial.build(rInfo[:extents])
-            json.facets Facet.build(rInfo)
-          end
-
-          # set writer pass to true if no messages
-          # false or warning will be set by code that places the message
-          responseObj[:writerPass] = true if responseObj[:writerMessages].empty?
-
-          # j = JSON.parse(metadata.target!)
-          # puts JSON.pretty_generate(j)
-
-          metadata.target!
-        end
+            # ignore jBuilder object mapping when array is empty
+            def self.json_map(collection = [], _class)
+               if collection.nil? || collection.empty?
+                  return nil
+               else
+                  collection.map { |item| _class.build(item).attributes! }
+               end
+            end
 
-        # find contact in contact array and return the contact hash
-        def self.getContact(contactID)
-          @intObj[:contacts].each do |hContact|
-            return hContact if hContact[:contactId] == contactID
-          end
-          {}
-        end
+         end
       end
-    end
-  end
+   end
 end

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_citation.rb

@@ -0,0 +1,79 @@
+# sbJson 1.0 writer
+
+# History:
+#  Stan Smith 2017-05-16 original script
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module SbJson
+
+            module Citation
+
+               # build from citation as follows ...
+               # names, [] {citation.responsibleParty[]}
+               # dates(type), [] {citation.dates[]}
+               # title, {citation.title}
+               # uri, [] {citation.onlineResource[]}
+               def self.build(hCitation)
+
+                  citation = ''
+
+                  # names
+                  indexes = []
+                  hCitation[:responsibleParties].each do |hResponsibility|
+                     hResponsibility[:parties].each do |hParty|
+                        indexes << hParty[:contactIndex]
+                        hParty[:organizationMembers].each do |hMember|
+                           indexes << hMember[:contactIndex]
+                        end
+                     end
+                  end
+                  indexes.uniq!
+                  indexes.each do |index|
+                     hContact = ADIWG::Mdtranslator::Writers::SbJson.getContact(index)
+                     unless hContact.empty?
+                        unless hContact[:name].nil?
+                           citation += hContact[:name] + ', '
+                        end
+                     end
+                  end
+
+                  # dates
+                  hCitation[:dates].each do |hDate|
+                     date = hDate[:date]
+                     dateRes = hDate[:dateResolution]
+                     unless date.nil?
+                        case dateRes
+                           when 'Y', 'YM', 'YMD'
+                              dateStr = AdiwgDateTimeFun.stringDateFromDateTime(date, dateRes)
+                           else
+                              dateStr = AdiwgDateTimeFun.stringDateTimeFromDateTime(date, dateRes)
+                        end
+                        citation += dateStr.to_s + '(' + hDate[:dateType] + '), '
+                     end
+                  end
+
+                  # title
+                  citation += hCitation[:title] + ', '
+
+                  # uri
+                  hCitation[:onlineResources].each do |hOnline|
+                     citation += hOnline[:olResURI] + ', '
+                  end
+
+                  # clean off last comma
+                  if citation.length > 0
+                     citation = citation[0...-2]
+                  end
+
+                  citation
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_id.rb

@@ -0,0 +1,54 @@
+# sbJson 1.0 writer
+
+# History:
+#  Stan Smith 2017-05-15 refactored for mdJson/mdTranslator 2.0
+#  Josh Bradley original script
+
+require 'uuidtools'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module SbJson
+
+            module Id
+
+               # use metadataInfo identifier
+               # else use citation identifier [0]
+               # else use generated UUID
+               def self.build(intObj)
+
+                  metadataInfo = intObj[:metadata][:metadataInfo]
+                  resourceInfo = intObj[:metadata][:resourceInfo]
+                  hIdentifier = metadataInfo[:metadataIdentifier]
+                  hCitation = resourceInfo[:citation]
+
+                  id = nil
+                  metadataId = nil
+                  citationId = nil
+                  unless hIdentifier.empty?
+                     metadataId = hIdentifier[:identifier]
+                  end
+
+                  unless hCitation.empty?
+                     unless hCitation[:identifiers].empty?
+                        citationId = hCitation[:identifiers][0][:identifier]
+                     end
+                  end
+
+                  if !metadataId.nil?
+                     id = metadataId
+                  elsif !citationId.nil?
+                     id = citationId
+                  else
+                     id = UUIDTools::UUID.random_create.to_s
+                  end
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_identifier.rb

@@ -1,23 +1,30 @@
+# sbJson 1.0 writer
+
+# History:
+#  Stan Smith 2017-05-16 refactored for mdTranslator 2.0
+#  Json Bradley original script
+
 require 'jbuilder'
 
 module ADIWG
-  module Mdtranslator
-    module Writers
-      module SbJson
-        module Identifier
-          def self.build(intObj)
-            Jbuilder.new do |json|
-              json.type intObj[:identifierType]
-              json.scheme intObj[:identifierNamespace] ||
-                          unless intObj[:identifierCitation].empty?
-                            intObj[:identifierCitation][:citOlResources][0][:olResURI] unless intObj[:identifierCitation][:citOlResources].empty?
-                          end ||
-                          'https://www.sciencebase.gov/vocab/category/item/identifier'
-              json.key intObj[:identifier]
+   module Mdtranslator
+      module Writers
+         module SbJson
+
+            module Identifier
+
+               def self.build(hIdentifier)
+
+                  Jbuilder.new do |json|
+                     json.key hIdentifier[:identifier]
+                     json.scheme hIdentifier[:namespace]
+                     json.type hIdentifier[:description]
+                  end
+               end
+
             end
-          end
-        end
+
+         end
       end
-    end
-  end
+   end
 end

data/lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_sbJson.rb

@@ -0,0 +1,57 @@
+# sbJson 1.0 writer
+
+# History:
+#  Stan Smith 2017-05-12 refactored for mdJson/mdTranslator 2.0
+#  Josh Bradley original script
+
+require 'jbuilder'
+require_relative 'sbJson_id'
+require_relative 'sbJson_citation'
+require_relative 'sbJson_identifier'
+
+module ADIWG
+   module Mdtranslator
+      module Writers
+         module SbJson
+
+            def self.build(intObj, responseObj)
+
+               resourceInfo = intObj[:metadata][:resourceInfo]
+               hCitation = resourceInfo[:citation]
+
+               @Namespace = ADIWG::Mdtranslator::Writers::SbJson
+
+               Jbuilder.new do |json|
+
+                  # id
+                  json.id Id.build(intObj)
+
+                  # title / alternateTitles (incorporates subTitle)
+                  unless hCitation.empty?
+                     json.title hCitation[:title]
+                     json.alternateTitles hCitation[:alternateTitles] unless hCitation[:alternateTitles].empty?
+                  end
+
+                  # body / summary
+                  json.body resourceInfo[:abstract]
+                  json.summary resourceInfo[:shortAbstract]
+
+                  # citation / identifier
+                  unless hCitation.empty?
+                     json.citation Citation.build(hCitation)
+                     json.identifiers @Namespace.json_map(hCitation[:identifiers], Identifier)
+                  end
+
+                  # purpose
+                  json.purpose resourceInfo[:purpose]
+
+                  # rights
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/writers/sbJson/version.rb

@@ -1,13 +1,17 @@
+# History version 1
+#  Stan Smith 2017-05-12 refactored for mdJson/mdTranslator 2.0
+
+# History version 0
+#  Josh Bradley
+
 module ADIWG
-    module Mdtranslator
-        module Writers
-            module SbJson
+   module Mdtranslator
+      module Writers
+         module SbJson
 
-                # current version of mdJson writer,
-                # corresponds to mdJson output
-                VERSION = '0.0.0'
+            VERSION = '1.0.0'
 
-            end
-        end
-    end
+         end
+      end
+   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adiwg-mdtranslator
 version: !ruby/object:Gem::Version
-  version: 2.0.0rc2
+  version: 2.0.0rc3
 platform: ruby
 authors:
 - Stan Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-01 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: adiwg-mdcodes
   requirement: !ruby/object:Gem::Requirement
@@ -165,34 +165,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: rgeo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
 description: 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
@@ -609,9 +581,12 @@ files:
 - lib/adiwg/mdtranslator/writers/sbJson/readme.md
 - lib/adiwg/mdtranslator/writers/sbJson/sbJson_writer.rb
 - lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_base.rb
+- lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_citation.rb
 - lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_contact.rb
 - lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_facet.rb
+- lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_id.rb
 - lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_identifier.rb
+- lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_sbJson.rb
 - lib/adiwg/mdtranslator/writers/sbJson/sections/sbJson_spatial.rb
 - lib/adiwg/mdtranslator/writers/sbJson/version.rb
 - lib/adiwg/mdtranslator_cli.rb