source_route 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33409f8b60b621ff40f5df4c5154430334884017
-  data.tar.gz: 2fcdf3f68ed75e8dede1f051e804058285834ae5
+  metadata.gz: 3b4bfd9535b257febd357416089fee4ff68b38b2
+  data.tar.gz: f2c7a60553434e0a0430f9919764f0d97dcd5780
 SHA512:
-  metadata.gz: c0e36502780c37fefdffb66f8cb120bed3f1d007bfa599fc7061fc482156b66e2184818ef1becdf28a5f396e0e60204ec2ffdf9bf7bd2b4cd79596568bdbaff4
-  data.tar.gz: 4e5980aaa635a1235079e694dad739615f274d03f408f3ab3d4afe1063c3ac5714554643ac27232e6e667ee54af38c852c4ba67ae2013b2a64dacea2f061ac2a
+  metadata.gz: 5d551e9a2364336fb6603633b0da2748eb3e27b2f0eba4b51bdaaffcf579af2956e269536a1e4d7cf7f47b3b05c1821fca533fb716d2d7888e1216472e96c436
+  data.tar.gz: d4b009feb8524193ad9d90776b60ff8a37213b45189838e4ce910975e697c720e0f9c9e3e01b6729b5db2130286480e63b437ee325d5972cbd5e2ebfa1adf6da

data/.gitignore

@@ -21,3 +21,5 @@ tmp
 *.a
 mkmf.log
 .ruby-version
+
+call_and_return_in_sample_app.html

data/README.md

@@ -24,15 +24,11 @@ Or install it yourself as:
 
 #### In irb or pry
 
-    SourceRoute.trace output_format: :console, event: :c_call do
-      'abc'.upcase
-    end
+    SourceRoute.trace(output_format: :console, event: :c_call) { 'abc'.upcase }
 
 #### In rails console
 
-    SourceRoute.trace defined_class: :ActiveRecord, output_format: :html do
-      User.new
-    end
+    SourceRoute.trace(defined_class: :ActiveRecord, output_format: :html) { User.new }
 
 It will generate a html file, open it and you can get the trace of User.new
 
@@ -72,14 +68,14 @@ see full usage in examples/study_callback.rb
 
 I always wanna upgrade my ruby(rails) skills. But everytime when I looking for workaround from stack overflow I feel frustration.
 
-To get solution or workaround from google or stack overflow is suitable when I'm a ruby starter or deadline is urgent. But it's not really helpful for my skills.
+To get solution or workaround from google or stack overflow is suitable when I'm a ruby starter or task is urgent. But it's not really helpful to levelup my skills.
 
-The way how I solve problem define my skills border and depth. So if I slove problems by search google and stack overflow with workarounds, I mostly just increase my experiences on ruby(rails). But if I solve problems directly, in most case, I can say my skill border extends.
+The way how I solve problem define my skills' border and depth. So if I slove problems by search google and stack overflow with workarounds, I mostly just increase my experiences on ruby(rails). But if I solve problems directly, in most case, I can say my skill border extends.
 
 That's why I create this gem. To solve problems directly, I need to know what happened in call or return traces.
 Fortunately ruby 2.0 introduce a new feature TracePoint to easily trace inner event. But it's not easily to be used as daily tool. This gem tries to make tracing more readable and easily in our daily work.
 
-Finally, I expect my working style can change from searching workaround from internet to reading code trace(then more easily check source) directly. I hope it can help you too.
+Finally, I expect my working style can changes from searching workaround from internet to reading code trace(then more easily check source) directly. I hope it can help you too.
 
 ## Test
 

data/lib/source_route/core_ext.rb

@@ -0,0 +1,30 @@
+class Object
+  def source_route_display
+    to_s
+  end
+
+end
+
+class Numeric
+  def source_route_display
+    self
+  end
+end
+
+class NilClass
+  def source_route_display
+    inspect
+  end
+end
+
+class Symbol
+  def source_route_display
+    inspect
+  end
+end
+
+class String
+  def source_route_display
+    eql?('') ? inspect : to_s
+  end
+end

data/lib/source_route/formats/html.rb

@@ -10,7 +10,7 @@ module SourceRoute
         template_path = File.expand_path "../html_template.slim", __FILE__
         slim_template = Slim::Template.new(template_path, pretty: true)
 
-        filename = result_config[:filename] || "#{Time.now.strftime('%H%M')}-source-route.html"
+        filename = result_config[:filename] || "#{Time.now.strftime('%H')}-source-route.html"
 
         if result_config.import_return_to_call and wrapper.condition.has_call_and_return_event
           wrapper.import_return_value_to_call_chain

data/lib/source_route/formats/html_template.slim

@@ -5,11 +5,14 @@ html
     link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css"
     link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"
     link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css"
+    link rel="stylesheet" href="https://cdn.rawgit.com/Urigo/angular-spinkit/master/build/angular-spinkit.min.css"
     script src="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"
     script src="http://cdnjs.cloudflare.com/ajax/libs/lodash.js/2.4.1/lodash.min.js"
     script src="http://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"
 
     css:
+      body { font-size: 24px }
+      pre { font-size: 20px }
       .call-level-0 {}
       .call-level-1 { margin-left: 50px }
       .call-level-2 { margin-left: 100px }
@@ -43,7 +46,7 @@ html
           button.btn.btn-default>(ng-click="outlineTrace()")
             span> OutLine
         span
-          button.btn.btn-primary(ng-click="removeOutlineTrace()") Expand ALL
+          button.btn.btn-primary(ng-click="expandAllTrace()") Expand ALL
 
       .trace-flow
         .row
@@ -55,6 +58,7 @@ html
           .traces.center-info.col-sm-12(ng-class="{{traceFilter.event}}")
             .trace.well(ng-repeat="trace in traces | filter:traceFilter:true | filter:childParentFilterFn"
               ng-class="callLevelClass(trace)" ng-controller="TpTraceCtrl")
+
               .header(ng-init="showMoreDetail = false")
                 .btn-group.pull-right
                   button.btn.btn-info.btn-sm(ng-if="::hasChild()" ng-click="toggleChild()")
@@ -69,6 +73,7 @@ html
                   | .
                 mark.method-value(ng-bind="trace.method_id")
                 / workaround for return_value is 'false' and return_value always to be string when existed
+                pulse-spinner(ng-show="togglingChild")
                 div(ng-if="trace.hasOwnProperty('return_value')")
                   span
                     | =>
@@ -90,12 +95,13 @@ html
 
           .right-info.col-sm-2
 
-    script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.3.6/angular.min.js"
-    script src="https://cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.11.2/ui-bootstrap-tpls.min.js"
+    script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.3.8/angular.min.js"
+    script src="https://cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.12.0/ui-bootstrap-tpls.min.js"
     script src="http://pc035860.github.io/angular-highlightjs/angular-highlightjs.min.js"
+    script src="https://cdn.rawgit.com/Urigo/angular-spinkit/master/build/angular-spinkit.min.js"
 
     javascript:
-      sourceRoute = angular.module('SourceRoute', ['ui.bootstrap', 'hljs'])
+      sourceRoute = angular.module('SourceRoute', ['ui.bootstrap', 'hljs', 'angular-spinkit'])
       sourceRoute.controller('MainCtrl', function($scope, $filter) {
 
         $scope.trimString = function(str, length) {
@@ -122,7 +128,7 @@ html
           return true;
         }
 
-        $scope.removeOutlineTrace = function() {
+        $scope.expandAllTrace = function() {
           _.each($scope.traces, function(trace) { trace.childClosed = false; });
           $scope.childParentFilter.hide_trace_ids = [];
         }
@@ -184,13 +190,19 @@ html
         $scope.outlineTrace();
       })
 
-      sourceRoute.controller('TpTraceCtrl', function($scope) {
+      sourceRoute.controller('TpTraceCtrl', function($scope, $timeout) {
+
         $scope.toggleChild = function() {
-          if ($scope.trace.childClosed) {
-            $scope.showChild();
-          } else {
-            $scope.hideChild();
-          }
+          $scope.togglingChild = true
+          $timeout(function() {
+            if ($scope.trace.childClosed) {
+              $scope.showChild();
+              $scope.togglingChild = false
+            } else {
+              $scope.hideChild();
+              $scope.togglingChild = false
+            }
+          }, 0)
         }
 
         $scope.showChild = function() {

data/lib/source_route/generate_result.rb

@@ -77,6 +77,15 @@ module SourceRoute
 
     private
 
+    def collect_tp_data
+      tp_data = output_attributes(@tp.event).inject({}) do |memo, key|
+        memo[key.to_sym] = @tp.send(key) if @tp.respond_to?(key)
+        memo
+      end
+      @collect_data = TpResult.new(tp_data)
+      puts @collect_data.inspect if @wrapper.condition.is_debug?
+    end
+
     # 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
@@ -86,19 +95,12 @@ module SourceRoute
       @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)
-        memo
-      end
-    end
-
     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
+        local_var_hash[v] = @tp.binding.local_variable_get(v).source_route_display
       end
       if local_var_hash != {}
         @collect_data.merge!(local_var: local_var_hash)
@@ -108,7 +110,7 @@ module SourceRoute
     def collect_instance_var_data
       instance_var_hash = {}
       @tp.self.instance_variables.each do |key|
-        instance_var_hash[key] = @tp.self.instance_variable_get(key)
+        instance_var_hash[key] = @tp.self.instance_variable_get(key).source_route_display
       end
       if instance_var_hash != {}
         @collect_data.merge!(instance_var: instance_var_hash)

data/lib/source_route/jsonify.rb

@@ -0,0 +1,11 @@
+module Jsonify
+
+  def self.dump(obj)
+    if obj.respond_to? :stringify
+      JSON.dump(obj.stringify)
+    else
+      JSON.dump(obj.to_s)
+    end
+  end
+
+end

data/lib/source_route/rails_plugins/source_track_middleware.rb

@@ -0,0 +1,15 @@
+class SourceTrackMiddleware
+
+  def initialize(app)
+    SourceRoute.enable do
+      defined_class 'ApplicationClass'
+    end
+
+    @app = app
+  end
+
+  def call(env)
+    SourceRoute.output_html
+    @app.call(env)
+  end
+end

data/lib/source_route/tp_result.rb

@@ -0,0 +1,46 @@
+module SourceRoute
+  # delegate to hash
+  class TpResult
+    attr_accessor :core
+
+    extend Forwardable
+    def_delegators :@core, :[], :merge, :merge!, :reject, :has_key?, :values, :[]=
+
+    def initialize(data)
+      @core = data
+    end
+
+    def return_event?
+      @core[:event] == :return
+    end
+
+    def call_event?
+      @core[:event] == :call
+    end
+
+    def ==(other)
+      @core[:tp_self] == other[:tp_self] and @core[:method_id] == other[:method_id] and
+        @core[:defined_class] == other[:defined_class]
+    end
+
+    def matched?
+      @core[:matched]
+    end
+
+    def return_assign_call(tp)
+      @core[:matched] = true
+      tp[:return_value] = @core[:return_value]
+      tp[:local_var] = @core[:local_var] if has_key? :local_var
+      tp[:instance_var] = @core[:instance_var] if has_key? :instance_var
+    end
+
+    def stringify
+      dup_core = @core.dup
+      # to_s is safer than inspect
+      # ex: inspect on ActiveRecord_Relation may crash
+      dup_core[:defined_class] = dup_core[:defined_class].to_s if dup_core.has_key?(:defined_class)
+      dup_core[:return_value] = dup_core[:return_value].source_route_display if dup_core.has_key?(:return_value)
+      dup_core
+    end
+  end
+end

data/lib/source_route/tp_result_chain.rb

@@ -1,5 +1,5 @@
 module SourceRoute
-
+  # delegate to Array
   class TpResultChain
     attr_reader :chain
 
@@ -13,25 +13,19 @@ module SourceRoute
     end
 
     def call_chain
-      select { |tpr| tpr[:event] == :call }
+      select(&:call_event?)
     end
 
     def return_chain
-      select { |tpr| tpr[:event] == :return }
+      select(&:return_event?)
     end
 
     def import_return_value_to_call_chain
       call_chain.each do |ctp|
-        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
+        matched_return_tp = return_chain.reject(&:matched?).detect {|rtp| rtp == ctp}
+
         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
+          matched_return_tp.return_assign_call(ctp)
         end
       end
     end
@@ -68,9 +62,11 @@ module SourceRoute
       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] == '' or tr[:return_value].is_a? Symbol
+        tr[:defined_class] = tr[:defined_class].to_s if tr.has_key?(:defined_class)
+        if tr.has_key?(:return_value)
+          if tr[:return_value].nil? or tr[:return_value].is_a? Symbol or
+            # ActiveRecord::ConnectionAdapters::Column override method ==
+              (tr[:return_value].is_a? String and tr[:return_value] == '')
             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.7"
+  VERSION = "0.1.8"
 end

data/lib/source_route/wrapper.rb

@@ -21,7 +21,7 @@ module SourceRoute
 
       TRACE_POINT_METHODS.each do |m|
         define_method m do |*v|
-          positive[m] = v.map(&:to_s).join('|')
+          positive[m] = v.flatten.map(&:to_s).join('|')
         end
 
         define_method "#{m}_not" do |*v|
@@ -56,6 +56,14 @@ module SourceRoute
           result_config.include_local_var = true
         end
       end
+
+      def debug(value=false)
+        @debug = value
+      end
+
+      def is_debug?
+        @debug
+      end
     end
 
     def initialize
@@ -72,7 +80,7 @@ module SourceRoute
 
     def trace
       # dont wanna init it in tp block, cause tp block could run thousands of times in one cycle trace
-      tp_result = GenerateResult.new(self)
+      build_result = GenerateResult.new(self)
       tp_filter = TpFilter.new(condition)
 
       track = TracePoint.new *condition.events do |tp|
@@ -80,26 +88,28 @@ module SourceRoute
         next if tp_filter.block_it?(tp)
 
         unless condition.result_config.format.is_a? Proc
-          ret_data = tp_result.build(tp)
+          ret_data = build_result.build(tp)
           @tp_result_chain.push(ret_data)
         end
 
-        tp_result.output(tp)
+        build_result.output(tp)
       end
       track.enable
       self.tp = track
     end
 
     def jsonify_events
-      JSON.dump(@condition.events.map(&:to_s))
+      Oj.dump(@condition.events.map(&:to_s))
     end
 
     def jsonify_tp_result_chain
-      JSON.dump(tp_result_chain.stringify)
+      # puts tp_result_chain.stringify
+      json_array = tp_result_chain.map { |result| Jsonify.dump(result) }
+      '[ ' + json_array.join(',') + ' ]'
     end
 
     def jsonify_tp_self_caches
-      JSON.dump(tp_self_caches.clone.map(&:to_s))
+      Oj.dump(tp_self_caches.clone.map(&:to_s))
     end
   end # END Wrapper
 

data/lib/source_route.rb

@@ -2,12 +2,15 @@ require 'ostruct'
 require 'logger'
 require 'singleton'
 require 'forwardable'
-
+require 'oj'
 require 'awesome_print'
 
+require "source_route/core_ext"
 require "source_route/version"
 require "source_route/wrapper"
+require "source_route/jsonify"
 require "source_route/generate_result"
+require "source_route/tp_result"
 require "source_route/tp_result_chain"
 require "source_route/tp_filter"
 require 'source_route/json_overrides/activerecord_associations_association'

data/source_route.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'source_route/version'
@@ -21,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'awesome_print'
   spec.add_dependency 'slim'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'oj'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/test/source_route_test.rb

@@ -47,19 +47,21 @@ class SourceRouteTest < Minitest::Test
 
   def test_not_match
     SourceRoute.enable do
+      defined_class 'SampleApp' # without it, a dead loop will occur
       method_id_not 'nonsense'
     end
     SampleApp.new.nonsense
     refute_includes @wrapper.tp_result_chain.map(&:values).flatten, 'nonsense'
   end
 
-  def test_match_class_name
+  def test_match_multiple_class_name
     SourceRoute.enable do
-      defined_class :SampleApp
+      defined_class [:SampleApp, :String]
     end
 
     SampleApp.new.nonsense
     assert @wrapper.tp_result_chain.size > 0
+    assert_equal SampleApp, @wrapper.tp_result_chain.last.core[:defined_class]
   end
 
   def test_source_route_with_one_parameter
@@ -97,9 +99,7 @@ class SourceRouteTest < Minitest::Test
   end
 
   def test_trace_with_c_call
-    SourceRoute.trace event: :c_call do
-      'abc'.upcase
-    end
+    SourceRoute.trace(event: :c_call) { 'abc'.upcase }
 
     assert_equal 2, @wrapper.tp_result_chain.size
   end
@@ -157,7 +157,7 @@ class SourceRouteTest < Minitest::Test
     ret_value = @wrapper.tp_result_chain.last
 
     assert_equal 88, ret_value[:local_var][:param1]
-    assert_equal nil, ret_value[:local_var][:param2]
+    assert_equal 'nil', ret_value[:local_var][:param2]
   end
 
   def test_track_local_var_when_event_is_return
@@ -196,7 +196,7 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.init_cool_app
     @wrapper.import_return_value_to_call_chain
-    assert @wrapper.call_chain[0].key?(:return_value), 'call results should contain return_value'
+    assert @wrapper.call_chain[0].has_key?(:return_value), 'call results should contain return_value'
   end
 
   def test_order_call_sequence
@@ -205,7 +205,6 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense_with_instance_var
     @wrapper.treeize_call_chain
-    @wrapper.treeize_call_chain
     call_results = @wrapper.call_chain
 
     nonsense_call_tp = call_results.find { |tp| tp[:method_id] == :nonsense }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -125,11 +153,15 @@ files:
 - examples/show_task_trace_in_rails.rb
 - examples/study_callback.rb
 - lib/source_route.rb
+- lib/source_route/core_ext.rb
 - 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/jsonify.rb
+- lib/source_route/rails_plugins/source_track_middleware.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
@@ -171,3 +203,4 @@ test_files:
 - test/source_route/wrapper_test.rb
 - test/source_route_test.rb
 - test/test_helper.rb
+has_rdoc: