rutabaga 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a428f0756500bdf33b08768d84ce7ce8fc3aa9c8ee071c99b921d88042b2f89
-  data.tar.gz: 57ad954ce4765e539343405560428fc89bbdb2aa128e4191e3f92a052680ab38
+  metadata.gz: b6a38a9e6277b182b50fc33ded4f92eaec8b3d9b8888112af72e08f287e38e84
+  data.tar.gz: f9cbe896db240cb89be5454991ab06d0d9abf4072046bda5630ea794e018b9be
 SHA512:
-  metadata.gz: 4b30b188a8e070606fac177a662d41cb1ab27ef11fa0294cfd5526fd733f5c81a88552e9ef92a62a28367719cf97e1657a1b29d2e0bb2eb736f7b126e3e20d53
-  data.tar.gz: fddbe585d7eb6b91954f9097b7b4b1dbe791430644df58f9f576390f10aa89acfb5db9bc06a2d880e4908ce907a284344e142a159c190c1775aa9c4d63dcdab4
+  metadata.gz: 2e0aca4cd5ff1afdd6a0e7f800d424dd0a1bb1edd546e849134a8021ed0df47a5cfeb87af8b5243a32eddc4c6da157b01228ec92cc8b43ace0b9ba27ab174ea0
+  data.tar.gz: 5123b99de3be3fc63399b06e71f9baad2065e45bf1bca864cedd8fec50f27c69a8c7c6e879fdd0612bcdf899fdc1a3fb25ff7a69560e1e7c1cabf3609f6991e7

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Development
+
+on:
+  push:
+  pull_request:
+    types: [opened, reopened]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, jruby]
+        gemfile: [Gemfile, Gemfile.turnip3]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: bundle-use-ruby-${{matrix.os}}-${{matrix.ruby}}-${{hashFiles('**/${{matrix.gemfile}}')}}
+        restore-keys: |
+          bundle-use-ruby-${{matrix.os}}-${{matrix.ruby}}-${{hashFiles('**/${{matrix.gemfile}}')}}
+
+    - name: Bundle install...
+      run: |
+        bundle config path vendor/bundle
+        bundle install --gemfile=${{matrix.gemfile}}
+
+    - run: bundle exec rspec spec

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '24 10 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/gempush.yml

@@ -0,0 +1,32 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+    - 'lib/rutabaga/version.rb'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        gem install gem-release
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        git config --global user.email ${{ github.event.pusher.email }}
+        git config --global user.name  ${{ github.event.pusher.name }}
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem release --tag --push
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/project-board.yml

@@ -0,0 +1,17 @@
+name: Automatically add new Issues to Silversmith's GitHub project board
+# https://github.com/orgs/simplybusiness/projects/3
+# New issues in this repository will be added to the board.
+on:
+  issues:
+    types: [ opened, reopened ]
+
+jobs:
+  track_issues:
+    uses: simplybusiness/github-action-reusable-workflows/.github/workflows/project-board.yaml@master
+    with:
+      pr-id: ${{ github.event.issue.node_id }}
+      project-number: 3
+      org: simplybusiness
+      actor: ${{ github.actor }}
+    secrets:
+      github-token: ${{ secrets.SILVERSMITHS_PROJECT_MANAGEMENT }}

data/.github/workflows/rubocop-analysis.yml

@@ -0,0 +1,22 @@
+name: "Rubocop"
+
+on: [push]
+
+jobs:
+  rubocop_job:
+    runs-on: ubuntu-latest
+    name: Code Scanning job run
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Rubocop run
+      uses: arthurnn/code-scanning-rubocop/rubocop-action@master
+
+    - name: Upload Sarif output
+      uses: github/codeql-action/upload-sarif@v1
+      with:
+        sarif_file: rubocop.sarif

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changes
 
+## Version 3.0.2
+
+- Implement auto deploy
+- Remove support for ruby 2.4
+
 ## Version 3.0.1
 
 - Removes legacy compatibility hack which stops `capybara-screenshot` from working.

data/CODEOWNERS

@@ -0,0 +1,4 @@
+# Add your project owners info here
+# More information: https://help.github.com/articles/about-codeowners/
+* @simplybusiness/silversmiths 
+

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rutabaga.gemspec
@@ -6,13 +8,8 @@ gemspec
 platform :ruby do
   gem 'pry-byebug'
   gem 'pry-doc'
-  gem 'pry-stack_explorer'
   gem 'pry-rescue'
+  gem 'pry-stack_explorer'
 end
 
-# Gem a dependency of Capybara, new version of rack 2.0 onwards require ruby 2.2 and above.
-if RUBY_VERSION.to_f < 2.2
-  gem 'rack', '~> 1.6'
-else
-  gem 'rack'
-end
+gem 'rack'

data/README.md

@@ -8,7 +8,7 @@ Rutabaga allows you to invert the control of feature files, so that features are
 
 This means that it is simple to create tests that are described by a class (such as controller tests in rspec-rails).
 
-[![Build Status](https://travis-ci.org/simplybusiness/rutabaga.svg?branch=master)](https://travis-ci.org/simplybusiness/rutabaga)
+[![Build Status](https://github.com/simplybusiness/rutabaga/workflows/.github/workflows/ci.yml/badge.svg)](https://github.com/simplybusiness/rutabaga/actions?query=workflow%3ADevelopment)
 [![Gem Version](https://badge.fury.io/rb/rutabaga.svg)](https://badge.fury.io/rb/rutabaga)
 
 ## Installation
@@ -171,31 +171,9 @@ The goal is to test just the business rule in Rutabaga, and not the login, the h
 
 ## For maintainers
 
-Use `gem-release` to maintain versions https://github.com/svenfuchs/gem-release.
-
-To update the patch version (e.g. 0.0.1 to 0.0.2), after merging the PR to `master` run:
-
-```
-gem bump --tag --release --push
-```
-
-if instead you want to bump the minor version (e.g. 0.0.1 to 0.1.0):
-
-```
-gem bump --version minor --tag --release --push
-```
-
-or major version (e.g. 0.0.1 to 1.0.0):
-
-```
-gem bump --version major --tag --release --push
-```
-
-If you've updated the version already, after merging to `master` run:
-
-```
-gem release --tag --push
-```
+To release a new version of the gem, bump the version in `lib/rutabaga/version.rb`
+using Semantic Versioning and merge to master. This will trigger a new version to
+be deployed.
 
 ## Testing alternate versions
 
@@ -210,4 +188,4 @@ gem 'turnip', '3.1.0'
 
 ## Copyright
 
-Copyright © 2012-2019 Simply Business. See LICENSE for details.
+Copyright © 2012-2020 Simply Business. See LICENSE for details.

data/Rakefile

@@ -1,2 +1,4 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/catalog-info.yaml

@@ -0,0 +1,8 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: rutabaga
+  description: Turnip extension to enable running turnip features from inside spec files, rather than outside.
+spec:
+  type: library
+  lifecycle: production

data/examples/compatibility/compatibility_spec.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'capybara/rspec'
 
-describe "capaybara rails does not overwrite the feature command" do
+describe 'capaybara rails does not overwrite the feature command' do
   feature '../test2.feature' do
-    step "that :first + :second is calculated" do |first, second|
+    step 'that :first + :second is calculated' do |first, second|
       @first = first
       @second = second
     end
 
-    step "my result is :result" do |result|
+    step 'my result is :result' do |result|
       expect(@first.to_i + @second.to_i - 1).to eq(result.to_i)
     end
   end

data/examples/pattern/test_pattern_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe "it prints out the RSpec.configuration.pattern" do
-  it "examples/test2.feature" do
+describe 'it prints out the RSpec.configuration.pattern' do
+  it 'examples/test2.feature' do
     puts "RSpec.configuration.pattern: #{RSpec.configuration.pattern}"
   end
 end

data/examples/spec_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
-    c.syntax = [:should, :expect]
+    c.syntax = %i[should expect]
   end
 end

data/examples/test_feature_example_group_spec.rb

@@ -1,109 +1,109 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe "test feature argument" do
+describe 'test feature argument' do
   feature
 
-  step "that :first + :second is calculated" do |first, second|
+  step 'that :first + :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@first.to_i + @second.to_i).to eq(result.to_i)
   end
 end
 
-feature "feature block" do
-  step "that :first + :second is calculated" do |first, second|
+feature 'feature block' do
+  step 'that :first + :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@first.to_i + @second.to_i).to eq(result.to_i)
   end
 end
 
-describe "feature block inside a describe block" do
+describe 'feature block inside a describe block' do
   feature do
-
-    step "that :first + :second is calculated" do |first, second|
+    step 'that :first + :second is calculated' do |first, second|
       @first = first
       @second = second
     end
 
-    step "my result is :result" do |result|
+    step 'my result is :result' do |result|
       expect(@first.to_i + @second.to_i).to eq(result.to_i)
     end
   end
 end
 
-describe "should find the feature file using the root (and monkey patching the result)" do
-  feature "examples/test2.feature"
+describe 'should find feature file using root (and monkey patch result)' do
+  feature 'examples/test2.feature'
 
-  step "that :first + :second is calculated" do |first, second|
+  step 'that :first + :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@first.to_i + @second.to_i - 1).to eq(result.to_i)
   end
 end
 
-describe "causes a failing test" do
-  feature "examples/test2.feature"
+describe 'causes a failing test' do
+  feature 'examples/test2.feature'
 
-  step "that :first + :second is calculated" do |first, second|
+  step 'that :first + :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@first.to_i + @second.to_i).to eq(result.to_i)
   end
 end
 
 describe "finds a feature file given as parameter to the 'feature' method" do
-  feature "examples/test3.feature"
+  feature 'examples/test3.feature'
 
-  step "that :first * :second is calculated" do |first, second|
+  step 'that :first * :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@first.to_i * @second.to_i).to eq(result.to_i)
   end
 end
 
-describe "finds a feature file with a different name in the same directory" do
-  feature "test3.feature"
+describe 'finds a feature file with a different name in the same directory' do
+  feature 'test3.feature'
 
-  step "that :first * :second is calculated" do |first, second|
+  step 'that :first * :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@first.to_i * @second.to_i).to eq(result.to_i)
   end
 end
 
-describe "backgrounds are properly called" do
-  feature "examples/test_background.feature"
+describe 'backgrounds are properly called' do
+  feature 'examples/test_background.feature'
 
-  step "we add :initial" do |initial|
+  step 'we add :initial' do |_initial|
     @initial = 10
   end
 
-  step "that :first * :second is calculated" do |first, second|
+  step 'that :first * :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@initial.to_i + @first.to_i * @second.to_i).to eq(result.to_i)
   end
-
 end

data/examples/test_spec.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe "should find the feature file using the root (and monkey patching the result)" do
-  feature "examples/test2.feature"
+describe 'should find feature file using root (and monkey patch result)' do
+  feature 'examples/test2.feature'
 
-  step "that :first + :second is calculated" do |first, second|
+  step 'that :first + :second is calculated' do |first, second|
     @first = first
     @second = second
   end
 
-  step "my result is :result" do |result|
+  step 'my result is :result' do |result|
     expect(@first.to_i + @second.to_i - 1).to eq(result.to_i)
   end
-
 end

data/lib/rspec/core/example_group_patch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file needs to be in this folder structure otherwise rspec
 # will not filter it out of the caller chain, and therefore report
 # incorrect file locations for example groups. This especially
@@ -5,10 +7,11 @@
 
 # Monkey patch rspec to block capybara from using feature
 class RSpec::Core::Configuration
-  alias_method :orig_alias_example_group_to, :alias_example_group_to
+  alias orig_alias_example_group_to alias_example_group_to
 
   def alias_example_group_to(new_name, *args)
-    return if [:feature, :xfeature, :ffeature].include?(new_name)
+    return if %i[feature xfeature ffeature].include?(new_name)
+
     orig_alias_example_group_to(new_name, *args)
   end
 end
@@ -16,16 +19,18 @@ end
 # Monkey patch RSpec to add the feature method in example groups
 class RSpec::Core::ExampleGroup
   class << self
-    alias_method :orig_subclass, :subclass
+    alias orig_subclass subclass
 
     def subclass(parent, description, *all_args, &example_group_block)
-      rutabaga = all_args.first.any? { |arg| arg.kind_of?(Hash) && arg[:rutabaga] }
+      rutabaga = all_args.first.any? { |arg| arg.is_a?(Hash) && arg[:rutabaga] }
 
-      self.orig_subclass(parent, description, *all_args, &example_group_block).tap do |describe|
-        Rutabaga::ExampleGroup::Feature.feature(describe, description, all_args.last) if rutabaga
+      orig_subclass(parent, description, *all_args, &example_group_block).tap do |describe|
+        if rutabaga
+          Rutabaga::ExampleGroup::Feature.feature(describe, description, all_args.last)
+        end
       end
     end
   end
 
-  define_example_group_method :feature, :rutabaga => true
+  define_example_group_method :feature, rutabaga: true
 end

data/lib/rutabaga/example_group/feature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'turnip/rspec'
 require 'rspec'
 
@@ -5,7 +7,7 @@ module Rutabaga
   module ExampleGroup
     module Feature
       class << self
-        def feature(example_group_class, description, args)
+        def feature(example_group_class, description, _args)
           Util.require_if_exists 'turnip_helper'
 
           Turnip::RSpec.rutabaga_run(Util.find_feature(description), example_group_class)

data/lib/rutabaga/no_turnip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rutabaga
   NO_TURNIP = true
 end
@@ -12,7 +14,7 @@ module Turnip
     module Loader
       def load(*a, &b)
         if a.first.end_with?('.feature')
-          ::RSpec.warning "Calling features directly has been disabled by rutabaga. To re-enable, do not require rutabaga/no_turnip."
+          ::RSpec.warning 'Calling features directly has been disabled by rutabaga. To re-enable, do not require rutabaga/no_turnip.'
         else
           super
         end
@@ -23,5 +25,5 @@ end
 
 ::RSpec.configure do |c|
   # Blow away rutabaga's pattern if still there
-  c.pattern.gsub!(",features/**/*.feature", "")
+  c.pattern.gsub!(',features/**/*.feature', '')
 end

data/lib/rutabaga/turnip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rutabaga'
 ##
 #
@@ -8,8 +10,8 @@ module Turnip
     module Loader
       def load(*a, &b)
         if a.first.end_with?('.feature')
-          if legal_directories.none? {|d| a.first.end_with? d }
-            ::RSpec.warning "Features can only be called from turnip enable directories. These are configured " \
+          if legal_directories.none? { |d| a.first.end_with? d }
+            ::RSpec.warning 'Features can only be called from turnip enable directories. These are configured ' \
                             "in RSpec.configuration.pattern which is currently '#{::RSpec.configuration.pattern}'"
           else
             require_if_exists 'turnip_helper'
@@ -26,9 +28,9 @@ module Turnip
 
       def legal_directories
         @legal_directories ||= ::RSpec.configuration.pattern.split(',')
-          .select {|p| /\.feature\Z/ =~ p}
-          .map {|d| Dir.glob(File.join(::RSpec.configuration.default_path,d)) }
-          .flatten
+                                      .select { |p| /\.feature\Z/ =~ p }
+                                      .map { |d| Dir.glob(File.join(::RSpec.configuration.default_path, d)) }
+                                      .flatten
       end
     end
   end