rshade 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df1b60bffc16ead7fcebdeb882136144baa8e1fa33b2f4bad417dd3dfe68d92
-  data.tar.gz: 072dcf363cfb6e9ac2112970fe133c8551fb9c3be7e02ad826ae8b19ca39a5f5
+  metadata.gz: 5594d3ba4348f6f4c4b73a74c223a7b30f3b7eda7216c72d0d122079cae63bf7
+  data.tar.gz: b071916008465bed00ff107b8b88fe778235a333e1a24c74af5ea62631ec4b75
 SHA512:
-  metadata.gz: 9a4fec3f4b69197d872ff150aaf31e8202ada46b5a44d3b0d63ee8f831807f2db20db3e1a403e490ca3605e7d026099c51e4fdd55a8603e343a08b84fcb873ca
-  data.tar.gz: a27714bfafda9b4d26adb96c135ea596d37a212586ede2a0df7cab2c751998cae205c16dfdb7d32fb903f2f343dfbf04dce73105f50e30ed98bea927083f8f5b
+  metadata.gz: b4a81694ecce4e7063a8a8d4cd5ed758ea93ca151aa0b09cd785e281d206c4cdcdfa389237523fe05f57441c6f4ad648f5cd60e1abb46793162b2ff182965555
+  data.tar.gz: 756a618370faa424864563640ac0389124201bc5c49eb47fdb6cae0fe8f535dadc7c97c366b6c5dfaa330700a39d9e2eaa6e9caad9538209319a7da9587c142f

data/Gemfile.lock

@@ -14,7 +14,7 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -35,9 +35,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   pry
-  rake (~> 10.0)
+  rake (>= 12.3.3)
   rshade!
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -5,8 +5,7 @@
 Ruby Shade or RShade gem to help you to reveal what lines of code are used in program execution.
   
 ```ruby
-trace = RShade::Trace.new  
-trace.reveal do  
+trace = RShade::Trace.reveal do  
   #your code here
 end
 trace.show

data/lib/rshade.rb

@@ -1,10 +1,16 @@
 require 'colorize'
 require 'rshade/configuration'
-require 'rshade/source'
-require 'rshade/tree'
-require 'rshade/source_node'
+require 'rshade/base'
+require 'rshade/event_serializer'
+require 'rshade/filter/app_filter'
+require 'rshade/formatter/string'
+require 'rshade/formatter/json'
+require 'rshade/formatter/stdout'
+require 'rshade/formatter/http'
+require 'rshade/event'
+require 'rshade/event_store'
 require 'rshade/trace'
-require 'rshade/rspec'
+require 'rshade/rspec/rspec'
 require 'rshade/version'
 
 
@@ -15,7 +21,7 @@ module RShade
   class << self
     attr_writer :config
 
-    def configuration
+    def config
       @config ||= Configuration.new
     end
 

data/lib/rshade/base.rb

@@ -0,0 +1,13 @@
+module RShade
+  class Base
+    def initialize(*args); end
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def call
+      raise NotImplementedError
+    end
+  end
+end

data/lib/rshade/configuration.rb

@@ -2,21 +2,17 @@ module RShade
   class Configuration
     RUBY_VERSION_PATTERN = /ruby-[0-9.]*/
 
-    attr_accessor :custom_arg_print, :included_gems
+    attr_accessor :track_gems, :filter, :formatter
 
     def initialize
-      @included_gems = []
-    end
-
-    def default_arg_print(args)
-
+      @track_gems = Set.new
     end
 
     def excluded_paths
       @excluded_paths ||= begin
         paths = [ENV['GEM_PATH'].split(':'), parse_ruby_version].flatten.compact
         paths.reject do |v|
-          included_gems.any? { |gem_name| v.include? gem_name }
+          track_gems.any? { |gem_name| v.include? gem_name }
         end
       end
     end
@@ -28,5 +24,16 @@ module RShade
       val[0]
     end
 
+    def filter
+      @filter ||= ::RShade::Filter::AppFilter
+    end
+
+    def formatter
+      @formatter ||= ::RShade::Formatter::Stdout
+    end
+
+    def store_dir
+      File.expand_path('../../tmp', __dir__)
+    end
   end
 end

data/lib/rshade/event.rb

@@ -0,0 +1,35 @@
+module RShade
+  # nodoc
+  class Event
+    attr_reader :hash
+    attr_accessor :depth
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def level
+      @hash[:level]
+    end
+
+    def klass
+      @hash[:klass]
+    end
+
+    def path
+      @hash[:path]
+    end
+
+    def lineno
+      @hash[:lineno]
+    end
+
+    def method_name
+      @hash[:method_name]
+    end
+
+    def vars
+      @hash[:vars]
+    end
+  end
+end

data/lib/rshade/event_serializer.rb

@@ -0,0 +1,29 @@
+require 'date'
+module RShade
+  class EventSerializer < Base
+    attr_reader :evt, :level
+    SERIALIZE_CLASSES = [NilClass, TrueClass, FalseClass, Numeric, Time, Date, String, Symbol, Array, Hash]
+    def initialize(evt, level)
+      @evt = evt
+      @level = level
+    end
+
+    def call
+      { level: @level, path: evt.path, lineno: evt.lineno, klass: evt.defined_class, method_name: evt.method_id, vars: process_locals(evt) }
+    end
+
+    def process_locals(evt)
+      vars = {}
+      evt.binding.local_variables.each do |var|
+        local_var = evt.binding.local_variable_get var
+        if SERIALIZE_CLASSES.any? { |klass| local_var.is_a?(klass) }
+          vars[var] = local_var
+        else
+          class_name =  local_var.is_a?(Class) ? local_var.to_s : local_var.class.to_s
+          vars[var] = "FILTERED[#{class_name}]"
+        end
+      end
+      vars
+    end
+  end
+end

data/lib/rshade/event_store.rb

@@ -0,0 +1,23 @@
+module RShade
+  # nodoc
+  class EventStore
+    attr_reader :events
+
+    def initialize
+      @events = []
+    end
+
+    def <<(event)
+      events << event
+    end
+
+    def iterate(&block)
+      pos_map = {}
+      @events.map {|item| item.level }.uniq.sort.each_with_index { |item, index| pos_map[item] = index}
+      @events.uniq{|item| [item.level, "#{item.klass}##{item.method_name}"]}.sort_by { |item| item.depth }.each do |item|
+        item.depth = pos_map[item.level]
+        yield(item, item.depth)
+      end
+    end
+  end
+end

data/lib/rshade/filter/app_filter.rb

@@ -0,0 +1,20 @@
+module RShade
+  module Filter
+    class AppFilter < ::RShade::Base
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def call
+        valid?(data[:path])
+      end
+
+      def valid?(path)
+        return true if RShade.config.track_gems.any? { |item| path.include? item }
+        RShade.config.excluded_paths.none? { |item| path.include? item }
+      end
+    end
+  end
+end

data/lib/rshade/formatter/http.rb

@@ -0,0 +1,8 @@
+module RShade
+  module Formatter
+    class Http < ::RShade::Base
+      def call
+      end
+    end
+  end
+end

data/lib/rshade/formatter/json.rb

@@ -0,0 +1,70 @@
+module RShade
+  module Formatter
+    class Json < ::RShade::Base
+      attr_reader :event_store
+      FILE_NAME = 'stacktrace.json'.freeze
+
+      def initialize(event_store)
+        @event_store = event_store
+      end
+
+      def call
+        flat
+      end
+
+      def flat
+        arr = []
+        event_store.iterate do |node, depth|
+          arr << item(node)
+        end
+        write_to_file(JSON.pretty_generate(arr.sort_by { |item| item[:depth]}))
+        arr
+      end
+
+      def hierarchical
+        hash = {}
+        event_store.iterate do |node, depth|
+          ref = hash_iterate(hash, depth)
+          ref[:data] = item(node)
+        end
+        hash = sort_hash(hash)
+        write_to_file(JSON.pretty_generate(hash))
+        hash
+      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 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}",
+            depth: value.depth,
+            vars: value.vars
+        }
+      end
+    end
+  end
+end

data/lib/rshade/formatter/stdout.rb

@@ -0,0 +1,10 @@
+module RShade
+  module Formatter
+    class Stdout < String
+      def call
+        buffer = super
+        puts buffer
+      end
+    end
+  end
+end

data/lib/rshade/formatter/string.rb

@@ -0,0 +1,30 @@
+module RShade
+  module Formatter
+    class String < ::RShade::Base
+      attr_reader :event_store
+      ROOT_SEP = "---\n"
+
+      def initialize(event_store)
+        @event_store = event_store
+      end
+
+      def call
+        buffer = StringIO.new
+        event_store.iterate do |node, depth|
+          if depth == 1
+            buffer << ROOT_SEP
+            next
+          end
+          puts line(node, depth)
+        end
+        buffer.string
+      end
+
+      def line(value, depth)
+        class_method = "#{value.klass}##{value.method_name}".colorize(:green)
+        full_path = "#{value.path}:#{value.lineno}".colorize(:blue)
+        "#{'  ' * depth}#{class_method}(#{value.vars}) -> #{full_path}\n"
+      end
+    end
+  end
+end

data/lib/rshade/{rspec.rb → rspec/rspec.rb}

@@ -2,15 +2,13 @@ module RShade
   REPORTS = []
 
   module RSpecHelper
-    def rshade_reveal(type = ::RShade::APP_TRACE, options = {})
+    def rshade_reveal(options = {})
       raise 'No block given' unless block_given?
-
-      trace = Trace.new
-      trace.reveal(options) do
+      options.merge!(formatter: Formatter::String) { |_key,v1, _v2| v1 }
+      result = Trace.reveal(options) do
         yield
       end
-
-      REPORTS.push trace.show(type)
+      REPORTS.push result.show
     end
   end
 end

data/lib/rshade/storage.rb

@@ -0,0 +1,4 @@
+module RShade
+  class Storage
+  end
+end

data/lib/rshade/trace.rb

@@ -1,68 +1,53 @@
 module RShade
   class Trace
-    attr_accessor :source_tree, :options
+    attr_accessor :event_store, :formatter, :filter
     EVENTS = %i[call return].freeze
 
-    def initialize
-      @source_tree = SourceNode.new(nil)
+    def initialize(options={})
+      @event_store = EventStore.new
+      @formatter = options.fetch(:formatter, RShade.config.formatter)
+      @filter = options.fetch(:filter, RShade.config.filter)
       @tp = TracePoint.new(*EVENTS, &method(:process_trace))
-      @stack = [@source_tree]
+      @level = 1
+      @stat = {}
+      @calls = 0
+      @returns = 0
     end
 
-    def reveal(options = {})
+    def self.reveal(options={}, &block)
+      new(options).reveal(&block)
+    end
+
+    def reveal
       return unless block_given?
 
       @tp.enable
       yield
+      self
     ensure
       @tp.disable
     end
 
-    def show(type = ::RShade::APP_TRACE)
-      return show_app_trace if type == ::RShade::APP_TRACE
-
-      show_full_trace
+    def show
+      formatter.call(event_store)
     end
 
-    def show_full_trace(tree = nil)
-      buffer = StringIO.new
-      tree ||= source_tree
-      tree.pre_order_traverse do |node, depth|
-        if node.root?
-          buffer << "---\n"
-          next
-        end
-
-        buffer << "#{'  ' * depth} #{node.value.pretty}\n" if node.value
-      end
-      puts buffer.string
-    end
-
-    def show_app_trace
-      clone = source_tree.clone_by do |node|
-        next true if node.root?
-
-        node.value.app_code?
-      end
-      show_full_trace(clone)
+    def stat
+      { calls: @calls, returns: @returns }
     end
 
     def process_trace(tp)
       if tp.event == :call
-        parent = @stack.last
-        vars = {}
-        tp.binding.local_variables.each do |var|
-          vars[var] = tp.binding.local_variable_get var
-        end
-        hash = { level: @stack.size, path: tp.path, lineno: tp.lineno, klass: tp.defined_class, method_name: tp.method_id, vars: vars }
-        node = SourceNode.new(Source.new(hash))
-        node.parent = parent
-        parent << node
-        @stack.push node
+        @level +=1
+        hash = EventSerializer.call(tp, @level)
+        return unless filter.call(hash)
+        @calls += 1
+        event_store << Event.new(hash)
       end
 
-      if tp.event == :return && @stack.size > 1
-        @stack.pop
+      if tp.event == :return && @level > 0
+        @returns += 1
+        @level -=1
       end
     end
   end

data/lib/rshade/version.rb

@@ -1,3 +1,3 @@
 module RShade
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/rshade.gemspec

@@ -39,6 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'colorize'
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/todo.md

@@ -0,0 +1,8 @@
+1. Should I use rails way organizing module/file naming or not?
+2. Reduce global state usage
+3. Problem with stack deep
+4. Problem when have binary values error in serialization (Encoding problems)
+5. Make filter while tracing that will be more efficient
+6. sort depth and than replace values
+7. tree not working bcz of vars serialization
+8. Some classes in Rails can't serialize safely produce StackTraceTooDeep

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rshade
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Ivan Lopatin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,15 +84,24 @@ files:
 - bin/console
 - bin/setup
 - lib/rshade.rb
+- lib/rshade/base.rb
 - lib/rshade/configuration.rb
-- lib/rshade/rspec.rb
-- lib/rshade/source.rb
-- lib/rshade/source_node.rb
+- lib/rshade/event.rb
+- lib/rshade/event_serializer.rb
+- lib/rshade/event_store.rb
+- lib/rshade/filter/app_filter.rb
+- lib/rshade/formatter/http.rb
+- lib/rshade/formatter/json.rb
+- lib/rshade/formatter/stdout.rb
+- lib/rshade/formatter/string.rb
+- lib/rshade/rails/rails.rb
+- lib/rshade/rspec/rspec.rb
+- lib/rshade/storage.rb
 - lib/rshade/trace.rb
-- lib/rshade/tree.rb
 - lib/rshade/version.rb
 - rshade.gemspec
 - shade.jpg
+- todo.md
 homepage: https://github.com/gingray/rshade
 licenses:
 - MIT
@@ -116,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: https://github.com/gingray/rshade

data/lib/rshade/source.rb

@@ -1,46 +0,0 @@
-module RShade
-  # nodoc
-  class Source
-
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def klass
-      @hash[:klass]
-    end
-
-    def lib_code?
-      !app_code?
-    end
-
-    def app_code?
-      return true if RShade.configuration.included_gems.any? { |item| path.include? item }
-
-      @app_code ||= RShade.configuration.excluded_paths.none? { |item| path.include? item }
-    end
-
-    def path
-      @hash[:path]
-    end
-
-    def lineno
-      @hash[:lineno]
-    end
-
-    def method_name
-      @hash[:method_name]
-    end
-
-    def vars
-      @hash[:vars]
-    end
-
-
-    def pretty
-      class_method = "#{klass}##{method_name}".colorize(:green)
-      full_path = "#{path}:#{lineno}".colorize(:blue)
-      "#{class_method}(#{vars.to_json}) -> #{full_path}"
-    end
-  end
-end

data/lib/rshade/source_node.rb

@@ -1,23 +0,0 @@
-module RShade
-  # nodoc
-  class SourceNode < Tree
-    def initialize(value = nil)
-      super(value)
-    end
-
-    def clone_by(new_tree = SourceNode.new(nil), &block)
-      if yield(self)
-        new_tree.value = value
-        node = SourceNode.new(nil)
-        node.parent = new_tree
-        new_tree << node
-        new_tree = node
-      end
-
-      nodes.each do |item|
-        item.clone_by(new_tree, &block)
-      end
-      new_tree
-    end
-  end
-end

data/lib/rshade/tree.rb

@@ -1,30 +0,0 @@
-module RShade
-  # nodoc
-  class Tree
-    attr_accessor :parent, :value
-    attr_reader :nodes
-
-    def initialize(value = nil)
-      @value = value
-      @nodes = []
-      @parent = nil
-    end
-
-    def root?
-      !parent
-    end
-
-    def <<(node)
-      @nodes << node
-    end
-
-    def pre_order_traverse(depth = 0, &block)
-      return unless block_given?
-
-      yield(self, depth)
-      nodes.each do |item|
-        item.pre_order_traverse(depth + 1, &block)
-      end
-    end
-  end
-end