spout 0.12.0.beta1 → 0.12.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91e37c53637e54635b7f204c6d871185e501b4b5
-  data.tar.gz: 47aca3d4fc26c38b9be92b1dc84160aae6331924
+  metadata.gz: b8d706e8d746c0ae4c64014bbcf38f47d51e388a
+  data.tar.gz: b2a49b2f165531f6a96ad677cb6a1d9f4045a283
 SHA512:
-  metadata.gz: 51be6855c98f63fdadd7d1a2733fb92b168ecf8776d73f1e5499f62f5092236df3f76788759233a49471ea5f3da3478cf40c577fe3663f0ce2e0868ff7f7392d
-  data.tar.gz: e01e379d9e265215c9919d91154e1cb1dbdbe5279d8846da405a04a21137fc6bf1876d5e876a30eaeb8c0ee725d7e5f39597eaac6a9a62792d8d5c29e9b616cf
+  metadata.gz: 9b4fa147fc6914b594afd25acc72f5de98c929dbc2631489fd8267c1a3ff3e432a16292a28ce2f5565d011879263a3cfa265b004c1af9deebcf6525d6fa5411d
+  data.tar.gz: 9f3dfd7ee30b971b2d3152c486dac7bb87b9d3811a6d7fd30267bfdf9285ec4330cfece6956e217dffb64827fa7f902f9f43aec3aed4fd4ea25622b670965017

data/CHANGELOG.md

@@ -3,11 +3,19 @@
 ### Enhancements
 - **General Changes**
   - Spout now provides a warning and skips columns in CSVs with blank headers
+- **Exporter Changes**
+  - The export command now exports the variable forms attribute
+- **Importer Changes**
+  - The import command now reads in the `commonly_used` column
+  - The import command now imports the variable forms attribute
 - **Gem Changes**
-  - Updated to Ruby 2.4.0
+  - Updated to Ruby 2.4.1
   - Updated to bundler 1.13
   - Updated to colorize 0.8.1
-  - Updated to simplecov 0.12.0
+  - Updated to simplecov 0.14.1
+
+### Refactoring
+- General code cleanup based on Rubocop recommendations
 
 ## 0.11.1 (February 4, 2016)
 

data/lib/spout/commands/exporter.rb

@@ -9,9 +9,10 @@ require 'spout/helpers/config_reader'
 
 module Spout
   module Commands
+    # Exports the JSON data dictionary to a CSV format.
     class Exporter
       def initialize(standard_version, argv)
-        @quiet = (argv.delete('--quiet') != nil)
+        @quiet = !argv.delete('--quiet').nil?
         @standard_version = standard_version
         @config = Spout::Helpers::ConfigReader.new
         expanded_export!
@@ -21,33 +22,42 @@ module Spout
 
       def expanded_export!
         folder = "dd/#{@standard_version}"
-        puts "      create".colorize( :green ) + "  #{folder}" unless @quiet
+        puts '      create'.colorize(:green) + "  #{folder}" unless @quiet
         FileUtils.mkpath folder
-
-        generic_export(folder, 'variables', %w(id display_name description type units domain labels calculation commonly_used))
+        generic_export(
+          folder,
+          'variables',
+          %w(
+            id display_name description type units domain labels calculation
+            commonly_used forms
+          )
+        )
         generic_export(folder, 'domains', %w(value display_name description), true)
         generic_export(folder, 'forms', %w(id display_name code_book))
       end
 
       def generic_export(folder, type, keys, include_domain_name = false)
         export_file = export_file_name(type)
-        puts "      export".colorize( :blue ) + "  #{folder}/#{export_file}" unless @quiet
-        CSV.open("#{folder}/#{export_file}", "wb") do |csv|
-          if include_domain_name
-            csv << ['folder', 'domain_id'] + keys
-          else
-            csv << ['folder'] + keys
-          end
+        puts '      export'.colorize(:blue) + "  #{folder}/#{export_file}" unless @quiet
+        CSV.open("#{folder}/#{export_file}", 'wb') do |csv|
+          csv << if include_domain_name
+                   %w(folder domain_id) + keys
+                 else
+                   %w(folder) + keys
+                 end
           Dir.glob("#{type}/**/*.json").sort.each do |file|
-            if json = JSON.parse(File.read(file)) rescue false
+            json = JSON.parse(File.read(file)) rescue false
+            if json
               relative_folder = generic_folder_path(file, type)
               if include_domain_name
                 domain_name = extract_domain_name(file)
                 json.each do |hash|
-                  csv << [relative_folder, domain_name] + keys.collect{|key| hash[key]}
+                  csv << [relative_folder, domain_name] + keys.collect { |key| hash[key] }
                 end
               else
-                csv << [relative_folder] + keys.collect{|key| json[key].is_a?(Array) ? json[key].join(';') : json[key].to_s}
+                csv << [relative_folder] + keys.collect do |key|
+                  json[key].is_a?(Array) ? json[key].join(';') : json[key].to_s
+                end
               end
             end
           end

data/lib/spout/commands/importer.rb

@@ -9,21 +9,17 @@ module Spout
   module Commands
     class Importer
       def initialize(argv)
-        use_domains = (argv.delete('--domains') != nil)
-
+        use_domains = !argv.delete('--domains').nil?
         @csv_file = argv[1].to_s
-
         unless File.exist?(@csv_file)
           puts csv_usage
           return self
         end
-
         if use_domains
           import_domains
         else
           import_variables
         end
-
       end
 
       def csv_usage
@@ -38,7 +34,7 @@ EOT
       end
 
       def import_variables
-        CSV.parse( File.open(@csv_file, 'r:iso-8859-1:utf-8'){|f| f.read}, headers: true ) do |line|
+        CSV.parse(File.open(@csv_file, 'r:iso-8859-1:utf-8', &: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
@@ -60,7 +56,10 @@ EOT
           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['labels'] = labels unless labels.empty?
+          hash['commonly_used'] = true if row.delete('commonly_used').to_s.casecmp('true').zero?
+          forms = row.delete('forms').to_s.split(';')
+          hash['forms'] = forms unless forms.empty?
           hash['other'] = row unless row.empty?
 
           file_name = File.join(folder, id + '.json')
@@ -74,7 +73,7 @@ EOT
       def import_domains
         domains = {}
 
-        CSV.parse( File.open(@csv_file, 'r:iso-8859-1:utf-8'){|f| f.read}, headers: true ) do |line|
+        CSV.parse(File.open(@csv_file, 'r:iso-8859-1:utf-8', &: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
@@ -116,7 +115,6 @@ EOT
           end
           puts "      create".colorize( :green ) + "  #{file_name}"
         end
-
       end
 
       # Converts ALL-CAPS display names to title case
@@ -135,8 +133,6 @@ EOT
       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/project_generator.rb

@@ -13,7 +13,7 @@ module Spout
       end
 
       def generate_folder_structure!(argv)
-        skip_gemfile = (argv.delete('--skip-gemfile') != nil)
+        skip_gemfile = !argv.delete('--skip-gemfile').nil?
         @full_path = File.join(argv[1].to_s.strip)
         usage = <<-EOT
 
@@ -22,14 +22,11 @@ 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 )
+        if @full_path == '' || (Dir.exist?(@full_path) && (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'

data/lib/spout/helpers/subject_loader.rb

@@ -59,7 +59,7 @@ module Spout
           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'){ |f| f.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)

data/lib/spout/models/graphables/numeric_vs_choices.rb

@@ -6,7 +6,6 @@ module Spout
   module Models
     module Graphables
       class NumericVsChoices < Spout::Models::Graphables::Default
-
         def categories
           categories_result = []
           @stratification_variable.domain.options.each do |option|
@@ -28,13 +27,11 @@ module Spout
           @stratification_variable.domain.options.each do |option|
             visit_subjects = @subjects.select{ |s| s._visit == option.value and s.send(@variable.id) != nil } rescue visit_subjects = []
             if visit_subjects.count > 0
-
-              filtered_domain_options(@chart_variable).each_with_index do |option, index|
-                values = visit_subjects.select{|s| s.send(@chart_variable.id) == option.value }.collect(&@variable.id.to_sym)
+              filtered_domain_options(@chart_variable).each_with_index do |filtered_option, index|
+                values = visit_subjects.select{|s| s.send(@chart_variable.id) == filtered_option.value }.collect(&@variable.id.to_sym)
                 data[index] ||= []
                 data[index] << (values.mean.round(2) rescue 0.0)
               end
-
             end
           end
 
@@ -42,7 +39,6 @@ module Spout
             { name: option.display_name, data: data[index] }
           end
         end
-
       end
     end
   end

data/lib/spout/models/variable.rb

@@ -23,6 +23,7 @@ module Spout
         @id     = file_name.to_s.gsub(%r{^(.*)/|\.json$}, '').downcase
         @folder = file_name.to_s.gsub(%r{^#{dictionary_root}/variables/|#{@id}\.json$}, '')
         @form_names = []
+        @domain_name = nil
 
         json = begin
                  JSON.parse(File.read(file_name))
@@ -31,7 +32,7 @@ module Spout
                  nil
                end
 
-        if json.is_a? Hash
+        if json.is_a?(Hash)
           %w(display_name description type units commonly_used calculation).each do |method|
             instance_variable_set("@#{method}", json[method])
           end
@@ -45,9 +46,7 @@ module Spout
         elsif json
           @errors << "Variable must be a valid hash in the following format: {\n\"id\": \"VARIABLE_ID\",\n  \"display_name\": \"VARIABLE DISPLAY NAME\",\n  \"description\": \"VARIABLE DESCRIPTION\"\n}"
         end
-
         @errors = (@errors + [error]).compact
-
         @domain = Spout::Models::Domain.find_by_id(@domain_name)
         @forms = @form_names.collect { |form_name| Spout::Models::Form.find_by_id(form_name) }.compact
       end

data/lib/spout/templates/ruby-version

@@ -1 +1 @@
-ruby-2.4.0
+ruby-2.4.1

data/lib/spout/templates/travis.yml

@@ -1,4 +1,4 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
+  - 2.4.1

data/lib/spout/version.rb

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

data/spout.gemspec

@@ -18,7 +18,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Remo Mueller']
   spec.email         = ['remosm@gmail.com']
   spec.description   = 'Manage your data dictionary as a JSON repository, and easily export back to CSV.'
-  spec.summary       = '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 for further validations.'
+  spec.summary       = '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 for '\
+                       'further validations.'
   spec.homepage      = 'https://github.com/sleepepi/spout'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.12.0.beta1
+  version: 0.12.0.beta2
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Turn your CSV data dictionary into a JSON repository. Collaborate with others