spout 0.12.1 → 0.13.0.beta1

data/lib/spout/commands/update.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'colorize'
-require 'spout/helpers/json_request'
-require 'spout/helpers/framework'
+require "colorize"
+require "spout/helpers/json_request"
+require "spout/helpers/framework"
 
 module Spout
   module Commands
@@ -17,27 +17,27 @@ module Spout
       end
 
       def initialize(argv)
-        @full_path = File.join('.')
+        @full_path = File.join(".")
       end
 
       def start
-        (json, _status) = Spout::Helpers::JsonRequest.get('https://rubygems.org/api/v1/gems/spout.json')
+        (json, _status) = Spout::Helpers::JsonRequest.get("https://rubygems.org/api/v1/gems/spout.json")
         if json
-          if json['version'] == Spout::VERSION::STRING
-            puts 'The spout gem is ' + 'up-to-date'.colorize(:green) + '!'
-            check_framework if File.exist?('Gemfile')
+          if json["version"] == Spout::VERSION::STRING
+            puts "The spout gem is " + "up-to-date".colorize(:green) + "!"
+            check_framework if File.exist?("Gemfile")
           else
             puts "A newer version (v#{json['version']}) is available!\n\n"
-            if File.exist?('Gemfile')
-              puts 'Add the following to your Gemfile and run ' + 'bundle update'.colorize(:green) + ".\n\n"
-              puts "  gem 'spout', '~> #{json['version']}'\n".colorize(:white)
+            if File.exist?("Gemfile")
+              puts "Add the following to your Gemfile and run " + "bundle update".colorize(:green) + ".\n\n"
+              puts "  gem \"spout\", \"~> #{json['version']}\"\n".colorize(:white)
             else
               puts "Type the following command to update:\n\n"
-              puts '  gem install spout --no-document'.colorize(:white) + "\n\n"
+              puts "  gem install spout --no-document".colorize(:white) + "\n\n"
             end
           end
         else
-          puts 'Unable to connect to RubyGems.org. Please try again later.'
+          puts "Unable to connect to RubyGems.org. Please try again later."
         end
       end
 
@@ -50,62 +50,62 @@ module Spout
       end
 
       def check_gitignore_file
-        if File.exist?('.gitignore')
-          lines = IO.readlines('.gitignore').collect(&:strip)
-          addables = ['/coverage', '/csvs', '/exports', '/graphs']
-          removables = ['/dd', '/images']
+        if File.exist?(".gitignore")
+          lines = IO.readlines(".gitignore").collect(&:strip)
+          addables = ["/coverage", "/csvs", "/exports", "/graphs"]
+          removables = ["/dd", "/images"]
           unless ((removables & lines) | (addables - lines)).empty?
-            puts 'File: ' + '.gitignore'.colorize(:white)
-            puts '----------------'
+            puts "File: " + ".gitignore".colorize(:white)
+            puts "----------------"
             (removables & lines).each do |removable|
-              puts 'REMOVE LINE '.colorize(:red) + removable.colorize(:white)
+              puts "REMOVE LINE ".colorize(:red) + removable.colorize(:white)
             end
             (addables - lines).each do |addable|
-              puts '   ADD LINE '.colorize(:green) + addable.colorize(:white)
+              puts "   ADD LINE ".colorize(:green) + addable.colorize(:white)
             end
             puts
           end
         else
-          copy_file 'gitignore', '.gitignore'
+          copy_file "gitignore", ".gitignore"
         end
       end
 
       def check_ruby_version
-        if File.exist?('.ruby-version')
-          lines = IO.readlines('.ruby-version').collect(&:strip)
-          template_lines = IO.readlines(File.expand_path('../../templates/ruby-version', __FILE__)).collect(&:strip)
+        if File.exist?(".ruby-version")
+          lines = IO.readlines(".ruby-version").collect(&:strip)
+          template_lines = IO.readlines(File.expand_path("../../templates/ruby-version", __FILE__)).collect(&:strip)
           if template_lines.first != lines.first
-            puts 'File: ' + '.ruby-version'.colorize(:white)
-            puts '-------------------'
-            print 'Update Ruby from ' + lines.first.to_s.colorize(:red)
-            print ' to ' + template_lines.first.to_s.colorize(:green)
+            puts "File: " + ".ruby-version".colorize(:white)
+            puts "-------------------"
+            print "Update Ruby from " + lines.first.to_s.colorize(:red)
+            print " to " + template_lines.first.to_s.colorize(:green)
             puts "\n\n"
           end
         else
-          copy_file 'ruby-version', '.ruby-version'
+          copy_file "ruby-version", ".ruby-version"
         end
       end
 
       def check_file_presence
         @project_name = File.basename(Dir.pwd)
-        evaluate_file 'CHANGELOG.md.erb', 'CHANGELOG.md' unless File.exist?('CHANGELOG.md')
-        evaluate_file 'README.md.erb', 'README.md' unless File.exist?('README.md')
-        copy_file 'VERSION' unless File.exist?('VERSION')
+        evaluate_file "CHANGELOG.md.erb", "CHANGELOG.md" unless File.exist?("CHANGELOG.md")
+        evaluate_file "README.md.erb", "README.md" unless File.exist?("README.md")
+        copy_file "VERSION" unless File.exist?("VERSION")
       end
 
       def check_folder_presence
         folders = %w(domains forms variables).reject { |f| Dir.exist?(f) }
         folders.each do |folder|
           directory folder
-          copy_file 'keep', "#{folder}/.keep"
+          copy_file "keep", "#{folder}/.keep"
         end
       end
 
       def check_test_folder
-        return if Dir.exist?('test')
-        directory 'test'
-        copy_file 'test/dictionary_test.rb'
-        copy_file 'test/test_helper.rb'
+        return if Dir.exist?("test")
+        directory "test"
+        copy_file "test/dictionary_test.rb"
+        copy_file "test/test_helper.rb"
       end
     end
   end

data/lib/spout/helpers/array_statistics.rb

@@ -116,13 +116,13 @@ module Spout
   module Helpers
     class ArrayStatistics
       def self.calculations
-        [['N', :n, :count],
-         ['Mean', :mean, :decimal],
-         ['StdDev', :standard_deviation, :decimal, '± %s'],
-         ['Median', :median, :decimal],
-         ['Min', :compact_min, :decimal],
-         ['Max', :compact_max, :decimal],
-         ['Unknown', :unknown, :count]]
+        [["N", :n, :count],
+         ["Mean", :mean, :decimal],
+         ["StdDev", :standard_deviation, :decimal, "± %s"],
+         ["Median", :median, :decimal],
+         ["Min", :compact_min, :decimal],
+         ["Max", :compact_max, :decimal],
+         ["Unknown", :unknown, :count]]
       end
     end
   end

data/lib/spout/helpers/chart_types.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spout/helpers/array_statistics'
-require 'spout/helpers/table_formatting'
+require "spout/helpers/array_statistics"
+require "spout/helpers/table_formatting"
 
 module Spout
   module Helpers

data/lib/spout/helpers/config_reader.rb

@@ -1,45 +1,46 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module Spout
   module Helpers
+    # Loads the .spout.yml configuration file.
     class ConfigReader
-
       attr_reader :slug, :visit, :charts, :webservers
 
       def initialize
-        @slug = ''
-        @visit = ''
+        @slug = ""
+        @visit = ""
         @charts = []
         @webservers = []
         parse_yaml_file
       end
 
       def parse_yaml_file
-        spout_config = YAML.load_file('.spout.yml')
+        spout_config = YAML.load_file(".spout.yml")
 
         if spout_config.is_a?(Hash)
-          @slug = spout_config['slug'].to_s.strip
-          @visit = spout_config['visit'].to_s.strip
-
-          @charts = if spout_config['charts'].is_a?(Array)
-            spout_config['charts'].select{|c| c.is_a?(Hash)}
-          else
-            []
-          end
-
-          @webservers = if spout_config['webservers'].is_a?(Array)
-            spout_config['webservers'].select{|c| c.is_a?(Hash)}
-          else
-            []
-          end
+          @slug = spout_config["slug"].to_s.strip
+          @visit = spout_config["visit"].to_s.strip
+
+          @charts = \
+            if spout_config["charts"].is_a?(Array)
+              spout_config["charts"].select { |c| c.is_a?(Hash) }
+            else
+              []
+            end
+
+          @webservers = \
+            if spout_config["webservers"].is_a?(Array)
+              spout_config["webservers"].select { |c| c.is_a?(Hash) }
+            else
+              []
+            end
         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"
         end
       end
-
     end
   end
 end

data/lib/spout/helpers/framework.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require 'colorize'
-require 'date'
-require 'erb'
-require 'fileutils'
+require "colorize"
+require "date"
+require "erb"
+require "fileutils"
 
-TEMPLATES_DIRECTORY = File.expand_path('../../templates', __FILE__)
+TEMPLATES_DIRECTORY = File.expand_path("../../templates", __FILE__)
 
 module Spout
   module Helpers
     # Helpers to generate and update Spout dictionary framework.
     module Framework
-      def copy_file(template_file, file_name = '')
-        file_name = template_file if file_name == ''
+      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}"
+        puts "      create".colorize(:green) + "  #{file_name}"
         FileUtils.copy(template_file_path, file_path)
       end
 
@@ -23,16 +23,16 @@ module Spout
         template_file_path = File.join(TEMPLATES_DIRECTORY, template_file)
         template = ERB.new(File.read(template_file_path))
         file_path = File.join(@full_path, file_name)
-        file_out = File.new(file_path, 'w')
+        file_out = File.new(file_path, "w")
         file_out.syswrite(template.result(binding))
-        puts '      create'.colorize(:green) + "  #{file_name}"
+        puts "      create".colorize(:green) + "  #{file_name}"
       ensure
         file_out.close if file_out
       end
 
       def directory(directory_name)
         directory_path = File.join(@full_path, directory_name)
-        puts '      create'.colorize(:green) + "  #{directory_name}"
+        puts "      create".colorize(:green) + "  #{directory_name}"
         FileUtils.mkpath(directory_path)
       end
     end

data/lib/spout/helpers/iterators.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require 'spout/models/dictionary'
+require "spout/models/dictionary"
 
 module Spout
   module Helpers
     module Iterators
-
       def self.included(c)
         class << c; attr_accessor :dictionary, :variables, :domains, :forms; end
         c.instance_variable_set(:@dictionary, Spout::Models::Dictionary.new(Dir.pwd).load_all!)
@@ -13,7 +12,6 @@ module Spout
         c.instance_variable_set(:@domains, c.instance_variable_get(:@dictionary).domains)
         c.instance_variable_set(:@forms, c.instance_variable_get(:@dictionary).forms)
       end
-
     end
   end
 end

data/lib/spout/helpers/json_loader.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module Spout
   module Helpers
     class JsonLoader
-
       def self.get_json(file_name, file_type)
         file = Dir.glob("#{file_type.to_s.downcase}s/**/#{file_name.to_s.downcase}.json", File::FNM_CASEFOLD).first
         json = JSON.parse(File.read(file)) rescue json = nil
@@ -13,9 +12,8 @@ module Spout
       end
 
       def self.get_variable(variable_name)
-        get_json(variable_name, 'variable')
+        get_json(variable_name, "variable")
       end
-
     end
   end
 end

data/lib/spout/helpers/json_request.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'openssl'
-require 'net/http'
-require 'json'
-require 'cgi'
+require "openssl"
+require "net/http"
+require "json"
+require "cgi"
 
 module Spout
   module Helpers
@@ -30,7 +30,7 @@ module Spout
         @url = URI.parse(url)
 
         @http = Net::HTTP.new(@url.host, @url.port)
-        if @url.scheme == 'https'
+        if @url.scheme == "https"
           @http.use_ssl = true
           @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
@@ -42,8 +42,8 @@ module Spout
       def get
         return unless @error.nil?
         full_path = @url.path
-        query = ([@url.query] + @params).flatten.compact.join('&')
-        full_path += "?#{query}" if query.to_s != ''
+        query = ([@url.query] + @params).flatten.compact.join("&")
+        full_path += "?#{query}" if query.to_s != ""
         response = @http.start do |http|
           http.get(full_path)
         end
@@ -55,7 +55,7 @@ module Spout
       def post
         return unless @error.nil?
         response = @http.start do |http|
-          http.post(@url.path, @params.flatten.compact.join('&'))
+          http.post(@url.path, @params.flatten.compact.join("&"))
         end
         [JSON.parse(response.body), response]
       rescue => e
@@ -64,7 +64,7 @@ module Spout
       end
 
       def patch
-        @params << '_method=patch'
+        @params << "_method=patch"
         post
       end
 
@@ -79,10 +79,10 @@ module Spout
         if value.is_a? Hash
           value.collect do |k,v|
             key_value_to_string(k, v, current_scope)
-          end.join('&')
+          end.join("&")
         elsif value.is_a? Array
           value.collect do |v|
-            key_value_to_string('', v, current_scope)
+            key_value_to_string("", v, current_scope)
           end
         else
           "#{current_scope}=#{CGI.escape(value.to_s)}"

data/lib/spout/helpers/number_helper.rb

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

data/lib/spout/helpers/quietly.rb

@@ -7,7 +7,7 @@ module Spout
       # From Rails: http://apidock.com/rails/v3.2.13/Kernel/silence_stream
       def silence_stream(stream)
         old_stream = stream.dup
-        stream.reopen(/mswin|mingw/ =~ RbConfig::CONFIG['host_os'] ? 'NUL:' : '/dev/null')
+        stream.reopen(/mswin|mingw/ =~ RbConfig::CONFIG["host_os"] ? "NUL:" : "/dev/null")
         stream.sync = true
         yield
       ensure

data/lib/spout/helpers/semantic.rb

@@ -10,7 +10,7 @@ module Spout
 
       def initialize(string)
         @string = string.to_s
-        (@major, @minor, @tiny, @build) = @string.split('.')
+        (@major, @minor, @tiny, @build) = @string.split(".")
       end
 
       def major_number

data/lib/spout/helpers/send_file.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'openssl'
-require 'net/http'
-require 'json'
+require "openssl"
+require "net/http"
+require "json"
 
 module Spout
   module Helpers
@@ -17,13 +17,13 @@ module Spout
 
       def initialize(url, filename, version, token, slug, folder)
         @params = {}
-        @params['version'] = version
-        @params['auth_token'] = token if token
-        @params['dataset'] = slug if slug
-        @params['folder'] = folder if folder
+        @params["version"] = version
+        @params["auth_token"] = token if token
+        @params["dataset"] = slug if slug
+        @params["folder"] = folder if folder
         begin
-          file = File.open(filename, 'rb')
-          @params['file'] = file
+          file = File.open(filename, "rb")
+          @params["file"] = file
 
           mp = Multipart::MultipartPost.new
           @query, @headers = mp.prepare_query(@params)
@@ -35,7 +35,7 @@ module Spout
           @url = URI.parse(url)
 
           @http = Net::HTTP.new(@url.host, @url.port)
-          if @url.scheme == 'https'
+          if @url.scheme == "https"
             @http.use_ssl = true
             @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
           end
@@ -77,14 +77,14 @@ module Multipart
     end
 
     def to_multipart
-      mime_type = 'application/octet-stream'
+      mime_type = "application/octet-stream"
       "Content-Disposition: form-data; name=\"#{k}\"; filename=\"#{filename}\"\r\n" + "Content-Transfer-Encoding: binary\r\n" + "Content-Type: #{mime_type}\r\n\r\n" + content + "\r\n"
     end
   end
 
   class MultipartPost
-    BOUNDARY = 'a#41-93r1-^&#213-rule0000'
-    HEADER = { 'Content-type' => "multipart/form-data, boundary=#{BOUNDARY} " }
+    BOUNDARY = "a#41-93r1-^&#213-rule0000"
+    HEADER = { "Content-type" => "multipart/form-data, boundary=#{BOUNDARY} " }
 
     def prepare_query(params)
       fp = []
@@ -95,7 +95,7 @@ module Multipart
           fp.push(Param.new(k, v))
         end
       end
-      query = fp.collect { |p| "--#{BOUNDARY}\r\n" + p.to_multipart }.join('') + "--#{BOUNDARY}--"
+      query = fp.collect { |p| "--#{BOUNDARY}\r\n" + p.to_multipart }.join("") + "--#{BOUNDARY}--"
       return query, HEADER
     end
   end

data/lib/spout/helpers/subject_loader.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'colorize'
-require 'csv'
-require 'json'
+require "colorize"
+require "csv"
+require "json"
 
-require 'spout/models/subject'
-require 'spout/helpers/semantic'
-require 'spout/models/empty'
+require "spout/models/subject"
+require "spout/helpers/semantic"
+require "spout/models/empty"
 
 module Spout
   module Helpers
@@ -24,7 +24,7 @@ module Spout
         @all_methods = {}
         @all_domains = []
         @csv_files = []
-        @csv_directory = ''
+        @csv_directory = ""
       end
 
       def load_subjects_from_csvs!
@@ -35,31 +35,31 @@ module Spout
       def load_subjects_from_csvs_part_one!
         @subjects = []
 
-        available_folders = (Dir.exist?('csvs') ? Dir.entries('csvs').select { |e| File.directory? File.join('csvs', e) }.reject { |e| ['.', '..'].include?(e) }.sort : [])
+        available_folders = (Dir.exist?("csvs") ? Dir.entries("csvs").select { |e| File.directory? File.join("csvs", e) }.reject { |e| [".", ".."].include?(e) }.sort : [])
 
         @semantic = Spout::Helpers::Semantic.new(@standard_version, available_folders)
 
         @csv_directory = @semantic.selected_folder
 
-        csv_root = File.join('csvs', @csv_directory)
+        csv_root = File.join("csvs", @csv_directory)
         @csv_files = Dir.glob("#{csv_root}/**/*.csv").sort
 
         if @csv_directory != @standard_version
-          puts "\n#{@csv_files.size == 0 ? 'No CSVs found' : 'Parsing files' } in " + "#{csv_root}".colorize(:white) + ' for dictionary version ' + @standard_version.to_s.colorize(:green) + "\n"
+          puts "\n#{@csv_files.size == 0 ? 'No CSVs found' : 'Parsing files' } in " + "#{csv_root}".colorize(:white) + " for dictionary version " + @standard_version.to_s.colorize(:green) + "\n"
         else
           puts "\n#{@csv_files.size == 0 ? 'No CSVs found' : 'Parsing files' } in " + "#{csv_root}".colorize(:white) + "\n"
         end
 
         last_folder = nil
         @csv_files.each do |csv_file|
-          relative_path = csv_file.gsub(%r{^#{csv_root}}, '')
+          relative_path = csv_file.gsub(%r{^#{csv_root}}, "")
           current_file = File.basename(relative_path)
-          current_folder = relative_path.gsub(/#{current_file}$/, '')
+          current_folder = relative_path.gsub(/#{current_file}$/, "")
           count = 1 # Includes counting the header row
-          puts "  #{current_folder}".colorize(:white) if current_folder.to_s != '' && current_folder != last_folder
+          puts "  #{current_folder}".colorize(:white) if current_folder.to_s != "" && current_folder != last_folder
           print "    #{current_file}"
           last_folder = current_folder
-          CSV.parse(File.open(csv_file, 'r:iso-8859-1:utf-8', &:read), headers: true, header_converters: lambda { |h| h.to_s.downcase }) do |line|
+          CSV.parse(File.open(csv_file, "r:iso-8859-1:utf-8", &:read), headers: true, header_converters: lambda { |h| h.to_s.downcase }) do |line|
             row = line.to_hash
             count += 1
             print "\r    #{current_file} " + "##{count}".colorize(:yellow) if (count % 10 == 0)
@@ -69,7 +69,7 @@ module Spout
 
               row.each_with_index do |(key, value), index|
                 method = key.to_s.downcase.strip
-                if method == ''
+                if method == ""
                   puts "\nSkipping column #{index + 1} due to blank header.".colorize(:red) if count == 2
                   next
                 end
@@ -99,20 +99,20 @@ module Spout
 
       def load_subjects_from_csvs_part_two!
         variable_count = @variable_files.count
-        print 'Converting numeric values to floats'
+        print "Converting numeric values to floats"
         @variable_files.each_with_index do |variable_file, index|
           print "\rConverting numeric values to floats:#{'% 3d' % ((index + 1) * 100 / variable_count)}%"
           json = JSON.parse(File.read(variable_file)) rescue json = nil
           next unless json
-          next unless @valid_ids.include?(json['id'].to_s.downcase) || @valid_ids.size == 0
-          next unless %w(numeric integer).include?(json['type'])
-          method = json['id'].to_s.downcase
+          next unless @valid_ids.include?(json["id"].to_s.downcase) || @valid_ids.size == 0
+          next unless %w(numeric integer).include?(json["type"])
+          method = json["id"].to_s.downcase
           next unless Spout::Models::Subject.method_defined?(method)
 
           domain_json = get_domain(json)
           # Make all domain options nil for numerics/integers
           if domain_json
-            domain_values = domain_json.collect { |option_hash| option_hash['value'] }
+            domain_values = domain_json.collect { |option_hash| option_hash["value"] }
             @subjects.each { |s| domain_values.include?(s.send(method)) ? s.send("#{method}=", nil) : nil }
           end
 
@@ -126,8 +126,8 @@ module Spout
         @variable_files.each do |variable_file|
           json = JSON.parse(File.read(variable_file)) rescue json = nil
           next unless json
-          next unless json['type'] == 'choices' || json['domain'].to_s.downcase.strip != ''
-          domain = json['domain'].to_s.downcase
+          next unless json["type"] == "choices" || json["domain"].to_s.downcase.strip != ""
+          domain = json["domain"].to_s.downcase
           @all_domains << domain
         end
         @all_domains = @all_domains.compact.uniq.sort
@@ -141,11 +141,11 @@ module Spout
       end
 
       def get_variable(variable_name)
-        get_json(variable_name, 'variable')
+        get_json(variable_name, "variable")
       end
 
       def get_domain(json)
-        get_json(json['domain'], 'domain')
+        get_json(json["domain"], "domain")
       end
     end
   end