rspec-parameterized 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b9bb7c728e9be30cccd124ebbd51d43efbcb0ea9
-  data.tar.gz: 8a08fa1727c563a958827988c74fd3549493c7d2
+SHA256:
+  metadata.gz: 13272c9240c96a67c05aac16ced725a1ca74f7983a7b4efdda6ba64d377fddaf
+  data.tar.gz: 5a7c41cb7738620b94d789b4db10f8954e139886a2c3c3ea683d807d68d1b89f
 SHA512:
-  metadata.gz: 69ce4c22c994ffb04ba2a843a55fa1072445f0641de800d36ad46624c056d2c47c4df5df43e3e2a54f7d6ace0b616443ef0b85c6360a950e60dd82768bf7e9f9
-  data.tar.gz: 05237e124b01dd4c2c75e28f93d7db359442e451bc08efecd231ad4bd3f37f1dc2ac188fc21a2a9e93bdbd30dfe96c81ac76362ff5db757fcdfa861d55cafa3c
+  metadata.gz: a3b193a8ae72948274d5f2e3723d99ca84c75150ffb0ebce618afcab90f04159ea995c7331a528c77764c9844bbec0a5c4d0c1a507c7d1b220359fd62e6e6877
+  data.tar.gz: 22bedbee2bbddbf8a5874b591ca0d66ad05671caeb9df8af8a7a2769fe019cee1b188a42d2af7ca64d60ff03815276f74e0fde9237657e7cc8fe27aac0393d8c

data/.travis.yml

@@ -1,15 +1,20 @@
 language: ruby
 cache: bundler
-sudo: false
 rvm:
-  - 2.2
-  - 2.3.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - ruby-head
+  - jruby-9.2.8.0
 
 gemfile:
-  - gemfiles/rspec2.gemfile
-  - gemfiles/rspec3.3.gemfile
   - gemfiles/rspec3.4.gemfile
+  - gemfiles/rspec-head.gemfile
+
+before_install:
+  - travis_retry gem update --system || travis_retry gem update --system 2.7.8
+  - travis_retry gem install bundler --no-document || travis_retry gem install bundler --no-document -v 1.17.3
 
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,4 +1,51 @@
 # Change Log
+## Unreleased
+[Full Changelog](https://github.com/tomykaira/rspec-parameterized/compare/v0.4.2...master)
+
+## [v0.4.2](https://github.com/tomykaira/rspec-parameterized/tree/v0.4.2) (2019-04-26)
+[Full Changelog](https://github.com/tomykaira/rspec-parameterized/compare/v0.4.1...v0.4.2)
+
+- Support jruby
+  - https://github.com/tomykaira/rspec-parameterized/pull/54
+  - https://github.com/tomykaira/rspec-parameterized/issues/49
+
+## [v0.4.1](https://github.com/tomykaira/rspec-parameterized/tree/v0.4.1) (2018-12-06)
+[Full Changelog](https://github.com/tomykaira/rspec-parameterized/compare/v0.4.0...v0.4.1)
+
+- Replace binding_of_caller with binding_ninja
+  - https://github.com/tomykaira/rspec-parameterized/pull/44
+  - https://github.com/tomykaira/rspec-parameterized/issues/48
+
+## [v0.4.0](https://github.com/tomykaira/rspec-parameterized/tree/v0.4.0) (2017-06-13)
+[Full Changelog](https://github.com/tomykaira/rspec-parameterized/compare/v0.3.2...v0.4.0)
+
+**Merged pull requests:**
+
+- Verbose test syntax [\#42](https://github.com/tomykaira/rspec-parameterized/pull/42) ([aliaksandr-martsinovich](https://github.com/aliaksandr-martsinovich))
+- Customizable description [\#41](https://github.com/tomykaira/rspec-parameterized/pull/41) ([aliaksandr-martsinovich](https://github.com/aliaksandr-martsinovich))
+
+## [v0.3.2](https://github.com/tomykaira/rspec-parameterized/tree/v0.3.2) (2016-12-26)
+[Full Changelog](https://github.com/tomykaira/rspec-parameterized/compare/v0.3.1...v0.3.2)
+
+**Merged pull requests:**
+
+- Fix deprecation warning on ruby 2.4.0 [\#40](https://github.com/tomykaira/rspec-parameterized/pull/40) ([sue445](https://github.com/sue445))
+- Add release note for v0.3.1 [\#39](https://github.com/tomykaira/rspec-parameterized/pull/39) ([sue445](https://github.com/sue445))
+- Add rubygems version badge [\#38](https://github.com/tomykaira/rspec-parameterized/pull/38) ([sue445](https://github.com/sue445))
+
+## [v0.3.1](https://github.com/tomykaira/rspec-parameterized/tree/v0.3.1) (2016-08-17)
+[Full Changelog](https://github.com/tomykaira/rspec-parameterized/compare/v0.3.0...v0.3.1)
+
+**Closed issues:**
+
+- Support "||" syntax [\#34](https://github.com/tomykaira/rspec-parameterized/issues/34)
+
+**Merged pull requests:**
+
+- Set the caller of `.with\_them` to metadata of ExampleGroup [\#37](https://github.com/tomykaira/rspec-parameterized/pull/37) ([nalabjp](https://github.com/nalabjp))
+- Add homepage url in gemspec [\#33](https://github.com/tomykaira/rspec-parameterized/pull/33) ([sue445](https://github.com/sue445))
+- Tweak travis setting [\#32](https://github.com/tomykaira/rspec-parameterized/pull/32) ([sue445](https://github.com/sue445))
+- Generate CHANGELOG [\#31](https://github.com/tomykaira/rspec-parameterized/pull/31) ([sue445](https://github.com/sue445))
 
 ## [v0.3.0](https://github.com/tomykaira/rspec-parameterized/tree/v0.3.0) (2016-02-22)
 [Full Changelog](https://github.com/tomykaira/rspec-parameterized/compare/v0.2.0...v0.3.0)

data/README.md

@@ -1,4 +1,4 @@
-# RSpec::Parameterized [![Build Status](https://travis-ci.org/tomykaira/rspec-parameterized.svg)](https://travis-ci.org/tomykaira/rspec-parameterized)
+# RSpec::Parameterized [![Gem Version](https://badge.fury.io/rb/rspec-parameterized.svg)](https://badge.fury.io/rb/rspec-parameterized) [![Build Status](https://travis-ci.org/tomykaira/rspec-parameterized.svg)](https://travis-ci.org/tomykaira/rspec-parameterized)
 
 Support simple parameterized test syntax in rspec.
 
@@ -72,6 +72,107 @@ describe "plus" do
     end
   end
 end
+
+# Verbose Syntax
+# For complex inputs or if you just want to be super explicit
+describe "Verbose syntax" do
+  where do
+    {
+      "positive integers" => {
+        a: 1,
+        b: 2,
+        answer: 3,
+      },
+      "negative_integers" => {
+        a: -1,
+        b: -2,
+        answer: -3,
+      },
+      "mixed_integers" => {
+        a: 3,
+        b: -3,
+        answer: 0,
+      },
+    }
+  end
+
+  with_them do
+    it "should do additions" do
+      expect(a + b).to eq answer
+    end
+  end
+end
+
+# It's also possible to override each combination name using magic variable :case_name
+# Output:
+# Custom names for regular syntax
+#   positive integers
+#     should do additions
+#   negative integers
+#     should do additions
+#   mixed integers
+#     should do additions
+describe "Custom names for regular syntax" do
+  where(:case_name, :a, :b, :answer) do
+    [
+      ["positive integers",  6,  2,  8],
+      ["negative integers", -1, -2, -3],
+      [   "mixed integers", -5,  3, -2],
+    ]
+  end
+
+  with_them do
+    it "should do additions" do
+      expect(a + b).to eq answer
+    end
+  end
+end
+
+# Or :case_names lambda for hash syntax
+# Output:
+# Custom naming for hash syntax
+#   1 + 5 + 2
+#     sum is even
+#   1 + 5 + 4
+#     sum is even
+#   1 + 7 + 2
+#     sum is even
+#   ...
+describe "Custom naming for hash syntax" do
+  where(case_names: ->(a, b, c){"#{a} + #{b} + #{c}"}, a: [1, 3], b: [5, 7, 9], c: [2, 4])
+
+  with_them do
+    it "sum is even" do
+      expect(a + b + c).to be_even
+    end
+  end
+end
+
+# Use ref(:symbol) to use let/let! defined variables in the where block
+# Use lazy when you want to create let/let! variables after the where block
+#
+# Failures will be more readable in the future - https://github.com/tomykaira/rspec-parameterized/pull/65
+describe "lazy and ref types" do
+  let(:one) { 1 }
+  let(:four) { 4 }
+
+  where(:a, :b, :result) do
+    [
+      [ref(:one), ref(:four), lazy { two + three }]
+    ]
+  end
+
+  with_them do
+    context "use let after where block" do
+      let(:two) { 2 }
+      let(:three) { 3 }
+
+      it 'should equal 5' do
+        expect(a + b).to eq result
+      end
+    end
+  end
+end
 ```
 
 I was inspired by [udzura's mock](https://gist.github.com/1881139).

data/gemfiles/{rspec2.gemfile → rspec-head.gemfile}

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem "rspec", "~> 2.14"
+gem "rspec"
 
 gemspec path: "../"

data/lib/rspec/parameterized.rb

@@ -2,6 +2,7 @@ require "rspec/parameterized/version"
 require 'parser'
 require 'unparser'
 require 'proc_to_ast'
+require 'rspec/parameterized/helper_methods'
 
 module RSpec
   module Parameterized
@@ -40,12 +41,22 @@ module RSpec
       def where(*args, &b)
 
         if args.size == 1 && args[0].instance_of?(Hash)
+          naming_func = args.first.delete(:case_names)
           params = args[0]
           first, *rest = params.values
+          arg_names = params.keys
+          arg_values = first.product(*rest)
 
-          set_parameters(params.keys) {
-            first.product(*rest)
+          if naming_func && naming_func.respond_to?(:call)
+            arg_names << :case_name
+            arg_values.map! { |row| row << naming_func.call(*row) }
+          end
+
+          set_parameters(arg_names) {
+            arg_values
           }
+        elsif args.size == 0
+          set_verbose_parameters(&b)
         else
           set_parameters(args, &b)
         end
@@ -87,6 +98,7 @@ module RSpec
 
       def define_cases(parameter, *args, &block)
         instance = new  # for evaluate let methods.
+        instance.extend HelperMethods
         if defined?(self.superclass::LetDefinitions)
           instance.extend self.superclass::LetDefinitions
         end
@@ -99,10 +111,14 @@ module RSpec
 
         param_sets.each do |param_set|
           pairs = [parameter.arg_names, param_set].transpose.to_h
-          pretty_params = pairs.map {|name, val| "#{name}: #{params_inspect(val)}"}.join(", ")
+          pretty_params = pairs.has_key?(:case_name) ? pairs[:case_name] : pairs.map {|name, val| "#{name}: #{params_inspect(val)}"}.join(", ")
           describe(pretty_params, *args) do
             pairs.each do |name, val|
-              let(name) { val }
+              if HelperMethods.applicable? val
+                let(name) { val.apply(self) }
+              else
+                let(name) { val }
+              end
             end
 
             singleton_class.module_eval do
@@ -135,6 +151,23 @@ module RSpec
           return obj.inspect
         end
       end
+
+      def set_verbose_parameters(&block)
+        arguments_hash = yield
+        arg_names = arguments_hash.values.reduce(Set.new) { |memo, pairs| memo | pairs.keys }.to_a
+        arg_values = []
+        arguments_hash.each do |name, values_hash|
+          row = [name]
+          arg_names.each do |argument_name|
+              row << values_hash[argument_name]
+          end
+          arg_values << row
+        end
+        arg_names.unshift(:case_name)
+        set_parameters(arg_names) {
+          arg_values
+        }
+      end
     end
   end
 

data/lib/rspec/parameterized/arg.rb

@@ -0,0 +1,7 @@
+module RSpec
+  module Parameterized
+    class Arg
+      def apply(obj) ; end
+    end
+  end
+end

data/lib/rspec/parameterized/helper_methods.rb

@@ -0,0 +1,20 @@
+require 'rspec/parameterized/ref_arg'
+require 'rspec/parameterized/lazy_arg'
+module RSpec
+  module Parameterized
+    module HelperMethods
+      def ref(symbol)
+        RefArg.new(symbol)
+      end
+
+      def lazy(&block)
+        LazyArg.new(&block)
+      end
+
+      def self.applicable?(arg)
+        arg.is_a? Arg
+      end
+    end
+  end
+end
+

data/lib/rspec/parameterized/lazy_arg.rb

@@ -0,0 +1,19 @@
+module RSpec
+  module Parameterized
+    class LazyArg < Arg
+      def initialize(&block)
+        @block = block
+      end
+
+      def apply(obj)
+        obj.instance_eval(&@block)
+      end
+
+      def inspect
+        "#{@block.to_raw_source}"
+      rescue Parser::SyntaxError
+        super.inspect
+      end
+    end
+  end
+end

data/lib/rspec/parameterized/ref_arg.rb

@@ -0,0 +1,19 @@
+require 'rspec/parameterized/arg'
+module RSpec
+  module Parameterized
+    class RefArg < Arg
+      def initialize(symbol)
+        @symbol = symbol
+      end
+
+      def apply(obj)
+        obj.send(@symbol)
+      end
+
+      def inspect
+        "#{@symbol}"
+      end
+    end
+  end
+end
+

data/lib/rspec/parameterized/table_syntax.rb

@@ -1,12 +1,13 @@
-require 'binding_of_caller'
 require 'rspec/parameterized/table'
+require 'binding_ninja'
 
 module RSpec
   module Parameterized
     module TableSyntaxImplement
-      def |(other)
-        where_binding = binding.of_caller(1)          # get where block binding
-        caller_instance = eval("self", where_binding) # get caller instance (ExampleGroup)
+      extend BindingNinja
+
+      def |(where_binding, other)
+        caller_instance = where_binding.receiver # get caller instance (ExampleGroup)
 
         if caller_instance.instance_variable_defined?(:@__parameter_table)
           table = caller_instance.instance_variable_get(:@__parameter_table)
@@ -20,6 +21,7 @@ module RSpec
         row.add_param(other)
         table
       end
+      auto_inject_binding :|
     end
 
     module TableSyntax
@@ -27,12 +29,18 @@ module RSpec
         include TableSyntaxImplement
       end
 
-      refine Fixnum do
-        include TableSyntaxImplement
-      end
+      if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create("2.4.0")
+        refine Integer do
+          include TableSyntaxImplement
+        end
+      else
+        refine Fixnum do
+          include TableSyntaxImplement
+        end
 
-      refine Bignum do
-        include TableSyntaxImplement
+        refine Bignum do
+          include TableSyntaxImplement
+        end
       end
 
       refine Array do

data/lib/rspec/parameterized/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Parameterized
-    VERSION = "0.3.1"
+    VERSION = "0.5.0"
   end
 end

data/rspec-parameterized.gemspec

@@ -13,8 +13,8 @@ I was inspired by [udzura's mock](https://gist.github.com/1881139).}
   gem.add_dependency('parser')
   gem.add_dependency('unparser')
   gem.add_dependency('proc_to_ast')
-  gem.add_dependency('binding_of_caller')
-  gem.add_development_dependency('rake')
+  gem.add_dependency('binding_ninja', '>= 0.2.3')
+  gem.add_development_dependency('rake', '>= 12.0.0')
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/parametarized_spec.rb

@@ -66,6 +66,177 @@ describe RSpec::Parameterized do
     end
   end
 
+  describe "Verbose syntax" do
+    where do
+      {
+        "positive integers" => {
+          a: 1,
+          b: 2,
+          answer: 3,
+        },
+        "negative_integers" => {
+          a: -1,
+          b: -2,
+          answer: -3,
+        },
+        "mixed_integers" => {
+          a: 3,
+          b: -3,
+          answer: 0,
+        },
+      }
+    end
+
+    with_them do
+      it "should do additions" do
+        expect(a + b).to eq answer
+      end
+
+      it "should have custom name" do |example|
+        expect(example.metadata[:example_group][:description]).to eq case_name
+      end
+    end
+
+    context "lambda parameter" do
+      where do
+        {
+          "integers" => {
+            a: 1,
+            b: 2,
+            answer: -> {expect(subject).to eq 3},
+          },
+          "strings" => {
+            a: "hello ",
+            b: "world",
+            answer: -> {expect(subject).to include "lo wo"},
+          },
+          "arrays" => {
+            a: [1, 2, 3],
+            b: [4, 5, 6],
+            answer: -> {expect(subject.size).to eq 6}
+          }
+        }
+      end
+
+      with_them do
+        subject {a + b}
+        it "should do additions" do
+          self.instance_exec(&answer)
+        end
+
+        it "should have custom name" do |example|
+          expect(example.metadata[:example_group][:description]).to eq(case_name)
+        end
+      end
+    end
+  end
+
+  describe "Custom test case name" do
+    context "when regular arguments" do
+      where(:case_name, :a, :b, :answer) do
+        [
+          ["positive integers",  6,  2,  8],
+          ["negative integers", -1, -2, -3],
+          [   "mixed integers", -5,  3, -2],
+        ]
+      end
+
+      with_them do
+        it "should do additions" do
+          expect(a + b).to eq answer
+        end
+
+        it "should have custom test name" do |example|
+          expect(example.metadata[:example_group][:description]).to eq case_name
+        end
+      end
+    end
+
+    context "when hash arguments" do
+      where(case_names: ->(a, b, c){"#{a} + #{b} + #{c}"}, a: [1, 3], b: [5, 7, 9], c: [2, 4])
+
+      with_them do
+        it "sum is even" do
+          expect(a + b + c).to be_even
+        end
+
+        it "should have custom names" do |example|
+          expect(example.metadata[:example_group][:description]).to include "+"
+        end
+      end
+    end
+
+    if RUBY_VERSION >= "2,1"
+      context "when arguments are separated with pipe (using TableSyntax)" do
+        using RSpec::Parameterized::TableSyntax
+
+        where(:case_name, :a, :b, :answer) do
+          "integers"      | 1                     | 2                     | 3
+          "strings"       | "hello "              | "world"               | "hello world"
+          "arrays"        | [1, 2, 3]             | [4, 5, 6]             | [1, 2, 3, 4, 5, 6]
+          "giant numbers" | 100000000000000000000 | 100000000000000000000 | 200000000000000000000
+        end
+
+        with_them do
+          it "a plus b is answer" do
+            expect(a + b).to eq answer
+          end
+
+          it "should have custom test name" do |example|
+            expect(example.metadata[:example_group][:description]).to eq case_name
+          end
+        end
+      end
+    end
+
+  end
+
+  describe "ref" do
+    let(:foo) { 1 }
+
+    where(:value, :answer) do
+      [
+        [ref(:foo), 1],
+      ]
+    end
+
+    with_them do
+      it "let variable in same example group can be used" do
+        expect(value).to eq answer
+      end
+
+      context "override let varibale" do
+        let(:foo) { 3 }
+
+        it "can override let variable" do
+          expect(value).to eq 3
+        end
+      end
+    end
+  end
+
+  describe "lazy" do
+    let(:one) { 1 }
+    let(:four) { 4 }
+
+    where(:a, :b, :answer) do
+      [
+        [ref(:one), ref(:four), lazy { two + three }],
+      ]
+    end
+
+    with_them do
+      context "define two and three after where block" do
+        let(:two) { 2 }
+        let(:three) { 3 }
+
+        it "should do additions" do
+          expect(a + b).to eq answer
+        end
+      end
+    end
+  end
+
   if RUBY_VERSION >= "2.1"
     describe "table separated with pipe (using TableSyntax)" do
       using RSpec::Parameterized::TableSyntax
@@ -74,6 +245,7 @@ describe RSpec::Parameterized do
         1         | 2         | 3
         "hello "  | "world"   | "hello world"
         [1, 2, 3] | [4, 5, 6] | [1, 2, 3, 4, 5, 6]
+        100000000000000000000 | 100000000000000000000 | 200000000000000000000
       end
 
       with_them do
@@ -90,6 +262,7 @@ describe RSpec::Parameterized do
         1         | 2         | -> { eq(3) }
         "hello "  | "world"   | -> { eq("hello world") }
         [1, 2, 3] | [4, 5, 6] | -> { be_a(Array) }
+        100000000000000000000 | 100000000000000000000 | -> { eq(200000000000000000000) }
       end
 
       with_them do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-parameterized
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - tomykaira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -73,33 +73,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: binding_of_caller
+  name: binding_ninja
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.0.0
 description: RSpec::Parameterized supports simple parameterized test syntax in rspec.
 email:
 - tomykaira@gmail.com
@@ -115,11 +115,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rspec2.gemfile
-- gemfiles/rspec3.3.gemfile
+- gemfiles/rspec-head.gemfile
 - gemfiles/rspec3.4.gemfile
 - lib/rspec-parameterized.rb
 - lib/rspec/parameterized.rb
+- lib/rspec/parameterized/arg.rb
+- lib/rspec/parameterized/helper_methods.rb
+- lib/rspec/parameterized/lazy_arg.rb
+- lib/rspec/parameterized/ref_arg.rb
 - lib/rspec/parameterized/table.rb
 - lib/rspec/parameterized/table_syntax.rb
 - lib/rspec/parameterized/version.rb
@@ -129,7 +132,7 @@ files:
 homepage: https://github.com/tomykaira/rspec-parameterized
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,9 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: RSpec::Parameterized supports simple parameterized test syntax in rspec.
   I was inspired by [udzura's mock](https://gist.github.com/1881139).

data/gemfiles/rspec3.3.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem "rspec", "~> 3.3.0"
-
-gemspec path: "../"