source_route 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37be5d396bcfb224e69e6e3577f1e71ddeffe4ba
-  data.tar.gz: 544985519acf978873b41219ace7e89e115423f2
+  metadata.gz: 3a497dac48db0ce73092b5fd0b1bff7a3d43b017
+  data.tar.gz: 5008e83d2a398c35c5fc0a6dc379a19d2641ed53
 SHA512:
-  metadata.gz: c4db59f01f059e29e2ceb2ff78101aaecb7298b66a9503ed2e5d8ebdc2f8c756a1a36165f099877a60ea9e41d9cdd47aa091153121bcb5090550d57c13af2a36
-  data.tar.gz: 57ddfee91d7f69b7295e2b87e1184582934ffd11da00ede3ff9bc7bb32aed2b817330a6e78d5308958b39c3f4b3c83ff9078d5e5bfb1e8642aa336a2a139c72e
+  metadata.gz: b751bcd35cd72c63133c4367e57d15ae26929084c70c372afe07ca2ec8e35db78f4ad5e94aa8504cb17b50d0d8d20d10fe5e741b77ee2e5a53f8fbd8209908ed
+  data.tar.gz: bbd3f567b24261dee0a075fb1a2e180eae2cd49761a10fca7eefdf474a5911b07a29c7088bbaae68b4926e57d7b21719e03b8ee3d17ab14d69dffcafe56e9fe9

data/README.md

@@ -77,4 +77,11 @@ see more usage in examples.
 
 ### TODO
 
+Hide defined class filter. Add vertical timeline.
+
+Add TpResults and GenerateResult(moved from TpResult) class.
+( 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

data/examples/callback_in_activesupport.rb

@@ -0,0 +1,34 @@
+require 'active_support/callbacks'
+
+require 'source_route'
+
+SourceRoute.enable do
+  event :call, :return
+  defined_class 'ActiveSupport::Callbacks', 'PersonRecord'
+  method_id :base_save, :saving_message, :callback
+  result_config.import_return_to_call = true
+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

data/lib/source_route.rb

@@ -1,12 +1,14 @@
 require 'ostruct'
 require 'logger'
 require 'singleton'
+require 'forwardable'
 
 require 'awesome_print'
 
 require "source_route/version"
 require "source_route/wrapper"
-require "source_route/tp_result"
+require "source_route/generate_result"
+require "source_route/tp_result_chain"
 require "source_route/tp_filter"
 
 module SourceRoute

data/lib/source_route/formats/html.rb

@@ -13,7 +13,8 @@ module SourceRoute
         filename = result_config[:filename] || "#{Time.now.strftime('%H%M')}-source-route.html"
 
         if result_config.import_return_to_call and wrapper.condition.has_call_and_return_event
-          wrapper.import_return_value_to_call_results
+          wrapper.import_return_value_to_call_chain
+          wrapper.order_call_chain
         end
         html_output_str = slim_template.render(wrapper)
         File.open(filename, 'w') do |f|

data/lib/source_route/formats/html_template.slim

@@ -6,9 +6,15 @@ html
     script src="http://cdnjs.cloudflare.com/ajax/libs/lodash.js/2.4.1/lodash.min.js"
     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 }
   body(ng-app="SourceRoute" ng-controller="MainCtrl")
+
     ruby:
-      local_trace_data = @tp_attrs_results.map do |tp_result|
+      local_trace_data = @tp_result_chain.map do |tp_result|
         if tp_result.key?(:defined_class)
           tp_result[:defined_class] = tp_result[:defined_class].inspect
           tp_result[:return_value] = tp_result[:return_value].inspect if tp_result.key?(:return_value)
@@ -25,10 +31,10 @@ html
       .container
         .container-fluid
           .navbar-header
-            a.navbar-brand(href="#" ng-click="resetTraceFilter()") ALL
+            a.navbar-brand(href="#" ng-click="::resetTraceFilter()") ALL
           ul.nav.navbar-nav
             li(ng-repeat="event in tpEvents" ng-class="{active: event == traceFilter.event}")
-              a(href="#" ng-click="traceFilter.event = event" ng-bind="event")
+              a(href="#" ng-click="traceFilter.event = event" ng-bind="::event")
           ul.nav.navbar-nav.navbar-right
             li
               a(disabled)
@@ -42,17 +48,17 @@ html
         .row
           .left-info.col-sm-4
             .btn-group-vertical
-              button.btn.btn-default(ng-repeat="klass in definedClasses"
+              button.btn.btn-default(ng-repeat="klass in ::definedClasses"
                 ng-click="traceFilter.defined_class = klass" style="height: 60px")
                 span(ng-bind="klass")
-          .traces.center-info.col-sm-6(ng-class="{{traceFilter.event}}")
-            .trace.well.well-lg(ng-repeat="trace in traces | filter:traceFilter:true")
-
+          .traces.center-info.col-sm-8(ng-class="{{traceFilter.event}}")
+            .trace.well.well-lg.call-level.call-level(ng-repeat="trace in traces | filter:traceFilter:true"
+              ng-class="callLevelClass(trace)")
               .header(ng-click="showMoreDetail = !showMoreDetail")
                 span(ng-bind="trace.defined_class")
                 span
                   | .
-                span(ng-bind="trace.method_id")
+                mark.method-value(ng-bind="trace.method_id")
                 / workaround for return_value is 'false' and return_value always to be string when existed
                 div(ng-if="isIncludeReturnValue")
                   span
@@ -66,7 +72,7 @@ html
                     span<>(ng-bind="key")
                     span<>
                       | =>
-                    / to do: could inspect fix it?
+                    / ? could inspect repaire it ?
                     span<>(ng-bind="value || 'null'")
                 .ins-vars.well.well-sm(ng-if="trace.instance_var" style="color: blue")
                   span Instance Var
@@ -75,10 +81,15 @@ html
                     span<>
                       | =>
                     span<>(ng-bind="value || 'null'")
+                .path-value.well.well-sm(ng-if="trace.path")
+                  span Path
+                  div
+                    span<>(ng-bind="trace.path")
+                    span<>(ng-bind="trace.lineno")
 
           .right-info.col-sm-2
 
-    script src="http://ajax.googleapis.com/ajax/libs/angularjs/1.2.25/angular.min.js"
+    script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.3.0/angular.min.js"
 
     javascript:
       sourceRoute = angular.module('SourceRoute', [])
@@ -97,6 +108,14 @@ html
 
         $scope.definedClasses = _.uniq(_.map($scope.traces, 'defined_class'))
 
+        $scope.callLevelClass = function(trace) {
+          if (trace.parent_length > 4) {
+            return 'call-level-4'
+          } else {
+            return 'call-level-' + trace.parent_length
+          }
+        }
+
         $scope.resetTraceFilter = function() {
           $scope.traceFilter = {}
         }

data/lib/source_route/{tp_result.rb → generate_result.rb}

@@ -1,9 +1,10 @@
 module SourceRoute
 
-  class TpResult
+  class GenerateResult
 
     Config = Struct.new(:format, :show_additional_attrs,
-                        :include_local_var, :include_instance_var, :filename, :import_return_to_call) do
+                        :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)
       end
@@ -121,6 +122,6 @@ module SourceRoute
       ap "#{@collect_data[:defined_class].inspect}##{@collect_data[:method_id]}"
     end
 
-  end # END TpResult
+  end # END GenerateResult
 
 end

data/lib/source_route/tp_result_chain.rb

@@ -0,0 +1,61 @@
+module SourceRoute
+
+  class TpResultChain
+    extend Forwardable
+    def_delegators :@chain, :each, :index, :first, :last, :size, :push, :values_at, :pop
+
+    include Enumerable
+
+    def initialize
+      @chain = []
+    end
+
+    def call_chain
+      select { |tpr| tpr[:event] == :call }
+    end
+
+    def return_chain
+      select { |tpr| tpr[:event] == :return }
+    end
+
+    def import_return_value_to_call_chain
+      call_chain.each do |ctp|
+        ctp[:return_value] = return_chain.detect do |rtp|
+          rtp[:defined_class] == ctp[:defined_class] and rtp[:method_id] == ctp[:method_id]
+        end[:return_value]
+      end
+    end
+
+    def order_call_chain
+      init_order_id_and_parent_ids
+      call_chain.each do |tpr|
+        return_tpr = return_chain.find do |rtpr|
+          rtpr[:defined_class] == tpr[:defined_class] and rtpr[:method_id] == tpr[:method_id]
+        end
+
+        start_index, end_index = tpr[:order_id], return_tpr[:order_id]
+        unless end_index == start_index + 1
+          values_at(start_index+1 ... end_index).select { |tpr| tpr[:event] == :call }.each do |tpr|
+            tpr[:parent_ids].push start_index
+          end
+        end
+      end
+
+      cal_parent_length
+    end
+
+    private
+    def init_order_id_and_parent_ids
+      each_with_index do |tpr, index|
+        tpr[:order_id], tpr[:parent_ids] = index, [-1]
+      end
+    end
+
+    def cal_parent_length
+      each do |tpr|
+        tpr[:parent_length] = tpr[:parent_ids].length
+      end
+    end
+
+  end # END TpResultChain
+end

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/source_route/wrapper.rb

@@ -5,10 +5,14 @@ module SourceRoute
 
     TRACE_POINT_METHODS = [:defined_class, :method_id, :path, :lineno]
 
-    attr_accessor :condition, :tp, :tp_attrs_results
+    attr_accessor :condition, :tp
+    attr_reader :tp_result_chain
+
+    extend Forwardable
+    def_delegators :@tp_result_chain, :import_return_value_to_call_chain, :order_call_chain, :call_chain, :return_chain
 
     Condition = Struct.new(:events, :negatives, :positive, :result_config) do
-      def initialize(e=[:call], n={}, p={}, r=TpResult::Config.new)
+      def initialize(e=[:call], n={}, p={}, r=GenerateResult::Config.new)
         super(e, n, p, r)
       end
     end
@@ -46,13 +50,13 @@ module SourceRoute
     def reset
       @tp.disable if @tp
       @condition = Condition.new
-      @tp_attrs_results = []
+      @tp_result_chain = TpResultChain.new
       self
     end
 
     def 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)
+      tp_result = GenerateResult.new(self)
       tp_filter = TpFilter.new(condition)
 
       track = TracePoint.new *condition.events do |tp|
@@ -61,7 +65,7 @@ module SourceRoute
 
         unless condition.result_config.format.is_a? Proc
           ret_data = tp_result.build(tp)
-          tp_attrs_results.push(ret_data)
+          @tp_result_chain.push(ret_data)
         end
 
         tp_result.output(tp)
@@ -71,21 +75,6 @@ module SourceRoute
       track
     end
 
-    def import_return_value_to_call_results
-      call_tp_results.each do |ctp|
-        ctp[:return_value] = return_tp_results.detect do |rtp|
-          rtp[:defined_class] == ctp[:defined_class] and rtp[:method_id] == ctp[:method_id]
-        end[:return_value]
-      end
-    end
-
-    def call_tp_results
-      tp_attrs_results.select { |tpr| tpr[:event] == :call }
-    end
-
-    def return_tp_results
-      tp_attrs_results.select { |tpr| tpr[:event] == :return }
-    end
-  end # Wrapper
+  end # END Wrapper
 
 end

data/test/source_route_test.rb

@@ -35,14 +35,14 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense
 
-    assert_includes @wrapper.tp_attrs_results.first[:path], 'test'
+    assert_includes @wrapper.tp_result_chain.first[:path], 'test'
   end
 
   def test_match_class_name_by_first_parameter
     @source_route = SourceRoute.enable 'SampleApp'
     SampleApp.new.nonsense
 
-    assert @wrapper.tp_attrs_results.size > 0
+    assert @wrapper.tp_result_chain.size > 0
   end
 
   def test_match_class_name
@@ -51,26 +51,26 @@ class SourceRouteTest < Minitest::Test
     end
 
     SampleApp.new.nonsense
-    assert @wrapper.tp_attrs_results.size > 0
+    assert @wrapper.tp_result_chain.size > 0
   end
 
   def test_source_route_with_one_parameter
     @source_route = SourceRoute.enable 'nonsense'
     SampleApp.new.nonsense
 
-    ret_value = @wrapper.tp_attrs_results.last
+    ret_value = @wrapper.tp_result_chain.last
     assert_equal SampleApp, ret_value[:defined_class]
   end
 
   def test_wrapper_reset
     SourceRoute.enable 'nonsense'
     SampleApp.new.nonsense
-    assert_equal 1, @wrapper.tp_attrs_results.size
+    assert_equal 1, @wrapper.tp_result_chain.size
 
     SourceRoute.reset
     SampleApp.new.nonsense
 
-    assert_equal 0, @wrapper.tp_attrs_results.size
+    assert_equal 0, @wrapper.tp_result_chain.size
   end
 
   def test_source_route_with_block_only
@@ -83,7 +83,7 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense
 
-    assert_equal 0, @wrapper.tp_attrs_results.size
+    assert_equal 0, @wrapper.tp_result_chain.size
     assert_equal 1, paths.size
     assert_includes paths.first, 'sample_app'
   end
@@ -93,14 +93,14 @@ class SourceRouteTest < Minitest::Test
       'abc'.upcase
     end
 
-    assert_equal 2, @wrapper.tp_attrs_results.size
+    assert_equal 2, @wrapper.tp_result_chain.size
   end
 
   def test_trace_without_first_hash_option
     SourceRoute.trace output_format: :test do
       SampleApp.new.nonsense
     end
-    assert @wrapper.tp_attrs_results.size > 0
+    assert @wrapper.tp_result_chain.size > 0
     refute @wrapper.tp.enabled?
   end
 
@@ -109,7 +109,7 @@ class SourceRouteTest < Minitest::Test
       event :call, :return
     end
     SampleApp.new.nonsense
-    assert_equal 2, @wrapper.tp_attrs_results.size
+    assert_equal 2, @wrapper.tp_result_chain.size
   end
 
   def test_show_local_variables
@@ -119,9 +119,9 @@ class SourceRouteTest < Minitest::Test
     end
 
     SampleApp.new.nonsense_with_params(88)
-    assert_equal 1, @wrapper.tp_attrs_results.size
+    assert_equal 1, @wrapper.tp_result_chain.size
 
-    ret_value = @wrapper.tp_attrs_results.last
+    ret_value = @wrapper.tp_result_chain.last
 
     assert_equal 88, ret_value[:local_var][:param1]
     assert_equal nil, ret_value[:local_var][:param2]
@@ -134,9 +134,9 @@ class SourceRouteTest < Minitest::Test
     end
 
     SampleApp.new.nonsense_with_params(88)
-    assert_equal 1, @wrapper.tp_attrs_results.size
+    assert_equal 1, @wrapper.tp_result_chain.size
 
-    ret_value_for_return_event = @wrapper.tp_attrs_results.last
+    ret_value_for_return_event = @wrapper.tp_result_chain.last
     assert_equal 88, ret_value_for_return_event[:local_var][:param1]
     assert_equal 5, ret_value_for_return_event[:local_var][:param2]
   end
@@ -148,22 +148,38 @@ class SourceRouteTest < Minitest::Test
 
     SampleApp.new('ins sure').nonsense_with_instance_var
 
-    assert_equal 2, @wrapper.tp_attrs_results.size
-    ret_value = @wrapper.tp_attrs_results.pop
+    assert_equal 2, @wrapper.tp_result_chain.size
+    ret_value = @wrapper.tp_result_chain.pop
 
     assert_equal 'ins sure', ret_value[:instance_var][:@sample]
   end
 
   def test_import_return_to_call
-    @source_route = SourceRoute.enable 'SampleApp' do
+    SourceRoute.enable 'SampleApp' do
       event :call, :return
       result_config.include_instance_var = true
       result_config.include_local_var = true
       result_config.import_return_to_call = true
     end
     SampleApp.new.init_cool_app
-    @wrapper.import_return_value_to_call_results
-    assert @wrapper.call_tp_results[0].key?(:return_value), 'call results should contain return_value'
+    @wrapper.import_return_value_to_call_chain
+    assert @wrapper.call_chain[0].key?(:return_value), 'call results should contain return_value'
+  end
+
+  def test_order_call_sequence
+    SourceRoute.enable 'SampleApp' do
+      event :call, :return
+    end
+    SampleApp.new.nonsense_with_instance_var
+    @wrapper.order_call_chain
+    @wrapper.order_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]
   end
 
   # Nothing has tested really when run rake cause ENV['ignore_html_generation'] was set to true

data/test/tp_filter_test.rb

@@ -14,7 +14,7 @@ module SourceRoute
       @warden_tp = FakeTp.new(:auth, Warden, 6)
       @user_tp = FakeTp.new(:new, User, 8)
       @tps = [@devise_tp, @warden_tp, @user_tp]
-      @result_config = TpResult::Config.new('silence', [], false, false)
+      @result_config = GenerateResult::Config.new('silence', [], false, false)
     end
 
     def test_filter_method_not_auth

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -121,13 +121,15 @@ 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
 - lib/source_route.rb
 - lib/source_route/formats/html.rb
 - lib/source_route/formats/html_template.slim
+- lib/source_route/generate_result.rb
 - lib/source_route/tp_filter.rb
-- lib/source_route/tp_result.rb
+- lib/source_route/tp_result_chain.rb
 - lib/source_route/version.rb
 - lib/source_route/wrapper.rb
 - source_route.gemspec