adiwg-mdcodes 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27148550d8503791cdf58ffb8cd0e012a1a23fb7
-  data.tar.gz: 9ce920947a7ec0284261dab3815a6bd4176a06f1
+  metadata.gz: 37ecaa1334498a0080c166f560554c569a46204b
+  data.tar.gz: b1ebf196e720456a10bde7cb37dd277ead3e6fed
 SHA512:
-  metadata.gz: ab38525674af2337f43c43064460c2c07079a02cc032b4a90aff8d570946f367d7040ff5d9492a4f5ea9b352e9ba863d28ebab7b564d504f4a8424bd81c17efb
-  data.tar.gz: fc87fdc70f80994986fd2e8afb8089dfd9c818007bda3b7e2a504ea87c8fb28c48d5691c203b2ff3d0be2b8e5f49a9a72c0b88288c5ebdc7372d9e494dad5306
+  metadata.gz: b6db8a7e0fc48dad7078509cda40170088df6f8d1a49465fbdfbb9d0d0fb72596e7aeb2d74e709fd74130b8bd7d6e08f66e8f5617b8fd4b96cdcc3cddd360d4c
+  data.tar.gz: fddb686c897c9152d01cdc30fa45e539ca6eb5c845298f3f3e57a1db309d86e9c5ecda69a4b2a3a59658f79d17cd633da216e80b84933aefa28909dd59e0fb9f

data/.gitignore

@@ -1,5 +1,5 @@
 /.project
-/resources/json/mdcodes.json
+/resources/json
 *.gem
 *.rbc
 .bundle
@@ -15,10 +15,10 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-test/dev.rb
 test/tmp
 test/version_tmp
 tmp
+dev
 *.bundle
 *.so
 *.o

data/README.md

@@ -1,13 +1,19 @@
 [![Build Status](https://travis-ci.org/adiwg/mdCodes.svg)](https://travis-ci.org/adiwg/mdCodes)
 [![Gem Version](https://badge.fury.io/rb/adiwg-mdcodes.svg)](http://badge.fury.io/rb/adiwg-mdcodes)
 
-# Mdcodes
+# mdCodes
 
-adiwg-mdcodes provides code lists in hash or JSON formats for loading of mdEditor and other metadata
-tools that use the adiwg-json-schema.  The code lists include all ISO 19115-2 and ISO 19115-1 codes plus
-supplemental codes added NGDC and ADIwg.
+mdCodes provides code lists in hash or JSON formats for loading of mdEditor and other metadata
+tools that use the ADIwg [mdJson-schemas](https://github.com/adiwg/mdJson-schemas).  The code lists
+include all ISO 19115-2 and ISO 19115-1 codes plus supplemental codes added by NGDC and ADIwg. The
+code lists may be accessed in Ruby using the gem. Alternatively, JSON may be generated from the YAML
+using [Grunt](http://gruntjs.com/getting-started). See the following for instructions.
 
-## Installation
+## Ruby
+
+The adiwg-mdcodes gem provides code lists in Ruby hash or JSON formats.
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -22,29 +28,40 @@ Or install it yourself as:
     $ gem install adiwg-mdcodes
 
 
-## Methods
+### Methods
 
-### getYamlPath
-> returns the path to the YAML file of code lists.
+#### getYamlPath
+> returns the path to the 'resources' folder containing codelist files in YAML format'.
 
-### getCodeLists( returnFormat )
-> returns all code lists with all code list data
+#### getAllCodelistsDetail( returnFormat )
+> returns all code lists with all codelist detail
 > returnFormat = \[__hash__ | json] (string)
 
-### getCodeList( codeListName, returnFormat )
-> returns a single code list with all code list data
+#### getCodelistDetail( codeListName, returnFormat )
+> returns a single codelist with all code list detail
 > codeListName = name of code list to return (string)
 > returnFormat = \[ __hash__ | json ] (string)
 
-### getCodeNames( returnFormat )
-> returns all code lists with only the code list item names
+#### getAllStaticCodelists( returnFormat )
+> returns all static codelists with only the codelist item names
 > returnFormat = \[__hash__ | json] (string)
 
-### getCodeName( codeListName, returnFormat )
-> returns a single code list with only the code list item names
+#### getStaticCodelist( codeListName, returnFormat )
+> returns a single static codelist with only the codelist item names
 > codeListName = name of code list to return (string)
 > returnFormat = \[__hash__ | json] (string)
 
+##Grunt
+
+Generate JSON verions of the code lists using Grunt.
+
+**Note**: These instructions assume that [npm](https://docs.npmjs.com/) and [Grunt](http://gruntjs.com/getting-started) are already installed. The generated
+files are not tracked by git.
+
+1. Change to the project's root directory.
+2. Install project dependencies with ```npm install```.
+3. Generate the JSON code lists with ```grunt```.
+4. The JSON is written to the *resources/json* directory.
 
 ## Contributing
 

data/lib/adiwg/mdcodes.rb

@@ -8,6 +8,7 @@
 #   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
 
@@ -15,29 +16,36 @@ require 'yaml'
 require 'json'
 
 module ADIWG
-
     module Mdcodes
-        # return the path to yaml file.
+
+        # return the path to yaml files.
         def self.getYamlPath
-            File.join(File.dirname(__FILE__),'..','..','resources','mdcodes.yml')
+            File.join(File.dirname(__FILE__),'..','..','resources')
         end
 
-        # read the yml file into ruby
-        def self.getCodeLists(format='hash')
-            file = getYamlPath
-			codes = YAML.load_file(file)
+        # 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
+            end
 			if format == 'json'
-				return codes.to_json
+				return hCodeLists.to_json
 			else
-				return codes
+				return hCodeLists
 			end
         end
 
-        # return a single code list
-        def self.getCodeList(codeList, format='hash')
-            codeLists = getCodeLists
-            hCodeList = {}
-            hCodeList[codeList] = codeLists[codeList]
+        # 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
+            end
 			if format == 'json'
 				return hCodeList.to_json
 			else
@@ -45,42 +53,47 @@ module ADIWG
 			end
         end
 
-        # return only code names
-        def self.getCodeNames(format='hash')
-            codeLists = getCodeLists
-            hCodeNames = {}
+        # return all static codelist with only the item names
+        def self.getAllStaticCodelists(format='hash')
+            codeLists = getAllCodeistsDetail
+            hCodeLists = {}
             codeLists.each do |key, value|
-                aItems = value['items']
-                aList = []
-                aItems.each do |item|
-                    aList << item['codeName']
+                if value['codelistType'] == 'staticList'
+                    aItems = value['codelist']
+                    aList = []
+                    aItems.each do |item|
+                        aList << item['codeName']
+                    end
+                    hCodeLists[key] = aList
                 end
-                hCodeNames[key] = aList
-			end
+            end
 			if format == 'json'
-				return hCodeNames.to_json
+				hCodeLists.to_json if format == 'json'
 			else
-				return hCodeNames
+				return hCodeLists
 			end
         end
 
-        # return a single code name list
-        def self.getCodeName(codeList, format='hash')
-            hCodeList = getCodeList(codeList)
-            hCodeNames = {}
-            aItems = hCodeList[codeList]['items']
-            aList = []
-            aItems.each do |item|
-                aList << item['codeName']
+        # 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
             end
-            hCodeNames[codeList] = aList
-			if format == 'json'
-				return hCodeNames.to_json
-			else
-				return hCodeNames
-			end
         end
 
     end
-
 end

data/lib/adiwg/mdcodes/version.rb

@@ -7,11 +7,13 @@
 # 0.2.0 2014-11-07 add option to return only codeNames
 #              ... moved resources directory outside of lib
 # 0.2.1 2014-11-10 added support for JSON returns
+# 0.3.0 2014-11-18 added administrator to role codelist
+# 0.4.0 2014-12-18 split codelists into individual YAML file
 
 module ADIWG
 
 	module Mdcodes
-		VERSION = "0.2.1"
+		VERSION = "0.4.0"
 	end
 
 end

data/resources/iso_associationType.yml

@@ -0,0 +1,24 @@
+---
+# mdJson codelists
+# base codelist for ISO 19115-2, 19115-1
+# extended for ADIwg
+
+codelistType: "staticList"
+codelistName: "iso_associationType"
+source: "ISO"
+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"}
+  - {code: "adiwg002", codeName: supplementalResource, description: "supplemental resource"}

data/resources/iso_characterSet.yml

@@ -0,0 +1,39 @@
+---
+# mdJson codelists
+# base codelist for ISO 19115-2, 19115-1
+
+codelistType: "staticList"
+codelistName: "iso_characterSet"
+source: "ISO"
+sourceName: "MD_CharacterSetCode"
+extensible: true
+description: "name of the character coding standard used in the resource"
+codelist:
+  - {code: "001", codeName: ucs2, description: "16-bit fixed size Universal Character Set, based on ISO/IEC 10646"}
+  - {code: "002", codeName: ucs4, description: "32-bit fixed size Universal Character Set, based on ISO/IEC 10646"}
+  - {code: "003", codeName: utf7, description: "7-bit variable size UCS Transfer Format, based on ISO/IEC 10646"}
+  - {code: "004", codeName: utf8, description: "8-bit variable size UCS Transfer Format, based on ISO/IEC 10646"}
+  - {code: "005", codeName: utf16, description: "16-bit variable size UCS Transfer Format, based on ISO/IEC 10646"}
+  - {code: "006", codeName: 8859part1, description: "ISO/IEC 8859-1, Information technology - 8-bit single byte coded graphic character sets - Part 1 : Latin alphabet No.1"}
+  - {code: "007", codeName: 8859part2, description: "ISO/IEC 8859-2, Information technology - 8-bit single byte coded graphic character sets - Part 2 : Latin alphabet No.2"}
+  - {code: "008", codeName: 8859part3, description: "ISO/IEC 8859-3, Information technology - 8-bit single byte coded graphic character sets - Part 3 : Latin alphabet No.3"}
+  - {code: "009", codeName: 8859part4, description: "ISO/IEC 8859-4, Information technology - 8-bit single byte coded graphic character sets - Part 4 : Latin alphabet No.4"}
+  - {code: "010", codeName: 8859part5, description: "ISO/IEC 8859-5, Information technology - 8-bit single byte coded graphic character sets - Part 5 : Latin/Cyrillic alphabet"}
+  - {code: "011", codeName: 8859part6, description: "ISO/IEC 8859-6, Information technology - 8-bit single byte coded graphic character sets - Part 6 : Latin/Arabic alphabet"}
+  - {code: "012", codeName: 8859part7, description: "ISO/IEC 8859-7, Information technology - 8-bit single byte coded graphic character sets - Part 7 : Latin/Greek alphabet"}
+  - {code: "013", codeName: 8859part8, description: "ISO/IEC 8859-8, Information technology - 8-bit single byte coded graphic character sets - Part 8 : Latin/Hebrew alphabet"}
+  - {code: "014", codeName: 8859part9, description: "ISO/IEC 8859-9, Information technology - 8-bit single byte coded graphic character sets - Part 9 : Latin alphabet No.5"}
+  - {code: "015", codeName: 8859part10, description: "ISO/IEC 8859-10, Information technology - 8-bit single byte coded graphic character sets - Part 10 : Latin alphabet No.6"}
+  - {code: "016", codeName: 8859part11, description: "ISO/IEC 8859-11, Information technology - 8-bit single byte coded graphic character sets - Part 11 : Latin/Thai alphabet"}
+  - {code: "018", codeName: 8859part13, description: "ISO/IEC 8859-13, Information technology - 8-bit single byte coded graphic character sets - Part 13 : Latin alphabet No.7"}
+  - {code: "019", codeName: 8859part14, description: "ISO/IEC 8859-14, Information technology - 8-bit single byte coded graphic character sets - Part 14 : Latin alphabet No.8 (Celtic)"}
+  - {code: "020", codeName: 8859part15, description: "ISO/IEC 8859-15, Information technology - 8-bit single byte coded graphic character sets - Part 15 : Latin alphabet No.9"}
+  - {code: "021", codeName: 8859part16, description: "ISO/IEC 8859-16, Information technology - 8-bit single byte coded graphic character sets - Part 16 : Latin alphabet No.10"}
+  - {code: "022", codeName: jis, description: "japanese code set used for electronic transmission"}
+  - {code: "023", codeName: shiftJIS, description: "japanese code set used on MS-DOS machines"}
+  - {code: "024", codeName: eucJP, description: "japanese code set used on UNIX based machines"}
+  - {code: "025", codeName: usAscii, description: "United States ASCII code set (ISO 646 US)"}
+  - {code: "026", codeName: ebcdic, description: "IBM mainframe code set"}
+  - {code: "027", codeName: ecuKR, description: "Korean code set"}
+  - {code: "028", codeName: big5, description: "traditional Chinese code set used in Taiwan, Hong Kong of China and other areas"}
+  - {code: "029", codeName: GB2312, description: "simplified Chinese code set"}

data/resources/iso_classification.yml

@@ -0,0 +1,20 @@
+---
+# mdJson codelists
+# base codelist for ISO 19115-2, 19115-1
+
+codelistType: "staticList"
+codelistName: "iso_classification"
+source: "ISO"
+sourceName: "MD_ClassificationCode"
+extensible: true
+description: "name of the handling restrictions on the dataset"
+codelist:
+  - {code: "001", codeName: unclassified, description: "available for general disclosure"}
+  - {code: "002", codeName: restricted, description: "not for general disclosure"}
+  - {code: "003", codeName: confidential, description: "available for someone who can be entrusted with information"}
+  - {code: "004", codeName: secret, description: "kept or meant to be kept private, unknown, or hidden from all but a select group of people"}
+  - {code: "005", codeName: topSecret, description: "of the highest secrecy"}
+  - {code: "006", codeName: sensitiveButUnclassified, description: "although unclassified, requires strict controls over its distribution"}
+  - {code: "007", codeName: forOfficialUseOnly, description: "unclassified information that is to be used only for official purposes determined by the designating body"}
+  - {code: "008", codeName: protected, description: "compromise of the information could cause damage"}
+  - {code: "009", codeName: limitedDistribution, description: "dissemination limited by designating body"}

data/resources/iso_dataType.yml

@@ -0,0 +1,27 @@
+---
+# mdJson codelists
+# base codelist for ISO 19115-2, 19115-1
+
+codelistType: "staticList"
+codelistName: iso_"dataType"
+source: "ISO"
+sourceName: "MD_DatatypeCode"
+extensible: true
+description: "datatype of element or entity"
+codelist:
+  - {code: "001", codeName: class, description: "descriptor of a set of objects that share the same attributes, operations, methods, relationships, and behavior"}
+  - {code: "002", codeName: codelist, description: "flexible enumeration useful for expressing a long list of values, can be extended"}
+  - {code: "003", codeName: enumerations, description: "data type whose instances form a list of named literal values, not extendable"}
+  - {code: "004", codeName: codelistElement, description: "permissible value for a codelist or enumeration"}
+  - {code: "005", codeName: abstractClass, description: "class that cannot be directly instantiated"}
+  - {code: "006", codeName: aggregateClass, description: "class that is composed of classes it is connected to by an aggregate relationship"}
+  - {code: "007", codeName: specifiedClass, description: "subclass that may be substituted for its superclass"}
+  - {code: "008", codeName: datatypeClass, description: "class with few or no operations whose primary purpose is to hold the abstract state of another class for transmittal, storage, encoding or persistent storage"}
+  - {code: "009", codeName: interfaceClass, description: "named set of operations that characterize the behavior of an element"}
+  - {code: "010", codeName: unionClass, description: "class describing a selection of one of the specified types"}
+  - {code: "011", codeName: metaClass, description: "class whose instances are classes"}
+  - {code: "012", codeName: typeClass, description: "class used for specification of a domain of instances (objects), together with the operations applicable to the objects. A type may have attributes and associations"}
+  - {code: "013", codeName: characterString, description: "free text field"}
+  - {code: "014", codeName: integer, description: "numeric filed"}
+  - {code: "015", codeName: association, description: "semantic relationship between two classes that involves connections among their instances"}
+  - {code: "016", codeName: typeClass, description: "class used for specification of a domain of instances (objects), together with the operations applicable to the objects. A type may have attributes and associations"}

data/resources/iso_dateType.yml

@@ -0,0 +1,27 @@
+---
+# mdJson codelists
+# base codelist for ISO 19115-2, 19115-1
+
+codelistType: "staticList"
+codelistName: "iso_dateType"
+source: "ISO"
+sourceName: "CI_DateTypeCode"
+extensible: true
+description: "identification of when a given event occurred"
+codelist:
+  - {code: "001", codeName: creation, description: "date identifies when the resource was brought into existence"}
+  - {code: "002", codeName: publication, description: "date identifies when the resource was issued"}
+  - {code: "003", codeName: revision, description: "date identifies when the resource was examined or re-examined and improved or amended"}
+  - {code: "004", codeName: expiry, description: "date identifies when resource expires"}
+  - {code: "005", codeName: lastUpdate, description: "date identifies when resource was last updated"}
+  - {code: "006", codeName: lastRevision, description: "date identifies when resource was last reviewed"}
+  - {code: "007", codeName: nextUpdate, description: "date identifies when resource will be next updated"}
+  - {code: "008", codeName: unavailable, description: "date identifies when resource became not available or obtainable"}
+  - {code: "009", codeName: inForce, description: "date identifies when resource became in force"}
+  - {code: "010", codeName: adopted, description: "date identifies when resource was adopted"}
+  - {code: "011", codeName: depreciated, description: "date identifies when resource was deprecated"}
+  - {code: "012", codeName: superseded, description: "date identifies when resource was superseded or replaced by another resource"}
+  - {code: "013", codeName: validityBegins, description: "time at which the data are considered to become valid. NOTE: There could be quite a delay between creation and validity begins"}
+  - {code: "014", codeName: validityExpires, description: "time at which the data are no longer considered to be valid"}
+  - {code: "015", codeName: released, description: "the date that the resource shall be released for public access"}
+  - {code: "016", codeName: distribution, description: "date identifies when an instance of the resource was distributed"}

data/resources/iso_initiativeType.yml

@@ -0,0 +1,26 @@
+---
+# mdJson codelists
+# base codelist for ISO 19115-2, 19115-1
+
+codelistType: "staticList"
+codelistName: "iso_initiativeType"
+source: "ISO"
+sourceName: "DS_InitiativeTypeCode"
+extensible: true
+description: "type of initiative under which the resource was produced - the activity that resulted in the resource"
+codelist:
+   - {code: "001", codeName: campaign, description: "series of organized planned actions"}
+   - {code: "002", codeName: collection, description: "accumulation of datasets assembled for a specific purpose"}
+   - {code: "003", codeName: exercise, description: "specific performance of a function or group of functions"}
+   - {code: "004", codeName: experiment, description: "process designed to find if something is effective or valid"}
+   - {code: "005", codeName: investigation, description: "search or systematic inquiry"}
+   - {code: "006", codeName: mission, description: "specific operation of a data collection system"}
+   - {code: "007", codeName: sensor, description: "device or piece of equipment which detects or records"}
+   - {code: "008", codeName: operation, description: "action that is part of a series of actions"}
+   - {code: "009", codeName: platform, description: "vehicle or other support base that holds a sensor"}
+   - {code: "010", codeName: process, description: "method of doing something involving a number of steps"}
+   - {code: "011", codeName: program, description: "specific planned activity"}
+   - {code: "012", codeName: project, description: "organized undertaking, research, or development"}
+   - {code: "013", codeName: study, description: "examination or investigation"}
+   - {code: "014", codeName: task, description: "piece of work"}
+   - {code: "015", codeName: trial, description: "process of testing to discover or demonstrate something"}

data/resources/iso_keywordType.yml

@@ -0,0 +1,28 @@
+---
+# mdJson codelists
+# base codelist for ISO 19115-2, 19115-1
+# extended for ADIwg
+
+codelistType: "staticList"
+codelistName: "iso_keywordType"
+source: "ISO"
+sourceName: "MD_KeywordTypeCode"
+extensible: true
+description: "methods used to group similar keywords"
+codelist:
+   - {code: "001", codeName: discipline, description: "keyword identifies a branch of instruction or specialized learning"}
+   - {code: "002", codeName: place, description: "keyword identifies a location"}
+   - {code: "003", codeName: stratum, description: "keyword identifies the layer(s) of any deposited substance"}
+   - {code: "004", codeName: temporal, description: "keyword identifies a time period related to the dataset"}
+   - {code: "005", codeName: theme, description: "keyword identifies a particular subject or topic"}
+   - {code: "006", codeName: dataCentre, description: "keyword identifies a repository or archive that manages and distributes data"}
+   - {code: "007", codeName: featureType, description: "keyword identifies a resource containing or about a collection of feature instances with common characteristics"}
+   - {code: "008", codeName: instrument, description: "keyword identifies a device used to measure or compare physical properties"}
+   - {code: "009", codeName: platform, description: "keyword identifies a structure upon which an instrument is mounted"}
+   - {code: "010", codeName: process, description: "keyword identifies a series of actions or natural occurrences"}
+   - {code: "011", codeName: project, description: "keyword identifies an endeavour undertaken to create or modify a product or service"}
+   - {code: "012", codeName: service, description: "keyword identifies an activity carried out by one party for the benefit of another"}
+   - {code: "013", codeName: product, description: "keyword identifies a type of product"}
+   - {code: "014", codeName: subTopicCategory, description: "refinement of a topic category for the purpose of geographic data classification"}
+   - {code: "015", codeName: taxon, description: "keyword identifies a taxonomy of the resource"}
+   - {code: "adiwg001", codeName: region, description: "keyword identifies a known geographic region (such as US Census Area, ecoregion type, etc.)"}