├── .github └── workflows │ └── ci.yml ├── .gitignore ├── .rspec ├── Appraisals ├── CODE_OF_CONDUCT.md ├── Gemfile ├── LICENSE.txt ├── README.md ├── Rakefile ├── gemfiles ├── 2.5.gemfile ├── 2.6.gemfile └── 2.7.gemfile ├── lib ├── rspec-parameterized-context.rb ├── rspec_parameterized_context.rb └── rspec_parameterized_context │ └── version.rb ├── rspec-parameterized-context.gemspec └── spec ├── rspec_parameterized_context_spec.rb └── spec_helper.rb /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: run_rspec 2 | 3 | on: pull_request 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-latest 8 | 9 | strategy: 10 | matrix: 11 | ruby: [2.5, 2.6, 2.7, 3.0] 12 | 13 | name: Run rspec on ruby ${{ matrix.ruby }} 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Set up Ruby 18 | uses: ruby/setup-ruby@v1 19 | with: 20 | ruby-version: ${{ matrix.ruby }} 21 | - name: Install dependencies 22 | run: | 23 | bundle install 24 | bundle exec appraisal bundle install 25 | - name: Run rspec 26 | run: bundle exec appraisal rspec 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.bundle/ 2 | /.yardoc 3 | /_yardoc/ 4 | /coverage/ 5 | /doc/ 6 | /pkg/ 7 | /spec/reports/ 8 | /tmp/ 9 | 10 | # rspec failure tracking 11 | .rspec_status 12 | 13 | Gemfile.lock 14 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --format documentation 2 | --color 3 | --require spec_helper 4 | -------------------------------------------------------------------------------- /Appraisals: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | appraise "2.5" do; end 4 | 5 | appraise "2.6" do; end 6 | 7 | appraise "2.7" do; end 8 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at alpaca-tc@alpaca.tc. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [https://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: https://contributor-covenant.org 74 | [version]: https://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Specify your gem's dependencies in rspec-parameterized-context.gemspec 4 | gemspec 5 | 6 | gem "rake", "~> 13.0" 7 | gem "rspec", "~> 3.0" 8 | gem "appraisal", "~> 2.0" 9 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2020 alpaca-tc 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rspec::Parameterized::Context 2 | 3 | Generate interfaces like `RSpec::Parameterized` to support parameterized testing that is evaluated in transaction. 4 | 5 | Support Ruby 2.5 and later. 6 | 7 | ## Installation 8 | 9 | Add this line to your application's Gemfile: 10 | 11 | ```ruby 12 | gem 'rspec-parameterized-context' 13 | ``` 14 | 15 | Then add this lines to files under `spec/support/` 16 | 17 | ```ruby 18 | RSpec.configure do |config| 19 | config.extend RSpecParameterizedContext 20 | end 21 | ``` 22 | 23 | ## Usage 24 | 25 | ### Syntax 26 | 27 | Provide interfaces like `RSpec::Parameterized`. 28 | 29 | Pass `where` and `with_them` to `parameterized` method as one block and specify parameterized count as `size` keyword argument. 30 | 31 | ```ruby 32 | describe "Addition" do 33 | parameterized do 34 | where(:a, :b, :answer, size: 3) do 35 | [ 36 | [1 , 2 , 3], 37 | [5 , 8 , 13], 38 | [0 , 0 , 0] 39 | ] 40 | end 41 | 42 | with_them do 43 | it do 44 | expect(a + b).to eq answer 45 | end 46 | end 47 | end 48 | end 49 | ``` 50 | 51 | ### Feature 52 | 53 | - rspec-parameterized-context supports to evaluate block that given where method in transaction. 54 | 55 | ```ruby 56 | # Assume today is 2020/9/9 57 | describe 'Evaluting block that given to where in transaction' do 58 | let(:now) { Date.new(2020, 1, 1) } 59 | # And travel to 2020/1/1 60 | before { travel_to(now) } 61 | 62 | parameterized do 63 | where(:current_on, size: 1) do 64 | [ 65 | [Date.current], 66 | ] 67 | end 68 | 69 | with_them do 70 | it do 71 | # current_on is evaluated as 2020/1/1 72 | expect(current_on).to eq now 73 | end 74 | end 75 | end 76 | end 77 | ``` 78 | 79 | - You can run specific context by focus_index parameter 80 | 81 | ```ruby 82 | describe "Addition" do 83 | parameterized do 84 | where(:a, :b, :answer, size: 3, focus_index: 1) do 85 | [ 86 | [1 , 2 , 3], 87 | [5 , 8 , 13], # will run only this context 88 | [0 , 0 , 0] 89 | ] 90 | end 91 | 92 | with_them do 93 | it do 94 | expect(a + b).to eq answer 95 | end 96 | end 97 | end 98 | end 99 | ``` 100 | 101 | ## Contributing 102 | 103 | - Fork the project. 104 | - Create feature branch. 105 | - Commit and push. 106 | - Make sure to add tests for it. 107 | - Create pull request. 108 | 109 | ## License 110 | 111 | The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). 112 | 113 | ## Code of Conduct 114 | 115 | Everyone interacting in the Rspec::Parameterized::Context project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec-parameterized-context/blob/master/CODE_OF_CONDUCT.md). 116 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | require "rspec/core/rake_task" 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | 6 | task :default => :spec 7 | -------------------------------------------------------------------------------- /gemfiles/2.5.gemfile: -------------------------------------------------------------------------------- 1 | # This file was generated by Appraisal 2 | 3 | source "https://rubygems.org" 4 | 5 | gem "rake", "~> 13.0" 6 | gem "rspec", "~> 3.0" 7 | gem "appraisal", "~> 2.0" 8 | 9 | gemspec path: "../" 10 | -------------------------------------------------------------------------------- /gemfiles/2.6.gemfile: -------------------------------------------------------------------------------- 1 | # This file was generated by Appraisal 2 | 3 | source "https://rubygems.org" 4 | 5 | gem "rake", "~> 13.0" 6 | gem "rspec", "~> 3.0" 7 | gem "appraisal", "~> 2.0" 8 | 9 | gemspec path: "../" 10 | -------------------------------------------------------------------------------- /gemfiles/2.7.gemfile: -------------------------------------------------------------------------------- 1 | # This file was generated by Appraisal 2 | 3 | source "https://rubygems.org" 4 | 5 | gem "rake", "~> 13.0" 6 | gem "rspec", "~> 3.0" 7 | gem "appraisal", "~> 2.0" 8 | 9 | gemspec path: "../" 10 | -------------------------------------------------------------------------------- /lib/rspec-parameterized-context.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'rspec_parameterized_context' 4 | -------------------------------------------------------------------------------- /lib/rspec_parameterized_context.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module RSpecParameterizedContext 4 | class Context 5 | def initialize(rspec_context) 6 | @rspec_context = rspec_context 7 | @where_names = [] 8 | @where_block = nil 9 | @where_size = nil 10 | 11 | @with_them_block = nil 12 | end 13 | 14 | def where(*names, size:, focus_index: nil, &block) 15 | @where_names = names 16 | @where_size = size 17 | @where_focus_index = focus_index 18 | @where_block = block 19 | end 20 | 21 | def with_them(&block) 22 | @with_them_block = block 23 | end 24 | 25 | def define_spec 26 | raise '.where is not called' unless @where_block.respond_to?(:call) 27 | raise '.with_them is not called' unless @with_them_block.respond_to?(:call) 28 | 29 | where_block = @where_block 30 | where_names = @where_names 31 | where_size = @where_size 32 | where_focus_index = @where_focus_index 33 | with_them_block = @with_them_block 34 | 35 | where_size.times do |index| 36 | next if where_focus_index && index != where_focus_index 37 | 38 | @rspec_context.context("parameterized phase ##{index}") do 39 | let(:_parameters) do 40 | instance_exec(&where_block) 41 | end 42 | 43 | before do 44 | raise "expected where(..., size: #{_parameters.size})" unless _parameters.size == where_size 45 | end 46 | 47 | where_names.each_with_index do |name, parameter_index| 48 | let(name) do 49 | _parameters[index][parameter_index] 50 | end 51 | end 52 | 53 | instance_exec(&with_them_block) 54 | end 55 | end 56 | end 57 | 58 | def method_missing(action, *args, &block) 59 | if @rspec_context.respond_to?(action) 60 | @rspec_context.public_send(action, *args, &block) 61 | else 62 | super 63 | end 64 | end 65 | 66 | ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true) 67 | 68 | def respond_to_missing?(action, include_private) 69 | @rspec_context.respond_to?(action, include_private) || super 70 | end 71 | end 72 | 73 | def parameterized(&block) 74 | parameterized_context = RSpecParameterizedContext::Context.new(self) 75 | parameterized_context.instance_exec(&block) 76 | parameterized_context.define_spec 77 | end 78 | end 79 | -------------------------------------------------------------------------------- /lib/rspec_parameterized_context/version.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module RspecParameterizedContext 4 | VERSION = '0.1.0' 5 | end 6 | -------------------------------------------------------------------------------- /rspec-parameterized-context.gemspec: -------------------------------------------------------------------------------- 1 | require_relative 'lib/rspec_parameterized_context/version' 2 | 3 | Gem::Specification.new do |spec| 4 | spec.name = "rspec-parameterized-context" 5 | spec.version = RspecParameterizedContext::VERSION 6 | spec.authors = ["alpaca-tc", "kamillle"] 7 | spec.email = ["alpaca-tc@alpaca.tc", "yuji.kmjm@gmail.com"] 8 | 9 | spec.summary = %q{} 10 | spec.description = %q{} 11 | spec.homepage = "https://github.com/alpaca-tc/rspec-parameterized-context" 12 | spec.license = "MIT" 13 | spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0") 14 | 15 | spec.metadata["homepage_uri"] = spec.homepage 16 | 17 | # Specify which files should be added to the gem when it is released. 18 | # The `git ls-files -z` loads the files in the RubyGem that have been added into git. 19 | spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do 20 | `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } 21 | end 22 | 23 | spec.require_paths = ["lib"] 24 | end 25 | -------------------------------------------------------------------------------- /spec/rspec_parameterized_context_spec.rb: -------------------------------------------------------------------------------- 1 | RSpec.describe RspecParameterizedContext do 2 | describe 'InstanceMethods' do 3 | describe '#parameterized' do 4 | extend RSpecParameterizedContext 5 | 6 | context 'basic' do 7 | parameterized do 8 | where(:a, :b, :expected, size: 1) do 9 | [ 10 | [1, 2, 3] 11 | ] 12 | end 13 | 14 | with_them do 15 | it { expect(a + b).to eq(expected) } 16 | end 17 | end 18 | end 19 | 20 | context 'subject/let/context' do 21 | parameterized do 22 | subject do 23 | expected 24 | end 25 | 26 | let(:a) do 27 | 'a' 28 | end 29 | 30 | where(:expected, size: 1) do 31 | [ 32 | [a] 33 | ] 34 | end 35 | 36 | with_them do 37 | it { expect(expected).to eq(expected) } 38 | 39 | context 'with context' do 40 | let(:a) do 41 | 'b' 42 | end 43 | 44 | it { is_expected.to eq(a) } 45 | end 46 | end 47 | end 48 | end 49 | end 50 | end 51 | end 52 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | require "bundler/setup" 2 | require "rspec_parameterized_context" 3 | 4 | RSpec.configure do |config| 5 | # Enable flags like --only-failures and --next-failure 6 | config.example_status_persistence_file_path = ".rspec_status" 7 | 8 | # Disable RSpec exposing methods globally on `Module` and `main` 9 | config.disable_monkey_patching! 10 | 11 | config.expect_with :rspec do |c| 12 | c.syntax = :expect 13 | end 14 | end 15 | --------------------------------------------------------------------------------