rspec-parameterized-core 1.0.0.beta1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8154f0d17983d93033899679942929337ebc2fbfffea858f1d6d9696dfb24fd
-  data.tar.gz: e4d2f7c5632141c43855df2a9010f44dd157adc963bf5def65ac98517447a81c
+  metadata.gz: bcd48d2b87de4ab47865a511551e78b1fb33bd5b4da4ebc25fce4950e3232558
+  data.tar.gz: 17ad0d1379f447197b946f943dc652ac32057ea6102169c5140f4b923cf6176c
 SHA512:
-  metadata.gz: ff1e240ac4458d5dfe73d7b3a2f6573a4a0f06aeedc6abab0f4c0389769b7b71a210e93a5fbb8d8bfbc2f6510dcd4cd740abfae03be983920f656aafcdb1741f
-  data.tar.gz: d02178da387a6471bd261770a3724e0158eeae210fff51b4b1fe44093d892e3700112d765a94711299974d9156fb5eb0e46aa5969f833030c831e96f75941c9c
+  metadata.gz: aa5444577be8a967b158b71a1dfb15cdb2af3b90b4b2b1cac79af5217960e319a31fec27b771b69d9a0f03660d31f787e8bb79b947753b8c63e79773cf8a97b9
+  data.tar.gz: 43807fad9790a182c1ed242a8896617b529bb70333ae8cf06ba1a798b605554a20fcdefb3fd4a2ef3c94742a1bd8b833b703987f2b580454848d84900ed16dd0

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-12-31
-
-- Initial release
+## [1.0.0] - 2022-12-31
+- https://github.com/tomykaira/rspec-parameterized/blob/master/CHANGELOG.md#v100-2022-12-31
+- Drop support Ruby < 2.6 (explicitly)

data/Gemfile

@@ -4,9 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in rspec-parameterized-core.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"

data/README.md

@@ -1,24 +1,179 @@
 # Rspec::Parameterized::Core
+`rspec-parameterized-core` provides parameterized test syntax in [rspec](https://rspec.info/).
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/parameterized/core`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/rspec-parameterized-core.svg)](https://badge.fury.io/rb/rspec-parameterized-core)
+[![RSpec](https://github.com/rspec-parameterized/rspec-parameterized-core/actions/workflows/rspec.yml/badge.svg)](https://github.com/rspec-parameterized/rspec-parameterized-core/actions/workflows/rspec.yml)
 
 ## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+# Install all components
+group :test do
+  gem "rspec-parameterized", ">= 1.0.0"
+end
+
+# Install only rspec-parameterized-core
+group :test do
+  gem "rspec-parameterized-core", ">= 1.0.0"
+end
+```
 
 ## Usage
-
-TODO: Write usage instructions here
+### Nested Array Style
+```ruby
+describe "plus" do
+  where(:a, :b, :answer) do
+    [
+      [1 , 2 , 3],
+      [5 , 8 , 13],
+      [0 , 0 , 0]
+    ]
+  end
+  with_them do
+    it "should do additions" do
+      expect(a + b).to eq answer
+    end
+  end
+  with_them do
+    # Can browse parameters via `params` method in with_them block
+    # Can browse all parameters via `all_params` method in with_them block
+    it "#{params[:a]} + #{params[:b]} == #{params[:answer]}" do
+      expect(a + b).to eq answer
+    end
+  end
+end
+```
+
+### Hash and Array Style
+```ruby
+# Given parameters is each value combinations
+# On this case
+# [
+#   [1, 5, 2],
+#   [1, 5, 4],
+#   [1, 7, 2],
+#   [1, 7, 4],
+#   [1, 9, 2],
+#   [1, 9, 4],
+#   [3, 5, 2],
+#   [3, 5, 4],
+#   [3, 7, 2],
+#   [3, 7, 4],
+#   [3, 9, 2],
+#   [3, 9, 4]
+# ]
+describe "Hash arguments" do
+  where(a: [1, 3], b: [5, 7, 9], c: [2, 4])
+  with_them do
+    it "sums is even" do
+      expect(a + b + c).to be_even
+    end
+  end
+end
+```
+
+### Verbose Syntax
+```ruby
+# 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
+```
+
+### Custom names
+```ruby
+# 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
+```
+
+### lazy and ref types
+```ruby
+# 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).
 
 ## Development
 
@@ -28,7 +183,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-parameterized-core.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rspec-parameterized/rspec-parameterized-core.
 
 ## License
 

data/lib/rspec/parameterized/core/version.rb

@@ -3,7 +3,7 @@
 module Rspec
   module Parameterized
     module Core
-      VERSION = "1.0.0.beta1"
+      VERSION = "1.0.0"
     end
   end
 end

data/rspec-parameterized-core.gemspec

@@ -19,6 +19,7 @@ I was inspired by [udzura's mock](https://gist.github.com/1881139).}
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-parameterized-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0
 platform: ruby
 authors:
 - sue445
@@ -119,6 +119,7 @@ metadata:
   homepage_uri: https://github.com/rspec-parameterized/rspec-parameterized-core
   source_code_uri: https://github.com/rspec-parameterized/rspec-parameterized-core
   changelog_uri: https://github.com/rspec-parameterized/rspec-parameterized-core/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -130,9 +131,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.22
 signing_key: