rspec-side_effects 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d4c1faa5a5a16d11a789cfb49dfc5553888e9dd
-  data.tar.gz: 416e8e2d16b05bb667faf2d78fd61de198a1094e
+SHA256:
+  metadata.gz: 3b6eaea6e9259ab552063672996d2b8f6696ddb674ab85fa736350748757473d
+  data.tar.gz: 126c485c45f8f06625970a7dd6a752502adad56b5d990ae095b2038e7074f6ac
 SHA512:
-  metadata.gz: 8ae7e359642a787e43fdd684f8077ecdbeaa0d6aa15e5ce636cbc8872e2ad00728b8ac73068d9fbbf021d9d7ce9e430d2438fcb78d4a40a7a63c9a3307ec847e
-  data.tar.gz: 6bd7444350e204568d342c97ab0813236a1da58af02e38aee2e554d122ec1b71d5a04657a425479f72e90a185d517871af54195cbf2d5b0259a65b5816820995
+  metadata.gz: c5ebb6d35a7af46857594feb7244ad184697bc1eade98a618a99ed99eaf346195f11786a0e15e39166ccd7c0f0af8bad7c41bb721e852c59d0cfd9ccf3585fa8
+  data.tar.gz: e36946c838159a80aa325346957b0852d2ccf980088ddb401e28d9aeb6f6ae1b78ab0f7056a541e5077584c5cc57bc82eb431e5864ad8d66d22db2a03b847ad0

data/.bundler-audit.yml

@@ -0,0 +1,8 @@
+---
+ignore:
+  - CVE-2024-39908
+  - CVE-2024-41946
+  - CVE-2024-43398
+  - CVE-2024-35176
+  - CVE-2024-41123
+  - CVE-2024-49761

data/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+on:
+  push:
+  schedule:
+      - cron: '0 1 * * 0' # every Sunday at 1am
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [3.1, 3.2, 3.3, 3.4, head, jruby, jruby-head]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || endsWith(matrix.ruby, 'jruby') }}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake spec
+  coverage:
+    needs: [ test ]
+    name: coverage
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - run: bundle exec rake
+      env:
+        CUCUMBER_PUBLISH_TOKEN: ${{ secrets.CUCUMBER_PUBLISH_TOKEN }}
+    - uses: paambaati/codeclimate-action@v9.0.0
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      with:
+        coverageLocations: |
+          ${{ github.workspace }}/coverage/lcov/*.lcov:lcov

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -1,7 +1,24 @@
-require: rubocop-rspec
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
 
 Metrics/MethodLength:
   Max: 20
 
 RSpec/EmptyExampleGroup:
   Enabled: false
+
+# Because of the way that blocks are used in RSpecs can end up being long when
+# example groups are nested or many examples are checked.
+# A similar pattern exists in the DSL for gemspec files.
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -6,7 +6,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## 0.0.1 - 2018-05-02
+## [0.3.0] - 2025-01-09
+### Changed
+- upgrade Rake to v13 to resolve [CVE-2020-8130](https://github.com/advisories/GHSA-jppv-gw3r-w3q8)
+- minimum required Ruby version to 3.1.2, dropping support for 2.x and 3.0
+
+## [0.2.0] - 2018-07-12
+### Changed
+- Rescue Exceptions from the subject in the its_side_effects_are helper, so
+  that it is possible to check the side effects of a method which is expected
+  to raise an error
+
+## [0.1.0] - 2018-05-02
 ### Added
 - Add the its_side_effects_are helper, as well as its aliases it_has_side_effects
-  and specify_side_effects
+  and specify_side_effects.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-side_effects.gemspec

data/README.md

@@ -1,14 +1,14 @@
 # Rspec::SideEffects
 
 [![Gem Version](https://badge.fury.io/rb/rspec-side_effects.svg)](http://badge.fury.io/rb/rspec-side_effects)
-[![Dependency Status](https://gemnasium.com/sugarcrm/rspec-side_effects.svg)](https://gemnasium.com/sugarcrm/rspec-side_effects)
-[![Build Status](https://travis-ci.org/sugarcrm/rspec-side_effects.svg?branch=master)](https://travis-ci.org/sugarcrm/rspec-side_effects)
+[![Build Status](https://github.com/sugarcrm/rspec-side_effects/actions/workflows/ci.yml/badge.svg)](https://github.com/sugarcrm/rspec-side_effects/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/sugarcrm/rspec-side_effects/badges/gpa.svg)](https://codeclimate.com/github/sugarcrm/rspec-side_effects)
 [![Test Coverage](https://codeclimate.com/github/sugarcrm/rspec-side_effects/badges/coverage.svg)](https://codeclimate.com/github/sugarcrm/rspec-side_effects/coverage)
-[![Inline docs](http://inch-ci.org/github/sugarcrm/rspec-side_effects.svg)](http://inch-ci.org/github/sugarcrm/rspec-side_effects)
 [![License](http://img.shields.io/badge/license-Apache2-green.svg?style=flat)](LICENSE)
 
-RSpec extension for check the side effects of your specifications.
+[![RubyDoc](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/rspec-side_effects)
+
+RSpec extension for checking the side effects of your specifications.
 
 ## Installation
 
@@ -32,10 +32,10 @@ This gem is intended to replace explicitly calling the *subject* before checking
 its side effects. It might be used when testing things like:
 * method which works directly with a database
 * method which works directly with a file system
-* method which integrates mocked objects
+* method which only integrates mocked objects
 
 There are several aliases for *it_has_side_effects_are* which can be used to
-communicate different things.
+communicate different things to the reader.
 
 ```
 subject { test_class.test }
@@ -74,16 +74,41 @@ its_side_effects_are do
 end
 ```
 
+Exceptions are also rescued by the helper, so you can still check side effects
+which also expecting an exception to be raised.
+
+```
+subject { test_class.test }
+
+it { expect { subject }.to raise_error(StandardError) }
+its_side_effects_are do
+  # Check what might have happened before the exception.
+  # Or confirm things which should not have happend with an error.
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Elsewhere on the web
+
+Links to other places on the web where this projects exists:
+
+* [Code Climate](https://codeclimate.com/github/sugarcrm/rspec-side_effects)
+* [Github](https://github.com/sugarcrm/rspec-side_effects)
+* [OpenHub](https://www.openhub.net/p/rspec-side_effects)
+* [RubyDoc](https://rubydoc.info/gems/rspec-side_effects)
+* [RubyGems](https://rubygems.org/gems/rspec-side_effects)
+* [Ruby LibHunt](https://ruby.libhunt.com/rspec-side_effects-alternatives)
+* [Ruby Toolbox](https://www.ruby-toolbox.com/projects/rspec-side_effects)
+
 ## Contributing
 
 See [CONTRIBUTING](CONTRIBUTING.md) for how you can contribute changes back into this project.
 
 ## Acknowledgments
 
-Copyright 2018 [SugarCRM Inc.](http://sugarcrm.com), released under the Apache2 License.
+Copyright 2025 [SugarCRM Inc.](http://sugarcrm.com), released under the [Apache2 License](https://www.apache.org/licenses/LICENSE-2.0.html).

data/Rakefile

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'bundler/audit/task'
+require 'yard'
+require 'yardstick/rake/measurement'
 require 'pathname'
+require 'license_finder'
+require 'English'
 
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = '--warnings'
@@ -23,4 +30,32 @@ RuboCop::RakeTask.new(:rubocop) do |task|
     ].push(rubocop_report_pathname.to_s)
 end
 
-task default: %i[spec rubocop]
+Bundler::Audit::Task.new
+
+desc 'Show which specified gems are outdated'
+task 'bundle:outdated' do
+  bundle_outdated_report_pathname =
+    Pathname(Rake.application.original_dir).join('tmp', 'bundle_outdated.txt')
+  bundle_outdated_report_pathname.dirname.mkpath
+
+  # TODO: Should consider re-writing this without using `tee`.
+  sh("bundle outdated --only-explicit | tee #{bundle_outdated_report_pathname}")
+end
+
+desc 'Check dependency licenses'
+task :license_finder do
+  puts `license_finder --quiet --format text`
+
+  abort('LicenseFinder failed') unless $CHILD_STATUS.success?
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files         = ['lib/**/*.rb']
+  t.stats_options = ['--list-undoc']
+end
+
+Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
+  measurement.output = 'tmp/yard_coverage.txt'
+end
+
+task default: %i[spec rubocop yardstick_measure bundle:audit license_finder]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'rspec/side_effects'

data/doc/dependency_decisions.yml

@@ -0,0 +1,25 @@
+---
+- - :ignore_group
+  - development
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: 
+    :versions: []
+    :when: 2018-06-13 15:20:17.351348000 Z
+- - :permit
+  - Apache 2.0
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: SugarCRM's primary approved open source license
+    :versions: []
+    :when: 2018-06-18 19:28:33.314061000 Z
+- - :permit
+  - MIT
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: SugarCRM's secondary approved open source license
+    :versions: []
+    :when: 2018-06-13 15:18:36.240771000 Z
+- - :permit
+  - BSD
+  - :who: Andrew Sullivan Cant <mail@andrewsullivancant.ca>
+    :why: SugarCRM's secondary approved open source license
+    :versions: []
+    :when: 2018-06-18 19:29:15.003697000 Z

data/lib/rspec/side_effects/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Rspec
   module SideEffects
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.3.0'
   end
 end

data/lib/rspec/side_effects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/side_effects/version'
 
 module Rspec
@@ -7,7 +9,7 @@ module Rspec
   # @example
   module SideEffects
     def its_side_effects_are(*options, &block)
-      its_caller = caller.reject { |file_line| file_line =~ /its_side_effects/ }
+      its_caller = caller.grep_v(/its_side_effects/)
       if options.last.is_a?(Hash)
         options.last.merge(called: its_caller)
       else
@@ -16,7 +18,12 @@ module Rspec
 
       describe('side effects', *options) do
         if block
-          before { subject }
+          # rubocop:disable Lint/RescueException, Lint/SuppressedException
+          before do
+            subject
+          rescue Exception
+          end
+          # rubocop:enable Lint/RescueException, Lint/SuppressedException
           example(nil, :aggregate_failures, *options, &block)
         else
           example(nil, {}) { subject }

data/rspec-side_effects.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -17,23 +18,29 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 3.1.2'
 
-  spec.add_runtime_dependency     'rspec-core', '>= 2.99.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake',    '~> 10.0'
-  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_dependency 'rspec-core', '>= 2.99.0'
+
+  spec.add_development_dependency 'rake',  '~> 13.2'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 
   # Dependencies whose APIs we do not really depend upon, and can be upgraded
   # without limiting.
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'license_finder'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-lcov'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'yardstick'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-side_effects
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Sullivan Cant
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -25,49 +25,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.99.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: license_finder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: DSL to make testing side effects clear and explicit.
 email:
 - mail@andrewsullivancant.ca
@@ -129,10 +199,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-audit.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - CONTRIBUTOR_TERMS.md
@@ -142,14 +214,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- doc/dependency_decisions.yml
 - lib/rspec/side_effects.rb
 - lib/rspec/side_effects/version.rb
 - rspec-side_effects.gemspec
 homepage: http://github.com/sugarcrm/rspec-side_effects
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,16 +231,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 3.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: RSpec extension for examples with side effects.
 test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: 2.4
-      os: osx
-os:
-  - linux
-  - osx
-sudo: false
-after_success:
-  - bundle exec codeclimate-test-reporter