spout 0.10.2 → 0.11.0.beta1

data/lib/spout/models/tables.rb

@@ -4,11 +4,9 @@ require 'spout/models/tables/choices_vs_choices'
 require 'spout/models/tables/numeric_vs_numeric'
 require 'spout/models/tables/choices_vs_numeric'
 
-
 module Spout
   module Models
     module Tables
-
       DEFAULT_CLASS = Spout::Models::Tables::Default
       GRAPHABLE_CLASSES = {
         'numeric_vs_choices' => Spout::Models::Tables::NumericVsChoices,
@@ -17,9 +15,9 @@ module Spout
         'choices_vs_numeric' => Spout::Models::Tables::ChoicesVsNumeric
       }
 
-      def self.for(variable, chart_variable, subjects, subtitle)
+      def self.for(variable, chart_variable, subjects, subtitle, totals: true)
         table_type = get_table_type(variable, chart_variable)
-        (GRAPHABLE_CLASSES[table_type] || DEFAULT_CLASS).new(variable, chart_variable, subjects, subtitle)
+        (GRAPHABLE_CLASSES[table_type] || DEFAULT_CLASS).new(variable, chart_variable, subjects, subtitle, totals)
       end
 
       def self.get_table_type(variable, chart_variable)
@@ -29,13 +27,13 @@ module Spout
       # Identical to graphables, TODO: Refactor
       def self.variable_to_table_type(variable)
         variable_type = (variable ? variable.type : nil)
-        case variable_type when 'numeric', 'integer'
+        case variable_type
+        when 'numeric', 'integer'
           'numeric'
         else
           variable_type
         end
       end
-
     end
   end
 end

data/lib/spout/models/variable.rb

@@ -13,29 +13,28 @@ module Spout
       attr_accessor :id, :folder, :display_name, :description, :type, :units, :labels, :commonly_used, :calculation
       attr_accessor :domain_name, :form_names
       attr_accessor :domain, :forms
+      attr_accessor :n, :mean, :stddev, :median, :min, :max, :unknown, :total
       attr_reader :errors
 
       def initialize(file_name, dictionary_root)
         @errors = []
-        @id     = file_name.to_s.gsub(/^(.*)\/|\.json$/, '').downcase
-        @folder = file_name.to_s.gsub(/^#{dictionary_root}\/variables\/|#{@id}\.json$/, '')
+        @id     = file_name.to_s.gsub(%r{^(.*)/|\.json$}, '').downcase
+        @folder = file_name.to_s.gsub(%r{^#{dictionary_root}/variables/|#{@id}\.json$}, '')
         @form_names = []
 
         json = begin
-          JSON.parse(File.read(file_name))
-        rescue => e
-          error = e.message
-          nil
-        end
-
-        if json and json.kind_of? Hash
+                 JSON.parse(File.read(file_name))
+               rescue => e
+                 error = e.message
+                 nil
+               end
 
-          %w( display_name description type units commonly_used calculation ).each do |method|
+        if json.is_a? Hash
+          %w(display_name description type units commonly_used calculation).each do |method|
             instance_variable_set("@#{method}", json[method])
           end
-
+          @commonly_used = false if @commonly_used.nil?
           @errors << "'id': #{json['id'].inspect} does not match filename #{@id.inspect}" if @id != json['id']
-
           @domain_name  = json['domain'] # Spout::Models::Domain.new(json['domain'], dictionary_root)
           @labels       = (json['labels'] || [])
           @form_names   = (json['forms'] || []).collect do |form_name|
@@ -48,13 +47,52 @@ module Spout
         @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
+        @forms = @form_names.collect { |form_name| Spout::Models::Form.find_by_id(form_name) }.compact
       end
 
       def path
         File.join(@folder, "#{@id}.json")
       end
 
+      def known_issues
+        line_found = false
+        lines = []
+        known_issues_file = 'KNOWNISSUES.md'
+        if File.exist?(known_issues_file) && File.file?(known_issues_file)
+          IO.foreach(known_issues_file) do |line|
+            if line_found && Variable.starts_with?(line, '  - ')
+              lines << line
+            elsif Variable.partial_match?(line, "\\[#{id}\\]")
+              line_found = true
+              lines << line
+            else
+              line_found = false
+            end
+          end
+        end
+        lines.join("\n")
+      end
+
+      def self.starts_with?(string, term)
+        !(/^#{term.to_s.downcase}/ =~ string.to_s.downcase).nil?
+      end
+
+      def self.partial_match?(string, term)
+        !(/#{term.to_s.downcase}/ =~ string.to_s.downcase).nil?
+      end
+
+      def deploy_params
+        { name: id, display_name: display_name, variable_type: type,
+          folder: folder.to_s.gsub(%r{/$}, ''), description: description,
+          units: units, calculation: calculation, commonly_used: commonly_used,
+          labels: labels,
+          stats_n: n, stats_mean: mean, stats_stddev: stddev,
+          stats_median: median, stats_min: min, stats_max: max,
+          stats_unknown: unknown, stats_total: total,
+          known_issues: known_issues,
+          spout_version: Spout::VERSION::STRING
+        }
+      end
     end
   end
 end

data/lib/spout/tasks/engine.rake

@@ -2,7 +2,7 @@ require 'rake/testtask'
 require 'colorize'
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
+  t.libs << 'test'
   t.test_files = FileList['test/**/*_test.rb']
   t.warning = true
   t.verbose = true

data/lib/spout/templates/ruby-version

@@ -1 +1 @@
-ruby-2.1.5
+ruby-2.3.0

data/lib/spout/templates/travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.1.5
+  - 2.3.0

data/lib/spout/tests/domain_format.rb

@@ -5,8 +5,8 @@ module Spout
       def assert_domain_format(item)
         result = begin
           json = JSON.parse(File.read(item))
-          if json.kind_of?(Array)
-            json.empty? or json.select{|o| not o.kind_of?(Hash)}.size == 0
+          if json.is_a?(Array)
+            json.empty? or json.select{|o| not o.is_a?(Hash)}.size == 0
           else
             false
           end

data/lib/spout/tests/domain_name_format.rb

@@ -0,0 +1,15 @@
+module Spout
+  module Tests
+    # Tests to assure that the domain name starts with a lowercase letter
+    # followed by lowercase letters, numbers, or underscores
+    module DomainNameFormat
+      Dir.glob('domains/**/*.json').each do |file|
+        define_method("test_domain_name_format: #{file}") do
+          message = 'Domain name format error. Name must start with a lowercase letter and be followed by lowercase letters, numbers, or underscores'
+          name = File.basename(file).gsub(/\.json$/, '') rescue name = nil
+          assert_match(/^[a-z]\w*$/, name, message)
+        end
+      end
+    end
+  end
+end

data/lib/spout/tests/form_name_format.rb

@@ -0,0 +1,14 @@
+module Spout
+  module Tests
+    # Tests to assure that the domain name starts with a lowercase letter
+    # followed by lowercase letters, numbers, or underscores
+    module FormNameFormat
+      Dir.glob('forms/**/*.json').each do |file|
+        define_method("test_form_name_format: #{file}") do
+          message = 'Form name format error. Name must start with a lowercase letter and be followed by lowercase letters, numbers, or underscores'
+          assert_match(/^[a-z]\w*$/, (begin JSON.parse(File.read(file))['id'] rescue nil end), message)
+        end
+      end
+    end
+  end
+end

data/lib/spout/tests/variable_name_format.rb

@@ -0,0 +1,14 @@
+module Spout
+  module Tests
+    # Tests to assure that the variable name starts with a lowercase letter
+    # followed by lowercase letters, numbers, or underscores
+    module VariableNameFormat
+      Dir.glob('variables/**/*.json').each do |file|
+        define_method("test_variable_name_format: #{file}") do
+          message = 'Variable name format error. Name must start with a lowercase letter and be followed by lowercase letters, numbers, or underscores'
+          assert_match(/^[a-z]\w*$/, (begin JSON.parse(File.read(file))['id'] rescue nil end), message)
+        end
+      end
+    end
+  end
+end

data/lib/spout/tests.rb

@@ -37,11 +37,11 @@ module Minitest
       def record(test)
         super
         if !test.skipped? && test.failure
-          print "    "
+          print '    '
           print_colored_status(test)
           print "    #{test.name}"
           puts
-          print "             "
+          print '             '
           print test.failure.to_s.gsub("\n", "\n             ")
           puts
           puts
@@ -63,36 +63,41 @@ end
 
 Minitest::Reporters.use! Minitest::Reporters::SpoutReporter.new
 
-
 require 'spout/tests/json_validation'
-require 'spout/tests/variable_type_validation'
-require 'spout/tests/variable_name_uniqueness'
-require 'spout/tests/variable_name_match'
-require 'spout/tests/variable_display_name_length'
 require 'spout/tests/domain_existence_validation'
 require 'spout/tests/domain_format'
+require 'spout/tests/domain_name_format'
 require 'spout/tests/domain_name_uniqueness'
 require 'spout/tests/domain_specified'
 require 'spout/tests/form_existence_validation'
-require 'spout/tests/form_name_uniqueness'
+require 'spout/tests/form_name_format'
 require 'spout/tests/form_name_match'
+require 'spout/tests/form_name_uniqueness'
+require 'spout/tests/variable_display_name_length'
+require 'spout/tests/variable_name_format'
+require 'spout/tests/variable_name_match'
+require 'spout/tests/variable_name_uniqueness'
+require 'spout/tests/variable_type_validation'
 
 require 'spout/helpers/iterators'
 
 module Spout
   module Tests
     include Spout::Tests::JsonValidation
-    include Spout::Tests::VariableTypeValidation
-    include Spout::Tests::VariableNameUniqueness
-    include Spout::Tests::VariableNameMatch
-    include Spout::Tests::VariableDisplayNameLength
     include Spout::Tests::DomainExistenceValidation
     include Spout::Tests::DomainFormat
+    include Spout::Tests::DomainNameFormat
     include Spout::Tests::DomainNameUniqueness
     include Spout::Tests::DomainSpecified
     include Spout::Tests::FormExistenceValidation
-    include Spout::Tests::FormNameUniqueness
+    include Spout::Tests::FormNameFormat
     include Spout::Tests::FormNameMatch
+    include Spout::Tests::FormNameUniqueness
+    include Spout::Tests::VariableDisplayNameLength
+    include Spout::Tests::VariableNameFormat
+    include Spout::Tests::VariableNameMatch
+    include Spout::Tests::VariableNameUniqueness
+    include Spout::Tests::VariableTypeValidation
   end
 end
 

data/lib/spout/version.rb

@@ -1,9 +1,9 @@
 module Spout
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 10
-    TINY = 2
-    BUILD = nil # nil, "pre", "rc", "rc2"
+    MINOR = 11
+    TINY = 0
+    BUILD = 'beta1' # 'pre', 'rc', 'rc2', nil
 
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end

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

@@ -262,7 +262,7 @@ tfoot td {
                   <% end %>
                 </td>
                 <td>
-                  <% if scr.json['type'] == 'choices' and scr.file_name_test %>
+                  <% if scr.json['type'] == 'choices' && scr.file_name_test %>
                     <% if scr.domain_test or scr.json['domain'].to_s.strip == '' %>
                       <code class="<%= 'success' if scr.domain_test %>">"domain": <%= scr.json['domain'].inspect %></code>
                     <% else %>
@@ -273,7 +273,7 @@ tfoot td {
                 <td style="white-space:nowrap">
                   <% if scr.json['type'] == 'choices' %>
                     <% unused_values = scr.valid_values - scr.csv_values %>
-                    <% if scr.values_test and unused_values.size == 0 %>
+                    <% if scr.values_test && unused_values.size == 0 %>
                       <div class="text-success" style="text-align:center"><span class="glyphicon glyphicon-ok"></span></div>
                     <% else %>
                       <% (scr.valid_values + scr.csv_values.compact.sort).uniq.each do |value| %>

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

@@ -149,7 +149,7 @@ tfoot td {
                 <td><%= outlier_result.method %></td>
                 <td><%= outlier_result.display_name.to_s[0..20] %></td>
                 <td>
-                  <% if outlier_result.median.kind_of?(Numeric) %>
+                  <% if outlier_result.median.is_a?(Numeric) %>
                     <code class="default"><%= number_with_delimiter(outlier_result.median.round(2)) %></code>
                   <% end %>
                   <%= outlier_result.units %>

data/lib/spout.rb

@@ -1,4 +1,4 @@
-require "spout/version"
+require 'spout/version'
 
 require 'spout/models/dictionary'
 
@@ -9,7 +9,6 @@ Spout::COMMANDS = {
   'i' => :importer,
   'e' => :exporter,
   'c' => :coverage_report,
-  'p' => :generate_images,
   'g' => :generate_charts_and_tables,
   'o' => :outliers_report,
   'd' => :deploy
@@ -17,7 +16,7 @@ Spout::COMMANDS = {
 
 module Spout
   def self.launch(argv)
-    self.send((Spout::COMMANDS[argv.first.to_s.scan(/\w/).first] || :help), argv)
+    send((Spout::COMMANDS[argv.first.to_s.scan(/\w/).first] || :help), argv)
   end
 
   def self.new_project(argv)
@@ -28,6 +27,8 @@ module Spout
   def self.coverage_report(argv)
     require 'spout/commands/coverage'
     Spout::Commands::Coverage.new(standard_version, argv)
+  rescue NoMemoryError
+    puts "[NoMemoryError] You made Spout cry... Spout doesn't run on potatoes :'-("
   end
 
   def self.exporter(argv)
@@ -38,49 +39,12 @@ module Spout
   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')
-    sizes         = flag_values(argv, 'size')
-    variable_ids  = non_flag_values(argv)
-    Spout::Commands::Images.new(types, variable_ids, sizes, standard_version, argv)
+    Spout::Commands::Graphs.new(argv, standard_version)
   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
-  [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>/`
-  [d]eploy NAME     Push dataset and data dictionary to a
-                    webserver specified in `.spout.yml`
-  [v]ersion         Returns the version of Spout
-
-Commands can be referenced by the first letter:
-  Ex: `spout t`, for test
-
-EOT
+    require 'spout/commands/help'
+    Spout::Commands::Help.new(argv)
   end
 
   def self.deploy(argv)
@@ -98,29 +62,20 @@ EOT
     Spout::Commands::Outliers.new(standard_version, argv)
   end
 
-  def self.test(argv)
-    system "bundle exec rake"
+  def self.test(_argv)
+    system 'bundle exec rake'
     # require 'spout/commands/test_runner'
     # Spout::Commands::TestRunner.new(argv)
   end
 
-  def self.version(argv)
+  def self.version(_argv)
     puts "Spout #{Spout::VERSION::STRING}"
   end
 
   def self.standard_version
-    version = File.open('VERSION', &:readline).strip rescue ''
+    version = File.open('VERSION', &:readline).strip
     version == '' ? '1.0.0' : version
+  rescue
+    '1.0.0'
   end
-
-  private
-
-  def self.flag_values(flags, param)
-    flags.select{|f| f =~ /^--#{param}-/}.collect{|f| f[(param.size + 3)..-1]}
-  end
-
-  def self.non_flag_values(flags)
-    flags.reject{|f| f =~ /^--/}
-  end
-
 end

data/spout.gemspec

@@ -12,25 +12,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'spout/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "spout"
+  spec.name          = 'spout'
   spec.version       = Spout::VERSION::STRING
-  spec.authors       = ["Remo Mueller"]
-  spec.email         = ["remosm@gmail.com"]
-  spec.description   = %q{Manage your data dictionary as a JSON repository, and easily export back to CSV.}
-  spec.summary       = %q{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       = "CC BY-NC-SA 3.0"
+  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.homepage      = 'https://github.com/sleepepi/spout'
+  spec.license       = 'CC BY-NC-SA 3.0'
 
   spec.files = Dir['{bin,lib}/**/*'] + ['CHANGELOG.md', 'LICENSE', 'Rakefile', 'README.md', 'spout.gemspec']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rake"
-  spec.add_dependency "minitest"
-  spec.add_dependency "minitest-reporters"
-  spec.add_dependency "json"
-  spec.add_dependency "colorize", "~> 0.7.5"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_dependency 'bundler', '~> 1.3'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'minitest'
+  spec.add_dependency 'minitest-reporters'
+  spec.add_dependency 'json'
+  spec.add_dependency 'colorize', '~> 0.7.5'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0.beta1
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.5
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 description: Manage your data dictionary as a JSON repository, and easily export back
   to CSV.
 email:
@@ -113,7 +113,7 @@ files:
 - lib/spout/commands/deploy.rb
 - lib/spout/commands/exporter.rb
 - lib/spout/commands/graphs.rb
-- lib/spout/commands/images.rb
+- lib/spout/commands/help.rb
 - lib/spout/commands/importer.rb
 - lib/spout/commands/outliers.rb
 - lib/spout/commands/project_generator.rb
@@ -123,6 +123,7 @@ files:
 - lib/spout/helpers/iterators.rb
 - lib/spout/helpers/json_loader.rb
 - lib/spout/helpers/json_request.rb
+- lib/spout/helpers/json_request_generic.rb
 - lib/spout/helpers/number_helper.rb
 - lib/spout/helpers/quietly.rb
 - lib/spout/helpers/semantic.rb
@@ -133,6 +134,7 @@ files:
 - lib/spout/models/coverage_result.rb
 - lib/spout/models/dictionary.rb
 - lib/spout/models/domain.rb
+- lib/spout/models/empty.rb
 - lib/spout/models/form.rb
 - lib/spout/models/graphables.rb
 - lib/spout/models/graphables/choices_vs_choices.rb
@@ -152,11 +154,6 @@ files:
 - lib/spout/models/tables/numeric_vs_choices.rb
 - lib/spout/models/tables/numeric_vs_numeric.rb
 - lib/spout/models/variable.rb
-- lib/spout/support/javascripts/data.js
-- lib/spout/support/javascripts/highcharts-convert.js
-- lib/spout/support/javascripts/highcharts-more.js
-- lib/spout/support/javascripts/highstock.js
-- lib/spout/support/javascripts/jquery.1.9.1.min.js
 - lib/spout/tasks.rb
 - lib/spout/tasks/engine.rake
 - lib/spout/templates/Gemfile
@@ -171,14 +168,17 @@ files:
 - lib/spout/tests.rb
 - lib/spout/tests/domain_existence_validation.rb
 - lib/spout/tests/domain_format.rb
+- lib/spout/tests/domain_name_format.rb
 - lib/spout/tests/domain_name_uniqueness.rb
 - lib/spout/tests/domain_specified.rb
 - lib/spout/tests/form_existence_validation.rb
+- lib/spout/tests/form_name_format.rb
 - lib/spout/tests/form_name_match.rb
 - lib/spout/tests/form_name_uniqueness.rb
 - lib/spout/tests/json_helper.rb
 - lib/spout/tests/json_validation.rb
 - lib/spout/tests/variable_display_name_length.rb
+- lib/spout/tests/variable_name_format.rb
 - lib/spout/tests/variable_name_match.rb
 - lib/spout/tests/variable_name_uniqueness.rb
 - lib/spout/tests/variable_type_validation.rb
@@ -201,12 +201,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Turn your CSV data dictionary into a JSON repository. Collaborate with others