Lint: Style/FrozenStringLiteralComment

.rubocop_todo.yml

@@ -12,13 +12,6 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 9 # Goal: 7
 
-# Switching to frozen strings internally would be fine, but if any of those
-# frozen strings cross our public API, that would be a breaking change.
-# Let's wait until we drop support for ruby 2.2 before doing this. If we freeze
-# before dropping 2.2, the comment could be misleading.
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 RSpec/InstanceVariable:
   Exclude:
     - spec/paper_trail/associations_spec.rb

Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Specify here only version constraints that differ from
 # `paper_trail.gemspec`.
 #

CHANGELOG.md

@@ -9,6 +9,7 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 - Drop support for ruby 2.2, [whose EoL is the end of March,
   2018](https://www.ruby-lang.org/en/news/2017/09/14/ruby-2-2-8-released/)
+- Assume that all strings returned by PaperTrail are frozen.
 - Removed deprecated `Version#originator`, use `#paper_trail_originator`
 - Using paper_trail.on_destroy(:after) with ActiveRecord's
   belongs_to_required_by_default will produce an error instead of a warning.

Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler"
 Bundler::GemHelper.install_tasks
 

doc/bug_report_template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Use this template to report PaperTrail bugs.
 # Please include only the minimum code necessary to reproduce your issue.
 require "bundler/inline"

lib/generators/paper_trail/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators"
 require "rails/generators/active_record"
 

lib/paper_trail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support"
 require "request_store"
 require "paper_trail/cleaner"

lib/paper_trail/attribute_serializers/attribute_serializer_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paper_trail/type_serializers/postgres_array_serializer"
 
 module PaperTrail
@@ -7,7 +9,7 @@ module PaperTrail
     # replaces certain default Active Record serializers
     # with custom PaperTrail ones.
     module AttributeSerializerFactory
-      AR_PG_ARRAY_CLASS = "ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array".freeze
+      AR_PG_ARRAY_CLASS = "ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array"
 
       def self.for(klass, attr)
         active_record_serializer = klass.type_for_attribute(attr)

lib/paper_trail/attribute_serializers/cast_attribute_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paper_trail/attribute_serializers/attribute_serializer_factory"
 
 module PaperTrail

lib/paper_trail/attribute_serializers/object_attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paper_trail/attribute_serializers/cast_attribute_serializer"
 
 module PaperTrail

lib/paper_trail/attribute_serializers/object_changes_attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paper_trail/attribute_serializers/cast_attribute_serializer"
 
 module PaperTrail

lib/paper_trail/cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   # Utilities for deleting version records.
   module Cleaner

lib/paper_trail/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "singleton"
 require "paper_trail/serializers/yaml"
 

lib/paper_trail/frameworks/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file only needs to be loaded if the gem is being used outside of Rails,
 # since otherwise the model(s) will get loaded in via the `Rails::Engine`.
 require "paper_trail/frameworks/active_record/models/paper_trail/version_association"

lib/paper_trail/frameworks/active_record/models/paper_trail/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paper_trail/version_concern"
 
 module PaperTrail

lib/paper_trail/frameworks/active_record/models/paper_trail/version_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paper_trail/version_association_concern"
 
 module PaperTrail

lib/paper_trail/frameworks/cucumber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # before hook for Cucumber
 Before do
   PaperTrail.enabled = false

lib/paper_trail/frameworks/rails.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require "paper_trail/frameworks/rails/controller"
 require "paper_trail/frameworks/rails/engine"

lib/paper_trail/frameworks/rails/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Rails
     # Extensions to rails controllers. Provides convenient ways to pass certain

lib/paper_trail/frameworks/rails/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Rails
     # See http://guides.rubyonrails.org/engines.html

lib/paper_trail/frameworks/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rspec/core"
 require "rspec/matchers"
 require "paper_trail/frameworks/rspec/helpers"

lib/paper_trail/frameworks/rspec/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module RSpec
     module Helpers

lib/paper_trail/has_paper_trail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/object" # provides the `try` method
 require "paper_trail/attribute_serializers/object_attribute"
 require "paper_trail/attribute_serializers/object_changes_attribute"

lib/paper_trail/model_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext"
 
 module PaperTrail

lib/paper_trail/queries/versions/where_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Queries
     module Versions

lib/paper_trail/queries/versions/where_object_changes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Queries
     module Versions

lib/paper_trail/record_history.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   # Represents the history of a single record.
   # @api private

lib/paper_trail/record_trail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   # Represents the "paper trail" for a single record.
   class RecordTrail

lib/paper_trail/reifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "paper_trail/attribute_serializers/object_attribute"
 require "paper_trail/reifiers/belongs_to"
 require "paper_trail/reifiers/has_and_belongs_to_many"

lib/paper_trail/reifiers/belongs_to.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Reifiers
     # Reify a single `belongs_to` association of `model`.

lib/paper_trail/reifiers/has_and_belongs_to_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Reifiers
     # Reify a single HABTM association of `model`.

lib/paper_trail/reifiers/has_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Reifiers
     # Reify a single, direct (not `through`) `has_many` association of `model`.

lib/paper_trail/reifiers/has_many_through.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Reifiers
     # Reify a single HMT association of `model`.

lib/paper_trail/reifiers/has_one.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module Reifiers
     # Reify a single `has_one` association of `model`.

lib/paper_trail/serializers/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/json"
 
 module PaperTrail

lib/paper_trail/serializers/yaml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 module PaperTrail

lib/paper_trail/type_serializers/postgres_array_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   module TypeSerializers
     # Provides an alternative method of serialization

lib/paper_trail/version_association_concern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/concern"
 
 module PaperTrail

lib/paper_trail/version_concern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/concern"
 require "paper_trail/attribute_serializers/object_changes_attribute"
 require "paper_trail/queries/versions/where_object"

lib/paper_trail/version_number.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaperTrail
   # The version number of the paper_trail gem. Not to be confused with
   # `PaperTrail::Version`. Ruby constants are case-sensitive, apparently,

paper_trail.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "paper_trail/version_number"
 

spec/controllers/articles_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 RSpec.describe ArticlesController, type: :controller do

spec/controllers/widgets_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 RSpec.describe WidgetsController, type: :controller, versioning: true do

spec/dummy_app/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 

spec/dummy_app/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   protect_from_forgery
 

spec/dummy_app/app/controllers/articles_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ArticlesController < ApplicationController
   def create
     @article = Article.create article_params

spec/dummy_app/app/controllers/test_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class TestController < ActionController::Base
   def user_for_paper_trail
     Thread.current.object_id

spec/dummy_app/app/controllers/widgets_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class WidgetsController < ApplicationController
   def paper_trail_enabled_for_controller
     request.user_agent != "Disable User-Agent"

spec/dummy_app/app/models/animal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Animal < ActiveRecord::Base
   has_paper_trail
   self.inheritance_column = "species"

spec/dummy_app/app/models/article.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Demonstrates the `only` and `ignore` attributes, among other things.
 class Article < ActiveRecord::Base
   has_paper_trail(

spec/dummy_app/app/models/authorship.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Authorship < ActiveRecord::Base
   belongs_to :book
   belongs_to :author, class_name: "Person"

spec/dummy_app/app/models/bar_habtm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class BarHabtm < ActiveRecord::Base
   has_and_belongs_to_many :foo_habtms
   has_paper_trail

spec/dummy_app/app/models/book.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Book < ActiveRecord::Base
   has_many :authorships, dependent: :destroy
   has_many :authors, through: :authorships

spec/dummy_app/app/models/boolit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Boolit < ActiveRecord::Base
   default_scope { where(scoped: true) }
   has_paper_trail

spec/dummy_app/app/models/callback_modifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CallbackModifier < ActiveRecord::Base
   has_paper_trail on: []
 

spec/dummy_app/app/models/car.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Car < Vehicle
   has_paper_trail
 end

spec/dummy_app/app/models/cat.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Cat < Animal
 end

spec/dummy_app/app/models/chapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Chapter < ActiveRecord::Base
   has_many :sections, dependent: :destroy
   has_many :paragraphs, through: :sections

spec/dummy_app/app/models/citation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Citation < ActiveRecord::Base
   belongs_to :quotation
 

spec/dummy_app/app/models/custom_primary_key_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "securerandom"
 
 class CustomPrimaryKeyRecord < ActiveRecord::Base

spec/dummy_app/app/models/customer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Customer < ActiveRecord::Base
   has_many :orders, dependent: :destroy
   has_paper_trail

spec/dummy_app/app/models/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Demonstrates a "custom versions association name". Instead of the assication
 # being named `versions`, it will be named `paper_trail_versions`.
 class Document < ActiveRecord::Base

spec/dummy_app/app/models/dog.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Dog < Animal
 end

spec/dummy_app/app/models/editor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # to demonstrate a has_through association that does not have paper_trail enabled
 class Editor < ActiveRecord::Base
   has_many :editorships, dependent: :destroy

spec/dummy_app/app/models/editorship.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Editorship < ActiveRecord::Base
   belongs_to :book
   belongs_to :editor

spec/dummy_app/app/models/elephant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Elephant < Animal
   paper_trail.disable
 end

spec/dummy_app/app/models/family/family.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Family
   class Family < ActiveRecord::Base
     has_paper_trail

spec/dummy_app/app/models/family/family_line.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Family
   class FamilyLine < ActiveRecord::Base
     has_paper_trail

spec/dummy_app/app/models/fluxor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Fluxor < ActiveRecord::Base
   if ActiveRecord.gem_version >= Gem::Version.new("5.0")
     belongs_to :widget, optional: true

spec/dummy_app/app/models/foo_habtm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class FooHabtm < ActiveRecord::Base
   has_and_belongs_to_many :bar_habtms
   accepts_nested_attributes_for :bar_habtms

spec/dummy_app/app/models/foo_widget.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class FooWidget < Widget
 end

spec/dummy_app/app/models/fruit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Fruit < ActiveRecord::Base
   if ENV["DB"] == "postgres" || JsonVersion.table_exists?
     has_paper_trail class_name: "JsonVersion"

spec/dummy_app/app/models/gadget.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gadget < ActiveRecord::Base
   has_paper_trail ignore: :brand
 end

spec/dummy_app/app/models/kitchen/banana.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kitchen
   class Banana < ActiveRecord::Base
     has_paper_trail class_name: "Kitchen::BananaVersion"

spec/dummy_app/app/models/legacy_widget.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The `legacy_widgets` table has a `version` column that would conflict with our
 # `version` method. It is configured to define a method named `custom_version`
 # instead.

spec/dummy_app/app/models/line_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class LineItem < ActiveRecord::Base
   belongs_to :order, dependent: :destroy
   has_paper_trail

spec/dummy_app/app/models/not_on_update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This model does not record versions when updated.
 class NotOnUpdate < ActiveRecord::Base
   has_paper_trail on: %i[create destroy]

spec/dummy_app/app/models/on/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module On
   class Create < ActiveRecord::Base
     self.table_name = :on_create

spec/dummy_app/app/models/on/destroy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module On
   class Destroy < ActiveRecord::Base
     self.table_name = :on_destroy

spec/dummy_app/app/models/on/empty_array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module On
   class EmptyArray < ActiveRecord::Base
     self.table_name = :on_empty_array

spec/dummy_app/app/models/on/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module On
   class Update < ActiveRecord::Base
     self.table_name = :on_update

spec/dummy_app/app/models/order.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Order < ActiveRecord::Base
   belongs_to :customer
   has_many :line_items

spec/dummy_app/app/models/paragraph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Paragraph < ActiveRecord::Base
   belongs_to :section
 

spec/dummy_app/app/models/person.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Person < ActiveRecord::Base
   has_many :authorships, foreign_key: :author_id, dependent: :destroy
   has_many :books, through: :authorships

spec/dummy_app/app/models/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Post < ActiveRecord::Base
   has_paper_trail class_name: "PostVersion"
 end

spec/dummy_app/app/models/post_with_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This model tests ActiveRecord::Enum, which was added in AR 4.1
 # http://edgeguides.rubyonrails.org/4_1_release_notes.html#active-record-enums
 class PostWithStatus < ActiveRecord::Base

spec/dummy_app/app/models/quotation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Quotation < ActiveRecord::Base
   belongs_to :chapter
   has_many :citations, dependent: :destroy

spec/dummy_app/app/models/section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Section < ActiveRecord::Base
   belongs_to :chapter
   has_many :paragraphs, dependent: :destroy

spec/dummy_app/app/models/skipper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Skipper < ActiveRecord::Base
   has_paper_trail ignore: [:created_at], skip: [:another_timestamp]
 end

spec/dummy_app/app/models/song.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OverrideSongAttributesTheRails4Way
   def attributes
     if name

spec/dummy_app/app/models/thing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Thing < ActiveRecord::Base
   has_paper_trail save_changes: false
 end

spec/dummy_app/app/models/translation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Demonstrates the `if` and `unless` configuration options.
 class Translation < ActiveRecord::Base
   # Has a `type` column, but it's not used for STI.

spec/dummy_app/app/models/truck.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Truck < Vehicle
   # This STI child class specifically does not call `has_paper_trail`.
   # Of the sub-classes of `Vehicle`, only `Car` is versioned.

spec/dummy_app/app/models/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PostgresUser < ActiveRecord::Base
   has_paper_trail
 end

spec/dummy_app/app/models/vehicle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Vehicle < ActiveRecord::Base
   # This STI parent class specifically does not call `has_paper_trail`.
   # Of its sub-classes, only `Car` is versioned.

spec/dummy_app/app/models/whatchamajigger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Whatchamajigger < ActiveRecord::Base
   has_paper_trail
 

spec/dummy_app/app/models/widget.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class Widget < ActiveRecord::Base
-  EXCLUDED_NAME = "Biglet".freeze
+  EXCLUDED_NAME = "Biglet"
   has_paper_trail
   has_one :wotsit
   has_many(:fluxors, -> { order(:name) })

spec/dummy_app/app/models/wotsit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Wotsit < ActiveRecord::Base
   has_paper_trail
 

spec/dummy_app/app/versions/custom_primary_key_record_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CustomPrimaryKeyRecordVersion < PaperTrail::Version
   self.table_name = "custom_primary_key_record_versions"
 end