rshade 0.2.0 → 0.2.2

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

@@ -4,14 +4,18 @@ 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)
+        # @param [RShade::EventProcessor] stack_frames
+        def call(stack_frames, variable_serializer: nil)
           buffer = StringIO.new
-          stack.each_with_index do |frame, idx|
+          stack_frames.each_with_index do |frame, idx|
             if idx.zero?
               buffer << ROOT_SEP
               next
@@ -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/html.rb

@@ -24,13 +24,11 @@ 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::Utils.store_dir, FILE_NAME), data)
         end
 
         def template
-          @template ||= ::File.read(::File.join(::RShade::Config.root_dir, TEMPLATE))
+          @template ||= ::File.read(::File.join(::RShade::Utils.root_dir, TEMPLATE))
         end
       end
     end

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

@@ -4,54 +4,43 @@ module RShade
   module Formatter
     module Trace
       class Json
-        attr_reader :event_processor
+        attr_reader :filepath, :pretty
 
-        # @param [RShade::EventProcessor] event_store
-        def call(event_store)
-          @event_store = event_store
-          flat
+        def initialize(filepath:, pretty: false)
+          @filepath = filepath
+          @pretty = pretty
         end
 
-        def flat
-          arr = []
-          event_store.each do |node|
-            arr << item(node.event)
+        # @param [RShade::EventProcessor] event_store
+        def call(event_store)
+          ::File.open(filepath, 'a+') do |file|
+            file.puts(convert_to_json(flat(event_store), pretty))
           end
-          arr.sort_by { |item| item[:level] }
         end
 
-        def hierarchical
-          hash = {}
-          event_store.each do |node|
-            depth = node.level
-            ref = hash_iterate(hash, depth)
-            ref[:data] = item(node)
-          end
-          sort_hash(hash)
-        end
+        private
 
-        def sort_hash(h)
-          {}.tap do |h2|
-            h.sort.each do |k, v|
-              h2[k] = v.is_a?(Hash) ? sort_hash(v) : v
-            end
-          end
+        def convert_to_json(object, pretty)
+          return JSON.pretty_generate(object) if pretty
+
+          JSON.generate(object)
         end
 
-        def hash_iterate(hash, depth)
-          (0..depth).each do |_lvl|
-            hash[:inner] = {} unless hash[:inner]
-            hash = hash[:inner]
+        def flat(event_store)
+          arr = event_store.filter_map do |node|
+            next unless node.value
+
+            serialize(node.value)
           end
-          hash
+          arr.sort_by { |item| item[:level] }
         end
 
-        def item(value)
+        def serialize(value)
           {
             class: value.klass.to_s,
             method_name: value.method_name,
             full_path: "#{value.path}:#{value.lineno}",
-            level: value.depth,
+            level: value.level,
             vars: value.vars
           }
         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

@@ -17,6 +17,10 @@ module RShade
         new_val
       end
 
+      def merge!(new_types)
+        @types.merge!(new_types)
+      end
+
       def default_types
         {
           default: lambda(&:to_s),
@@ -26,14 +30,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
@@ -20,7 +20,7 @@ module RShade
 
         frame
       end.compact.reverse
-      config.formatter.call(result)
+      config.formatter.call(result, variable_serializer: config.variable_serializer)
     end
   end
 end

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.rb

@@ -4,14 +4,14 @@ module RShade
   class Trace
     attr_reader :config, :event_store
 
-    # @param [RShade::Config,RShade::Config::Store] config
-    def initialize(config)
-      @config = fetch_config(config)
+    # @param [RShade::Config,RShade::Config::EventStore] config
+    def initialize(config: ::RShade::Config::Registry.instance.default_trace_config)
+      @config = config
       @event_store = EventTree.new
     end
 
-    def self.reveal(config = nil, &block)
-      new(config).reveal(&block)
+    def self.reveal(config: ::RShade::Config::Registry.instance.default_trace_config, &block)
+      new(config: config).reveal(&block)
     end
 
     def reveal(&block)
@@ -25,13 +25,5 @@ module RShade
     def show
       config.formatter.call(event_store)
     end
-
-    private
-
-    def fetch_config(config)
-      config ||= ::RShade::Config.default
-      config = config.value if config.is_a?(::RShade::Config)
-      config
-    end
   end
 end

data/lib/rshade/trace_observable.rb

@@ -9,7 +9,7 @@ module RShade
     RETURN_EVENTS = Set[:return, :c_return, :b_return]
 
     # @param [Enumerable<#call>, #call] observers
-    # @param [::RShade::Config::Store] config
+    # @param [::RShade::Config::EventStore] config
     def initialize(observers, config)
       @trace_p = TracePoint.new(*config.tp_events, &method(:process))
       observers = [observers] unless observers.is_a?(Enumerable)
@@ -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/utils.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RShade
+  module Utils
+    RUBY_VERSION_PATTERN = /ruby-[0-9.]*/.freeze
+
+    def self.store_dir
+      File.expand_path('../../tmp', __dir__)
+    end
+
+    def self.root_dir
+      @root_dir ||= File.expand_path('../../', __dir__)
+    end
+
+    def self.default_excluded_path
+      [ENV['GEM_PATH'].split(':'), RUBY_VERSION_PATTERN, /internal/, %r{/gems/}].flatten.compact
+    end
+  end
+end

data/lib/rshade/version.rb

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

data/lib/rshade.rb

@@ -23,7 +23,6 @@ require 'rshade/filter/default'
 
 require 'rshade/formatter/trace/string'
 require 'rshade/formatter/trace/json'
-require 'rshade/formatter/trace/file'
 require 'rshade/formatter/trace/html'
 require 'rshade/formatter/trace/stdout'
 
@@ -31,8 +30,8 @@ require 'rshade/formatter/stack/string'
 require 'rshade/formatter/stack/stdout'
 require 'rshade/formatter/stack/json'
 
-require 'rshade/config'
-require 'rshade/config/store'
+require 'rshade/utils'
+require 'rshade/config/event_store'
 require 'rshade/config/stack_store'
 require 'rshade/config/registry'
 

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rshade
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Ivan Lopatin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -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
@@ -113,10 +72,9 @@ files:
 - bin/setup
 - html/template.html.erb
 - lib/rshade.rb
-- lib/rshade/config.rb
+- lib/rshade/config/event_store.rb
 - lib/rshade/config/registry.rb
 - lib/rshade/config/stack_store.rb
-- lib/rshade/config/store.rb
 - lib/rshade/core_extensions/object/reveal.rb
 - lib/rshade/event.rb
 - lib/rshade/event_observer.rb
@@ -132,18 +90,17 @@ files:
 - lib/rshade/formatter/stack/json.rb
 - lib/rshade/formatter/stack/stdout.rb
 - lib/rshade/formatter/stack/string.rb
-- lib/rshade/formatter/trace/file.rb
 - lib/rshade/formatter/trace/html.rb
 - 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
 - lib/rshade/stack_frame.rb
 - lib/rshade/trace.rb
 - lib/rshade/trace_observable.rb
+- lib/rshade/utils.rb
 - lib/rshade/version.rb
 - rshade.gemspec
 - shade.jpg
@@ -156,6 +113,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 +122,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:
   - - ">="

data/lib/rshade/config/store.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module RShade
-  class Config
-    class Store
-      attr_reader :filter_composition, :formatter, :tp_events, :custom_serializers
-
-      # @param [Hash] options
-      # @option options [RShade::Filter::FilterComposition] :filter_composition
-      # @option options [#call(event_store)] :formatter
-      # @option options [Array<Symbol>] :tp_events
-      def initialize(options = {})
-        @filter_composition = options.fetch(:filter_composition, default_filter_composition)
-        @formatter = options.fetch(:formatter, ::RShade::Formatter::Trace::Stdout)
-        @tp_events = options.fetch(:tp_events, %i[call return])
-        @custom_serializers = options.fetch(:custom_serializers, {})
-      end
-
-      def set_tp_events(tp_events)
-        @tp_events = tp_events
-        self
-      end
-
-      def add_custom_serializers(hash)
-        custom_serializers.merge!(hash)
-        self
-      end
-
-      def config_filter(filter_type, &block)
-        filter_composition.config_filter(filter_type, &block)
-        self
-      end
-
-      def set_formatter(formatter)
-        @formatter = formatter
-        self
-      end
-
-      private
-
-      def default_filter_composition
-        RShade::Filter::FilterBuilder.build([:or,
-                                             [:or, RShade::Filter::VariableFilter.new, RShade::Filter::IncludePathFilter.new], RShade::Filter::ExcludePathFilter.new])
-      end
-    end
-  end
-end

data/lib/rshade/config.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module RShade
-  class Config
-    RUBY_VERSION_PATTERN = /ruby-[0-9.]*/
-
-    def self.default
-      ::RShade::Config::Store.new.set_formatter(::RShade::Formatter::Trace::Stdout.new)
-                             .config_filter(::RShade::Filter::ExcludePathFilter) do |paths|
-        default_excluded_path.each do |path|
-          paths << path
-        end
-      end
-    end
-
-    # @param [RShade::Config::Store] config_store
-    def initialize(config_store)
-      @config_store = config_store
-    end
-
-    # @param [Hash] options
-    # @option options [RShade::Filter::FilterComposition] :filter_composition
-    # @option options [#call(event_store)] :formatter
-    # @option options [Array<Symbol>] :tp_events
-    def self.create(options = {})
-      new(Config::Store.new(options))
-    end
-
-    def tp_events(&block)
-      events = block.call
-      @config_store.set_tp_events(events)
-      self
-    end
-
-    def include_paths(&block)
-      @config_store.config_filter(::RShade::Filter::IncludePathFilter, &block)
-      self
-    end
-
-    def exclude_paths(&block)
-      @config_store.config_filter(::RShade::Filter::ExcludePathFilter, &block)
-      self
-    end
-
-    def match_variable(&block)
-      @config_store.config_filter(::RShade::Filter::VariableFilter, &block)
-      self
-    end
-
-    def formatter(&block)
-      formatter = block.call
-      @config_store.set_formatter(formatter)
-      self
-    end
-
-    def add_custom_serializers(hash)
-      @config_store.add_custom_serializers(hash)
-      self
-    end
-
-    def value
-      @config_store
-    end
-
-    def self.store_dir
-      File.expand_path('../../tmp', __dir__)
-    end
-
-    def self.root_dir
-      @root_dir ||= File.expand_path('../../', __dir__)
-    end
-
-    def self.default_excluded_path
-      [ENV['GEM_PATH'].split(':'), RUBY_VERSION_PATTERN, /internal/].flatten.compact
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module RShade
-  module Formatter
-    module Trace
-      class File
-        attr_reader :formatter
-
-        FILE_NAME = 'stacktrace.json'
-
-        def initialize(args = {})
-          @formatter = args.fetch(:format, Json)
-        end
-
-        # @param [RShade::EventProcessor] event_store
-        def call(event_store)
-          data = formatter.call(event_store)
-          if formatter == Json
-            write_to_file(JSON.pretty_generate(data))
-          else
-            write_to_file(data.to_s)
-          end
-        end
-
-        def write_to_file(data)
-          ::File.open(::File.join(RShade::Config.store_dir, FILE_NAME), 'w+') do |f|
-            f.write data
-          end
-        end
-      end
-    end
-  end
-end