source_route 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89e5066f6c1b4590957260ef57b44982b01cf006
-  data.tar.gz: 3ae996d75fa35ba29b45e1afe7a77ae3932984d8
+  metadata.gz: fd182d935ed8eb7520d0cebb22fe7af916d0d137
+  data.tar.gz: 44b50d2846f827b6a15cd98a0a49125c34f965da
 SHA512:
-  metadata.gz: 332fe83850831d9c872bdbfdf05a3d1fc3eb047704a7308a18ad93f6308beba1332b63164261917fe51468e7a128f1769a509e5061c218868723a0990a78728c
-  data.tar.gz: aa108ff2d48aee83a49c45d5d2a65152512a7a94a7fd33f7614939cd771a0f97949efe9d09761e2cf6d12c5cac6578aab3680497a67f5a621761547fdd5e05e4
+  metadata.gz: 4bf100bdc4ff65df991267c0905d9f8546f6a70e7b8860262d0b275c918a73bb17dd953cc6da896280e92a2f24702eb7c4e8edaed551d044acf603b535410fd4
+  data.tar.gz: 6b5a8dc7cf522fbdcd7520c10377d9d5bac16d069e1d6df52ba82b4290c5b82438a42bc1a11042fda38a3ec76e2a007c19fcfc67c9e1b61ed09f29624ddebe0a

data/README.md

@@ -64,7 +64,7 @@ Same as the previous example, you will get a html file showing the code trace.
 It will output the trace when you run the application.
 
 see more usage in examples.
-see full usage in examples/callback_in_activesupport.rb
+see full usage in examples/study_callback.rb
 
 ## Why
 
@@ -97,10 +97,13 @@ Finally, I expect my working style can change from searching workaround from int
 
 Dynamic indent when new child level comes.
 
+Is it possible to easily open only direct child
 Animation when child was click.
 
 Show loading when click clear. (when $apply() take more than 1 seconds to run)
 
 Add debug option to provide more verbose messages of what has happened
 
-Open File directly from browser(chrome) by plugin?
+if instance val contains symbol as value, the json output will be string. It could be confused others.
+
+Open File directly from browser(chrome) by plugin? Maybe check out how better error implement this

data/examples/study_callback.rb

@@ -0,0 +1,35 @@
+require 'active_support/callbacks'
+
+require 'source_route'
+
+SourceRoute.enable do
+  method_id 'base_decorate', 'prepare_decorate'
+  defined_class 'ActiveSupport::Callbacks', 'PersonRecord', 'Filters'
+  result_config.filename = 'trace_callback.html'
+  full_feature 10
+end
+
+class House
+  include ActiveSupport::Callbacks
+  define_callbacks :decorate
+
+  def base_decorate
+    run_callbacks :decorate do
+      puts "Let's decorate house"
+    end
+  end
+end
+
+class KattyHouse < House
+  set_callback :decorate, :after, :prepare_decorate
+
+  def prepare_decorate
+    puts "Preparing: buy materials ......"
+  end
+end
+
+katty_house = KattyHouse.new
+
+katty_house.base_decorate
+
+SourceRoute.output_html

data/lib/source_route/formats/html_template.slim

@@ -43,7 +43,7 @@ html
           button.btn.btn-default>(ng-click="outlineTrace()")
             span> OutLine
         span
-          button.btn.btn-primary(ng-click="removeOutlineTrace()") Clear
+          button.btn.btn-primary(ng-click="removeOutlineTrace()") Expand ALL
 
       .trace-flow
         .row
@@ -64,7 +64,7 @@ html
                       i.fa.fa-angle-right
                     span Child
                   button.btn.btn-info.btn-sm(ng-show="::containsDetail(trace)" ng-click="showMoreDetail = !showMoreDetail") Details
-                span(ng-bind="trace.defined_class")
+                span(ng-bind="::tpSelfList[trace.tp_self]")
                 span
                   | .
                 mark.method-value(ng-bind="trace.method_id")
@@ -72,9 +72,9 @@ html
                 div(ng-if="trace.hasOwnProperty('return_value')")
                   span
                     | =>
-                  span<(ng-bind="trace.return_value.substring(0, 200) | json")
+                  span<(ng-bind="::trimString(trace.return_value, 200)")
 
-              .details(ng-if="showMoreDetail")
+              .details(ng-if="showMoreDetail" style="margin-top: 10px")
                 .attrs.well.well-sm(ng-if="containsOtherAttrs(trace)")
                   span Attrs
                   div(hljs source="::combinedAttrs(trace) | json")
@@ -84,6 +84,9 @@ html
                 .ins-vars.well.well-sm(ng-if="trace.instance_var")
                   span Instance Var
                   .ins-values(hljs source="::trace.instance_var | json")
+                .return-value(ng-if="trace.hasOwnProperty('return_value')")
+                  span Return Value
+                  .value(hljs source="::trace.return_value | json")
 
           .right-info.col-sm-2
 
@@ -94,31 +97,40 @@ html
     javascript:
       sourceRoute = angular.module('SourceRoute', ['ui.bootstrap', 'hljs'])
       sourceRoute.controller('MainCtrl', function($scope, $filter) {
+
+        $scope.trimString = function(str, length) {
+          return str.length > length ? str.substring(0, length - 3) + '...' : str;
+        }
+
         $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.childParentFilter = { hide_parent_ids: [] }
+        $scope.childParentFilter = { hide_trace_ids: [] }
 
         $scope.childParentFilterFn = function(trace) {
-          if ($scope.childParentFilter.hide_parent_ids.length == 0) {
+          if (!trace.hasOwnProperty('parent_ids')) {
+            return true;
+          }
+          if (trace.parent_ids.length == 0) {
             return true;
           } else {
-            var shared_parents = _.intersection(trace.parent_ids, $scope.childParentFilter.hide_parent_ids);
-            if (shared_parents.length == 0) {
-              return true;
+            var shared_hide_parents = _.intersection(trace.parent_ids, $scope.childParentFilter.hide_trace_ids);
+            if (shared_hide_parents.length > 0 ) {
+              return false;
             }
           }
+          return true;
         }
 
         $scope.removeOutlineTrace = function() {
           _.each($scope.traces, function(trace) { trace.childClosed = false; });
-          $scope.childParentFilter.hide_parent_ids = [];
+          $scope.childParentFilter.hide_trace_ids = [];
         }
 
         $scope.outlineTrace = function() {
-          $scope.childParentFilter.hide_parent_ids = [];
+          $scope.childParentFilter.hide_trace_ids = [];
           _.chain($scope.traces).filter({parent_length: 0})
-            .each(function(trace) { trace.childClosed = true; $scope.childParentFilter.hide_parent_ids.push(trace.order_id) })
+            .each(function(trace) { trace.childClosed = true; $scope.childParentFilter.hide_trace_ids.push(trace.order_id) })
         }
 
         $scope.traceFilter = {event: $scope.tpEvents[0]}
@@ -148,7 +160,7 @@ html
 
         $scope.containsOtherAttrs = function(trace) {
           return trace.hasOwnProperty('path') || trace.hasOwnProperty('lineno') ||
-            trace.hasOwnProperty('tp_self');
+            trace.hasOwnProperty('defined_class');
         }
 
         $scope.containsDetail = function(trace) {
@@ -159,16 +171,17 @@ html
         $scope.combinedAttrs = function(trace) {
           var attrs = {}
           if (trace.hasOwnProperty('lineno') && trace.hasOwnProperty('path')) {
-            attrs.path = trace.path + ":" + trace.lineno;
+            attrs.method_defined_on = trace.path + ":" + trace.lineno;
           } else if (trace.hasOwnProperty('path')) {
-            attrs.path = trace.path;
+            attrs.method_defined_on = trace.path;
           }
-          if (trace.hasOwnProperty('tp_self')) {
-            attrs.self = $scope.tpSelfList[trace.tp_self];
+          if (trace.hasOwnProperty('defined_class')) {
+            attrs.method_defined_in = trace.defined_class;
           }
           return attrs;
         }
 
+        $scope.outlineTrace();
       })
 
       sourceRoute.controller('TpTraceCtrl', function($scope) {
@@ -182,12 +195,12 @@ html
 
         $scope.showChild = function() {
           $scope.trace.childClosed = false;
-          _.pull($scope.childParentFilter.hide_parent_ids, $scope.trace.order_id);
+          _.pull($scope.childParentFilter.hide_trace_ids, $scope.trace.order_id);
         }
 
         $scope.hideChild = function() {
           $scope.trace.childClosed = true;
-          $scope.childParentFilter.hide_parent_ids.push($scope.trace.order_id);
+          $scope.childParentFilter.hide_trace_ids.push($scope.trace.order_id);
         }
 
         $scope.hasChild = function() {

data/lib/source_route/generate_result.rb

@@ -3,7 +3,7 @@ module SourceRoute
   class GenerateResult
 
     Config = Struct.new(:format, :show_additional_attrs,
-                        :include_local_var, :include_instance_var, :include_tp_self,
+                        :include_local_var, :include_instance_var,
                         :filename, :import_return_to_call) do
       def initialize(f="silence", s=[], ilr=false, iiv=false)
         super(f, s, ilr, iiv)
@@ -44,7 +44,7 @@ module SourceRoute
     def build(trace_point_instance)
       @tp = trace_point_instance
       collect_tp_data
-      collect_tp_self if @config[:include_tp_self]
+      collect_tp_self # NEED more check. Does TracePoint support self for all events?
       collect_local_var_data if @config[:include_local_var]
       collect_instance_var_data if @config[:include_instance_var]
       @collect_data

data/lib/source_route/tp_result_chain.rb

@@ -22,10 +22,13 @@ module SourceRoute
 
     def import_return_value_to_call_chain
       call_chain.each do |ctp|
-        matched_return_tp = return_chain.detect do |rtp|
+        matched_return_tp = return_chain.
+          reject { |c| c[:matched] }.  # matched return tp should not checked again
+          detect do |rtp|
           rtp[:tp_self] == ctp[:tp_self] and rtp[:method_id] == ctp[:method_id] and rtp[:defined_class] == ctp[:defined_class]
         end
         unless matched_return_tp.nil?
+          matched_return_tp[:matched] = true
           ctp[:return_value] = matched_return_tp[:return_value]
           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
@@ -66,7 +69,7 @@ module SourceRoute
         # 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] == ''
+          if tr[:return_value].nil? or tr[:return_value] == '' or tr[:return_value].is_a? Symbol
             tr[:return_value] = tr[:return_value].inspect
           else
             tr[:return_value] = tr[:return_value].to_s

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/source_route/wrapper.rb

@@ -46,7 +46,6 @@ module SourceRoute
 
         self.events = [:call, :return]
         result_config.import_return_to_call = true
-        result_config.include_tp_self = true
 
         result_config.show_additional_attrs = [:path, :lineno]
         # JSON serialize trigger many problems when handle complicated object

data/test/source_route_test.rb

@@ -108,18 +108,17 @@ class SourceRouteTest < Minitest::Test
     SourceRoute.trace method_id: 'nonsense', full_feature: true do
       SampleApp.new.nonsense
     end
-    assert @wrapper.condition.result_config.include_tp_self
     first_result = @wrapper.tp_result_chain.first
     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.tp_self_caches.first.is_a? SampleApp
-  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.tp_self_caches.first.is_a? SampleApp
+  # end
 
   def test_stringify_tp_result_chain
     SourceRoute.trace method_id: 'nonsense', full_feature: true do
@@ -225,7 +224,6 @@ class SourceRouteTest < Minitest::Test
       result_config.include_instance_var = true
       result_config.include_local_var = true
       result_config.show_additional_attrs = [:path, :lineno]
-      result_config.include_tp_self = true
 
       result_config.filename = 'call_and_return_in_sample_app.html'
       result_config.import_return_to_call = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-13 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -121,9 +121,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/callback_in_activesupport.rb
 - examples/show_init_files_when_rails_server_start.rb
 - examples/show_task_trace_in_rails.rb
+- examples/study_callback.rb
 - lib/source_route.rb
 - lib/source_route/formats/html.rb
 - lib/source_route/formats/html_template.slim

data/examples/callback_in_activesupport.rb

@@ -1,33 +0,0 @@
-require 'active_support/callbacks'
-
-require 'source_route'
-
-SourceRoute.enable do
-  defined_class 'ActiveSupport::Callbacks', 'PersonRecord'
-  method_id :base_save, :saving_message, :callback
-  full_feature
-end
-
-class Record
-  include ActiveSupport::Callbacks
-  define_callbacks :save
-
-  def base_save
-    run_callbacks :save do
-      puts "- save"
-    end
-  end
-end
-
-class PersonRecord < Record
-  set_callback :save, :before, :saving_message
-
-  def saving_message
-    puts "saving..."
-  end
-end
-
-person = PersonRecord.new
-person.base_save
-
-SourceRoute.build_html_output