source_route 0.5.0 → 0.6.0

data/lib/source_route/proxy.rb

@@ -1,6 +1,6 @@
 module SourceRoute
 
-  class Proxy # todo Rename it to Proxy
+  class Proxy
     include Singleton
 
     attr_accessor :config, :tp, :result_builder
@@ -19,17 +19,17 @@ module SourceRoute
     end
 
     def trace
-      tp_filter = TpFilter.new(config)
+      trace_filter = TraceFilter.new(config)
       track = TracePoint.new(*config.event) do |tp|
-        next if tp_filter.block_it?(tp)
+        next if trace_filter.block_it?(tp)
         @result_builder.output(tp)
       end
       track.enable
       self.tp = track
     end
 
-    def tp_result_chain
-      result_builder.tp_result_chain
+    def trace_chain
+      result_builder.trace_chain
     end
   end # END Proxy
 

data/lib/source_route/rails_plugins/source_track_middleware.rb

@@ -3,18 +3,17 @@ module Rack
 
     def initialize(app, opts={})
       @opts = opts
-      if @opts.present?
-        ::SourceRoute.enable do
-          # defined_class 'Cors'
-          # method_id opts[:method_id] # will crashed
-          method_id 'resource_for_path'
-          full_feature
-        end
-      end
       @app = app
     end
 
     def call(env)
+      ::SourceRoute.enable do
+        # defined_class 'Cors'
+        # method_id opts[:method_id] # will crashed
+        method_id 'render'
+        full_feature
+      end
+
       @app.call(env)
     end
 

data/lib/source_route/tp_result.rb

@@ -123,6 +123,8 @@ module SourceRoute
     def get_local_or_params_var
       local_var_hash = {}
       # Warn: @tp_ins.binding.eval('local_variables') =! @tp_ins.binding.send('local_variables')
+      # Params var is complex, see https://alexcastano.com/everything-about-ruby-splats/ for more details
+      # so actually here just get local variables which includes params
       @tp_ins.binding.eval('local_variables').each do |v|
         # I need comment out why i need source_route_display
         # must be some strange variables require it

data/lib/source_route/{tp_result_chain.rb → trace_chain.rb}

@@ -1,6 +1,6 @@
 module SourceRoute
   # delegate to Array
-  class TpResultChain
+  class TraceChain
     attr_reader :chain
 
     extend Forwardable
@@ -69,5 +69,5 @@ module SourceRoute
       end
     end
 
-  end # END TpResultChain
+  end # END TraceChain
 end

data/lib/source_route/{tp_filter.rb → trace_filter.rb}

@@ -1,6 +1,6 @@
 module SourceRoute
 
-  class TpFilter
+  class TraceFilter
     attr_accessor :cond
     def initialize(condition)
       @cond = condition
@@ -8,9 +8,18 @@ module SourceRoute
 
     # to improve performance, we didnt assign tp as instance variable
     def block_it?(tp)
-      return true if negative_check(tp)
-      return false if positives_check(tp)
-      true
+      if @cond.track_params
+        return true if negative_check(tp)
+        if positives_check(tp)
+          return !tp.binding.eval('local_variables').any? do |v|
+            tp.binding.local_variable_get(v).object_id == @cond.track_params
+          end
+        end
+      else
+        return true if negative_check(tp)
+        return false if positives_check(tp)
+      end
+      true # default is blocked the tp
     end
 
     def negative_check(tp)

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/source_route.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-shell'

data/test/sample_app.rb

@@ -48,6 +48,14 @@ class SampleApp
       cool_in_foo = 'foo data'
       @cool_ins_after = 'will shown in result?'
     end
+
+    def reverse_hash(h)
+      ret = {}
+      h.each do |k, v|
+        ret[v] = k
+      end
+      ret
+    end
   end
 
   class RetObj
@@ -59,4 +67,5 @@ class SampleApp
       {temp: 'testing'}
     end
   end
+
 end

data/test/source_route/config_test.rb

@@ -3,11 +3,11 @@ require 'test_helper'
 module SourceRoute
   class ConfigTest < Minitest::Test
 
-    def test_tp_filter_methods
-      assert TP_FILTER_METHODS.include?(:defined_class_not)
-      assert TP_FILTER_METHODS.include?(:method_id_not)
-      assert TP_FILTER_METHODS.include?(:path)
-      assert TP_FILTER_METHODS.frozen?
+    def test_trace_filter_methods
+      assert TRACE_FILTER_METHODS.include?(:defined_class_not)
+      assert TRACE_FILTER_METHODS.include?(:method_id_not)
+      assert TRACE_FILTER_METHODS.include?(:path)
+      assert TRACE_FILTER_METHODS.frozen?
     end
 
     def test_block_parser
@@ -56,11 +56,13 @@ module SourceRoute
     def test_full_feature_of_params_parser
       params = {output_format: 'html', event: :c_call,
                 defined_class: 'ActiveRecord::Base',
-                method_id_not: ['initialize', 'nonsense']
+                method_id_not: ['initialize', 'nonsense'],
+                full_feature: true
                }
       config = ParamsConfigParser.run(params)
       assert_equal :html, config.output_format
-      assert_equal [:c_call], config.event
+      assert_equal [:c_call, :call, :return], config.event
+      assert config.full_feature
       assert_equal 'ActiveRecord::Base', config.positives[:defined_class]
       assert_equal 'initialize|nonsense', config.negatives[:method_id]
     end

data/test/source_route/{tp_filter_test.rb → trace_filter_test.rb}

@@ -7,7 +7,7 @@ module SourceRoute
 
   FakeTp = Struct.new(:method_id, :defined_class, :lineno)
 
-  class TpFilterTest < Minitest::Test
+  class TraceFilterTest < Minitest::Test
 
     def setup
       @devise_tp = FakeTp.new(:auth, Devise, 5)
@@ -20,24 +20,24 @@ module SourceRoute
     def test_filter_method_not_auth
       cond = Config.new
       cond.negatives[:method_id] = 'auth'
-      @tp_filter = TpFilter.new(cond)
-      filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
+      @trace_filter = TraceFilter.new(cond)
+      filtered = @tps.reject { |tp| @trace_filter.block_it?(tp) }
       assert_equal [@user_tp], filtered
     end
 
     def test_filter_class_is_admin
       cond = Config.new
       cond.positives[:defined_class] = 'Admin'
-      @tp_filter = TpFilter.new(cond)
-      filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
+      @trace_filter = TraceFilter.new(cond)
+      filtered = @tps.reject { |tp| @trace_filter.block_it?(tp) }
       assert_equal [], filtered
     end
 
     def test_filter_method_is_auth
       cond = Config.new
       cond.positives[:method_id] = 'auth'
-      @tp_filter = TpFilter.new(cond)
-      filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
+      @trace_filter = TraceFilter.new(cond)
+      filtered = @tps.reject { |tp| @trace_filter.block_it?(tp) }
       assert_equal [@devise_tp, @warden_tp], filtered
     end
 
@@ -45,16 +45,16 @@ module SourceRoute
       cond = Config.new
       cond.positives[:defined_class] = 'Devise'
       cond.positives[:method_id] = 'new'
-      @tp_filter = TpFilter.new(cond)
-      filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
+      @trace_filter = TraceFilter.new(cond)
+      filtered = @tps.reject { |tp| @trace_filter.block_it?(tp) }
       assert_equal [@devise_tp, @user_tp], filtered
     end
 
     def test_filter_class_is_devise_or_warden
       cond = Config.new
       cond.positives[:defined_class] = 'Warden|User'
-      @tp_filter = TpFilter.new(cond)
-      filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
+      @trace_filter = TraceFilter.new(cond)
+      filtered = @tps.reject { |tp| @trace_filter.block_it?(tp) }
       assert_equal [@warden_tp, @user_tp], filtered
     end
   end

data/test/source_route_test.rb

@@ -36,14 +36,14 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense
 
-    assert_includes @proxy.tp_result_chain.first.path, 'test'
+    assert_includes @proxy.trace_chain.first.path, 'test'
   end
 
   def test_match_class_name_by_first_parameter
     @source_route = SourceRoute.enable 'SampleApp'
     SampleApp.new.nonsense
 
-    assert @proxy.tp_result_chain.size > 0
+    assert @proxy.trace_chain.size > 0
   end
 
   def test_not_match
@@ -52,7 +52,7 @@ class SourceRouteTest < Minitest::Test
       method_id_not 'nonsense'
     end
     SampleApp.new.nonsense
-    refute_includes @proxy.tp_result_chain.map(&:method_id).flatten, 'nonsense'
+    refute_includes @proxy.trace_chain.map(&:method_id).flatten, 'nonsense'
   end
 
   def test_match_multiple_class_name
@@ -61,8 +61,8 @@ class SourceRouteTest < Minitest::Test
     end
 
     SampleApp.new.nonsense
-    assert @proxy.tp_result_chain.size > 0
-    assert_equal SampleApp, @proxy.tp_result_chain.last.defined_class
+    assert @proxy.trace_chain.size > 0
+    assert_equal SampleApp, @proxy.trace_chain.last.defined_class
   end
 
   def test_source_route_with_one_parameter
@@ -71,19 +71,19 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense
 
-    ret_tp = @proxy.tp_result_chain.last
+    ret_tp = @proxy.trace_chain.last
     assert_equal SampleApp, ret_tp.defined_class
   end
 
   def test_proxy_reset
     SourceRoute.enable 'nonsense'
     SampleApp.new.nonsense
-    assert_equal 1, @proxy.tp_result_chain.size
+    assert_equal 1, @proxy.trace_chain.size
 
     SourceRoute.reset
     SampleApp.new.nonsense
 
-    assert_equal 0, @proxy.tp_result_chain.size
+    assert_equal 0, @proxy.trace_chain.size
   end
 
   def test_source_route_with_block
@@ -96,7 +96,7 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense
 
-    assert_equal 0, @proxy.tp_result_chain.size
+    assert_equal 0, @proxy.trace_chain.size
     assert_equal 1, paths.size
     assert_includes paths.first, 'sample_app'
   end
@@ -104,14 +104,14 @@ class SourceRouteTest < Minitest::Test
   def test_trace_with_c_call
     SourceRoute.trace(event: :c_call) { 'abc'.upcase }
 
-    assert_equal 2, @proxy.tp_result_chain.size
+    assert_equal 2, @proxy.trace_chain.size
   end
 
   def test_trace_with_full_feature
     SourceRoute.trace method_id: 'nonsense', full_feature: 10 do
       SampleApp.new.nonsense
     end
-    first_result = @proxy.tp_result_chain.first
+    first_result = @proxy.trace_chain.first
     assert_equal first_result.tp_self_refer, 0
   end
 
@@ -123,20 +123,20 @@ class SourceRouteTest < Minitest::Test
   #   assert @proxy.tp_self_caches.first.is_a? SampleApp
   # end
 
-  def test_stringify_tp_result_chain_only
+  def test_stringify_trace_chain_only
     SourceRoute.trace method_id: 'nonsense', full_feature: true do
       SampleApp.new.nonsense
     end
-    origin_tp_result_chain = @proxy.tp_result_chain
-    assert @proxy.tp_result_chain.first.stringify.defined_class.is_a? String
-    assert_equal origin_tp_result_chain, @proxy.tp_result_chain
+    origin_trace_chain = @proxy.trace_chain
+    assert @proxy.trace_chain.first.stringify.defined_class.is_a? String
+    assert_equal origin_trace_chain, @proxy.trace_chain
   end
 
   def test_trace_without_first_hash_option
     SourceRoute.trace output_format: :test do
       SampleApp.new.nonsense
     end
-    assert @proxy.tp_result_chain.size > 0
+    assert @proxy.trace_chain.size > 0
     refute @proxy.tp.enabled?
   end
 
@@ -145,7 +145,7 @@ class SourceRouteTest < Minitest::Test
       event :call, :return
     end
     SampleApp.new.nonsense
-    assert_equal 2, @proxy.tp_result_chain.size
+    assert_equal 2, @proxy.trace_chain.size
   end
 
   # but local var didnt displayed
@@ -157,7 +157,7 @@ class SourceRouteTest < Minitest::Test
 
     SampleApp.new.nonsense_with_params(88)
 
-    ret_value = @proxy.tp_result_chain.last
+    ret_value = @proxy.trace_chain.last
   end
 
   def test_track_local_var_when_event_is_return
@@ -167,9 +167,9 @@ class SourceRouteTest < Minitest::Test
     end
 
     SampleApp.new.nonsense_with_params(88)
-    assert_equal 1, @proxy.tp_result_chain.size
+    assert_equal 1, @proxy.trace_chain.size
 
-    ret_value_for_return_event = @proxy.tp_result_chain.last
+    ret_value_for_return_event = @proxy.trace_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
@@ -181,8 +181,8 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new('ins sure').nonsense_with_instance_var
 
-    assert_equal 4, @proxy.tp_result_chain.size
-    ret_value = @proxy.tp_result_chain.pop
+    assert_equal 4, @proxy.trace_chain.size
+    ret_value = @proxy.trace_chain.pop
 
     assert_equal 'ins sure', ret_value.instance_var[:@sample]
   end
@@ -192,8 +192,20 @@ class SourceRouteTest < Minitest::Test
       full_feature 10
     end
     SampleApp.new('cool stuff').init_cool_app
-    @proxy.tp_result_chain.import_return_value_to_call_chain
-    assert @proxy.tp_result_chain.call_chain[0].return_value, 'call results should contain return_value'
+    @proxy.trace_chain.import_return_value_to_call_chain
+    assert @proxy.trace_chain.call_chain[0].return_value, 'call results should contain return_value'
+  end
+
+  def test_trace_when_value_was_passed_to_method
+    hash = {x: 1, y: 2}
+    SourceRoute.enable do
+      track_params hash
+    end
+    SampleApp.new
+    ca = SampleApp::CoolApp.new
+    ca.reverse_hash(hash)
+    SourceRoute.output_html
+    assert_equal 1, @proxy.trace_chain.size
   end
 
   def test_order_call_sequence
@@ -202,8 +214,8 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense_with_instance_var
 
-    @proxy.tp_result_chain.treeize_call_chain
-    call_results = @proxy.result_builder.tp_result_chain.call_chain
+    @proxy.trace_chain.treeize_call_chain
+    call_results = @proxy.result_builder.trace_chain.call_chain
 
     nonsense_call_tp = call_results.find { |tp| tp.method_id == :nonsense }
     nonsense_with_instance_var_call_tp = call_results.find do |tp|
@@ -211,7 +223,7 @@ class SourceRouteTest < Minitest::Test
     end
     assert_equal [nonsense_with_instance_var_call_tp.order_id], nonsense_call_tp.parent_ids
     assert_equal 1, nonsense_call_tp.parent_length
-    assert_equal [0, 1], @proxy.result_builder.tp_result_chain.parent_length_list
+    assert_equal [0, 1], @proxy.result_builder.trace_chain.parent_length_list
     assert_equal [nonsense_call_tp.order_id], nonsense_with_instance_var_call_tp.direct_child_order_ids
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -187,22 +173,21 @@ files:
 - lib/source_route/core_ext.rb
 - lib/source_route/formats/html.rb
 - lib/source_route/formats/html_semantic.slim
-- lib/source_route/formats/html_semantic.slim.failtry
+- lib/source_route/formats/html_semantic_vue.slim
 - lib/source_route/generate_result.rb
 - lib/source_route/json_overrides/activerecord_associations_association.rb
-- lib/source_route/jsonify.rb
 - lib/source_route/proxy.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/trace_chain.rb
+- lib/source_route/trace_filter.rb
 - lib/source_route/version.rb
 - source_route.gemspec
 - test/fake_app.rb
 - test/sample_app.rb
 - test/source_route/config_test.rb
 - test/source_route/proxy_test.rb
-- test/source_route/tp_filter_test.rb
+- test/source_route/trace_filter_test.rb
 - test/source_route_test.rb
 - test/test_helper.rb
 homepage: http://github.com/raykin/source-route
@@ -225,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Wrapper of TracePoint.
@@ -234,7 +219,6 @@ test_files:
 - test/sample_app.rb
 - test/source_route/config_test.rb
 - test/source_route/proxy_test.rb
-- test/source_route/tp_filter_test.rb
+- test/source_route/trace_filter_test.rb
 - test/source_route_test.rb
 - test/test_helper.rb
-has_rdoc: