Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust deprecator definition to be more inline with the official API #1

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/paper_trail.rb
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,10 @@ def version
def active_record_gte_7_0?
@active_record_gte_7_0 ||= ::ActiveRecord.gem_version >= ::Gem::Version.new("7.0.0")
end

def deprecator
@deprecator ||= ActiveSupport::Deprecation.new("16.0", "PaperTrail")
end
end
end

Expand Down
14 changes: 0 additions & 14 deletions lib/paper_trail/active_record_version_concern.rb

This file was deleted.

6 changes: 5 additions & 1 deletion lib/paper_trail/frameworks/rails/railtie.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class Railtie < ::Rails::Railtie
# We specify `before: "load_config_initializers"` to ensure that the PT
# initializer happens before "app initializers" (those defined in
# the app's `config/initalizers`).
initializer "paper_trail", before: "load_config_initializers" do
initializer "paper_trail", before: "load_config_initializers" do |app|
# `on_load` is a "lazy load hook". It "declares a block that will be
# executed when a Rails component is fully loaded". (See
# `active_support/lazy_load_hooks.rb`)
Expand All @@ -25,6 +25,10 @@ class Railtie < ::Rails::Railtie
ActiveSupport.on_load(:active_record) do
require "paper_trail/frameworks/active_record"
end

if ::Rails::VERSION::STRING >= "7.1"
app.deprecators[:paper_trail] = PaperTrail.deprecator
end
end
end
end
6 changes: 2 additions & 4 deletions lib/paper_trail/model_config.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# frozen_string_literal: true

require "paper_trail/active_record_version_concern"

module PaperTrail
# Configures an ActiveRecord model, mostly at application boot time, but also
# sometimes mid-request, with methods like enable/disable.
Expand Down Expand Up @@ -158,7 +156,7 @@ def check_version_class_name(options)
# @api private - `version_class_name`
@model_class.class_attribute :version_class_name
if options[:class_name]
ActiveRecordVersionConcern.deprecation.warn(
PaperTrail.deprecator.warn(
format(
DPR_CLASS_NAME_OPTION,
class_name: options[:class_name].inspect
Expand Down Expand Up @@ -194,7 +192,7 @@ def define_has_many_versions(options)
def ensure_versions_option_is_hash(options)
unless options[:versions].is_a?(Hash)
if options[:versions]
ActiveRecordVersionConcern.deprecation.warn(
PaperTrail.deprecator.warn(
format(
DPR_PASSING_ASSOC_NAME_DIRECTLY_TO_VERSIONS_OPTION,
versions_name: options[:versions].inspect
Expand Down
2 changes: 1 addition & 1 deletion paper_trail.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ has been destroyed.
# PT supports request_store versions for 3 years.
s.add_dependency "request_store", "~> 1.4"

s.add_development_dependency "appraisal", "~> 2.4.1"
s.add_development_dependency "appraisal", "~> 2.5"
s.add_development_dependency "byebug", "~> 11.1"
s.add_development_dependency "ffaker", "~> 2.20"
s.add_development_dependency "generator_spec", "~> 0.9.4"
Expand Down
8 changes: 4 additions & 4 deletions spec/paper_trail/model_config_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ module PaperTrail
describe "has_paper_trail" do
describe "versions:" do
it "name can be passed instead of an options hash", :deprecated do
allow(ActiveRecordVersionConcern.deprecation).to receive(:warn)
allow(PaperTrail.deprecator).to receive(:warn)
klass = Class.new(ApplicationRecord) do
has_paper_trail versions: :drafts
end
expect(klass.reflect_on_association(:drafts)).to be_a(
ActiveRecord::Reflection::HasManyReflection
)
expect(ActiveRecordVersionConcern.deprecation).to have_received(:warn).once.with(
expect(PaperTrail.deprecator).to have_received(:warn).once.with(
a_string_starting_with("Passing versions association name"),
array_including(/#{__FILE__}:/)
)
Expand Down Expand Up @@ -78,14 +78,14 @@ module PaperTrail

describe "class_name:" do
it "can be used instead of versions: {class_name: ...}", :deprecated do
allow(ActiveRecordVersionConcern.deprecation).to receive(:warn)
allow(PaperTrail.deprecator).to receive(:warn)
klass = Class.new(ApplicationRecord) do
has_paper_trail class_name: "NoObjectVersion"
end
expect(klass.reflect_on_association(:versions).options[:class_name]).to eq(
"NoObjectVersion"
)
expect(ActiveRecordVersionConcern.deprecation).to have_received(:warn).once.with(
expect(PaperTrail.deprecator).to have_received(:warn).once.with(
a_string_starting_with("Passing Version class name"),
array_including(/#{__FILE__}:/)
)
Expand Down