Skip to content

Commit

Permalink
Add frozen_string_literal: true everywhere (#220)
Browse files Browse the repository at this point in the history
* Add frozen_string_literal: true everywhere

* Fix frozen string

* Try running on my branch

* Fix warning: `*' interpreted as argument prefix
Update actions/checkout to v4

* Keep workflow main branch
  • Loading branch information
ericproulx committed Jun 4, 2024
1 parent 5becc96 commit da79956
Show file tree
Hide file tree
Showing 46 changed files with 109 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
env:
BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up using Ruby ${{ matrix.ruby-version }} with Gemfile '${{ matrix.gemfile }}'
uses: ruby/setup-ruby@v1
with:
Expand Down
1 change: 1 addition & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Unreleased
---
* Add `frozen_string_literal: true` (#220)

5.0.0
---
Expand Down
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

platforms :rbx do
Expand Down
2 changes: 2 additions & 0 deletions gemfiles/sidekiq5_rails6.gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

gem 'sidekiq', '~> 5.0'
Expand Down
2 changes: 2 additions & 0 deletions gemfiles/sidekiq6_4_rails6.gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

gem 'sidekiq', '~> 6.4.0'
Expand Down
2 changes: 2 additions & 0 deletions gemfiles/sidekiq6_4_rails7.gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

gem 'sidekiq', '~> 6.4.0'
Expand Down
2 changes: 2 additions & 0 deletions gemfiles/sidekiq6_5_rails6.gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

gem 'sidekiq', '~> 6.5'
Expand Down
2 changes: 2 additions & 0 deletions gemfiles/sidekiq6_5_rails7.gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

gem 'sidekiq', '~> 6.5'
Expand Down
2 changes: 2 additions & 0 deletions gemfiles/sidekiq7_rails7.gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

gem 'sidekiq', '~> 7'
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec-sidekiq.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'forwardable'

require 'sidekiq'
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/batch.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'rspec/core'

if defined? Sidekiq::Batch
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/configuration.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require "rubygems"
require "set"

Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/helpers.rb
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
# frozen_string_literal: true

require 'rspec/core'
require 'rspec/sidekiq/helpers/within_sidekiq_retries_exhausted_block'
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module Sidekiq
module Worker
module ClassMethods
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require "rspec/core"
require "rspec/matchers"
require "rspec/mocks/argument_list_matcher"
Expand Down
10 changes: 6 additions & 4 deletions lib/rspec/sidekiq/matchers/base.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down Expand Up @@ -275,13 +277,13 @@ def failure_message
message << "but enqueued only jobs"
if expected_arguments
job_messages = actual_jobs.map do |job|
base = " -JID:#{job.jid} with arguments:"
base << "\n -#{formatted(job.args)}"
base = [" -JID:#{job.jid} with arguments:"]
base << " -#{formatted(job.args)}"
if expected_options.any?
base << "\n with context: #{formatted(job.context)}"
base << " with context: #{formatted(job.context)}"
end

base
base.join("\n")
end

message << job_messages.join("\n")
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/be_delayed.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/be_expired_in.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/be_processed_in.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/be_retryable.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/be_unique.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/enqueue_sidekiq_job.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/have_enqueued_sidekiq_job.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/matchers/save_backtrace.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Matchers
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/sidekiq.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
class << self
Expand Down
2 changes: 2 additions & 0 deletions lib/rspec/sidekiq/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
VERSION = "5.0.0"
Expand Down
2 changes: 2 additions & 0 deletions rspec-sidekiq.gemspec
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require File.expand_path("../lib/rspec/sidekiq/version", __FILE__)

Gem::Specification.new do |s|
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/batch_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'Batch', stub_batches: true do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/helpers/retries_exhausted_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'Retries Exhausted block' do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/matchers/be_delayed_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require "spec_helper"

RSpec.describe RSpec::Sidekiq::Matchers::BeDelayed do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/matchers/be_expired_in_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe RSpec::Sidekiq::Matchers::BeExpiredIn do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/matchers/be_processed_in_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe RSpec::Sidekiq::Matchers::BeProcessedIn do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/matchers/be_retryable_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe RSpec::Sidekiq::Matchers::BeRetryable do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/matchers/be_unique_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe RSpec::Sidekiq::Matchers::BeUnique do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/matchers/enqueue_sidekiq_job_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require "spec_helper"

RSpec.describe RSpec::Sidekiq::Matchers::EnqueueSidekiqJob do
Expand Down
32 changes: 17 additions & 15 deletions spec/rspec/sidekiq/matchers/have_enqueued_sidekiq_job_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe RSpec::Sidekiq::Matchers::HaveEnqueuedSidekiqJob do
Expand Down Expand Up @@ -121,18 +123,18 @@
end

it 'matches a job with arguments' do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
expect(worker).to have_enqueued_sidekiq_job
expect(worker).to have_enqueued_sidekiq_job *worker_args
expect(worker).to have_enqueued_sidekiq_job(*worker_args)
end

it 'matches on the global Worker queue' do
worker.perform_async *worker_args
expect(Sidekiq::Worker).to have_enqueued_sidekiq_job *worker_args
worker.perform_async(*worker_args)
expect(Sidekiq::Worker).to have_enqueued_sidekiq_job(*worker_args)
end

it "fails if a job was enqueued with arguments but matched with no_args" do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
expect do
expect(worker).to have_enqueued_sidekiq_job(no_args)
end.to raise_error(/expected to have enqueued a .* job/)
Expand All @@ -147,7 +149,7 @@
end

it "fails if a job was enqueued" do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
expect do
expect(worker).not_to have_enqueued_sidekiq_job
end.to raise_error(/expected not to have enqueued a .* job/)
Expand Down Expand Up @@ -255,27 +257,27 @@

describe '#have_enqueued_sidekiq_job' do
it 'returns instance' do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
expect(have_enqueued_sidekiq_job).to be_a described_class
end

it 'matches the same way have_enqueued_sidekiq_job does' do
worker.perform_async *worker_args
expect(worker).to have_enqueued_sidekiq_job *worker_args
worker.perform_async(*worker_args)
expect(worker).to have_enqueued_sidekiq_job(*worker_args)
end
end

describe '#description' do
it 'returns description' do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
argument_subject.matches? worker
expect(argument_subject.description).to eq %{have enqueued a #{worker} job with arguments [\"string\", 1, true, {\"key\"=>\"value\", \"bar\"=>\"foo\", \"nested\"=>[{\"hash\"=>true}]}]}
end
end

describe '#failure_message' do
it 'returns message' do
jid = worker.perform_async *worker_args
jid = worker.perform_async(*worker_args)
argument_subject.matches? worker
expect(argument_subject.failure_message).to eq <<~eos.strip
expected to have enqueued a #{worker} job
Expand All @@ -292,7 +294,7 @@
let(:argument_subject) { described_class.new wrapped_args }

it "returns a message showing the wrapped array in expectations but each job on its own line" do
jids = 2.times.map { worker.perform_async *worker_args }
jids = 2.times.map { worker.perform_async(*worker_args) }
argument_subject.matches? worker
expect(argument_subject.failure_message).to eq <<~eos.strip
expected to have enqueued a #{worker} job
Expand All @@ -310,7 +312,7 @@

describe '#failure_message_when_negated' do
it 'returns message' do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
argument_subject.matches? worker
expect(argument_subject.failure_message_when_negated).to eq <<-eos.gsub(/^ {6}/, '').strip
expected not to have enqueued a #{worker} job but enqueued 1
Expand All @@ -323,7 +325,7 @@
context 'when condition matches' do
context 'when expected are arguments' do
it 'returns true' do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
expect(argument_subject.matches? worker).to be true
end
end
Expand All @@ -338,7 +340,7 @@

context 'when expected are matchers' do
it 'returns true' do
worker.perform_async *worker_args
worker.perform_async(*worker_args)
expect(matcher_subject.matches? worker).to be true
end
end
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/matchers/save_backtrace_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe RSpec::Sidekiq::Matchers::SaveBacktrace do
Expand Down
2 changes: 2 additions & 0 deletions spec/rspec/sidekiq/sidekiq_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe RSpec::Sidekiq do
Expand Down
2 changes: 2 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require 'pry'

require 'sidekiq'
Expand Down
2 changes: 2 additions & 0 deletions spec/support/factories.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

module RSpec
module Sidekiq
module Spec
Expand Down
2 changes: 2 additions & 0 deletions spec/support/init.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

require_relative 'factories'
require_relative 'test_worker'
require_relative 'test_worker_alternative'
Expand Down
2 changes: 2 additions & 0 deletions spec/support/test_action_mailer.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

class TestActionMailer < ActionMailer::Base
def testmail(resource = nil)
@resource = resource
Expand Down
2 changes: 2 additions & 0 deletions spec/support/test_job.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

class TestJob < ActiveJob::Base
queue_as :mailers

Expand Down
2 changes: 2 additions & 0 deletions spec/support/test_resource.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

class TestResource
include GlobalID::Identification

Expand Down
2 changes: 2 additions & 0 deletions spec/support/test_worker.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

class TestWorker
include Sidekiq::Worker

Expand Down
2 changes: 2 additions & 0 deletions spec/support/test_worker_alternative.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

class TestWorkerAlternative
include Sidekiq::Worker

Expand Down

0 comments on commit da79956

Please sign in to comment.