rspec-its 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ede48c8c66058550c26cb470fbbc8a0e8cdc42693b2bd67a9996a5ef010c94a4
-  data.tar.gz: b0bfe107c8683af7f7797ec123a9d4677da93b53364af49808bc7d8dc0c51d0e
+  metadata.gz: 3d1e500e46f3ca1f648ee76288e9ac19340ee6dfb42ac9f0714534f71fab3a46
+  data.tar.gz: 0f5b92bf819bf9c825e0776a8f4b53dcce9566db785188ae6b349a05b9afbd5c
 SHA512:
-  metadata.gz: 5d0e4aa570b53ed61476c17a616d4b60dca827e78d74fff470b775b034502fbf5e22eb3bbecafae894833614d1f90b61f1aaf97ae32e83acf5a37d445118797e
-  data.tar.gz: 7f032617d48bc1fe4e499f002583463b4c474fd1145fc7398c96696870a1d0b8694afc4bfd672219d411b70a35f6f5c9ee0d8552ef0508639161deee17d8a472
+  metadata.gz: 8fd88f4645fb0c2b3a81cca6fba3abdcee34eb50526af38a5a30d896e17d272756744bf0d2009b4862b4e9acc3d697855ba72370e88b8d02e593e87395f923bb
+  data.tar.gz: 27af6704b1e805eb8eebbd91797ee29c44f006384e0289c0526d92aafe07f06c613ac655551dac326049d105ddfb6876bcd110c844b87454d028ea8a04383e8c

data/.github/workflows/ci.yml

@@ -9,86 +9,51 @@ on:
     branches:
       - '*'
 env:
-  BRANCH: '3-12-maintenance'
   RSPEC_CI: true
 jobs:
+  rubocop:
+    name: Rubocop
+    runs-on: 'ubuntu-20.04'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+      - run: script/update_rubygems_and_install_bundler
+      - run: bundle install
+      - run: bundle exec rubocop -c .rubocop.yml
+
   test:
     name: Ruby ${{ matrix.ruby }} ${{ matrix.name_extra || '' }}
     runs-on: ${{ matrix.os || 'ubuntu-20.04' }}
     strategy:
       matrix:
         ruby:
+          - '3.4'
+          - '3.3'
           - '3.2'
           - '3.1'
           - '3.0'
-          - 2.7
-          - 2.6
-          - 2.5
-          - 2.4
-          - 2.3
-          - 2.2
-          - 2.1.9
         env:
           -
             BRANCH: "main"
         include:
-          - ruby: jruby-9.2.13.0
+          - ruby: '3.3'
+            name_extra: "against RSpec 3.13"
             env:
-              JRUBY_OPTS: "--dev"
-          # Compatibility builds
+              BRANCH: "3-13-maintenance"
           - ruby: '3.2'
-            name_extra: "against RSpec 3.12"
+            name_extra: "against RSpec 3.13"
             env:
-              BRANCH: "3-12-maintenance"
+              BRANCH: "3-13-maintenance"
           - ruby: '3.1'
-            name_extra: "against RSpec 3.11"
-            env:
-              BRANCH: "3-11-maintenance"
-          - ruby: '3.1'
-            name_extra: "against RSpec 3.10"
-            env:
-              BRANCH: "3-10-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.9"
-            env:
-              BRANCH: "3-9-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.8"
-            env:
-              BRANCH: "3-8-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.7"
-            env:
-              BRANCH: "3-7-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.6"
-            env:
-              BRANCH: "3-6-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.5"
+            name_extra: "against RSpec 3.13"
             env:
-              BRANCH: "3-5-maintenance"
+              BRANCH: "3-13-maintenance"
           - ruby: '3.0'
-            name_extra: "against RSpec 3.4"
+            name_extra: "against RSpec 3.13"
             env:
-              BRANCH: "3-4-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.3"
-            env:
-              BRANCH: "3-3-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.2"
-            env:
-              BRANCH: "3-2-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.1"
-            env:
-              BRANCH: "3-1-maintenance"
-          - ruby: '3.0'
-            name_extra: "against RSpec 3.0"
-            env:
-              BRANCH: "3-0-maintenance"
-
+              BRANCH: "3-13-maintenance"
       fail-fast: false
     continue-on-error: ${{ matrix.allow_failure || endsWith(matrix.ruby, 'head') }}
     env: ${{ matrix.env }}
@@ -99,33 +64,6 @@ jobs:
           bundler: ${{ matrix.bundler || 2 }}
           ruby-version: ${{ matrix.ruby }}
       - run: script/update_rubygems_and_install_bundler
-      - run: bundle install --binstubs --standalone
-      - run: script/test_all
-
-  legacy:
-    name: Legacy Ruby Builds (${{ matrix.container.version }})
-    runs-on: ubuntu-20.04
-    container:
-      image: ${{ matrix.container.tag }}
-      options: ${{ matrix.container.options || '--add-host github-complains-if-this-is-empty.com:127.0.0.1' }}
-    strategy:
-      fail-fast: false
-      matrix:
-        container:
-          - version: "2.0"
-            tag: ghcr.io/rspec/docker-ci:2.0.0
-          - version: "1.9.3"
-            tag: ghcr.io/rspec/docker-ci:1.9.3
-          - version: "JRuby 1.7"
-            tag: ghcr.io/rspec/docker-ci:jruby-1.7
-          - version: "JRuby 9.1.17.0"
-            tag: ghcr.io/rspec/docker-ci:jruby-9.1.17.0
-            options: "--add-host rubygems.org:151.101.129.227 --add-host api.rubygems.org:151.101.129.227"
-    env:
-      ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
-      LEGACY_CI: true
-      JRUBY_OPTS: ${{ matrix.container.jruby_opts || '--dev' }}
-    steps:
-      - uses: actions/checkout@v3
-      - run: script/legacy_setup.sh
+      - run: bundle install --standalone
+      - run: bundle binstubs --all
       - run: script/test_all

data/.gitignore

@@ -17,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/*

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*_spec.rb
+
+Layout/LineLength:
+  Max: 120
+
+Lint/NestedMethodDefinition:
+  Exclude:
+    - lib/rspec/its.rb
+
+Lint/SendWithMixinArgument:
+  Exclude:
+    - lib/rspec/its.rb
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/rspec/its.rb
+
+Metrics/MethodLength:
+  Max: 25
+
+Naming/PredicateName:
+  Exclude:
+    - lib/rspec/its.rb
+
+Style/CaseEquality:
+  Exclude:
+    - lib/rspec/its/subject.rb
+
+Style/SignalException:
+  Exclude:
+    - features/**/*.rb
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - rspec-its.gemspec
+
+# We don't care about single vs double quotes.
+Style/StringLiterals:
+  Enabled: false

data/Changelog.md

@@ -1,3 +1,12 @@
+### 2.0.0 / 2024-11-04
+
+Version 2.0.0 drops support for Ruby below 3, and changes the supported RSpec version to "main" and current release series.
+(At the time of writing this is 3.13.x, but it means the current supported release only).
+
+Breaking changes:
+
+* Now uses `public_send` so that private methods will not be accidentally reachable. (James Ottaway #33, #101)
+
 ### 1.3.1 / 2024-10-23
 [full changelog](http://github.com/rspec/rspec-its/compare/v1.3.0...v1.3.1)
 

data/Gemfile

@@ -1,38 +1,27 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rspec-its.gemspec
 gemspec
 
 %w[rspec rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
-  branch = ENV.fetch('BRANCH','main')
+  branch = ENV.fetch('BRANCH', 'main')
   library_path = File.expand_path("../../#{lib}", __FILE__)
 
   if File.exist?(library_path) && !ENV['USE_GIT_REPOS']
-    gem lib, :path => library_path
+    gem lib, path: library_path
   elsif lib == 'rspec'
-    gem 'rspec', :git => "https://github.com/rspec/rspec-metagem.git", :branch => branch
+    gem 'rspec', git: "https://github.com/rspec/rspec-metagem.git", branch: branch
   else
-    gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => branch
+    gem lib, git: "https://github.com/rspec/#{lib}.git", branch: branch
   end
 end
 
-if RUBY_VERSION < '2.2.0' && !!(RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/)
-  gem 'ffi', '< 1.10'
-elsif RUBY_VERSION < '2.4.0' && !!(RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/)
-  gem 'ffi', '< 1.15'
-elsif RUBY_VERSION < '2.0'
-  gem 'ffi', '< 1.9.19' # ffi dropped Ruby 1.8 support in 1.9.19
-elsif RUBY_VERSION < '2.3.0'
-  gem 'ffi', '~> 1.12.0'
-else
-  gem 'ffi', '~> 1.15.0'
-end
-
-# test coverage
-# gem 'simplecov', :require => false
-
-gem 'contracts', '< 0.16' if RUBY_VERSION < '1.9.0'
-
-gem 'coveralls', :require => false, :platform => :mri_20
-
-eval File.read('Gemfile-custom') if File.exist?('Gemfile-custom')
+gem 'aruba', '~> 2.2.0'
+gem 'bundler', '> 2.0.0'
+gem 'coveralls', require: false
+gem 'cucumber', '>= 1.3.8'
+gem 'ffi', '~> 1.17.0'
+gem 'matrix', '~> 0.4.2'
+gem 'rake', '~> 13.2.0'
+gem 'rubocop', '~> 1.68.0'

data/LICENSE.txt

@@ -1,9 +1,9 @@
 (The MIT License)
 
+Copyright (c) 2024 The RSpec Development Team
 Copyright (c) 2013 Peter Alfvin
 Copyright (c) 2012 David Chelimsky, Myron Marston
 Copyright (c) 2006 David Chelimsky, The RSpec Development Team
-Copyright (c) 2005 Steven Baker
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-# RSpec::Its [![Build Status](https://travis-ci.org/rspec/rspec-its.svg)](https://travis-ci.org/rspec/rspec-its)
+# RSpec::Its [![Build Status](https://github.com/rspec/rspec-its/actions/workflows/ci.yml/badge.svg)](https://github.com/rspec/rspec-its/actions/workflows/ci.yml/badge.svg)
 
 RSpec::Its provides the `its` method as a short-hand to specify the expected value of an attribute.
 
@@ -26,33 +26,31 @@ require 'rspec/its'
 
 ## Usage
 
-Use the `its` method to generate a nested example group with
-a single example that specifies the expected value of an attribute of the
-subject using `should`, `should_not` or `is_expected`.
-The `its` method can also specify the block expectations of an attribute of the
-subject using `will` or `will_not`.
+Use the `its` method to generate a nested example group with a single example that specifies the expected value
+of an attribute of the subject using `is_expected`. The `its` method can also specify the block expectations of
+an attribute of the subject using `will` or `will_not`.
 
 `its` accepts a symbol or a string, and a block representing the example.
 
 ```ruby
-its(:size)    { should eq(1) }
-its("length") { should eq(1) }
+its(:size)    { is_expected.to eq(1) }
+its("length") { is_expected.to eq(1) }
 ```
 
 You can use a string with dots to specify a nested attribute (i.e. an
 attribute of the attribute of the subject).
 
 ```ruby
-its("phone_numbers.size") { should_not eq(0) }
+its("phone_numbers.size") { is_expected.to_not eq(0) }
 ```
 
-The following expect-style method is also available:
+The following should-style method is also available:
 
 ```ruby
-its(:size) { is_expected.to eq(1) }
+its(:size) { should eq(1) }
 ```
 
-as is this alias for pluralized use:
+as is an alias of `is_expected` for pluralized use:
 
 ```ruby
 its(:keys) { are_expected.to eq([:key1, :key2]) }
@@ -88,13 +86,13 @@ For other objects, multiple keys within the array will be passed as separate arg
 
 ```ruby
 subject { Matrix[ [:a, :b], [:c, :d] ] }
-its([1,1]) { should eq(:d) }
+its([1,1]) { is_expected.to eq(:d) }
 ```
 
 Metadata arguments are supported.
 
 ```ruby
-its(:size, focus: true) { should eq(1) }
+its(:size, focus: true) { is_expected.to eq(1) }
 ```
 
 ## Contributing

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler"
 Bundler.setup
 Bundler::GemHelper.install_tasks
@@ -13,4 +15,4 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.ruby_opts = %w[-w]
 end
 
-task :default => [:spec, :cucumber]
+task default: %i[spec cucumber]

data/features/its.feature

@@ -1,57 +1,25 @@
 Feature: attribute of subject
 
-  @pre-3-9
   Scenario: specify value of a nested attribute
     Given a file named "example_spec.rb" with:
       """ruby
       class Person
         attr_reader :phone_numbers
-        def initialize
-          @phone_numbers = []
-        end
-      end
-
-      describe Person do
-        context "with one phone number (555-1212)"do
-          subject do
-            person = Person.new
-            person.phone_numbers << "555-1212"
-            person
-          end
-
-          its("phone_numbers.first") { should eq("555-1212") }
-        end
-      end
-      """
-    When I run rspec with the documentation option
-    Then the output should contain:
-      """
-      Person
-        with one phone number (555-1212)
-          phone_numbers.first
-            should eq "555-1212"
-      """
 
-  @post-3-9
-  Scenario: specify value of a nested attribute
-    Given a file named "example_spec.rb" with:
-      """ruby
-      class Person
-        attr_reader :phone_numbers
         def initialize
           @phone_numbers = []
         end
       end
 
-      describe Person do
+      RSpec.describe Person do
         context "with one phone number (555-1212)"do
-          subject do
+          subject(:person) do
             person = Person.new
             person.phone_numbers << "555-1212"
             person
           end
 
-          its("phone_numbers.first") { should eq("555-1212") }
+          its("phone_numbers.first") { is_expected.to eq("555-1212") }
         end
       end
       """
@@ -67,13 +35,13 @@ Feature: attribute of subject
   Scenario: specify value of an attribute of a hash
     Given a file named "example_spec.rb" with:
       """ruby
-      describe Hash do
+      RSpec.describe Hash do
         context "with two items" do
           subject do
             {:one => 'one', :two => 'two'}
           end
 
-          its(:size) { should eq(2) }
+          its(:size) { is_expected.to eq(2) }
         end
       end
       """
@@ -83,14 +51,14 @@ Feature: attribute of subject
   Scenario: specify value for key in a hash
     Given a file named "example_spec.rb" with:
       """ruby
-      describe Hash do
+      RSpec.describe Hash do
         context "with keys :one and 'two'" do
           subject do
             {:one => 1, "two" => 2}
           end
 
-          its([:one]) { should eq(1) }
-          its(["two"]) { should eq(2) }
+          its([:one]) { is_expected.to eq(1) }
+          its(["two"]) { is_expected.to eq(2) }
         end
       end
       """
@@ -102,15 +70,15 @@ Feature: attribute of subject
       """ruby
       require 'matrix'
 
-      describe Matrix do
+      RSpec.describe Matrix do
         context "with values [[1, 2], [3, 4]]" do
           subject do
             Matrix[[1, 2], [3, 4]]
           end
 
-          its([0, 1]) { should eq(2) }
-          its([1, 0]) { should eq(3) }
-          its([1, 2]) { should be_nil }
+          its([0, 1]) { are_expected.to eq(2) }
+          its([1, 0]) { are_expected.to eq(3) }
+          its([1, 2]) { are_expected.to be_nil }
         end
       end
       """
@@ -120,22 +88,22 @@ Feature: attribute of subject
  Scenario: failures are correctly reported as coming from the `its` line
     Given a file named "example_spec.rb" with:
       """ruby
-      describe Array do
+      RSpec.describe Array do
         context "when first created" do
-          its(:size) { should_not eq(0) }
+          its(:size) { is_expected.to_not eq(0) }
         end
       end
       """
     When I run rspec
-    Then the output should contain "Failure/Error: its(:size) { should_not eq(0) }"
-      And the output should not match /#[^\n]*rspec[\x2f]its/
+    Then the output should contain "Failure/Error: its(:size) { is_expected.to_not eq(0) }"
+    And the output should not match /#[^\n]*rspec[\x2f]its/
 
  Scenario: examples can be specified by exact line number
     Given a file named "example_spec.rb" with:
       """ruby
-      describe Array do
+      RSpec.describe Array do
         context "when first created" do
-          its(:size) { should eq(0) }
+          its(:size) { is_expected.to eq(0) }
         end
       end
       """
@@ -145,10 +113,11 @@ Feature: attribute of subject
   Scenario: examples can be specified by line number within containing block
     Given a file named "example_spec.rb" with:
     """ruby
-      describe Array do
+      RSpec.describe Array do
         context "when first created" do
-          its(:size) { should eq(0) }
+          its(:size) { is_expected.to eq(0) }
         end
+
         it "should never execute this" do
           expect(true).to be(false)
         end
@@ -166,8 +135,9 @@ Feature: attribute of subject
         end
       end
 
-      describe Klass do
-        subject { Klass.new }
+      RSpec.describe Klass do
+        subject(:klass) { Klass.new }
+
         its(:foo) { will_not raise_error }
         its(:bar) { will raise_error(NoMethodError) }
       end
@@ -180,15 +150,16 @@ Feature: attribute of subject
       """ruby
       class Klass; end
 
-      describe Klass do
-        subject { Klass.new }
+      RSpec.describe Klass do
+        subject(:klass) { Klass.new }
+
         its(:foo) { will_not raise_error }
       end
       """
     When I run rspec
     Then the example should fail
     And the output should contain "Failure/Error: its(:foo) { will_not raise_error }"
-    And the output should contain "expected no Exception, got #<NoMethodError: undefined method `foo'"
+    And the output should match /expected no Exception, got #<NoMethodError: undefined method [`']foo'/
 
   Scenario: examples will warn when using non block expectations
     Given a file named "example_spec.rb" with:
@@ -199,8 +170,9 @@ Feature: attribute of subject
         end
       end
 
-      describe Klass do
-        subject { Klass.new }
+      RSpec.describe Klass do
+        subject(:arnie) { Klass.new }
+
         its(:terminator) { will be("back") }
       end
       """

data/features/step_definitions/additional_cli_steps.rb

@@ -1,32 +1,34 @@
-When /^I run rspec( with the documentation option)?$/ do |documentation|
-  rspec_its_gem_location = File.expand_path('../../../lib/rspec/its', __FILE__)
+# frozen_string_literal: true
+
+When(/^I run rspec( with the documentation option)?$/) do |documentation|
+  rspec_its_gem_location = File.expand_path('../../lib/rspec/its', __dir__)
   require_option = "--require #{rspec_its_gem_location}"
   format_option = documentation ? "--format documentation" : ""
   rspec_command = ['rspec', require_option, format_option, 'example_spec.rb'].join(' ')
   step "I run `#{rspec_command}`"
 end
 
-When /^I run rspec specifying line number (\d+)$/ do |line_number|
-  rspec_its_gem_location = File.expand_path('../../../lib/rspec/its', __FILE__)
+When(/^I run rspec specifying line number (\d+)$/) do |line_number|
+  rspec_its_gem_location = File.expand_path('../../lib/rspec/its', __dir__)
   require_option = "--require #{rspec_its_gem_location}"
   file_specification = "example_spec.rb:#{line_number}"
   rspec_command = ['rspec', require_option, file_specification].join(' ')
   step "I run `#{rspec_command}`"
 end
 
-Then /^the example(?:s)? should(?: all)? pass$/ do
-  step %q{the output should contain "0 failures"}
-  step %q{the output should not contain "0 examples"}
-  step %q{the exit status should be 0}
+Then(/^the example(?:s)? should(?: all)? pass$/) do
+  step 'the output should contain "0 failures"'
+  step 'the output should not contain "0 examples"'
+  step 'the exit status should be 0'
 end
 
-Then(/^the example should fail$/) do
-  step %q{the output should contain "1 failure"}
-  step %q{the exit status should not be 0}
+Then("the example should fail") do
+  step 'the output should contain "1 failure"'
+  step 'the exit status should not be 0'
 end
 
 Then(/^the output should contain "(.*?)" and "(.*?)"$/) do |string1, string2|
   unless [string1, string2].all? { |s| all_output.include?(s) }
-    fail %Q{Both "#{string1}" and "#{string2}" were found in:\n#{all_output}}
+    fail %(Both "#{string1}" and "#{string2}" were found in:\n#{all_output})
   end
 end

data/features/support/env.rb

@@ -1,15 +1,14 @@
+# frozen_string_literal: true
+
 require 'aruba/cucumber'
 require 'rspec/core'
 require 'rspec/its'
 
-Aruba.configure do |config|
-  config.before(:command) do |cmd|
-    cmd.environment['JRUBY_OPTS'] = "-X-C #{ENV['JRUBY_OPTS']}" # disable JIT since these processes are so short lived
-  end
-end if RUBY_PLATFORM == 'java'
-
-Aruba.configure do |config|
-  config.before(:command) do |cmd|
-    cmd.environment['RBXOPT'] = "-Xint=true #{ENV['RBXOPT']}" # disable JIT since these processes are so short lived
+if RUBY_PLATFORM == 'java'
+  Aruba.configure do |config|
+    config.before(:command) do |cmd|
+      # disable JIT since these processes are so short lived
+      cmd.environment['JRUBY_OPTS'] = "-X-C #{ENV.fetch('JRUBY_OPTS', '')}"
+    end
   end
-end if defined?(Rubinius)
+end

data/lib/rspec/its/subject.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Its
+    # @api private
+    # Handles turning subject into an expectation target
+    module Subject
+      def for(attribute, subject)
+        if Array === attribute
+          if Hash === subject
+            attribute.inject(subject) { |inner, attr| inner[attr] }
+          else
+            subject[*attribute]
+          end
+        else
+          attribute_chain = attribute.to_s.split('.')
+          attribute_chain.inject(subject) do |inner_subject, attr|
+            inner_subject.public_send(attr)
+          end
+        end
+      end
+
+      module_function :for
+    end
+  end
+end