exception_handling 2.2.1 → 2.3.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 925c7332d4385df7c8ccd52f2df818d887e31d64a643c99cc5e682d89ddba535
-  data.tar.gz: 54df02d0d0cedea56c2495de72b2bcf706d2f703111bb46cb80deb34a026d8df
+SHA1:
+  metadata.gz: 1538b60821d54ce39c0d24c94378f147f3c1cdea
+  data.tar.gz: d34346f81571519472db2dfd77d94fec6e31cdec
 SHA512:
-  metadata.gz: bd8d879e6ea219dbaa979d7436ab30f409f1942277b275fcc6d957d84095da84e14bf6620c4b834d5562012b5abcf6767da3d3a872142d5251f927ffe129191a
-  data.tar.gz: 1a2f9e4c18b47d01919e50ab6c69ef182068b38ff5f9e4656fd6123fcac53d404ce0042c6b23a2aef19791f02dffc248c03a08067a386050ccdd02fb1055657b
+  metadata.gz: f588ceffb08a99941eb044c48c1de3d843fd9dfdfa6863bb778e95e099a2a7b29ad9081e66d4ec36ffe1cae2c91028d812c2af173e06ba444502ca41fe3c1829
+  data.tar.gz: 0f376e25489540e95224a17c0b1a86ddeb1a7a1fe544f8391c3deef4a74c66068170510ef1f733e83e936461cdb7230214774c8b62397ec4fd1d45f3e6bb76eb

data/.gitignore

@@ -1,2 +1,3 @@
 .idea
 .DS_Store
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,5 @@
+# This rubocop config file inherits from our centralized style-guide repository.
+# If you are looking to update the ruby style guide, be sure to both update the rubocop config
+# as well as the README.md
+# https://github.com/Invoca/style-guide/tree/master/ruby
+inherit_from: https://raw.githubusercontent.com/Invoca/style-guide/master/ruby/.rubocop.yml

data/Gemfile

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in attr_default.gemspec
 gemspec
 
-gem 'hobo_support',   '2.0.1',      git: 'git@github.com:Invoca/hobosupport',    ref: 'b9086322274b474a2b5bae507c4885e55d4aa050'
-gem 'invoca-utils',                 git: 'git@github.com:Invoca/invoca-utils',   ref: '891b8f7e1af0f6324bf85601046907143122e204'
-gem 'activesupport', '>= 4.2.11.1'
-gem 'actionpack',    '>= 4.2.11.1'
 gem 'actionmailer',  '>= 4.2.11.1'
+gem 'actionpack',    '>= 4.2.11.1'
+gem 'activesupport', '>= 4.2.11.1'
 
 group :development do
+  gem 'pry'
   gem 'rake',    '>=0.9'
-  gem 'shoulda', '> 3.1.1'
   gem 'rr'
-  gem 'pry'
+  gem 'rubocop'
+  gem 'shoulda', '> 3.1.1'
 end
 
 group :test do

data/Gemfile.lock

@@ -1,11 +1,3 @@
-GIT
-  remote: git@github.com:Invoca/hobosupport
-  revision: b9086322274b474a2b5bae507c4885e55d4aa050
-  ref: b9086322274b474a2b5bae507c4885e55d4aa050
-  specs:
-    hobo_support (2.0.1)
-      rails (~> 4.2.10)
-
 GIT
   remote: git@github.com:Invoca/honeybadger-ruby
   revision: bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6
@@ -13,17 +5,10 @@ GIT
   specs:
     honeybadger (3.3.1.pre.1)
 
-GIT
-  remote: git@github.com:Invoca/invoca-utils
-  revision: 891b8f7e1af0f6324bf85601046907143122e204
-  ref: 891b8f7e1af0f6324bf85601046907143122e204
-  specs:
-    invoca-utils (0.0.3)
-
 PATH
   remote: .
   specs:
-    exception_handling (2.2.1)
+    exception_handling (2.3.0.pre.1)
       actionmailer (~> 4.2)
       actionpack (~> 4.2)
       activesupport (~> 4.2)
@@ -70,19 +55,25 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     arel (6.0.4)
+    ast (2.4.0)
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    contextual_logger (0.2.1)
+    contextual_logger (0.3.1)
+      activesupport
       json
     crass (1.0.4)
     erubis (2.7.0)
     eventmachine (1.2.7)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
+    hobo_support (2.2.6)
+      rails (~> 4.2.6)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    json (2.2.0)
+    invoca-utils (0.0.5)
+    jaro_winkler (1.5.3)
+    json (2.3.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -92,8 +83,11 @@ GEM
     mini_mime (1.0.1)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nokogiri (1.10.3)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -124,8 +118,17 @@ GEM
       activesupport (= 4.2.11.1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
     rake (12.3.2)
     rr (1.2.1)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
     shoulda (3.6.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (~> 3.0)
@@ -139,10 +142,11 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -152,13 +156,12 @@ DEPENDENCIES
   actionpack (>= 4.2.11.1)
   activesupport (>= 4.2.11.1)
   exception_handling!
-  hobo_support (= 2.0.1)!
   honeybadger (= 3.3.1.pre.1)!
-  invoca-utils!
   pry
   rake (>= 0.9)
   rr
+  rubocop
   shoulda (> 3.1.1)
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -31,7 +31,6 @@ For example:
 
     # optional
     ExceptionHandling.escalation_recipients   = ['escalation@example.com']
-    ExceptionHandling.mailer_send_enabled     = true # false, will disable exception emails
     ExceptionHandling.filter_list_filename    = "#{Rails.root}/config/exception_filters.yml"
     ExceptionHandling.email_environment       = Rails.env
     ExceptionHandling.eventmachine_safe       = false

data/Rakefile

@@ -1,9 +1,10 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
 namespace :test do
-
   Rake::TestTask.new do |t|
     t.name = :unit
     t.libs << "test"
@@ -11,8 +12,7 @@ namespace :test do
     t.verbose = true
   end
   Rake::Task['test:unit'].comment = "Run the unit tests"
-
 end
 
-task :test    => 'test:unit'
-task :default => 'test'
+task test: 'test:unit'
+task default: 'test'

data/config/exception_filters.yml

@@ -1,7 +1,6 @@
 --- !map:HashWithIndifferentAccess
-Test BS:
-  error: "Some BS"
-  send_email: true
+Test Exception:
+  error: "Some Exception"
   notes: "this is used by a test"
   send_to_honeybadger: true
 

data/exception_handling.gemspec

@@ -1,24 +1,26 @@
-require File.expand_path('../lib/exception_handling/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/exception_handling/version', __dir__)
 
 Gem::Specification.new do |spec|
   spec.authors       = ["Colin Kelley"]
   spec.email         = ["colindkelley@gmail.com"]
-  spec.description   = %q{Exception handling logger/emailer}
-  spec.summary       = %q{Invoca's exception handling logger/emailer layer, based on exception_notifier. Works with Rails or EventMachine or EventMachine+Synchrony.}
+  spec.description   = 'Exception handling logger/emailer'
+  spec.summary       = "Invoca's exception handling logger/emailer layer, based on exception_notifier. Works with Rails or EventMachine or EventMachine+Synchrony."
   spec.homepage      = "https://github.com/Invoca/exception_handling"
 
-  spec.files         = `git ls-files`.split($\)
-  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/.*\.rb})
   spec.name          = "exception_handling"
   spec.require_paths = ["lib"]
   spec.version       = ExceptionHandling::VERSION
 
-  spec.add_dependency 'eventmachine',  '~> 1.0'
-  spec.add_dependency 'activesupport', '~> 4.2'
-  spec.add_dependency 'actionpack',    '~> 4.2'
   spec.add_dependency 'actionmailer',  '~> 4.2'
-  spec.add_dependency 'invoca-utils',  '~> 0.0'
-  spec.add_dependency 'hobo_support'
+  spec.add_dependency 'actionpack',    '~> 4.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
   spec.add_dependency 'contextual_logger'
+  spec.add_dependency 'eventmachine',  '~> 1.0'
+  spec.add_dependency 'hobo_support'
+  spec.add_dependency 'invoca-utils',  '~> 0.0'
 end

data/lib/exception_handling/exception_catalog.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module ExceptionHandling
   class ExceptionCatalog
 
     def initialize(filter_path)
       @filter_path = filter_path
-      @filters = { }
+      @filters = {}
       @filters_last_modified_time = nil
     end
 
@@ -21,7 +23,6 @@ module ExceptionHandling
           load_file
         end
       end
-
     rescue => ex # any exceptions
       # DO NOT CALL ExceptionHandling.log_error because this method is called from that.  It can loop and cause mayhem.
       ExceptionHandling.write_exception_to_log(ex, "ExceptionCatalog#refresh_filters: #{@filter_path}", Time.now.to_i)
@@ -30,9 +31,9 @@ module ExceptionHandling
     def load_file
       @filters_last_modified_time = last_modified_time # make race condition fall on the side of reloading unnecessarily next time rather than missing a set of changes
 
-      filters = YAML::load_file(@filter_path)
+      filters = YAML.load_file(@filter_path)
       filter_hash_values = filters.map { |filter_name, regexes|  [filter_name.to_sym, ExceptionDescription.new(filter_name.to_sym, regexes.symbolize_keys)] }
-      @filters = Hash[ filter_hash_values ]
+      @filters = Hash[filter_hash_values]
     end
 
     def last_modified_time

data/lib/exception_handling/exception_description.rb

@@ -1,59 +1,59 @@
+# frozen_string_literal: true
+
 module ExceptionHandling
   class ExceptionDescription
-    MATCH_SECTIONS =  [:error, :request, :session, :environment, :backtrace, :event_response]
+    MATCH_SECTIONS = [:error, :request, :session, :environment, :backtrace, :event_response].freeze
 
     CONFIGURATION_SECTIONS = {
-        send_email:           false,  # should email be sent?
-        send_to_honeybadger:  false,  # should be sent to honeybadger?
-        send_metric:          true,   # should the metric be sent.
-        metric_name:          nil,    # Will be derived from section name if not passed
-        notes:                nil     # Will be included in exception email if set, used to keep notes and relevant links
-    }
+      send_to_honeybadger: false,  # should be sent to honeybadger?
+      send_metric: true,   # should the metric be sent.
+      metric_name: nil,    # Will be derived from section name if not passed
+      notes: nil     # Will be included in exception email if set, used to keep notes and relevant links
+    }.freeze
 
-    attr_reader :filter_name, :send_email, :send_to_honeybadger, :send_metric, :metric_name, :notes
+    attr_reader :filter_name, :send_to_honeybadger, :send_metric, :metric_name, :notes
 
     def initialize(filter_name, configuration)
       @filter_name = filter_name
 
       invalid_sections = configuration.except(*(CONFIGURATION_SECTIONS.keys + MATCH_SECTIONS))
-      invalid_sections.empty? or raise ArgumentError, "Unknown section: #{invalid_sections.keys.join(",")}"
+      invalid_sections.empty? or raise ArgumentError, "Unknown section: #{invalid_sections.keys.join(',')}"
 
       @configuration = CONFIGURATION_SECTIONS.merge(configuration)
-      @send_email  = @configuration[:send_email]
       @send_to_honeybadger = @configuration[:send_to_honeybadger]
       @send_metric = @configuration[:send_metric]
-      @metric_name = (@configuration[:metric_name] || @filter_name ).to_s.gsub(" ","_")
+      @metric_name = (@configuration[:metric_name] || @filter_name).to_s.gsub(" ", "_")
       @notes       = @configuration[:notes]
 
-      regex_config = @configuration.reject { |k,v| k.in?(CONFIGURATION_SECTIONS.keys) || v.blank? }
+      regex_config = @configuration.reject { |k, v| k.in?(CONFIGURATION_SECTIONS.keys) || v.blank? }
 
-      @regexes = Hash[regex_config.map { |section, regex| [section, Regexp.new(regex, Regexp::IGNORECASE | Regexp::MULTILINE) ] }]
+      @regexes = Hash[regex_config.map { |section, regex| [section, Regexp.new(regex, Regexp::IGNORECASE | Regexp::MULTILINE)] }]
 
       !@regexes.empty? or raise ArgumentError, "Filter #{filter_name} has all blank regexes: #{configuration.inspect}"
     end
 
     def exception_data
       {
-          "send_metric" => send_metric,
-          "metric_name" => metric_name,
-          "notes"       => notes
+        "send_metric" => send_metric,
+        "metric_name" => metric_name,
+        "notes" => notes
       }
     end
 
     def match?(exception_data)
       @regexes.all? do |section, regex|
-          case target = exception_data[section.to_s] || exception_data[section]
-          when String
-            regex =~ target
-          when Array
-            target.any? { |row| row =~ regex }
-          when Hash
-            target[:to_s] =~ regex
-          when NilClass
-            false
-          else
-            raise "Unexpected class #{exception_data[section].class.name}"
-          end
+        case target = exception_data[section.to_s] || exception_data[section]
+        when String
+          regex =~ target
+        when Array
+          target.any? { |row| row =~ regex }
+        when Hash
+          target[:to_s] =~ regex
+        when NilClass
+          false
+        else
+          raise "Unexpected class #{exception_data[section].class.name}"
+        end
       end
     end
   end

data/lib/exception_handling/exception_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionHandling
   class ExceptionInfo
 
@@ -6,47 +8,45 @@ module ExceptionHandling
       /^QUERY_/,
       /^REQUEST_/,
       /^SERVER_/
-    ]
-
-    ENVIRONMENT_OMIT =(
-<<EOF
-CONTENT_TYPE: application/x-www-form-urlencoded
-GATEWAY_INTERFACE: CGI/1.2
-HTTP_ACCEPT: */*
-HTTP_ACCEPT: */*, text/javascript, text/html, application/xml, text/xml, */*
-HTTP_ACCEPT_CHARSET: ISO-8859-1,utf-8;q=0.7,*;q=0.7
-HTTP_ACCEPT_ENCODING: gzip, deflate
-HTTP_ACCEPT_ENCODING: gzip,deflate
-HTTP_ACCEPT_LANGUAGE: en-us
-HTTP_CACHE_CONTROL: no-cache
-HTTP_CONNECTION: Keep-Alive
-HTTP_HOST: www.invoca.com
-HTTP_MAX_FORWARDS: 10
-HTTP_UA_CPU: x86
-HTTP_VERSION: HTTP/1.1
-HTTP_X_FORWARDED_HOST: www.invoca.com
-HTTP_X_FORWARDED_SERVER: www2.invoca.com
-HTTP_X_REQUESTED_WITH: XMLHttpRequest
-LANG:
-PATH: /sbin:/usr/sbin:/bin:/usr/bin
-PWD: /
-RAILS_ENV: production
-RAW_POST_DATA: id=500
-REMOTE_ADDR: 10.251.34.225
-SCRIPT_NAME: /
-SERVER_NAME: www.invoca.com
-SERVER_PORT: 80
-SERVER_PROTOCOL: HTTP/1.1
-SERVER_SOFTWARE: Mongrel 1.1.4
-SHLVL: 1
-TERM: linux
-TERM: xterm-color
-_: /usr/bin/mongrel_cluster_ctl
-EOF
-      ).split("\n")
-
-    SECTIONS = [:request, :session, :environment, :backtrace, :event_response]
-    HONEYBADGER_CONTEXT_SECTIONS = [:timestamp, :error_class, :exception_context, :server, :scm_revision, :notes, :user_details, :request, :session, :environment, :backtrace, :event_response]
+    ].freeze
+
+    ENVIRONMENT_OMIT = <<~EOS.split("\n")
+      CONTENT_TYPE: application/x-www-form-urlencoded
+      GATEWAY_INTERFACE: CGI/1.2
+      HTTP_ACCEPT: */*
+      HTTP_ACCEPT: */*, text/javascript, text/html, application/xml, text/xml, */*
+      HTTP_ACCEPT_CHARSET: ISO-8859-1,utf-8;q=0.7,*;q=0.7
+      HTTP_ACCEPT_ENCODING: gzip, deflate
+      HTTP_ACCEPT_ENCODING: gzip,deflate
+      HTTP_ACCEPT_LANGUAGE: en-us
+      HTTP_CACHE_CONTROL: no-cache
+      HTTP_CONNECTION: Keep-Alive
+      HTTP_HOST: www.invoca.com
+      HTTP_MAX_FORWARDS: 10
+      HTTP_UA_CPU: x86
+      HTTP_VERSION: HTTP/1.1
+      HTTP_X_FORWARDED_HOST: www.invoca.com
+      HTTP_X_FORWARDED_SERVER: www2.invoca.com
+      HTTP_X_REQUESTED_WITH: XMLHttpRequest
+      LANG:
+      PATH: /sbin:/usr/sbin:/bin:/usr/bin
+      PWD: /
+      RAILS_ENV: production
+      RAW_POST_DATA: id=500
+      REMOTE_ADDR: 10.251.34.225
+      SCRIPT_NAME: /
+      SERVER_NAME: www.invoca.com
+      SERVER_PORT: 80
+      SERVER_PROTOCOL: HTTP/1.1
+      SERVER_SOFTWARE: Mongrel 1.1.4
+      SHLVL: 1
+      TERM: linux
+      TERM: xterm-color
+      _: /usr/bin/mongrel_cluster_ctl
+    EOS
+
+    SECTIONS = [:request, :session, :environment, :backtrace, :event_response].freeze
+    HONEYBADGER_CONTEXT_SECTIONS = [:timestamp, :error_class, :exception_context, :server, :scm_revision, :notes, :user_details, :request, :session, :environment, :backtrace, :event_response].freeze
 
     attr_reader :exception, :controller, :exception_context, :timestamp
 
@@ -71,13 +71,19 @@ EOF
     end
 
     def send_to_honeybadger?
-      ExceptionHandling.honeybadger? && (!exception_description || exception_description.send_to_honeybadger)
+      ExceptionHandling.honeybadger_defined? && (!exception_description || exception_description.send_to_honeybadger)
     end
 
     def honeybadger_context_data
       @honeybadger_context_data ||= enhanced_data_to_honeybadger_context
     end
 
+    def controller_name
+      @controller_name ||= if @controller
+                             @controller.request.parameters.with_indifferent_access[:controller]
+                           end.to_s
+    end
+
     private
 
     def controller_from_context(exception_context)
@@ -88,10 +94,10 @@ EOF
       exception_message = @exception.message.to_s
       data = ActiveSupport::HashWithIndifferentAccess.new
       data[:error_class] = @exception.class.name
-      data[:error_string]= "#{data[:error_class]}: #{ExceptionHandling.encode_utf8(exception_message)}"
+      data[:error_string] = "#{data[:error_class]}: #{ExceptionHandling.encode_utf8(exception_message)}"
       data[:timestamp]   = @timestamp
       data[:backtrace]   = ExceptionHandling.clean_backtrace(@exception)
-      if @exception_context && @exception_context.is_a?(Hash)
+      if @exception_context&.is_a?(Hash)
         # if we are a hash, then we got called from the DebugExceptions rack middleware filter
         # and we need to do some things different to get the info we want
         data[:error] = "#{data[:error_class]}: #{ExceptionHandling.encode_utf8(exception_message)}"
@@ -118,7 +124,8 @@ EOF
     end
 
     def enhance_exception_data(data)
-      return if ! ExceptionHandling.custom_data_hook
+      return if !ExceptionHandling.custom_data_hook
+
       begin
         ExceptionHandling.custom_data_hook.call(data)
       rescue Exception => ex
@@ -131,28 +138,29 @@ EOF
     def normalize_exception_data(data)
       if data[:location].nil?
         data[:location] = {}
-        if data[:request] && data[:request].key?(:params)
+        if data[:request]&.key?(:params)
           data[:location][:controller] = data[:request][:params]['controller']
           data[:location][:action]     = data[:request][:params]['action']
         end
       end
-      if data[:backtrace] && data[:backtrace].first
+      if data[:backtrace]&.first
         first_line = data[:backtrace].first
 
         # template exceptions have the line number and filename as the first element in backtrace
-        if matched = first_line.match( /on line #(\d*) of (.*)/i )
-          backtrace_hash = {}
-          backtrace_hash[:line] = matched[1]
-          backtrace_hash[:file] = matched[2]
+        if (matched = first_line.match(/on line #(\d*) of (.*)/i))
+          backtrace_hash = {
+            line: matched[1],
+            file: matched[2]
+          }
         else
-          backtrace_hash = Hash[* [:file, :line].zip( first_line.split( ':' )[0..1]).flatten ]
+          backtrace_hash = Hash[* [:file, :line].zip(first_line.split(':')[0..1]).flatten]
         end
 
-        data[:location].merge!( backtrace_hash )
+        data[:location].merge!(backtrace_hash)
       end
     end
 
-    def clean_exception_data( data )
+    def clean_exception_data(data)
       if (as_array = data[:backtrace].to_a).size == 1
         data[:backtrace] = as_array.first.to_s.split(/\n\s*/)
       end
@@ -197,16 +205,16 @@ EOF
     def extract_and_merge_controller_data(data)
       if @controller
         data[:request] = {
-          params:      @controller.request.parameters.to_hash,
-          rails_root:  defined?(Rails) && defined?(Rails.root) ? Rails.root : "Rails.root not defined. Is this a test environment?",
-          url:         @controller.complete_request_uri
+          params: @controller.request.parameters.to_hash,
+          rails_root: defined?(Rails) && defined?(Rails.root) ? Rails.root : "Rails.root not defined. Is this a test environment?",
+          url: @controller.complete_request_uri
         }
         data[:environment].merge!(@controller.request.env.to_hash)
 
         @controller.session[:fault_in_session]
         data[:session] = {
-          key:         @controller.request.session_options[:id],
-          data:        @controller.session.to_hash
+          key: @controller.request.session_options[:id],
+          data: @controller.session.to_hash
         }
       end
     end
@@ -236,22 +244,22 @@ EOF
       end
     end
 
-    def add_to_s( data_section )
-      data_section[:to_s] = dump_hash( data_section )
+    def add_to_s(data_section)
+      data_section[:to_s] = dump_hash(data_section)
     end
 
-    def dump_hash( h, indent_level = 0 )
-      result = ""
-      h.sort { |a, b| a.to_s <=> b.to_s }.each do |key, value|
-        result << ' ' * (2 * indent_level)
-        result << "#{key}:"
-        case value
-        when Hash
-          result << "\n" << dump_hash( value, indent_level + 1 )
-        else
-          result << " #{value}\n"
+    def dump_hash(h, indent_level = 0)
+      result = +""
+      h&.sort { |a, b| a.to_s <=> b.to_s }&.each do |key, value|
+          result << ' ' * (2 * indent_level)
+          result << "#{key}:"
+          case value
+          when Hash
+            result << "\n" << dump_hash(value, indent_level + 1)
+          else
+            result << " #{value}\n"
+          end
         end
-      end unless h.nil?
       result
     end