spout 0.0.1.pre → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe71bde7117d9d6c8e762ac1c317a1c081a0c128
-  data.tar.gz: f73c0a7af28d13123e83e995490a074b930b47df
+  metadata.gz: 880fd246ea520f004a09cf9bf2b576d5866c9850
+  data.tar.gz: 65d2e48269923e7a46cd7448fa8e265c3ad8ac6c
 SHA512:
-  metadata.gz: dd77404cca8453b8da545bd1f098133e03144c4e1d8f64d2f781b5a31efa6b59cd4a71538b1f8fbf8275320a3aad9fa52d685e641de8f4e91d0d139c74cd19f4
-  data.tar.gz: c0004991d0d1b942ddfba3ab724f98e0221feedde76d45af3b5c3fa9da8fbb887f4f283187f25f3dcfde5690c8b4d1b0ea930cb16e1d89c3bd3c4526dccac382
+  metadata.gz: bad0c66a8fc3e992e3affcd6cff667a749f6acd0db8b858cd53d37af5961f1db83003d98b8f4bb205c111074053d19d82689b41a4f3b16ba93d60fd8835983ed
+  data.tar.gz: ec2ce69aa8c5157d7d4345ad12d78c91564951afc1c564868c2c8c17dc6993b6a9d82cd52fd6edca05e0329021e3c62a5442f969ef74bdb39073f78f4296a63b

data/CHANGELOG.md

@@ -1 +1,15 @@
-CHANGELOG.md
+## 0.1.0
+
+### Enhancements
+- Existing Data Dictionaries can be converted to JSON format from a CSV file
+- 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
+- Added test to check if a domain referenced from a variable exists
+- Tests can now be added as a group, or on a test-by-test basis
+  - Add `require 'spout/tests'` to your individual tests, or to your `test_helper.rb`
+  - Include the all or some of the tests provided by Spout
+    - `include Spout::Tests` for all tests
+    - `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

data/README.md

@@ -30,12 +30,32 @@ bundle exec rake dd:import CSV=data_dictionary.csv
 
 ### Test your repository
 
+
 ```
-spout test # or bundle exec rake
+require 'spout/tests'
+
+class DictionaryTest < Test::Unit::TestCase
+  include Spout::Tests
+end
 ```
 
+```
+require 'spout/tests'
+
+class DictionaryTest < Test::Unit::TestCase
+  # Or only include certain tests
+  include Spout::Tests::JsonValidation
+  include Spout::Tests::VariableTypeValidation
+end
+```
+
+Then run either `bundle exec rake` or `spout test` to run your tests
+
+
 ### Create a CSV Data Dictionary from your JSON repository
 
+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
+bundle exec rake dd:create [VERSION]
 ```

data/bin/spout

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

data/lib/spout/actions.rb

@@ -1,7 +1,7 @@
 module Spout
-  module Actions
+  class Actions
 
-    def self.help
+    def help
       help_message = <<-EOT
 
 Usage: spout COMMAND [ARGS]
@@ -16,16 +16,14 @@ EOT
       puts help_message
     end
 
-    def self.interpret(argv)
+    def interpret(argv)
       case argv.first
       when '--version', '-v', 'version'
         puts "Spout #{Spout::VERSION::STRING}"
-        # exit(0)
       when 'help', '--help', '-h'
         help
-        exit(0)
       else
-        require 'spout/test_helpers'
+        system "bundle exec rake"
       end
     end
 

data/lib/spout/tasks/engine.rake

@@ -1,10 +1,5 @@
 require 'rake/testtask'
 
-desc 'do something'
-task :something do
-  puts "something"
-end
-
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/**/*_test.rb']
@@ -12,6 +7,8 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+task :default => :test
+
 namespace :dd do
   require 'csv'
   require 'fileutils'
@@ -79,5 +76,3 @@ namespace :dd do
     end
   end
 end
-
-task :default => :test

data/lib/spout/tests.rb

@@ -0,0 +1,16 @@
+require 'turn/autorun'
+require 'test/unit'
+require 'rubygems'
+require 'json'
+
+require 'spout/tests/domain_existence_validation'
+require 'spout/tests/json_validation'
+require 'spout/tests/variable_type_validation'
+
+module Spout
+  module Tests
+    include Spout::Tests::JsonValidation
+    include Spout::Tests::VariableTypeValidation
+    include Spout::Tests::DomainExistenceValidation
+  end
+end

data/lib/spout/tests/domain_existence_validation.rb

@@ -0,0 +1,15 @@
+module Spout
+  module Tests
+    module DomainExistenceValidation
+
+      Dir.glob("variables/**/*.json").each do |file|
+        if (not [nil, ''].include?(JSON.parse(File.read(file))["domain"]) rescue false)
+          define_method("test_domain_exists: "+file) do
+            assert_equal true, (File.exists?(File.join("domains", JSON.parse(File.read(file))["domain"]+".json")) rescue false)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/spout/tests/json_validation.rb

@@ -0,0 +1,19 @@
+module Spout
+  module Tests
+    module JsonValidation
+
+      Dir.glob("variables/**/*.json").each do |file|
+        define_method("test_json: "+file) do
+          assert_equal true, (!!JSON.parse(File.read(file)) rescue false)
+        end
+      end
+
+      Dir.glob("domains/**/*.json").each do |file|
+        define_method("test_json: "+file) do
+          assert_equal true, (!!JSON.parse(File.read(file)) rescue false)
+        end
+      end
+
+    end
+  end
+end

data/lib/spout/tests/variable_type_validation.rb

@@ -0,0 +1,14 @@
+module Spout
+  module Tests
+    module VariableTypeValidation
+      VALID_VARIABLE_TYPES = ['identifier', 'choices', 'integer', 'numeric']
+
+      Dir.glob("variables/**/*.json").each do |file|
+        define_method("test_variable_type: "+file) do
+          assert_equal true, (VALID_VARIABLE_TYPES.include?(JSON.parse(File.read(file))["type"]) rescue false)
+        end
+      end
+
+    end
+  end
+end

data/lib/spout/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spout
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,7 +80,10 @@ files:
 - lib/spout/application.rb
 - lib/spout/tasks/engine.rake
 - lib/spout/tasks.rb
-- lib/spout/test_helpers.rb
+- lib/spout/tests/domain_existence_validation.rb
+- lib/spout/tests/json_validation.rb
+- lib/spout/tests/variable_type_validation.rb
+- lib/spout/tests.rb
 - lib/spout/version.rb
 - lib/spout.rb
 - CHANGELOG.md

data/lib/spout/test_helpers.rb

@@ -1,39 +0,0 @@
-require 'turn/autorun'
-require 'test/unit'
-require 'rubygems'
-require 'json'
-
-module Spout
-  module TestHelpers
-    VALID_VARIABLE_TYPES = ['identifier', 'choices', 'integer', 'numeric']
-
-    class TestCase < Test::Unit::TestCase
-      Dir.glob("domains/**/*.json").each do |file|
-        define_method("test_json: "+file) do
-          assert_equal true, (!!JSON.parse(File.read(file)) rescue false)
-        end
-      end
-
-      Dir.glob("variables/**/*.json").each do |file|
-
-        define_method("test_json: "+file) do
-          assert_equal true, (!!JSON.parse(File.read(file)) rescue false)
-        end
-
-        define_method("test_variable_type: "+file) do
-          assert_equal true, (::VALID_VARIABLE_TYPES.include?(JSON.parse(File.read(file))["type"]) rescue false)
-        end
-
-        if (not [nil, ''].include?(JSON.parse(File.read(file))["domain"]) rescue false)
-          define_method("test_domain_exists: "+file) do
-            assert_equal true, (File.exists?(File.join("domains", JSON.parse(File.read(file))["domain"]+".json")) rescue false)
-          end
-        end
-
-      end
-    end
-
-
-
-  end
-end