Skip to content

Commit

Permalink
Refactor specs
Browse files Browse the repository at this point in the history
- Create `spec_helper` and `.rspec`
- Add `spec/examples.txt` to `.gitignore` and sort alphabetically.
  `spec/examples.txt` allows to run specs with `--only-failures` option
- Add SimpleCov for code coverage. Run specs with `COVERAGE` env
  variable set to any value
  • Loading branch information
tagliala committed Dec 30, 2024
1 parent 3a12c9e commit 7a05360
Show file tree
Hide file tree
Showing 29 changed files with 141 additions and 36 deletions.
9 changes: 5 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--require spec_helper
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ 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.3.0", require: false

gem "simplecov", require: false
3 changes: 1 addition & 2 deletions spec/asset_file_spec.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# frozen_string_literal: true

require "inline_svg/finds_asset_paths"
require "inline_svg/asset_file"
require 'spec_helper'

RSpec.describe InlineSvg::AssetFile do
it "reads data from a file, after qualifying a full path" do
Expand Down
3 changes: 1 addition & 2 deletions spec/cached_asset_file_spec.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# frozen_string_literal: true

require 'pathname'
require "inline_svg"
require 'spec_helper'

RSpec.describe InlineSvg::CachedAssetFile do
let(:fixture_path) { Pathname.new(File.expand_path('files/static_assets', __dir__)) }
Expand Down
3 changes: 1 addition & 2 deletions spec/finds_asset_paths_spec.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# frozen_string_literal: true

require 'pathname'
require "inline_svg"
require 'spec_helper'

RSpec.describe InlineSvg::FindsAssetPaths do
after do
Expand Down
2 changes: 1 addition & 1 deletion spec/helpers/inline_svg_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg'
require 'spec_helper'

class WorkingCustomTransform < InlineSvg::CustomTransformation
def transform(doc)
Expand Down
2 changes: 1 addition & 1 deletion spec/id_generator_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg/id_generator"
require 'spec_helper'

RSpec.describe InlineSvg::IdGenerator do
it "generates a hexencoded ID based on a salt and a random value" do
Expand Down
2 changes: 1 addition & 1 deletion spec/inline_svg_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg"
require 'spec_helper'

class MyCustomTransform
def self.create_with_value(value); end
Expand Down
6 changes: 3 additions & 3 deletions spec/io_resource_spec.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# frozen_string_literal: true

require "inline_svg"
require "stringio"
require "tempfile"
require 'tempfile'

require 'spec_helper'

RSpec.describe InlineSvg::IOResource do
it "support api methods" do
Expand Down
2 changes: 1 addition & 1 deletion spec/propshaft_asset_finder_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg"
require 'spec_helper'

RSpec.describe InlineSvg::PropshaftAssetFinder do
context "when the file is not found" do
Expand Down
106 changes: 106 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# frozen_string_literal: true

if ENV.fetch('COVERAGE', false)
require 'simplecov'

SimpleCov.start do
add_filter %r{^/spec/}
end
end

require 'inline_svg'

# This file was generated by the `rspec --init` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause
# this file to always be loaded, without a need to explicitly require it in any
# files.
#
# Given that it is always loaded, you are encouraged to keep this file as
# light-weight as possible. Requiring heavyweight dependencies from this file
# will add to the boot time of your test suite on EVERY test run, even for an
# individual file that may not need all of that loaded. Instead, consider making
# a separate helper file that requires the additional dependencies and performs
# the additional setup, and require it from the spec files that actually need
# it.
#
# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
RSpec.configure do |config|
# rspec-expectations config goes here. You can use an alternate
# assertion/expectation library such as wrong or the stdlib/minitest
# assertions if you prefer.
config.expect_with :rspec do |expectations|
# This option will default to `true` in RSpec 4. It makes the `description`
# and `failure_message` of custom matchers include text for helper methods
# defined using `chain`, e.g.:
# be_bigger_than(2).and_smaller_than(4).description
# # => "be bigger than 2 and smaller than 4"
# ...rather than:
# # => "be bigger than 2"
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
end

# rspec-mocks config goes here. You can use an alternate test double
# library (such as bogus or mocha) by changing the `mock_with` option here.
config.mock_with :rspec do |mocks|
# Prevents you from mocking or stubbing a method that does not exist on
# a real object. This is generally recommended, and will default to
# `true` in RSpec 4.
mocks.verify_partial_doubles = true
end

# This option will default to `:apply_to_host_groups` in RSpec 4 (and will
# have no way to turn it off -- the option exists only for backwards
# compatibility in RSpec 3). It causes shared context metadata to be
# inherited by the metadata hash of host groups and examples, rather than
# triggering implicit auto-inclusion in groups with matching metadata.
config.shared_context_metadata_behavior = :apply_to_host_groups

# This allows you to limit a spec run to individual examples or groups
# you care about by tagging them with `:focus` metadata. When nothing
# is tagged with `:focus`, all examples get run. RSpec also provides
# aliases for `it`, `describe`, and `context` that include `:focus`
# metadata: `fit`, `fdescribe` and `fcontext`, respectively.
config.filter_run_when_matching :focus

# Allows RSpec to persist some state between runs in order to support
# the `--only-failures` and `--next-failure` CLI options. We recommend
# you configure your source control system to ignore this file.
config.example_status_persistence_file_path = "spec/examples.txt"

# Limits the available syntax to the non-monkey patched syntax that is
# recommended. For more details, see:
# https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
config.disable_monkey_patching!

# This setting enables warnings. It's recommended, but in some cases may
# be too noisy due to issues in dependencies.
config.warnings = true

# Many RSpec users commonly either run the entire suite or an individual
# file, and it's useful to allow more verbose output when running an
# individual spec file.
if config.files_to_run.one?
# Use the documentation formatter for detailed output,
# unless a formatter has already been configured
# (e.g. via a command-line flag).
config.default_formatter = "doc"
end

# Print the 10 slowest examples and example groups at the
# end of the spec run, to help surface which specs are running
# particularly slow.
config.profile_examples = 10

# Run specs in random order to surface order dependencies. If you find an
# order dependency and want to debug it, you can fix the order by providing
# the seed, which is printed after each run.
# --seed 1234
config.order = :random

# Seed global randomization in this process using the `--seed` CLI option.
# Setting this allows you to use `--seed` to deterministically reproduce
# test failures related to randomization by passing the same `--seed` value
# as the one that triggered the failure.
Kernel.srand config.seed
end
2 changes: 1 addition & 1 deletion spec/static_asset_finder_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg"
require 'spec_helper'

RSpec.describe InlineSvg::StaticAssetFinder do
context "when the file is not found" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg/transform_pipeline"
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
it "adds a role attribute to the SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::AriaHiddenAttribute do
it "adds an aria-hidden='true' attribute to a SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg/transform_pipeline"
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::ClassAttribute do
it "adds a class attribute to a SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::DataAttributes do
it "adds a data attribute to a SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::Description do
it "adds a desc element to the SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::Height do
it "adds height attribute to a SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::IdAttribute do
it "adds an id attribute to a SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::PreserveAspectRatio do
it "adds preserveAspectRatio attribute to a SVG document" do
Expand Down
2 changes: 1 addition & 1 deletion spec/transformation_pipeline/transformations/size_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::Size do
it "adds width and height attributes to a SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg/transform_pipeline"
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::ClassAttribute do
it "adds a style attribute to a SVG document" do
Expand Down
2 changes: 1 addition & 1 deletion spec/transformation_pipeline/transformations/title_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::Title do
it "adds a title element as the first element in the SVG document" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# frozen_string_literal: true

require 'inline_svg'
require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::Transformation do
describe "#with_svg" do
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::ViewBox do
it "adds viewBox attribute to a SVG document" do
Expand Down
2 changes: 1 addition & 1 deletion spec/transformation_pipeline/transformations/width_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'inline_svg/transform_pipeline'
require 'spec_helper'

RSpec.describe InlineSvg::TransformPipeline::Transformations::Width do
it "adds width attribute to a SVG document" do
Expand Down
3 changes: 1 addition & 2 deletions spec/transformation_pipeline/transformations_spec.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# frozen_string_literal: true

require 'inline_svg'
require 'inline_svg/transform_pipeline'
require 'spec_helper'

class ACustomTransform < InlineSvg::CustomTransformation
def transform(doc)
Expand Down
2 changes: 1 addition & 1 deletion spec/webpack_asset_finder_spec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require "inline_svg"
require 'spec_helper'

RSpec.describe InlineSvg::WebpackAssetFinder do
context "when the file is not found" do
Expand Down

0 comments on commit 7a05360

Please sign in to comment.