From 32b03b46150b0161eba2321ccac7678511e3d58e Mon Sep 17 00:00:00 2001
From: Yoshiyuki Kinjo <kinjo@bita.jp>
Date: Tue, 9 Oct 2018 16:14:51 +0900
Subject: Implement AR#inspect using ParamterFilter.

AR instance support `filter_parameters` since #33756.
Though Regex or Proc is valid as `filter_parameters`,
they are not supported as AR#inspect.

I also add :mask option and #filter_params to
`ActiveSupport::ParameterFilter#new` to implement this.
---
 .../lib/active_record/attribute_methods.rb         | 19 +++++-----
 activerecord/lib/active_record/core.rb             | 41 ++++++++++++----------
 2 files changed, 33 insertions(+), 27 deletions(-)

(limited to 'activerecord/lib/active_record')

diff --git a/activerecord/lib/active_record/attribute_methods.rb b/activerecord/lib/active_record/attribute_methods.rb
index 3c785180e1..1581490f16 100644
--- a/activerecord/lib/active_record/attribute_methods.rb
+++ b/activerecord/lib/active_record/attribute_methods.rb
@@ -336,14 +336,7 @@ module ActiveRecord
     #   # => "[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]"
     def attribute_for_inspect(attr_name)
       value = read_attribute(attr_name)
-
-      if value.is_a?(String) && value.length > 50
-        "#{value[0, 50]}...".inspect
-      elsif value.is_a?(Date) || value.is_a?(Time)
-        %("#{value.to_s(:db)}")
-      else
-        value.inspect
-      end
+      format_for_inspect(value)
     end
 
     # Returns +true+ if the specified +attribute+ has been set by the user or by a
@@ -463,6 +456,16 @@ module ActiveRecord
         end
       end
 
+      def format_for_inspect(value)
+        if value.is_a?(String) && value.length > 50
+          "#{value[0, 50]}...".inspect
+        elsif value.is_a?(Date) || value.is_a?(Time)
+          %("#{value.to_s(:db)}")
+        else
+          value.inspect
+        end
+      end
+
       def readonly_attribute?(name)
         self.class.readonly_attributes.include?(name)
       end
diff --git a/activerecord/lib/active_record/core.rb b/activerecord/lib/active_record/core.rb
index b53681ee20..9780258302 100644
--- a/activerecord/lib/active_record/core.rb
+++ b/activerecord/lib/active_record/core.rb
@@ -2,15 +2,13 @@
 
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/string/filters"
+require "active_support/parameter_filter"
 require "concurrent/map"
-require "set"
 
 module ActiveRecord
   module Core
     extend ActiveSupport::Concern
 
-    FILTERED = "[FILTERED]" # :nodoc:
-
     included do
       ##
       # :singleton-method:
@@ -239,9 +237,7 @@ module ActiveRecord
       end
 
       # Specifies columns which shouldn't be exposed while calling +#inspect+.
-      def filter_attributes=(attributes_names)
-        @filter_attributes = attributes_names.map(&:to_s).to_set
-      end
+      attr_writer :filter_attributes
 
       # Returns a string like 'Post(id:integer, title:string, body:text)'
       def inspect # :nodoc:
@@ -514,11 +510,14 @@ module ActiveRecord
       inspection = if defined?(@attributes) && @attributes
         self.class.attribute_names.collect do |name|
           if has_attribute?(name)
-            if filter_attribute?(name)
-              "#{name}: #{ActiveRecord::Core::FILTERED}"
+            attr = read_attribute(name)
+            value = if attr.nil?
+              attr.inspect
             else
-              "#{name}: #{attribute_for_inspect(name)}"
+              attr = format_for_inspect(attr)
+              inspection_filter.filter_param(name, attr)
             end
+            "#{name}: #{value}"
           end
         end.compact.join(", ")
       else
@@ -534,18 +533,16 @@ module ActiveRecord
       return super if custom_inspect_method_defined?
       pp.object_address_group(self) do
         if defined?(@attributes) && @attributes
-          column_names = self.class.column_names.select { |name| has_attribute?(name) || new_record? }
-          pp.seplist(column_names, proc { pp.text "," }) do |column_name|
+          attr_names = self.class.attribute_names.select { |name| has_attribute?(name) }
+          pp.seplist(attr_names, proc { pp.text "," }) do |attr_name|
             pp.breakable " "
             pp.group(1) do
-              pp.text column_name
+              pp.text attr_name
               pp.text ":"
               pp.breakable
-              if filter_attribute?(column_name)
-                pp.text ActiveRecord::Core::FILTERED
-              else
-                pp.pp read_attribute(column_name)
-              end
+              value = read_attribute(attr_name)
+              value = inspection_filter.filter_param(attr_name, value) unless value.nil?
+              pp.pp value
             end
           end
         else
@@ -597,8 +594,14 @@ module ActiveRecord
         self.class.instance_method(:inspect).owner != ActiveRecord::Base.instance_method(:inspect).owner
       end
 
-      def filter_attribute?(attribute_name)
-        self.class.filter_attributes.include?(attribute_name) && !read_attribute(attribute_name).nil?
+      def inspection_filter
+        @inspection_filter ||= begin
+          mask = DelegateClass(::String).new(ActiveSupport::ParameterFilter::FILTERED)
+          def mask.pretty_print(pp)
+            pp.text __getobj__
+          end
+          ActiveSupport::ParameterFilter.new(self.class.filter_attributes, mask: mask)
+        end
       end
   end
 end
-- 
cgit v1.2.3