spout 0.8.0.beta7 → 0.8.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe29cf954727208eb8e957550db8b7f887a7c5b2
-  data.tar.gz: d1231cf3acdc0679c02d590fc1f7d15689a8405b
+  metadata.gz: 77f00d45a191d59e327952d4af5a2f57c2f65f3b
+  data.tar.gz: 2848258e7bad286df21eee2bb622e3fda54094a5
 SHA512:
-  metadata.gz: 17622fa7556b40aedbe2670ff20d1e6e6e9668dbed835b59e1a11d4ac506757c4a8934536c0a6d2b5eccaeb649845124d4ce5aa50a6f240e96176e95b2ab1e2d
-  data.tar.gz: 4a87ec0fa442bec34c88bd5ebec53ae0615a9da2f76de6f0858c7fb9de728067a95efcbb944884098bfae1160cb64b3313ae1f9789a8b8416c2d3730b1c9b40b
+  metadata.gz: 58f411b0735343c82c575897d10b6c02b4521c91dbba3693d204933a295aa6bdf3418e077256eabdabf51172182a652ac436b084346a1ae88748456a4f29dab9
+  data.tar.gz: abf5ec903b9321e5e9f270ac57df9724daef73dcba9a5e25a5400e081bc09556b4ddfccfb5a67463e0e07d89079f7660039f3e787ee6272ad025a2246e599bd0

data/CHANGELOG.md

@@ -8,6 +8,7 @@
 - The `spout pngs` command now renders the histogram form for each variable
 - The `spout coverage` command now lists variables that are defined in the data dictionary and that do not exist in any CSV dataset
 - Added `spout outliers` command that returns a list of integer or numeric variables that contain major and minor outliers
+- Removed the deprecated `spout hybrid` command
 - **Gem Changes**
   - Updated to colorize 0.7.2
 - Use of Ruby 2.1.2 is now recommended

data/README.md

@@ -6,6 +6,8 @@
 
 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).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -217,25 +219,10 @@ 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
 
 ```
-spout -rows=10 ahi
+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`.
-
-
-### Export to the Hybrid Data Dictionary format from your JSON repository
-
-Exporting to a format compatible with [Hybrid](https://github.com/sleepepi/hybrid) is also available.
-
-```
-spout hybrid
-```
-
-You can optionally provide a version string
-
-```
-spout hybrid [1.0.0]
-```

data/lib/spout/actions.rb

@@ -17,8 +17,6 @@ module Spout
         import_from_csv(argv, 'domains')
       when 'export', 'e', 'ex', 'exp', '--export', '-e', '-ex', '-exp'
         new_data_dictionary_export(argv)
-      when 'hybrid', '-hybrid', '--hybrid', 'y', 'hy', '-y', '-hy'
-        new_data_dictionary_export(argv, 'hybrid')
       when 'coverage', '-coverage', '--coverage', 'c', '-c'
         coverage_report(argv)
       when 'pngs', '-pngs', '--pngs', 'p', '-p'
@@ -67,9 +65,7 @@ The most common spout commands are:
   [tv]              Run the tests and show passing and failing
                     tests
   [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
+  [e]xport [1.0.0]  Export the JSON dictionary to CSV format
   [c]overage        Coverage report, requires dataset CSVs
                     in `<project_name>/csvs/<version>`
   [o]utliers        Outlier report, requires dataset CSVs
@@ -89,11 +85,10 @@ EOT
         puts help_message
       end
 
-      def new_data_dictionary_export(argv, type = '')
+      def new_data_dictionary_export(argv)
         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 spout:create #{version_string} #{type_string}"
+        system "bundle exec rake spout:create #{version_string}"
       end
 
       def new_template_dictionary(argv)

data/lib/spout/tasks/engine.rake

@@ -23,15 +23,7 @@ namespace :spout do
     puts "      create".colorize( :green ) + "  #{folder}"
     FileUtils.mkpath folder
 
-    export_name = nil
-    additional_keys = []
-
-    if ENV['TYPE'] == 'hybrid'
-      export_name = 'hybrid'
-      additional_keys = [['hybrid', 'design_name'], ['hybrid', 'design_file'], ['hybrid', 'sensitivity'], ['hybrid', 'commonly_used']]
-    end
-
-    expanded_export(folder, export_name, additional_keys)
+    expanded_export(folder)
   end
 
   desc 'Initialize JSON repository from a CSV file: CSV=datadictionary.csv'
@@ -84,20 +76,20 @@ def standard_version
   version == '' ? '1.0.0' : version
 end
 
-def expanded_export(folder, export_name = nil, additional_keys = [])
-  variables_export_file = "#{[export_name, 'variables'].compact.join('-')}.csv"
+def expanded_export(folder)
+  variables_export_file = "variables.csv"
   puts "      export".colorize( :blue ) + "  #{folder}/#{variables_export_file}"
   CSV.open("#{folder}/#{variables_export_file}", "wb") do |csv|
     keys = %w(id display_name description type units domain labels calculation)
-    csv << ['folder'] + keys + additional_keys.collect{|i| i[1]}
+    csv << ['folder'] + keys
     Dir.glob("variables/**/*.json").each do |file|
       if json = JSON.parse(File.read(file)) rescue false
         variable_folder = variable_folder_path(file)
-        csv << [variable_folder] + keys.collect{|key| json[key].kind_of?(Array) ? json[key].join(';') : json[key].to_s} + additional_keys.collect{|i| other_property(i[0], json, i[1])}
+        csv << [variable_folder] + keys.collect{|key| json[key].kind_of?(Array) ? json[key].join(';') : json[key].to_s}
       end
     end
   end
-  domains_export_file = "#{[export_name, 'domains'].compact.join('-')}.csv"
+  domains_export_file = "domains.csv"
   puts "      export".colorize( :blue ) + "  #{folder}/#{domains_export_file}"
   CSV.open("#{folder}/#{domains_export_file}", "wb") do |csv|
     keys = %w(value display_name description)
@@ -126,10 +118,6 @@ def variable_folder_path(file)
   file.gsub(/variables\//, '').split('/')[0..-2].join('/')
 end
 
-def other_property(parent, json, property)
-  json[parent] ? json[parent][property] : ''
-end
-
 def import_variables
   CSV.parse( File.open(ENV['CSV'].to_s, 'r:iso-8859-1:utf-8'){|f| f.read}, headers: true ) do |line|
     row = line.to_hash

data/lib/spout/version.rb

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

data/lib/spout/views/index.html.erb

@@ -187,7 +187,7 @@ tfoot td {
               <tr>
                 <td>
                   <% csv_files.each do |csv_file| %>
-                    <code class="<%= 'success' if scr.number_of_errors == 0 %>"><%= csv_file %><code><br />
+                    <code class="<%= 'success' if scr.number_of_errors == 0 %>"><%= csv_file %></code><br />
                   <% end %>
                 </td>
                 <td><%= column %></td>

data/lib/spout/views/outliers.html.erb

@@ -116,7 +116,7 @@ tfoot td {
               <tr>
                 <td>
                   <% outlier_result.csv_files.each do |csv_file| %>
-                    <code class="<%= 'success' if outlier_result.outliers.size == 0 %>"><%= csv_file %><code><br />
+                    <code class="<%= 'success' if outlier_result.outliers.size == 0 %>"><%= csv_file %></code><br />
                   <% end %></td>
                 <td><%= outlier_result.method %></td>
                 <td>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.8.0.beta7
+  version: 0.8.0.beta8
 platform: ruby
 authors:
 - Remo Mueller