rshade 0.1.9.1 → 0.2.1

data/lib/rshade/trace.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module RShade
   class Trace
     attr_reader :config, :event_store
-    
+
     # @param [RShade::Config,RShade::Config::Store] config
     def initialize(config)
       @config = fetch_config(config)
       @event_store = EventTree.new
     end
 
-    def self.reveal(config=nil, &block)
+    def self.reveal(config = nil, &block)
       new(config).reveal(&block)
     end
 
@@ -16,7 +18,7 @@ module RShade
       processor = EventProcessor.new(event_store, config)
       observer = EventObserver.new(config, processor)
       observable = RShade::TraceObservable.new([observer], config)
-      observable.reveal &block
+      observable.reveal(&block)
       self
     end
 
@@ -25,8 +27,9 @@ module RShade
     end
 
     private
+
     def fetch_config(config)
-      config = config || ::RShade::Config.default
+      config ||= ::RShade::Config.default
       config = config.value if config.is_a?(::RShade::Config)
       config
     end

data/lib/rshade/trace_observable.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module RShade
   class TraceObservable
     include Observable
     attr_reader :trace_p
+
     CALL_EVENTS = Set[:call, :c_call, :b_call]
     RETURN_EVENTS = Set[:return, :c_return, :b_return]
 
@@ -27,13 +30,15 @@ module RShade
     end
 
     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
   end

data/lib/rshade/version.rb

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

data/lib/rshade.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 require 'colorized_string'
+require 'binding_of_caller'
 require 'erb'
 require 'weakref'
-require 'set'
 require 'observer'
-require 'rshade/config'
-require 'rshade/config/store'
+require 'json'
+require 'singleton'
+
 require 'rshade/serializer/traversal'
 require 'rshade/event_tree'
 require 'rshade/event_processor'
@@ -17,14 +20,28 @@ require 'rshade/filter/include_path_filter'
 require 'rshade/filter/exclude_path_filter'
 require 'rshade/filter/variable_filter'
 require 'rshade/filter/default'
-require 'rshade/formatter/string'
-require 'rshade/formatter/json'
-require 'rshade/formatter/file'
-require 'rshade/formatter/html'
-require 'rshade/formatter/stdout'
+
+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'
+
+require 'rshade/formatter/stack/string'
+require 'rshade/formatter/stack/stdout'
+require 'rshade/formatter/stack/json'
+
+require 'rshade/config'
+require 'rshade/config/store'
+require 'rshade/config/stack_store'
+require 'rshade/config/registry'
+
 require 'rshade/event'
 require 'rshade/trace'
+require 'rshade/stack'
+require 'rshade/stack_frame'
 require 'rshade/rspec/rspec'
+require 'rshade/core_extensions/object/reveal'
 require 'rshade/version'
 
 module RShade

data/rshade.gemspec

@@ -1,44 +1,46 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rshade/version"
+require 'rshade/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rshade"
+  spec.name          = 'rshade'
   spec.version       = RShade::VERSION
-  spec.authors       = ["Ivan Lopatin"]
-  spec.email         = ["gingray.dev@gmail.com"]
+  spec.authors       = ['Ivan Lopatin']
+  spec.email         = ['gingray.dev@gmail.com']
 
-  spec.summary       = %q{https://github.com/gingray/rshade}
-  spec.description   = %q{https://github.com/gingray/rshade}
-  spec.homepage      = "https://github.com/gingray/rshade"
-  spec.license       = "MIT"
+  spec.summary       = 'https://github.com/gingray/rshade'
+  spec.description   = 'https://github.com/gingray/rshade'
+  spec.homepage      = 'https://github.com/gingray/rshade'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/gingray/rshade"
-    spec.metadata["changelog_uri"] = "https://github.com/gingray/rshade/CHANGELOG.md"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/gingray/rshade'
+    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."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.7.0'
 
-  spec.add_runtime_dependency 'colorize'
+  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,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rshade
 version: !ruby/object:Gem::Version
-  version: 0.1.9.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Ivan Lopatin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2025-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,47 +25,33 @@ 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
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: https://github.com/gingray/rshade
 email:
 - gingray.dev@gmail.com
@@ -75,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -86,6 +73,8 @@ files:
 - html/template.html.erb
 - lib/rshade.rb
 - lib/rshade/config.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
@@ -99,14 +88,18 @@ files:
 - lib/rshade/filter/filter_composition.rb
 - lib/rshade/filter/include_path_filter.rb
 - lib/rshade/filter/variable_filter.rb
-- lib/rshade/formatter/file.rb
-- lib/rshade/formatter/html.rb
-- lib/rshade/formatter/json.rb
-- lib/rshade/formatter/stdout.rb
-- lib/rshade/formatter/string.rb
-- lib/rshade/rails/rails.rb
+- 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/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/version.rb
@@ -121,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:
@@ -129,14 +123,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: https://github.com/gingray/rshade

data/lib/rshade/formatter/file.rb

@@ -1,28 +0,0 @@
-module RShade
-  module Formatter
-    class File
-      attr_reader :formatter
-      FILE_NAME = 'stacktrace.json'.freeze
-
-      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

data/lib/rshade/formatter/html.rb

@@ -1,33 +0,0 @@
-require 'json'
-
-module RShade
-  module Formatter
-    class Html
-      attr_reader :formatter
-      FILE_NAME = 'stacktrace.html'.freeze
-      TEMPLATE = 'html/template.html.erb'
-
-      def initialize(args={})
-        @formatter = args.fetch(:formatter, Json)
-      end
-
-      # @param [RShade::EventProcessor] event_store
-      def call(event_store)
-        data = formatter.call(event_store)
-        erb_template = ERB.new(template)
-        content = erb_template.result_with_hash({json: data.to_json})
-        write_to_file(content)
-      end
-
-      def write_to_file(data)
-        ::File.open(::File.join(RShade::Config.store_dir, FILE_NAME), "w+") do |f|
-          f.write data
-        end
-      end
-
-      def template
-        @template ||=::File.read(::File.join(::RShade::Config.root_dir, TEMPLATE))
-      end
-    end
-  end
-end

data/lib/rshade/formatter/json.rb

@@ -1,59 +0,0 @@
-module RShade
-  module Formatter
-    class Json
-      attr_reader :event_processor
-
-      # @param [RShade::EventProcessor] event_store
-      def call(event_store)
-        @event_store = event_store
-        flat
-      end
-
-      def flat
-        arr = []
-        event_store.each do |node|
-          arr << item(node.event)
-        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
-
-      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
-      end
-
-      def hash_iterate(hash, depth)
-        (0..depth).each do |lvl|
-          unless hash[:inner]
-            hash[:inner] = {}
-          end
-          hash = hash[:inner]
-        end
-        hash
-      end
-
-      def item(value)
-        {
-          class: value.klass.to_s,
-          method_name: value.method_name,
-          full_path: "#{value.path}:#{value.lineno}",
-          level: value.depth,
-          vars: value.vars
-        }
-      end
-    end
-  end
-end

data/lib/rshade/formatter/stdout.rb

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

data/lib/rshade/formatter/string.rb

@@ -1,36 +0,0 @@
-module RShade
-  module Formatter
-    class String
-      ROOT_SEP = "---\n"
-
-      def initialize(opts= {})
-      end
-
-      # @param [RShade::EventProcessor] event_store
-      def call(event_store)
-        buffer = StringIO.new
-        event_store.each_with_index do |node, idx|
-          depth = node.level
-          event = node.value
-          if depth == 1
-            buffer << ROOT_SEP
-            next
-          end
-          next unless event
-          buffer.write line(idx, event, node.vlevel)
-        end
-        buffer.string
-      end
-
-      def line(line_idx, value, depth)
-        vars = value.vars
-        returned = ColorizedString["=> |#{value.return_value}|"].colorize(:magenta)
-
-        class_method = ColorizedString["#{value.klass}##{value.method_name}"].colorize(:green)
-        full_path = ColorizedString["#{value.path}:#{value.lineno}"].colorize(:blue)
-        line_idx = ColorizedString["[#{line_idx}] "].colorize(:red)
-        "#{'  ' * depth}#{line_idx}#{class_method}(#{vars}) #{returned} -> #{full_path}\n"
-      end
-    end
-  end
-end