param_test 0.0.1beta

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+param-test-ruby
+===============
+
+Parametrized unit tests for Ruby/ActiveSupport

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/*_test.rb']
+  test.verbose = true
+  test.warning = true
+end
+
+task :default => [:test]

data/lib/active_support/testing/parametrized.rb

@@ -0,0 +1,76 @@
+module ActiveSupport
+  module Testing
+    module Parametrized
+
+      # Generates parametrized tests, one for each set of parameters given.
+      # The description must be a format specification with the same number
+      # of substitutions as each parameter set has arguments (generally,
+      # just use one '%s' substitution per parameter). The body of the test
+      # is the given block executed with each parameter set.
+      #
+      # = Examples
+      #
+      # This code within an ActiveSupport::Testcase
+      #
+      #   param_test "string %s is ASCII only",
+      #   ["foo", "bar", "baz"] do |string|
+      #     assert string.ascii_only?
+      #   end
+      #
+      # Generates 3 test methods, one for each parameter given, with names
+      # based on the description.
+      #
+      # Another example with multiple parameters, generating 2 test methods:
+      #
+      #   param_test "%s is uppercase %s",
+      #   [["FOO", "foo"], ["BAR", "bar"]] do |expected, param|
+      #     assert_equal expected, param.upcase
+      #   end
+      #
+      def param_test(description_template, parameters, &block)
+        parameters.each do |param_set|
+          # Replacing nil values with 'nil' string because nil values will
+          # get converted to an empty string within a test name.
+          if param_set.kind_of? Array
+            sanitized_param_set = param_set.map do |param|
+              param.nil? ? 'nil' : param
+            end
+          else
+            sanitized_param_set = param_set.nil? ? 'nil' : param_set
+          end
+
+          begin
+            description = description_template % sanitized_param_set
+          rescue ArgumentError
+            raise ArgumentError, "Parameter set #{param_set} doesn't match number " +
+              "of arguments expected by description template '#{description_template}'"
+          end
+
+          # Make sure the description generates a unique test method name.
+          unique_description = description
+          if instance_methods.include? generate_test_name(unique_description)
+            count = 1
+            description += " %s"
+            unique_description = description % count
+          end
+          while instance_methods.include? generate_test_name(unique_description)
+            count += 1
+            unique_description = description % count
+          end
+
+          test unique_description do
+            instance_exec param_set, &block
+          end
+        end
+      end
+
+      private
+
+      def generate_test_name(description)
+        # Declarative 'test' uses the same substitution of whitespace.
+        sanitized_description = description.gsub(/\s+/,'_')
+        "test_#{sanitized_description}".to_sym
+      end
+    end
+  end
+end

data/lib/param_test.rb

@@ -0,0 +1,8 @@
+require 'active_support/test_case'
+require 'active_support/testing/parametrized'
+
+module ActiveSupport
+  class TestCase
+    extend ActiveSupport::Testing::Parametrized
+  end
+end

data/param_test.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'param_test'
+  s.version     = '0.0.1beta'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nik Haldimann']
+  s.email       = ['nhaldimann@gmail.com']
+  s.homepage    = 'https://github.com/nikhaldi/param-test-ruby'
+  s.summary     = 'Parametrized unit tests for Ruby/ActiveSupport'
+  s.description = 'Parametrized unit tests for Ruby/ActiveSupport'
+
+  s.add_runtime_dependency 'activesupport', '~> 3.2'
+  s.add_development_dependency 'rake'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'param_test'
+require 'test/unit'

data/test/param_test_meta_test.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+class ParamTestMetaTest < ActiveSupport::TestCase
+
+  def assert_test_method_count(clazz, expected_count)
+    instance_methods = clazz.instance_methods - clazz.superclass.instance_methods
+    assert_equal expected_count, instance_methods.grep(/^test/).size
+  end
+
+  def assert_has_test_method(clazz, expected_method_name)
+    assert_include clazz.instance_methods, expected_method_name
+  end
+
+  test "empty parameters adds no tests" do
+    test_case = Class.new ActiveSupport::TestCase do
+      param_test "adds no tests", [] do |param| end
+    end
+    assert_test_method_count test_case, 0
+  end
+
+  test "single parameter list adds one test" do
+    test_case = Class.new ActiveSupport::TestCase do
+      param_test "adds one test %s", [42] do |param| end
+    end
+    assert_test_method_count test_case, 1
+    assert_has_test_method test_case, :test_adds_one_test_42
+  end
+
+  test "multiple parameters generate correct method name" do
+    test_case = Class.new ActiveSupport::TestCase do
+      param_test "adds one test %s two params %s", [[41, 42]] do |first, second| end
+    end
+    assert_test_method_count test_case, 1
+    assert_has_test_method test_case, :test_adds_one_test_41_two_params_42
+  end
+
+  test "two parameter lists generate two methods" do
+    test_case = Class.new ActiveSupport::TestCase do
+      param_test "with two params %s %s",
+        [[41, 42], [43, 44]] do |first, second| end
+    end
+    assert_test_method_count test_case, 2
+    assert_has_test_method test_case, :test_with_two_params_41_42
+    assert_has_test_method test_case, :test_with_two_params_43_44
+  end
+
+  test "uneven parameter lists fails" do
+    assert_raise ArgumentError do
+      Class.new ActiveSupport::TestCase do
+        param_test "%s %s",
+          [[41, 42], [43], [44, 45]] do |first, second| end
+      end
+    end
+  end
+
+  test "substitutes nil string for nil" do
+    test_case = Class.new ActiveSupport::TestCase do
+      param_test "params %s %s",
+        [[nil, nil]] do |param| end
+    end
+    assert_test_method_count test_case, 1
+    assert_has_test_method test_case, :test_params_nil_nil
+  end
+
+  test "generates unique test names" do
+    test_case = Class.new ActiveSupport::TestCase do
+      param_test "param %s",
+        [nil, "nil", "", " ", "\n  \t"] do |param| end
+    end
+    assert_test_method_count test_case, 5
+    assert_has_test_method test_case, :test_param_nil
+    assert_has_test_method test_case, :test_param_nil_1
+    assert_has_test_method test_case, :test_param_
+    assert_has_test_method test_case, :test_param_1
+    assert_has_test_method test_case, :test_param_2
+  end
+
+end

data/test/param_test_test.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class ParamTestTest < ActiveSupport::TestCase
+
+  param_test "single parameter: %s", [1, 2, 3] do |param|
+    assert param.is_a? Numeric
+  end
+
+  param_test "multiple parameters: %s %s",
+  [[1, 1], [2, 2], [3, 3]] do |first_param, second_param|
+    assert_equal first_param, second_param
+  end
+
+  # Example from the rdoc string
+  param_test "string %s is ASCII only",
+  ["foo", "bar", "baz"] do |string|
+    assert string.ascii_only?
+  end
+
+  # 2nd example from the rdoc string
+  param_test "%s is uppercase %s",
+  [["FOO", "foo"], ["BAR", "bar"]] do |expected, param|
+    assert_equal expected, param.upcase
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: param_test
+version: !ruby/object:Gem::Version
+  version: 0.0.1beta
+  prerelease: 5
+platform: ruby
+authors:
+- Nik Haldimann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parametrized unit tests for Ruby/ActiveSupport
+email:
+- nhaldimann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/active_support/testing/parametrized.rb
+- lib/param_test.rb
+- param_test.gemspec
+- test/helper.rb
+- test/param_test_meta_test.rb
+- test/param_test_test.rb
+homepage: https://github.com/nikhaldi/param-test-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Parametrized unit tests for Ruby/ActiveSupport
+test_files:
+- test/helper.rb
+- test/param_test_meta_test.rb
+- test/param_test_test.rb
+has_rdoc: