spout 0.1.0.pre → 0.1.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 880fd246ea520f004a09cf9bf2b576d5866c9850
-  data.tar.gz: 65d2e48269923e7a46cd7448fa8e265c3ad8ac6c
+  metadata.gz: e32f497120ec785b137d1c17e742276175bcefb1
+  data.tar.gz: fc4b7095bc652ca44c4ad0fc57bcb9b7e393faf1
 SHA512:
-  metadata.gz: bad0c66a8fc3e992e3affcd6cff667a749f6acd0db8b858cd53d37af5961f1db83003d98b8f4bb205c111074053d19d82689b41a4f3b16ba93d60fd8835983ed
-  data.tar.gz: ec2ce69aa8c5157d7d4345ad12d78c91564951afc1c564868c2c8c17dc6993b6a9d82cd52fd6edca05e0329021e3c62a5442f969ef74bdb39073f78f4296a63b
+  metadata.gz: 348a4e793232013cfe12d1444ad6e68e802b095e3cc5b6ee0663ae3985ad010cb1d828c099827f86c991a156e6457fce97667b9ca1fc04ef270647c2bd7f4d6f
+  data.tar.gz: 559c1d2b2c288d81bd2be68387fce94d15f1ac2cccf03bb17ac56cad7457bc2d9d353a3a33cbc1bbc6c4b6e52c374f3ad525ca8f19131762863bebda090c401b

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ### Enhancements
 - Existing Data Dictionaries can be converted to JSON format from a CSV file
+  - Recognized columns:
+    - `folder`
+    - `id`
+    - `display_name`
+    - `description`
+    - `type`
+    - `domain`
+    - `units`
+    - `calculation`
+    - `labels`
+  - All other columns will go into an `Other` JSON hash
 - Added a rake task to create CSVs of the JSON data dictionary
 - Added tests for JSON validity of variables and domains
 - Added test to check presence/validity of variable type
@@ -13,3 +24,4 @@
     - `include Spout::Tests::JsonValidation` to verify valid JSON formats of domains and variables
     - `include Spout::Tests::VariableTypeValidation` to verify valid variable type for variables
     - `include Spout::Tests::DomainExistenceValidation` to verify existence of domains referenced by variables
+- Added `spout new FOLDER` to create an empty data dictionary in the specified `FOLDER`

data/README.md

@@ -25,7 +25,7 @@ spout new my_data_dictionary
 
 cd my_data_dictionary
 
-bundle exec rake dd:import CSV=data_dictionary.csv
+spout import CSV=data_dictionary.csv
 ```
 
 ### Test your repository
@@ -57,5 +57,11 @@ Then run either `bundle exec rake` or `spout test` to run your tests
 Provide an optional version parameter to name the folder the CSVs will be generated in, defaults to 1.0.0 currently.
 
 ```
-bundle exec rake dd:create [VERSION]
+spout export
+```
+
+or
+
+```
+bundle exec rake dd:create [VERSION=1.0.0]
 ```

data/lib/spout/actions.rb

@@ -1,31 +1,106 @@
 module Spout
   class Actions
 
-    def help
-      help_message = <<-EOT
+    def interpret(argv)
+      case argv.first
+      when 'new'
+        new_template_dictionary(argv)
+      when '--version', '-v', 'version'
+        puts "Spout #{Spout::VERSION::STRING}"
+      when 'help', '--help', '-h'
+        help
+      when 'import'
+        import_from_csv(argv)
+      when 'export'
+        system "bundle exec rake dd:create"
+      else
+        system "bundle exec rake"
+      end
+    end
+
+    protected
+
+      def import_from_csv(argv)
+        usage = <<-EOT
+
+Usage: spout import CSVFILE
+
+The CSVFILE must be the location of a valid CSV file.
+
+EOT
+
+        csv_file = File.join(argv[1].to_s.strip)
+        if File.exists?(csv_file)
+          system "bundle exec rake dd:import CSV=#{csv_file}"
+        else
+          puts usage
+        end
+      end
+
+      def help
+        help_message = <<-EOT
 
 Usage: spout COMMAND [ARGS]
 
 The most common spout commands are:
-  test        Running the test file (short-cut alias: "t")
   new         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
 
 EOT
-      puts help_message
-    end
+        puts help_message
+      end
 
-    def interpret(argv)
-      case argv.first
-      when '--version', '-v', 'version'
-        puts "Spout #{Spout::VERSION::STRING}"
-      when 'help', '--help', '-h'
-        help
-      else
-        system "bundle exec rake"
+      def new_template_dictionary(argv)
+        @full_path = File.join(argv[1].to_s.strip)
+        usage = <<-EOT
+
+Usage: spout new FOLDER
+
+The FOLDER must be empty or new.
+
+EOT
+
+        if Dir.exists?(@full_path) and (Dir.entries(@full_path) - ['.', '..']).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'
+        copy_file 'Gemfile'
+        copy_file 'Rakefile'
+        directory 'domains'
+        directory 'variables'
+        directory 'test'
+        copy_file 'test/dictionary_test.rb'
+        copy_file 'test/test_helper.rb'
+        puts "         run  bundle install"
+        Dir.chdir(@full_path)
+        system "bundle install"
+      end
+
+    private
+
+      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(File.expand_path(File.dirname(__FILE__)), "templates", template_file)
+        puts "      create  #{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}"
+        FileUtils.mkpath(directory_path)
       end
-    end
 
   end
 end

data/lib/spout/tasks/engine.rake

@@ -22,12 +22,12 @@ namespace :dd do
     FileUtils.mkpath folder
 
     CSV.open("#{folder}/variables.csv", "wb") do |csv|
-      keys = %w(id display_name description type domain)
+      keys = %w(id display_name description type units domain labels calculation)
       csv << ['folder'] + keys
       Dir.glob("variables/**/*.json").each do |file|
         if json = JSON.parse(File.read(file)) rescue false
           variable_folder = file.gsub(/variables\//, '').split('/')[0..-2].join('/')
-          csv << [variable_folder] + keys.collect{|key| json[key]}
+          csv << [variable_folder] + keys.collect{|key| json[key].kind_of?(Array) ? json[key].join(';') : json[key].to_s}
         end
       end
     end
@@ -53,24 +53,31 @@ namespace :dd do
     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
-        next if row['COLUMN'] == ''
-        folder = File.join('variables', row['FOLDER'])
+        next if row['id'] == ''
+        folder = File.join('variables', row['folder'])
         FileUtils.mkpath folder
         hash = {}
-        hash['id'] = row['COLUMN']
-        hash['display_name'] = row['DISPLAY_NAME']
-        hash['description'] = row['DESCRIPTION'].to_s
-        hash['type'] = row['VARIABLE_TYPE']
-        hash['domain'] = row['DOMAIN'] if row['DOMAIN'] != '' and row['DOMAIN'] != nil
-        hash['units'] = row['UNITS'] if row['UNITS'] != '' and row['UNITS'] != nil
-        hash['calculation'] = row['CALCULATION'] if row['DOMAIN'] != '' and row['CALCULATION'] != nil
-        hash['labels'] = row['LABELS'].to_s.split(';') if row['LABELS'].to_s.split(';').size > 0
+        id = row.delete('id')
+        hash['id'] = id
+        hash['display_name'] = row.delete('display_name')
+        hash['description'] = row.delete('description').to_s
+        hash['type'] = row.delete('type')
+        domain = row.delete('domain').to_s
+        hash['domain'] = domain if domain != ''
+        units = row.delete('units').to_s
+        hash['units'] = units if units != ''
+        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['other'] = row
 
-        File.open(File.join(folder, row['COLUMN'].downcase + '.json'), 'w') do |file|
+        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}"
       end
-      puts "Data Dictionary Imported from CSV."
     else
       puts "Please specify a valid CSV file."
     end

data/lib/spout/templates/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'spout'

data/lib/spout/templates/Rakefile

@@ -0,0 +1,2 @@
+require 'spout'
+Spout::Application.new.load_tasks

data/lib/spout/templates/gitignore

@@ -0,0 +1,8 @@
+# OS generated files #
+.DS_Store
+
+# Project Files
+/Gemfile.lock
+
+# Data Dictionary folders
+/dd

data/lib/spout/templates/ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/lib/spout/templates/test/dictionary_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class DictionaryTest < Test::Unit::TestCase
+  include Spout::Tests
+
+  # You may add additional tests here
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/lib/spout/templates/test/test_helper.rb

@@ -0,0 +1 @@
+require 'spout/tests'

data/lib/spout/templates/travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/lib/spout/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0.rc
 platform: ruby
 authors:
 - Remo Mueller
@@ -80,6 +80,13 @@ files:
 - lib/spout/application.rb
 - lib/spout/tasks/engine.rake
 - lib/spout/tasks.rb
+- lib/spout/templates/Gemfile
+- lib/spout/templates/gitignore
+- lib/spout/templates/Rakefile
+- lib/spout/templates/ruby-version
+- lib/spout/templates/test/dictionary_test.rb
+- lib/spout/templates/test/test_helper.rb
+- lib/spout/templates/travis.yml
 - lib/spout/tests/domain_existence_validation.rb
 - lib/spout/tests/json_validation.rb
 - lib/spout/tests/variable_type_validation.rb