paper-trail-gem--paper_trail/lib/paper_trail/config.rb

64 lines
2.0 KiB
Ruby

require "singleton"
require "paper_trail/serializers/yaml"
module PaperTrail
# Global configuration affecting all threads. Some thread-specific
# configuration can be found in `paper_trail.rb`, others in `controller.rb`.
class Config
include Singleton
attr_accessor :serializer, :version_limit
attr_writer :track_associations
def initialize
# Variables which affect all threads, whose access is synchronized.
@mutex = Mutex.new
@enabled = true
# Variables which affect all threads, whose access is *not* synchronized.
@serializer = PaperTrail::Serializers::YAML
end
def serialized_attributes
ActiveSupport::Deprecation.warn(
"PaperTrail.config.serialized_attributes is deprecated without " +
"replacement and always returns false."
)
false
end
def serialized_attributes=(_)
ActiveSupport::Deprecation.warn(
"PaperTrail.config.serialized_attributes= is deprecated without " +
"replacement and no longer has any effect."
)
end
# Previously, we checked `PaperTrail::VersionAssociation.table_exists?`
# here, but that proved to be problematic in situations when the database
# connection had not been established, or when the database does not exist
# yet (as with `rake db:create`).
def track_associations?
if @track_associations.nil?
ActiveSupport::Deprecation.warn <<-EOS.strip_heredoc.gsub(/\s+/, " ")
PaperTrail.track_associations has not been set. As of PaperTrail 5, it
defaults to false. Tracking associations is an experimental feature so
we recommend setting PaperTrail.config.track_associations = false in
your config/initializers/paper_trail.rb
EOS
false
else
@track_associations
end
end
# Indicates whether PaperTrail is on or off. Default: true.
def enabled
@mutex.synchronize { !!@enabled }
end
def enabled=(enable)
@mutex.synchronize { @enabled = enable }
end
end
end