rookout 0.1.36 → 0.1.39

data/lib/rookout/logger.rb

@@ -66,7 +66,7 @@ module Rookout
 
         arguments.each do |argument|
           if argument.is_a? Exception
-            @formatted_message += "\n" + argument.message + "\n" + argument.backtrace.join("\n\t")
+            @formatted_message += "\n#{argument.message}\n#{argument.backtrace.join "\n\t"}"
           end
         end
 
@@ -74,7 +74,13 @@ module Rookout
         set_caller
       end
 
-      attr_reader :level, :time, :filename, :lineno, :message, :formatted_message, :arguments
+      attr_reader :level
+      attr_reader :time
+      attr_reader :filename
+      attr_reader :lineno
+      attr_reader :message
+      attr_reader :formatted_message
+      attr_reader :arguments
 
       def format
         "#{@time} #{Process.pid}:#{Thread.current.name}-" \
@@ -137,19 +143,19 @@ module Rookout
         file = nil
 
         if Config.debug
-          STDERR.puts "[Rookout] Failed to open log file: #{log_file_path}"
-          STDERR.puts e.backtrace
+          $stderr.puts "[Rookout] Failed to open log file: #{log_file_path}"
+          $stderr.puts e.backtrace
         end
       end
 
-      ->(record) { file.write record.format + "\n" if file }
+      ->(record) { file.write "#{record.format}\n" if file }
     end
 
     def calculate_log_file_path
       return Config.logger_filename if absolute_path? Config.logger_filename
 
       if RUBY_PLATFORM.include? "darwin"
-        File.join ENV["HOME"], Config.logger_filename
+        File.join Dir.home, Config.logger_filename
       elsif RUBY_PLATFORM.match?(/cygwin|mswin|mingw|bccwin|wince|emx/)
         File.join ENV["USERPROFILE"], Config.logger_filename
       else
@@ -158,7 +164,7 @@ module Rookout
     end
 
     def new_stderr_handler
-      ->(record) { STDERR.puts record.format }
+      ->(record) { $stderr.puts record.format }
     end
 
     def new_remote_handler

data/lib/rookout/processor/namespace_serializer.rb

@@ -7,7 +7,7 @@ module Rookout
 
       module_function
 
-      def dump namespace, log_errors = true
+      def dump namespace, log_errors
         namespace.dump log_errors
       rescue StandardError => e
         message = "Failed to serialize namespace"

data/lib/rookout/processor/namespace_serializer2.rb

@@ -9,12 +9,20 @@ module Rookout
       require_relative "./namespaces/container_namespace"
       require_relative "./namespaces/traceback_namespace"
 
+      begin
+        require "hashie/mash"
+        MASH = ::Hashie::Mash
+      rescue LoadError
+        MASH = nil
+      end
+
       def initialize
         @string_cache = {}
         @estimated_pending_bytes = 0
       end
 
-      attr_reader :string_cache, :estimated_pending_bytes
+      attr_reader :string_cache
+      attr_reader :estimated_pending_bytes
 
       def get_string_index_in_cache str
         if @string_cache.key? str
@@ -35,13 +43,16 @@ module Rookout
         variant.variant_type_max_depth = (type << 1) | 1
       end
 
-      def dump namespace, log_errors = true
-        if namespace.is_a? Namespaces::RubyObjectNamespace
+      def dump namespace, log_errors
+        case namespace
+        when Namespaces::RubyObjectNamespace
           dump_ruby_object_namespace namespace, log_errors
-        elsif namespace.is_a? Namespaces::ContainerNamespace
+        when Namespaces::ContainerNamespace
           dump_container_namespace namespace, log_errors
-        elsif namespace.is_a? Namespaces::TracebackNamespace
+        when Namespaces::TracebackNamespace
           dump_traceback_namespace namespace
+        else
+          raise NotImplementedError
         end
       rescue StandardError => e
         message = "Failed to serialize namespace"
@@ -80,6 +91,7 @@ module Rookout
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/PerceivedComplexity
       # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Style/ClassEqualityComparison
       def unsafe_dump_object obj, current_depth, config, log_object_errors
         variant = Com::Rookout::Variant2.new original_type_index_in_cache: get_string_index_in_cache(obj.class.to_s)
 
@@ -93,7 +105,7 @@ module Rookout
           dump_time obj, variant
         elsif obj.class == Array
           dump_array obj, variant, current_depth, config, log_object_errors
-        elsif obj.class == Hash
+        elsif obj.class == Hash || (!MASH.nil? && obj.is_a?(MASH))
           dump_hash obj, variant, current_depth, config, log_object_errors
         elsif obj.is_a? Exception
           dump_exception obj, variant, current_depth, config, log_object_errors
@@ -105,6 +117,7 @@ module Rookout
 
         variant
       end
+      # rubocop:enable Style/ClassEqualityComparison
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/PerceivedComplexity
       # rubocop:enable Metrics/CyclomaticComplexity
@@ -120,20 +133,21 @@ module Rookout
       INT64_MAX = (1 << 63) - 1
 
       def dump_numeric obj, variant, config
-        if obj == true
+        case obj
+        when true
           dump_variant_type variant, Com::Rookout::Variant::Type::VARIANT_LONG
           variant.long_value = 1
-        elsif obj == false
+        when false
           dump_variant_type variant, Com::Rookout::Variant::Type::VARIANT_LONG
           variant.long_value = 0
-        elsif obj.is_a? Integer
+        when Integer
           dump_integer obj, variant
-        elsif obj.is_a? Float
+        when Float
           dump_variant_type variant, Com::Rookout::Variant::Type::VARIANT_DOUBLE
           variant.double_value = obj.to_f
-        elsif obj.is_a? BigDecimal
+        when BigDecimal
           dump_string obj.to_s, variant, config # TODO: NS: This might cut the decimal value, is that ok?
-        elsif obj.is_a? Complex
+        when Complex
           dump_variant_type variant, Com::Rookout::Variant::Type::VARIANT_COMPLEX
           variant.complex_value = Com::Rookout::Variant::Complex.new real: obj.real.to_f,
                                                                      imaginary: obj.imaginary.to_f

data/lib/rookout/processor/namespaces/container_namespace.rb

@@ -11,6 +11,7 @@ module Rookout
 
       class ContainerNamespace < Namespace
         def initialize hash = {}
+          super()
           @hash = hash
         end
 

data/lib/rookout/processor/namespaces/frame_namespace.rb

@@ -8,6 +8,7 @@ module Rookout
 
       class FrameNamespace < Namespace
         def initialize binding
+          super()
           @binding = binding
         end
 
@@ -19,14 +20,12 @@ module Rookout
 
         def call_method name, args
           case name
-          when "filename"
+          when "filename", "module"
             RubyObjectNamespace.new @binding.source_location[0]
           when "line"
             RubyObjectNamespace.new @binding.source_location[1]
           when "function"
             RubyObjectNamespace.new @binding.eval("__method__").to_s
-          when "module"
-            RubyObjectNamespace.new @binding.source_location[0]
           when "locals"
             locals args
           when "dump"

data/lib/rookout/processor/namespaces/namespace.rb

@@ -3,6 +3,7 @@ module Rookout
     module Namespaces
       class Namespace
         require_relative "../../exceptions"
+
         def call_method name, _args
           raise Exceptions::RookMethodNotFound.new(self.class.to_s, name)
         end

data/lib/rookout/processor/namespaces/noop_namespace.rb

@@ -7,10 +7,6 @@ module Rookout
       require_relative "../../protobuf/variant_pb"
 
       class NoopNamespace < Namespace
-        def initialize
-          super
-        end
-
         def call_method _name, _args
           Rookout::Processor::Namespaces::RubyObjectNamespace.new nil
         end

data/lib/rookout/processor/namespaces/ruby_object_namespace.rb

@@ -17,7 +17,10 @@ module Rookout
           @max_string = max_string
         end
 
-        attr_reader :max_depth, :max_width, :max_collection_depth, :max_string
+        attr_reader :max_depth
+        attr_reader :max_width
+        attr_reader :max_collection_depth
+        attr_reader :max_string
       end
 
       OBJECT_DUMP_CONFIG_STRICT = ObjectDumpConfig.new 2, 10, 2, 128
@@ -37,12 +40,14 @@ module Rookout
       class RubyObjectNamespace < Namespace
         include RubyObjectSerializer
 
-        def initialize obj, dump_config = OBJECT_DUMP_CONFIG_DEFAULT
+        def initialize obj, dump_config = nil
+          super()
           @obj = obj
-          @dump_config = dump_config
+          @dump_config = dump_config || OBJECT_DUMP_CONFIG_DEFAULT
         end
 
-        attr_reader :obj, :dump_config
+        attr_reader :obj
+        attr_reader :dump_config
 
         def tailor_limits!
           if @obj.is_a? String
@@ -62,18 +67,11 @@ module Rookout
         end
 
         def read_key key
-          if @obj.is_a?(Array) || @obj.is_a?(String)
-            key_int = key.to_i
-            return RubyObjectNamespace.new @obj[key_int] if key_int >= 0 && key_int < @obj.length
-            raise Exceptions::RookKeyNotFound, key
-
-          elsif @obj.is_a? Hash
-            return RubyObjectNamespace.new @obj[key] if @obj.key? key
-            return RubyObjectNamespace.new @obj[key.to_sym] if @obj.key? key.to_s.to_sym
-
-            @obj.each { |it, value| return RubyObjectNamespace.new value if it.to_s == key }
-
-            raise Exceptions::RookKeyNotFound, key
+          case @obj
+          when Array, String
+            read_key_as_int key
+          when Hash
+            read_key_from_hash key
           else
             raise Exceptions::RookInvalidObjectForAccess.new(@obj.class.to_s, "ReadKey")
           end
@@ -94,6 +92,23 @@ module Rookout
           dump_raw_object @obj, 0, @dump_config, log_object_errors
         end
       end
+
+      private
+
+      def read_key_as_int key
+        key_int = key.to_i
+        return RubyObjectNamespace.new @obj[key_int] if key_int >= 0 && key_int < @obj.length
+        raise Exceptions::RookKeyNotFound, key
+      end
+
+      def read_key_from_hash key
+        return RubyObjectNamespace.new @obj[key] if @obj.key? key
+        return RubyObjectNamespace.new @obj[key.to_sym] if @obj.key? key.to_s.to_sym
+
+        @obj.each { |it, value| return RubyObjectNamespace.new value if it.to_s == key }
+
+        raise Exceptions::RookKeyNotFound, key
+      end
     end
   end
 end

data/lib/rookout/processor/namespaces/ruby_object_serializer.rb

@@ -24,6 +24,7 @@ module Rookout
 
         # rubocop:disable Metrics/PerceivedComplexity
         # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Style/ClassEqualityComparison
         def unsafe_dump_object obj, current_depth, config, log_object_errors
           variant = create_base_variant obj, current_depth, config, log_object_errors
 
@@ -49,7 +50,7 @@ module Rookout
 
           variant
         end
-
+        # rubocop:enable Style/ClassEqualityComparison
         # rubocop:enable Metrics/CyclomaticComplexity
         # rubocop:enable Metrics/PerceivedComplexity
 
@@ -83,23 +84,24 @@ module Rookout
         INT64_MAX = (1 << 63) - 1
 
         def dump_numeric obj, variant
-          if obj == true
+          case obj
+          when true
             variant.variant_type = :VARIANT_INT
             variant.int_value = 1
-          elsif obj == false
+          when false
             variant.variant_type = :VARIANT_INT
             variant.int_value = 0
-          elsif obj.is_a? Integer
+          when Integer
             dump_integer obj, variant
-          elsif obj.is_a? Float
+          when Float
             variant.variant_type = :VARIANT_DOUBLE
             variant.double_value = obj.to_f
-          elsif obj.is_a? BigDecimal
+          when BigDecimal
             serialized_decimal = obj.to_s
             variant.variant_type = :VARIANT_STRING
             variant.string_value = Com::Rookout::Variant::String.new value: serialized_decimal,
                                                                      original_size: serialized_decimal.length
-          elsif obj.is_a? Complex
+          when Complex
             variant.variant_type = :VARIANT_COMPLEX
             variant.complex_value = Com::Rookout::Variant::Complex.new real: obj.real.to_f,
                                                                        imaginary: obj.imaginary.to_f

data/lib/rookout/processor/namespaces/ruby_utils_namespace.rb

@@ -9,10 +9,6 @@ module Rookout
       require_relative "ruby_object_namespace"
 
       class RubyUtilsNamespace < Namespace
-        def initialize
-          super
-        end
-
         def call_method name, args
           case name
           when "exception"

data/lib/rookout/processor/namespaces/stack_namespace.rb

@@ -7,6 +7,7 @@ module Rookout
 
       class StackNamespace < Namespace
         def initialize backtrace, offset = 0
+          super()
           @backtrace = backtrace
           @offset = offset
         end

data/lib/rookout/processor/namespaces/traceback_namespace.rb

@@ -8,12 +8,15 @@ module Rookout
 
       class TracebackNamespace < Namespace
         def initialize backtrace, offset, depth
+          super()
           @backtrace = backtrace
           @offset = offset
           @depth = depth
         end
 
-        attr_reader :backtrace, :offset, :depth
+        attr_reader :backtrace
+        attr_reader :offset
+        attr_reader :depth
 
         def read_key key
           FrameNamespace.new @backtrace[key + @offset]

data/lib/rookout/processor/operations/set_operation.rb

@@ -11,6 +11,8 @@ module Rookout
 
       class SetOperation < Operation
         def initialize configuration, factory
+          super()
+
           @paths = []
 
           configuration["paths"].each do |key, value|

data/lib/rookout/processor/paths/arithmetic_path.rb

@@ -13,6 +13,8 @@ module Rookout
 
       class ArithmeticPath < Path
         def initialize path
+          super()
+
           if path.is_a? Hash
             path = path["path"] || path[:path]
           end
@@ -20,7 +22,7 @@ module Rookout
           @raw_path = path
 
           if path.start_with?("NOT(") && path.end_with?(")")
-            @path = path["NOT(".length..-2]
+            @path = path[("NOT(".length)..-2]
             @negation = true
           else
             @path = path

data/lib/rookout/processor/paths/canopy/actions.rb

@@ -79,6 +79,8 @@ module Rookout
           end
 
           # rubocop:disable Metrics/AbcSize
+          # rubocop:disable Metrics/CyclomaticComplexity
+          # rubocop:disable Metrics/PerceivedComplexity
           def make_comp_exp _input, _start, _finish, elements
             # We can assume the following: atom ( opt_ atom )*
             # the first (which must be) will be simple atom
@@ -108,7 +110,7 @@ module Rookout
                 flat_elements.each_with_index do |e, index|
                   if e.is_a?(Opt) && e.level == level
                     result = e.execute_operation flat_elements[index - 1], flat_elements[index + 1]
-                    flat_elements = flat_elements[0...index - 1] + [result] + flat_elements[index + 2..-1]
+                    flat_elements = flat_elements[0...index - 1] + [result] + flat_elements[index + 2..]
                     restart_scan = true
                     break
                   end
@@ -122,6 +124,8 @@ module Rookout
 
             flat_elements[0]
           end
+          # rubocop:enable Metrics/PerceivedComplexity
+          # rubocop:enable Metrics/CyclomaticComplexity
           # rubocop:enable Metrics/AbcSize
 
           def make_opt _input, _start, _finish, elements

data/lib/rookout/processor/paths/canopy/consts.rb

@@ -50,9 +50,10 @@ module Rookout
             # If it's a dict, scan the keys, compensating for additional abstraction
             if b.is_a? Hash
               b.each_key do |key|
-                if key.is_a? ObjectMarker
+                case key
+                when ObjectMarker
                   return true if key.obj == a
-                elsif key == a
+                when a
                   return true
                 end
               end
@@ -62,9 +63,10 @@ module Rookout
             # If it's an array, scan the value, compensating for additional abstraction
             if b.is_a? Array
               b.each do |value|
-                if value.is_a? ObjectMarker
+                case value
+                when ObjectMarker
                   return true if value.obj == a
-                elsif value == a
+                when a
                   return true
                 end
               end

data/lib/rookout/processor/paths/canopy/markers.rb

@@ -7,7 +7,11 @@ module Rookout
         require_relative "../../../exceptions"
         require_relative "../../namespaces/container_namespace"
 
-        class Marker; end
+        # rubocop:disable Lint/EmptyClass
+        class Marker
+          # Empty base class
+        end
+        # rubocop:enable Lint/EmptyClass
 
         class Operation < Marker
           def read _namespace, _create
@@ -21,6 +25,7 @@ module Rookout
 
         class FunctionOperation < Operation
           def initialize name, args
+            super()
             @name = name
             @args = args
           end
@@ -32,6 +37,7 @@ module Rookout
 
         class AttributeOperation < Operation
           def initialize name
+            super()
             @name = name
           end
 
@@ -49,6 +55,7 @@ module Rookout
 
         class LookupOperation < Operation
           def initialize text
+            super()
             if (text.start_with?("'") && text.end_with?("'")) || (text.start_with?("\"") && text.end_with?("\""))
               @key = text[1...-1]
             else
@@ -63,11 +70,13 @@ module Rookout
 
         class ObjectMarker < Marker
           def initialize text, obj
+            super()
             @text = text
             @obj = obj
           end
 
-          attr_reader :text, :obj
+          attr_reader :text
+          attr_reader :obj
 
           def to_s
             @obj.to_s
@@ -136,6 +145,8 @@ module Rookout
 
         class Opt < Marker
           def initialize opt
+            super()
+
             @opt = opt
             @level = nil
 
@@ -160,9 +171,8 @@ module Rookout
               return
             end
 
-            unless first_obj.nil?
-              raise Exceptions::RookNonPrimitiveObjectType, first_obj.class.to_s unless
-                PRIMITIVES.include? first_obj.class
+            if !first_obj.nil? && !(PRIMITIVES.include? first_obj.class)
+              raise Exceptions::RookNonPrimitiveObjectType, first_obj.class.to_s
             end
 
             return if second_obj.nil?

data/lib/rookout/processor/processor_factory.rb

@@ -5,8 +5,6 @@ module Rookout
     require_relative "paths/arithmetic_path"
 
     class ProcessorFactory
-      def initialize; end
-
       def create_operation configuration
         Operations::SetOperation.new configuration, self
       end

data/lib/rookout/processor/rook_error.rb

@@ -24,7 +24,9 @@ module Rookout
         end
       end
 
-      attr_reader :message, :exception, :parameters
+      attr_reader :message
+      attr_reader :exception
+      attr_reader :parameters
 
       def dumps
         parameters = NamespaceSerializer.dump Namespaces::RubyObjectNamespace.new(@parameters), false

data/lib/rookout/rookout_singleton.rb

@@ -82,9 +82,10 @@ module Rookout
     private
 
     def check_version_supported
-      raise Exceptions:: RookVersionNotSupported.new("platform", RUBY_ENGINE) unless RUBY_ENGINE == "ruby"
+      raise Exceptions::RookVersionNotSupported.new("platform", RUBY_ENGINE) unless RUBY_ENGINE == "ruby"
       raise Exceptions::RookVersionNotSupported.new("version", RUBY_VERSION) unless
-          RUBY_VERSION.start_with?("2.7") || RUBY_VERSION.start_with?("2.6")
+          RUBY_VERSION.start_with?("2.7") || RUBY_VERSION.start_with?("2.6") ||
+          RUBY_VERSION.start_with?("3.0") || RUBY_VERSION.start_with?("3.1")
     end
   end
 end

data/lib/rookout/sanitizer.rb

@@ -0,0 +1,22 @@
+require "set"
+module Rookout
+  class Sanitizer
+    @@blacklisted_properties = Set["labels", "ROOKOUT_LABELS"]
+
+    def self.sanitize_object! obj
+      obj.each_key do |key|
+        if obj[key].is_a?(String) && !@@blacklisted_properties.include?(key.to_s)
+          obj[key] = obj[key].strip
+        end
+      end
+    end
+
+    def self.sanitize_properties!
+      ENV.each do |key, val|
+        if key.start_with?("ROOKOUT_") && !@@blacklisted_properties.include?(key.to_s)
+          ENV[key] = val.strip
+        end
+      end
+    end
+  end
+end

data/lib/rookout/services/position.rb

@@ -11,7 +11,8 @@ module Rookout
         @method = method
       end
 
-      attr_reader :lineno, :method
+      attr_reader :lineno
+      attr_reader :method
     end
 
     class PositionResolver
@@ -54,7 +55,7 @@ module Rookout
       end
 
       def clear_augs
-        @augs.values.each do |aug_id|
+        @augs.each_value do |aug_id|
           remove_aug aug_id
         end
 

data/lib/rookout/services/tracer.rb

@@ -26,7 +26,7 @@ module Rookout
 
           # We add and remove a dummy trace point to re-align the tracing mechanism as a result of some bug in adding
           # a breakpoint
-          dummy_trace_point = TracePoint.new(:line) {}
+          dummy_trace_point = TracePoint.new(:line) {} # Dummy
           dummy_trace_point.enable target: position.method, target_line: position.lineno
           dummy_trace_point.disable
 
@@ -53,7 +53,7 @@ module Rookout
       end
 
       def clear_augs
-        @augs.values.each do |aug_id|
+        @augs.each_value do |aug_id|
           remove_aug aug_id
         end
 

data/lib/rookout/utils.rb

@@ -15,6 +15,12 @@ module Utils
   def time_to_nanoseconds time_obj
     secs = time_obj.to_i
     nsecs = time_obj.nsec
-    (10**9) * secs + nsecs
+    ((10**9) * secs) + nsecs
+  end
+end
+
+class String
+  def is_number?
+    to_f.to_s == self || to_i.to_s == self
   end
 end

data/lib/rookout/version.rb

@@ -1,3 +1,3 @@
 module Rookout
-  VERSION = "0.1.36".freeze
+  VERSION = "0.1.39".freeze
 end

data/lib/rookout.rb

@@ -2,6 +2,10 @@ module Rookout
   module_function
 
   def start options = {}
+    require_relative "rookout/sanitizer"
+    Sanitizer.sanitize_object! options
+    Sanitizer.sanitize_properties!
+
     require_relative "rookout/interface"
     Interface.instance.start options
   end