rshade 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39758f070ab0a6b6e7dc0bdc09aa03bb107130f84fe7115331189a31c0e013eb
-  data.tar.gz: 0331bdd526cd0155df7d210603bb07a15c9541bcce62197b2754731e640060c3
+  metadata.gz: efdbfc08fca88589c49b580abbbeb36687b68986e365291c2c4758633b33943d
+  data.tar.gz: 78e8147a5539bb79216281763274c676d916729b62af681b2811caa1772f7031
 SHA512:
-  metadata.gz: b0c97b53d02f997d05484e850655dfe561c82da1d110a111022885278ece826b5fc75b2e5d70260ff59095ca29178e681c85915301a6b171efe263aa42c82f64
-  data.tar.gz: ed9a95bceb71f94cd17587bd88086a6e26d77b5a19fe14ed96b4cfbd559fa1574ffaca380ec3fc49167e788197008bc08b581f83fb5997fb058dedba77e49bf8
+  metadata.gz: 39fad4c1cb0663e510aaee89100090a10e689880da9f2fb2422fc404094337bad4bcbd5bb72a96270b284a3709392d4d9879cb1410d8f912d8e55db2962a8e4f
+  data.tar.gz: de5d785cfe183f5a7109aeebb128086e0173ce126788165b7dc18b818de066909830e628b5322c84ff6c9655696cb34cc8c7d289aafff036965f6a7caeb7bda0

data/.rubocop.yml

@@ -0,0 +1,31 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'spec/fixture/**/*'
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+Naming/MethodParameterName:
+  Exclude:
+    - spec/**/*
+    - test.rb
+Style/Documentation:
+  Enabled: false
+Metrics/BlockLength:
+  Max: 75
+Metrics/MethodLength:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 10
+Metrics/AbcSize:
+  Max: 30

data/Gemfile

@@ -9,6 +9,9 @@ gemspec
 
 group :development, :test do
   gem 'binding_of_caller'
+  gem 'bundler', '~> 2.2.33'
   gem 'prism'
   gem 'pry'
+  gem 'rake', '>= 12.3.3'
+  gem 'rspec', '~> 3.0'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rshade (0.2.0)
+    rshade (0.2.1)
       binding_of_caller
       colorize
       prism
@@ -12,7 +12,7 @@ GEM
     binding_of_caller (1.0.1)
       debug_inspector (>= 1.2.0)
     coderay (1.1.3)
-    colorize (0.8.1)
+    colorize (1.1.0)
     debug_inspector (1.2.0)
     diff-lcs (1.5.0)
     method_source (1.0.0)

data/README.md

@@ -102,11 +102,12 @@ As you can see all code that have been in use is printed.
 
 ## Stack reveal
 Config
+
 ```ruby
 ::RShade::Config::Registry.instance.stack_config do |config|
-  config.exclude_gems!
-  filepath = File.join(Rails.root, 'log', 'rshade-stack.json.log')
-  config.set_formatter(:json, { filepath: filepath, pretty: false })
+   config.exclude_gems!
+   filepath = File.join(Rails.root, 'log', 'rshade-stack.json.log')
+   config.formatter!(:json, { filepath: filepath, pretty: false })
 end
 ```
 

data/lib/rshade/config/registry.rb

@@ -3,9 +3,8 @@
 module RShade
   class Config
     class Registry
-      attr_reader :map, :mutex
-
       include Singleton
+      attr_reader :map, :mutex
 
       def initialize
         @map = {}
@@ -13,12 +12,6 @@ module RShade
         defaults
       end
 
-      def set_default_stack(config)
-        mutex.synchronize do
-          map[:store_default] = config
-        end
-      end
-
       def default_stack_config
         val = nil
         mutex.synchronize do

data/lib/rshade/config/stack_store.rb

@@ -6,7 +6,8 @@ module RShade
       attr_reader :filter, :formatter, :custom_serializers
 
       DEFAULT_FORMATTER = {
-        json: ::RShade::Formatter::Stack::Json
+        json: ::RShade::Formatter::Stack::Json,
+        stdout: ::RShade::Formatter::Stack::Stdout
       }.freeze
 
       # @param [Hash] options
@@ -28,7 +29,7 @@ module RShade
         self
       end
 
-      def set_formatter(formatter, opts = {})
+      def formatter!(formatter, opts = {})
         @formatter = formatter.is_a?(Symbol) ? set_symbol_formatter(formatter, opts) : formatter
         self
       end
@@ -50,8 +51,12 @@ module RShade
       end
 
       def default_filter_composition
+        variable_filter = RShade::Filter::VariableFilter.new
+        include_filter = RShade::Filter::IncludePathFilter.new
+        exclude_filter = RShade::Filter::ExcludePathFilter.new
+
         RShade::Filter::FilterBuilder.build([:or,
-                                             [:or, RShade::Filter::VariableFilter.new, RShade::Filter::IncludePathFilter.new], RShade::Filter::ExcludePathFilter.new])
+                                             [:or, variable_filter, include_filter], exclude_filter])
       end
     end
   end

data/lib/rshade/config/store.rb

@@ -16,7 +16,7 @@ module RShade
         @custom_serializers = options.fetch(:custom_serializers, {})
       end
 
-      def set_tp_events(tp_events)
+      def tp_events!(tp_events)
         @tp_events = tp_events
         self
       end
@@ -31,7 +31,7 @@ module RShade
         self
       end
 
-      def set_formatter(formatter)
+      def formatter!(formatter)
         @formatter = formatter
         self
       end
@@ -39,8 +39,12 @@ module RShade
       private
 
       def default_filter_composition
+        variable_filter = RShade::Filter::VariableFilter.new
+        include_filter = RShade::Filter::IncludePathFilter.new
+        exclude_filter = RShade::Filter::ExcludePathFilter.new
+
         RShade::Filter::FilterBuilder.build([:or,
-                                             [:or, RShade::Filter::VariableFilter.new, RShade::Filter::IncludePathFilter.new], RShade::Filter::ExcludePathFilter.new])
+                                             [:or, variable_filter, include_filter], exclude_filter])
       end
     end
   end

data/lib/rshade/config.rb

@@ -2,10 +2,10 @@
 
 module RShade
   class Config
-    RUBY_VERSION_PATTERN = /ruby-[0-9.]*/
+    RUBY_VERSION_PATTERN = /ruby-[0-9.]*/.freeze
 
     def self.default
-      ::RShade::Config::Store.new.set_formatter(::RShade::Formatter::Trace::Stdout.new)
+      ::RShade::Config::Store.new.formatter!(::RShade::Formatter::Trace::Stdout.new)
                              .config_filter(::RShade::Filter::ExcludePathFilter) do |paths|
         default_excluded_path.each do |path|
           paths << path
@@ -28,7 +28,7 @@ module RShade
 
     def tp_events(&block)
       events = block.call
-      @config_store.set_tp_events(events)
+      @config_store.tp_events!(events)
       self
     end
 
@@ -49,7 +49,7 @@ module RShade
 
     def formatter(&block)
       formatter = block.call
-      @config_store.set_formatter(formatter)
+      @config_store.formatter!(formatter)
       self
     end
 
@@ -71,7 +71,7 @@ module RShade
     end
 
     def self.default_excluded_path
-      [ENV['GEM_PATH'].split(':'), RUBY_VERSION_PATTERN, /internal/].flatten.compact
+      [ENV['GEM_PATH'].split(':'), RUBY_VERSION_PATTERN, /internal/, %r{/gems/}].flatten.compact
     end
   end
 end

data/lib/rshade/core_extensions/object/reveal.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 class Object
+  # rubocop:disable Metrics/MethodLength
   def reveal(method_name = nil, **opts, &block)
     if method_name
       @__cache_rshade_reveal ||= {}
@@ -8,6 +9,7 @@ class Object
       @__cache_rshade_reveal[method_name] = config
       instance_eval do
         def method_added(name)
+          super
           return unless @__cache_rshade_reveal[name]
 
           if @__reveal_rewrite
@@ -34,4 +36,5 @@ class Object
       trace.show
     end
   end
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/rshade/event.rb

@@ -22,7 +22,7 @@ module RShade
       self
     end
 
-    def set_return_value!(return_value)
+    def return_value!(return_value)
       @hash[:return_value] = return_value
       self
     end
@@ -46,7 +46,7 @@ module RShade
         vars[var_name] = hash
       end
 
-      hash = { path: evt.path, lineno: evt.lineno, klass: evt.defined_class, method_name: evt.method_id, vars:,
+      hash = { path: evt.path, lineno: evt.lineno, klass: evt.defined_class, method_name: evt.method_id, vars: vars,
                event_type: evt.event }
 
       if RETURN_EVENTS.include?(evt.event)

data/lib/rshade/event_processor.rb

@@ -22,7 +22,7 @@ module RShade
     # @param [Integer] level
     def leave(event, _level)
       store.current! do |node|
-        node.value.set_return_value!(event.return_value)
+        node.value.return_value!(event.return_value)
             .with_serialized_return!(serializer)
       end
     rescue StandardError

data/lib/rshade/event_tree.rb

@@ -10,6 +10,7 @@ module RShade
       @current = @head = EventTreeNode.new(nil, 0, nil)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def add(value, level)
       if current.level + 1 == level
         current.children << EventTreeNode.new(value, level, current)
@@ -30,6 +31,7 @@ module RShade
       @current = current.parent
       add(value, level)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def current!(&block)
       block.call(current.children.last) if current.children.last
@@ -50,7 +52,7 @@ module RShade
       @level = level
       @parent = parent
       @value = value
-      @vlevel = set_vlevel(parent)
+      @vlevel = vlevel!(parent)
     end
 
     def each(&block)
@@ -60,13 +62,13 @@ module RShade
 
     private
 
-    def set_vlevel(node)
+    def vlevel!(node)
       return 0 if node.nil?
 
       if node.value || node.level.zero?
         node.vlevel + 1
       else
-        set_vlevel(node.parent)
+        vlevel!(node.parent)
       end
     end
   end

data/lib/rshade/filter/default.rb

@@ -3,7 +3,7 @@
 module RShade
   module Filter
     class Default
-      RUBY_VERSION_PATTERN = /ruby-[0-9.]*/
+      RUBY_VERSION_PATTERN = /ruby-[0-9.]*/.freeze
 
       def self.create
         new.create

data/lib/rshade/filter/filter_composition.rb

@@ -7,7 +7,7 @@ module RShade
       AND_OP = :and
       OR_OP = :or
       UNARY_OP = :unary
-      attr_reader :value, :left, :right, :parent
+      attr_reader :value, :left, :right
       attr_accessor :parent
 
       # @param [#call, Enumerable] left
@@ -18,6 +18,7 @@ module RShade
         @right = right
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def call(event)
         case value
         when UNARY_OP
@@ -30,6 +31,7 @@ module RShade
           value.call(event)
         end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def each(&block)
         yield value unless left && right
@@ -38,8 +40,8 @@ module RShade
       end
 
       def config_filter(type, &block)
-        filter = find do |filter|
-          filter.is_a? type
+        filter = find do |f|
+          f.is_a? type
         end
         filter&.config(&block)
       end

data/lib/rshade/filter/include_path_filter.rb

@@ -8,6 +8,7 @@ module RShade
       NAME = :include_paths
 
       def initialize
+        super
         @paths = []
       end
 

data/lib/rshade/filter/variable_filter.rb

@@ -8,6 +8,7 @@ module RShade
       NAME = :variable_filter
 
       def initialize
+        super
         @matchers = []
       end
 

data/lib/rshade/formatter/stack/stdout.rb

@@ -5,7 +5,7 @@ module RShade
     module Stack
       class Stdout < String
         def call(stack)
-          puts super(stack)
+          puts super
         end
       end
     end

data/lib/rshade/formatter/stack/string.rb

@@ -4,9 +4,13 @@ module RShade
   module Formatter
     module Stack
       class String
+        attr_reader :colorize
+
         ROOT_SEP = "---\n"
 
-        def initialize(opts = {}); end
+        def initialize(colorize: true)
+          @colorize = colorize
+        end
 
         # @param [RShade::EventProcessor] stack
         def call(stack)
@@ -23,18 +27,26 @@ module RShade
           buffer.string
         end
 
+        private
+
         # @param [RShade::StackFrame] frame
         def line(line_idx, frame, depth)
-          source_location = ColorizedString["(#{frame.source_location[:path]}:#{frame.source_location[:line]})"].colorize(:green)
+          source_location = apply_color("(#{frame.source_location[:path]}:#{frame.source_location[:line]})", :green)
           var_str = frame.local_vars.map do |_, val|
             var_name = val[:name]
             var_value = val[:value]
             var_type = val[:type]
             "#{var_type} #{var_name} => (#{var_value})"
           end.join(', ')
-          colorized_var_str = ColorizedString[var_str].colorize(:blue)
+          colorized_var_str = apply_color(var_str, :blue)
           "#{'  ' * depth}[frame: #{line_idx}]#{source_location} => local vars: (#{colorized_var_str})\n"
         end
+
+        def apply_color(str, color)
+          return str unless colorize
+
+          ColorizedString[str].colorize(color)
+        end
       end
     end
   end

data/lib/rshade/formatter/trace/file.rb

@@ -23,9 +23,7 @@ module RShade
         end
 
         def write_to_file(data)
-          ::File.open(::File.join(RShade::Config.store_dir, FILE_NAME), 'w+') do |f|
-            f.write data
-          end
+          ::File.write(::File.join(RShade::Config.store_dir, FILE_NAME), data)
         end
       end
     end

data/lib/rshade/formatter/trace/html.rb

@@ -24,9 +24,7 @@ module RShade
         end
 
         def write_to_file(data)
-          ::File.open(::File.join(RShade::Config.store_dir, FILE_NAME), 'w+') do |f|
-            f.write data
-          end
+          ::File.write(::File.join(RShade::Config.store_dir, FILE_NAME), data)
         end
 
         def template

data/lib/rshade/formatter/trace/json.rb

@@ -13,9 +13,8 @@ module RShade
         end
 
         def flat
-          arr = []
-          event_store.each do |node|
-            arr << item(node.event)
+          arr = event_store.map do |node|
+            item(node.event)
           end
           arr.sort_by { |item| item[:level] }
         end
@@ -30,9 +29,9 @@ module RShade
           sort_hash(hash)
         end
 
-        def sort_hash(h)
+        def sort_hash(hash)
           {}.tap do |h2|
-            h.sort.each do |k, v|
+            hash.sort.each do |k, v|
               h2[k] = v.is_a?(Hash) ? sort_hash(v) : v
             end
           end

data/lib/rshade/formatter/trace/stdout.rb

@@ -6,7 +6,7 @@ module RShade
       class Stdout < String
         # @param [RShade::EventProcessor] event_store
         def call(event_store)
-          puts super(event_store)
+          puts super
         end
       end
     end

data/lib/rshade/rspec/rspec.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module RShade
-  REPORTS = [].freeze
+  # rubocop:disable Style/MutableConstant
+  REPORTS = []
+  # rubocop:enable Style/MutableConstant
 
   module RSpecHelper
     def rshade_reveal(options = {}, &block)

data/lib/rshade/serializer/traversal.rb

@@ -26,14 +26,9 @@ module RShade
           String => ->(value) { value },
           Hash => lambda do |value|
             hash = {}
-            begin
-              value.each do |k, v|
-                hash[k] = traverse(v)
-              end
-            rescue Exception => e
-              binding.pry
+            value.each do |k, v|
+              hash[k] = traverse(v)
             end
-
             hash
           end,
           Array => lambda do |value|

data/lib/rshade/stack.rb

@@ -9,7 +9,7 @@ module RShade
     end
 
     def self.trace(config: nil)
-      new(config:).trace
+      new(config: config).trace
     end
 
     def trace

data/lib/rshade/stack_frame.rb

@@ -30,7 +30,7 @@ module RShade
         type = value.is_a?(Class) ? value : value.class
         memo[var_name] = {
           name: var_name,
-          value:,
+          value: value,
           type: type.to_s
         }
       end
@@ -39,11 +39,12 @@ module RShade
         type = value.is_a?(Class) ? value : value.class
         memo[var_name] = {
           name: var_name,
-          value:,
+          value: value,
           type: type.to_s
         }
       end
-      hash = { source_location:, local_vars:, source: {}, receiver_variables: }
+      hash = { source_location: source_location, local_vars: local_vars, source: {},
+               receiver_variables: receiver_variables }
       new(hash)
     end
 

data/lib/rshade/trace_observable.rb

@@ -32,12 +32,12 @@ module RShade
     private
 
     # more info https://rubyapi.org/3.1/o/tracepoint
-    # @param [TracePoint] tp
-    def process(tp)
+    # @param [TracePoint] trace_point
+    def process(trace_point)
       changed
-      event = Event.from_trace_point(tp)
-      return notify_observers(event, :enter) if CALL_EVENTS.include?(tp.event)
-      return notify_observers(event, :leave) if RETURN_EVENTS.include?(tp.event)
+      event = Event.from_trace_point(trace_point)
+      return notify_observers(event, :enter) if CALL_EVENTS.include?(trace_point.event)
+      return notify_observers(event, :leave) if RETURN_EVENTS.include?(trace_point.event)
 
       notify_observers(event, :other)
     end

data/lib/rshade/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RShade
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/rshade.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
     spec.metadata['changelog_uri'] = 'https://github.com/gingray/rshade/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -36,12 +36,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.7.0'
 
-  spec.add_runtime_dependency 'binding_of_caller'
-  spec.add_runtime_dependency 'colorize'
-  spec.add_runtime_dependency 'prism'
+  spec.add_dependency 'binding_of_caller'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'prism'
 
-  spec.add_development_dependency 'bundler', '~> 2.2.33'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rshade
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ivan Lopatin
@@ -52,48 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.33
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.33
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: https://github.com/gingray/rshade
 email:
 - gingray.dev@gmail.com
@@ -103,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -137,7 +96,6 @@ files:
 - lib/rshade/formatter/trace/json.rb
 - lib/rshade/formatter/trace/stdout.rb
 - lib/rshade/formatter/trace/string.rb
-- lib/rshade/rails/rails.rb
 - lib/rshade/rspec/rspec.rb
 - lib/rshade/serializer/traversal.rb
 - lib/rshade/stack.rb
@@ -156,6 +114,7 @@ metadata:
   homepage_uri: https://github.com/gingray/rshade
   source_code_uri: https://github.com/gingray/rshade
   changelog_uri: https://github.com/gingray/rshade/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -164,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="