codeinventory 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0466434f7ce5176346394af5842accdb4bc649cd
-  data.tar.gz: b3f98cf215d6b6f5739d137cb5db87df0e45b8a7
+  metadata.gz: bb626c63a1233fa953e0a8ab80b66fb4cb958537
+  data.tar.gz: ffe05f5c9eee82879827b2a452bea822a7545c83
 SHA512:
-  metadata.gz: 47467123b0e59a32e04f744f34e5e951d506920c8c1cb6c64e7c78d70998891094e4260d3d4c0f51a244dbf1e08427cef20aa0413672d24de1ed8bb8864f3731
-  data.tar.gz: aec125c4b76b049d8b81fac3663914f4509de0e3178dee1863b8b955a78ebd861dedd74e5c8048cb83addf65c71bfa2257373fe367856ff7584745cba3f5626a
+  metadata.gz: 092d0c1d9cd87baf6369944bde702a1b66d48393ec506eabd84508c6c858f2ad41520518800cff2236046f7c910d3a8af9abe7292de719a090b89993b787d8c6
+  data.tar.gz: 3516d81dbc3645f2b5e77490b79f768873c2a47e50a6076d58ae6f3f0b7db3feb324645e12e1838fcce96d8265554ff4c74d3123072148771d16670b058d8c70

data/README.md

@@ -2,15 +2,30 @@
 
 *_This is an experimental gem that is currently in an alpha stage. The features and interface are unstable and may change at any time._*
 
-The `codeinventory` gem is a tool to harvest project metadata from an agency's repositories. The harvested metadata can be used to produce a [code.json](https://code.gov/#/policy-guide/docs/compliance/inventory-code) file for [Code.gov](https://code.gov/). The gem includes the ability to pull project metadata from these sources:
+The `codeinventory` gem is provides a CLI tool and a programmatic interface to harvest project metadata from an agency's repositories. The harvested metadata can be used to produce a [code.json](https://code.gov/#/policy-guide/docs/compliance/inventory-code) file for [Code.gov](https://code.gov/). The gem includes the ability to pull project metadata from these sources:
 
 * JSON files
 * CSV files
 
-More sources can be added via plugins.
+More sources can be added via plugins:
+
+* [GitHub](https://github.com/GSA/codeinventory-github)
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [CLI](#cli)
+  * [JSON Source](#json-source)
+  * [CSV Source](#csv-source)
+  * [Multiple Sources](#multiple-sources)
+* [Development](#development)
+* [Contributing](#contributing)
 
 ## Installation
 
+You will need [Ruby](https://www.ruby-lang.org/en/) on your system in order to install and use this gem.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -27,18 +42,47 @@ Or install it yourself as:
 
 ## Usage
 
-Basically:
+### CLI
 
-```ruby
-json_source = CodeInventory::JSONFile.new(File.new("some_projects.json"))
-csv_source = CodeInventory::CSVFile.new(File.new("more_projects.csv"))
+After installing this gem, you can run `codeinv`, an extensible command-line interface (CLI).
 
-inventory = CodeInventory::Inventory.new(json_source, csv_source)
-inventory.projects # Returns an array of all projects in the JSON and CSV files
 ```
+$ codeinv
+Commands:
+  codeinv csv FILENAME    # Build an inventory from a CSV file
+  codeinv help [COMMAND]  # Describe available commands or one specific command
+  codeinv json FILENAME   # Build an inventory from a JSON file
+```
+
+To generate a code inventory from an existing CSV file, for instance:
+
+```
+codeinv csv my_csv_file.csv
+```
+
+For information on the required format of JSON and CSV input files, see [JSON Source](#json-source) and [CSV Source](#csv-source).
+
+The CLI can be extended to support other sources just by installing a gem. For instance, if you install the [codeinventory-github](https://github.com/GSA/codeinventory-github) gem, you'll automatically get the `github` subcommand:
+
+```
+$ codeinv
+Commands:
+  codeinv csv FILENAME                                     # Build an inventory from a CSV file
+  codeinv github GITHUB_ACCESS_TOKEN GITHUB_ORG [OPTIONS]  # Build an inventory from GitHub
+  codeinv help [COMMAND]                                   # Describe available commands or one s...
+  codeinv json FILENAME                                    # Build an inventory from a JSON file
+```
+
 
 ### JSON Source
 
+```ruby
+json_source = CodeInventory::JSONFile.new(File.new("some_projects.json"))
+
+inventory = CodeInventory::Inventory.new(json_source)
+inventory.projects # Returns an array of all projects in the JSON file
+```
+
 When using `CodeInventory::JSONFile`, the source file is expected to be a JSON file in the following format:
 
 ```json
@@ -78,6 +122,13 @@ See the [Code.gov documentation](https://code.gov/#/policy-guide/docs/compliance
 
 ### CSV Source
 
+```ruby
+csv_source = CodeInventory::CSVFile.new(File.new("more_projects.csv"))
+
+inventory = CodeInventory::Inventory.new(csv_source)
+inventory.projects # Returns an array of all projects in the CSV file
+```
+
 When using `CodeInventory::CSVFile`, the source file is expected to be a CSV file in the following format:
 
 ```csv
@@ -88,6 +139,18 @@ Product Two,Another awesome product.,http://www.usa.gov/publicdomain/label/1.0/,
 
 See the [Code.gov documentation](https://code.gov/#/policy-guide/docs/compliance/inventory-code) for specifics on required fields and value types.
 
+### Multiple Sources
+
+You can combine multiple sources when building an inventory.
+
+```ruby
+json_source = CodeInventory::JSONFile.new(File.new("some_projects.json"))
+csv_source = CodeInventory::CSVFile.new(File.new("more_projects.csv"))
+
+inventory = CodeInventory::Inventory.new(json_source, csv_source)
+inventory.projects # Returns an array of all projects in the JSON and CSV files
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/codeinventory/csv_file.rb

@@ -12,7 +12,7 @@ module CodeInventory
     def projects
       @csv.collect do |row|
         csv_data = row.to_hash
-        csv_data.inject({}) do |memo, pair|
+        project = csv_data.inject({}) do |memo, pair|
           csv_header, csv_value = pair
           case
           when csv_header == "tags"
@@ -24,6 +24,8 @@ module CodeInventory
           end
           memo.merge(new_pair)
         end
+        yield project if block_given?
+        project
       end
     end
 

data/lib/codeinventory/inventory.rb

@@ -7,7 +7,12 @@ module CodeInventory
     end
 
     def projects
-      @sources.collect { |source| source.projects }.flatten
+      @sources.collect { |src|
+        src.projects do |project|
+          yield project, src if block_given?
+          project
+        end
+      }.flatten
     end
   end
 end

data/lib/codeinventory/json_file.rb

@@ -2,10 +2,15 @@ require "json"
 
 module CodeInventory
   class JSONFile
-    attr_accessor :projects
-
     def initialize(json_file)
       @projects = JSON.load(json_file)
     end
+
+    def projects
+      if block_given?
+        @projects.each { |p| yield p }
+      end
+      @projects
+    end
   end
 end

data/lib/codeinventory/version.rb

@@ -1,3 +1,3 @@
 module CodeInventory
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeinventory
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jeff Fredrickson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler