spout 0.1.0.rc2 → 0.1.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 107e09d3629aadfb7fd0e06b27c115a2d0e87fbd
-  data.tar.gz: 62ea6faceb8218158e870aebedb42ac3047a2a66
+  metadata.gz: eac7961655c4b0c02a08c9f5265be806f1ba8d29
+  data.tar.gz: 70a68bf828fb2fc2cfa9ab70fa2cdc49d0d06146
 SHA512:
-  metadata.gz: 3d5710e58b74e66277fa1dd0c6a85fbf63edbea619e5b51c5b7720b00f786d7c43586e07f99733432f61c06ac6f83f8daabcf56d12b924a67acb553bc8bfae3b
-  data.tar.gz: a94c8b3c1bfd03586f62079dd01d91cd4563f2fbed2fabaf34d900ea2bc1d5801c22a8ad61846948b6ca80bce0d535aea8a9d741f82b86a9e3fd2ab5d8aee8bd
+  metadata.gz: bd6fa9f07d148ccc176188be95f5d86a36d5bd0a0f333f5a8c06ab7c516ca8147b6b08f8fab3b2f5de7341251d8faeb7b519db96f5862c8ddfec43ebb54bffc1
+  data.tar.gz: 7fa9bb7618a1eccad4eee36ebc11cf44335c64ae951ef476245d865f1931b82fed90bd9e9f12ccb2fcbba2cacfe76e056d408a6fc92cc88e7d0d6a8162ca19f3

data/README.md

@@ -28,6 +28,38 @@ cd my_data_dictionary
 spout import data_dictionary.csv
 ```
 
+The CSV should contain at minimal the two column headers:
+
+`id`: This column will give the variable it's 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:
+
+`display_name`: The variable name as it is presented to the user. The display name should be reasonable in length and not unreasonably long.
+
+`description`: A longer description of the variable.
+
+`type`: Should be a valid variable type, i.e.:
+  - `identifier`
+  - `choices`
+  - `integer`
+  - `numeric`
+  - `string`
+  - `text`
+  - `date`
+  - `time`
+  - `file`
+
+`domain`: The name of the domain that is associated with the variable. Typically, only variable of type `choices` have domains.  These domains then reside in `domains` folder.
+
+`units`: A string of the associated that are appended to variable values, or added to coordinates in graphs representing the variable.
+
+`calculation`: A calculation represented using algebraic expressions along with `id` of other variables.
+
+`labels`: A series of different names for the variable that are semi-colon `;` separated. These labels are commonly synonyms, or related terms used primarily for searching.
+
+All other columns get grouped into a hash labeled `other`.
+
 ### Test your repository
 
 If you created your data dictionary repository using `spout new`, you can go ahead and test using:
@@ -69,6 +101,12 @@ Provide an optional version parameter to name the folder the CSVs will be genera
 spout export
 ```
 
+You can optionally provide a version string
+
+```
+spout export [1.0.0]
+```
+
 or
 
 ```

data/bin/spout

@@ -2,7 +2,4 @@
 
 require File.expand_path('../../lib/spout', __FILE__)
 
-if ARGV.size > 0
-  Spout::Actions.new.interpret(ARGV)
-  exit(0)
-end
+Spout::Actions.new.interpret(ARGV)

data/lib/spout/actions.rb

@@ -3,18 +3,18 @@ module Spout
 
     def interpret(argv)
       case argv.first
-      when 'new'
+      when 'new', 'n', 'ne', '-new', '-n', '-ne'
         new_template_dictionary(argv)
-      when '--version', '-v', 'version'
+      when '--version', '-v', '-ve', '-ver', 'version', 'v', 've', 'ver'
         puts "Spout #{Spout::VERSION::STRING}"
-      when 'help', '--help', '-h'
-        help
-      when 'import'
+      when 'test', 't', 'te', 'tes', '--test', '-t', '-te', '-tes'
+        system "bundle exec rake"
+      when 'import', 'i', 'im', 'imp', '--import', '-i', '-im', '-imp'
         import_from_csv(argv)
-      when 'export'
-        system "bundle exec rake dd:create"
+      when 'export', 'e', 'ex', 'exp', '--export', '-e', '-ex', '-exp'
+        new_data_dictionary_export(argv)
       else
-        system "bundle exec rake"
+        help
       end
     end
 
@@ -43,17 +43,25 @@ EOT
 Usage: spout COMMAND [ARGS]
 
 The most common spout commands are:
-  new         Create a new Spout dictionary. "spout new my_dd" creates a
+  [n]ew       Create a new Spout dictionary. "spout new my_dd" creates a
               new data dictionary called MyDD in "./my_dd"
-  test        Running the test file (short-cut alias: "t")
-  import      Import a CSV file into the JSON repository
-  export      Export the JSON respository to a CSV
-  version     Returns the version of Spout
+  [t]est      Running the test file
+  [i]mport    Import a CSV file into the JSON repository
+  [e]xport    Export the JSON respository to a CSV
+  [v]ersion   Returns the version of Spout
+
+Each command 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 dd:create #{version_string}"
+      end
+
       def new_template_dictionary(argv)
         @full_path = File.join(argv[1].to_s.strip)
         usage = <<-EOT
@@ -64,7 +72,7 @@ The FOLDER must be empty or new.
 
 EOT
 
-        if Dir.exists?(@full_path) and (Dir.entries(@full_path) - ['.', '..']).size > 0
+        if @full_path == '' or (Dir.exists?(@full_path) and (Dir.entries(@full_path) - ['.', '..']).size > 0)
           puts usage
           exit(0)
         end
@@ -81,7 +89,7 @@ EOT
         directory 'test'
         copy_file 'test/dictionary_test.rb'
         copy_file 'test/test_helper.rb'
-        puts "         run  bundle install"
+        puts "         run".colorize( :green ) + "  bundle install".colorize( :blue )
         Dir.chdir(@full_path)
         system "bundle install"
       end
@@ -92,13 +100,13 @@ EOT
         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  #{file_name}"
+        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  #{directory_name}"
+        puts "      create".colorize( :green ) + "  #{directory_name}"
         FileUtils.mkpath(directory_path)
       end
 

data/lib/spout/tasks/engine.rake

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require 'colorize'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
@@ -33,12 +34,13 @@ namespace :dd do
     end
     CSV.open("#{folder}/domains.csv", "wb") do |csv|
       keys = %w(value display_name description)
-      csv << ['id'] + keys
+      csv << ['folder', 'id'] + keys
       Dir.glob("domains/**/*.json").each do |file|
         if json = JSON.parse(File.read(file)) rescue false
-          domain_name = file.gsub(/domains\//, '')
+          domain_folder = file.gsub(/domains\//, '').split('/')[0..-2].join('/')
+          domain_name = file.gsub(/domains\//, '').split('/').last.to_s.gsub(/.json/, '')
           json.each do |hash|
-            csv << [domain_name] + keys.collect{|key| hash[key]}
+            csv << [domain_folder, domain_name] + keys.collect{|key| hash[key]}
           end
         end
       end
@@ -49,12 +51,18 @@ namespace :dd do
 
   desc 'Initialize JSON repository from a CSV file: CSV=datadictionary.csv'
   task :import do
+    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( :blue ).underline + "\n\n"
+
     puts ENV['CSV'].inspect
     if File.exists?(ENV['CSV'].to_s)
       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 `id` in data dictionary.".colorize( :red ) + additional_csv_info
+          exit(1)
+        end
         next if row['id'] == ''
-        folder = File.join('variables', row.delete('folder').to_s.gsub(':', '/'))
+        folder = File.join('variables', row.delete('folder').to_s)
         FileUtils.mkpath folder
         hash = {}
         id = row.delete('id')
@@ -70,16 +78,16 @@ namespace :dd do
         hash['calculation'] = calculation if calculation != ''
         labels = row.delete('labels').to_s.split(';')
         hash['labels'] = labels if labels.size > 0
-        hash['other'] = row
+        hash['other'] = row unless row.empty?
 
         file_name = File.join(folder, id.downcase + '.json')
         File.open(file_name, 'w') do |file|
           file.write(JSON.pretty_generate(hash))
         end
-        puts "      create  #{file_name}"
+        puts "      create".colorize( :green ) + "  #{file_name}"
       end
     else
-      puts "Please specify a valid CSV file."
+      puts "\nPlease specify a valid CSV file.".colorize( :red ) + additional_csv_info
     end
   end
 end

data/lib/spout/tests.rb

@@ -6,12 +6,14 @@ require 'json'
 require 'spout/tests/domain_existence_validation'
 require 'spout/tests/json_validation'
 require 'spout/tests/variable_type_validation'
+require 'spout/tests/domain_format'
 
 module Spout
   module Tests
     include Spout::Tests::JsonValidation
     include Spout::Tests::VariableTypeValidation
     include Spout::Tests::DomainExistenceValidation
+    include Spout::Tests::DomainFormat
 
     Turn.config.trace = 1
   end

data/lib/spout/tests/domain_existence_validation.rb

@@ -6,8 +6,7 @@ module Spout
         result = begin
           domain_name = JSON.parse(File.read(item))["domain"]+".json"
           File.exists?(File.join("domains", domain_name))
-        rescue JSON::ParserError => e
-          error = e
+        rescue JSON::ParserError
           false
         end
         full_message = build_message(msg, "The domain \"domains/#{domain_name}\" referenced by ? does not exist.", item)

data/lib/spout/tests/domain_format.rb

@@ -0,0 +1,31 @@
+module Spout
+  module Tests
+    module DomainFormat
+
+      def assert_domain_format(item, msg = nil)
+        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
+          else
+            false
+          end
+        rescue JSON::ParserError
+          false
+        end
+
+        full_message = build_message(msg, "Must be an array of choice hashes. Ex:\n[\n  {\n    \"value\":        \"1\",\n    \"display_name\": \"Option 1\",\n    \"description\":  \"...\"\n  },\n  { ... },\n  ...\n]")
+        assert_block(full_message) do
+          result
+        end
+      end
+
+      Dir.glob("domains/**/*.json").each do |file|
+        define_method("test_json: "+file) do
+          assert_domain_format file
+        end
+      end
+
+    end
+  end
+end

data/lib/spout/tests/variable_type_validation.rb

@@ -1,7 +1,7 @@
 module Spout
   module Tests
     module VariableTypeValidation
-      VALID_VARIABLE_TYPES = ['identifier', 'choices', 'integer', 'numeric'].sort
+      VALID_VARIABLE_TYPES = ['identifier', 'choices', 'integer', 'numeric', 'string', 'text', 'date', 'time', 'file'].sort
 
       def assert_variable_type(item, msg = nil)
         full_message = build_message(msg, "? invalid variable type. Valid types: #{VALID_VARIABLE_TYPES.join(', ')}", item)

data/lib/spout/version.rb

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

data/spout.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rake"
   spec.add_dependency "turn"
   spec.add_dependency "json"
+  spec.add_dependency "colorize", "~> 0.5.8"
 
   spec.add_development_dependency "bundler", "~> 1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
+  version: 0.1.0.rc3
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ files:
 - lib/spout/templates/test/test_helper.rb
 - lib/spout/templates/travis.yml
 - lib/spout/tests/domain_existence_validation.rb
+- lib/spout/tests/domain_format.rb
 - lib/spout/tests/json_validation.rb
 - lib/spout/tests/variable_type_validation.rb
 - lib/spout/tests.rb