Merge pull request #1482 from sul-dlss/named-subject

Fix Rspec/NamedSubject lint errors

Author: dnoneill

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-08-04 20:22:48 UTC using RuboCop version 1.79.1.
+# on 2025-08-07 17:15:23 UTC using RuboCop version 1.79.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -19,9 +19,9 @@ Metrics/CyclomaticComplexity:
 # Offense count: 19
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 25
+  Max: 24
 
-# Offense count: 25
+# Offense count: 23
 RSpec/AnyInstance:
   Exclude:
     - 'spec/controllers/media_controller_spec.rb'
@@ -34,10 +34,9 @@ RSpec/AnyInstance:
     - 'spec/requests/iiif/auth/v2/tokens_spec.rb'
     - 'spec/requests/iiif_auth_request_spec.rb'
     - 'spec/requests/iiif_spec.rb'
-    - 'spec/requests/media_auth_request_spec.rb'
     - 'spec/requests/versioned_file_spec.rb'
 
-# Offense count: 57
+# Offense count: 54
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -48,7 +47,6 @@ RSpec/ContextWording:
     - 'spec/models/projection_spec.rb'
     - 'spec/requests/file_auth_request_spec.rb'
     - 'spec/requests/iiif_spec.rb'
-    - 'spec/requests/media_auth_request_spec.rb'
     - 'spec/services/iiif_metadata_service_spec.rb'
     - 'spec/services/media_authentication_json_spec.rb'
 
@@ -67,7 +65,7 @@ RSpec/EmptyLineAfterExampleGroup:
   Exclude:
     - 'spec/requests/file_auth_request_spec.rb'
 
-# Offense count: 17
+# Offense count: 18
 # This cop supports safe autocorrection (--autocorrect).
 RSpec/EmptyLineAfterFinalLet:
   Exclude:
@@ -88,16 +86,15 @@ RSpec/EmptyLineAfterHook:
     - 'spec/features/status_spec.rb'
     - 'spec/requests/iiif_spec.rb'
 
-# Offense count: 9
+# Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
 RSpec/EmptyLineAfterSubject:
   Exclude:
     - 'spec/controllers/webauth_controller_spec.rb'
-    - 'spec/models/projection_spec.rb'
     - 'spec/models/stacks_image_spec.rb'
     - 'spec/services/iiif_metadata_service_spec.rb'
 
-# Offense count: 39
+# Offense count: 47
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 16
@@ -128,37 +125,28 @@ RSpec/LeadingSubject:
     - 'spec/models/stacks_media_token_spec.rb'
     - 'spec/services/media_authentication_json_spec.rb'
 
-# Offense count: 8
+# Offense count: 7
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   Exclude:
     - 'spec/controllers/file_controller_spec.rb'
     - 'spec/controllers/media_controller_spec.rb'
 
-# Offense count: 94
+# Offense count: 97
 RSpec/MultipleExpectations:
   Max: 12
 
-# Offense count: 63
+# Offense count: 13
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
 # SupportedStyles: always, named_only
 RSpec/NamedSubject:
   Exclude:
-    - 'spec/controllers/application_controller_spec.rb'
     - 'spec/controllers/file_controller_spec.rb'
     - 'spec/controllers/webauth_controller_spec.rb'
-    - 'spec/models/approved_location_spec.rb'
-    - 'spec/models/projection_spec.rb'
-    - 'spec/models/restricted_image_spec.rb'
-    - 'spec/models/stacks_file_spec.rb'
-    - 'spec/models/stacks_image_spec.rb'
     - 'spec/models/stacks_media_token_spec.rb'
-    - 'spec/models/user_spec.rb'
-    - 'spec/services/iiif_metadata_service_spec.rb'
-    - 'spec/services/media_authentication_json_spec.rb'
 
-# Offense count: 65
+# Offense count: 66
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 6
@@ -168,7 +156,7 @@ RSpec/RepeatedDescription:
   Exclude:
     - 'spec/routing/legacy_image_api_spec.rb'
 
-# Offense count: 5
+# Offense count: 4
 RSpec/StubbedMock:
   Exclude:
     - 'spec/controllers/file_controller_spec.rb'
@@ -192,4 +180,3 @@ RSpec/VerifiedDoubles:
 Rails/I18nLocaleTexts:
   Exclude:
     - 'app/controllers/webauth_controller.rb'
-

spec/controllers/application_controller_spec.rb

@@ -4,24 +4,24 @@
 
 RSpec.describe ApplicationController do
   describe '#current_user' do
-    subject { controller.send(:current_user) }
+    subject(:user) { controller.send(:current_user) }
 
     context 'with a Bearer token' do
-      let(:user) { User.new(id: 'test-user', ldap_groups: ['stanford:stanford']) }
+      let(:persisted_user) { User.new(id: 'test-user', ldap_groups: ['stanford:stanford']) }
       let(:credentials) do
         # `encode_credentials` hardcodes `Token` so make sure to test `Bearer`
         # http://iiif.io/api/auth/1.0/#the-json-access-token-response
-        ActionController::HttpAuthentication::Token.encode_credentials(user.token).gsub('Token', 'Bearer')
+        ActionController::HttpAuthentication::Token.encode_credentials(persisted_user.token).gsub('Token', 'Bearer')
       end
 
       before do
         request.env['HTTP_AUTHORIZATION'] = credentials
       end
 
       it 'supports bearer auth users' do
-        expect(subject.id).to eq 'test-user'
-        expect(subject).to be_a_token_user
-        expect(subject).to be_stanford
+        expect(user.id).to eq 'test-user'
+        expect(user).to be_a_token_user
+        expect(user).to be_stanford
       end
     end
 
@@ -31,14 +31,14 @@
       end
 
       it 'supports webauth users' do
-        expect(subject.id).to eq 'my-user'
-        expect(subject).to be_a_webauth_user
+        expect(user.id).to eq 'my-user'
+        expect(user).to be_a_webauth_user
       end
 
       context 'with shibboleth groups' do
         before { request.env['eduPersonEntitlement'] = 'a;b' }
         it 'supports shibboleth users' do
-          expect(subject.ldap_groups).to match_array %w[a b]
+          expect(user.ldap_groups).to match_array %w[a b]
         end
       end
     end
@@ -48,7 +48,7 @@
         request.env['REMOTE_USER'] = ''
       end
 
-      it { expect(subject).not_to be_a_webauth_user }
+      it { expect(user).not_to be_a_webauth_user }
     end
 
     context 'with session information' do
@@ -58,15 +58,15 @@
       end
 
       it 'retrieves the remote user and workgroup information' do
-        expect(subject.id).to eq 'my-user'
-        expect(subject).to be_a_webauth_user
-        expect(subject.ldap_groups).to match_array %w[a b]
+        expect(user.id).to eq 'my-user'
+        expect(user).to be_a_webauth_user
+        expect(user.ldap_groups).to match_array %w[a b]
       end
     end
 
     context 'with no other credentials' do
       it 'is an anonymous locatable user' do
-        expect(subject).to be_an_anonymous_locatable_user
+        expect(user).to be_an_anonymous_locatable_user
       end
     end
   end

spec/models/approved_location_spec.rb

@@ -3,29 +3,23 @@
 require 'rails_helper'
 
 RSpec.describe ApprovedLocation do
-  subject { described_class.new(locatable) }
+  subject { described_class.new(locatable).locations }
 
   context "when the locatable object's IP address does exist in the configuration" do
     let(:locatable) { double('Locatable', ip_address: 'ip.address1') }
 
-    it 'returns the location name as a string' do
-      expect(subject.locations).to eq %w[location1 location2]
-    end
+    it { is_expected.to eq %w[location1 location2] }
   end
 
   context "when the locatable object's IP address does not exist in the configuration" do
     let(:locatable) { double('Locatable', ip_address: 'not.a.configured.ip') }
 
-    it 'returns an empty array' do
-      expect(subject.locations).to eq []
-    end
+    it { is_expected.to be_empty }
   end
 
   context 'when the locatable object has no IP address' do
     let(:locatable) { double('NotReallyLocatable') }
 
-    it 'returns an empty array' do
-      expect(subject.locations).to eq []
-    end
+    it { is_expected.to be_empty }
   end
 end

spec/models/projection_spec.rb

@@ -21,7 +21,7 @@
   end
 
   describe '#tile_dimensions' do
-    subject { instance.send(:tile_dimensions) }
+    subject(:dimensions) { instance.send(:tile_dimensions) }
 
     context "for an unrestricted image" do
       context "explicit sizes" do
@@ -51,10 +51,10 @@
       context 'for requests with "max" size' do
         let(:ability) { instance_double(Ability) }
         let(:permissive_ability) do
-          ability.tap { |x| allow(x).to receive(:can?).with(:download, subject).and_return(true) }
+          ability.tap { |x| allow(x).to receive(:can?).with(:download, dimensions).and_return(true) }
         end
         let(:restricted_ability) do
-          ability.tap { |x| allow(x).to receive(:can?).with(:download, subject).and_return(false) }
+          ability.tap { |x| allow(x).to receive(:can?).with(:download, dimensions).and_return(false) }
         end
         let(:options) { { size: 'max', region: '0,0,800,600' } }
 
@@ -74,23 +74,23 @@
         let(:options) { { size: 'max', region: 'full' } }
 
         it 'limits users to thumbnail sizes' do
-          expect(subject).to eq IIIF::Image::Dimension.new(width: 400, height: 400)
+          expect(dimensions).to eq IIIF::Image::Dimension.new(width: 400, height: 400)
         end
       end
 
       context "best fit size" do
         let(:options) { { size: '!800,800', region: 'full' } }
 
         it 'limits users to thumbnail sizes' do
-          expect(subject).to eq IIIF::Image::Dimension.new(width: 400, height: 400)
+          expect(dimensions).to eq IIIF::Image::Dimension.new(width: 400, height: 400)
         end
       end
 
       context "specified region" do
         let(:options) { { size: 'max', region: '0,0,800,600' } }
 
         it 'limits users to a maximum tiles size' do
-          expect(subject).to eq IIIF::Image::Dimension.new(width: 512, height: 512)
+          expect(dimensions).to eq IIIF::Image::Dimension.new(width: 512, height: 512)
         end
       end
     end
@@ -112,7 +112,7 @@
         it 'allows the user to see the full-resolution image' do
           allow(HTTP).to receive_message_chain(:timeout, :headers, :use).and_return(http_client)
           allow(http_client).to receive(:get).and_return(double(body: nil))
-          subject.response
+          projection.response
           expect(http_client).to have_received(:get).with(%r{/full/max/0/default.jpg})
         end
       end
@@ -123,7 +123,7 @@
         it 'returns original size when requested dimensions are larger' do
           allow(HTTP).to receive_message_chain(:timeout, :headers, :use).and_return(http_client)
           allow(http_client).to receive(:get).and_return(double(body: nil))
-          subject.response
+          projection.response
           expect(http_client).to have_received(:get).with(%r{/full/!800,600/0/default.jpg})
         end
       end
@@ -141,7 +141,7 @@
           allow(HTTP).to receive_message_chain(:timeout, :headers, :use)
             .and_return(http_client)
           allow(http_client).to receive(:get).and_return(double(body: nil))
-          subject.response
+          projection.response
           expect(http_client).to have_received(:get).with(%r{/full/!400,400/0/default.jpg})
         end
       end
@@ -153,7 +153,7 @@
           allow(HTTP).to receive_message_chain(:timeout, :headers, :use)
             .and_return(http_client)
           allow(http_client).to receive(:get).and_return(double(body: nil))
-          subject.response
+          projection.response
           expect(http_client).to have_received(:get).with(%r{/full/!100,100/0/default.jpg})
         end
       end
@@ -165,7 +165,7 @@
           allow(HTTP).to receive_message_chain(:timeout, :headers, :use)
             .and_return(http_client)
           allow(http_client).to receive(:get).and_return(double(body: nil))
-          subject.response
+          projection.response
           expect(http_client).to have_received(:get).with(%r{/full/!400,400/0/default.jpg})
         end
       end
@@ -177,7 +177,7 @@
           allow(HTTP).to receive_message_chain(:timeout, :headers, :use)
             .and_return(http_client)
           allow(http_client).to receive(:get).and_return(double(body: nil))
-          subject.response
+          projection.response
           expect(http_client).to have_received(:get).with(%r{/square/100,100/0/default.jpg})
         end
       end
@@ -272,35 +272,30 @@
 
   describe '#region_dimensions' do
     subject { instance.region_dimensions }
+
     context 'for a full region' do
       let(:options) { { size: 'full', region: 'full' } }
 
-      it 'uses the image dimensions' do
-        expect(subject).to eq IIIF::Image::Dimension.new(width: 800, height: 600)
-      end
+      it { is_expected.to eq IIIF::Image::Dimension.new(width: 800, height: 600) }
     end
 
     context 'for square' do
       let(:options) { { size: 'full', region: 'square' } }
 
-      it 'uses the image dimensions' do
-        expect(subject).to eq IIIF::Image::Dimension.new(width: 600, height: 600)
-      end
+      it { is_expected.to eq IIIF::Image::Dimension.new(width: 600, height: 600) }
     end
 
     context 'for an explicit region' do
       let(:options) { { size: 'full', region: '0,1,2,3' } }
 
-      it 'handles explicit region requests' do
-        expect(subject).to eq IIIF::Image::Dimension.new(width: 2, height: 3)
-      end
+      it { is_expected.to eq IIIF::Image::Dimension.new(width: 2, height: 3) }
     end
 
     context 'for an region that contains negative values' do
       let(:options) { { size: 'full', region: '-22832,-22832,22832,22832' } }
 
       it 'raises an error' do
-        expect { subject }.to raise_error IIIF::Image::InvalidAttributeError
+        expect { instance.region_dimensions }.to raise_error IIIF::Image::InvalidAttributeError
       end
     end
   end

spec/models/restricted_image_spec.rb

@@ -6,16 +6,14 @@
   let(:instance) { described_class.new(stacks_file: instance_double(StacksImage)) }
 
   describe '#info' do
-    subject { instance.info }
-
     let(:info_service) { instance_double(IiifMetadataService, fetch: {}) }
 
     before do
       allow(instance).to receive(:info_service).and_return(info_service)
+      instance.info
     end
 
     it "adds tile size to the djatoka response" do
-      subject
       expect(info_service).to have_received(:fetch).with(256)
     end
   end