source_route 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 041a4d7886479530f9fde5b9ae5d065ecd8e8d37
-  data.tar.gz: 90b253aafe37a4fe6748fa28157928ef6c52e89f
+  metadata.gz: e359db40f93fb8aa3973ed198e521e29c21aa2ab
+  data.tar.gz: b0f07e1dce0010f430d54b81b993c0bd7dcb73e4
 SHA512:
-  metadata.gz: 493b59aebebc7469f2e018541afc7fa109462a2029bee32157248ef7eed86ca940a6b22804356b6ebad0cee9617c097bd1ec7c874d380d6d128fdd8c4154f826
-  data.tar.gz: cd3354a5fa9fe8091aedcdb46d28f6dd329df0e8750e139ebe4d4d66a12db21d2eb3e0abeb0f409b7cb7464c0a84268f8ce24be60de9b48900e22cbc9c45c206
+  metadata.gz: b418b380f34fe5ed9aa794eab4950b6c9936f9f019408047de068412c1986f49d17c0d84cb05e80d302d30af3f27b3d404797d8d2d7077feb7f143bc728437ec
+  data.tar.gz: 02fd9a36fbb122ebadfd660baf1fe19328f272ba0260a5620becdd310bb69b34d68af85655f1355353b9ac375b38f4819f9feb61690c17d4f4358924e8f16ff1

data/README.md

@@ -62,6 +62,19 @@ It will output the trace when you run the application.
 see more usage in examples.
 see full usage in examples/callback_in_activesupport.rb
 
+## Why
+
+I always wanna upgrade my ruby(rails) skills. But everytime when I look 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.
+
+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.
+
 ## Test
 
     $ bundle install
@@ -78,6 +91,10 @@ see full usage in examples/callback_in_activesupport.rb
 
 ### TODO
 
+Open Method directly from browser
+
+Apply https://github.com/a5hik/ng-sortable
+
 Hide defined class filter. Add vertical timeline.
 (see http://tympanus.net/codrops/2013/05/02/vertical-timeline/
 http://stackoverflow.com/questions/20896240/responsive-timeline-ui-with-bootstrap3)

data/examples/callback_in_activesupport.rb

@@ -3,10 +3,9 @@ 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
+  full_feature
 end
 
 class Record

data/examples/show_init_files_when_rails_server_start.rb

@@ -16,7 +16,7 @@ SourceRoute.enable do
   end
 end
 
-# The above source route block defines similar trace point feature as following
+# The above source route block defines trace point feature as following
     # files = []
     # tp = TracePoint.new(:line) do |tp|
     #   if tp.path =~ /your_rails_application_root_dir_name/

data/lib/source_route/formats/html.rb

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

data/lib/source_route/formats/html_template.slim

@@ -13,20 +13,6 @@ html
       .call-level-4 { margin-left: 150px }
   body(ng-app="SourceRoute" ng-controller="MainCtrl")
 
-    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)}")
-
-
     nav.navbar.navbar-default.navbar-static-top
       .container
         .container-fluid
@@ -46,12 +32,12 @@ html
     .container
       .trace-flow
         .row
-          .left-info.col-sm-4
+          .left-info.col-sm-4(ng-if="false")
             .btn-group-vertical
               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-8(ng-class="{{traceFilter.event}}")
+                span(ng-bind="klass.substring(0, 40)" popover="{{klass}}" popover-trigger="mouseenter" popover-placement="bottom")
+          .traces.center-info.col-sm-12(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")
@@ -63,24 +49,24 @@ html
                 div(ng-if="trace.hasOwnProperty('return_value')")
                   span
                     | =>
-                  span<(ng-bind="trace.return_value")
+                  span<(ng-bind="trace.return_value.substring(0, 150)")
 
               .details(ng-if="showMoreDetail")
-                .local-vars.well.well-sm(ng-if="trace.local_var" style="color: green")
+                .local-vars.well.well-sm(ng-if="trace.local_var" style="color: green; margin-bottom: 0")
                   span Local Var
                   .local-values(ng-repeat="(key, value) in trace.local_var")
                     span<>(ng-bind="key")
                     span<>
                       | =>
                     / ? could inspect repaire it ?
-                    span<>(ng-bind="value || 'null'")
-                .ins-vars.well.well-sm(ng-if="trace.instance_var" style="color: blue")
+                    span<>(ng-bind="value | json")
+                .ins-vars.well.well-sm(ng-if="trace.instance_var" style="color: blue; margin-bottom: 0")
                   span Instance Var
                   .ins-values(ng-repeat="(key, value) in trace.instance_var")
                     span<>(ng-bind="key")
                     span<>
                       | =>
-                    span<>(ng-bind="value || 'null'")
+                    span<>(ng-bind="value | json")
                 .path-value.well.well-sm(ng-if="trace.path")
                   span Path
                   div
@@ -90,9 +76,10 @@ html
           .right-info.col-sm-2
 
     script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.3.0/angular.min.js"
+    script src="https://cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/0.11.2/ui-bootstrap-tpls.min.js"
 
     javascript:
-      sourceRoute = angular.module('SourceRoute', [])
+      sourceRoute = angular.module('SourceRoute', ['ui.bootstrap'])
       sourceRoute.controller('MainCtrl', function($scope, $filter) {
         $scope.traces = angular.element("#trace-data").data('trace')
         $scope.tpEvents = angular.element("#trace-data").data('tp-events')
@@ -122,3 +109,16 @@ 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)}")

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_local_var, :include_instance_var, :include_tp_self,
                         :filename, :import_return_to_call) do
       def initialize(f="silence", s=[], ilr=false, iiv=false)
         super(f, s, ilr, iiv)
@@ -44,8 +44,9 @@ module SourceRoute
     def build(trace_point_instance)
       @tp = trace_point_instance
       collect_tp_data
-      collect_local_var_data
-      collect_instance_var_data
+      @collect_data[:tp_self] = @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
     end
 
@@ -84,27 +85,23 @@ module SourceRoute
     end
 
     def collect_local_var_data
-      if @wrapper.condition.result_config[:include_local_var]
-        local_var_hash = {}
-
-        @tp.binding.eval('local_variables').each do |v|
-          local_var_hash[v] = @tp.binding.local_variable_get v
-        end
-        if local_var_hash != {}
-          @collect_data.merge!(local_var: local_var_hash)
-        end
+      local_var_hash = {}
+
+      @tp.binding.eval('local_variables').each do |v|
+        local_var_hash[v] = @tp.binding.local_variable_get v
+      end
+      if local_var_hash != {}
+        @collect_data.merge!(local_var: local_var_hash)
       end
     end
 
     def collect_instance_var_data
-      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)
-        end
-        if instance_var_hash != {}
-          @collect_data.merge!(instance_var: instance_var_hash)
-        end
+      instance_var_hash = {}
+      @tp.self.instance_variables.each do |key|
+        instance_var_hash[key] = @tp.self.instance_variable_get(key)
+      end
+      if instance_var_hash != {}
+        @collect_data.merge!(instance_var: instance_var_hash)
       end
     end
 

data/lib/source_route/tp_result_chain.rb

@@ -20,9 +20,14 @@ module SourceRoute
 
     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]
+        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]
+
+        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]
       end
     end
 

data/lib/source_route/version.rb

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

data/lib/source_route/wrapper.rb

@@ -30,7 +30,6 @@ module SourceRoute
       end
 
       def event(*v)
-        # why need self? without self, the events will not really changed, why?. seems a bug in Struct
         self.events = v.map(&:to_sym) unless v == []
       end
 
@@ -41,6 +40,16 @@ module SourceRoute
       def has_call_and_return_event
         events.include? :return and events.include? :call
       end
+
+      def full_feature(value=true)
+        return unless value
+
+        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
+      end
     end
 
     def initialize

data/lib/source_route.rb

@@ -46,6 +46,7 @@ module SourceRoute
     opt.each do |k, v|
       wrapper.condition.send(k, v)
     end
+
     wrapper.trace
     yield
     wrapper.tp.disable

data/test/source_route_test.rb

@@ -104,6 +104,15 @@ class SourceRouteTest < Minitest::Test
     assert_equal 2, @wrapper.tp_result_chain.size
   end
 
+  def test_trace_with_full_feature
+    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 first_result[:tp_self]
+  end
+
   def test_trace_without_first_hash_option
     SourceRoute.trace output_format: :test do
       SampleApp.new.nonsense

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print