yamltest 0.5.0

data/History.txt

@@ -0,0 +1,4 @@
+== yamltest 0.5 2009-01-21
+
+* 1 major improvement
+  * First release after extraction from zena (http://zenadmin.org). [gaspard]

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/yamltest.rb
+script/console
+script/destroy
+script/generate
+test/gem_test
+test/gem_test/foo.yml
+test/gem_test/simple_test.rb
+test/test_helper.rb
+test/test_yamltest.rb
+test/yamltest/simple.yml
+test/zoo/complicated.yml

data/README.rdoc

@@ -0,0 +1,62 @@
+= yamltest
+
+* http://github.com/zena/yamltest/tree
+
+== DESCRIPTION:
+
+yamltest lets you configure unit test with yaml documents. Simply define a "yt_parse" method
+that will transform your "src" (source) into a "res" (result).
+
+== FEATURES:
+
+* Ease of context definition.
+* Multiple step testing with different keys.
+* Tests are only created if a test with the same name does not exist.
+* Named tests (easy to get information on failed tests).
+* If someone asks, I can try to fix my TextMate Bundle that runs the tests (all or one at a time) 
+  from the yaml file and put it online.
+
+== SYNOPSIS:
+
+  class TestSomething < Test::Unit::TestCase
+    yamltest :directory => 'relative/path/to/yaml/files'
+    
+    def yt_parse(key, source, context)
+      do_something_with(source, context)
+    end
+    
+    yt_make
+  end
+
+== REQUIREMENTS:
+
+* yaml, test/unit
+
+== INSTALL:
+
+* sudo gem install yamltest
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008-2009 Gaspard Bucher
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/yamltest'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('yamltest', Yamltest::VERSION) do |p|
+  p.developer('Gaspard Bucher', 'gaspard@teti.ch')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name
+  
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/yamltest.rb

@@ -0,0 +1,164 @@
+require 'test/unit'
+require 'yaml'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Yamltest
+  VERSION = '0.5.0'
+  module Helper
+    def self.included(obj)
+      obj.extend Yamltest::ClassMethods
+    end
+  end
+  
+  module ClassMethods
+    
+    # build an array of file_name, file_path, options
+    def file_list(caller_path, opts)
+      directories = opts[:directories] || [opts[:directory] || :default]
+      
+      if files = opts[:files]
+        files.map!{|f| f.to_s}
+      end
+      
+      directories = directories.map do |dir|
+        if dir == :default
+          if caller_path.split('/').last =~ /^(.*)_test.rb/ || caller_path.split('/').last =~ /^test_(.*).rb/
+            directories = [File.join(File.dirname(caller_path), $1)]
+          else
+            puts "Bad file name for yaml_tests '#{caller_path}'. Should be 'xxx_test.rb' or 'test_xxx.rb'. Trying parent directory."
+            directories = [File.dirname(caller_path)]
+          end
+        else
+          # relative to caller
+          Dir[File.join(File.dirname(caller_path),dir)]
+        end
+      end.flatten
+
+      file_list = []
+      
+      directories.each do |dir|
+        Dir.foreach(dir) do |f|
+          next unless f =~ /^([\w_-]+).yml/
+          next if files && !files.include?($1)
+          file_list << [$1, File.join(dir, "#{$1}.yml"), opts[$1] || opts[$1.to_sym] || {}]
+        end
+      end
+      
+      file_list
+    end
+    
+    
+    # Setup yaml testing.
+    # usage:
+    # class SuperTest < Test::Unit::TestCase
+    #   yamltest
+    #
+    # or to define custom search directories for tests definitions
+    # class SuperTest < Test::Unit::TestCase
+    #   yamltest :directories => ["sub/**", "/absolute/location"]
+    #
+    # to use only some files:
+    # class SuperTest < Test::Unit::TestCase
+    #   yamltest :files => ["one", "two"]
+    #
+    # to pass parameters during testing of a specific file:
+    # class SuperTest < Test::Unit::TestCase
+    #   yamltest :options => {:latex => {:module => Latex}}
+    #
+    def yamltest(opts = {})
+      # We need to do a class_eval so that the class variables 'test_strings, test_methods, ...' are scoped
+      # in the final class and are not global to all tests using the YamlTest helper.
+      
+      class_eval %Q{
+        @@test_strings = {}
+        @@test_methods = {}
+        @@test_options = {}
+        @@test_files = []
+        @@file_list  = file_list(#{caller[0].inspect}, #{opts.inspect})
+        
+        @@file_list.each do |file_name, file_path, opts|
+          strings = {}
+          test_methods = []
+          begin
+            YAML::load_documents( File.open( file_path ) ) do |doc|
+              doc.each do |elem|
+                test_methods << elem[0]
+                strings[elem[0]] = elem[1]
+              end
+            end
+          rescue ArgumentError => err
+            puts "Error while loading test file \#{file_path}"
+            raise err
+          end
+          class_eval "
+            def \#{file_name}
+              @@test_strings['\#{file_name}']
+            end
+          "
+          @@test_strings[file_name] = strings.freeze
+          @@test_methods[file_name] = test_methods
+          @@test_files << file_name
+        end
+        
+        # Override this in your test class
+        def yt_parse(key, source, context)
+          source
+        end
+        
+        def yt_do_test(file, test, context = yt_get('context',file,test))
+          @@test_strings[file][test].keys.each do |key|
+            next if ['src', 'context'].include?(key)
+            yt_assert yt_get(key,file,test), yt_parse(key, yt_get('src',file,test), context)
+          end
+        end
+        
+        protected
+          def yt_assert(test_res, res)
+            if test_res.kind_of?(String) && test_res[0..1] == '!/'
+              assert_no_match %r{\#{test_res[2..-2]}}m, res
+            elsif test_res.kind_of?(String) && test_res[0..0] == '/'
+              assert_match %r{\#{test_res[1..-2]}}m, res
+            else
+              assert_equal test_res, res
+            end
+          end
+          
+          def yt_get(key, file, test)
+            case key
+            when 'context', :context
+              context = @@test_strings[file][test]['context'] || {}
+              default_context = (@@test_strings[file]['default'] || {})['context'] || {}
+              context = default_context.merge(context)
+            when 'src'
+              @@test_strings[file][test]['src'] || test.gsub('_',' ')
+            else
+              @@test_strings[file][test][key.to_s]
+            end
+          end
+      }
+    end
+    
+    def yt_make
+      class_eval %q{
+        return unless @@test_methods
+        tests = self.instance_methods.reject! {|m| !( m =~ /^test_/ )}
+        @@test_files.each do |tf|
+          @@test_methods[tf].each do |test|
+            unless tests.include?("test_#{tf}_#{test}")
+              tests << "test_#{tf}_#{test}"
+              class_eval <<-END
+                def test_#{tf}_#{test}
+                  yt_do_test(#{tf.inspect}, #{test.inspect})
+                end
+              END
+            end
+          end
+        end
+      }
+    end
+  end
+end
+
+Test::Unit::TestCase.send :include, Yamltest::Helper

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/yamltest.rb'}"
+puts "Loading yamltest gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/gem_test/foo.yml

@@ -0,0 +1,7 @@
+default:
+  context:
+  src: "12345"
+  res: "54321"
+
+new_york:
+  res: 'kroy wen'

data/test/gem_test/simple_test.rb

@@ -0,0 +1,15 @@
+# Simple file to test installed gem
+
+require 'test/unit'
+require 'rubygems'
+require 'yamltest'
+
+class TestYamltestGem < Test::Unit::TestCase
+  yamltest :directory => '.'
+  
+  def yt_parse(key, source, context)
+    source.split(//).reverse.join
+  end
+  
+  yt_make
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/yamltest'

data/test/test_yamltest.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+# patch Hash to sort keys on inspect for consistency
+class Hash
+  def inspect
+    res = []
+    keys.map{|k| [k, k.to_s]}.sort{|a,b| a[1] <=> b[1]}.each do |k, ks|
+      res << "#{k.inspect} => #{self[k].inspect}"
+    end
+    "{#{res.join(', ')}}"
+  end
+end
+
+class TestDefaultFolder < Test::Unit::TestCase
+  yamltest
+  
+  def yt_parse(key, source, context)
+    eval(source)
+  end
+  
+  def test_to_make_sure_tests_are_valid
+    assert (respond_to?('test_simple_default') and
+             (method('test_simple_default').arity == 0 ||
+              method('test_simple_default').arity == -1))
+  end
+  
+  yt_make
+end
+
+class TestCustomKeys < Test::Unit::TestCase
+  yamltest :directory => 'zoo'
+  
+  def yt_parse(key, source, context)
+    res = source.gsub('o', 'a')
+    case key
+    when 'res'
+      res
+    when 'len'
+      res.length
+    when 'foo'
+      context['foo']
+    else
+      "bad test key #{key.inspect}"
+    end
+  end
+  
+  # This test will not be redefined by 'make_tests'
+  def test_complicated_animal
+    context = yt_get('context', 'complicated', 'animal')
+    context['foo'] = 'bozo'
+    yt_do_test('complicated', 'animal', context)
+  end
+  
+  yt_make
+end

data/test/yamltest/simple.yml

@@ -0,0 +1,16 @@
+default:
+  context:
+    one: 1
+    two: 2
+    env:
+      login: 'Joe'
+      pass:  'secret'
+  src: "context.inspect"
+  res: '{"env" => {"login" => "Joe", "pass" => "secret"}, "one" => 1, "two" => 2}'
+
+overwrite_key_replaces_hash:
+  context:
+    env:
+      login: 'Marc'
+  src: "context.inspect"
+  res: '{"env" => {"login" => "Marc"}, "one" => 1, "two" => 2}'

data/test/zoo/complicated.yml

@@ -0,0 +1,16 @@
+default:
+  src: "John is Good"
+  res: "Jahn is Gaad"
+
+other_keys:
+  context:
+    env:
+      login: 'Marc'
+  src: "Moon"
+  len: 4
+  res: "Maan"
+  
+animal:
+  context:
+    foo: "bar"
+  foo: "bozo"

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: yamltest
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Gaspard Bucher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: yamltest lets you configure unit test with yaml documents. Simply define a "yt_parse" method that will transform your "src" (source) into a "res" (result).
+email: 
+- gaspard@teti.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/yamltest.rb
+- script/console
+- script/destroy
+- script/generate
+- test/gem_test
+- test/gem_test/foo.yml
+- test/gem_test/simple_test.rb
+- test/test_helper.rb
+- test/test_yamltest.rb
+- test/yamltest/simple.yml
+- test/zoo/complicated.yml
+has_rdoc: true
+homepage: http://github.com/zena/yamltest/tree
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yamltest
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: yamltest lets you configure unit test with yaml documents
+test_files: 
+- test/test_helper.rb
+- test/test_yamltest.rb