source_route 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e359db40f93fb8aa3973ed198e521e29c21aa2ab
-  data.tar.gz: b0f07e1dce0010f430d54b81b993c0bd7dcb73e4
+  metadata.gz: 1a153562bb55ebdbeed1c374089561c69be101a5
+  data.tar.gz: 326bc1d36580221a021630ddd59ce66ea2cedfc2
 SHA512:
-  metadata.gz: b418b380f34fe5ed9aa794eab4950b6c9936f9f019408047de068412c1986f49d17c0d84cb05e80d302d30af3f27b3d404797d8d2d7077feb7f143bc728437ec
-  data.tar.gz: 02fd9a36fbb122ebadfd660baf1fe19328f272ba0260a5620becdd310bb69b34d68af85655f1355353b9ac375b38f4819f9feb61690c17d4f4358924e8f16ff1
+  metadata.gz: 1265a2077f7420311560c804169c50c369639c5c0882453549bee819ceb429bfa4713d3e545fca2c079076bce45911b7fe3db03547811dfb28f1a4acee3255ee
+  data.tar.gz: 381f9a950f6b582edded7df76c30934f123c14fcbf51b4853b6062333d48c42a40d393543ec20b5c3c63682d4d0d65fe296f0ecb8e1ffe11d706c62fd5a9989f

data/README.md

@@ -44,8 +44,9 @@ you will get a different trace file.
     SourceRoute.enable :wanted_method_name
     .... # here is your code
     ....
-    # may be code this in another file
-    SourceRoute.build_html_output
+    ....
+    # add it after your tracked code, it will output the trace into a html file
+    SourceRoute.output_html
 
 Same as the previous example, you will get a html file showing the code trace.
 
@@ -91,12 +92,14 @@ Finally, I expect my working style can change from searching workaround from int
 
 ### TODO
 
-Open Method directly from browser
+Add debug option to provider more verbose messages of what has happened
+
+Open File directly from browser(chrome) by plugin?
 
 Apply https://github.com/a5hik/ng-sortable
 
-Hide defined class filter. Add vertical timeline.
+Add vertical timeline.
 (see http://tympanus.net/codrops/2013/05/02/vertical-timeline/
 http://stackoverflow.com/questions/20896240/responsive-timeline-ui-with-bootstrap3)
 
-Add debug option to provider more verbose messages of what has happened
+Hide defined class filter.

data/lib/source_route/formats/html.rb

@@ -14,8 +14,9 @@ module SourceRoute
 
         if result_config.import_return_to_call and wrapper.condition.has_call_and_return_event
           wrapper.import_return_value_to_call_chain
-          wrapper.order_call_chain
+          wrapper.treeize_call_chain
         end
+        # TODO: any exception triggered in render method will be absorb totally, how to fix it?
         html_output_str = slim_template.render(wrapper)
         File.open(filename, 'w') do |f|
           f << html_output_str

data/lib/source_route/formats/html_template.slim

@@ -7,10 +7,14 @@ html
     script src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"
 
     css:
-      .call-level-1 {}
-      .call-level-2 { margin-left: 50px }
-      .call-level-3 { margin-left: 100px }
-      .call-level-4 { margin-left: 150px }
+      .call-level-0 {}
+      .call-level-1 { margin-left: 50px }
+      .call-level-2 { margin-left: 100px }
+      .call-level-3 { margin-left: 150px }
+      .call-level-4 { margin-left: 200px }
+      .call-level-5 { margin-left: 250px }
+      .call-level-6 { margin-left: 300px }
+      .call-level-7 { margin-left: 300px }
   body(ng-app="SourceRoute" ng-controller="MainCtrl")
 
     nav.navbar.navbar-default.navbar-static-top
@@ -30,6 +34,14 @@ html
     .clearfix
 
     .container
+      .level-header(ng-if="parentLengthList" style="padding-bottom: 10px")
+        .btn-group>
+          button.btn.btn-default>(ng-click="traceFilter.parent_length = length" ng-repeat="length in parentLengthList")
+            span> Level
+            span(ng-bind="::length")
+        span
+          button.btn.btn-primary(ng-click="traceFilter.parent_length = undefined") Clear
+
       .trace-flow
         .row
           .left-info.col-sm-4(ng-if="false")
@@ -67,6 +79,10 @@ html
                     span<>
                       | =>
                     span<>(ng-bind="value | json")
+                .self-obj.well.well-sm(ng-if="trace.hasOwnProperty('tp_self')" style="color: red; margin-bottom: 0")
+                  span Self
+                  div
+                    span(ng-bind="tpSelfList[trace.tp_self] | json")
                 .path-value.well.well-sm(ng-if="trace.path")
                   span Path
                   div
@@ -82,7 +98,9 @@ html
       sourceRoute = angular.module('SourceRoute', ['ui.bootstrap'])
       sourceRoute.controller('MainCtrl', function($scope, $filter) {
         $scope.traces = angular.element("#trace-data").data('trace')
+        $scope.tpSelfList = angular.element("#trace-data").data('tp-self-caches')
         $scope.tpEvents = angular.element("#trace-data").data('tp-events')
+        $scope.parentLengthList = angular.element("#trace-data").data('tp-parent-length-list')
 
         $scope.traceFilter = {event: $scope.tpEvents[0]}
         if ($scope.tpEvents.length == 1 && angular.isUndefined($scope.traces[0].event)) {
@@ -94,8 +112,8 @@ html
         $scope.definedClasses = _.uniq(_.map($scope.traces, 'defined_class'))
 
         $scope.callLevelClass = function(trace) {
-          if (trace.parent_length > 4) {
-            return 'call-level-4'
+          if (trace.parent_length > 7) {
+            return 'call-level-7'
           } else {
             return 'call-level-' + trace.parent_length
           }
@@ -110,15 +128,9 @@ html
 
       })
 
-    ruby:
-      local_trace_data = @tp_result_chain.map do |tp_result|
-        if tp_result.key?(:defined_class)
-          tp_result[:defined_class] = tp_result[:defined_class].to_s
-          tp_result[:return_value] = tp_result[:return_value].inspect if tp_result.key?(:return_value)
-        end
-        tp_result
-      end
-
     .data-collect
       / 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)}" data-tp-events="#{JSON.dump(@condition.events)}")
+      #trace-data(data-trace="#{jsonify_tp_result_chain}"
+        data-tp-events="#{jsonify_events}"
+        data-tp-self-caches="#{jsonify_tp_self_caches}"
+        data-tp-parent-length-list="#{JSON.dump(parent_length_list)}")

data/lib/source_route/generate_result.rb

@@ -44,7 +44,7 @@ module SourceRoute
     def build(trace_point_instance)
       @tp = trace_point_instance
       collect_tp_data
-      @collect_data[:tp_self] = @tp.self if @config[:include_tp_self]
+      collect_tp_self if @config[:include_tp_self]
       collect_local_var_data if @config[:include_local_var]
       collect_instance_var_data if @config[:include_instance_var]
       @collect_data
@@ -77,6 +77,15 @@ module SourceRoute
 
     private
 
+    # include? will evaluate @tp.self, if @tp.self is AR::Relation, it could cause problems
+    # So that's why I use object_id as replace
+    def collect_tp_self
+      unless @wrapper.tp_self_caches.find { |tp_cache| tp_cache.equal? @tp.self }
+        @wrapper.tp_self_caches.push @tp.self
+      end
+      @collect_data[:tp_self] = @wrapper.tp_self_caches.map(&:__id__).index(@tp.self.__id__)
+    end
+
     def collect_tp_data
       @collect_data = output_attributes(@tp.event).inject({}) do |memo, key|
         memo[key.to_sym] = @tp.send(key) if @tp.respond_to?(key)
@@ -87,6 +96,7 @@ module SourceRoute
     def collect_local_var_data
       local_var_hash = {}
 
+      # Warn: @tp.binding.eval('local_variables') =! @tp.binding.send('local_variables')
       @tp.binding.eval('local_variables').each do |v|
         local_var_hash[v] = @tp.binding.local_variable_get v
       end

data/lib/source_route/json_overrides/activerecord_associations_association.rb

@@ -0,0 +1,20 @@
+if defined? ActiveRecord
+  class ActiveRecord::Associations::Association
+
+    # dump association can trigger ActiveSupport::JSON::Encoding::CircularReferenceError when use rails ~> 4.0.1
+    # I try other json gems to fix it, but all failed. That's why I override it here.
+    def to_json(options = nil)
+      JSON.dump(to_s)
+    end
+  end
+
+  class ActiveRecord::Base
+
+    # dump association can trigger ActiveSupport::JSON::Encoding::CircularReferenceError when use rails ~> 4.0.1
+    # I try other json gems to fix it, but all failed. That's why I override it here.
+    def to_json(options = nil)
+      JSON.dump(to_s)
+    end
+  end
+
+end

data/lib/source_route/tp_result_chain.rb

@@ -21,17 +21,15 @@ module SourceRoute
     def import_return_value_to_call_chain
       call_chain.each do |ctp|
         matched_return_tp = return_chain.detect do |rtp|
-          rtp[:defined_class] == ctp[:defined_class] and rtp[:method_id] == ctp[:method_id] and
-            rtp[:tp_self] == ctp[:tp_self]
-
+          rtp[:tp_self] == ctp[:tp_self] and rtp[:method_id] == ctp[:method_id] and rtp[:defined_class] == ctp[:defined_class]
         end
         ctp[:return_value] = matched_return_tp[:return_value]
-        ctp[:local_var] = matched_return_tp[:local_var]
-        ctp[:instance_var] = matched_return_tp[:instance_var]
+        ctp[:local_var] = matched_return_tp[:local_var] if matched_return_tp.key? :local_var
+        ctp[:instance_var] = matched_return_tp[:instance_var] if matched_return_tp.key? :instance_var
       end
     end
 
-    def order_call_chain
+    def treeize_call_chain
       init_order_id_and_parent_ids
       call_chain.each do |tpr|
         return_tpr = return_chain.find do |rtpr|
@@ -49,10 +47,14 @@ module SourceRoute
       cal_parent_length
     end
 
+    def parent_length_list
+      call_chain.map { |tp| tp[:parent_length] }.uniq.sort
+    end
+
     private
     def init_order_id_and_parent_ids
       each_with_index do |tpr, index|
-        tpr[:order_id], tpr[:parent_ids] = index, [-1]
+        tpr[:order_id], tpr[:parent_ids] = index, []
       end
     end
 

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/source_route/wrapper.rb

@@ -6,10 +6,10 @@ module SourceRoute
     TRACE_POINT_METHODS = [:defined_class, :method_id, :path, :lineno]
 
     attr_accessor :condition, :tp
-    attr_reader :tp_result_chain
+    attr_reader :tp_result_chain, :tp_self_caches
 
     extend Forwardable
-    def_delegators :@tp_result_chain, :import_return_value_to_call_chain, :order_call_chain, :call_chain, :return_chain
+    def_delegators :@tp_result_chain, :import_return_value_to_call_chain, :treeize_call_chain, :call_chain, :return_chain, :parent_length_list
 
     Condition = Struct.new(:events, :negatives, :positive, :result_config) do
       def initialize(e=[:call], n={}, p={}, r=GenerateResult::Config.new)
@@ -46,9 +46,12 @@ module SourceRoute
 
         self.events = [:call, :return]
         result_config.import_return_to_call = true
-        result_config.include_instance_var = true
-        result_config.include_local_var = true
         result_config.include_tp_self = true
+
+        result_config.show_additional_attrs = [:path, :lineno]
+        # JSON serialize trigger many problems when handle complicated object
+        # result_config.include_instance_var = true
+        # result_config.include_local_var = true
       end
     end
 
@@ -57,9 +60,10 @@ module SourceRoute
     end
 
     def reset
-      @tp.disable if @tp
+      @tp.disable if defined? @tp
       @condition = Condition.new
       @tp_result_chain = TpResultChain.new
+      @tp_self_caches = []
       self
     end
 
@@ -81,9 +85,43 @@ module SourceRoute
       end
       track.enable
       self.tp = track
-      track
     end
 
+    # TODO: move this into chain self
+    def stringify_tp_self_caches
+      tp_self_caches.clone.map(&:to_s)
+    end
+
+    def stringify_tp_result_chain
+      deep_cloned = tp_result_chain.map do |tp_result|
+        tp_result.clone
+      end
+      deep_cloned.map do |tr|
+        # to_s is safer than inspect
+        # ex: inspect on ActiveRecord_Relation may crash
+        tr[:defined_class] = tr[:defined_class].to_s if tr.key?(:defined_class)
+        if tr.key?(:return_value)
+          if tr[:return_value].nil? or tr[:return_value] == ''
+            tr[:return_value] = tr[:return_value].inspect
+          else
+            tr[:return_value] = tr[:return_value].to_s
+          end
+        end
+        tr
+      end
+    end
+
+    def jsonify_events
+      JSON.dump(@condition.events.map(&:to_s))
+    end
+
+    def jsonify_tp_result_chain
+      JSON.dump(stringify_tp_result_chain)
+    end
+
+    def jsonify_tp_self_caches
+      JSON.dump(stringify_tp_self_caches)
+    end
   end # END Wrapper
 
 end

data/lib/source_route.rb

@@ -10,6 +10,7 @@ require "source_route/wrapper"
 require "source_route/generate_result"
 require "source_route/tp_result_chain"
 require "source_route/tp_filter"
+require 'source_route/json_overrides/activerecord_associations_association'
 
 module SourceRoute
   extend self
@@ -58,6 +59,10 @@ module SourceRoute
     SourceRoute::Formats::Html.slim_render(wrapper)
   end
 
+  def output_html
+    build_html_output
+  end
+
   # Not implement yet
   class Logger < Logger
   end

data/test/source_route_test.rb

@@ -110,7 +110,25 @@ class SourceRouteTest < Minitest::Test
     end
     assert @wrapper.condition.result_config.include_tp_self
     first_result = @wrapper.tp_result_chain.first
-    assert first_result[:tp_self]
+    assert_equal first_result[:tp_self], 0
+  end
+
+  def test_trace_include_tp_self
+    SourceRoute.trace method_id: 'nonsense', full_feature: true do
+      SampleApp.new.nonsense
+    end
+    assert_equal 1, @wrapper.tp_self_caches.size
+    assert @wrapper.stringify_tp_self_caches.first.is_a? String
+    assert @wrapper.tp_self_caches.first.is_a? SampleApp
+  end
+
+  def test_stringify_tp_result_chain
+    SourceRoute.trace method_id: 'nonsense', full_feature: true do
+      SampleApp.new.nonsense
+    end
+    origin_tp_result_chain = @wrapper.tp_result_chain
+    assert @wrapper.stringify_tp_result_chain.first[:defined_class].is_a? String
+    assert_equal origin_tp_result_chain, @wrapper.tp_result_chain
   end
 
   def test_trace_without_first_hash_option
@@ -188,15 +206,16 @@ class SourceRouteTest < Minitest::Test
       event :call, :return
     end
     SampleApp.new.nonsense_with_instance_var
-    @wrapper.order_call_chain
-    @wrapper.order_call_chain
+    @wrapper.treeize_call_chain
+    @wrapper.treeize_call_chain
     call_results = @wrapper.call_chain
 
     nonsense_call_tp = call_results.find { |tp| tp[:method_id] == :nonsense }
     nonsense_with_instance_var_call_tp = call_results.find { |tp| tp[:method_id] == :nonsense_with_instance_var }
 
-    assert_equal [-1, nonsense_with_instance_var_call_tp[:order_id]], nonsense_call_tp[:parent_ids]
-    assert_equal 2, nonsense_call_tp[:parent_length]
+    assert_equal [nonsense_with_instance_var_call_tp[:order_id]], nonsense_call_tp[:parent_ids]
+    assert_equal 1, nonsense_call_tp[:parent_length]
+    assert_equal [0, 1], @wrapper.parent_length_list
   end
 
   # Nothing has tested really when run rake cause ENV['ignore_html_generation'] was set to true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -128,6 +128,7 @@ files:
 - lib/source_route/formats/html.rb
 - lib/source_route/formats/html_template.slim
 - lib/source_route/generate_result.rb
+- lib/source_route/json_overrides/activerecord_associations_association.rb
 - lib/source_route/tp_filter.rb
 - lib/source_route/tp_result_chain.rb
 - lib/source_route/version.rb