spout 0.6.0.beta7 → 0.6.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8321e511c49c9c76cdda7d8be1e289190888a05b
-  data.tar.gz: 831e1f22202f30316a79c51e8ed93971600b4225
+  metadata.gz: bbef72d6ca54c940ae287a25f94bd794a7ea7eb1
+  data.tar.gz: ab4f7c2e9b7ed6261f1307ac01902f1d76841bf7
 SHA512:
-  metadata.gz: 74529bff8848f4aff638e9b3a5bf0086dcd408e9b2988f2eaad48777c3feeab149c7dcef319f67de058351bd55ae9c8caa7e80322c6c31e4129c60c4834d58b6
-  data.tar.gz: 905223a0af8901f51167aa3a0c1e269a18b7919b0ef7b807eb62562ee393b59beb1a0e962276be5614fa961432c3eb180a9fbcf525a405eb376e60294fbc13a9
+  metadata.gz: ae5344b68426a94036f75ed40d99cc13fb73eb180d5ecdfedc864acb6b7910fa1f46cc9371f58d2501f5ff536debef735bbc307248689693717e65fc27d2a5d0
+  data.tar.gz: 7d5bd440cf67393263bc339feb575876e9be618fdc0c83caf1c263abe9fa323bd88b41ca7af00811b72dad44360d1b6633032a6ac1ccbd9822d8f838031365a1

data/CHANGELOG.md

@@ -1,9 +1,9 @@
 ## 0.6.0
 
 ### Enhancement
-- Added `spout match` command that generates a coverage report of how well a dataset matches the data dictionary
-  - Spout Match generates a viewable report in `dd\index.html` that shows which columns are covered in CSVs located in `dd\csvs`
-  - Spout Match checks that all collected values for a variable with a domain exist in the associated domain
+- Added `spout coverage` command that generates a coverage report of how well a dataset matches the data dictionary
+  - Generates a viewable report in `<project_name>/coverage/index.html` that shows which columns are covered in CSVs located in `<project_name>/csvs/`
+  - Checks that all collected values for a variable with a domain exist in the associated domain
 - **Gem Changes**
   - Updated to colorize 0.6.0
 

data/README.md

@@ -120,6 +120,18 @@ end
 Then run either `spout test` or `bundle exec rake` to run your tests.
 
 
+### Test your data dictionary coverage of your dataset
+
+Spout lets you generate a nice visual coverage report that displays how well the data dictionary covers your dataset. Place your dataset csvs into `./csvs/` and then run the following Spout command:
+
+```
+spout coverage
+```
+
+This will generate an `index.html` file that can be opened and viewed in any browser.
+
+Spout coverage validates that values stored in your dataset match up with variables and domains defined in your data dictionary.
+
 ### Create a CSV Data Dictionary from your JSON repository
 
 Provide an optional version parameter to name the folder the CSVs will be generated in, defaults to what is in `VERSION` file, or if that does not exist `1.0.0`.

data/lib/spout/actions.rb

@@ -19,8 +19,8 @@ module Spout
         new_data_dictionary_export(argv)
       when 'hybrid', '-hybrid', '--hybrid', 'y', 'hy', '-y', '-hy'
         new_data_dictionary_export(argv, 'hybrid')
-      when 'dataset', '-dataset', '--dataset', 'd', '-d', 'match', '-match', '--match', 'm', '-m', 'coverage', '-coverage', '--coverage', 'c', '-c'
-        match_dataset_report(argv)
+      when 'coverage', '-coverage', '--coverage', 'c', '-c'
+        coverage_report(argv)
       else
         help
       end
@@ -42,7 +42,7 @@ EOT
       def import_from_csv(argv, type = "")
         csv_file = File.join(argv[1].to_s.strip)
         if File.exists?(csv_file)
-          system "bundle exec rake dd:import CSV=#{csv_file} #{'TYPE='+type if type.to_s != ''}"
+          system "bundle exec rake spout:import CSV=#{csv_file} #{'TYPE='+type if type.to_s != ''}"
         else
           puts csv_usage
         end
@@ -55,15 +55,17 @@ Usage: spout COMMAND [ARGS]
 
 The most common spout commands are:
   [n]ew             Create a new Spout dictionary.
-                    "spout new my_dd" creates a new data
-                    dictionary called MyDD in "./my_dd"
+                    `spout new <project_name>` creates a new
+                    data dictionary in `./<project_name>`
   [t]est            Run tests and show failing tests
   [tv]              Run the tests and show passing and failing
                     tests
-  [i]mport          Import a CSV file into the JSON repository
-  [e]xport [1.0.0]  Export the JSON respository to a CSV
- h[y]brid  [1.0.0]  Export the JSON repository in the Hybrid
-                    Dictionary format
+  [i]mport          Import a CSV file into the JSON dictionary
+  [e]xport [1.0.0]  Export the JSON dictionary to a CSV
+ h[y]brid  [1.0.0]  Export the JSON dictionary in the Hybrid
+                    dictionary format
+  [c]overage        Coverage report, requires dataset CSVs
+                    in `<project_name>/csvs/`
   [v]ersion         Returns the version of Spout
 
 Commands can be referenced by the first letter:
@@ -77,7 +79,7 @@ EOT
         version = argv[1].to_s.gsub(/[^a-zA-Z0-9\.-]/, '_').strip
         version_string = (version == '' ? "" : "VERSION=#{version}")
         type_string =  type.to_s == '' ? "" : "TYPE=#{type}"
-        system "bundle exec rake dd:create #{version_string} #{type_string}"
+        system "bundle exec rake spout:create #{version_string} #{type_string}"
       end
 
       def new_template_dictionary(argv)
@@ -114,8 +116,8 @@ EOT
         system "bundle install"
       end
 
-      def match_dataset_report(argv)
-        system "bundle exec rake dd:coverage"
+      def coverage_report(argv)
+        system "bundle exec rake spout:coverage"
       end
 
     private

data/lib/spout/tasks/engine.rake

@@ -8,9 +8,9 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => :test
+task default: :test
 
-namespace :dd do
+namespace :spout do
   require 'csv'
   require 'fileutils'
   require 'rubygems'
@@ -60,7 +60,7 @@ namespace :dd do
     value_hash = {}
     csv_names = []
 
-    Dir.glob("dd/csvs/*.csv").each do |csv_file|
+    Dir.glob("csvs/*.csv").each do |csv_file|
       csv_name = csv_file.split('/').last.to_s
       csv_names << csv_name
       puts "\nParsing: #{csv_name}"
@@ -104,8 +104,10 @@ namespace :dd do
       @coverage_results << [ csv_name, total_column_count, mapped_column_count ]
     end
 
-    coverage_file = File.join(Dir.pwd, 'dd', 'index.html')
-    puts "\nGenerating: index.html\n\n"
+    coverage_folder = File.join(Dir.pwd, 'coverage')
+    FileUtils.mkpath coverage_folder
+    coverage_file = File.join(coverage_folder, 'index.html')
+    print "\nGenerating: index.html\n\n"
 
     File.open(coverage_file, 'w+') do |file|
       name = 'index.html'

data/lib/spout/templates/gitignore

@@ -6,3 +6,5 @@
 
 # Data Dictionary folders
 /dd
+/coverage
+/csvs

data/lib/spout/version.rb

@@ -3,7 +3,7 @@ module Spout
     MAJOR = 0
     MINOR = 6
     TINY = 0
-    BUILD = "beta7" # nil, "pre", "rc", "rc2"
+    BUILD = "rc" # nil, "pre", "rc", "rc2"
 
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.6.0.beta7
+  version: 0.6.0.rc
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake