adiwg-mdcodes 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 882a4a567e9fc193221bb5dc67e9b09e25afeb26
-  data.tar.gz: f71051a650b8024d366b5c5babd35c70bd9dfca0
+  metadata.gz: 27148550d8503791cdf58ffb8cd0e012a1a23fb7
+  data.tar.gz: 9ce920947a7ec0284261dab3815a6bd4176a06f1
 SHA512:
-  metadata.gz: 45b87e8aff5350e4a2a8da3aa4f1e328e8a4b6b917565f8f06d42b10071e86d9bea218b847af44c8b28c0715de6624b2acf6c19d57b669d063d44f75673b082c
-  data.tar.gz: e2b73efc0bb18a9bcc538ec83e9c82275d3261033080e2806cdae471b55c7437438d3efef7ee99a0392bf0ab1d86de3c411c7c5dc4081e4358a6e92e20497ad4
+  metadata.gz: ab38525674af2337f43c43064460c2c07079a02cc032b4a90aff8d570946f367d7040ff5d9492a4f5ea9b352e9ba863d28ebab7b564d504f4a8424bd81c17efb
+  data.tar.gz: fc87fdc70f80994986fd2e8afb8089dfd9c818007bda3b7e2a504ea87c8fb28c48d5691c203b2ff3d0be2b8e5f49a9a72c0b88288c5ebdc7372d9e494dad5306

data/.gitignore

@@ -1,3 +1,5 @@
+/.project
+/resources/json/mdcodes.json
 *.gem
 *.rbc
 .bundle
@@ -22,3 +24,4 @@ tmp
 *.o
 *.a
 mkmf.log
+node_modules

data/Gruntfile.js

@@ -0,0 +1,32 @@
+module.exports = function(grunt) {
+
+    // Project configuration.
+    grunt.initConfig({
+        // This line makes your node configurations available for use
+        pkg: grunt.file.readJSON('package.json'),
+        convert: {
+            yml2json: {
+                files: [{
+                    expand: true,
+                    cwd: 'resources/',
+                    src: ['**/*.yml'],
+                    dest: 'resources/json/',
+                    ext: '.json'
+                }]
+            }
+        },
+
+        yamllint: {
+            all: ['resources/**/*.yaml']
+        }
+    });
+    // Each plugin must be loaded following this pattern
+    grunt.loadNpmTasks('grunt-convert');
+    grunt.loadNpmTasks('grunt-yamllint');
+    // Custom task(s).
+    // First argument names the task for use in command line
+    // Second argument is a list of tasks to be run
+    grunt.registerTask('default', ['yamllint:all', 'convert:yml2json']);
+    grunt.registerTask('lint', ['yamllint:all']);
+
+};

data/README.md

@@ -1,10 +1,11 @@
 [![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
 
-adiwg-mdcodes provides code lists in JSON formats for loading of mdEditor or other metadata
-editors using adiwg-json-schema.  The codes include all ISO 19115-2 and ISO 19115-1 codes plus
-additional codes from NGDC and ADIwg.
+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.
 
 ## Installation
 
@@ -20,13 +21,34 @@ Or install it yourself as:
 
     $ gem install adiwg-mdcodes
 
-## Usage
 
-TODO: Write usage instructions here
+## Methods
+
+### getYamlPath
+> returns the path to the YAML file of code lists.
+
+### getCodeLists( returnFormat )
+> returns all code lists with all code list data
+> returnFormat = \[__hash__ | json] (string)
+
+### getCodeList( codeListName, returnFormat )
+> returns a single code list with all code list data
+> 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
+> returnFormat = \[__hash__ | json] (string)
+
+### getCodeName( codeListName, returnFormat )
+> returns a single code list with only the code list item names
+> codeListName = name of code list to return (string)
+> returnFormat = \[__hash__ | json] (string)
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/mdCodes/fork )
+1. Fork it (https://github.com/adiwg/mdCodes/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/adiwg-mdcodes.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~>10"
   spec.add_development_dependency "minitest", "~>5"
 
+  spec.add_runtime_dependency "json", "~>1.8"
+
 end

data/lib/adiwg/mdcodes.rb

@@ -6,10 +6,13 @@
 # 	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
 
 # add main directories to load_path
 
 require 'yaml'
+require 'json'
 
 module ADIWG
 
@@ -20,21 +23,30 @@ module ADIWG
         end
 
         # read the yml file into ruby
-        def self.getCodeLists
+        def self.getCodeLists(format='hash')
             file = getYamlPath
-            return YAML.load_file(file)
+			codes = YAML.load_file(file)
+			if format == 'json'
+				return codes.to_json
+			else
+				return codes
+			end
         end
 
         # return a single code list
-        def self.getCodeList(codeList)
+        def self.getCodeList(codeList, format='hash')
             codeLists = getCodeLists
             hCodeList = {}
             hCodeList[codeList] = codeLists[codeList]
-            return hCodeList
+			if format == 'json'
+				return hCodeList.to_json
+			else
+				return hCodeList
+			end
         end
 
         # return only code names
-        def self.getCodeNames
+        def self.getCodeNames(format='hash')
             codeLists = getCodeLists
             hCodeNames = {}
             codeLists.each do |key, value|
@@ -44,12 +56,16 @@ module ADIWG
                     aList << item['codeName']
                 end
                 hCodeNames[key] = aList
-            end
-            return hCodeNames
+			end
+			if format == 'json'
+				return hCodeNames.to_json
+			else
+				return hCodeNames
+			end
         end
 
         # return a single code name list
-        def self.getCodeName(codeList)
+        def self.getCodeName(codeList, format='hash')
             hCodeList = getCodeList(codeList)
             hCodeNames = {}
             aItems = hCodeList[codeList]['items']
@@ -58,7 +74,11 @@ module ADIWG
                 aList << item['codeName']
             end
             hCodeNames[codeList] = aList
-            return hCodeNames
+			if format == 'json'
+				return hCodeNames.to_json
+			else
+				return hCodeNames
+			end
         end
 
     end

data/lib/adiwg/mdcodes/version.rb

@@ -6,11 +6,12 @@
 # 0.1.1 2014-11-06 added factSheet to scope
 # 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
 
 module ADIWG
 
 	module Mdcodes
-		VERSION = "0.2.0"
+		VERSION = "0.2.1"
 	end
 
 end

data/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "mdCodes",
+  "version": "0.2.1",
+  "description": "CodeLists for ADIwg mdJSON",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adiwg/mdCodes.git"
+  },
+  "keywords": [
+    "metadata",
+    "adiwg",
+    "json"
+  ],
+  "author": "https://github.com/stansmith907, https://github.com/jlblcc",
+  "license": "UNLICENSE",
+  "bugs": {
+    "url": "https://github.com/adiwg/mdCodes/issues"
+  },
+  "homepage": "https://github.com/adiwg/mdCodes",
+  "devDependencies": {
+    "grunt": "^0.4.5",
+    "grunt-convert": "^0.1.11",
+    "grunt-yamllint": "^0.2.0"
+  }
+}

data/resources/mdcodes.yml

@@ -1,8 +1,7 @@
-
+---
 # adiwgJson codelists
 # compiled from ISO 19115-2, 19115-1, NGDC, and ADIwg
 
----
 associationType:
   isoName: "DS_AssociationTypeCode"
   description: "justification for the correlation of two resources (datasets or projects)"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adiwg-mdcodes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - stansmith907
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: adiwg-mdcodes provides code lists for use in ISO 19139 compliant metadata,
   especially mdJSON.  The codes include all ISO 19115-2 and ISO 19115-1 codes plus
   additional codes from NGDC and ADIwg.
@@ -64,6 +78,7 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Gruntfile.js
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -71,6 +86,7 @@ files:
 - lib/adiwg-mdcodes.rb
 - lib/adiwg/mdcodes.rb
 - lib/adiwg/mdcodes/version.rb
+- package.json
 - resources/mdcodes.yml
 - test/dev.rb
 - test/tc_mdcodes.rb
@@ -101,4 +117,3 @@ summary: adiwg-mdcodes provides code lists for mdJSON.
 test_files:
 - test/dev.rb
 - test/tc_mdcodes.rb
-has_rdoc: