honeybadger 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e792f463bd86a18b5499b2e995407f014db4e82
-  data.tar.gz: 868f7529ee321a42dc00f783ab41cf6182262308
+  metadata.gz: a304866efae8f56e2fda056d380f07171ce9a678
+  data.tar.gz: a9e6a086d55d5384d4d776bc5d4e208fd2f34924
 SHA512:
-  metadata.gz: da5baa248b75404411f27261afa1821d7dd721257498a9a5edf299016bf14e28860aa86897c9f71cb0d8becb2e3e089148bdddcf89a32115c363b3340cfafe46
-  data.tar.gz: 47ca59a742c15f5a69df9604483e2c79fd7f8e5cd219ce72440f800dc28584b1676d301e842b293ac92a052aeb01e0dd552c934dbb08e774e7a888017a1c6add
+  metadata.gz: 2126e97c4ffb1162d2840a535e714565be7aa7ff2822755c382a247ff3fb3bf0ecefcc121bd9c97878573d25dbcbac6ea1ae8ade525a628c15d32dd3e705dea7
+  data.tar.gz: 23b99fcda16cfc38ab3e50f5628f96d4bd3a4fe22ea74e576e149ebda236281fb4936cd5ec5445418ee4b8021d6ff9003b936a423cfab0d4ca657b1a872f0ead

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+* Update heroku cli deprecations.
+
+  *@adamkuipers*
+
+* Don't insert middleware if they're disabled.
+
+  *Bradley Priest*
+
+* Don't send RAW_POST_DATA.
+
+  *Joshua Wood*
+
+* Filter HTTP_COOKIE in request cgi_data.
+
+  *Sam McTaggart*
+
+* Fix breakage relating to Exceptions containing a :cause attribute which is not
+  itself an Exception.
+
+  *Gabe da Silveira*
+
+* Support for extracting the correct component & action for Rails Active Jobs (previously all Active Jobs where reported as  'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper')
+
+  *Panos Korros*
+
 * Allow API key to be overridden from `Honeybadger.notify`.
 
   *Joshua Wood*

data/lib/honeybadger/cli/heroku.rb

@@ -29,7 +29,7 @@ module Honeybadger
           exit(1)
         end
 
-        cmd = %Q(heroku addons:add deployhooks:http --url="https://api.honeybadger.io/v1/deploys?deploy[environment]=#{rails_env}&deploy[local_username]={{user}}&deploy[revision]={{head}}&api_key=#{api_key}"#{app ? " --app #{app}" : ''})
+        cmd = %Q(heroku addons:create deployhooks:http --url="https://api.honeybadger.io/v1/deploys?deploy[environment]=#{rails_env}&deploy[local_username]={{user}}&deploy[revision]={{head}}&api_key=#{api_key}"#{app ? " --app #{app}" : ''})
 
         say("Running: `#{cmd}`")
         say(run(cmd))

data/lib/honeybadger/init/rails.rb

@@ -17,8 +17,8 @@ module Honeybadger
             if config.feature?(:notices) && config[:'exceptions.enabled']
               ::Rails.application.config.middleware.tap do |middleware|
                 middleware.insert(0, 'Honeybadger::Rack::ErrorNotifier', config)
-                middleware.insert_before('Honeybadger::Rack::ErrorNotifier', 'Honeybadger::Rack::UserFeedback', config)
-                middleware.insert_before('Honeybadger::Rack::UserFeedback', 'Honeybadger::Rack::UserInformer', config)
+                middleware.insert_before('Honeybadger::Rack::ErrorNotifier', 'Honeybadger::Rack::UserInformer', config) if config[:'user_informer.enabled']
+                middleware.insert_before('Honeybadger::Rack::ErrorNotifier', 'Honeybadger::Rack::UserFeedback', config) if config[:'feedback.enabled']
               end
             end
 

data/lib/honeybadger/notice.rb

@@ -423,11 +423,11 @@ module Honeybadger
     # Returns the Exception cause.
     def exception_cause(exception)
       e = exception
-      if e.respond_to?(:cause) && e.cause
+      if e.respond_to?(:cause) && e.cause && e.cause.is_a?(Exception)
         e.cause
-      elsif e.respond_to?(:original_exception) && e.original_exception
+      elsif e.respond_to?(:original_exception) && e.original_exception && e.original_exception.is_a?(Exception)
         e.original_exception
-      elsif e.respond_to?(:continued_exception) && e.continued_exception
+      elsif e.respond_to?(:continued_exception) && e.continued_exception && e.continued_exception.is_a?(Exception)
         e.continued_exception
       end
     end

data/lib/honeybadger/plugins/delayed_job/plugin.rb

@@ -8,9 +8,17 @@ module Honeybadger
         callbacks do |lifecycle|
           lifecycle.around(:invoke_job) do |job, &block|
             begin
-              begin #buildin suport for Delayed::PerformableMethod
-                component = job.payload_object.object.is_a?(Class) ? job.payload_object.object.name : job.payload_object.object.class.name
-                action    = job.payload_object.method_name.to_s
+
+              begin
+                if job.payload_object.class.name == 'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper'
+                  #buildin support for Rails 4.2 ActiveJob
+                  component = job.payload_object.job_data['job_class']
+                  action = 'perform'
+                else
+                  #buildin support for Delayed::PerformableMethod
+                  component = job.payload_object.object.is_a?(Class) ? job.payload_object.object.name : job.payload_object.object.class.name
+                  action    = job.payload_object.method_name.to_s
+                end
               rescue #fallback to support all other classes
                 component = job.payload_object.class.name
                 action    = 'perform'

data/lib/honeybadger/rack/request_hash.rb

@@ -3,6 +3,10 @@ module Honeybadger
     # Internal: Constructs a request hash from a Rack::Request matching the
     # /v1/notices API specification.
     class RequestHash < ::Hash
+      # Internal
+      CGI_BLACKLIST = ['QUERY_STRING', 'RAW_POST_DATA'].freeze
+      CGI_KEY_REGEXP = /\A[A-Z_]+\Z/
+
       def initialize(request)
         self[:url] = extract_url(request)
         self[:params] = extract_params(request)
@@ -37,7 +41,14 @@ module Honeybadger
       end
 
       def extract_cgi_data(request)
-        request.env.reject {|k,_| k == 'QUERY_STRING' || !k.match(/\A[A-Z_]+\Z/) }
+        request.env.reject {|k,_| cgi_blacklist?(k) }
+      end
+
+      def cgi_blacklist?(key)
+        return true if CGI_BLACKLIST.include?(key)
+        return true unless key.match(CGI_KEY_REGEXP)
+
+        false
       end
     end
   end

data/lib/honeybadger/rack/user_feedback.rb

@@ -26,7 +26,7 @@ module Honeybadger
 
       def call(env)
         status, headers, body = @app.call(env)
-        if enabled? && env['honeybadger.error_id'] && form = render_form(env['honeybadger.error_id'])
+        if env['honeybadger.error_id'] && form = render_form(env['honeybadger.error_id'])
           new_body = []
           body.each do |chunk|
             new_body << chunk.gsub("<!-- HONEYBADGER FEEDBACK -->", form)
@@ -38,10 +38,6 @@ module Honeybadger
         [status, headers, body]
       end
 
-      def enabled?
-        config[:'feedback.enabled']
-      end
-
       def action
         URI.parse("#{config.connection_protocol}://#{config[:'connection.host']}:#{config.connection_port}/v1/feedback/").to_s
       rescue URI::InvalidURIError

data/lib/honeybadger/rack/user_informer.rb

@@ -16,7 +16,7 @@ module Honeybadger
 
       def call(env)
         status, headers, body = @app.call(env)
-        if env['honeybadger.error_id'] && config[:'user_informer.enabled']
+        if env['honeybadger.error_id']
           new_body = []
           replace  = replacement(env['honeybadger.error_id'])
           body.each do |chunk|

data/lib/honeybadger/util/request_payload.rb

@@ -4,7 +4,7 @@ module Honeybadger
   module Util
     # Internal: Constructs/sanitizes request data for notices and traces.
     module RequestPayload
-      # Internal: default values to use for request data.
+      # Internal: Default values to use for request data.
       DEFAULTS = {
         url: nil,
         component: nil,
@@ -14,9 +14,12 @@ module Honeybadger
         cgi_data: {}.freeze
       }.freeze
 
-      # Internal: allowed keys.
+      # Internal: Allowed keys.
       KEYS = DEFAULTS.keys.freeze
 
+      # Internal: The cgi_data key where the raw Cookie header is stored.
+      HTTP_COOKIE_KEY = 'HTTP_COOKIE'.freeze
+
       def self.build(opts = {})
         sanitizer = opts.fetch(:sanitizer) { Sanitizer.new }
 
@@ -28,6 +31,9 @@ module Honeybadger
 
         payload[:session] = opts[:session][:data] if opts[:session] && opts[:session][:data]
         payload[:url] = sanitizer.filter_url(payload[:url]) if payload[:url]
+        if payload[:cgi_data][HTTP_COOKIE_KEY]
+          payload[:cgi_data][HTTP_COOKIE_KEY] = sanitizer.filter_cookies(payload[:cgi_data][HTTP_COOKIE_KEY])
+        end
 
         payload
       end

data/lib/honeybadger/util/sanitizer.rb

@@ -9,6 +9,10 @@ module Honeybadger
 
       MAX_STRING_SIZE = 2048
 
+      COOKIE_PAIRS = /[;,]\s?/
+      COOKIE_SEP = '='.freeze
+      COOKIE_PAIR_SEP = '; '.freeze
+
       def initialize(opts = {})
         @max_depth = opts.fetch(:max_depth, 20)
 
@@ -53,13 +57,26 @@ module Honeybadger
         end
       end
 
+      def filter_cookies(raw_cookies)
+        return raw_cookies unless filters
+
+        cookies = []
+        raw_cookies.split(COOKIE_PAIRS).each do |pair|
+          name, values = pair.split(COOKIE_SEP, 2)
+          values = FILTERED_REPLACEMENT if filter_key?(name)
+          cookies << "#{ name }=#{ values }"
+        end
+
+        cookies.join(COOKIE_PAIR_SEP)
+      end
+
       def filter_url(url)
         return url unless filters
 
         filtered_url = url.to_s.dup
         filtered_url.scan(/(?:^|&|\?)([^=?&]+)=([^&]+)/).each do |m|
           next unless filter_key?(m[0])
-          filtered_url.gsub!(/#{m[1]}/, '[FILTERED]')
+          filtered_url.gsub!(/#{m[1]}/, FILTERED_REPLACEMENT)
         end
 
         filtered_url

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # Public: The current String Honeybadger version.
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -83,39 +83,6 @@ files:
 - vendor/capistrano-honeybadger/lib/capistrano/tasks/deploy.cap
 - vendor/capistrano-honeybadger/lib/honeybadger/capistrano.rb
 - vendor/capistrano-honeybadger/lib/honeybadger/capistrano/legacy.rb
-- vendor/inifile/lib/inifile.rb
-- vendor/thor/lib/thor.rb
-- vendor/thor/lib/thor/actions.rb
-- vendor/thor/lib/thor/actions/create_file.rb
-- vendor/thor/lib/thor/actions/create_link.rb
-- vendor/thor/lib/thor/actions/directory.rb
-- vendor/thor/lib/thor/actions/empty_directory.rb
-- vendor/thor/lib/thor/actions/file_manipulation.rb
-- vendor/thor/lib/thor/actions/inject_into_file.rb
-- vendor/thor/lib/thor/base.rb
-- vendor/thor/lib/thor/command.rb
-- vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb
-- vendor/thor/lib/thor/core_ext/io_binary_read.rb
-- vendor/thor/lib/thor/core_ext/ordered_hash.rb
-- vendor/thor/lib/thor/error.rb
-- vendor/thor/lib/thor/group.rb
-- vendor/thor/lib/thor/invocation.rb
-- vendor/thor/lib/thor/line_editor.rb
-- vendor/thor/lib/thor/line_editor/basic.rb
-- vendor/thor/lib/thor/line_editor/readline.rb
-- vendor/thor/lib/thor/parser.rb
-- vendor/thor/lib/thor/parser/argument.rb
-- vendor/thor/lib/thor/parser/arguments.rb
-- vendor/thor/lib/thor/parser/option.rb
-- vendor/thor/lib/thor/parser/options.rb
-- vendor/thor/lib/thor/rake_compat.rb
-- vendor/thor/lib/thor/runner.rb
-- vendor/thor/lib/thor/shell.rb
-- vendor/thor/lib/thor/shell/basic.rb
-- vendor/thor/lib/thor/shell/color.rb
-- vendor/thor/lib/thor/shell/html.rb
-- vendor/thor/lib/thor/util.rb
-- vendor/thor/lib/thor/version.rb
 homepage: https://github.com/honeybadger-io/honeybadger-ruby
 licenses:
 - MIT

data/vendor/inifile/lib/inifile.rb

@@ -1,628 +0,0 @@
-#encoding: UTF-8
-
-# This class represents the INI file and can be used to parse, modify,
-# and write INI files.
-class IniFile
-  include Enumerable
-
-  class Error < StandardError; end
-  VERSION = '3.0.0'
-
-  # Public: Open an INI file and load the contents.
-  #
-  # filename - The name of the file as a String
-  # opts     - The Hash of options (default: {})
-  #            :comment   - String containing the comment character(s)
-  #            :parameter - String used to separate parameter and value
-  #            :encoding  - Encoding String for reading / writing
-  #            :default   - The String name of the default global section
-  #
-  # Examples
-  #
-  #   IniFile.load('file.ini')
-  #   #=> IniFile instance
-  #
-  #   IniFile.load('does/not/exist.ini')
-  #   #=> nil
-  #
-  # Returns an IniFile instance or nil if the file could not be opened.
-  def self.load( filename, opts = {} )
-    return unless File.file? filename
-    new(opts.merge(:filename => filename))
-  end
-
-  # Get and set the filename
-  attr_accessor :filename
-
-  # Get and set the encoding
-  attr_accessor :encoding
-
-  # Public: Create a new INI file from the given set of options. If :content
-  # is provided then it will be used to populate the INI file. If a :filename
-  # is provided then the contents of the file will be parsed and stored in the
-  # INI file. If neither the :content or :filename is provided then an empty
-  # INI file is created.
-  #
-  # opts - The Hash of options (default: {})
-  #   :content   - The String/Hash containing the INI contents
-  #   :comment   - String containing the comment character(s)
-  #   :parameter - String used to separate parameter and value
-  #   :encoding  - Encoding String for reading / writing
-  #   :default   - The String name of the default global section
-  #   :filename  - The filename as a String
-  #
-  # Examples
-  #
-  #   IniFile.new
-  #   #=> an empty IniFile instance
-  #
-  #   IniFile.new( :content => "[global]\nfoo=bar" )
-  #   #=> an IniFile instance
-  #
-  #   IniFile.new( :filename => 'file.ini', :encoding => 'UTF-8' )
-  #   #=> an IniFile instance
-  #
-  #   IniFile.new( :content => "[global]\nfoo=bar", :comment => '#' )
-  #   #=> an IniFile instance
-  #
-  def initialize( opts = {} )
-    @comment  = opts.fetch(:comment, ';#')
-    @param    = opts.fetch(:parameter, '=')
-    @encoding = opts.fetch(:encoding, nil)
-    @default  = opts.fetch(:default, 'global')
-    @filename = opts.fetch(:filename, nil)
-    content   = opts.fetch(:content, nil)
-
-    @ini = Hash.new {|h,k| h[k] = Hash.new}
-
-    if    content.is_a?(Hash) then merge!(content)
-    elsif content             then parse(content)
-    elsif @filename           then read
-    end
-  end
-
-  # Public: Write the contents of this IniFile to the file system. If left
-  # unspecified, the currently configured filename and encoding will be used.
-  # Otherwise the filename and encoding can be specified in the options hash.
-  #
-  # opts - The default options Hash
-  #        :filename - The filename as a String
-  #        :encoding - The encoding as a String
-  #
-  # Returns this IniFile instance.
-  def write( opts = {} )
-    filename = opts.fetch(:filename, @filename)
-    encoding = opts.fetch(:encoding, @encoding)
-    mode = encoding ? "w:#{encoding}" : "w"
-
-    File.open(filename, mode) do |f|
-      @ini.each do |section,hash|
-        f.puts "[#{section}]"
-        hash.each {|param,val| f.puts "#{param} #{@param} #{escape_value val}"}
-        f.puts
-      end
-    end
-
-    self
-  end
-  alias :save :write
-
-  # Public: Read the contents of the INI file from the file system and replace
-  # and set the state of this IniFile instance. If left unspecified the
-  # currently configured filename and encoding will be used when reading from
-  # the file system. Otherwise the filename and encoding can be specified in
-  # the options hash.
-  #
-  # opts - The default options Hash
-  #        :filename - The filename as a String
-  #        :encoding - The encoding as a String
-  #
-  # Returns this IniFile instance if the read was successful; nil is returned
-  # if the file could not be read.
-  def read( opts = {} )
-    filename = opts.fetch(:filename, @filename)
-    encoding = opts.fetch(:encoding, @encoding)
-    return unless File.file? filename
-
-    mode = encoding ? "r:#{encoding}" : "r"
-    File.open(filename, mode) { |fd| parse fd }
-    self
-  end
-  alias :restore :read
-
-  # Returns this IniFile converted to a String.
-  def to_s
-    s = []
-    @ini.each do |section,hash|
-      s << "[#{section}]"
-      hash.each {|param,val| s << "#{param} #{@param} #{escape_value val}"}
-      s << ""
-    end
-    s.join("\n")
-  end
-
-  # Returns this IniFile converted to a Hash.
-  def to_h
-    @ini.dup
-  end
-
-  # Public: Creates a copy of this inifile with the entries from the
-  # other_inifile merged into the copy.
-  #
-  # other - The other IniFile.
-  #
-  # Returns a new IniFile.
-  def merge( other )
-    self.dup.merge!(other)
-  end
-
-  # Public: Merges other_inifile into this inifile, overwriting existing
-  # entries. Useful for having a system inifile with user overridable settings
-  # elsewhere.
-  #
-  # other - The other IniFile.
-  #
-  # Returns this IniFile.
-  def merge!( other )
-    return self if other.nil?
-
-    my_keys = @ini.keys
-    other_keys = case other
-      when IniFile
-        other.instance_variable_get(:@ini).keys
-      when Hash
-        other.keys
-      else
-        raise Error, "cannot merge contents from '#{other.class.name}'"
-      end
-
-    (my_keys & other_keys).each do |key|
-      case other[key]
-      when Hash
-        @ini[key].merge!(other[key])
-      when nil
-        nil
-      else
-        raise Error, "cannot merge section #{key.inspect} - unsupported type: #{other[key].class.name}"
-      end
-    end
-
-    (other_keys - my_keys).each do |key|
-      @ini[key] = case other[key]
-        when Hash
-          other[key].dup
-        when nil
-          {}
-        else
-          raise Error, "cannot merge section #{key.inspect} - unsupported type: #{other[key].class.name}"
-        end
-    end
-
-    self
-  end
-
-  # Public: Yield each INI file section, parameter, and value in turn to the
-  # given block.
-  #
-  # block - The block that will be iterated by the each method. The block will
-  #         be passed the current section and the parameter/value pair.
-  #
-  # Examples
-  #
-  #   inifile.each do |section, parameter, value|
-  #     puts "#{parameter} = #{value} [in section - #{section}]"
-  #   end
-  #
-  # Returns this IniFile.
-  def each
-    return unless block_given?
-    @ini.each do |section,hash|
-      hash.each do |param,val|
-        yield section, param, val
-      end
-    end
-    self
-  end
-
-  # Public: Yield each section in turn to the given block.
-  #
-  # block - The block that will be iterated by the each method. The block will
-  #         be passed the current section as a Hash.
-  #
-  # Examples
-  #
-  #   inifile.each_section do |section|
-  #     puts section.inspect
-  #   end
-  #
-  # Returns this IniFile.
-  def each_section
-    return unless block_given?
-    @ini.each_key {|section| yield section}
-    self
-  end
-
-  # Public: Remove a section identified by name from the IniFile.
-  #
-  # section - The section name as a String.
-  #
-  # Returns the deleted section Hash.
-  def delete_section( section )
-    @ini.delete section.to_s
-  end
-
-  # Public: Get the section Hash by name. If the section does not exist, then
-  # it will be created.
-  #
-  # section - The section name as a String.
-  #
-  # Examples
-  #
-  #   inifile['global']
-  #   #=> global section Hash
-  #
-  # Returns the Hash of parameter/value pairs for this section.
-  def []( section )
-    return nil if section.nil?
-    @ini[section.to_s]
-  end
-
-  # Public: Set the section to a hash of parameter/value pairs.
-  #
-  # section - The section name as a String.
-  # value   - The Hash of parameter/value pairs.
-  #
-  # Examples
-  #
-  #   inifile['tenderloin'] = { 'gritty' => 'yes' }
-  #   #=> { 'gritty' => 'yes' }
-  #
-  # Returns the value Hash.
-  def []=( section, value )
-    @ini[section.to_s] = value
-  end
-
-  # Public: Create a Hash containing only those INI file sections whose names
-  # match the given regular expression.
-  #
-  # regex - The Regexp used to match section names.
-  #
-  # Examples
-  #
-  #   inifile.match(/^tree_/)
-  #   #=> Hash of matching sections
-  #
-  # Return a Hash containing only those sections that match the given regular
-  # expression.
-  def match( regex )
-    @ini.dup.delete_if { |section, _| section !~ regex }
-  end
-
-  # Public: Check to see if the IniFile contains the section.
-  #
-  # section - The section name as a String.
-  #
-  # Returns true if the section exists in the IniFile.
-  def has_section?( section )
-    @ini.has_key? section.to_s
-  end
-
-  # Returns an Array of section names contained in this IniFile.
-  def sections
-    @ini.keys
-  end
-
-  # Public: Freeze the state of this IniFile object. Any attempts to change
-  # the object will raise an error.
-  #
-  # Returns this IniFile.
-  def freeze
-    super
-    @ini.each_value {|h| h.freeze}
-    @ini.freeze
-    self
-  end
-
-  # Public: Mark this IniFile as tainted -- this will traverse each section
-  # marking each as tainted.
-  #
-  # Returns this IniFile.
-  def taint
-    super
-    @ini.each_value {|h| h.taint}
-    @ini.taint
-    self
-  end
-
-  # Public: Produces a duplicate of this IniFile. The duplicate is independent
-  # of the original -- i.e. the duplicate can be modified without changing the
-  # original. The tainted state of the original is copied to the duplicate.
-  #
-  # Returns a new IniFile.
-  def dup
-    other = super
-    other.instance_variable_set(:@ini, Hash.new {|h,k| h[k] = Hash.new})
-    @ini.each_pair {|s,h| other[s].merge! h}
-    other.taint if self.tainted?
-    other
-  end
-
-  # Public: Produces a duplicate of this IniFile. The duplicate is independent
-  # of the original -- i.e. the duplicate can be modified without changing the
-  # original. The tainted state and the frozen state of the original is copied
-  # to the duplicate.
-  #
-  # Returns a new IniFile.
-  def clone
-    other = dup
-    other.freeze if self.frozen?
-    other
-  end
-
-  # Public: Compare this IniFile to some other IniFile. For two INI files to
-  # be equivalent, they must have the same sections with the same parameter /
-  # value pairs in each section.
-  #
-  # other - The other IniFile.
-  #
-  # Returns true if the INI files are equivalent and false if they differ.
-  def eql?( other )
-    return true if equal? other
-    return false unless other.instance_of? self.class
-    @ini == other.instance_variable_get(:@ini)
-  end
-  alias :== :eql?
-
-  # Escape special characters.
-  #
-  # value - The String value to escape.
-  #
-  # Returns the escaped value.
-  def escape_value( value )
-    value = value.to_s.dup
-    value.gsub!(%r/\\([0nrt])/, '\\\\\1')
-    value.gsub!(%r/\n/, '\n')
-    value.gsub!(%r/\r/, '\r')
-    value.gsub!(%r/\t/, '\t')
-    value.gsub!(%r/\0/, '\0')
-    value
-  end
-
-  # Parse the given content and store the information in this IniFile
-  # instance. All data will be cleared out and replaced with the information
-  # read from the content.
-  #
-  # content - A String or a file descriptor (must respond to `each_line`)
-  #
-  # Returns this IniFile.
-  def parse( content )
-    parser = Parser.new(@ini, @param, @comment, @default)
-    parser.parse(content)
-    self
-  end
-
-  # The IniFile::Parser has the responsibility of reading the contents of an
-  # .ini file and storing that information into a ruby Hash. The object being
-  # parsed must respond to `each_line` - this includes Strings and any IO
-  # object.
-  class Parser
-
-    attr_writer :section
-    attr_accessor :property
-    attr_accessor :value
-
-    # Create a new IniFile::Parser that can be used to parse the contents of
-    # an .ini file.
-    #
-    # hash    - The Hash where parsed information will be stored
-    # param   - String used to separate parameter and value
-    # comment - String containing the comment character(s)
-    # default - The String name of the default global section
-    #
-    def initialize( hash, param, comment, default )
-      @hash = hash
-      @default = default
-
-      comment = comment.to_s.empty? ? "\\z" : "\\s*(?:[#{comment}].*)?\\z"
-
-      @section_regexp  = %r/\A\s*\[([^\]]+)\]#{comment}/
-      @ignore_regexp   = %r/\A#{comment}/
-      @property_regexp = %r/\A(.*?)(?<!\\)#{param}(.*)\z/
-
-      @open_quote      = %r/\A\s*(".*)\z/
-      @close_quote     = %r/\A(.*(?<!\\)")#{comment}/
-      @full_quote      = %r/\A\s*(".*(?<!\\)")#{comment}/
-      @trailing_slash  = %r/\A(.*)(?<!\\)\\#{comment}/
-      @normal_value    = %r/\A(.*?)#{comment}/
-    end
-
-    # Returns `true` if the current value starts with a leading double quote.
-    # Otherwise returns false.
-    def leading_quote?
-      value && value =~ %r/\A"/
-    end
-
-    # Given a string, attempt to parse out a value from that string. This
-    # value might be continued on the following line. So this method returns
-    # `true` if it is expecting more data.
-    #
-    # string - String to parse
-    #
-    # Returns `true` if the next line is also part of the current value.
-    # Returns `fase` if the string contained a complete value.
-    def parse_value( string )
-      continuation = false
-
-      # if our value starts with a double quote, then we are in a
-      # line continuation situation
-      if leading_quote?
-        # check for a closing quote at the end of the string
-        if string =~ @close_quote
-          value << $1
-
-        # otherwise just append the string to the value
-        else
-          value << string
-          continuation = true
-        end
-
-      # not currently processing a continuation line
-      else
-        case string
-        when @full_quote
-          self.value = $1
-
-        when @open_quote
-          self.value = $1
-          continuation = true
-
-        when @trailing_slash
-          self.value ?  self.value << $1 : self.value = $1
-          continuation = true
-
-        when @normal_value
-          self.value ?  self.value << $1 : self.value = $1
-
-        else
-          error
-        end
-      end
-
-      if continuation
-        self.value << $/ if leading_quote?
-      else
-        process_property
-      end
-
-      continuation
-    end
-
-    # Parse the ini file contents. This will clear any values currently stored
-    # in the ini hash.
-    #
-    # content - Any object that responds to `each_line`
-    #
-    # Returns nil.
-    def parse( content )
-      return unless content
-
-      continuation = false
-
-      @hash.clear
-      @line = nil
-      self.section = nil
-
-      content.each_line do |line|
-        @line = line.chomp
-
-        if continuation
-          continuation = parse_value @line
-        else
-          case @line
-          when @ignore_regexp
-            nil
-          when @section_regexp
-            self.section = @hash[$1]
-          when @property_regexp
-            self.property = $1.strip
-            error if property.empty?
-
-            continuation = parse_value $2
-          else
-            error
-          end
-        end
-      end
-
-      # check here if we have a dangling value ... usually means we have an
-      # unmatched open quote
-      if leading_quote?
-        error "Unmatched open quote"
-      elsif property && value
-        process_property
-      elsif value
-        error
-      end
-
-      nil
-    end
-
-    # Store the property/value pair in the currently active section. This
-    # method checks for continuation of the value to the next line.
-    #
-    # Returns nil.
-    def process_property
-      property.strip!
-      value.strip!
-
-      self.value = $1 if value =~ %r/\A"(.*)(?<!\\)"\z/m
-
-      section[property] = typecast(value)
-
-      self.property = nil
-      self.value = nil
-    end
-
-    # Returns the current section Hash.
-    def section
-      @section ||= @hash[@default]
-    end
-
-    # Raise a parse error using the given message and appending the current line
-    # being parsed.
-    #
-    # msg - The message String to use.
-    #
-    # Raises IniFile::Error
-    def error( msg = 'Could not parse line' )
-      raise Error, "#{msg}: #{@line.inspect}"
-    end
-
-    # Attempt to typecast the value string. We are looking for boolean values,
-    # integers, floats, and empty strings. Below is how each gets cast, but it
-    # is pretty logical and straightforward.
-    #
-    #  "true"  -->  true
-    #  "false" -->  false
-    #  ""      -->  nil
-    #  "42"    -->  42
-    #  "3.14"  -->  3.14
-    #  "foo"   -->  "foo"
-    #
-    # Returns the typecast value.
-    def typecast( value )
-      case value
-      when %r/\Atrue\z/i;  true
-      when %r/\Afalse\z/i; false
-      when %r/\A\s*\z/i;   nil
-      else
-        Integer(value) rescue \
-        Float(value)   rescue \
-        unescape_value(value)
-      end
-    end
-
-    # Unescape special characters found in the value string. This will convert
-    # escaped null, tab, carriage return, newline, and backslash into their
-    # literal equivalents.
-    #
-    # value - The String value to unescape.
-    #
-    # Returns the unescaped value.
-    def unescape_value( value )
-      value = value.to_s
-      value.gsub!(%r/\\[0nrt\\]/) { |char|
-        case char
-        when '\0';   "\0"
-        when '\n';   "\n"
-        when '\r';   "\r"
-        when '\t';   "\t"
-        when '\\\\'; "\\"
-        end
-      }
-      value
-    end
-  end
-
-end  # IniFile
-