paramesan 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ec829da8c0a763523519359e2759713f8ca3e3f
-  data.tar.gz: c56c3ef7d36f622257e685b20e08de3920cc9fbb
+SHA256:
+  metadata.gz: 033f2032789102c66626b25bb5f67222b067025ee299f6f98c55cf1a12073f4c
+  data.tar.gz: 31f2ca4d45936102ce65f0ee077477490d5028680888511a9c96c18c673cceb3
 SHA512:
-  metadata.gz: cb0308e57a4659cc8939a28d6143fe87829594e3729ba17cbce7ce5c17e6fcb47c5c7c10130ea5c12e07a8cc215cd6c4943d4d0a10091977f51c04d3918c302b
-  data.tar.gz: adea8068805d95b7c483102ec1baea0b2f3c778095b49053082ef6125cd08ccebd39bd2fa484198ef2c9b9b85c21800122ae8ef6b603ec1ccd4976f3b5f5743c
+  metadata.gz: e2393e003a09d0d6a87e3ba5136556df1368c6ef5d3f90ee22743ae2c251ead83a43bbf26ed7d800aab58d0fd50ee274ba0e3f43c75acd9c7d4f96bb1aab13a3
+  data.tar.gz: ce0378ef1aff1c84fec8f0c4eae63f17d9dd86233a2893e25820a9545831bc2c17b4676f7c6244aa41c1c3c8458c6bedda41f5412f2b75e663fd8dda696fbc24

data/README.md

@@ -13,53 +13,87 @@ unit tests, which initially focused on the behavior (the process or code), then
 and output as data that go through the process.
 
 I looked for the equivalent in Ruby, and the closest that I found was
-[param_test](https://www.ruby-toolbox.com/projects/param_test). That, however, uses activesupport,
-which is included in Rails, but I wanted a version that ran in a pure Ruby environment, using only
-Test::Unit.
+[param_test](https://www.ruby-toolbox.com/projects/param_test). That uses activesupport, which is
+included in Rails, but I wanted a version that ran in a pure Ruby environment, using only the
+test-unit gem. I prefer that over Minitest, mainly because the latter uses notifications that don't
+work especially well with Emacs.
 
-Ergo, paramesan, which as of this writing, allows a very primitive set of options for parameterized
-tests.
+Ergo, Paramesan, which as of this writing, supports a set of options for parameterized tests.
 
 # Example
 
 ## Before
 
+58 lines.
+
 ```ruby
 require 'pvn/log/options'
 require 'test/unit'
 
 class FormatOptionTest < Test::Unit::TestCase
-  def assert_formatter expected, *types
-    types.each do |type|
-      fmtr = Pvn::Log::FormatOption.new type
-      assert_kind_of expected, fmtr.formatter, "type: #{type}"
-    end
+  def assert_formatter expected, type
+    fmtr = Pvn2::Log::FormatOption.new type
+    assert_kind_of expected, fmtr.formatter, "type: #{type}"
   end
   
-  def test_oneline
-    assert_formatter Pvn::Log::FormatOneLine, "single", "single-line", "si", "oneline"
+  def test_oneline_single
+    assert_formatter Pvn2::Log::FormatOneLine, "single"
+  end
+
+  def test_oneline_si
+    assert_formatter Pvn2::Log::FormatOneLine, "si"
+  end
+
+  def test_oneline_oneline
+    assert_formatter Pvn2::Log::FormatOneLine, "oneline"
+  end
+
+  def test_summary_summary
+    assert_formatter Pvn2::Log::FormatSummary, "summary"
   end
 
-  def test_summary
-    assert_formatter Pvn::Log::FormatSummary, "summary", "su"
+  def test_summary_su
+    assert_formatter Pvn2::Log::FormatSummary, "su"
   end
 
-  def test_revision_only
-    assert_formatter Pvn::Log::FormatRevisionOnly, "revision", "rev", "revisiononly"
+  def test_revision_revision
+    assert_formatter Pvn2::Log::FormatRevision, "revision"
   end
 
-  def test_revision_author
-    assert_formatter Pvn::Log::FormatRevisionAuthor, "revauthor", "revauth", "revisionauthor"
+  def test_revision_author_revauthor
+    assert_formatter Pvn2::Log::FormatRevisionAuthor, "revauthor"
   end
 
-  def test_colorized
-    assert_formatter Pvn::Log::FormatColorized, "color", "colorized"
+  def test_revision_author_revauth
+    assert_formatter Pvn2::Log::FormatRevisionAuthor, "revauth"
+  end
+
+  def test_revision_author_revisionauthor
+    assert_formatter Pvn2::Log::FormatRevisionAuthor, "revisionauthor"
+  end
+
+  def test_colorized_color
+    assert_formatter Pvn2::Log::FormatColorized, "color"
+  end
+
+  def test_colorized_colorized
+    assert_formatter Pvn2::Log::FormatColorized, "colorized"
+  end
+
+  def test_tree_tree
+    assert_formatter Pvn2::Log::FormatTree, "tree"
+  end
+    
+  def test_tree_zzz
+    assert_formatter Pvn2::Log::FormatTree, "zzz"
   end
 end
 ```
 
 ## After
 
+17 lines.
+
 ```ruby
 require 'pvn/log/options'
 require 'test/unit'
@@ -67,19 +101,89 @@ require 'paramesan'
 
 class FormatOptionTest < Test::Unit::TestCase
   extend Paramesan
-  
+
   param_test [
-    [ Pvn::Log::FormatOneLine,        "single", "single-line", "si", "oneline" ],
-    [ Pvn::Log::FormatSummary,        "summary", "su" ],
-    [ Pvn::Log::FormatRevisionOnly,   "revision", "rev", "revisiononly" ],
-    [ Pvn::Log::FormatRevisionAuthor, "revauthor", "revauth", "revisionauthor" ],
-    [ Pvn::Log::FormatColorized,      "color", "colorized" ],
+    [ Pvn2::Log::FormatOneLine,        "oneline", "single", "si" ],
+    [ Pvn2::Log::FormatSummary,        "summary", "sum" ],
+    [ Pvn2::Log::FormatRevision,       "revision" ],
+    [ Pvn2::Log::FormatRevisionAuthor, "revisionauthor", "revauthor", "revauth" ],
+    [ Pvn2::Log::FormatColorized,      "colorized", "color", "full" ],
+    [ Pvn2::Log::FormatMessage,        "message" ],
+    [ Pvn2::Log::FormatTree,           "tree", "zzz" ],
   ] do |exp, *types|
-    fmts = Pvn::Log::Formats.new
+    types.each do |type|
+      assert_kind_of exp, Pvn2::Log::FormatOption.new(type).formatter, "type: #{type}"
+    end
+  end
+end
+```
+
+The Paramesan code generates a test method for each parameter set, as for example, with the last
+test case, which fails:
+
+```text
+Error: test__Pvn2_Log_FormatTree_tree_zzz_(FormatsTest): RuntimeError: invalid format zzz not one of: author colorized full message oneline revauthor revision revisionauthor single summary tree
+/opt/proj/pvn2/lib/pvn2/log/formats.rb:46:in `class_for'
+/opt/proj/pvn2/lib/pvn2/log/options.rb:19:in `initialize'
+/opt/proj/pvn2/test/pvn2/log/formats_test.rb:134:in `new'
+/opt/proj/pvn2/test/pvn2/log/formats_test.rb:134:in `block (2 levels) in <class:FormatsTest>'
+/opt/proj/pvn2/test/pvn2/log/formats_test.rb:133:in `each'
+/opt/proj/pvn2/test/pvn2/log/formats_test.rb:133:in `block in <class:FormatsTest>'
+/home/jpace/.rvm/gems/ruby-2.3.0/gems/paramesan-0.1.1/lib/paramesan.rb:19:in `instance_exec'
+/home/jpace/.rvm/gems/ruby-2.3.0/gems/paramesan-0.1.1/lib/paramesan.rb:19:in `block (2 levels) in param_test'
+```
+
+# Common Parameters
+
+Sometimes the same set of parameters is used in multiple tests. To do that with Paramesan, simply
+define a class method returning those parameters, and adjust the param_test blocks:
+
+```ruby
+class FormatsTest < Test::Unit::TestCase
+  include Paramesan
+
+  def self.build_class_types_params
+    [
+      [ Pvn2::Log::FormatOneLine,        "oneline", "single", "si" ],
+      [ Pvn2::Log::FormatSummary,        "summary", "sum" ],
+      [ Pvn2::Log::FormatRevision,       "revision" ],
+      [ Pvn2::Log::FormatRevisionAuthor, "revisionauthor", "revauthor", "revauth" ],
+      [ Pvn2::Log::FormatColorized,      "colorized", "color", "full" ],
+      [ Pvn2::Log::FormatMessage,        "message" ],
+      [ Pvn2::Log::FormatTree,           "tree", "zzz" ],
+    ]
+  end
+  
+  param_test build_class_types_params do |exp, *types|
+    fmts = Pvn2::Log::Formats.new
     types.each do |type|
       assert_equal exp, fmts.class_for(type), "type: #{type}"
     end
   end
+
+  param_test build_class_types_params do |exp, *types|
+    types.each do |type|
+      assert_kind_of exp, Pvn2::Log::FormatOption.new(type).formatter, "type: #{type}"
+    end
+  end
+end
+```
+
+# Non Arrays
+
+The set of parameters does not have to consist of arrays. For example, using strings:
+
+```ruby
+class FormatsTest < Test::Unit::TestCase
+  include Paramesan
+
+  param_test %w{ abc def } do |str|
+    fmts = Pvn2::Log::Formats.new
+    expfmts = "author colorized full message oneline revauthor revision revisionauthor single summary tree"
+    assert_raise(RuntimeError.new "invalid format #{str} not one of: #{expfmts}") do
+      fmts.class_for str
+    end
+  end
 end
 ```
 

data/lib/paramesan.rb

@@ -4,22 +4,40 @@
 require "paramesan/version"
 
 module Paramesan
-  def param_test paramlist, &blk
-    puts "self: #{self}"
-    
-    paramlist.each do |params|
-      basename = "test_" + params.to_s.gsub(Regexp.new('[^\w]+'), '_')
-      mname = basename
+  module ClassMethods
+    def param_test paramlist, &blk
+      count = paramlist.count
+      paramlist.each_with_index do |params, idx|
+        name = param_test_name params, idx, count
 
-      count = 1
-      while instance_methods.include? mname.to_sym
-        mname += "_#{count}"
+        mname = name.to_sym
+        i = 0
+        while instance_methods.include? mname.to_sym
+          i += 1
+          mname = name + "_#{i}"
+        end
+
+        define_method mname do
+          instance_exec(params, &blk)
+        end
       end
+    end
 
-      define_method mname do
-        instance_exec(params, &blk)
-        puts
+    def param_test_name params, idx, count
+      name = "test_" + idx.to_s + "_of_" + count.to_s + "__"
+      if params.kind_of?(Enumerable)
+        nonword = Regexp.new '[^\w]+'
+        elements = params.collect { |param| param.to_s.gsub nonword, '_' }
+        name << elements.join('_')
+      else
+        name << params.to_s
       end
     end
   end
+
+  extend ClassMethods
+
+  def self.included other
+    other.extend ClassMethods
+  end
 end

data/lib/paramesan/version.rb

@@ -4,5 +4,5 @@
 require 'pathname'
 
 module Paramesan
-  VERSION = "0.0.1"
+  VERSION = "1.0.1"
 end

data/paramesan.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", ">= 13.0"
   spec.add_development_dependency "test-unit", "~> 3.1.5"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: paramesan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Jeff Pace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2020-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -90,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Parameterized tests