source_route 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53b09f104ea2720d70ee2312d8233aeefbc5ea6c
-  data.tar.gz: 33f9ec189a6d23df94cd85bd27da378561ebda00
+  metadata.gz: ca12ebcf942682b151bf55b7e80c01b064fe5b04
+  data.tar.gz: f7959a511fb7d8eb531698dacd26df7e06c32ce3
 SHA512:
-  metadata.gz: 64e04570f8a30d20631c86003bc3d311ac15f69a0e31d1b6e080220a553c1e8ad51699745fe4be6bf4f6c82f53266248ca78117e3f0f79da60effa506afdecaf
-  data.tar.gz: f1ba59748e527c875f5f4ac2b9a46cb3287f845f43ee62b38db9ad3cbf8f57ba89c08921c25e21ae53349fadaacd168ba0ec7d255431ac61f327483edfa1bbed
+  metadata.gz: 144b8d6f493591605622a78ed4ff692da65eb44670eae99ec6d566d226f798997088f14e6671440138a228622ff0dae0c2845756caeb1392aeb1df4b717f3a30
+  data.tar.gz: af1a760698f4ad109943c11b67fba8ef8e14da88ba116f45bf4ba70dcadd512f057c1313daa302013e46072d1a123722a821e826dac553266f6e62b62bc28a79

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-#### In irb or pry terminal
+#### In irb or pry
 
     SourceRoute.trace output_format: :console, event: :c_call do
       'abc'.upcase
@@ -30,7 +30,7 @@ Or install it yourself as:
 
 #### In rails console
 
-    SourceRoute.trace defined_class: 'ActiveRecord', output_format: html do
+    SourceRoute.trace defined_class: :ActiveRecord, output_format: :html do
       User.new
     end
 
@@ -80,3 +80,5 @@ see more usage in examples.
 Add debug option to provider more verbose messages of what has happened
 
 Support SourceRoute.enable :wanted_method_or_class, at now only SourceRoute.enable :wanted_method works
+
+When we record both call end return event, it's better to combine them togother into one, so we can get call order from call event and also get return value from return event

data/lib/source_route/formats/html.rb

@@ -6,10 +6,12 @@ module SourceRoute
     module Html
 
       # results is instance of Wrapper
-      def self.render(results)
+      def self.slim_render(results)
         template_path = File.expand_path "../html_template.slim", __FILE__
-        html_output_str = Slim::Template.new(template_path).render(results)
-        File.open("#{Time.now.strftime('%M%S-%H-%m-%d')}-source-route.html", 'w') do |f|
+        slim_template = Slim::Template.new(template_path)
+
+        html_output_str = slim_template.render(results)
+        File.open("#{Time.now.strftime('%S%M-%H-%m')}-source-route.html", 'w') do |f|
           f << html_output_str
         end
       end

data/lib/source_route/formats/html_template.slim

@@ -10,21 +10,22 @@ html
     / workaround for following case:
     / pry(main)> ActiveRecord::Inheritance::ClassMethods.to_json => {} # Dont know why
     ruby:
-      trace_data = @tp_attrs_results.map do |tp_result|
+      local_trace_data = @tp_attrs_results.map do |tp_result|
         if tp_result.has_key?(:defined_class)
-          tp_result[:defined_class] = tp_result[:defined_class].nature_value
+          tp_result[:defined_class] = tp_result[:defined_class].to_s
         end
         tp_result
       end
 
     .data-collect
-      #trace-data data-trace="#{trace_data.to_json}"
+      / dont use local_trace_data.to_json, because ActiveSupport override it and can introduce unexpected crash for some data
+      #trace-data data-trace="#{JSON.dump(local_trace_data)}"
 
     .container(ng-controller="MainCtrl")
       .top-header
         h4
           | Event:
-          =< @conditions.events
+          =< @condition.events
       .trace-flow
         .row
           .left-info.col-sm-4
@@ -33,10 +34,17 @@ html
                 span(ng-bind="klass")
           .center-info.col-sm-6
             .well.well-lg(ng-repeat="trace in traces | filter:{defined_class: selectedKlass}")
-              div(ng-click="showMoreDetail = !showMoreDetail")
+
+              .header(ng-click="showMoreDetail = !showMoreDetail")
                 span(ng-bind="trace.defined_class")
-                span #
+                span
+                  | .
                 span(ng-bind="trace.method_id")
+
+                span<>(ng-if="trace.return_value")
+                  | =>
+                span<>(ng-if="trace.return_value" ng-bind="trace.return_value")
+
               .details(ng-if="showMoreDetail")
                 .local-vars.well.well-sm(ng-if="trace.local_var" style="color: green")
                   span Local Var

data/lib/source_route/tp_result.rb

@@ -14,17 +14,22 @@ module SourceRoute
       c_return: [:defined_class, :method_id, :return_value],
       raise: [:raised_exception],
       b_call: [:binding, :defined_class, :method_id],
-      b_return: [:binding, :defined_class, :method_id],
+      b_return: [:binding, :defined_class, :method_id, :return_value],
       thread_begin: [:defined_class, :method_id],
       thread_end: [:defined_class, :method_id]
     }
 
     def initialize(wrapper)
+      @logger = Logger.new(STDOUT)
       @wrapper = wrapper
 
-      @output_config = @wrapper.conditions.result_config
+      @output_config = @wrapper.condition.result_config
 
-      @tp_events = @wrapper.conditions.events
+      @tp_events = @wrapper.condition.events
+      if @tp_events.length > 1 and @output_config[:selected_attrs]
+        @logger.warn 'selected_attrs was ignored, cause watched event was more than one '
+        @output_config[:selected_attrs] = nil
+      end
     end
 
     def output_attributes(event)
@@ -56,6 +61,8 @@ module SourceRoute
         # I have to know when the application is end
       when :test, :silence
         # do nothing at now
+      when :stack_overflow
+        console_stack_overflow
       when Proc
         format.call(tp_ins)
       else
@@ -74,7 +81,7 @@ module SourceRoute
     end
 
     def collect_local_var_data
-      if @wrapper.conditions.result_config[:include_local_var]
+      if @wrapper.condition.result_config[:include_local_var]
         local_var_hash = {}
 
         @tp.binding.eval('local_variables').each do |v|
@@ -87,7 +94,7 @@ module SourceRoute
     end
 
     def collect_instance_var_data
-      if @wrapper.conditions.result_config[:include_instance_var]
+      if @wrapper.condition.result_config[:include_instance_var]
         instance_var_hash = {}
         @tp.self.instance_variables.each do |key|
           instance_var_hash[key] = @tp.self.instance_variable_get(key)
@@ -108,6 +115,9 @@ module SourceRoute
       ap ret
     end
 
+    def console_stack_overflow
+      ap "#{@collect_data[:defined_class].inspect}##{@collect_data[:method_id]}"
+    end
   end # END TpResult
 
 end

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/source_route/wrapper.rb

@@ -3,84 +3,87 @@ module SourceRoute
   class Wrapper
     include Singleton
 
-    attr_accessor :conditions, :tp, :tp_attrs_results
+    TRACE_POINT_METHODS = [:defined_class, :method_id, :path, :lineno]
+
+    attr_accessor :condition, :tp, :tp_attrs_results
     attr_accessor :output_include_local_variables, :output_include_instance_variables
 
-    def initialize
-      reset
-    end
+    Condition = Struct.new(:events, :negative, :positive, :result_config)
 
-    # output_format can be console, html
-    def reset
-      @tp.disable if @tp
-      @conditions = OpenStruct.new(events: [:call], negative: {}, positive: {},
-                                   result_config: { output_format: 'none',
-                                     selected_attrs: nil,
-                                     include_local_var: false,
-                                     include_instance_var: false
-                                   })
-      @tp_attrs_results = []
-      self
-    end
+    class Condition
 
-    def events(v)
-      @conditions.events = Array(v).map(&:to_sym) unless v.nil?
-    end
-    alias :event :events
+      TRACE_POINT_METHODS.each do |m|
+        define_method m do |v|
+          positive[m] = v.to_s
+        end
 
-    def set_result_config(value)
-      unless value.is_a? Hash
-        conditions.result_config = value
+        define_method "#{m}_not" do |v|
+          negative[m] = v.to_s
+        end
       end
-    end
 
-    def output_format(data = nil, &block)
-      conditions.result_config[:output_format] = if block_given?
-                                                   block
-                                                 else
-                                                   data
-                                                 end
-    end
-
-    def selected_attrs(*attr)
-      conditions.result_config[:selected_attrs] = Array(attr)
-    end
-
-    def output_include_local_variables
-      conditions.result_config[:include_local_var] = true
-    end
+      def event(*v)
+        # why need self? without self, the events will not really changed, why?. seems a bug in ruby
+        self.events = v.map(&:to_sym) unless v == []
+      end
 
-    def output_include_instance_variables
-      conditions.result_config[:include_instance_var] = true
-    end
+      def output_format(data = nil, &block)
+        result_config[:output_format] = if block_given?
+                                          block
+                                        else
+                                          data
+                                        end
+      end
 
-    TRACE_POINT_METHODS = [:defined_class, :method_id, :path, :lineno]
+      def selected_attrs(*attr)
+        result_config[:selected_attrs] = attr
+      end
 
-    TRACE_POINT_METHODS.each do |m|
-      define_method m do |v|
-        @conditions.positive[m] = v.to_s
+      def output_include_local_variables
+        result_config[:include_local_var] = true
       end
 
-      define_method "#{m}_not" do |v|
-        @conditions.negative[m] = v.to_s
+      def output_include_instance_variables
+        result_config[:include_instance_var] = true
       end
+
+    end
+
+    def initialize
+      reset
     end
 
+    # output_format can be console, html
+    def reset
+      @tp.disable if @tp
+      @condition = Condition.new([:call], {}, {},
+                                 { output_format: 'none',
+                                   selected_attrs: nil,
+                                   include_local_var: false,
+                                   include_instance_var: false
+                                 })
+      @tp_attrs_results = []
+      self
+    end
+
+
     def trace
-      # dont wanna init it in tp block, cause tp block could run thousands of time in one cycle trace
+      # dont wanna init it in tp block, cause tp block could run thousands of times in one cycle trace
       tp_result = TpResult.new(self)
 
-      track = TracePoint.new *conditions.events do |tp|
-        negative_break = conditions.negative.any? do |method_key, value|
-          tp.send(method_key).nature_value =~ Regexp.new(value)
+      track = TracePoint.new *condition.events do |tp|
+        # todo: it's better to change the break check to condition methods to make more flexible
+        negative_break = condition.negative.any? do |method_key, value|
+          tp.send(method_key).to_s =~ Regexp.new(value)
         end
         next if negative_break
-        positive_break = conditions.positive.any? do |method_key, value|
-          tp.send(method_key).nature_value !~ Regexp.new(value)
+
+        positive_break = condition.positive.any? do |method_key, value|
+          tp.send(method_key).to_s !~ Regexp.new(value)
         end
         next if positive_break
 
-        unless conditions[:result_config][:output_format].is_a? Proc
+        unless condition[:result_config][:output_format].is_a? Proc
           ret_data = tp_result.build(tp)
           tp_attrs_results.push(ret_data)
         end

data/lib/source_route.rb

@@ -7,7 +7,7 @@ require 'awesome_print'
 require "source_route/version"
 require "source_route/wrapper"
 require "source_route/tp_result"
-require "source_route/nature_value"
+# require "source_route/customize_to_json"
 
 module SourceRoute
   extend self
@@ -27,9 +27,9 @@ module SourceRoute
   def enable(match = nil, &block)
     wrapper.reset
 
-    wrapper.method_id(match) if match # TODO in future future: should add as wrapper.method_id_or(match)
+    wrapper.condition.method_id(match) if match # TODO in future future: should add as wrapper.method_id_or(match)
 
-    wrapper.instance_eval(&block) if block_given?
+    wrapper.condition.instance_eval(&block) if block_given?
 
     wrapper.trace
   end
@@ -39,7 +39,7 @@ module SourceRoute
     opt[:output_format] ||= :silence
     wrapper.reset
     opt.each do |k, v|
-      wrapper.send(k, v)
+      wrapper.condition.send(k, v)
     end
     wrapper.trace
     yield
@@ -48,7 +48,8 @@ module SourceRoute
   end
 
   def build_html_output
-    SourceRoute::Formats::Html.render(wrapper)
+    SourceRoute.disable
+    SourceRoute::Formats::Html.slim_render(wrapper)
   end
 
   # Not implement yet

data/test/wrapper_test.rb

@@ -86,6 +86,7 @@ module SourceRoute
       SourceRoute.trace event: :c_call do
         'abc'.upcase
       end
+
       assert_equal 2, @wrapper.tp_attrs_results.size
     end
 
@@ -99,7 +100,7 @@ module SourceRoute
 
     def test_trace_two_events
       SourceRoute.enable 'nonsense' do
-        events [:call, :return]
+        event :call, :return
       end
       SampleApp.new.nonsense
       assert_equal 2, @wrapper.tp_attrs_results.size
@@ -122,7 +123,7 @@ module SourceRoute
 
     def test_track_local_var_when_event_is_return
       SourceRoute.enable 'nonsense_with_params' do
-        events :return
+        event :return
         output_include_local_variables
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -139,7 +139,6 @@ files:
 - lib/source_route.rb
 - lib/source_route/formats/html.rb
 - lib/source_route/formats/html_template.slim
-- lib/source_route/nature_value.rb
 - lib/source_route/tp_result.rb
 - lib/source_route/version.rb
 - lib/source_route/wrapper.rb

data/lib/source_route/nature_value.rb

@@ -1,29 +0,0 @@
-class NilClass
-  def nature_value
-    nil
-  end
-end
-
-class String
-  def nature_value
-    self
-  end
-end
-
-class Class
-  def nature_value
-    self.name
-  end
-end
-
-class Module
-  def nature_value
-    self.name
-  end
-end
-
-class Symbol
-  def nature_value
-    to_s
-  end
-end