spout 0.11.0.beta2 → 0.11.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7a873eabc85e3035b8e784628e510d8e976f15b
-  data.tar.gz: 90c06d0bac0ef4c772c82da29760d4007591407b
+  metadata.gz: 0e8b31dbf0428ffd5c44e2cc701090313d57b5e8
+  data.tar.gz: d4d827b412188a66799084fca3fa306279264b39
 SHA512:
-  metadata.gz: a7cee73fe2aa1bec7762300e8fe24c29462a6db61fa7149bd81274950e5da9ef3071602718f061db7d603db52a5ad56ed97f2377620a08ac96144f4dfc75f2cb
-  data.tar.gz: 9c9038e3ea7ff18eae3485622f11d12f8523e656d331ad9274d969c7c70863cf63ad0b729e76ec5b1de7cbf2c6f59fcd946a2312d9a5602ca2c52ddf1c9ef809
+  metadata.gz: b078712373a6c6460bb791dd01c4a515bc9f787afc5d6d989fb1f9645b332c8ac1c6f6abf1a7cedcd51d694a08cecf77df06f792502d68de42a509779e0c2d51
+  data.tar.gz: e648d5ee7df044dc62bbfb64c6ef75cfba76aec05ef2e5f2f6f3f24270ce7bc8f424100e98288820ecde5377991ed40823002a1903bef96acb5bbd61801f6bda

data/CHANGELOG.md

@@ -33,6 +33,7 @@
 
 ### Refactoring
 - Started refactoring code base to better adhere to RuboCop style recommendations
+- Replaced dependency on `ansi/code` with colorize for better compatibility with Windows
 
 ## 0.10.2 (December 29, 2014)
 

data/README.md

@@ -4,9 +4,13 @@
 [![Dependency Status](https://gemnasium.com/sleepepi/spout.svg)](https://gemnasium.com/sleepepi/spout)
 [![Code Climate](https://codeclimate.com/github/sleepepi/spout/badges/gpa.svg)](https://codeclimate.com/github/sleepepi/spout)
 
-Turn your CSV data dictionary into a JSON repository. Collaborate with others to update the data dictionary in JSON format. Generate new Data Dictionary from the JSON repository. Test and validate your data dictionary using built-in tests, or add your own tests and validations.
+Turn your CSV data dictionary into a JSON repository. Collaborate with others to
+update the data dictionary in JSON format. Generate new Data Dictionary from the
+JSON repository. Test and validate your data dictionary using built-in tests, or
+add your own tests and validations.
 
-Spout has been used extensively to curate and clean datasets available on the [National Sleep Research Resource](https://sleepdata.org).
+Spout has been used extensively to curate and clean datasets available on the
+[National Sleep Research Resource](https://sleepdata.org).
 
 ## Installation
 
@@ -36,13 +40,19 @@ spout import data_dictionary.csv
 
 The CSV should contain at minimal the two column headers:
 
-`id`: This column will give the variable its name, and also be used to name the file, i.e. `<id>.json`
+`id`: This column will give the variable its name, and also be used to name the
+file, i.e. `<id>.json`
 
-`folder`: This can be blank, however it is used to place variables into a folder hiearchy. The folder column can contain forward slashes `/` to place a variable into a subfolder. An example may be, `id`: `myvarid`, `folder`: `Demographics/Subfolder` would create a file `variables/Demographics/Subfolder/myvarid.json`
+`folder`: This can be blank, however it is used to place variables into a folder
+hiearchy. The folder column can contain forward slashes `/` to place a variable
+into a subfolder. An example may be, `id`: `myvarid`,
+`folder`: `Demographics/Subfolder` would create a file
+`variables/Demographics/Subfolder/myvarid.json`
 
 Other columns that will be interpreted include:
 
-`display_name`: The variable name as it is presented to the user. The display name should be fit on a single line.
+`display_name`: The variable name as it is presented to the user. The display
+name should be fit on a single line.
 
 `description`: A longer description of the variable.
 
@@ -58,13 +68,19 @@ Other columns that will be interpreted include:
   - `datetime`
   - `file`
 
-`domain`: The name of the domain that is associated with the variable. Typically, only variable of type `choices` have domains.  These domains then reside in `domains` folder.
+`domain`: The name of the domain that is associated with the variable.
+Typically, only variable of type `choices` have domains. These domains then
+reside in `domains` folder.
 
-`units`: A string of the associated that are appended to variable values, or added to coordinates in graphs representing the variable.
+`units`: A string of the associated that are appended to variable values, or
+added to coordinates in graphs representing the variable.
 
-`calculation`: A calculation represented using algebraic expressions along with `id` of other variables.
+`calculation`: A calculation represented using algebraic expressions along with
+`id` of other variables.
 
-`labels`: A series of different names for the variable that are semi-colon `;` separated. These labels are commonly synonyms, or related terms used primarily for searching.
+`labels`: A series of different names for the variable that are semi-colon `;`
+separated. These labels are commonly synonyms, or related terms used primarily
+for searching.
 
 All other columns get grouped into a hash labeled `other`.
 
@@ -91,13 +107,15 @@ Other columns that are imported include:
 
 ### Test your repository
 
-If you created your data dictionary repository using `spout new`, you can go ahead and test using:
+If you created your data dictionary repository using `spout new`, you can go
+ahead and test using:
 
 ```
 spout test
 ```
 
-If not, you can add the following to your `test` directory to include all Spout tests, or just a subset of Spout tests.
+If not, you can add the following to your `test` directory to include all Spout
+tests, or just a subset of Spout tests.
 
 `test/dictionary_test.rb`
 
@@ -129,9 +147,11 @@ end
 
 Then run either `spout test` or `bundle exec rake` to run your tests.
 
-You can also use Spout iterators to create custom tests for variables, forms, and domains in your data dictionary.
+You can also use Spout iterators to create custom tests for variables, forms,
+and domains in your data dictionary.
 
-**Example Custom Test 1:** Test that `integer` and `numeric` variables have a valid unit type
+**Example Custom Test 1:** Test that `integer` and `numeric` variables have a
+valid unit type
 
 ```ruby
 class DictionaryTest < Minitest::Test
@@ -176,31 +196,41 @@ end
 
 ### 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/<version>/` and then run the following Spout command:
+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/<version>/` 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.
+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.
+Spout coverage validates that values stored in your dataset match up with
+variables and domains defined in your data dictionary.
 
 ### Identify outliers in your dataset
 
-Spout lets you generate detect outliers in your underlying datasets. Place your dataset csvs into `./csvs/<version>/` and then run the following Spout command:
+Spout lets you generate detect outliers in your underlying datasets. Place your
+dataset csvs into `./csvs/<version>/` and then run the following Spout command:
 
 ```
 spout outliers
 ```
 
-This will generate an `outliers.html` file that can be opened and viewed in any browser.
+This will generate an `outliers.html` file that can be opened and viewed in any
+browser.
 
-Spout outliers computes the [inner and outer fences](http://www.wikihow.com/Calculate-Outliers) to identify minor and major outliers in the dataset.
+Spout outliers computes the
+[inner and outer fences](http://www.wikihow.com/Calculate-Outliers) to identify
+minor and major outliers in the dataset.
 
 ### 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`.
+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`.
 
 ```
 spout export
@@ -220,7 +250,8 @@ spout graphs
 
 This command generates JSON charts and tables of each variable in a dataset
 
-Requires a Spout YAML configuration file, `.spout.yml`, in the root of the data dictionary that defines the variables used to create the charts:
+Requires a Spout YAML configuration file, `.spout.yml`, in the root of the data
+dictionary that defines the variables used to create the charts:
 
 - `visit`: This variable is used to separate subject encounters in a histogram
 - `charts`: Array of choices, numeric, or integer variables for charts
@@ -238,15 +269,18 @@ charts:
   title: Race
 ```
 
-To only generate graphs for a few select variables, add the variable names after the `spout graphs` command.
+To only generate graphs for a few select variables, add the variable names after
+the `spout graphs` command.
 
-For example, the command below will only generate graphs for the two variables `ahi` and `bmi`.
+For example, the command below will only generate graphs for the two variables
+`ahi` and `bmi`.
 
 ```
 spout g ahi bmi
 ```
 
-You can also specify a limit to the amount of rows to read in from the CSV files by specifying the `-rows` flag
+You can also specify a limit to the amount of rows to read in from the CSV files
+by specifying the `-rows` flag.
 
 ```
 spout g --rows=10 ahi
@@ -255,7 +289,8 @@ spout g --rows=10 ahi
 This will generate a graph for ahi for the first 10 rows of each dataset CSV.
 
 
-This will generate charts and tables for each variable in the dataset plotted against the variables listed under `charts`.
+This will generate charts and tables for each variable in the dataset plotted
+against the variables listed under `charts`.
 
 ### Example Variable that references a Domain and a Form
 
@@ -308,7 +343,8 @@ This will generate charts and tables for each variable in the dataset plotted ag
 spout deploy NAME
 ```
 
-This command pushes a tagged version of the data dictionary to a webserver specified in the `.spout.yml` file.
+This command pushes a tagged version of the data dictionary to a webserver
+specified in the `.spout.yml` file.
 
 ```
 webservers:
@@ -339,8 +375,9 @@ The following steps are run:
   - `CHANGELOG.md` top line should include version, ex: `## 0.1.0`
   - Git Repo should have zero uncommitted changes
 - **Tests Pass**
-  - `spout t` passes for RC and FINAL versions (Include .rc, does not include .beta)
-  - `spout c` passes for RC and FINAL versions (Include .rc, does not include .beta)
+  - `spout t` passes for RC and FINAL versions
+- **Dataset Coverage Check**
+  - `spout c` passes for RC and FINAL versions
 - **Graph Generation**
   - `spout g` is run
   - Graphs are pushed to server
@@ -350,6 +387,4 @@ The following steps are run:
 - **Documentation Uploads**
   - `README.md` and `KNOWNISSUES.md` are uploaded
 - **Server-Side Updates**
-  - Server checks out branch of specified tag
-  - Server runs `load_data_dictionary!` for specified dataset slug
   - Server refreshes dataset folder to reflect new dataset and data dictionaries

data/lib/spout/commands/deploy.rb

@@ -49,6 +49,9 @@ module Spout
         @version = version
         @skip_checks = !(argv.delete('--skip-checks').nil? && argv.delete('--no-checks').nil?)
 
+        @skip_tests = !(argv.delete('--skip-tests').nil? && argv.delete('--no-tests').nil?)
+        @skip_coverage = !(argv.delete('--skip-coverage').nil? && argv.delete('--no-coverage').nil?)
+
         @skip_variables = !(argv.delete('--skip-variables').nil? && argv.delete('--no-variables').nil?)
         @skip_dataset = !(argv.delete('--skip-dataset').nil? && argv.delete('--no-dataset').nil?)
         @skip_dictionary = !(argv.delete('--skip-dictionary').nil? && argv.delete('--no-dictionary').nil?)
@@ -80,6 +83,7 @@ module Spout
         config_file_load
         version_check
         test_check
+        coverage_check
         user_authorization
         upload_variables
         dataset_uploads
@@ -176,12 +180,12 @@ module Spout
       end
 
       def test_check
-        if @skip_checks
+        if @skip_tests
           puts '          Spout Tests: ' + 'SKIP'.colorize(:blue)
           return
         end
 
-        print "          Spout Tests: "
+        print '          Spout Tests: '
 
         stdout = quietly do
           `spout t`
@@ -193,8 +197,15 @@ module Spout
           message = "#{INDENT}spout t".colorize(:white) + " had errors or failures".colorize(:red) + "\n#{INDENT}Please fix all errors and failures and then run spout deploy again."
           failure message
         end
+      end
+
+      def coverage_check
+        if @skip_coverage
+          puts '     Dataset Coverage: ' + 'SKIP'.colorize(:blue)
+          return
+        end
 
-        puts '       Spout Coverage: ' + 'SKIP'.colorize(:blue)
+        puts '     Dataset Coverage: ' + 'NOT IMPLEMENTED'.colorize(:yellow)
       end
 
       def user_authorization

data/lib/spout/commands/help.rb

@@ -138,7 +138,9 @@ Optional Flags:
                         to a maximum of N rows
   <variable>            Only deploy specified variable(s)
                         Ex: spout deploy production age gender
-  --skip-checks         Skip Spout checks
+  --skip-checks         Skip git tag and version checks
+  --skip-tests          Skip data dictionary tests
+  --skip-coverage       Skip dataset coverage check
   --skip-variables      Skip upload of dataset variables
   --skip-dataset        Skip upload of dataset CSVs
   --skip-dictionary     Skip upload of data dictionary

data/lib/spout/tasks/engine.rake

@@ -5,7 +5,7 @@ Rake::TestTask.new do |t|
   t.libs << 'test'
   t.test_files = FileList['test/**/*_test.rb']
   t.warning = true
-  t.verbose = true
+  t.verbose = false
 end
 
 task default: :test

data/lib/spout/tests.rb

@@ -3,18 +3,16 @@ require 'json'
 
 require 'minitest/autorun'
 require 'minitest/reporters'
-require 'ansi/code'
 require 'colorize'
 
 module Minitest
   module Reporters
     class SpoutReporter < BaseReporter
-      include ANSI::Code
       include RelativePosition
 
       def start
         super
-        print(white { 'Loaded Suite test' })
+        print 'Loaded Suite test'.colorize(:white)
         puts
         puts
         puts 'Started'
@@ -23,13 +21,13 @@ module Minitest
 
       def report
         super
-        puts 'Finished in %.5f seconds.' % total_time
+        puts format('Finished in %.5f seconds.', total_time)
         puts
-        print(white { '%d tests' } % count)
-        print(', %d assertions, ' % assertions)
+        print format('%d tests', count).colorize(:white)
+        print format(', %d assertions, ', assertions)
         color = failures.zero? && errors.zero? ? :green : :red
-        print(send(color) { '%d failures, %d errors, ' } % [failures, errors])
-        print(yellow { '%d skips' } % skips)
+        print format('%d failures, %d errors, ', failures, errors).colorize(color)
+        print format('%d skips', skips).colorize(:yellow)
         puts
         puts
       end
@@ -50,6 +48,17 @@ module Minitest
 
       protected
 
+      def print_colored_status(test)
+        color = if test.passed?
+                  :green
+                elsif test.skipped?
+                  :yellow
+                else
+                  :red
+                end
+        print pad_mark(result(test).to_s.upcase).colorize(color)
+      end
+
       def before_suite(suite)
         puts suite
       end

data/lib/spout/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.11.0.beta2
+  version: 0.11.0.beta3
 platform: ruby
 authors:
 - Remo Mueller