Merge pull request #3398 from kenhys/section-pretty-print

Support pretty print Fluent::Config::Section for debugging
fluent · May 31, 2021 · 6521cca · 6521cca
2 parents d3eb28e + 224dc26
commit 6521cca
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/lib/fluent/config/section.rb b/lib/fluent/config/section.rb
@@ -50,6 +50,11 @@ def inspect
         "<Fluent::Config::Section #{@params.to_json}>"
       end
 
+      # Used by PP and Pry
+      def pretty_print(q)
+        q.text(inspect)
+      end
+
       def nil?
         false
       end

diff --git a/test/config/test_section.rb b/test/config/test_section.rb
@@ -1,5 +1,6 @@
 require_relative '../helper'
 require 'fluent/config/section'
+require 'pp'
 
 module Fluent::Config
   class TestSection < ::Test::Unit::TestCase
@@ -176,6 +177,14 @@ class TestSection < ::Test::Unit::TestCase
           s1 = Fluent::Config::Section.new(h1)
           assert_equal(expected, s1.respond_to?(method))
         end
+
+        test '#pretty_print' do
+          q = PP.new
+          h1 = {name: "s1", klass: "A"}
+          s1 = Fluent::Config::Section.new(h1)
+          s1.pretty_print(q)
+          assert_equal s1.inspect, q.output
+        end
       end
     end
   end