Skip to content

Commit 001b5c7

Browse files
committed
Prefer require_relative for internal requires
`require_relative` is preferred over `require` for files within the same project because it uses paths relative to the current file, making code more portable and less dependent on the load path. This change updates internal requires to use `require_relative` for consistency, performance, and improved portability. However, the test directory makes an exception and there `require` is preferred Fix `Packaging/RequireRelativeHardcodingLib` safe offense Ref: - ruby/psych#522 - ruby/logger#20 - ruby/rdoc#658 - rubocop/rubocop#8748 - https://docs.rubocop.org/rubocop-packaging/cops_packaging.html#packagingrequirerelativehardcodinglib
1 parent 10f0749 commit 001b5c7

13 files changed

+39
-51
lines changed

.rubocop_todo.yml

Lines changed: 0 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/inline_svg.rb

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
require "inline_svg/version"
2-
require "inline_svg/action_view/helpers"
3-
require "inline_svg/asset_file"
4-
require "inline_svg/cached_asset_file"
5-
require "inline_svg/finds_asset_paths"
6-
require "inline_svg/propshaft_asset_finder"
7-
require "inline_svg/static_asset_finder"
8-
require "inline_svg/webpack_asset_finder"
9-
require "inline_svg/transform_pipeline"
10-
require "inline_svg/io_resource"
11-
12-
require "inline_svg/railtie" if defined?(Rails)
1+
require_relative "inline_svg/version"
2+
require_relative "inline_svg/action_view/helpers"
3+
require_relative "inline_svg/asset_file"
4+
require_relative "inline_svg/cached_asset_file"
5+
require_relative "inline_svg/finds_asset_paths"
6+
require_relative "inline_svg/propshaft_asset_finder"
7+
require_relative "inline_svg/static_asset_finder"
8+
require_relative "inline_svg/webpack_asset_finder"
9+
require_relative "inline_svg/transform_pipeline"
10+
require_relative "inline_svg/io_resource"
11+
12+
require_relative "inline_svg/railtie" if defined?(Rails)
13+
1314
require 'active_support'
1415
require 'active_support/core_ext/object/blank'
1516
require 'active_support/core_ext/string'

lib/inline_svg/railtie.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module InlineSvg
33
class Railtie < ::Rails::Railtie
44
initializer "inline_svg.action_view" do |app|
55
ActiveSupport.on_load :action_view do
6-
require "inline_svg/action_view/helpers"
6+
require_relative "action_view/helpers"
77
include InlineSvg::ActionView::Helpers
88
end
99
end

lib/inline_svg/transform_pipeline/transformations.rb

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,18 @@ def self.no_transform
7575
end
7676
end
7777

78-
require 'inline_svg/transform_pipeline/transformations/transformation'
79-
require 'inline_svg/transform_pipeline/transformations/no_comment'
80-
require 'inline_svg/transform_pipeline/transformations/class_attribute'
81-
require 'inline_svg/transform_pipeline/transformations/style_attribute'
82-
require 'inline_svg/transform_pipeline/transformations/title'
83-
require 'inline_svg/transform_pipeline/transformations/description'
84-
require 'inline_svg/transform_pipeline/transformations/size'
85-
require 'inline_svg/transform_pipeline/transformations/height'
86-
require 'inline_svg/transform_pipeline/transformations/width'
87-
require 'inline_svg/transform_pipeline/transformations/view_box'
88-
require 'inline_svg/transform_pipeline/transformations/id_attribute'
89-
require 'inline_svg/transform_pipeline/transformations/data_attributes'
90-
require 'inline_svg/transform_pipeline/transformations/preserve_aspect_ratio'
91-
require 'inline_svg/transform_pipeline/transformations/aria_attributes'
92-
require "inline_svg/transform_pipeline/transformations/aria_hidden_attribute"
78+
require_relative 'transformations/transformation'
79+
require_relative 'transformations/no_comment'
80+
require_relative 'transformations/class_attribute'
81+
require_relative 'transformations/style_attribute'
82+
require_relative 'transformations/title'
83+
require_relative 'transformations/description'
84+
require_relative 'transformations/size'
85+
require_relative 'transformations/height'
86+
require_relative 'transformations/width'
87+
require_relative 'transformations/view_box'
88+
require_relative 'transformations/id_attribute'
89+
require_relative 'transformations/data_attributes'
90+
require_relative 'transformations/preserve_aspect_ratio'
91+
require_relative 'transformations/aria_attributes'
92+
require_relative 'transformations/aria_hidden_attribute'

spec/asset_file_spec.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
require_relative '../lib/inline_svg/finds_asset_paths'
2-
require_relative '../lib/inline_svg/asset_file'
1+
require "inline_svg/finds_asset_paths"
2+
require "inline_svg/asset_file"
33

44
describe InlineSvg::AssetFile do
55
it "reads data from a file, after qualifying a full path" do

spec/cached_asset_file_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# frozen_string_literal: true
22

33
require 'pathname'
4-
require_relative '../lib/inline_svg'
4+
require "inline_svg"
55

66
describe InlineSvg::CachedAssetFile do
77
let(:fixture_path) { Pathname.new(File.expand_path("../files/static_assets", __FILE__)) }

spec/finds_asset_paths_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
require 'pathname'
2-
require_relative '../lib/inline_svg'
2+
require "inline_svg"
33

44
describe InlineSvg::FindsAssetPaths do
55
context "when sprockets finder returns an object which supports only the pathname method" do

spec/id_generator_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
require_relative '../lib/inline_svg/id_generator'
1+
require "inline_svg/id_generator"
22

33
describe InlineSvg::IdGenerator do
44
it "generates a hexencoded ID based on a salt and a random value" do

spec/inline_svg_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
require_relative '../lib/inline_svg'
1+
require "inline_svg"
22

33
class MyCustomTransform
44
def self.create_with_value(value); end

spec/io_resource_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
require_relative '../lib/inline_svg'
1+
require "inline_svg"
22
require "stringio"
33
require "tempfile"
44

spec/propshaft_asset_finder_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
require_relative '../lib/inline_svg'
1+
require "inline_svg"
22

33
describe InlineSvg::PropshaftAssetFinder do
44
context "when the file is not found" do

spec/static_asset_finder_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
require_relative '../lib/inline_svg'
1+
require "inline_svg"
22

33
describe InlineSvg::StaticAssetFinder do
44
context "when the file is not found" do

spec/webpack_asset_finder_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
require_relative '../lib/inline_svg'
1+
require "inline_svg"
22

33
describe InlineSvg::WebpackAssetFinder do
44
context "when the file is not found" do

0 commit comments

Comments
 (0)