rshade 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10cfe61e925b1882ff42ea7580a2a6d72b5eadd4f18831a7e52813e22d1daea
-  data.tar.gz: cfe32fccff6bd61114bb86d0fd0d790d66c61ca41ce7bda0fc39e03af73ddb46
+  metadata.gz: e5ef0c31c59c3ed46f44326e1e28f6a5b2b2ccbdbce32152e6b54233f875d6d0
+  data.tar.gz: f394a28db1cda3274954309996eaea895bf715737f34aecbb09c0d0873fd09fb
 SHA512:
-  metadata.gz: 34222d8c0982a0af1ccbd37a2436f3dfa58d164ad4614a51db4c2074aff55f5adc873aa89008b173a065ec83975b3e67f9266437931efc1725baf50d04638bd5
-  data.tar.gz: 231f085edc963e287f1e8ae1b0843567ff5857cbfd50d80e240548e143148609c44d02d76204a6dd021765785c7ce347e6d7dcdeb49a388ff08197ce52074f45
+  metadata.gz: 956a68bec41feea89513eab5e0002fadb70d9d0f9e57f1c47f316d2c30c6e801cb510a80312e54b9d075c4fa7f768ad6b2acc881dc3db03680a9351abe56dda4
+  data.tar.gz: 4bafb27714ffaf13734f99522897b3057da42f5bf4eb05929b824af9c67f19076f304373ab835f1cf0b0bb3ef5a253a1fd23ec343236596255b64f34290702b3

data/.gitignore

@@ -6,6 +6,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea
 
 # rspec failure tracking
 .rspec_status
+.ruby-version
+.DS_Store
+test.rb

data/Gemfile.lock

@@ -1,43 +1,44 @@
 PATH
   remote: .
   specs:
-    rshade (0.1.7)
+    rshade (0.1.9)
       colorize
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
+    coderay (1.1.3)
     colorize (0.8.1)
-    diff-lcs (1.3)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2.33)
   pry
   rake (>= 12.3.3)
   rshade!
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.3
+   2.2.33

data/README.md

@@ -2,20 +2,82 @@
  
 ![warcraft shade](https://github.com/gingray/rshade/raw/master/shade.jpg)
 
-Ruby Shade or RShade gem to help you to reveal what lines of code are used in program execution.
-  
+RShade is a debugging/code exploration tool based on `TracePoint` functionality. 
+Recent years I've working with relatively huge legacy code and I need a tool which can help me to figure out what is going on due execution. 
+Luckely Ruby have build in functionality to achieve it, but it's pretty low level. It was my motivation to create `RShade` it helps me to save tons of time 
+when I face with something not trivial or a good start point to create dependency map when I do refactoring or bugfix. Tool still in beta and it's possible that there
+is some bugs, but it's do the job.  
+
+## How it works?
+```shell
+gem install rshade
+```
+Simple wrap code that you want to check in to block and it will pretty print all of the calls which was made in this block with pointing line of executions, variables what was pass
+inside methods and variables what was return
 ```ruby
-trace = RShade::Trace.reveal do  
+RShade::Trace.reveal do  
   #your code here
-end
-trace.show
-#rspec
- rshade_reveal do
-   #code here
- end 
+end.show
+```
+Due that tool create a detailed log with all of the steps of execution it's hard to read (it's can easelly be 20 - 30k lines because it's shows not only your custom code but also
+code in gems that are involved in execution). `RShade` have filters to tackle this problem. Default filter is illiminate all code related to gems and only expose app code itself. You can 
+change this behaviour or add your own filter. Even when some piece of code are not shown due filtration order of calls and execution still shown in correct way.
+
+## Table of Contents
+ - [Configuration](#configuration)
+ - [Filters](#filters)
+   - [Filter by path include](#filter-by-path-include)
+   - [Filter by path exclude](#filter-by-path-exclude)
+   - [Filter by variable name or value](#filter-by-variable-name-or-value)
+ - [Examples](#examples)
+
+### Configuration
+```ruby
+config = ::RShade::Config.default
+
+RShade::Trace.reveal(config) do
+end.show
+```
+### Filters
+Filters by default represent by expression `(include_path or variable_match) or (not exclude_path)`
+Filters can be chained like:
+```ruby
+config = ::RShade::Config.default.include_paths { |paths| paths << /devise/ }
+                                  .exclude_paths { |paths| paths << /warden/ } 
+                                  .match_variable { |name, value| name == :current_user }
+```
+#### Filter by path include
+`paths` - is array which accept regex or string
+```ruby
+config = ::RShade::Config.default.include_paths { |paths| paths << /devise/ }
+
+RShade::Trace.reveal(config) do
+   #your code
+end.show
 
 ```
-## Example
+#### Filter by path exclude
+`paths` - is array which accept regex or string
+```ruby
+config = ::RShade::Config.default.exclude_paths { |paths| paths << /devise/ }
+
+RShade::Trace.reveal(config) do
+   #your code
+end.show
+```
+
+#### Filter by variable name or value
+`name` - represent variable name as symbol
+`value` - actual variable value
+```ruby
+config = ::RShade::Config.default.match_variable { |name, value| name == :current_user }
+
+RShade::Trace.reveal(config) do
+   #your code
+end.show
+```
+
+## Examples
 I've took example from https://github.com/spree/spree code base. Wrap code to take a look what code is in use when you save variant.
 On such huge codebase as spree it's helpful to know what callbacks are triggered and so on.
 ```ruby
@@ -24,7 +86,7 @@ On such huge codebase as spree it's helpful to know what callbacks are triggered
       before { variant.cost_currency = nil }
 
       it 'populates cost currency with the default value on save', focus: true do
-        rshade_reveal do
+         RShade::Trace.reveal do
           variant.save!
         end
         expect(variant.cost_currency).to eql 'USD'
@@ -32,18 +94,11 @@ On such huge codebase as spree it's helpful to know what callbacks are triggered
     end
   end
 ```
+
 Below is example how output will look like.
 As you can see all code that have been in use is printed.
 [![asciicast](https://asciinema.org/a/MR5KL7TmHmYRUhwBUWQjBI373.svg)](https://asciinema.org/a/MR5KL7TmHmYRUhwBUWQjBI373)
 
-## Installation  
-  
-Add this line to your application's Gemfile:  
-  
-```ruby  
-gem 'rshade'  
-```  
-  
 ## TODO  
 Use stack to keep connections between current method and caller  
 take a look on https://github.com/matugm/visual-call-graph  

data/lib/rshade/binding_serializer.rb

@@ -0,0 +1,35 @@
+require 'date'
+module RShade
+  class BindingSerializer
+    SERIALIZE_CLASSES = [NilClass, TrueClass, FalseClass, Numeric, Time, Date, String, Symbol, Array]
+    
+    def initialize(opts={})
+    end
+
+    def call(trace_binding)
+      vars = {}
+      trace_binding.each do |name, value|
+        if SERIALIZE_CLASSES.any? { |klass| value.is_a?(klass) }
+          vars[name] = value
+        elsif value.is_a?(Hash)
+          copy = shallow_copy_of_hash(value)
+          vars[name] = copy
+        else
+          class_name =  value.is_a?(Class) ? value.to_s : value.class.to_s
+          vars[name] = class_name
+        end
+      end
+      vars
+    end
+
+    #TODO: work on more efficient way to serialize hash
+    def shallow_copy_of_hash(hash)
+      {}.tap do |new_hash|
+        hash.each do |k,v|
+          new_hash[k] = v.to_s
+        end
+        new_hash
+      end
+    end
+  end
+end

data/lib/rshade/config/store.rb

@@ -0,0 +1,38 @@
+
+module RShade
+  class Config
+    class Store
+      attr_reader :filter_composition, :formatter, :tp_events
+
+      # @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::Stdout)
+        @tp_events = options.fetch(:tp_events, [:call, :return])
+      end
+
+      def set_tp_events(tp_events)
+        @tp_events = tp_events
+      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

@@ -0,0 +1,71 @@
+module RShade
+  class Config
+    RUBY_VERSION_PATTERN = /ruby-[0-9.]*/
+
+    def self.default
+      ::RShade::Config::Store.new.set_formatter(::RShade::Formatter::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 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
+
+    private
+    def self.default_excluded_path
+      [ENV['GEM_PATH'].split(':'), RUBY_VERSION_PATTERN, /internal/].flatten.compact
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+class Object
+  def reveal(&block)
+    trace = ::RShade::Trace.reveal do
+      block.call
+    end
+    trace.show
+  end
+end

data/lib/rshade/event.rb

@@ -1,35 +1,60 @@
 module RShade
   # nodoc
   class Event
-    attr_reader :hash
-    attr_accessor :depth
+    attr_reader :hash, :skipped
+    RETURN_EVENTS = [:return, :b_return, :c_return]
+
 
     def initialize(hash)
       @hash = hash
     end
 
-    def level
-      @hash[:level]
+    [:klass, :path, :lineno, :method_name, :vars, :level, :return_value].each do |method_name|
+      define_method method_name do
+        fetch method_name
+      end
+    end
+
+    def with_level!(level)
+      @hash[:level] = level
+      self
     end
 
-    def klass
-      @hash[:klass]
+    def set_return_value!(return_value)
+      @hash[:return_value] = return_value
+      self
     end
 
-    def path
-      @hash[:path]
+    def with_serialized_return!(serializer)
+      @hash[:return_value] = serializer.call(@hash[:return_value])
+      self
     end
 
-    def lineno
-      @hash[:lineno]
+    def with_serialized_vars!(serializer)
+      @hash[:vars] = serializer.call(@hash[:vars])
+      self
     end
 
-    def method_name
-      @hash[:method_name]
+    def self.from_trace_point(evt)
+      vars = {}
+      evt.binding.local_variables.each do |var_name|
+        vars[var_name] = evt.binding.local_variable_get var_name
+      end
+
+      hash = { path: evt.path, lineno: evt.lineno, klass: evt.defined_class, method_name: evt.method_id, vars: vars,
+               event_type: evt.event }
+      hash.merge!({return_value: evt.return_value}) if RETURN_EVENTS.include?(evt.event)
+      new(hash)
     end
 
-    def vars
-      @hash[:vars]
+    def self.create_blank(level)
+      new({level: level}, true)
+    end
+
+    private
+
+    def fetch(key)
+      @hash[key]
     end
   end
 end

data/lib/rshade/event_observer.rb

@@ -0,0 +1,45 @@
+module RShade
+  class EventObserver
+    attr_reader :event_processor, :config
+
+    # @param [RShade::Config::Store] config
+    # @param [RShade::EventProcessor] event_store
+    def initialize(config, event_processor)
+      @event_processor = event_processor
+      @config = config
+      @level = 0
+      @hook = Hash.new(0)
+      @hook[:enter] = 1
+      @hook[:leave] = -1
+    end
+
+    # @param [:enter, :leave, :other] type
+    # @param [RShade::Event] event
+    def call(event, type)
+      @level += @hook[type]
+      return unless pass?(event)
+
+      enter(event) if type == :enter
+      leave(event) if type == :leave
+      other(event) if type == :other
+    end
+
+    private
+
+    def enter(event)
+      event_processor.enter event, @level
+    end
+
+    def leave(event)
+      event_processor.leave event, @level
+    end
+
+    def other(event)
+      event_processor.other event, @level
+    end
+
+    def pass?(event)
+      config.filter_composition.call(event)
+    end
+  end
+end

data/lib/rshade/event_processor.rb

@@ -0,0 +1,35 @@
+module RShade
+  # nodoc
+  class EventProcessor
+    attr_reader :store
+
+    def initialize(store)
+      @store = store
+      @var_serializer = BindingSerializer.new
+    end
+
+    # @param [RShade::Event] event
+    # @param [Integer] level
+    def enter(event, level)
+      event.with_serialized_vars!(@var_serializer).with_level!(level)
+      store.add(event, level)
+    end
+
+    # @param [RShade::Event] event
+    # @param [Integer] level
+    def leave(event, level)
+      store.current! do |node|
+          node.value.set_return_value!(event.return_value)
+              .with_serialized_return!(->(value) { value.inspect })
+      end
+    rescue => e
+      # this rescue here due this issue which reproduce in ruby-2.6.6 at least
+      # https://bugs.ruby-lang.org/issues/18060
+    end
+    # @param [RShade::Event] event
+    # @param [Integer] level
+    def other(event, level)
+
+    end
+  end
+end

data/lib/rshade/event_tree.rb

@@ -0,0 +1,75 @@
+module RShade
+  class EventTree
+    include Enumerable
+
+    attr_reader :current, :head
+
+    def initialize
+      @current = @head = EventTreeNode.new(nil, 0, nil)
+    end
+
+    def add(value, level)
+      if current.level + 1 == level
+        current.children << EventTreeNode.new(value, level, current)
+        return
+      end
+      if current.level + 1 < level
+
+        last = current.children.last
+        unless last
+          current.children << EventTreeNode.new(nil, current.level + 1 , current)
+        end
+        @current = current.children.last
+        add(value, level)
+        return
+      end
+
+      if current.level + 1 > level
+        unless current.parent
+          return
+        end
+        @current = current.parent
+        add(value, level)
+      end
+    end
+
+    def current!(&block)
+      block.call(current.children.last) if current.children.last
+    end
+
+    def each(&block)
+      @head.each(&block)
+    end
+  end
+
+  class EventTreeNode
+    include Enumerable
+    attr_reader :children, :level, :vlevel, :value
+    attr_accessor :parent
+
+    def initialize(value, level, parent=nil)
+      @children = []
+      @level = level
+      @parent = parent
+      @value = value
+      @vlevel = set_vlevel(parent)
+    end
+
+    def each(&block)
+      block.call(self) if parent != nil || value != nil
+      children.each { |item| item.each(&block) }
+    end
+
+    private
+
+    def set_vlevel(node)
+      return 0 if node == nil
+
+      if node.value || node.level == 0
+        node.vlevel + 1
+      else
+        set_vlevel(node.parent)
+      end
+    end
+  end
+end

data/lib/rshade/filter/abstract_filter.rb

@@ -0,0 +1,26 @@
+module RShade
+  module Filter
+    class AbstractFilter
+      def name
+        raise NotImplementedError
+      end
+
+      def priority
+        raise NotImplementedError
+      end
+
+      def call(event)
+        raise NotImplementedError
+      end
+
+      def config_call
+        raise NotImplementedError
+      end
+
+      def config(&block)
+        config_call(&block)
+        self
+      end
+    end
+  end
+end

data/lib/rshade/filter/default.rb

@@ -0,0 +1,28 @@
+module RShade
+  module Filter
+    class Default
+      RUBY_VERSION_PATTERN = /ruby-[0-9.]*/
+
+      def self.create
+        new.create
+      end
+
+      def create
+        [create_exclude]
+      end
+
+      def create_exclude
+        filter = ExcludePathFilter.new
+        filter.config do |paths|
+          excluded_paths.each do |path|
+            paths << path
+          end
+        end
+      end
+
+      def excluded_paths
+        [ENV['GEM_PATH'].split(':'), RUBY_VERSION_PATTERN, /internal/].flatten.compact
+      end
+    end
+  end
+end

data/lib/rshade/filter/exclude_path_filter.rb

@@ -0,0 +1,24 @@
+module RShade
+  module Filter
+    class ExcludePathFilter < IncludePathFilter
+      NAME = :exclude_paths
+
+      def name
+        NAME
+      end
+
+      def priority
+        0
+      end
+
+      private
+      def str?(str, event_path)
+        !event_path.include?(str)
+      end
+
+      def regexp?(regex, event_path)
+        !regex.match?(event_path)
+      end
+    end
+  end
+end