param_test 0.0.1beta → 0.0.1

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Nik Haldimann
+
+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/README.md

@@ -1,4 +1,68 @@
-param-test-ruby
-===============
+param_test
+==========
 
-Parametrized unit tests for Ruby/ActiveSupport
+**Parametrized unit tests for Ruby/ActiveSupport**
+
+This gem extends `ActiveSupport::TestCase` with a simple `param_test` class method that generates multiple tests with different parameters from a single code block.
+
+
+## Usage
+
+In unit tests, you'll often want to run a set of the same assertions on multiple inputs. One way to do this is by looping over the inputs, for example:
+
+    class StringTest < ActiveSupport::TestCase
+
+      test "strings are ASCII only" do
+        ["foo", "bar", "baz"].each do |string|
+          # Bad programmer! Don't do this
+          assert string.ascii_only?
+        end
+      end
+
+    end
+
+**Don't do this!** This is almost always a bad idea. If this test fails you won't know at which of the 3 input parameters it failed. A failure will also prevent subsequent inputs from getting tested, masking other failures that you won't discover until later.
+
+`param_test` addresses these problems. The above test should be rewritten like this:
+
+    require 'param_test'
+
+    class StringTest < ActiveSupport::TestCase
+
+      param_test "string %s is ASCII only",
+	  ["foo", "bar", "baz"] do |string|
+	    assert string.ascii_only?
+	  end
+
+    end
+
+This will generate three separate tests, one for each of the three parameters (`"foo"`, `"bar"` and `"baz"`) passed in the second argument. Each test is independent and can fail independently.
+
+The tests will be named after the description template passed as the first argument. Standard Ruby string formatting is used to substitute the parameters into the description. Generally you'll want to just use string substitution with `%s`.
+
+You can have multiple parameters per test:
+
+    param_test "%s is uppercase %s",
+    [["FOO", "foo"], ["BAR", "bar"]] do |expected, param|
+      assert_equal expected, param.upcase
+    end
+
+Each parameter set must have the same number of parameters. The description template must have a corresponding number of substitutions.
+
+### About Test Naming
+
+Ruby's underlying unit test framework requires tests to be defined as methods beginning with `test`, so the description is actually converted to a valid method name. In the last example, the methods generated are `:test_FOO_is_uppercase_foo` and `:test_BAR_is_uppercase_bar`.
+
+If string substitution would create the same method names for two different sets of parameters (this can happen because for example any all-whitespace string converts to the same single underscore), a counting variable will be added to the method name to keep them unique.
+
+For better readability, any `nil` parameters will be string substituted as a `"nil"` string (the default string substitution for `nil` values is the empty string).
+
+
+## Installation
+
+    gem install param_test
+
+
+## License
+
+Distributed under an [MIT license](https://github.com/nikhaldi/param-test-ruby/blob/master/LICENSE.md).

data/param_test.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'param_test'
-  s.version     = '0.0.1beta'
+  s.version     = '0.0.1'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Nik Haldimann']
   s.email       = ['nhaldimann@gmail.com']

data/test/param_test_test.rb

@@ -22,4 +22,13 @@ class ParamTestTest < ActiveSupport::TestCase
   [["FOO", "foo"], ["BAR", "bar"]] do |expected, param|
     assert_equal expected, param.upcase
   end
+
+  # Example from README.md
+  test "strings are ASCII only" do
+    ["foo", "bar", "baz"].each do |string|
+      # Bad programmer! Don't do this
+      assert string.ascii_only?
+    end
+  end
+
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: param_test
 version: !ruby/object:Gem::Version
-  version: 0.0.1beta
-  prerelease: 5
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Nik Haldimann
@@ -52,6 +52,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/active_support/testing/parametrized.rb
@@ -75,9 +76,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24