spout 0.3.0.rc2 → 0.3.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5671a8b41975a9ab290e27c97afd2e145e3b268
-  data.tar.gz: de9fbced0d2dd9f7b926cf266a3d7f44c64102de
+  metadata.gz: e50bf89439f62303ac004c28c0a8667703e30f4a
+  data.tar.gz: be7c8397dce6d4079f0d98b8e06923e2b1e685c3
 SHA512:
-  metadata.gz: 92c999b5af0fb4832ba0f3fb1d9ab4302e060d7d4da38232a86358eae4e4de18c69390bf034cf672ee98a6250ce95d34b9a6ad05fd015ca29a20361dc49bf833
-  data.tar.gz: b6dc0ec67ca26940e11be22af04179b34cfceef4484bd16413d773977a642c435ab33633e41c2aaf6602c5f6cccdfab966871f8d5fa3fdda4a41b7e4631278ef
+  metadata.gz: b5f53395b85e06a43ff229715046d2aa5d9875e71f5a655a7b50bc1d3da37496630ba0ec2f1b064b8219d04b11143f8fec75c3cb2a6f781593eb79b135380ca2
+  data.tar.gz: 2d382de9ab10cc0ccfaf9e6b203b290c2a2da7602fe6dad2baa4948d5b49f30ce82625db93717e500c6155b7d6545b64cad05d939b0afc44d60f1557fea54552

data/CHANGELOG.md

@@ -3,10 +3,14 @@
 ### Enhancements
 - Tests now hide passing tests by default
   - To show all tests, use `spout tv`, or `bundle exec rake`
+- Tests now include check for variable and domain name uniqueness across folders
+  - `include Spout::Tests::VariableNameUniqueness`
+  - `include Spout::Tests::DomainNameUniqueness`
 - Exports will now create a folder based on the version specified in the `VERSION` file located in the root of the data dictionary
   - If a version is specified, `spout export 1.0.1` then the command line version is used
   - If no version is specified, and no `VERSION` file exists, then the default `1.0.0` is used
   - The version must be specified on the first line in the `VERSION` file
+- Spout can now create a new Spout project in a folder that was cloned from a Git repository
 - Use of Ruby 2.0.0-p247 is now recommended
 
 ## 0.2.0 (June 26, 2013)

data/lib/spout/actions.rb

@@ -88,7 +88,7 @@ The FOLDER must be empty or new.
 
 EOT
 
-        if @full_path == '' or (Dir.exists?(@full_path) and (Dir.entries(@full_path) - ['.', '..']).size > 0)
+        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

data/lib/spout/tasks/engine.rake

@@ -18,19 +18,19 @@ namespace :dd do
 
   desc 'Create Data Dictionary from repository'
   task :create do
-
     folder = "dd/#{ENV['VERSION'] || standard_version}"
+    puts "      create".colorize( :green ) + "  #{folder}"
     FileUtils.mkpath folder
 
-    case ENV['TYPE']
-    when 'hybrid'
-      hybrid_export(folder)
-    else
-      standard_export(folder)
-    end
+    export_name = nil
+    additional_keys = []
 
+    if ENV['TYPE'] == 'hybrid'
+      export_name = 'hybrid'
+      additional_keys = [['hybrid', 'design_name'], ['hybrid', 'design_file'], ['hybrid', 'sensitivity'], ['hybrid', 'commonly_used']]
+    end
 
-    puts "Data Dictionary Created in #{folder}"
+    expanded_export(folder, export_name, additional_keys)
   end
 
   desc 'Initialize JSON repository from a CSV file: CSV=datadictionary.csv'
@@ -49,18 +49,22 @@ def standard_version
   version == '' ? '1.0.0' : version
 end
 
-def standard_export(folder)
-  CSV.open("#{folder}/variables.csv", "wb") do |csv|
+def expanded_export(folder, export_name = nil, additional_keys = [])
+  variables_export_file = "#{[export_name, 'variables'].compact.join('-')}.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
+    csv << ['folder'] + keys + additional_keys.collect{|i| i[1]}
     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}
+        csv << [variable_folder] + keys.collect{|key| json[key].kind_of?(Array) ? json[key].join(';') : json[key].to_s} + additional_keys.collect{|i| other_property(i[0], json, i[1])}
       end
     end
   end
-  CSV.open("#{folder}/domains.csv", "wb") do |csv|
+  domains_export_file = "#{[export_name, 'domains'].compact.join('-')}.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|
@@ -87,85 +91,8 @@ def variable_folder_path(file)
   file.gsub(/variables\//, '').split('/')[0..-2].join('/')
 end
 
-def hybrid_concept_type(json)
-  if json['hybrid'] and json['hybrid']['type'].to_s != ''
-    json['hybrid']['type']
-  else
-    hybrid_concept_type_map(json['type'])
-  end
-end
-
-def hybrid_concept_type_map(variable_type)
-  hybrid_types = { "choices" => "categorical",
-                   "numeric" => "continuous",
-                   "integer" => "continuous",
-                   "string" => "free text",
-                   "text" => "free text",
-                   "date" => "datetime",
-                   "time" => "datetime",
-                   "file" => "free text" }
-  hybrid_types[variable_type] || variable_type
-end
-
-def hybrid_property(json, property)
-  json['hybrid'] ? json['hybrid'][property] : ''
-end
-
-def hybrid_export(folder)
-  domain_parents = {}
-  CSV.open("#{folder}/hybrid.csv", "wb") do |csv|
-    csv << ["Folder", "Short Name", "Description", "Concept Type", "Units", "Terms", "Internal Terms", "Parents", "Children", "Field Values", "Sensitivity", "Display Name", "Commonly Used", "Calculation", "Source Name", "Source File"]
-    Dir.glob("variables/**/*.json").each do |file|
-      if json = JSON.parse(File.read(file)) rescue false
-        if json['domain'].to_s != ''
-          domain_parents[json['domain'].to_s.downcase] ||= []
-          domain_parents[json['domain'].to_s.downcase] << json['id'].to_s
-        end
-        row = [
-          variable_folder_path(file),                             # Folder
-          json['id'],                                             # Short Name
-          json['description'],                                    # Description
-          hybrid_concept_type(json),                              # Concept Type
-          json['units'],                                          # Units
-          (json['labels'] || []).join(';'),                       # Terms
-          '',                                                     # Internal Terms
-          '',                                                     # Parents
-          '',                                                     # Children
-          '',                                                     # Field Values
-          hybrid_property(json, 'access level'),                  # Sensitivity
-          json['display_name'],                                   # Display Name
-          hybrid_property(json, 'most commonly used'),            # Commonly Used
-          json['calculation'],                                    # Calculation
-          hybrid_property(json, 'SOURCE'),                        # Source Name
-          hybrid_property(json, 'filename')                       # Source File
-        ]
-        csv << row
-      end
-    end
-    Dir.glob("domains/**/*.json").each do |file|
-      if json = JSON.parse(File.read(file)) rescue false
-        json.each do |option|
-          row = [
-            domain_folder_path(file),                             # Folder
-            extract_domain_name(file)+'_'+option['value'].to_s,   # Short Name
-            option['description'],                                # Description
-            'boolean',                                            # Concept Type
-            '',                                                   # Units
-            '',                                                   # Terms
-            option['value'],                                      # Internal Terms
-            (domain_parents[extract_domain_name(file).downcase] || []).join(';'), # Parents
-            '',                                                   # Children
-            '',                                                   # Field Values
-            '0',                                                  # Sensitivity
-            option['display_name'],                               # Display Name
-            '',                                                   # Commonly Used
-            '',                                                   # Calculation
-          ]
-          csv << row
-        end
-      end
-    end
-  end
+def other_property(parent, json, property)
+  json[parent] ? json[parent][property] : ''
 end
 
 def import_variables

data/lib/spout/tests.rb

@@ -3,17 +3,21 @@ require 'test/unit'
 require 'rubygems'
 require 'json'
 
-require 'spout/tests/domain_existence_validation'
 require 'spout/tests/json_validation'
 require 'spout/tests/variable_type_validation'
+require 'spout/tests/variable_name_uniqueness'
+require 'spout/tests/domain_existence_validation'
 require 'spout/tests/domain_format'
+require 'spout/tests/domain_name_uniqueness'
 
 module Spout
   module Tests
     include Spout::Tests::JsonValidation
     include Spout::Tests::VariableTypeValidation
+    include Spout::Tests::VariableNameUniqueness
     include Spout::Tests::DomainExistenceValidation
     include Spout::Tests::DomainFormat
+    include Spout::Tests::DomainNameUniqueness
 
     Turn.config.trace = 1
   end

data/lib/spout/tests/domain_name_uniqueness.rb

@@ -0,0 +1,10 @@
+module Spout
+  module Tests
+    module DomainNameUniqueness
+      def test_domain_name_uniqueness
+        files = Dir.glob("domains/**/*.json").collect{|file| file.split('/').last }
+        assert_equal [], files.select{ |f| files.count(f) > 1 }.uniq
+      end
+    end
+  end
+end

data/lib/spout/tests/variable_name_uniqueness.rb

@@ -0,0 +1,10 @@
+module Spout
+  module Tests
+    module VariableNameUniqueness
+      def test_variable_name_uniqueness
+        files = Dir.glob("variables/**/*.json").collect{|file| file.split('/').last }
+        assert_equal [], files.select{ |f| files.count(f) > 1 }.uniq
+      end
+    end
+  end
+end

data/lib/spout/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc2
+  version: 0.3.0.rc3
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,7 +104,9 @@ files:
 - lib/spout/templates/travis.yml
 - lib/spout/tests/domain_existence_validation.rb
 - lib/spout/tests/domain_format.rb
+- lib/spout/tests/domain_name_uniqueness.rb
 - lib/spout/tests/json_validation.rb
+- lib/spout/tests/variable_name_uniqueness.rb
 - lib/spout/tests/variable_type_validation.rb
 - lib/spout/tests.rb
 - lib/spout/version.rb