spout 0.8.0.beta10 → 0.8.0.beta11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85db9e44c8437edc8bf46ba106ec1030ce1adf06
-  data.tar.gz: 453e7af390a7cd5ec6fff0a0ca79bd10cb97e93e
+  metadata.gz: d24bb02bdd280c06d7525c64dcf7ba2e8d41cbdd
+  data.tar.gz: 4320a06b3bf72ef336bfd211e4b54c2cfbcc379d
 SHA512:
-  metadata.gz: 65fb80564f823a0539222ac7080ee782c88dd7859854f2c6f96d0413335a5fe1ffe1cdc04f43491431593728e8928db8a0c9b5b2bce947ef65043576719ec96e
-  data.tar.gz: b657059a6c7536a1e4166782c08100c564a5c79b6cef99afcc4bfe33211222a17ad2ab9ed65ea0fc63c8e9eef85de5a25d77bb7d7f0e4bb2548871824997ff63
+  metadata.gz: b6d305cc70fb6bcbd16e97c7450f0bed6f35bf456f93becc7ce23c97b766d5eda07a06c152941d3c127a61cd8042737013b99c01ba13563226a6bd3186453351
+  data.tar.gz: 2493538c40d38fb5708795f4c4b7dc75b0eb3ecf7ec119e0365244a38dae4f86753e60c5f6422bc1361e1e4b8319e8e61dcfcdbe65710745473043d885a8fb9e

data/CHANGELOG.md

@@ -14,6 +14,9 @@
   - Updated to colorize 0.7.2
 - Use of Ruby 2.1.2 is now recommended
 
+### Testing
+- Refactored Spout code and updated test coverage for all major spout commands
+
 ## 0.7.0 (April 16, 2014)
 
 ### Enhancements

data/README.md

@@ -37,6 +37,7 @@ 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`
+
 `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:
@@ -70,18 +71,21 @@ All other columns get grouped into a hash labeled `other`.
 #### Importing domains from an existing CSV file
 
 ```
-spout import_domains data_dictionary_domains.csv
+spout import data_dictionary_domains.csv --domains
 ```
 
 The CSV should contain at minimal three column headers:
 
 `domain_id`: The name of the associated domain for the choice/option.
+
 `value`: The value of the choice/option.
+
 `display_name`: The display name of the choice/option.
 
 Other columns that are imported include:
 
 `description`: A longer description of the choice/option.
+
 `folder`: The name of the folder path where the domain resides.
 
 
@@ -203,9 +207,12 @@ Example `.spout.yml` file:
 ```yml
 visit: visitnumber
 charts:
-  - age
-  - gender
-  - race
+- chart: age
+  title: Age
+- chart: gender
+  title: Gender
+- chart: race
+  title: Race
 ```
 
 To only generate graphs for a few select variables, add the variable names after the `spout graphs` command.

data/bin/spout

@@ -2,4 +2,4 @@
 
 require File.expand_path('../../lib/spout', __FILE__)
 
-Spout::Actions.new.interpret(ARGV)
+Spout.launch(ARGV)

data/lib/spout/actions.rb

@@ -1,172 +1,92 @@
-module Spout
-  class Actions
-
-    def interpret(argv)
-      case argv.first
-      when 'new', 'n', 'ne', '-new', '-n', '-ne'
-        new_template_dictionary(argv)
-      when '--version', '-v', '-ve', '-ver', 'version', 'v', 've', 'ver'
-        puts "Spout #{Spout::VERSION::STRING}"
-      when 'test', 't', 'te', 'tes', '--test', '-t', '-te', '-tes'
-        system "bundle exec rake HIDE_PASSING_TESTS=true"
-      when 'tv'
-        system "bundle exec rake"
-      when 'import', 'i', 'im', 'imp', '--import', '-i', '-im', '-imp'
-        import_from_csv(argv)
-      when 'import_domain', '--import_domain', 'import_domains', '--import_domains'
-        import_from_csv(argv, 'domains')
-      when 'export', 'e', 'ex', 'exp', '--export', '-e', '-ex', '-exp'
-        new_data_dictionary_export(argv)
-      when 'coverage', '-coverage', '--coverage', 'c', '-c'
-        coverage_report(argv)
-      when 'pngs', '-pngs', '--pngs', 'p', '-p'
-        generate_images(argv.last(argv.size - 1))
-      when 'graphs', '-graphs', '--graphs', 'g', '-g'
-        generate_charts_and_tables(argv.last(argv.size - 1))
-      when 'outliers', '-outliers', '--outliers', 'o', '-o'
-        outliers_report(argv)
-      else
-        help
-      end
-    end
-
-    protected
-
-      def csv_usage
-        usage = <<-EOT
-
-Usage: spout import CSVFILE
-
-The CSVFILE must be the location of a valid CSV file.
-
-EOT
-        usage
-      end
-
-      def import_from_csv(argv, type = "")
-        csv_file = File.join(argv[1].to_s.strip)
-        if File.exists?(csv_file)
-          system "bundle exec rake spout:import CSV=#{csv_file} #{'TYPE='+type if type.to_s != ''}"
-        else
-          puts csv_usage
-        end
-      end
-
-      def help
-        help_message = <<-EOT
-
-Usage: spout COMMAND [ARGS]
-
-The most common spout commands are:
-  [n]ew             Create a new Spout dictionary.
-                    `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 dictionary
-  [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
-                    in `<project_name>/csvs/<version>`
-  [p]ngs            Generates images for each variable in a
-                    dataset and places them
-                    in `<project_name>/images/<version>/`
-  [g]raphs          Generates JSON graphs for each variable
-                    in a dataset and places them
-                    in `<project_name>/graphs/<version>/`
-  [v]ersion         Returns the version of Spout
-
-Commands can be referenced by the first letter:
-  Ex: `spout t`, for test
-
-EOT
-        puts help_message
-      end
-
-      def new_data_dictionary_export(argv)
-        version = argv[1].to_s.gsub(/[^a-zA-Z0-9\.-]/, '_').strip
-        version_string = (version == '' ? "" : "VERSION=#{version}")
-        system "bundle exec rake spout:create #{version_string}"
-      end
-
-      def new_template_dictionary(argv)
-        @full_path = File.join(argv[1].to_s.strip)
-        usage = <<-EOT
-
-Usage: spout new FOLDER
-
-The FOLDER must be empty or new.
-
-EOT
-
-        if @full_path == '' or ( Dir.exists?(@full_path) and (Dir.entries(@full_path) & ['.gitignore', '.ruby-version', '.travis.yml', 'Gemfile', 'Rakefile', 'domains', 'variables', 'test']).size > 0 )
-          puts usage
-          exit(0)
-        end
-
-        FileUtils.mkpath(@full_path)
-
-        copy_file 'gitignore', '.gitignore'
-        copy_file 'ruby-version', '.ruby-version'
-        copy_file 'travis.yml', '.travis.yml'
-        copy_file 'Gemfile'
-        copy_file 'Rakefile'
-        directory 'domains'
-        copy_file 'keep', 'domains/.keep'
-        directory 'variables'
-        copy_file 'keep', 'variables/.keep'
-        directory 'test'
-        copy_file 'test/dictionary_test.rb'
-        copy_file 'test/test_helper.rb'
-        puts "         run".colorize( :green ) + "  bundle install".colorize( :light_cyan )
-        Dir.chdir(@full_path)
-        system "bundle install"
-      end
-
-      def coverage_report(argv)
-        system "bundle exec rake spout:coverage"
-      end
-
-      def outliers_report(argv)
-        system "bundle exec rake spout:outliers"
-      end
-
-      def flag_values(flags, param)
-        flags.select{|f| f[0..((param.size + 3) - 1)] == "--#{param}-" and f.length > param.size + 3}.collect{|f| f[(param.size + 3)..-1]}
-      end
-
-      def generate_images(flags)
-        params = {}
-        params['types']        = flag_values(flags, 'type')
-        params['variable_ids'] = flag_values(flags, 'id')
-        params['sizes']        = flag_values(flags, 'size')
-
-        params_string = params.collect{|key, values| "#{key}=#{values.join(',')}"}.join(' ')
-
-        system "bundle exec rake spout:images #{params_string}"
-      end
-
-      def generate_charts_and_tables(variables)
-        system "bundle exec rake spout:json variables=#{variables.join(',')}"
-      end
-
-    private
-
-      def copy_file(template_file, file_name = '')
-        file_name = template_file if file_name == ''
-        file_path = File.join(@full_path, file_name)
-        template_file_path = File.join(File.expand_path(File.dirname(__FILE__)), "templates", template_file)
-        puts "      create".colorize( :green ) + "  #{file_name}"
-        FileUtils.copy(template_file_path, file_path)
-      end
-
-      def directory(directory_name)
-        directory_path = File.join(@full_path, directory_name)
-        puts "      create".colorize( :green ) + "  #{directory_name}"
-        FileUtils.mkpath(directory_path)
-      end
-
-  end
-end
+# module Spout
+#   class Actions
+
+#     def interpret(argv)
+#       # case argv.first.to_s.scan(/\w/).first
+#       case argv.first
+#       when 'new', 'n', 'ne', '-new', '-n', '-ne'
+#         new_template_dictionary(argv)
+#       when '--version', '-v', '-ve', '-ver', 'version', 'v', 've', 'ver'
+#         puts "Spout #{Spout::VERSION::STRING}"
+#       when 'test', 't', 'te', 'tes', '--test', '-t', '-te', '-tes'
+#         system "bundle exec rake HIDE_PASSING_TESTS=true"
+#       # when 'tv'
+#       #   system "bundle exec rake"
+#       when 'import', 'i', 'im', 'imp', '--import', '-i', '-im', '-imp'
+#         import_from_csv(argv)
+#       when 'import_domain', '--import_domain', 'import_domains', '--import_domains'
+#         import_from_csv(argv, 'domains')
+#       when 'export', 'e', 'ex', 'exp', '--export', '-e', '-ex', '-exp'
+#         new_data_dictionary_export(argv)
+#       when 'coverage', '-coverage', '--coverage', 'c', '-c'
+#         coverage_report(argv)
+#       when 'pngs', '-pngs', '--pngs', 'p', '-p'
+#         generate_images(argv.last(argv.size - 1))
+#       when 'graphs', '-graphs', '--graphs', 'g', '-g'
+#         generate_charts_and_tables(argv.last(argv.size - 1))
+#       when 'outliers', '-outliers', '--outliers', 'o', '-o'
+#         outliers_report(argv)
+#       # else
+#       #   help
+#       end
+#     end
+
+#     protected
+
+#       def csv_usage
+#         usage = <<-EOT
+
+# Usage: spout import CSVFILE
+
+# The CSVFILE must be the location of a valid CSV file.
+
+# EOT
+#         usage
+#       end
+
+#       def import_from_csv(argv, type = "")
+#         csv_file = File.join(argv[1].to_s.strip)
+#         if File.exists?(csv_file)
+#           system "bundle exec rake spout:import CSV=#{csv_file} #{'TYPE='+type if type.to_s != ''}"
+#         else
+#           puts csv_usage
+#         end
+#       end
+
+#       def new_data_dictionary_export(argv)
+#         version = argv[1].to_s.gsub(/[^a-zA-Z0-9\.-]/, '_').strip
+#         version_string = (version == '' ? "" : "VERSION=#{version}")
+#         system "bundle exec rake spout:create #{version_string}"
+#       end
+
+#       def coverage_report(argv)
+#         require 'spout/commands/coverage'
+#         Spout::Commands::Coverage.new(standard_version, argv)
+#         # system "bundle exec rake spout:coverage"
+#       end
+
+#       def outliers_report(argv)
+#         system "bundle exec rake spout:outliers"
+#       end
+
+#       def flag_values(flags, param)
+#         flags.select{|f| f[0..((param.size + 3) - 1)] == "--#{param}-" and f.length > param.size + 3}.collect{|f| f[(param.size + 3)..-1]}
+#       end
+
+#       def generate_images(flags)
+#         params = {}
+#         params['types']        = flag_values(flags, 'type')
+#         params['variable_ids'] = flag_values(flags, 'id')
+#         params['sizes']        = flag_values(flags, 'size')
+
+#         params_string = params.collect{|key, values| "#{key}=#{values.join(',')}"}.join(' ')
+
+#         system "bundle exec rake spout:images #{params_string}"
+#       end
+
+#       def generate_charts_and_tables(variables)
+#         system "bundle exec rake spout:json variables=#{variables.join(',')}"
+#       end
+
+#   end
+# end

data/lib/spout/commands/coverage.rb

@@ -1,13 +1,18 @@
 require 'yaml'
+require 'erb'
 
 require 'spout/helpers/subject_loader'
 require 'spout/models/coverage_result'
+require 'spout/helpers/number_helper'
 
 module Spout
   module Commands
     class Coverage
-      def initialize(standard_version)
+      include Spout::Helpers::NumberHelper
+
+      def initialize(standard_version, argv)
         @standard_version = standard_version
+        @console = (argv.delete('--console') != nil)
 
         @variable_files = Dir.glob("variables/**/*.json")
         @valid_ids = []
@@ -60,10 +65,12 @@ module Spout
           file.puts ERB.new(File.read(erb_location)).result(binding)
         end
 
-        open_command = 'open'  if RUBY_PLATFORM.match(/darwin/) != nil
-        open_command = 'start' if RUBY_PLATFORM.match(/mingw/) != nil
+        unless @console
+          open_command = 'open'  if RUBY_PLATFORM.match(/darwin/) != nil
+          open_command = 'start' if RUBY_PLATFORM.match(/mingw/) != nil
 
-        system "#{open_command} #{coverage_file}" if ['start', 'open'].include?(open_command)
+          system "#{open_command} #{coverage_file}" if ['start', 'open'].include?(open_command)
+        end
         puts "#{coverage_file}\n\n"
       end
     end

data/lib/spout/commands/exporter.rb

@@ -0,0 +1,62 @@
+require 'csv'
+
+module Spout
+  module Commands
+    class Exporter
+      def initialize(standard_version, argv)
+        @csv_file = argv[1].to_s
+        @standard_version = standard_version
+        expanded_export!
+      end
+
+      private
+
+      def expanded_export!
+        folder = "dd/#{@standard_version}"
+        puts "      create".colorize( :green ) + "  #{folder}"
+        FileUtils.mkpath 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
+          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}
+            end
+          end
+        end
+        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)
+          csv << ['folder', 'domain_id'] + keys
+          Dir.glob("domains/**/*.json").each do |file|
+            if json = JSON.parse(File.read(file)) rescue false
+              domain_folder = domain_folder_path(file)
+              domain_name = extract_domain_name(file)
+              json.each do |hash|
+                csv << [domain_folder, domain_name] + keys.collect{|key| hash[key]}
+              end
+            end
+          end
+        end
+      end
+
+      def extract_domain_name(file)
+        file.gsub(/domains\//, '').split('/').last.to_s.gsub(/.json/, '')
+      end
+
+      def domain_folder_path(file)
+        file.gsub(/domains\//, '').split('/')[0..-2].join('/')
+      end
+
+      def variable_folder_path(file)
+        file.gsub(/variables\//, '').split('/')[0..-2].join('/')
+      end
+
+    end
+  end
+end

data/lib/spout/commands/graphs.rb

@@ -28,7 +28,7 @@ module Spout
         else
           puts "The YAML file needs to be in the following format:"
           puts "---\nvisit: visit_variable_name\ncharts:\n- chart: age_variable_name\n  title: Age\n- chart: gender_variable_name\n  title: Gender\n- chart: race_variable_name\n  title: Race\n"
-          exit
+          return self
         end
 
         if Spout::Helpers::ChartTypes::get_json(@visit, 'variable') == nil
@@ -37,12 +37,12 @@ module Spout
           else
             puts "Could not find the following visit variable: #{@visit}"
           end
-          exit
+          return self
         end
         missing_variables = chart_variables.select{|c| Spout::Helpers::ChartTypes::get_json(c['chart'], 'variable') == nil}
         if missing_variables.count > 0
           puts "Could not find the following chart variable#{'s' unless missing_variables.size == 1}: #{missing_variables.join(', ')}"
-          exit
+          return self
         end
 
         argv_string = variables.join(',')

data/lib/spout/commands/images.rb

@@ -11,9 +11,11 @@ module Spout
   module Commands
     class Images
 
-      def initialize(types, variable_ids, sizes, standard_version)
+      def initialize(types, variable_ids, sizes, standard_version, argv)
         @variable_files = Dir.glob('variables/**/*.json')
         @standard_version = standard_version
+        @pretend = (argv.delete('--pretend') != nil)
+
 
         @valid_ids = variable_ids
 
@@ -60,42 +62,44 @@ module Spout
 
           filtered_subjects = @subjects.select{ |s| s.send(@visit) != nil }
 
-          File.open(tmp_options_file, "w") do |outfile|
-            chart_json = Spout::Helpers::ChartTypes::chart_histogram(@visit, filtered_subjects, json, variable_name)
-            outfile.puts <<-eos
-              {
-                "credits": {
-                  "enabled": false
-                },
-                "chart": {
-                  "type": "column"
-                },
-                "title": {
-                  "text": ""
-                },
-                "xAxis": {
-                  "categories": #{chart_json[:categories].to_json}
-                },
-                "yAxis": {
+          chart_json = Spout::Helpers::ChartTypes::chart_histogram(@visit, filtered_subjects, json, variable_name)
+
+          if chart_json
+            File.open(tmp_options_file, "w") do |outfile|
+              outfile.puts <<-eos
+                {
+                  "credits": {
+                    "enabled": false
+                  },
+                  "chart": {
+                    "type": "column"
+                  },
                   "title": {
-                    "text": #{chart_json[:units].to_json}
-                  }
-                },
-                "plotOptions": {
-                  "column": {
-                    "pointPadding": 0.2,
-                    "borderWidth": 0,
-                    "stacking": #{chart_json[:stacking].to_json}
-                  }
-                },
-                "series": #{chart_json[:series].to_json}
-              }
-            eos
+                    "text": ""
+                  },
+                  "xAxis": {
+                    "categories": #{chart_json[:categories].to_json}
+                  },
+                  "yAxis": {
+                    "title": {
+                      "text": #{chart_json[:units].to_json}
+                    }
+                  },
+                  "plotOptions": {
+                    "column": {
+                      "pointPadding": 0.2,
+                      "borderWidth": 0,
+                      "stacking": #{chart_json[:stacking].to_json}
+                    }
+                  },
+                  "series": #{chart_json[:series].to_json}
+                }
+              eos
+            end
+            run_phantom_js("#{json['id']}-lg.png", 600, tmp_options_file) if sizes.size == 0 or sizes.include?('lg')
+            run_phantom_js("#{json['id']}.png",     75, tmp_options_file) if sizes.size == 0 or sizes.include?('sm')
           end
 
-
-          run_phantom_js("#{json['id']}-lg.png", 600, tmp_options_file) if sizes.size == 0 or sizes.include?('lg')
-          run_phantom_js("#{json['id']}.png",     75, tmp_options_file) if sizes.size == 0 or sizes.include?('sm')
         end
         File.delete(tmp_options_file) if File.exists?(tmp_options_file)
       end
@@ -267,8 +271,13 @@ module Spout
         end
 
         phantomjs_command = "#{open_command} #{directory}/highcharts-convert.js -infile #{tmp_options_file} -outfile #{graph_path} -scale 2.5 -width #{width} -constr Chart"
-        # puts phantomjs_command
-        `#{phantomjs_command}`
+
+        if @pretend
+          puts phantomjs_command
+        else
+          `#{phantomjs_command}`
+        end
+
       end
 
     end

data/lib/spout/commands/importer.rb

@@ -0,0 +1,125 @@
+require 'csv'
+
+module Spout
+  module Commands
+    class Importer
+      def initialize(argv)
+        use_domains = (argv.delete('--domains') != nil)
+
+        @csv_file = argv[1].to_s
+
+        unless File.exists?(@csv_file)
+          puts csv_usage
+          return self
+        end
+
+        if use_domains
+          import_domains
+        else
+          import_variables
+        end
+
+      end
+
+      def csv_usage
+        usage = <<-EOT
+
+Usage: spout import CSVFILE
+
+The CSVFILE must be the location of a valid CSV file.
+
+EOT
+        usage
+      end
+
+      def import_variables
+        CSV.parse( File.open(@csv_file, 'r:iso-8859-1:utf-8'){|f| f.read}, headers: true ) do |line|
+          row = line.to_hash
+          if not row.keys.include?('id')
+            puts "\nMissing column header `".colorize( :red ) + "id".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
+            exit(1)
+          end
+          next if row['id'] == ''
+          folder = File.join('variables', row.delete('folder').to_s)
+          FileUtils.mkpath folder
+          hash = {}
+          id = row.delete('id')
+          hash['id'] = id
+          hash['display_name'] = row.delete('display_name')
+          hash['description'] = row.delete('description').to_s
+          hash['type'] = row.delete('type')
+          domain = row.delete('domain').to_s
+          hash['domain'] = domain if domain != ''
+          units = row.delete('units').to_s
+          hash['units'] = units if units != ''
+          calculation = row.delete('calculation').to_s
+          hash['calculation'] = calculation if calculation != ''
+          labels = row.delete('labels').to_s.split(';')
+          hash['labels'] = labels if labels.size > 0
+          hash['other'] = row unless row.empty?
+
+          file_name = File.join(folder, id.to_s.downcase + '.json')
+          File.open(file_name, 'w') do |file|
+            file.write(JSON.pretty_generate(hash) + "\n")
+          end
+          puts "      create".colorize( :green ) + "  #{file_name}"
+        end
+      end
+
+      def import_domains
+        domains = {}
+
+        CSV.parse( File.open(@csv_file, 'r:iso-8859-1:utf-8'){|f| f.read}, headers: true ) do |line|
+          row = line.to_hash
+          if not row.keys.include?('domain_id')
+            puts "\nMissing column header `".colorize( :red ) + "domain_id".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
+            exit(1)
+          end
+          if not row.keys.include?('value')
+            puts "\nMissing column header `".colorize( :red ) + "value".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
+            exit(1)
+          end
+          if not row.keys.include?('display_name')
+            puts "\nMissing column header `".colorize( :red ) + "display_name".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
+            exit(1)
+          end
+
+          next if row['domain_id'].to_s == '' or row['value'].to_s == '' or row['display_name'].to_s == ''
+          folder = File.join('domains', row['folder'].to_s).gsub(/[^a-zA-Z0-9_\/\.-]/, '_')
+          domain_name = row['domain_id'].to_s.gsub(/[^a-zA-Z0-9_\/\.-]/, '_')
+          domains[domain_name] ||= {}
+          domains[domain_name]["folder"] = folder
+          domains[domain_name]["options"] ||= []
+
+          hash = {}
+          hash['value'] = row.delete('value').to_s
+          hash['display_name'] = row.delete('display_name').to_s
+          hash['description'] = row.delete('description').to_s
+
+          domains[domain_name]["options"] << hash
+        end
+
+        domains.each do |domain_name, domain_hash|
+          folder = domain_hash["folder"]
+          FileUtils.mkpath folder
+
+          file_name = File.join(folder, domain_name.to_s.downcase + '.json')
+
+          File.open(file_name, 'w') do |file|
+            file.write(JSON.pretty_generate(domain_hash["options"]) + "\n")
+          end
+          puts "      create".colorize( :green ) + "  #{file_name}"
+        end
+
+      end
+
+      private
+
+      def additional_csv_info
+        "\n\nFor additional information on specifying CSV column headers before import see:\n\n    " + "https://github.com/sleepepi/spout#generate-a-new-repository-from-an-existing-csv-file".colorize( :light_cyan ) + "\n\n"
+      end
+
+
+    end
+  end
+end

data/lib/spout/commands/outliers.rb

@@ -1,13 +1,18 @@
 require 'yaml'
+require 'erb'
 
 require 'spout/helpers/subject_loader'
 require 'spout/models/outlier_result'
+require 'spout/helpers/number_helper'
 
 module Spout
   module Commands
     class Outliers
-      def initialize(standard_version)
+      include Spout::Helpers::NumberHelper
+
+      def initialize(standard_version, argv)
         @standard_version = standard_version
+        @console = (argv.delete('--console') != nil)
 
         @variable_files = Dir.glob('variables/**/*.json')
         @valid_ids = []
@@ -19,6 +24,7 @@ module Spout
         @subject_loader = Spout::Helpers::SubjectLoader.new(@variable_files, @valid_ids, @standard_version, @number_of_rows, @visit)
         @subject_loader.load_subjects_from_csvs!
         @subjects = @subject_loader.subjects
+        run_outliers_report!
       end
 
       def run_outliers_report!
@@ -47,13 +53,15 @@ module Spout
           file.puts ERB.new(File.read(erb_location)).result(binding)
         end
 
-        open_command = 'open'  if RUBY_PLATFORM.match(/darwin/) != nil
-        open_command = 'start' if RUBY_PLATFORM.match(/mingw/) != nil
+        unless @console
+          open_command = 'open'  if RUBY_PLATFORM.match(/darwin/) != nil
+          open_command = 'start' if RUBY_PLATFORM.match(/mingw/) != nil
 
-        system "#{open_command} #{html_file}" if ['start', 'open'].include?(open_command)
+          system "#{open_command} #{html_file}" if ['start', 'open'].include?(open_command)
+        end
         puts "#{html_file}\n\n"
+        return self
       end
-
     end
   end
 end

data/lib/spout/commands/project_generator.rb

@@ -0,0 +1,66 @@
+TEMPLATES_DIRECTORY = File.expand_path('../../templates', __FILE__)
+
+module Spout
+  module Commands
+    class ProjectGenerator
+      def initialize(argv)
+        generate_folder_structure!(argv)
+      end
+
+      def generate_folder_structure!(argv)
+        skip_gemfile = (argv.delete('--skip-gemfile') != nil)
+        @full_path = File.join(argv[1].to_s.strip)
+        usage = <<-EOT
+
+Usage: spout new FOLDER
+
+The FOLDER must be empty or new.
+
+EOT
+
+        if @full_path == '' or ( Dir.exists?(@full_path) and (Dir.entries(@full_path) & ['.gitignore', '.ruby-version', '.travis.yml', 'Gemfile', 'Rakefile', 'domains', 'variables', 'test']).size > 0 )
+          puts usage
+          exit(0)
+        end
+
+        FileUtils.mkpath(@full_path)
+
+        copy_file 'gitignore', '.gitignore'
+        copy_file 'ruby-version', '.ruby-version'
+        copy_file 'travis.yml', '.travis.yml'
+        copy_file 'spout.yml', '.spout.yml'
+        copy_file 'Gemfile'
+        copy_file 'Rakefile'
+        directory 'domains'
+        copy_file 'keep', 'domains/.keep'
+        directory 'variables'
+        copy_file 'keep', 'variables/.keep'
+        directory 'test'
+        copy_file 'test/dictionary_test.rb'
+        copy_file 'test/test_helper.rb'
+        unless skip_gemfile
+          puts "         run".colorize( :green ) + "  bundle install".colorize( :light_cyan )
+          Dir.chdir(@full_path)
+          system "bundle install"
+        end
+      end
+
+      private
+
+      def copy_file(template_file, file_name = '')
+        file_name = template_file if file_name == ''
+        file_path = File.join(@full_path, file_name)
+        template_file_path = File.join(TEMPLATES_DIRECTORY, template_file)
+        puts "      create".colorize( :green ) + "  #{file_name}"
+        FileUtils.copy(template_file_path, file_path)
+      end
+
+      def directory(directory_name)
+        directory_path = File.join(@full_path, directory_name)
+        puts "      create".colorize( :green ) + "  #{directory_name}"
+        FileUtils.mkpath(directory_path)
+      end
+
+    end
+  end
+end

data/lib/spout/helpers/number_helper.rb

@@ -0,0 +1,9 @@
+module Spout
+  module Helpers
+    module NumberHelper
+      def number_with_delimiter(number, delimiter = ",")
+        number.to_s.reverse.scan(/(?:\d*\.)?\d{1,3}-?/).join(',').reverse
+      end
+    end
+  end
+end

data/lib/spout/helpers/subject_loader.rb

@@ -1,5 +1,7 @@
-require 'spout/models/subject'
+require 'csv'
+require 'json'
 
+require 'spout/models/subject'
 
 module Spout
   module Helpers
@@ -31,7 +33,6 @@ module Spout
           count = 0
           puts "Parsing: #{csv_file}"
           CSV.parse( File.open(csv_file, 'r:iso-8859-1:utf-8'){|f| f.read}, headers: true, header_converters: lambda { |h| h.to_s.downcase } ) do |line|
-
             row = line.to_hash
             count += 1
             puts "Line: #{count}" if (count % 1000 == 0)
@@ -42,10 +43,11 @@ module Spout
                 unless t.respond_to?(key)
                   t.class.send(:define_method, "#{key}") { instance_variable_get("@#{key}") }
                   t.class.send(:define_method, "#{key}=") { |value| instance_variable_set("@#{key}", value) }
-                  all_methods[key] ||= []
-                  all_methods[key] << csv_file
                 end
 
+                @all_methods[key] ||= []
+                @all_methods[key] = @all_methods[key] | [csv_file]
+
                 unless value == nil
                   t.send("#{key}=", value)
                 end

data/lib/spout/tasks/engine.rake

@@ -9,196 +9,3 @@ Rake::TestTask.new do |t|
 end
 
 task default: :test
-
-namespace :spout do
-  require 'csv'
-  require 'fileutils'
-  require 'rubygems'
-  require 'json'
-  require 'erb'
-
-  desc 'Create Data Dictionary from repository'
-  task :create do
-    folder = "dd/#{ENV['VERSION'] || standard_version}"
-    puts "      create".colorize( :green ) + "  #{folder}"
-    FileUtils.mkpath folder
-
-    expanded_export(folder)
-  end
-
-  desc 'Initialize JSON repository from a CSV file: CSV=datadictionary.csv'
-  task :import do
-    puts ENV['CSV'].inspect
-    if File.exists?(ENV['CSV'].to_s)
-      ENV['TYPE'] == 'domains' ? import_domains : import_variables
-    else
-      puts "\nPlease specify a valid CSV file.".colorize( :red ) + additional_csv_info
-    end
-  end
-
-  desc 'Match CSV dataset with JSON repository'
-  task :coverage do
-    require 'spout/commands/coverage'
-    Spout::Commands::Coverage.new(standard_version)
-  end
-
-  desc 'Identify Outliers in CSV dataset'
-  task :outliers do
-    require 'spout/commands/outliers'
-    outliers = Spout::Commands::Outliers.new(standard_version)
-    outliers.run_outliers_report!
-  end
-
-  desc 'Match CSV dataset with JSON repository'
-  task :images do
-    require 'spout/commands/images'
-    types         = ENV['types'].to_s.split(',').collect{|t| t.to_s.downcase}
-    variable_ids  = ENV['variable_ids'].to_s.split(',').collect{|vid| vid.to_s.downcase}
-    sizes         = ENV['sizes'].to_s.split(',').collect{|s| s.to_s.downcase}
-    Spout::Commands::Images.new(types, variable_ids, sizes, standard_version)
-  end
-
-  desc 'Generate JSON charts and tables'
-  task :json do
-    require 'spout/commands/graphs'
-    variables = ENV['variables'].to_s.split(',').collect{|s| s.to_s.downcase}
-    Spout::Commands::Graphs.new(variables, standard_version)
-  end
-
-end
-
-def number_with_delimiter(number, delimiter = ",")
-  number.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
-end
-
-def standard_version
-  version = File.open('VERSION', &:readline).strip rescue ''
-  version == '' ? '1.0.0' : version
-end
-
-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
-    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}
-      end
-    end
-  end
-  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)
-    csv << ['folder', 'domain_id'] + keys
-    Dir.glob("domains/**/*.json").each do |file|
-      if json = JSON.parse(File.read(file)) rescue false
-        domain_folder = domain_folder_path(file)
-        domain_name = extract_domain_name(file)
-        json.each do |hash|
-          csv << [domain_folder, domain_name] + keys.collect{|key| hash[key]}
-        end
-      end
-    end
-  end
-end
-
-def extract_domain_name(file)
-  file.gsub(/domains\//, '').split('/').last.to_s.gsub(/.json/, '')
-end
-
-def domain_folder_path(file)
-  file.gsub(/domains\//, '').split('/')[0..-2].join('/')
-end
-
-def variable_folder_path(file)
-  file.gsub(/variables\//, '').split('/')[0..-2].join('/')
-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
-    if not row.keys.include?('id')
-      puts "\nMissing column header `".colorize( :red ) + "id".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
-      exit(1)
-    end
-    next if row['id'] == ''
-    folder = File.join('variables', row.delete('folder').to_s)
-    FileUtils.mkpath folder
-    hash = {}
-    id = row.delete('id')
-    hash['id'] = id
-    hash['display_name'] = row.delete('display_name')
-    hash['description'] = row.delete('description').to_s
-    hash['type'] = row.delete('type')
-    domain = row.delete('domain').to_s
-    hash['domain'] = domain if domain != ''
-    units = row.delete('units').to_s
-    hash['units'] = units if units != ''
-    calculation = row.delete('calculation').to_s
-    hash['calculation'] = calculation if calculation != ''
-    labels = row.delete('labels').to_s.split(';')
-    hash['labels'] = labels if labels.size > 0
-    hash['other'] = row unless row.empty?
-
-    file_name = File.join(folder, id.to_s.downcase + '.json')
-    File.open(file_name, 'w') do |file|
-      file.write(JSON.pretty_generate(hash) + "\n")
-    end
-    puts "      create".colorize( :green ) + "  #{file_name}"
-  end
-end
-
-def import_domains
-  domains = {}
-
-  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
-    if not row.keys.include?('domain_id')
-      puts "\nMissing column header `".colorize( :red ) + "domain_id".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
-      exit(1)
-    end
-    if not row.keys.include?('value')
-      puts "\nMissing column header `".colorize( :red ) + "value".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
-      exit(1)
-    end
-    if not row.keys.include?('display_name')
-      puts "\nMissing column header `".colorize( :red ) + "display_name".colorize( :light_cyan ) + "` in data dictionary.".colorize( :red ) + additional_csv_info
-      exit(1)
-    end
-
-    next if row['domain_id'].to_s == '' or row['value'].to_s == '' or row['display_name'].to_s == ''
-    folder = File.join('domains', row['folder'].to_s).gsub(/[^a-zA-Z0-9_\/\.-]/, '_')
-    domain_name = row['domain_id'].to_s.gsub(/[^a-zA-Z0-9_\/\.-]/, '_')
-    domains[domain_name] ||= {}
-    domains[domain_name]["folder"] = folder
-    domains[domain_name]["options"] ||= []
-
-    hash = {}
-    hash['value'] = row.delete('value').to_s
-    hash['display_name'] = row.delete('display_name').to_s
-    hash['description'] = row.delete('description').to_s
-
-    domains[domain_name]["options"] << hash
-  end
-
-  domains.each do |domain_name, domain_hash|
-    folder = domain_hash["folder"]
-    FileUtils.mkpath folder
-
-    file_name = File.join(folder, domain_name.to_s.downcase + '.json')
-
-    File.open(file_name, 'w') do |file|
-      file.write(JSON.pretty_generate(domain_hash["options"]) + "\n")
-    end
-    puts "      create".colorize( :green ) + "  #{file_name}"
-  end
-
-end
-
-def additional_csv_info
-  "\n\nFor additional information on specifying CSV column headers before import see:\n\n    " + "https://github.com/sleepepi/spout#generate-a-new-repository-from-an-existing-csv-file".colorize( :light_cyan ) + "\n\n"
-end

data/lib/spout/templates/ruby-version

@@ -1 +1 @@
-ruby-2.1.1
+ruby-2.1.2

data/lib/spout/templates/spout.yml

@@ -0,0 +1,2 @@
+visit: visit
+charts: []

data/lib/spout/version.rb

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

data/lib/spout.rb

@@ -1,8 +1,115 @@
 require "spout/version"
-require "spout/actions"
 require "spout/application"
 require 'spout/tasks'
 
+Spout::COMMANDS = {
+  'n' => :new_project,
+  'v' => :version,
+  't' => :test,
+  'i' => :importer,
+  'e' => :exporter,
+  'c' => :coverage_report,
+  'p' => :generate_images,
+  'g' => :generate_charts_and_tables,
+  'o' => :outliers_report
+}
+
 module Spout
+  def self.launch(argv)
+    self.send((Spout::COMMANDS[argv.first.to_s.scan(/\w/).first] || :help), argv)
+  end
+
+  def self.new_project(argv)
+    require 'spout/commands/project_generator'
+    Spout::Commands::ProjectGenerator.new(argv)
+  end
+
+  def self.coverage_report(argv)
+    require 'spout/commands/coverage'
+    Spout::Commands::Coverage.new(standard_version, argv)
+  end
+
+  def self.exporter(argv)
+    require 'spout/commands/exporter'
+    Spout::Commands::Exporter.new(standard_version, argv)
+  end
+
+  def self.generate_charts_and_tables(argv)
+    argv = argv.last(argv.size - 1)
+    require 'spout/commands/graphs'
+    variables = argv.collect{|s| s.to_s.downcase}
+    Spout::Commands::Graphs.new(variables, standard_version)
+  end
+
+  def self.generate_images(argv)
+    argv = argv.last(argv.size - 1)
+    require 'spout/commands/images'
+    types         = flag_values(argv, 'type')
+    variable_ids  = flag_values(argv, 'id')
+    sizes         = flag_values(argv, 'size')
+    Spout::Commands::Images.new(types, variable_ids, sizes, standard_version, argv)
+  end
+
+  def self.help(argv)
+    puts <<-EOT
+
+Usage: spout COMMAND [ARGS]
+
+The most common spout commands are:
+  [n]ew             Create a new Spout dictionary.
+                    `spout new <project_name>` creates a new
+                    data dictionary in `./<project_name>`
+  [t]est            Run tests and show failing tests
+  [t] --verbose     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 CSV format
+  [c]overage        Coverage report, requires dataset CSVs
+                    in `<project_name>/csvs/<version>`
+  [o]utliers        Outlier report, requires dataset CSVs
+                    in `<project_name>/csvs/<version>`
+  [p]ngs            Generates images for each variable in a
+                    dataset and places them
+                    in `<project_name>/images/<version>/`
+  [g]raphs          Generates JSON graphs for each variable
+                    in a dataset and places them
+                    in `<project_name>/graphs/<version>/`
+  [v]ersion         Returns the version of Spout
+
+Commands can be referenced by the first letter:
+  Ex: `spout t`, for test
+
+EOT
+  end
+
+  def self.importer(argv)
+    require 'spout/commands/importer'
+    Spout::Commands::Importer.new(argv)
+  end
+
+  def self.outliers_report(argv)
+    require 'spout/commands/outliers'
+    Spout::Commands::Outliers.new(standard_version, argv)
+  end
+
+  def self.test(argv)
+    hide_passing_tests = (argv.delete('--verbose') == nil)
+    system "bundle exec rake#{' HIDE_PASSING_TESTS=true' if hide_passing_tests}"
+  end
+
+  def self.version(argv)
+    puts "Spout #{Spout::VERSION::STRING}"
+  end
+
+  def self.standard_version
+    version = File.open('VERSION', &:readline).strip rescue ''
+    version == '' ? '1.0.0' : version
+  end
+
+  private
+
+  def self.flag_values(flags, param)
+    flags.select{|f| f[0..((param.size + 3) - 1)] == "--#{param}-" and f.length > param.size + 3}.collect{|f| f[(param.size + 3)..-1]}
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.8.0.beta10
+  version: 0.8.0.beta11
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,12 +98,16 @@ files:
 - lib/spout/actions.rb
 - lib/spout/application.rb
 - lib/spout/commands/coverage.rb
+- lib/spout/commands/exporter.rb
 - lib/spout/commands/graphs.rb
 - lib/spout/commands/images.rb
+- lib/spout/commands/importer.rb
 - lib/spout/commands/outliers.rb
+- lib/spout/commands/project_generator.rb
 - lib/spout/helpers/array_statistics.rb
 - lib/spout/helpers/chart_types.rb
 - lib/spout/helpers/json_loader.rb
+- lib/spout/helpers/number_helper.rb
 - lib/spout/helpers/subject_loader.rb
 - lib/spout/helpers/table_formatting.rb
 - lib/spout/hidden_reporter.rb
@@ -122,6 +126,7 @@ files:
 - lib/spout/templates/gitignore
 - lib/spout/templates/keep
 - lib/spout/templates/ruby-version
+- lib/spout/templates/spout.yml
 - lib/spout/templates/test/dictionary_test.rb
 - lib/spout/templates/test/test_helper.rb
 - lib/spout/templates/travis.yml