about_yml 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2c2f42bfc38bfad01b3f282ef2369d7becef08b
-  data.tar.gz: 9ff0b51442aeedc72b016d97b2f3a5672e1cb7a2
+  metadata.gz: a3434a081c8ba183825647058a87aa9670f1f446
+  data.tar.gz: d48fc5b2f4d6b04272231be66f8306abbd66fa6c
 SHA512:
-  metadata.gz: f523e392c10f5e6fa4a94877655205568a29baf0c44e39f74b9baf2088b0bccc704e59b5c98676b1bceac552902eef06ab9dcb0724ac07b2aae52a81a30d5bac
-  data.tar.gz: ce220e63ea4465715f8790009e091e91ef21b19de51cc9ea4037386fb57ccbe93cbfddc2aba52d4c5a8c6ff464a2d49c14b91a8cf7f66a3902946fba7014a9eb
+  metadata.gz: c6629fe23082244cae129a1700ee8faf886cf22ad6858c3f5fb0556577cf224ac99203cd03dc2b522f98b76c4afa776db209dd8a39d33d6a111f22c8912bb00c
+  data.tar.gz: f1e1ca7bdca399056a1f07716e35726be7000994968544d2d9eea20bfa08384ef3facf1dd7c3ad2d65dba474f05d309e776eecfef97e13810a0ff56524559372

data/bin/about_yml_validate

@@ -6,15 +6,16 @@ require 'safe_yaml'
 
 def usage(exitstatus = 0)
   (exitstatus == 0 ? $stdout : $stderr).puts <<END_USAGE
-#{$PROGRAM_NAME} path_to_about_file [...]
+#{$PROGRAM_NAME} [path_to_about_file] [...]
 
-Validates .about.yml file contents. Prints nothing on success; prints errors
-to standard error.
+Validates .about.yml file contents. Assumes file in current directory
+unless path specified. Prints nothing on success; prints errors to
+standard error.
 END_USAGE
   exit exitstatus
 end
 
-usage 1 if ARGV.empty?
+ARGV << '.about.yml' if ARGV.empty?
 ARGV.each { |f| abort "#{f} does not exist" unless File.exist? f }
 
 exitstatus = 0

data/lib/about_yml/about.rb

@@ -36,16 +36,28 @@ module AboutYml
       SafeYAML.load Base64.decode64(about['content'])
     end
 
+    def self.write_error(err, repo, result)
+      $stderr.puts('Error while parsing .about.yml for ' \
+        "#{repo.full_name}:\n #{err}")
+      result['errors'] << { repo.full_name => err.message }
+    end
+
+    def self.add_github_metadata(result, repo)
+      result['github'] = {
+        'name' => repo.full_name,
+        'description' => repo.description,
+      }
+    end
+
     def self.collect_repository_data(repo, client, result)
       collection = (repo.private == true) ? 'private' : 'public'
       repo_name = repo.full_name
       result[collection][repo_name] = fetch_file_contents client, repo_name
+      add_github_metadata result[collection][repo_name], repo
     rescue Octokit::NotFound
       result['missing'] << repo.full_name
     rescue StandardError => err
-      $stderr.puts('Error while parsing .about.yml for ' \
-        "#{repo.full_name}:\n #{err}")
-      result['errors'] << {repo.full_name => err.message} 
+      write_error err, repo, result
     end
     private_class_method :collect_repository_data
 

data/lib/about_yml/schema.json

@@ -44,7 +44,7 @@
         "testable": {
             "type": "boolean",
             "default": false,
-            "description": "Should be 'true' if the project has a continuous build"
+            "description": "Should this repo have automated tests? If so, set to `true`."
         },
         "team": {
             "type": "array",
@@ -128,7 +128,7 @@
         }
     },
     "required": [
-        "name", "full_name", "stage", "team", "licenses", "owner_type", "status", "testable"
+        "name", "full_name", "stage", "team", "licenses", "owner_type", "testable"
     ],
     "definitions": {
         "person": {
@@ -223,7 +223,7 @@
             "properties": {
                 "url": {
                     "type": "string",
-                    "description": "URI for the link to ",
+                    "description": "URL for the link",
                     "format": "uri"
                 },
                 "text": {

data/lib/about_yml/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module AboutYml
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: about_yml
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mike Bland
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml