Fix broken specs (#476)

* Simplecov must be loaded first to monitor coverage

* Require dev/test deps for specs

Dev and test dependencies should be required for tests to use them.

They _could_ be required manually within each individual spec file.
Doing so would ensure that tests only load that which is directly
necessary for that specific test file and would allow running individual
files the absolute fastest.

However, for expediency and because the dependency list is quite short,
we can just load the entire group within the spec helper and reduce the
burden on each test file to load its own dependencies.

* All gems in Gemfile are dev/test deps

It's unclear why byebug would have ever been listed as a 'test'
dependency in the Gemfile. Virtually _all_ of the gems in the Gemfile
(because this is a gem, and not an app) are going to be dev/test deps.

simplecov, rspec, webmock, etc

All of these gems are "test" gems. So either they should all be listed
in the test group, or the test group ceases to have a role.

(Indeed, because this is a gem and not an application, bundler's groups
are already less useful. Nothing in this codebase was using the test
group.)

* Extract with_max_links to Helper module

The with_max_links helper was already being used across multiple spec
files, but wasn't properly being included for reuse. (It was defined
_globally_ in one single spec, which only worked if that specific test
just _happened_ to be loaded before the other.)

Helpers like this need to be included wherever they are used (if not
included globally).

Author: jasonkarns

Gemfile

@@ -8,6 +8,7 @@ gemspec
 gem 'appraisal', git: 'https://github.com/thoughtbot/appraisal.git'
 gem 'aws-sdk-core'
 gem 'aws-sdk-s3'
+gem 'byebug'
 gem 'combustion'
 gem 'fog-aws'
 gem 'google-cloud-storage'
@@ -18,18 +19,14 @@ gem 'rspec_junit_formatter'
 gem 'rspec-rails'
 gem 'simplecov'
 gem 'sqlite3', '~> 2.1.0'
-gem 'webmock'
+gem 'webmock', require: 'webmock/rspec'
 
 if RUBY_VERSION.match?(/2.5.*/)
   gem 'nokogiri', '1.12.5'
 else
   gem 'nokogiri'
 end
 
-group :test do
-  gem 'byebug'
-end
-
 # Dev tools / linter
 gem 'rubocop',             require: false
 gem 'rubocop-performance', require: false

gemfiles/rails_6.0.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
 gem "aws-sdk-core"
 gem "aws-sdk-s3"
+gem "byebug"
 gem "combustion"
 gem "fog-aws"
 gem "google-cloud-storage"
@@ -15,17 +16,13 @@ gem "rspec_junit_formatter"
 gem "rspec-rails"
 gem "simplecov"
 gem "sqlite3", "~> 1.5.0"
-gem "webmock"
+gem "webmock", require: "webmock/rspec"
 gem "nokogiri"
 gem "rubocop", require: false
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 
-group :test do
-  gem "byebug"
-end
-
 install_if -> { Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0") } do
   gem "drb"
   gem "mutex_m"

gemfiles/rails_6.1.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
 gem "aws-sdk-core"
 gem "aws-sdk-s3"
+gem "byebug"
 gem "combustion"
 gem "fog-aws"
 gem "google-cloud-storage"
@@ -15,17 +16,13 @@ gem "rspec_junit_formatter"
 gem "rspec-rails"
 gem "simplecov"
 gem "sqlite3", "~> 1.5.0"
-gem "webmock"
+gem "webmock", require: "webmock/rspec"
 gem "nokogiri"
 gem "rubocop", require: false
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 
-group :test do
-  gem "byebug"
-end
-
 install_if -> { Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0") } do
   gem "drb"
   gem "mutex_m"

gemfiles/rails_7.0.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
 gem "aws-sdk-core"
 gem "aws-sdk-s3"
+gem "byebug"
 gem "combustion"
 gem "fog-aws"
 gem "google-cloud-storage"
@@ -15,17 +16,13 @@ gem "rspec_junit_formatter"
 gem "rspec-rails"
 gem "simplecov"
 gem "sqlite3", "~> 1.5.0"
-gem "webmock"
+gem "webmock", require: "webmock/rspec"
 gem "nokogiri"
 gem "rubocop", require: false
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 
-group :test do
-  gem "byebug"
-end
-
 install_if -> { Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0") } do
   gem "drb"
   gem "mutex_m"

gemfiles/rails_7.1.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
 gem "aws-sdk-core"
 gem "aws-sdk-s3"
+gem "byebug"
 gem "combustion"
 gem "fog-aws"
 gem "google-cloud-storage"
@@ -15,15 +16,11 @@ gem "rspec_junit_formatter"
 gem "rspec-rails"
 gem "simplecov"
 gem "sqlite3", "~> 1.5.0"
-gem "webmock"
+gem "webmock", require: "webmock/rspec"
 gem "nokogiri"
 gem "rubocop", require: false
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 
-group :test do
-  gem "byebug"
-end
-
 gemspec path: "../"

gemfiles/rails_7.2.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
 gem "aws-sdk-core"
 gem "aws-sdk-s3"
+gem "byebug"
 gem "combustion"
 gem "fog-aws"
 gem "google-cloud-storage"
@@ -15,15 +16,11 @@ gem "rspec_junit_formatter"
 gem "rspec-rails"
 gem "simplecov"
 gem "sqlite3", "~> 1.5.0"
-gem "webmock"
+gem "webmock", require: "webmock/rspec"
 gem "nokogiri"
 gem "rubocop", require: false
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 
-group :test do
-  gem "byebug"
-end
-
 gemspec path: "../"

gemfiles/rails_8.0.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
 gem "aws-sdk-core"
 gem "aws-sdk-s3"
+gem "byebug"
 gem "combustion"
 gem "fog-aws"
 gem "google-cloud-storage"
@@ -15,15 +16,11 @@ gem "rspec_junit_formatter"
 gem "rspec-rails"
 gem "simplecov"
 gem "sqlite3", "~> 2.1.0"
-gem "webmock"
+gem "webmock", require: "webmock/rspec"
 gem "nokogiri"
 gem "rubocop", require: false
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 
-group :test do
-  gem "byebug"
-end
-
 gemspec path: "../"

gemfiles/rails_8.1.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
 gem "aws-sdk-core"
 gem "aws-sdk-s3"
+gem "byebug"
 gem "combustion"
 gem "fog-aws"
 gem "google-cloud-storage"
@@ -15,15 +16,11 @@ gem "rspec_junit_formatter"
 gem "rspec-rails"
 gem "simplecov"
 gem "sqlite3", "~> 2.1.0"
-gem "webmock"
+gem "webmock", require: "webmock/rspec"
 gem "nokogiri"
 gem "rubocop", require: false
 gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 
-group :test do
-  gem "byebug"
-end
-
 gemspec path: "../"

spec/sitemap_generator/interpreter_spec.rb

@@ -2,6 +2,8 @@
 require 'sitemap_generator/interpreter'
 
 RSpec.describe SitemapGenerator::Interpreter do
+  include SitemapHelpers
+
   let(:link_set)    { SitemapGenerator::LinkSet.new }
   let(:interpreter) { SitemapGenerator::Interpreter.new(:link_set => link_set) }
 

spec/sitemap_generator/sitemap_generator_spec.rb

@@ -7,15 +7,9 @@ class << self
   end
 end
 
-def with_max_links(num)
-  original = SitemapGenerator::Sitemap.max_sitemap_links
-  SitemapGenerator::Sitemap.max_sitemap_links = num
-  yield
-ensure
-  SitemapGenerator::Sitemap.max_sitemap_links = original
-end
-
 RSpec.describe 'SitemapGenerator' do
+  include SitemapHelpers
+
   describe 'reset!' do
     before do
       SitemapGenerator::Sitemap.default_host # Force initialization of the LinkSet