adiwg-mdcodes 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2234c19c3daf94bfdd3bb4b8be231da2a45f270
-  data.tar.gz: 748870ce439720fc03791d5c42fe2f703cf2ee07
+  metadata.gz: a40a9ab950a81d61db62806c5fb9a799926dbf83
+  data.tar.gz: a9ea92833aaa1c2f5bca91ffeda9db5bbab39757
 SHA512:
-  metadata.gz: b816d007176514a1edefde2b8d01718020a9beb624f7362bf4cd5a23035e7ffa3df15bdd9a9359715cbab01218afc2555fe2eb5316e1f4a721425494098dcd40
-  data.tar.gz: ac4146692c4144b52deff5ce9b143ccec92af7ef77ba7fc68aa2390a1deefd7f2bcdec3e12b61690d5f2186368e470c548f87f8ed172c6298358952cfb8b6f4b
+  metadata.gz: 78e6f7d5214af91979ed6acae03193be84013fae9005451991022830a2f18908e17030bd724e299f159f0a6b79a100b63594f6cb81f411dc592c820f092212d2
+  data.tar.gz: 70fa5577ac472dfeac7091c837e5cc3d6c9dea642c2dcb4cc16886403179fd274f395be523282329ab5de8f912c4ad66d657351b4537842a761ea558b5a20ad9

data/lib/adiwg/mdcodes.rb

@@ -1,99 +1,109 @@
-# Mdcodes - ADIwg codeLists to be used with adiwgJson and mdEditor
-# ... codeLists are maintained in a YAML file 'mdCodes.yml'
-# ... the Mdcodes module has methods to access and return codeLists
+# Mdcodes - ADIwg codelists to be used with adiwgJson and mdEditor
+# ... codelists are maintained in a YAML file 'mdCodes.yml'
+# ... the Mdcodes module has methods to access and return codelists
 
 # History:
+#  Stan Smith 2017-08-08 add deprecated parameter to codelists
+#  Stan Smith 2014-12-18 split codelists into individual YAML file
+#  Stan Smith 2014-11-10 added README.md text
+#  Stan Smith 2014-11-10 added support for JSON returns
+#  Josh Bradley 2014-11-07 moved resources directory outside lib, add getYamlPath
+#  Stan Smith 2014-11-07 add methods to return only codeNames
 # 	Stan Smith 2014-11-07 original script
-#   Stan Smith 2014-11-07 add methods to return only codeNames
-#   Josh Bradley 2014-11-07 moved resources directory outside lib, add getYamlPath
-#   Stan Smith 2014-11-10 added support for JSON returns
-#   Stan Smith 2014-11-10 added README.md text
-#   Stan Smith 2014-12-18 split codelists into individual YAML file
-
-# add main directories to load_path
 
 require 'yaml'
 require 'json'
 
 module ADIWG
-    module Mdcodes
+   module Mdcodes
 
-        # return the path to yaml files.
-        def self.getYamlPath
-            File.join(File.dirname(File.expand_path(__FILE__)),'..','..','resources')
-        end
+      # return the path to yaml files.
+      def self.getYamlPath
+         File.join(File.dirname(File.expand_path(__FILE__)), '..', '..', 'resources')
+      end
 
-        # return all codelists with full details
-        def self.getAllCodeistsDetail(format='hash')
-            path = getYamlPath + '/*.yml'
-            hCodeLists = {}
-            Dir.glob(path) do |item|
-                hCodeList = YAML.load_file(item)
-                hCodeLists[hCodeList['codelistName']] = hCodeList
+      # return all codelists with all elements
+      def self.getAllCodelistsDetail(format='hash', showDeprecated=false)
+         path = getYamlPath + '/*.yml'
+         hCodelists = {}
+         Dir.glob(path) do |item|
+            hCodelist = YAML.load_file(item)
+            hCodelists[hCodelist['codelistName']] = hCodelist
+         end
+         unless showDeprecated
+            hCodelists.each do |key, value|
+               aKeepItems = []
+               value['codelist'].each do |item|
+                  if item.has_key?('deprecated')
+                     unless item['deprecated']
+                        aKeepItems << item
+                     end
+                  else
+                     aKeepItems << item
+                  end
+                  value['codelist'] = aKeepItems
+               end
             end
-			if format == 'json'
-				return hCodeLists.to_json
-			else
-				return hCodeLists
-			end
-        end
+         end
+         return hCodelists.to_json if format == 'json'
+         return hCodelists
+      end
 
-        # return a single codelist with full details
-        def self.getCodelistDetail(codeList, format='hash')
-            file = File.join(getYamlPath, codeList + '.yml')
-            if File.exist?(file)
-                hCodeList = YAML.load_file(file)
-            else
-                return nil
+      # return a single codelist with all elements
+      def self.getCodelistDetail(codelist, format='hash', showDeprecated=false)
+         file = File.join(getYamlPath, codelist + '.yml')
+         if File.exist?(file)
+            hCodelist = YAML.load_file(file)
+            unless showDeprecated
+               aKeepItems = []
+               hCodelist['codelist'].each do |item|
+                  if item.has_key?('deprecated')
+                     unless item['deprecated']
+                        aKeepItems << item
+                     end
+                  else
+                     aKeepItems << item
+                  end
+                  hCodelist['codelist'] = aKeepItems
+               end
             end
-			if format == 'json'
-				return hCodeList.to_json
-			else
-				return hCodeList
-			end
-        end
+         else
+            return nil
+         end
+         return hCodelist.to_json if format == 'json'
+         return hCodelist
+      end
 
-        # return all static codelist with only the item names
-        def self.getAllStaticCodelists(format='hash')
-            codeLists = getAllCodeistsDetail
-            hCodeLists = {}
-            codeLists.each do |key, value|
-                if value['codelistType'] == 'staticList'
-                    aItems = value['codelist']
-                    aList = []
-                    aItems.each do |item|
-                        aList << item['codeName']
-                    end
-                    hCodeLists[key] = aList
-                end
+      # return all codelist with only the codeName
+      def self.getAllStaticCodelists(format='hash', showDeprecated=false)
+         hCodelists = {}
+         codelists = getAllCodelistsDetail('hash', showDeprecated)
+         codelists.each do |key, value|
+            aList = []
+            value['codelist'].each do |item|
+               aList << item['codeName']
             end
-			if format == 'json'
-				hCodeLists.to_json if format == 'json'
-			else
-				return hCodeLists
-			end
-        end
+            hCodelists[key] = aList
+         end
+         return hCodelists.to_json if format == 'json'
+         return hCodelists
+      end
 
-        # return a single static codelist with only the item names
-        def self.getStaticCodelist(codeList, format='hash')
-            hCodeList = getCodelistDetail(codeList)
-            if hCodeList
-                hCodeNames = {}
-                aItems = hCodeList['codelist']
-                aList = []
-                aItems.each do |item|
-                    aList << item['codeName']
-                end
-                hCodeNames[hCodeList['codelistName']] = aList
-                if format == 'json'
-                    return hCodeNames.to_json
-                else
-                    return hCodeNames
-                end
-            else
-                return nil
+      # return a single codelist with only the codeName
+      def self.getStaticCodelist(codelist, format='hash', showDeprecated=false)
+         hCodelist = getCodelistDetail(codelist, 'hash', showDeprecated)
+         unless hCodelist.nil?
+            hCodeNames = {}
+            aList = []
+            hCodelist['codelist'].each do |item|
+               aList << item['codeName']
             end
-        end
+            hCodeNames[hCodelist['codelistName']] = aList
+            return hCodeNames.to_json if format == 'json'
+            return hCodeNames
+         end
+         return nil
+      end
 
-    end
+   end
 end

data/lib/adiwg/mdcodes/version.rb

@@ -1,6 +1,8 @@
 # adiwg mdCodes
 
 # version 2 history
+# 2.3.0 2017-08-01 added showDeprecated parameter to mdCodes methods
+# 2.3.0 2017-08-01 change to associationTypes: revised definitions, deprecated some codes
 # 2.2.0 2017-06-29 added adiwg namespace codelist
 # 2.1.7 2017-06-08 added scienceBase date codes to dateType
 # 2.1.6 2017-05-16 added 'isoTopicCategory' to keyword type code list
@@ -12,7 +14,6 @@
 # 2.1.0 2016-11-27 added 10 MI codelists
 
 # version 1 history
-
 # 0.1.0 2014-11-05 first release
 # 0.1.1 2014-11-06 added factSheet to scope
 # 0.2.0 2014-11-07 add option to return only codeNames
@@ -29,6 +30,6 @@
 
 module ADIWG
    module Mdcodes
-      VERSION = "2.2.2"
+      VERSION = "2.3.0"
    end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdcodes",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "CodeLists for ADIwg mdJSON",
   "repository": {
     "type": "git",

data/resources/adiwg_metadataRepository.yml

@@ -12,3 +12,4 @@ codelist:
   - {code: "cdddf5c7-eec4-4e0c-9b54-d75b763a88fc", codeName: data.gov, description: "U.S. Government repository of open data"}
   - {code: "da0336c4-a8f6-4010-99b3-1b848d14ff2f", codeName: ScienceBase, description: "U.S. Geological Survey repository for data and metadata"}
   - {code: "b1d2ffbe-0b64-40fe-890a-02c4f0b6b9b4", codeName: ScienceCatalog, description: "U.S. Geological Survey inventory for data and metadata"}
+  - {code: "a791e961-f2d4-4be4-ab3c-1cdf8fd025b9", codeName: LCCScienceCatalog, description: "Repository of Landscape Conservation Cooperative projects and data products."}

data/resources/iso_associationType.yml

@@ -10,19 +10,24 @@ sourceName: "DS_AssociationTypeCode"
 extensible: true
 description: "justification for the correlation of two resources (datasets or projects)"
 codelist:
-  - {code: "001", codeName: crossReference, description: "reference from one resource (dataset or project) to another"}
-  - {code: "002", codeName: largerWorkCitation, description: "reference to a master resource (dataset or project) of which this one is a part"}
-  - {code: "003", codeName: partOfSeamlessDatabase, description: "part of the same structured set of data held in a computer"}
-  - {code: "004", codeName: source, description: "mapping and charting information from which the dataset content originates"}
-  - {code: "005", codeName: stereoMate, description: "part of a set of imagery that when used together, provides three-dimensional images"}
-  - {code: "006", codeName: isComposedOf, description: "reference to resources (datasets or projects) that are parts of this resource"}
-  - {code: "007", codeName: collectiveTitle, description: "common title for a collection of resources. NOTE Title identifies elements of a series collectively, combined with information about what volumes are available at the source cite."}
-  - {code: "008", codeName: series, description: "associated through a common heritage such as produced to a common product specification"}
-  - {code: "009", codeName: dependency, description: "associated through a dependency"}
-  - {code: "010", codeName: revisionOf, description: "resource is a revision of associated resource"}
-  - {code: "adiwg001", codeName: projectProduct, description: "products developed as deliverables of a project or program (DEPRECATED: use productOf)"}
-  - {code: "adiwg002", codeName: supplementalResource, description: "supplemental resource"}
-  - {code: "adiwg003", codeName: produced, description: "reference to a product or deliverable produced by the resource (e.g. project or program)"}
-  - {code: "adiwg004", codeName: productOf, description: "reference to a project or program which produced the resource as a deliverable"}
-  - {code: "adiwg005", codeName: mainprojectOf, description: "reference to a project which is a derivative of the resource"}
-  - {code: "adiwg006", codeName: subprojectOf, description: "reference to a project of which the resource is a derivative"}
+  - {code: "001", codeName: crossReference, description: "the associated resource is a reference to another dataset or project"}
+  - {code: "002", codeName: largerWorkCitation, description: "the associated resource is a citation to a master resource of the main resource"}
+  - {code: "003", codeName: partOfSeamlessDatabase, description: "the associated resource is a part of the same structured dataset as the main resource"}
+  - {code: "004", codeName: source, description: "the associated resource is mapping and charting information from which the main resource content originates"}
+  - {code: "005", codeName: stereoMate, description: "the associated resource is part of a set of imagery that when used together provide three-dimensional images"}
+  - {code: "006", codeName: isComposedOf, description: "the associated resource is a dataset or project that is part of the main resource"}
+  - {code: "007", codeName: collectiveTitle, description: "the associated resource is a common title for a collection of resources. NOTE Title identifies elements of a series collectively, combined with information about what volumes are available at the source cite."}
+  - {code: "008", codeName: series, description: "the associated resource was produced via the same product specifications as the main resource"}
+  - {code: "009", codeName: dependency, description: "the associated resource is dependent on the main resource"}
+  - {code: "010", codeName: revisionOf, description: "the main resource is a revision of the associated resource"}
+  - {code: "adiwg001", codeName: projectProduct, description: "DEPRECATED: use product", deprecated: true}
+  - {code: "adiwg002", codeName: supplementalResource, description: "the associated resource is a supplemental resource to the main resource"}
+  - {code: "adiwg003", codeName: produced, description: "DEPRECATED: use product", deprecated: true}
+  - {code: "adiwg004", codeName: productOf, description: "DEPRECATED: use parentProject", deprecated: true}
+  - {code: "adiwg005", codeName: mainProjectOf, description: "DEPRECATED: use subProject", deprecated: true}
+  - {code: "adiwg006", codeName: subProjectOf, description: "DEPRECATED: use parentProject", deprecated: true}
+  - {code: "adiwg007", codeName: product, description: "the associated resource is a product developed as deliverable of the main resource"}
+  - {code: "adiwg008", codeName: parentProject, description: "the associated resource is a parent project of the main resource"}
+  - {code: "adiwg009", codeName: subProject, description: "the associated resource is sub-project or task of the main resource"}
+  - {code: "adiwg010", codeName: derivativeProduct, description: "the associated resource is product derived from main resource"}
+  - {code: "adiwg011", codeName: alternate, description: "the associated resource is an alternate reference for the main resource"}

data/test/tc_mdcodes.rb

@@ -6,49 +6,71 @@
 =end
 
 require 'minitest/autorun'
-require File.join(File.dirname(__FILE__),'..','lib', 'adiwg-mdcodes.rb')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'adiwg-mdcodes.rb')
 
 class TestMdcodes < Minitest::Test
-  def test_parseYaml
-    @errors = Array.new
 
-    FileList[ADIWG::Mdcodes.getYamlPath + '**/*.yml'].each do |fname|
-      begin YAML.load_file(fname)
-      rescue Exception
-        @errors << "Could not parse YAML: #{fname}"
+   def test_parseYaml
+      @errors = Array.new
+
+      path = ADIWG::Mdcodes.getYamlPath
+      Dir["#{File.join(path, '**/*.yml')}"].each do |fname|
+         begin
+            YAML.load_file(fname)
+         rescue Exception
+            @errors << "Could not parse YAML: #{fname}"
+         end
+      end
+      assert(@errors.empty?, @errors.join("\n"))
+   end
+
+   def test_yamlResourceDir
+      yamlDir = ADIWG::Mdcodes.getYamlPath
+      assert(Dir.exist?(yamlDir), 'Did not find resource Directory.')
+   end
+
+   def test_getAllCodelistsDetail
+      assert_instance_of(Hash, ADIWG::Mdcodes.getAllCodelistsDetail)
+   end
+
+   def test_getCodelistDetail
+      yaml = ADIWG::Mdcodes.getAllCodelistsDetail
+      refute_empty(yaml)
+
+      yaml.keys.each do |key|
+         assert_instance_of(Hash, ADIWG::Mdcodes.getCodelistDetail(key), 'Failed to load ' + key)
       end
-    end
-    assert(@errors.empty?, @errors.join("\n"))
-  end
-
-  def test_yamlResourceDir
-    yamlDir = ADIWG::Mdcodes.getYamlPath
-    assert(Dir.exist?(yamlDir), 'Did not find resource Directory.')
-  end
-
-  def test_getAllCodeistsDetail
-    assert_instance_of(Hash,ADIWG::Mdcodes.getAllCodeistsDetail)
-  end
-
-  def test_getCodelistDetail
-    yaml = ADIWG::Mdcodes.getAllCodeistsDetail
-    refute_empty(yaml)
-
-    yaml.keys.each do |key|
-      assert_instance_of(Hash,ADIWG::Mdcodes.getCodelistDetail(key), 'Failed to load ' + key)
-    end
-  end
-
-  def test_getAllStaticCodelists
-    assert_instance_of(Hash,ADIWG::Mdcodes.getAllStaticCodelists)
-  end
-
-  def test_getStaticCodelist
-    yaml = ADIWG::Mdcodes.getAllStaticCodelists
-    refute_empty(yaml)
-
-    yaml.keys.each do |key|
-      assert_instance_of(Hash,ADIWG::Mdcodes.getStaticCodelist(key), 'Failed to load ' + key)
-    end
-  end
+   end
+
+   def test_getAllStaticCodelists
+      assert_instance_of(Hash, ADIWG::Mdcodes.getAllStaticCodelists)
+   end
+
+   def test_getStaticCodelist
+      yaml = ADIWG::Mdcodes.getAllStaticCodelists
+      refute_empty(yaml)
+
+      yaml.keys.each do |key|
+         assert_instance_of(Hash, ADIWG::Mdcodes.getStaticCodelist(key), 'Failed to load ' + key)
+      end
+   end
+
+   def test_getStaticCodelist_deprecated
+      yaml = ADIWG::Mdcodes.getStaticCodelist('iso_associationType')
+      yamlDeprecated = ADIWG::Mdcodes.getStaticCodelist('iso_associationType', 'hash', true)
+
+      refute_empty yaml['iso_associationType']
+      refute_empty yamlDeprecated['iso_associationType']
+      assert (yaml['iso_associationType'].length < yamlDeprecated['iso_associationType'].length)
+   end
+
+   def test_getAllCodelistsDetail_deprecated
+      yaml = ADIWG::Mdcodes.getAllCodelistsDetail
+      yamlDeprecated = ADIWG::Mdcodes.getAllCodelistsDetail('hash', true)
+
+      refute_empty yaml['iso_associationType']['codelist']
+      refute_empty yamlDeprecated['iso_associationType']['codelist']
+      assert (yaml['iso_associationType']['codelist'].length < yamlDeprecated['iso_associationType']['codelist'].length)
+   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adiwg-mdcodes
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - stansmith907, jlblcc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: adiwg-mdcodes provides code lists for mdJSON.