source_route 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d7a56268a17ce2f0ea56258f3eaa28afac00dac
-  data.tar.gz: ffd4b43dd9a3b1dfa298695352cec8486c554d21
+  metadata.gz: 67d1a63084f0e5b6a0f2e7fb6f066d8b02510590
+  data.tar.gz: f7cc2c6ddc3632cde00f74a97b634834df307154
 SHA512:
-  metadata.gz: c3a6f2c1acf132f9ef1b8efa0463febbd55e62bc4ecf6f36fc89af0f63793bf662bce96dbfff758663b6753de2e12491284e298da0a25d28f998ca63198320c8
-  data.tar.gz: 334f6cd5aafc1091a17c67ced52bd9f865a3154894a6ec72806c52eba0caa4a23ad5539df249c0e636f217d012019eebd223d8c6b297a407f892542e2f807b16
+  metadata.gz: 001a12df5c3bbb0c3ae80d92f1661732ddbd44689f72cb214b84a3b55e01d266282273e094347ed795816fe3d66fc524247ffa4b3a6a3a5d4cce87f8da70b3b2
+  data.tar.gz: 8bd9da28ab7372e981ca605e63402f6bd7637db273be83c920db5b3548a9c6b0af01082b78cf6762a230fda79678be491586ec156168251b5b17195ce6c84a21

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.ruby-version

data/README.md

@@ -10,7 +10,7 @@ Wrapper of TracePoint
 
 Add this line to your application's Gemfile:
 
-    gem 'source_route', git: 'https://github.com/raykin/source-route'
+    gem 'source_route'
 
 And then execute:
 
@@ -26,7 +26,7 @@ Or install it yourself as:
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/source_route/fork )
+1. Fork it ( https://github.com/raykin/source_route/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/source_route/formats/html_template.slim

@@ -11,7 +11,9 @@ html
     / pry(main)> ActiveRecord::Inheritance::ClassMethods.to_json => {} # Dont know why
     ruby:
       trace_data = @tp_attrs_results.map do |tp_result|
-        tp_result[:defined_class] = tp_result[:defined_class].nature_value
+        if tp_result.has_key?(:defined_class)
+          tp_result[:defined_class] = tp_result[:defined_class].nature_value
+        end
         tp_result
       end
 
@@ -25,16 +27,33 @@ html
           =< @conditions.event
       .trace-flow
         .row
-          .left-info.col-sm-3
+          .left-info.col-sm-4
             .well.well-sm(ng-repeat="klass in definedClasses")
-              p.text-center(ng-bind="klass")
-          .center-info.col-sm-5
-            .well.well-lg(ng-repeat="trace in traces")
-              p
+              button.btn.btn-default(ng-click="selectKlass(klass)")
+                span(ng-bind="klass")
+          .center-info.col-sm-6
+            .well.well-lg(ng-repeat="trace in traces | filter:{defined_class: selectedKlass}")
+              div(ng-click="showMoreDetail = !showMoreDetail")
                 span(ng-bind="trace.defined_class")
                 span #
                 span(ng-bind="trace.method_id")
-          .right-info.col-sm-3
+              .details(ng-if="showMoreDetail")
+                .local-vars.well.well-sm(ng-if="trace.local_var" style="color: green")
+                  span Local Var
+                  .local-values(ng-repeat="(key, value) in trace.local_var")
+                    span<>(ng-bind="key")
+                    span<>
+                      | =>
+                    span<>(ng-bind="value || 'null'")
+                .ins-vars.well.well-sm(ng-if="trace.instance_var" style="color: blue")
+                  span Instance Var
+                  .ins-values(ng-repeat="(key, value) in trace.instance_var")
+                    span<>(ng-bind="key")
+                    span<>
+                      | =>
+                    span<>(ng-bind="value || 'null'")
+
+          .right-info.col-sm-2
 
     script src="http://ajax.googleapis.com/ajax/libs/angularjs/1.2.25/angular.min.js"
 
@@ -45,4 +64,13 @@ html
         // it is possible to prevent dirty check on definedClasses after it was generated
         $scope.definedClasses = _.uniq(_.map($scope.traces, 'defined_class'))
         $scope.definedClasses.unshift('ALL')
+
+        $scope.selectKlass = function(klass) {
+          if (klass == 'ALL') {
+            $scope.selectedKlass = undefined
+          } else {
+            $scope.selectedKlass = klass
+          }
+        }
+
       })

data/lib/source_route/tp_result.rb

@@ -3,8 +3,8 @@ module SourceRoute
   class TpResult
 
     DEFAULT_ATTRS = {
-      call: [:defined_class, :event, :method_id],
-      return: [:defined_class, :event, :method_id, :return_value]
+      call: [:defined_class, :method_id],
+      return: [:defined_class, :method_id, :return_value]
     }
 
     def initialize(wrapper)
@@ -12,10 +12,13 @@ module SourceRoute
 
       @output_config = @wrapper.conditions.result_config
 
-      @tp_event = @wrapper.conditions.event.to_sym
-      if @output_config[:selected_attrs].nil? and [@wrapper.conditions.event].flatten.size == 1
-        @output_config[:selected_attrs] = DEFAULT_ATTRS[@tp_event] - [:event]
-      end
+      @tp_events = @wrapper.conditions.events
+    end
+
+    def output_attributes(event)
+      attrs = @output_config[:selected_attrs] || DEFAULT_ATTRS[event]
+      attrs.push(:event) if @tp_events.size > 1
+      attrs
     end
 
     def build(trace_point_instance)
@@ -26,7 +29,7 @@ module SourceRoute
       @collect_data
     end
 
-    # always run build before it # not a good design
+    # must run build before it # not a good design
     def output
 
       format = @output_config[:output_format].to_sym
@@ -53,7 +56,7 @@ module SourceRoute
     private
 
     def collect_tp_data
-      @collect_data = @output_config[:selected_attrs].inject({}) do |memo, key|
+      @collect_data = output_attributes(@tp.event).inject({}) do |memo, key|
         memo[key.to_sym] = @tp.send(key) if @tp.respond_to?(key)
         memo
       end
@@ -66,8 +69,9 @@ module SourceRoute
         @tp.binding.eval('local_variables').each do |v|
           local_var_hash[v] = @tp.binding.local_variable_get v
         end
-
-        @collect_data.merge!(local_var: local_var_hash)
+        if local_var_hash != {}
+          @collect_data.merge!(local_var: local_var_hash)
+        end
       end
     end
 
@@ -77,7 +81,9 @@ module SourceRoute
         @tp.self.instance_variables.each do |key|
           instance_var_hash[key] = @tp.self.instance_variable_get(key)
         end
-        @collect_data.merge!(instance_var: instance_var_hash)
+        if instance_var_hash != {}
+          @collect_data.merge!(instance_var: instance_var_hash)
+        end
       end
     end
 

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/source_route/wrapper.rb

@@ -13,7 +13,7 @@ module SourceRoute
     # output_format can be console, html
     def reset
       @tp.disable if @tp
-      @conditions = OpenStruct.new(event: :call, negative: {}, positive: {},
+      @conditions = OpenStruct.new(events: :call, negative: {}, positive: {},
                                    result_config: { output_format: 'none',
                                      selected_attrs: nil,
                                      include_local_var: false,
@@ -23,11 +23,10 @@ module SourceRoute
       self
     end
 
-    # TODO: make event can be array
-    def event(v)
-      @conditions.event = v.to_sym unless v.nil?
+    def events(v)
+      @conditions.events = Array(v).map(&:to_sym) unless v.nil?
     end
-
+    alias :event :events
     def set_result_config(value)
       unless value.is_a? Hash
         conditions.result_config = value
@@ -70,7 +69,7 @@ module SourceRoute
       # dont wanna init it in tp block, cause tp block could run thousands of time in one cycle trace
       tp_result = TpResult.new(self)
 
-      track = TracePoint.new conditions.event do |tp|
+      track = TracePoint.new *conditions.events do |tp|
         negative_break = conditions.negative.any? do |method_key, value|
           tp.send(method_key).nature_value =~ Regexp.new(value)
         end
@@ -81,8 +80,8 @@ module SourceRoute
         next if positive_break
 
         ret_data = tp_result.build(tp)
-        tp_result.output
         tp_attrs_results.push(ret_data)
+        tp_result.output
       end
       track.enable
       self.tp = track

data/lib/source_route.rb

@@ -43,7 +43,7 @@ module SourceRoute
     wrapper.trace
     yield
     wrapper.tp.disable
-    SourceRoute.build_html_output if opt[:output_format] == :html
+    SourceRoute.build_html_output if opt[:output_format].to_sym == :html
   end
 
   def build_html_output

data/source_route.gemspec

@@ -10,8 +10,9 @@ Gem::Specification.new do |spec|
   spec.email         = ["raykincoldxiao@gmail.com"]
   spec.summary       = %q{Wrapper of TracePoint.}
   spec.description   = %q{Wrapper of TracePoint.}
-  spec.homepage      = ""
+  spec.homepage      = "http://github.com/raykin/source-route"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -23,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'slim'
+  spec.add_development_dependency 'minitest'
 end

data/test/sample_app.rb

@@ -2,8 +2,8 @@
 # When add more complex test, update FakeApp
 class SampleApp
 
-  def initialize(cool=nil)
-    @cool = cool if cool
+  def initialize(sample=nil)
+    @sample = sample if sample
   end
 
   def nonsense
@@ -17,4 +17,23 @@ class SampleApp
   def nonsense_with_instance_var
     nonsense
   end
+
+  def init_cool_app
+    CoolApp.new.foo
+  end
+
+  class CoolApp
+    def initialize
+      @cool = ['test', 'data']
+      # todo: cant display on html easily
+      @cool_hash = {first: :run, second: :halt, third: :stop}
+      cool_in_init = 'init data in cool app'
+
+    end
+
+    def foo
+      cool_in_foo = 'foo data'
+      @cool_ins_after = 'will shown in result?'
+    end
+  end
 end

data/test/test_helper.rb

@@ -5,4 +5,5 @@ require File.join(File.dirname(__FILE__), 'fake_app')
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'source_route'
-require 'byebug'
+# require 'pry'
+# require 'pry-byebug'

data/test/wrapper_test.rb

@@ -19,7 +19,7 @@ module SourceRoute
       assert_equal @wrapper, SourceRoute.wrapper
     end
 
-    def test_catch_call_event_only
+    def test_catch_call_event
       SourceRoute.enable do
         event :call
         method_id /nonsense/
@@ -48,7 +48,7 @@ module SourceRoute
       assert @wrapper.tp_attrs_results.size > 0
     end
 
-    def test_source_route_with_only_one_parameter
+    def test_source_route_with_one_parameter
       @source_route = SourceRoute.enable 'nonsense'
       SampleApp.new.nonsense
 
@@ -68,23 +68,31 @@ module SourceRoute
     end
 
     def test_source_route_with_block
-      SourceRoute.trace method_id: 'nonsense', output_format: :html do
+      SourceRoute.trace method_id: 'nonsense', output_format: :test do
         SampleApp.new.nonsense
       end
       assert_equal 1, @wrapper.tp_attrs_results.size
       refute @wrapper.tp.enabled?
     end
 
-    def test_trace_without_condition
-      SourceRoute.trace output_format: :html do
+    def test_trace_without_first_hash_option
+      SourceRoute.trace output_format: :test do
         SampleApp.new.nonsense
       end
       assert @wrapper.tp_attrs_results.size > 0
       refute @wrapper.tp.enabled?
     end
 
+    def test_trace_two_events
+      SourceRoute.enable 'nonsense' do
+        events [:call, :return]
+      end
+      SampleApp.new.nonsense
+      assert_equal 2, @wrapper.tp_attrs_results.size
+    end
+
     def test_show_local_variables
-      @source_route = SourceRoute.enable 'nonsense_with_params' do
+      SourceRoute.enable 'nonsense_with_params' do
         output_include_local_variables
       end
 
@@ -94,6 +102,21 @@ module SourceRoute
       ret_value = @wrapper.tp_attrs_results.last
 
       assert_equal 88, ret_value[:local_var][:param1]
+      assert_equal nil, ret_value[:local_var][:param2]
+    end
+
+    def test_track_local_var_when_event_is_return
+      SourceRoute.enable 'nonsense_with_params' do
+        events :return
+        output_include_local_variables
+      end
+
+      SampleApp.new.nonsense_with_params(88)
+      assert_equal 1, @wrapper.tp_attrs_results.size
+
+      ret_value_for_return_event = @wrapper.tp_attrs_results.last
+      assert_equal 88, ret_value_for_return_event[:local_var][:param1]
+      assert_equal 5, ret_value_for_return_event[:local_var][:param2]
     end
 
     def test_show_instance_vars
@@ -101,21 +124,23 @@ module SourceRoute
         output_include_instance_variables
       end
 
-      SampleApp.new(:cool).nonsense_with_instance_var
+      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 :cool, ret_value[:instance_var][:@cool]
+      assert_equal 'ins sure', ret_value[:instance_var][:@sample]
     end
 
-    # Nothing has tested really
-    def test_html_format_output
-      @source_route = SourceRoute.enable 'nonsense' do
+    # Nothing has tested really when run rake cause ENV['ignore_html_generation'] was set to true
+    def test_html_format_output_only
+      @source_route = SourceRoute.enable do
+        defined_class 'SampleApp'
         output_include_instance_variables
+        output_include_local_variables
       end
 
-      SampleApp.new(:cool).nonsense_with_instance_var
+      SampleApp.new.init_cool_app
 
       if ENV['ignore_html_generation'] == 'true'
         # do nothing. it was set in Rakefile, so rake test will not generate html file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper of TracePoint.
 email:
 - raykincoldxiao@gmail.com
@@ -105,7 +119,7 @@ files:
 - test/sample_app.rb
 - test/test_helper.rb
 - test/wrapper_test.rb
-homepage: ''
+homepage: http://github.com/raykin/source-route
 licenses:
 - MIT
 metadata: {}
@@ -117,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -134,4 +148,3 @@ test_files:
 - test/sample_app.rb
 - test/test_helper.rb
 - test/wrapper_test.rb
-has_rdoc: