Refactor specs

- Create `spec_helper`
- Disable random spec order to allow spec to pass
- Update RuboCop
- Use `described_class` (autofix `RSpec/DescribedClass` offenses)
- Remove unused variables to fix the following warnings:
    ```
    spec/cached_asset_file_spec.rb:51: warning: assigned but unused variable - known_document_0
    spec/transformation_pipeline/transformations/transformation_spec.rb:19: warning: assigned but unused variable - svg
    ```
- Add SimpleCov for code coverage

Author: tagliala

.gitignore

@@ -2,17 +2,18 @@
 *.rbc
 .bundle
 .config
+.ruby-*
 .yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
 doc/
+Gemfile.lock
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc
+spec/examples.txt
 spec/reports
 test/tmp
 test/version_tmp
 tmp
-.ruby-*
+_yardoc

.rspec

@@ -0,0 +1 @@
+--require spec_helper

.rubocop_todo.yml

@@ -10,8 +10,10 @@ gem "pry"
 gem "rake"
 gem "rspec"
 
-gem "rubocop", "1.66.1"
-gem "rubocop-packaging", "0.5.2"
-gem "rubocop-performance", "1.22.1"
-gem "rubocop-rake", "0.6.0"
-gem "rubocop-rspec", "3.0.5"
+gem "rubocop", "1.69.0", require: false
+gem "rubocop-packaging", "0.5.2", require: false
+gem "rubocop-performance", "1.23.0", require: false
+gem "rubocop-rake", "0.6.0", require: false
+gem "rubocop-rspec", "3.2.0", require: false
+
+gem "simplecov", require: false

Gemfile

@@ -3,27 +3,27 @@
 require "inline_svg/finds_asset_paths"
 require "inline_svg/asset_file"
 
-describe InlineSvg::AssetFile do
+RSpec.describe InlineSvg::AssetFile do
   it "reads data from a file, after qualifying a full path" do
     example_svg_path = File.expand_path(__FILE__, 'files/example.svg')
     expect(InlineSvg::FindsAssetPaths).to receive(:by_filename).with('some filename').and_return example_svg_path
 
-    expect(InlineSvg::AssetFile.named('some filename')).to include('This is a test')
+    expect(described_class.named('some filename')).to include('This is a test')
   end
 
   it "complains when the file cannot be read" do
     allow(InlineSvg::FindsAssetPaths).to receive(:by_filename).and_return('/this/path/does/not/exist')
 
     expect do
-      InlineSvg::AssetFile.named('some missing file')
+      described_class.named('some missing file')
     end.to raise_error InlineSvg::AssetFile::FileNotFound
   end
 
   it "complains when the file path was not found" do
     allow(InlineSvg::FindsAssetPaths).to receive(:by_filename).and_return(nil)
 
     expect do
-      InlineSvg::AssetFile.named('some missing file')
+      described_class.named('some missing file')
     end.to raise_error InlineSvg::AssetFile::FileNotFound
   end
 end

spec/asset_file_spec.rb

@@ -3,19 +3,19 @@
 require 'pathname'
 require "inline_svg"
 
-describe InlineSvg::CachedAssetFile do
+RSpec.describe InlineSvg::CachedAssetFile do
   let(:fixture_path) { Pathname.new(File.expand_path('files/static_assets', __dir__)) }
 
   it "loads assets under configured paths" do
     known_document = File.read(fixture_path.join("assets0", "known-document.svg"))
 
-    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path.join("assets0"))
+    asset_loader = described_class.new(paths: fixture_path.join("assets0"))
 
     expect(asset_loader.named("known-document.svg")).to eq(known_document)
   end
 
   it "does not include assets outside of configured paths" do
-    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path.join("assets0"))
+    asset_loader = described_class.new(paths: fixture_path.join("assets0"))
 
     expect(fixture_path.join("assets1", "other-document.svg")).to be_file
     expect do
@@ -29,7 +29,7 @@
 
     expect(known_document_0).not_to eq(known_document_1)
 
-    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path)
+    asset_loader = described_class.new(paths: fixture_path)
 
     expect(known_document_0).to eq(asset_loader.named("assets0/known-document.svg"))
     expect(known_document_1).to eq(asset_loader.named("assets1/known-document.svg"))
@@ -41,17 +41,16 @@
 
     expect(known_document).not_to eq(known_document_2)
 
-    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path.join("assets0"), filters: /\.svg/)
+    asset_loader = described_class.new(paths: fixture_path.join("assets0"), filters: /\.svg/)
 
     expect(asset_loader.named("known-document")).to eq(known_document)
     expect(asset_loader.named("known-document-two")).to eq(known_document_2)
   end
 
   it "filters wanted files by simple string matching" do
-    known_document_0 = File.read(fixture_path.join("assets0", "known-document.svg"))
     known_document_1 = File.read(fixture_path.join("assets1", "known-document.svg"))
 
-    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path, filters: "assets1")
+    asset_loader = described_class.new(paths: fixture_path, filters: "assets1")
 
     expect do
       asset_loader.named("assets0/known-document.svg")
@@ -63,7 +62,7 @@
   it "filters wanted files by regex matching" do
     known_document_1 = File.read(fixture_path.join("assets1", "known-document.svg"))
 
-    asset_loader = InlineSvg::CachedAssetFile.new(paths: fixture_path, filters: ["assets1", /\.svg/])
+    asset_loader = described_class.new(paths: fixture_path, filters: ["assets1", /\.svg/])
 
     expect do
       asset_loader.named("assets1/some-file.txt")

spec/cached_asset_file_spec.rb

@@ -3,7 +3,7 @@
 require 'pathname'
 require "inline_svg"
 
-describe InlineSvg::FindsAssetPaths do
+RSpec.describe InlineSvg::FindsAssetPaths do
   context "when sprockets finder returns an object which supports only the pathname method" do
     it "returns fully qualified file paths from Sprockets" do
       sprockets = double('SprocketsDouble')
@@ -15,7 +15,7 @@
         config.asset_finder = sprockets
       end
 
-      expect(InlineSvg::FindsAssetPaths.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
+      expect(described_class.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
     end
   end
 
@@ -30,7 +30,7 @@
         config.asset_finder = sprockets
       end
 
-      expect(InlineSvg::FindsAssetPaths.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
+      expect(described_class.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
     end
   end
 
@@ -44,7 +44,7 @@
         config.asset_finder = sprockets
       end
 
-      expect(InlineSvg::FindsAssetPaths.by_filename('some-file')).to be_nil
+      expect(described_class.by_filename('some-file')).to be_nil
     end
   end
 
@@ -59,7 +59,7 @@
         config.asset_finder = propshaft
       end
 
-      expect(InlineSvg::FindsAssetPaths.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
+      expect(described_class.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
     end
   end
 
@@ -74,7 +74,7 @@
         config.asset_finder = shakapacker
       end
 
-      expect(InlineSvg::FindsAssetPaths.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
+      expect(described_class.by_filename('some-file')).to eq Pathname('/full/path/to/some-file')
     end
   end
 
@@ -89,7 +89,7 @@
         config.asset_finder = shakapacker
       end
 
-      expect(InlineSvg::FindsAssetPaths.by_filename('some-file')).to eq Pathname('https://my-fancy-domain.test/full/path/to/some-file')
+      expect(described_class.by_filename('some-file')).to eq Pathname('https://my-fancy-domain.test/full/path/to/some-file')
     end
   end
 end

spec/finds_asset_paths_spec.rb

@@ -11,7 +11,7 @@ def transform(doc)
   end
 end
 
-describe InlineSvg::ActionView::Helpers do
+RSpec.describe InlineSvg::ActionView::Helpers do
   let(:helper) { (Class.new { include InlineSvg::ActionView::Helpers }).new }
 
   shared_examples "inline_svg helper" do |helper_method:|

spec/helpers/inline_svg_spec.rb

@@ -2,11 +2,11 @@
 
 require "inline_svg/id_generator"
 
-describe InlineSvg::IdGenerator do
+RSpec.describe InlineSvg::IdGenerator do
   it "generates a hexencoded ID based on a salt and a random value" do
     randomizer = -> { "some-random-value" }
 
-    expect(InlineSvg::IdGenerator.generate("some-base", "some-salt", randomness: randomizer))
+    expect(described_class.generate("some-base", "some-salt", randomness: randomizer))
       .to eq("at2c17mkqnvopy36iccxspura7wnreqf")
   end
 end

spec/id_generator_spec.rb

@@ -19,53 +19,53 @@ class MyCustomAssetFile
   def self.named(filename); end
 end
 
-describe InlineSvg do
+RSpec.describe InlineSvg do
   describe "configuration" do
     context "when a block is not given" do
       it "complains" do
         expect do
-          InlineSvg.configure
+          described_class.configure
         end.to raise_error(InlineSvg::Configuration::Invalid)
       end
     end
 
     context "asset finder" do
       it "allows an asset finder to be assigned" do
         sprockets = double('SomethingLikeSprockets', find_asset: 'some asset')
-        InlineSvg.configure do |config|
+        described_class.configure do |config|
           config.asset_finder = sprockets
         end
 
-        expect(InlineSvg.configuration.asset_finder).to eq sprockets
+        expect(described_class.configuration.asset_finder).to eq sprockets
       end
 
       it "falls back to StaticAssetFinder when the provided asset finder does not implement #find_asset" do
-        InlineSvg.configure do |config|
+        described_class.configure do |config|
           config.asset_finder = 'Not a real asset finder'
         end
 
-        expect(InlineSvg.configuration.asset_finder).to eq InlineSvg::StaticAssetFinder
+        expect(described_class.configuration.asset_finder).to eq InlineSvg::StaticAssetFinder
       end
     end
 
     context "configuring a custom asset file" do
       it "falls back to the built-in asset file implementation by default" do
-        expect(InlineSvg.configuration.asset_file).to eq(InlineSvg::AssetFile)
+        expect(described_class.configuration.asset_file).to eq(InlineSvg::AssetFile)
       end
 
       it "adds a collaborator that meets the interface specification" do
-        InlineSvg.configure do |config|
+        described_class.configure do |config|
           config.asset_file = MyCustomAssetFile
         end
 
-        expect(InlineSvg.configuration.asset_file).to eq MyCustomAssetFile
+        expect(described_class.configuration.asset_file).to eq MyCustomAssetFile
       end
 
       it "rejects a collaborator that does not conform to the interface spec" do
         bad_asset_file = double("bad_asset_file")
 
         expect do
-          InlineSvg.configure do |config|
+          described_class.configure do |config|
             config.asset_file = bad_asset_file
           end
         end.to raise_error(InlineSvg::Configuration::Invalid, /asset_file should implement the #named method/)
@@ -75,7 +75,7 @@ def self.named(filename); end
         bad_asset_file = double("bad_asset_file", named: nil)
 
         expect do
-          InlineSvg.configure do |config|
+          described_class.configure do |config|
             config.asset_file = bad_asset_file
           end
         end.to raise_error(InlineSvg::Configuration::Invalid, /asset_file should implement the #named method with arity 1/)
@@ -84,42 +84,42 @@ def self.named(filename); end
 
     context "configuring the default svg-not-found class" do
       it "sets the class name" do
-        InlineSvg.configure do |config|
+        described_class.configure do |config|
           config.svg_not_found_css_class = 'missing-svg'
         end
 
-        expect(InlineSvg.configuration.svg_not_found_css_class).to eq 'missing-svg'
+        expect(described_class.configuration.svg_not_found_css_class).to eq 'missing-svg'
       end
     end
 
     context "configuring custom transformation" do
       it "allows a custom transformation to be added" do
-        InlineSvg.configure do |config|
+        described_class.configure do |config|
           config.add_custom_transformation(attribute: :my_transform, transform: MyCustomTransform)
         end
 
-        expect(InlineSvg.configuration.custom_transformations).to eq({ my_transform: { attribute: :my_transform, transform: MyCustomTransform } })
+        expect(described_class.configuration.custom_transformations).to eq({ my_transform: { attribute: :my_transform, transform: MyCustomTransform } })
       end
 
       it "rejects transformations that do not implement .create_with_value" do
         expect do
-          InlineSvg.configure do |config|
+          described_class.configure do |config|
             config.add_custom_transformation(attribute: :irrelevant, transform: MyInvalidCustomTransformKlass)
           end
         end.to raise_error(InlineSvg::Configuration::Invalid, /#{MyInvalidCustomTransformKlass} should implement the .create_with_value and #transform methods/o)
       end
 
       it "rejects transformations that does not implement #transform" do
         expect do
-          InlineSvg.configure do |config|
+          described_class.configure do |config|
             config.add_custom_transformation(attribute: :irrelevant, transform: MyInvalidCustomTransformInstance)
           end
         end.to raise_error(InlineSvg::Configuration::Invalid, /#{MyInvalidCustomTransformInstance} should implement the .create_with_value and #transform methods/o)
       end
 
       it "rejects transformations that are not classes" do
         expect do
-          InlineSvg.configure do |config|
+          described_class.configure do |config|
             config.add_custom_transformation(attribute: :irrelevant, transform: :not_a_class)
           end
         end.to raise_error(InlineSvg::Configuration::Invalid, /not_a_class should implement the .create_with_value and #transform methods/)

spec/inline_svg_spec.rb

@@ -4,7 +4,7 @@
 require "stringio"
 require "tempfile"
 
-describe InlineSvg::IOResource do
+RSpec.describe InlineSvg::IOResource do
   it "support api methods" do
     is_expected.to respond_to(:===, :read)
   end