solid_errors 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 760689e543a0af0e87d8998ddcbb6f94611a5b9da8ad2b9d2a7fc11da1ceaa27
-  data.tar.gz: 83ecabee79fb2ffe3572922e6b97b1a6895b935ec491d0df9d858632cae8d4c2
+  metadata.gz: 2b217c4f9bb72282db398685b1e5152f709f6d2b17476d096b5d4db30ba36724
+  data.tar.gz: fa004229fca23f20fce73294ca971d1465fafc022c6c8803be1edf21a0dcd8b9
 SHA512:
-  metadata.gz: 40cf2bebf1c854caf6bce78db0b99e03a4a3e05b12fe5ccc254d2cfd0448b924610bee0bc7306237fac7ce09d48c93423ed5299cf82481d96e2fa145648d5965
-  data.tar.gz: b87fc4639cd99f4e326dd8bbc37c8c5d613209b83c5286f25bdd8f1f30d07d13e5ba6b4ad6e1419e4f57074124ef0feba78a5583622114bd01b9a0aef2069b3b
+  metadata.gz: 1576b20fe13fcb3a40edca8f9f672d5f84b6e87707147eee254e180508b2942b243a49662a402c1cd45e3cddd8da0906e89114767672e89a8eb422e268d25bd3
+  data.tar.gz: 14d720a8e037f7ee0cbd1683790049fa6ca0e5d9230b4bf8692dcddc192bde8962defb6f64e4768b542f79d01fa90da5fc7e95c61e1da67ed59800e8cdbc3c9c

data/lib/solid_errors/sanitizer.rb

@@ -0,0 +1,91 @@
+module SolidErrors
+  # adapted from: https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger/util/sanitizer.rb
+  class Sanitizer
+    BASIC_OBJECT = '#<BasicObject>'.freeze
+    DEPTH = '[DEPTH]'.freeze
+    RAISED = '[RAISED]'.freeze
+    RECURSION = '[RECURSION]'.freeze
+    TRUNCATED = '[TRUNCATED]'.freeze
+    MAX_STRING_SIZE = 65536
+
+    def self.sanitize(data)
+      @sanitizer ||= new
+      @sanitizer.sanitize(data)
+    end
+
+    def initialize(max_depth: 20)
+      @max_depth = max_depth
+    end
+
+    def sanitize(data, depth = 0, stack = nil)
+      return BASIC_OBJECT if basic_object?(data)
+
+      if recursive?(data)
+        return RECURSION if stack && stack.include?(data.object_id)
+
+        stack = stack ? stack.dup : Set.new
+        stack << data.object_id
+      end
+
+      case data
+      when Hash
+        return DEPTH if depth >= max_depth
+
+        new_hash = {}
+        data.each do |key, value|
+          key = key.kind_of?(Symbol) ? key : sanitize(key, depth+1, stack)
+          value = sanitize(value, depth+1, stack)
+          new_hash[key] = value
+        end
+        new_hash
+      when Array, Set
+        return DEPTH if depth >= max_depth
+
+        data.to_a.map do |value|
+          sanitize(value, depth+1, stack)
+        end
+      when Numeric, TrueClass, FalseClass, NilClass
+        data
+      when String
+        sanitize_string(data)
+      else # all other objects
+        klass = data.class
+
+        begin
+          data = String(data)
+        rescue
+          return RAISED
+        end
+
+        return "#<#{klass.name}>" if inspected?(data)
+
+        sanitize_string(data)
+      end
+    end
+
+    private
+      attr_reader :max_depth
+
+      def basic_object?(object)
+        object.respond_to?(:to_s)
+        false
+      rescue
+        # BasicObject doesn't respond to `#respond_to?`.
+        true
+      end
+
+      def recursive?(data)
+        data.is_a?(Hash) || data.is_a?(Array) || data.is_a?(Set)
+      end
+
+      def sanitize_string(string)
+        string.gsub!(/#<(.*?):0x.*?>/, '#<\1>') # remove object_id
+        return string unless string.respond_to?(:size) && string.size > MAX_STRING_SIZE
+        string[0...MAX_STRING_SIZE] + TRUNCATED
+      end
+
+      def inspected?(string)
+        String(string) =~ /#<.*>/
+      end
+  end
+end

data/lib/solid_errors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidErrors
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/lib/solid_errors.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "solid_errors/version"
+require_relative "solid_errors/sanitizer"
 require_relative "solid_errors/subscriber"
 require_relative "solid_errors/backtrace"
 require_relative "solid_errors/backtrace_line"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Stephen Margheim
@@ -52,6 +52,7 @@ files:
 - lib/solid_errors/backtrace.rb
 - lib/solid_errors/backtrace_line.rb
 - lib/solid_errors/engine.rb
+- lib/solid_errors/sanitizer.rb
 - lib/solid_errors/subscriber.rb
 - lib/solid_errors/version.rb
 homepage: https://github.com/fractaledmind/solid_errors