add module for deprecation handling

lib/lunchmoney/api.rb

@@ -3,6 +3,7 @@
 
 require_relative "exceptions"
 require_relative "configuration"
+require_relative "deprecate"
 
 require_relative "calls/base"
 require_relative "objects/object"

lib/lunchmoney/deprecate.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LunchMoney
+  module Deprecate
+    cattr_accessor :endpoint_deprecation_warnings, default: true
+
+    sig { params(replacement: T.nilable(String)).void }
+    def deprecate_endpoint(replacement = nil)
+      return unless endpoint_deprecation_warnings
+
+      replacement = if replacement.nil?
+        "There is currently no replacement for this endpoint"
+      else
+        "Please use #{replacement} instead"
+      end
+
+      message = "#{deprecated_endpoint} is deprecated and may be removed from LunchMoney | #{replacement}"
+      Kernel.warn(message)
+    end
+
+    private
+
+    sig { returns(String) }
+    def deprecated_endpoint
+      endpoint_call = Kernel.caller_locations.find { |call| call.to_s.include?("lunchmoney/calls") }
+
+      if endpoint_call.nil?
+        ""
+      else
+        "LunchMoney::Api##{endpoint_call.label}"
+      end
+    end
+  end
+end

test/test_helper.rb

@@ -19,3 +19,5 @@
 require_relative "helpers/mocha_typed"
 require_relative "helpers/mock_response_helper"
 require_relative "helpers/vcr_helper"
+
+LunchMoney::Deprecate.endpoint_deprecation_warnings = false