Prefer require_relative for internal code

bquorning · bquorning · commit 6adf13a694cb · 2025-11-05T13:58:03.000+01:00
But don't use require_relative from spec/ to lib/ and vice versa.
diff --git a/lib/zendesk_api.rb b/lib/zendesk_api.rb
@@ -3,6 +3,6 @@ module ZendeskAPI; end
 require "faraday"
 require "faraday/multipart"
 
-require "zendesk_api/helpers"
-require "zendesk_api/core_ext/inflection"
-require "zendesk_api/client"
+require_relative "zendesk_api/helpers"
+require_relative "zendesk_api/core_ext/inflection"
+require_relative "zendesk_api/client"
diff --git a/lib/zendesk_api/association.rb b/lib/zendesk_api/association.rb
@@ -1,4 +1,4 @@
-require "zendesk_api/helpers"
+require_relative "helpers"
 
 module ZendeskAPI
   # Represents an association between two resources
diff --git a/lib/zendesk_api/associations.rb b/lib/zendesk_api/associations.rb
@@ -1,4 +1,4 @@
-require "zendesk_api/helpers"
+require_relative "helpers"
 
 module ZendeskAPI
   # This module holds association method for resources.
diff --git a/lib/zendesk_api/client.rb b/lib/zendesk_api/client.rb
@@ -1,25 +1,25 @@
-require "zendesk_api/version"
-require "zendesk_api/sideloading"
-require "zendesk_api/configuration"
-require "zendesk_api/collection"
-require "zendesk_api/lru_cache"
-require "zendesk_api/silent_mash"
-require "zendesk_api/middleware/request/etag_cache"
-require "zendesk_api/middleware/request/retry"
-require "zendesk_api/middleware/request/raise_rate_limited"
-require "zendesk_api/middleware/request/upload"
-require "zendesk_api/middleware/request/encode_json"
-require "zendesk_api/middleware/request/api_token_impersonate"
-require "zendesk_api/middleware/request/url_based_access_token"
-require "zendesk_api/middleware/response/callback"
-require "zendesk_api/middleware/response/deflate"
-require "zendesk_api/middleware/response/gzip"
-require "zendesk_api/middleware/response/sanitize_response"
-require "zendesk_api/middleware/response/parse_iso_dates"
-require "zendesk_api/middleware/response/parse_json"
-require "zendesk_api/middleware/response/raise_error"
-require "zendesk_api/middleware/response/logger"
-require "zendesk_api/delegator"
+require_relative "version"
+require_relative "sideloading"
+require_relative "configuration"
+require_relative "collection"
+require_relative "lru_cache"
+require_relative "silent_mash"
+require_relative "middleware/request/etag_cache"
+require_relative "middleware/request/retry"
+require_relative "middleware/request/raise_rate_limited"
+require_relative "middleware/request/upload"
+require_relative "middleware/request/encode_json"
+require_relative "middleware/request/api_token_impersonate"
+require_relative "middleware/request/url_based_access_token"
+require_relative "middleware/response/callback"
+require_relative "middleware/response/deflate"
+require_relative "middleware/response/gzip"
+require_relative "middleware/response/sanitize_response"
+require_relative "middleware/response/parse_iso_dates"
+require_relative "middleware/response/parse_json"
+require_relative "middleware/response/raise_error"
+require_relative "middleware/response/logger"
+require_relative "delegator"
 
 module ZendeskAPI
   # The top-level class that handles configuration and connection to the Zendesk API.
diff --git a/lib/zendesk_api/collection.rb b/lib/zendesk_api/collection.rb
@@ -1,7 +1,7 @@
-require "zendesk_api/resource"
-require "zendesk_api/resources"
-require "zendesk_api/search"
-require "zendesk_api/pagination"
+require_relative "resource"
+require_relative "resources"
+require_relative "search"
+require_relative "pagination"
 
 module ZendeskAPI
   # Represents a collection of resources. Lazily loaded, resources aren't
diff --git a/lib/zendesk_api/middleware/request/raise_rate_limited.rb b/lib/zendesk_api/middleware/request/raise_rate_limited.rb
@@ -1,5 +1,5 @@
 require "faraday/middleware"
-require "zendesk_api/error"
+require_relative "../../error"
 
 module ZendeskAPI
   module Middleware
diff --git a/lib/zendesk_api/middleware/response/raise_error.rb b/lib/zendesk_api/middleware/response/raise_error.rb
@@ -1,4 +1,4 @@
-require "zendesk_api/error"
+require_relative "../../error"
 
 module ZendeskAPI
   module Middleware
diff --git a/lib/zendesk_api/resource.rb b/lib/zendesk_api/resource.rb
@@ -1,9 +1,9 @@
-require "zendesk_api/helpers"
-require "zendesk_api/trackie"
-require "zendesk_api/actions"
-require "zendesk_api/association"
-require "zendesk_api/associations"
-require "zendesk_api/verbs"
+require_relative "helpers"
+require_relative "trackie"
+require_relative "actions"
+require_relative "association"
+require_relative "associations"
+require_relative "verbs"
 
 # See docs: https://developer.zendesk.com/api-reference/
 module ZendeskAPI
diff --git a/lib/zendesk_api/trackie.rb b/lib/zendesk_api/trackie.rb
@@ -1,5 +1,5 @@
-require "zendesk_api/track_changes"
-require "zendesk_api/silent_mash"
+require_relative "track_changes"
+require_relative "silent_mash"
 
 module ZendeskAPI
   # @private
diff --git a/spec/core/spec_helper.rb b/spec/core/spec_helper.rb
@@ -20,9 +20,9 @@ def encoding_aware?
   end
 end
 
-require File.join(File.dirname(__FILE__), "..", "macros", "resource_macros")
-require File.join(File.dirname(__FILE__), "..", "fixtures", "zendesk")
-require File.join(File.dirname(__FILE__), "..", "fixtures", "test_resources")
+require_relative "../macros/resource_macros"
+require_relative "../fixtures/zendesk"
+require_relative "../fixtures/test_resources"
 
 $credentials_warning = false
 
diff --git a/spec/live/cbp_support_spec.rb b/spec/live/cbp_support_spec.rb
@@ -1,4 +1,4 @@
-require "core/resources/cbp_spec_helper"
+require_relative "../core/resources/cbp_spec_helper"
 
 describe "Endpoints that support CBP" do
   describe ZendeskAPI::Group do

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-require "zendesk_api/helpers"`
	`1`	`+require_relative "helpers"`
`2`	`2`
`3`	`3`	`module ZendeskAPI`
`4`	`4`	`# Represents an association between two resources`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-require "zendesk_api/error"`
	`1`	`+require_relative "../../error"`
`2`	`2`
`3`	`3`	`module ZendeskAPI`
`4`	`4`	`module Middleware`