source_route 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a900afbf3890bf31f01041e72ac6a65f61f3a477
-  data.tar.gz: 85e3915fb47c64ac5cbbe9312c2435a4720758f2
+  metadata.gz: c2fa5c78d22ad8c809c220b45e5d7940fdbe9f84
+  data.tar.gz: f9ff7bcf3f5cb8e116b3dc0023a677aa2e434677
 SHA512:
-  metadata.gz: 91e0b7a0a43e00dddf0d1b8f278324c197f9d62179c066d490c8049913c7eb19e32bb500966938ae2914a5b76541caa77e84508da96b9454dd5a667bcfdeb8ec
-  data.tar.gz: bdc789e2660545ec2b6c0aaac975d2b276bbaf618d4414d46a944fafe383eccd8e9ba1cf38b92a6564541d4ff69e2ce246f3a00da3047cf499f63d695db470b7
+  metadata.gz: d13bafaf3a17ffdc98aeb9491d2cf15c3f05dc140bacc769f4a82a45fbd5143df729b0e1097e63a3939a0330f388ac01d4da1c6fcd6a6a5c06c79d9d57a26286
+  data.tar.gz: 2d4c883291edd2c76e33ae293a99e4046b066fbd3b5194f69ef2fae2504cc685adc0ee786d4dea71f3abc93d9e09c4cf327edd109ac6e1158adfb277fd0dd623

data/README.md

@@ -1,6 +1,6 @@
 # SourceRoute
 
-Wrapper of TracePoint
+Trace ruby code
 
 ## Dependency
 
@@ -40,6 +40,7 @@ you will get a different trace file.
     SourceRoute.enable do
       method_id :wanted_method_name
       full_feature
+      filename 'tmp/capture_wanted.html'
     end
     .... # here is your code
     ....

data/examples/study_callback.rb

@@ -5,7 +5,7 @@ require 'source_route'
 SourceRoute.enable do
   method_id 'base_decorate', 'prepare_decorate'
   defined_class 'ActiveSupport::Callbacks', 'House', 'Filters'
-  result_config.filename = 'trace_callback.html'
+  filename = 'trace_callback.html'
   full_feature 10
 end
 

data/lib/source_route.rb

@@ -1,5 +1,4 @@
 require 'ostruct'
-require 'logger'
 require 'singleton'
 require 'forwardable'
 require 'oj'
@@ -7,7 +6,8 @@ require 'awesome_print'
 
 require "source_route/core_ext"
 require "source_route/version"
-require "source_route/wrapper"
+require "source_route/config"
+require "source_route/proxy"
 require "source_route/jsonify"
 require "source_route/generate_result"
 require "source_route/tp_result"
@@ -18,7 +18,7 @@ require 'source_route/json_overrides/activerecord_associations_association'
 begin
   if Rails
     ActiveSupport.on_load(:after_initialize, yield: true) do
-      # make it respond to to_s. IN rails source, almost all of its methods are removed, including to_s.
+      # make it respond to to_s. In rails source, almost all of its methods are removed, including to_s.
       module ActiveSupport
         class OptionMerger
           def to_s
@@ -35,51 +35,38 @@ end
 module SourceRoute
   extend self
 
-  def wrapper
-    @@wrapper ||= Wrapper.instance
+  def proxy
+    @@proxy ||= Proxy.instance
   end
 
   def reset
-    wrapper.reset
+    proxy.reset
   end
 
   def disable
-    wrapper.tp.disable
+    proxy.tp.disable
   end
 
   def enable(match = nil, &block)
-    wrapper.reset
+    proxy.reset
 
-    if match
-      wrapper.condition.method_id(match)
-      wrapper.condition.defined_class(match)
-    end
-
-    wrapper.condition.instance_eval(&block) if block_given?
+    proxy.config = BlockConfigParser.new.run(match, &block)
 
-    wrapper.trace
+    proxy.trace
   end
 
   def trace(opt, &block)
-    opt[:output_format] ||= :test
-    wrapper.reset
-    opt.each do |k, v|
-      wrapper.condition.send(k, v)
-    end
-
-    wrapper.trace
+    proxy.reset
+    proxy.config = ParamsConfigParser.run(opt)
+    proxy.trace
     yield
-    wrapper.tp.disable
-    SourceRoute.output_html if opt[:output_format].to_sym == :html
+    proxy.tp.disable
+    SourceRoute.output_html if proxy.config.output_format == :html
   end
 
   def output_html
     SourceRoute.disable
-    SourceRoute::Formats::Html.slim_render(wrapper)
-  end
-
-  # Not implement yet
-  class Logger < Logger
+    SourceRoute::Formats::Html.slim_render(proxy)
   end
 
   module Formats

data/lib/source_route/config.rb

@@ -0,0 +1,123 @@
+module SourceRoute
+  TP_FILTER = [:defined_class, :method_id, :path, :lineno].freeze
+  TP_FILTER_METHODS = (TP_FILTER + TP_FILTER.map { |tpf| "#{tpf}_not".to_sym }).freeze
+
+  class Config
+
+    DIRECT_ATTRS = [:event, :full_feature, :debug,
+                    :output_format, :show_additional_attrs,
+                    :filename, :include_local_var, :include_instance_var,
+                    :import_return_to_call
+                   ]
+
+    attr_accessor *DIRECT_ATTRS
+    attr_accessor :negatives, :positives
+
+    def initialize
+      @event = [:call]
+      @output_format = :test
+      @positives = {}
+      @negatives = {}
+    end
+
+    # mutable method
+    def formulize
+      symbolize_output_format
+      event_becomes_array
+      self
+    end
+
+    def symbolize_output_format
+      self.output_format = output_format.to_sym if output_format.respond_to? :to_sym
+    end
+
+    def event_becomes_array
+      self.event = Array(event).map(&:to_sym)
+    end
+
+    def has_call_and_return_event
+      event.include? :return and event.include? :call
+    end
+  end # END Config
+
+  class BlockConfigParser
+    attr_accessor :ret_params
+
+    def initialize
+      @ret_params = {}
+    end
+
+    def run(match_str = nil, &block)
+      unless match_str.nil?
+        ret_params[:defined_class] = match_str
+        ret_params[:method_id] = match_str
+      end
+      instance_eval(&block) if block_given?
+      ParamsConfigParser.run(@ret_params)
+    end
+
+    Config::DIRECT_ATTRS.each do |attr|
+      define_method attr do |v=true|
+        ret_params[attr] = v
+      end
+    end
+
+    # override
+    [:event, :show_additional_attrs].each do |attr|
+      define_method attr do |*v|
+        ret_params[attr] = v unless v == []
+      end
+    end
+
+    # override
+    def output_format(data = nil, &block)
+      ret_params[:output_format] = block_given? ? block : data
+    end
+
+    TP_FILTER_METHODS.each do |m|
+      define_method m do |*v|
+        ret_params[m] = v
+      end
+    end
+
+  end # END BlockConfigParser
+
+  module ParamsConfigParser
+    extend self
+
+    TP_FILTER.each do |m|
+      define_method m do |v|
+        @config.positives[m] = Array(v).flatten.map(&:to_s).join('|')
+      end
+
+      define_method "#{m}_not" do |*v|
+        @config.negatives[m] = Array(v).flatten.map(&:to_s).join('|')
+      end
+    end
+
+    def run(params)
+      @config = Config.new
+      params.each do |k, v|
+        @config.send("#{k}=", v) if Config::DIRECT_ATTRS.include? k.to_sym
+        send(k, v) if (TP_FILTER_METHODS + [:full_feature]).include? k.to_sym
+      end
+      @config.formulize
+    end
+
+    # todo. value equal 10 may not be a good params
+    def full_feature(value=true)
+      return unless value
+      @config.formulize
+      @config.event = (@config.event + [:call, :return]).uniq
+      @config.import_return_to_call = true
+      @config.show_additional_attrs = [:path, :lineno]
+      # JSON serialize trigger many problems when handle complicated object(in rails?)
+      # a Back Door to open more data. but be care it could trigger weird crash when Jsonify these vars
+      if value == 10
+        @config.include_instance_var = true
+        @config.include_local_var = true
+      end
+    end
+  end # END ParamsConfigParser
+
+end

data/lib/source_route/formats/html.rb

@@ -5,19 +5,19 @@ module SourceRoute
   module Formats
     module Html
 
-      def self.slim_render(wrapper)
-        result_config = wrapper.condition.result_config
+      def self.slim_render(proxy)
+
         template_path = File.expand_path "../html_semantic.slim", __FILE__
         slim_template = Slim::Template.new(template_path, pretty: true)
 
-        filename = result_config[:filename] || "#{Time.now.strftime('%H')}-source-route.html"
+        filename = proxy.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.result_builder.import_return_value_to_call_chain
-          wrapper.result_builder.treeize_call_chain
+        if proxy.config.import_return_to_call and proxy.config.has_call_and_return_event
+          proxy.result_builder.import_return_value_to_call_chain
+          proxy.result_builder.treeize_call_chain
         end
         # TODO: any exception triggered in render method will be absorb totally, how to fix it?
-        html_output_str = slim_template.render(wrapper.result_builder)
+        html_output_str = slim_template.render(proxy.result_builder)
         File.open(filename, 'w') do |f|
           f << html_output_str
         end

data/lib/source_route/formats/html_semantic.slim

@@ -4,12 +4,12 @@ html
     title Source Route Result
     link rel="stylesheet" href="https://cdn.rawgit.com/Urigo/angular-spinkit/master/build/angular-spinkit.min.css"
     link rel="stylesheet" href="https://cdn.rawgit.com/mohsen1/json-formatter/master/dist/json-formatter.css"
-    link rel="stylesheet" href="http://oss.maxcdn.com/semantic-ui/2.0.7/semantic.min.css"
+    link rel="stylesheet" href="http://oss.maxcdn.com/semantic-ui/2.1.4/semantic.min.css"
 
     script async=true src="http://cdnjs.cloudflare.com/ajax/libs/lodash.js/3.10.0/lodash.js"
     script src="http://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"
-    script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.4.3/angular.min.js"
-    script async=true src="http://oss.maxcdn.com/semantic-ui/2.0.7/semantic.min.js"
+    script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.4.6/angular.min.js"
+    script async=true src="http://oss.maxcdn.com/semantic-ui/2.1.4/semantic.min.js"
 
     css:
       .call-level-0 {}
@@ -42,7 +42,7 @@ html
         .right.menu
           .item
             span Trace Count
-            .ui.teal.pointing.left.label(ng-bind="currentCounter()")
+            .ui.teal.left.pointing.label(ng-bind="currentCounter()")
 
     .ui.container
       .row
@@ -57,11 +57,11 @@ html
               / workaround for return_value is 'false' and return_value always to be string when existed
               .meta(ng-if="trace.hasOwnProperty('return_value')")
                 i.icon.pointing.right.small
-                json-formatter(open="1" json="::trace.return_value")
+                json-formatter(open="1" json="::trace.return_value" style="display: inline-block")
             .description
               .ui.vertical.buttons.basic
                 button.ui.labeled.icon.button(ng-show="::containsDetail(trace)" ng-click="showMoreDetail = !showMoreDetail")
-                  i.info.icon
+                  i.browser.icon
                   span Details
                 button.ui.labeled.icon.button(ng-if="::hasChild()" ng-click="toggleChild()" ng-class="{loading: togglingChild}")
                   i.icon.angle.down(ng-show="trace.childOpened")
@@ -71,20 +71,20 @@ html
 
               .details.right.floated(ng-if="showMoreDetail")
                 .ui.segments(style="border-color: blue")
+                  .ui.segment(ng-if="::trace.params_var")
+                    .ui.teal.right.ribbon.label Parameters
+                    json-formatter(open="1" json="::trace.params_var")
                   .ui.segment(ng-if="::trace.hasOwnProperty('return_value')")
                     .ui.grey.right.ribbon.label Return Value
                     json-formatter(json="::trace.return_value")
                   .ui.segment(ng-if="::containsOtherAttrs(trace)")
-                    .ui.orange.right.ribbon.label Trace Attrs
+                    .ui.orange.right.ribbon.label Trace Attributes
                     json-formatter(open="1" json="::plusTraceAttrs[trace.order_id]")
-                  .ui.segment(ng-if="::trace.params_var")
-                    .ui.teal.right.ribbon.label Params Var
-                    json-formatter(open="1" json="::trace.params_var")
                   .ui.segment(ng-if="::trace.local_var")
-                    .ui.teal.right.ribbon.label Local Var
+                    .ui.teal.right.ribbon.label Local Variables
                     json-formatter(open="1" json="::trace.local_var")
                   .ui.segment(ng-if="::trace.instance_var")
-                    .ui.blue.right.ribbon.label Instance Var
+                    .ui.blue.right.ribbon.label Instance Variables
                     json-formatter(open="1" json="::trace.instance_var")
 
     script src="https://cdn.rawgit.com/Urigo/angular-spinkit/master/build/angular-spinkit.min.js"

data/lib/source_route/generate_result.rb

@@ -11,16 +11,7 @@ module SourceRoute
     attr_reader :tp_result_chain, :tp_self_caches, :collected_data
 
     extend Forwardable
-
-    def_delegators :@tp_result_chain, :import_return_value_to_call_chain, :treeize_call_chain, :call_chain, :return_chain, :parent_length_list
-
-    Config = Struct.new(:format, :show_additional_attrs,
-                        :include_local_var, :include_instance_var,
-                        :filename, :import_return_to_call) do
-      def initialize(f=:test, s=[], ilr=false, iiv=false)
-        super(f, s, ilr, iiv)
-      end
-    end
+    def_delegators :@tp_result_chain, :import_return_value_to_call_chain, :treeize_call_chain
 
     # see event description in TracePoint API Doc
     DEFAULT_ATTRS = {
@@ -39,22 +30,17 @@ module SourceRoute
       thread_end: [:defined_class, :method_id]
     }
 
-    def initialize(wrapper)
-      @wrapper = wrapper
-
-      @config = @wrapper.condition.result_config
-
+    def initialize(proxy)
+      @proxy = proxy
       @tp_result_chain = TpResultChain.new
-
       @tp_self_caches = []
-      @wanted_attributes = {}
     end
 
     # it cached and only calculate once for one trace point block round
     def self.wanted_attributes(eve)
       event = eve.to_sym
       @wanted_attributes.fetch event do
-        attrs = DEFAULT_ATTRS[event] + Array(SourceRoute.wrapper.condition.result_config.show_additional_attrs)
+        attrs = DEFAULT_ATTRS[event] + Array(SourceRoute.proxy.config.show_additional_attrs)
         attrs.push(:event)
         @wanted_attributes[event] = attrs.uniq
         @wanted_attributes[event]
@@ -66,21 +52,18 @@ module SourceRoute
     end
 
     def output(tp_ins)
-      format = @config.format
-      format = format.to_sym if format.respond_to? :to_sym
+      format = @proxy.config.output_format
 
       assign_tp_self_caches(tp_ins)
       # we cant call method on tp_ins outside of track block,
       # so we have to run it immediately
-
       @collected_data = TpResult.new(tp_ins)
-
       case format
       when :console
         console_put(tp_ins)
       when :html
-        # we cant generate html right now becase the tp collection is still in process
-        # so we collect tp here
+        # we cant generate html right now becase the tp callback is still in process
+        # so we gather data into array
         @tp_result_chain.push(TpResult.new(tp_ins))
       when :silence, :none
       # do nothing at now
@@ -92,26 +75,10 @@ module SourceRoute
         format.call(tp_ins)
       else
         klass = "SourceRoute::Formats::#{format.to_s.capitalize}"
-        ::SourceRoute.const_get(klass).render(self, tp_ins)
+        ::SourceRoute.const_get(klass).render(self, tp_ins, @collected_data)
       end
     end
 
-    # def build(trace_point_instance)
-    #   TpResult.new(trace_point_instance)
-    #   # tp_result.collect_self
-
-    #   # @tp = trace_point_instance
-    #   # collect_tp_data
-    #   # collect_tp_self # NEED more check. Does TracePoint support self for all events?
-    #   # collect_local_var_data if @config[:include_local_var]
-    #   # collect_instance_var_data if @config[:include_instance_var]
-    #   # @collected_data
-    # end
-
-    # def collect_tp_result
-    #   tp_result = TpResult.new(tp)
-    # 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 assign_tp_self_caches(tp_ins)
@@ -121,7 +88,7 @@ module SourceRoute
     end
 
     def jsonify_events
-      Oj.dump(@wrapper.condition.events.map(&:to_s))
+      Oj.dump(@proxy.config.event.map(&:to_s))
     end
 
     def jsonify_tp_result_chain
@@ -138,44 +105,6 @@ module SourceRoute
 
     private
 
-    # def collect_tp_data
-    #   tp_data = wanted_attributes(@tp.event).inject({}) do |memo, key|
-    #     memo[key.to_sym] = @tp.send(key) if @tp.respond_to?(key)
-    #     memo
-    #   end
-    #   @collected_data = TpResult.new(tp_data)
-    #   puts @collected_data.inspect if @wrapper.condition.is_debug?
-    # end
-
-    # def collect_tp_self(tp)
-    #   unless tp_self_caches.find { |tp_cache| tp_cache.object_id.equal? tp.self.object_id }
-    #     tp_self_caches.push tp.self
-    #   end
-    #   @collected_data[:tp_self_refer] = tp_self_caches.map(&:__id__).index(tp.self.__id__)
-    # 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|
-    #     # I need rememeber why i need source_route_display
-    #     local_var_hash[v] = @tp.binding.local_variable_get(v).source_route_display
-    #   end
-    #   if local_var_hash != {}
-    #     @collected_data.merge!(local_var: local_var_hash)
-    #   end
-    # end
-
-    # 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).source_route_display
-    #   end
-    #   if instance_var_hash != {}
-    #     @collected_data.merge!(instance_var: instance_var_hash)
-    #   end
-    # end
-
     def console_put(tp)
       ret = []
       ret << "#{collected_data.defined_class.inspect}##{collected_data.method_id}"

data/lib/source_route/proxy.rb

@@ -0,0 +1,36 @@
+module SourceRoute
+
+  class Proxy # todo Rename it to Proxy
+    include Singleton
+
+    attr_accessor :config, :tp, :result_builder
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @tp.disable if defined? @tp
+      @config = Config.new
+      # only init once, so its @collected_data seems not useful
+      @result_builder = GenerateResult.new(self)
+      GenerateResult.clear_wanted_attributes
+      self
+    end
+
+    def trace
+      tp_filter = TpFilter.new(config)
+      track = TracePoint.new(*config.event) do |tp|
+        next if tp_filter.block_it?(tp)
+        @result_builder.output(tp)
+      end
+      track.enable
+      self.tp = track
+    end
+
+    def tp_result_chain
+      result_builder.tp_result_chain
+    end
+  end # END Proxy
+
+end

data/lib/source_route/tp_filter.rb

@@ -1,26 +1,27 @@
 module SourceRoute
 
   class TpFilter
+    attr_accessor :cond
     def initialize(condition)
-      @condition = condition
+      @cond = condition
     end
 
     # to improve performance, we didnt assign tp as instance variable
     def block_it?(tp)
       return true if negative_check(tp)
-      return false if positive_check(tp)
+      return false if positives_check(tp)
       true
     end
 
     def negative_check(tp)
-      @condition.negatives.any? do |method_key, value|
+      cond.negatives.any? do |method_key, value|
         tp.send(method_key).to_s =~ Regexp.new(value)
       end
     end
 
-    def positive_check(tp)
-      return true if @condition.positive == {}
-      @condition.positive.any? do |method_key, value|
+    def positives_check(tp)
+      return true if cond.positives == {}
+      cond.positives.any? do |method_key, value|
         tp.send(method_key).to_s =~ Regexp.new(value)
       end
     end

data/lib/source_route/tp_result.rb

@@ -10,19 +10,18 @@ module SourceRoute
     INNER_ATTRS = [:local_var, :instance_var, :params_var].freeze
     attr_accessor *INNER_ATTRS
 
-    # customized attrs
+    # customized attrs for build html output
     CUSTOM_ATTRS = [:order_id, :parent_ids, :direct_child_order_ids,
                    :has_return_value, :parent_length, :tp_self_refer].freeze
     attr_accessor *CUSTOM_ATTRS
 
-    # extend Forwardable
-    # def_delegators :@ret_data, :[], :merge, :merge!, :reject, :has_key?, :values, :[]=
-
     # The tricky part is
-    # cant call @core after trace block finished
+    # can't call method on @tp_ins outside trace block finished
+    # it could be a security limitation in ruby TracePoint object
+    # so collect_required_data can only run once and immediately
     def initialize(tp_ins)
-      @tp_ins = tp_ins # it only workable in TracePoint block
-      collect_required_data # so this method can only called once
+      @tp_ins = tp_ins
+      collect_required_data
     end
 
     def found_opposite
@@ -57,16 +56,13 @@ module SourceRoute
       call_tp.instance_var = instance_var unless instance_var.nil?
     end
 
-    # to_hash
-    # why we need wrapper?
-    # it's nonsense
     def to_hash
       stringify
       ret_hash = GenerateResult.wanted_attributes(event).inject({}) do |memo, k|
         memo[k.to_s] = send(k)
         memo
       end
-      if SourceRoute.wrapper.condition.events.include?(:return)
+      if SourceRoute.proxy.config.event.include?(:return)
         ret_hash['return_value'] = return_value.nil? ? return_value.inspect : return_value
       end
       (INNER_ATTRS + CUSTOM_ATTRS).each do |k|
@@ -75,16 +71,7 @@ module SourceRoute
       ret_hash
     end
 
-    # def stringify
-    #   # why dup it?
-    #   # dup_core = ret_data.dup
-    #   # to_s is safer than inspect
-    #   # ex: inspect on ActiveRecord_Relation may crash
-    #   ret_data[:defined_class] = ret_data[:defined_class].to_s if ret_data.has_key?(:defined_class)
-    #   ret_data[:return_value] = ret_data[:return_value].source_route_display if ret_data.has_key?(:return_value)
-    # end
-
-    # this is a mutable method
+    # todo: this is a mutable method
     # not a good solution.
     # we should use it on the return hash of method to_hash
     def stringify
@@ -109,30 +96,21 @@ module SourceRoute
       get_attrs
       get_self_refer
 
-      get_local_or_params_var if SourceRoute.wrapper.condition.result_config[:include_local_var]
-      get_instance_var if SourceRoute.wrapper.condition.result_config[:include_instance_var] and return_event?
+      get_local_or_params_var if SourceRoute.proxy.config.include_local_var
+      get_instance_var if SourceRoute.proxy.config.include_instance_var and return_event?
       self
     end
 
-    # Becare. we cal @tp_ins.event here
-    # but in stringify method we jsut call event
     def get_attrs
-      attrs_data = GenerateResult.wanted_attributes(
-        @tp_ins.event).each do |key|
+      GenerateResult.wanted_attributes(@tp_ins.event).each do |key|
         if @tp_ins.respond_to?(key)
           send("#{key}=", @tp_ins.send(key))
         end
       end
     end
 
-    # def get_additional_attributes
-    #   [:order_id, :parent_ids, :direct_child_order_ids, :parent_length].each do |k|
-    #     @ret_data[k] = send(k) unless send(k).nil?
-    #   end
-    # end
-
     def get_self_refer
-      self.tp_self_refer = SourceRoute.wrapper.result_builder.tp_self_caches
+      self.tp_self_refer = SourceRoute.proxy.result_builder.tp_self_caches
                            .map(&:__id__).index(@tp_ins.self.__id__)
     end
 

data/lib/source_route/tp_result_chain.rb

@@ -56,20 +56,6 @@ module SourceRoute
       call_chain.map { |tp| tp.parent_length }.uniq.sort
     end
 
-    # def deep_cloned
-    #   chain.map { |r| r.clone }
-    # end
-
-    # def stringify
-    #   deep_cloned.map do |tr|
-    #     # to_s is safer than inspect
-    #     # ex: inspect on ActiveRecord_Relation may crash
-    #     # should moved to tr object
-    #     tr.stringify
-    #     tr
-    #   end
-    # end
-
     private
     def init_order_id_and_parent_ids
       each_with_index do |tpr, index|

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/source_route/config_test.rb

@@ -0,0 +1,86 @@
+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?
+    end
+
+    def test_block_parser
+      block_parser = BlockConfigParser.new
+      config = block_parser.run do
+        event :call, 'c_call'
+        method_id_not :exception_method_name
+        defined_class 'ActiveRecord::Callback'
+        output_format 'silence'
+      end
+      assert_equal [:call, :c_call], config.event
+      assert_equal 'exception_method_name', config.negatives[:method_id]
+      assert_equal 'ActiveRecord::Callback', config.positives[:defined_class]
+      assert_equal :silence, config.output_format
+    end
+
+    def test_block_parser_with_full_feature
+      block_parser = BlockConfigParser.new
+      config = block_parser.run do
+        event :call, 'c_call'
+        path 'your_rails_application_root_dir_name'
+        filename 'trial.html'
+        full_feature 10
+      end
+      assert_equal 3, config.event.size
+      assert_includes config.event, :return
+      assert config.import_return_to_call
+      assert 'trial.html', config.filename
+      assert_includes config.positives[:path], 'root_dir'
+    end
+
+    def test_block_parser_with_params
+      block_parser = BlockConfigParser.new
+      config = block_parser.run 'wanted' do
+      end
+      assert_equal 'wanted', config.positives[:defined_class]
+      assert_equal 'wanted', config.positives[:method_id]
+    end
+
+    def test_block_parser_without_block
+      block_parser = BlockConfigParser.new
+      config = block_parser.run 'ActiveSupport'
+      assert_equal 'ActiveSupport', config.positives[:defined_class]
+    end
+
+    def test_full_feature_of_params_parser
+      params = {output_format: 'html', event: :c_call,
+                defined_class: 'ActiveRecord::Base',
+                method_id_not: ['initialize', 'nonsense']
+               }
+      config = ParamsConfigParser.run(params)
+      assert_equal :html, config.output_format
+      assert_equal [:c_call], config.event
+      assert_equal 'ActiveRecord::Base', config.positives[:defined_class]
+      assert_equal 'initialize|nonsense', config.negatives[:method_id]
+    end
+
+    def test_default_value_of_config
+      params = {defined_class: [:Rack, :ActiveRecord]}
+      config = ParamsConfigParser.run(params)
+      assert_equal :test, config.output_format
+      assert_equal [:call], config.event
+      assert_equal 'Rack|ActiveRecord', config.positives[:defined_class]
+    end
+
+    def test_config_formulize
+      config = Config.new
+      config.output_format = 'html'
+      config.event = ['return', :call]
+      config.formulize
+      assert_equal :html, config.output_format
+      assert_equal [:return, :call], config.event
+    end
+  end
+
+end

data/test/source_route/proxy_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class SourceRoute::ProxyTest < Minitest::Test
+
+  def setup
+    @proxy = SourceRoute::Proxy.instance
+    super
+  end
+
+end

data/test/source_route/tp_filter_test.rb

@@ -14,39 +14,45 @@ 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 = GenerateResult::Config.new('silence', [], false, false)
+      super
     end
 
     def test_filter_method_not_auth
-      cond = Wrapper::Condition.new([:call], {method_id: 'auth'}, {}, @result_config)
+      cond = Config.new
+      cond.negatives[:method_id] = 'auth'
       @tp_filter = TpFilter.new(cond)
       filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
       assert_equal [@user_tp], filtered
     end
 
     def test_filter_class_is_admin
-      cond = Wrapper::Condition.new([:call], {}, {defined_class: 'Admin'}, @result_config)
+      cond = Config.new
+      cond.positives[:defined_class] = 'Admin'
       @tp_filter = TpFilter.new(cond)
       filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
       assert_equal [], filtered
     end
 
     def test_filter_method_is_auth
-      cond = Wrapper::Condition.new([:call], {}, {method_id: 'auth'}, @result_config)
+      cond = Config.new
+      cond.positives[:method_id] = 'auth'
       @tp_filter = TpFilter.new(cond)
       filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
       assert_equal [@devise_tp, @warden_tp], filtered
     end
 
     def test_filter_method_is_new_class_is_devise
-      cond = Wrapper::Condition.new([:call], {}, {defined_class: 'Devise', method_id: 'new'}, @result_config)
+      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) }
       assert_equal [@devise_tp, @user_tp], filtered
     end
 
     def test_filter_class_is_devise_or_warden
-      cond = Wrapper::Condition.new([:call], {}, {defined_class: 'Warden|User'}, @result_config)
+      cond = Config.new
+      cond.positives[:defined_class] = 'Warden|User'
       @tp_filter = TpFilter.new(cond)
       filtered = @tps.reject { |tp| @tp_filter.block_it?(tp) }
       assert_equal [@warden_tp, @user_tp], filtered

data/test/source_route_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class SourceRouteTest < Minitest::Test
 
   def setup
-    @wrapper = SourceRoute::Wrapper.instance
+    @proxy = SourceRoute::Proxy.instance
     super
   end
 
@@ -13,9 +13,9 @@ class SourceRouteTest < Minitest::Test
   end
 
   def test_enable_return_true
-    @source_route = SourceRoute.enable /nnnonsense/
+    @source_route = SourceRoute.enable 'nnnonsense'
     assert @source_route
-    assert_equal @wrapper, SourceRoute.wrapper
+    assert_equal @proxy, SourceRoute.proxy
   end
 
   def test_catch_call_event
@@ -26,24 +26,24 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense
 
-    assert @wrapper.tp
+    assert @proxy.tp
   end
 
   def test_show_addtional_attrs
     SourceRoute.enable 'nonsense' do
-      result_config.show_additional_attrs = :path
+      show_additional_attrs :path
       full_feature
     end
     SampleApp.new.nonsense
 
-    assert_includes @wrapper.tp_result_chain.first.path, 'test'
+    assert_includes @proxy.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_result_chain.size > 0
+    assert @proxy.tp_result_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 @wrapper.tp_result_chain.map(&:method_id).flatten, 'nonsense'
+    refute_includes @proxy.tp_result_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 @wrapper.tp_result_chain.size > 0
-    assert_equal SampleApp, @wrapper.tp_result_chain.last.defined_class
+    assert @proxy.tp_result_chain.size > 0
+    assert_equal SampleApp, @proxy.tp_result_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 = @wrapper.tp_result_chain.last
+    ret_tp = @proxy.tp_result_chain.last
     assert_equal SampleApp, ret_tp.defined_class
   end
 
-  def test_wrapper_reset
+  def test_proxy_reset
     SourceRoute.enable 'nonsense'
     SampleApp.new.nonsense
-    assert_equal 1, @wrapper.tp_result_chain.size
+    assert_equal 1, @proxy.tp_result_chain.size
 
     SourceRoute.reset
     SampleApp.new.nonsense
 
-    assert_equal 0, @wrapper.tp_result_chain.size
+    assert_equal 0, @proxy.tp_result_chain.size
   end
 
   def test_source_route_with_block
@@ -96,7 +96,7 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense
 
-    assert_equal 0, @wrapper.tp_result_chain.size
+    assert_equal 0, @proxy.tp_result_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, @wrapper.tp_result_chain.size
+    assert_equal 2, @proxy.tp_result_chain.size
   end
 
   def test_trace_with_full_feature
     SourceRoute.trace method_id: 'nonsense', full_feature: 10 do
       SampleApp.new.nonsense
     end
-    first_result = @wrapper.tp_result_chain.first
+    first_result = @proxy.tp_result_chain.first
     assert_equal first_result.tp_self_refer, 0
   end
 
@@ -119,25 +119,25 @@ class SourceRouteTest < Minitest::Test
   #   SourceRoute.trace method_id: 'nonsense', full_feature: true do
   #     SampleApp.new.nonsense
   #   end
-  #   assert_equal 1, @wrapper.tp_self_caches.size
-  #   assert @wrapper.tp_self_caches.first.is_a? SampleApp
+  #   assert_equal 1, @proxy.tp_self_caches.size
+  #   assert @proxy.tp_self_caches.first.is_a? SampleApp
   # end
 
   def test_stringify_tp_result_chain_only
     SourceRoute.trace method_id: 'nonsense', full_feature: true do
       SampleApp.new.nonsense
     end
-    origin_tp_result_chain = @wrapper.tp_result_chain
-    assert @wrapper.tp_result_chain.first.stringify.defined_class.is_a? String
-    assert_equal origin_tp_result_chain, @wrapper.tp_result_chain
+    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
   end
 
   def test_trace_without_first_hash_option
     SourceRoute.trace output_format: :test do
       SampleApp.new.nonsense
     end
-    assert @wrapper.tp_result_chain.size > 0
-    refute @wrapper.tp.enabled?
+    assert @proxy.tp_result_chain.size > 0
+    refute @proxy.tp.enabled?
   end
 
   def test_trace_two_events
@@ -145,44 +145,44 @@ class SourceRouteTest < Minitest::Test
       event :call, :return
     end
     SampleApp.new.nonsense
-    assert_equal 2, @wrapper.tp_result_chain.size
+    assert_equal 2, @proxy.tp_result_chain.size
   end
 
   # but local var didnt displayed
   def test_show_local_variables
     SourceRoute.enable 'nonsense_with_params' do
-      result_config.include_local_var = true
+      include_local_var true
       output_format :console
     end
 
     SampleApp.new.nonsense_with_params(88)
 
-    ret_value = @wrapper.tp_result_chain.last
+    ret_value = @proxy.tp_result_chain.last
   end
 
   def test_track_local_var_when_event_is_return
     SourceRoute.enable 'nonsense_with_params' do
       event :return
-      result_config.include_local_var = true
+      include_local_var true
     end
 
     SampleApp.new.nonsense_with_params(88)
-    assert_equal 1, @wrapper.tp_result_chain.size
+    assert_equal 1, @proxy.tp_result_chain.size
 
-    ret_value_for_return_event = @wrapper.tp_result_chain.last
+    ret_value_for_return_event = @proxy.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
 
   def test_show_instance_vars_only
     SourceRoute.enable 'nonsense' do
-      result_config.include_instance_var = true
+      include_instance_var true
       event :call, :return
     end
     SampleApp.new('ins sure').nonsense_with_instance_var
 
-    assert_equal 4, @wrapper.tp_result_chain.size
-    ret_value = @wrapper.tp_result_chain.pop
+    assert_equal 4, @proxy.tp_result_chain.size
+    ret_value = @proxy.tp_result_chain.pop
 
     assert_equal 'ins sure', ret_value.instance_var[:@sample]
   end
@@ -192,8 +192,8 @@ class SourceRouteTest < Minitest::Test
       full_feature 10
     end
     SampleApp.new('cool stuff').init_cool_app
-    @wrapper.tp_result_chain.import_return_value_to_call_chain
-    assert @wrapper.tp_result_chain.call_chain[0].return_value, 'call results should contain return_value'
+    @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'
   end
 
   def test_order_call_sequence
@@ -202,8 +202,8 @@ class SourceRouteTest < Minitest::Test
     end
     SampleApp.new.nonsense_with_instance_var
 
-    @wrapper.tp_result_chain.treeize_call_chain
-    call_results = @wrapper.result_builder.call_chain
+    @proxy.tp_result_chain.treeize_call_chain
+    call_results = @proxy.result_builder.tp_result_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 +211,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], @wrapper.result_builder.parent_length_list
+    assert_equal [0, 1], @proxy.result_builder.tp_result_chain.parent_length_list
     assert_equal [nonsense_call_tp.order_id], nonsense_with_instance_var_call_tp.direct_child_order_ids
   end
 
@@ -221,7 +221,7 @@ class SourceRouteTest < Minitest::Test
       defined_class 'SampleApp'
       event :call, :return
       full_feature 10
-      result_config.filename = 'call_and_return_in_sample_app.html'
+      filename 'call_and_return_in_sample_app.html'
     end
 
     SampleApp.new.init_cool_app

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -197,23 +197,25 @@ files:
 - examples/show_task_trace_in_rails.rb
 - examples/study_callback.rb
 - lib/source_route.rb
+- lib/source_route/config.rb
 - lib/source_route/core_ext.rb
 - lib/source_route/formats/html.rb
 - lib/source_route/formats/html_semantic.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/version.rb
-- lib/source_route/wrapper.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/wrapper_test.rb
 - test/source_route_test.rb
 - test/test_helper.rb
 homepage: http://github.com/raykin/source-route
@@ -243,8 +245,9 @@ summary: Wrapper of TracePoint.
 test_files:
 - 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/wrapper_test.rb
 - test/source_route_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/source_route/wrapper.rb

@@ -1,112 +0,0 @@
-module SourceRoute
-
-  class Wrapper
-    include Singleton
-
-    TRACE_POINT_METHODS = [:defined_class, :method_id, :path, :lineno]
-
-    attr_accessor :condition, :tp, :result_builder
-
-    Condition = Struct.new(:events, :negatives, :positive, :result_config) do
-      def initialize(e=[:call], n={}, p={}, r=GenerateResult::Config.new)
-        @debug = false
-        super(e, n, p, r)
-      end
-    end
-
-    class Condition
-
-      TRACE_POINT_METHODS.each do |m|
-        define_method m do |*v|
-          positive[m] = v.flatten.map(&:to_s).join('|')
-        end
-
-        define_method "#{m}_not" do |*v|
-          negatives[m] = v.map(&:to_s).join('|')
-        end
-      end
-
-      def event(*v)
-        self.events = v.map(&:to_sym) unless v == []
-      end
-
-      def output_format(data = nil, &block)
-        result_config.format = block_given? ? block : data
-      end
-
-      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.show_additional_attrs = [:path, :lineno]
-        # JSON serialize trigger many problems when handle complicated object
-
-        # a Back Door to open more data. but be care it could trigger weird crash when Jsonify these vars
-        if value == 10
-          result_config.include_instance_var = true
-          result_config.include_local_var = true
-        end
-      end
-
-      def debug(value=false)
-        @debug = value
-      end
-
-      def is_debug?
-        @debug
-      end
-    end
-
-    def initialize
-      reset
-    end
-
-    def reset
-      @tp.disable if defined? @tp
-      @condition = Condition.new
-      @result_builder = GenerateResult.new(self)
-      GenerateResult.clear_wanted_attributes
-      self
-    end
-
-    def trace
-      # dont wanna init it in tp block, cause tp block could run thousands of times in one cycle trace
-
-      tp_filter = TpFilter.new(condition)
-
-      track = TracePoint.new *condition.events do |tp|
-
-        next if tp_filter.block_it?(tp)
-
-        # immediate output trace point result
-        # here is confused. todo
-        # should move tp_result_chain to result generator
-        @result_builder.output(tp)
-        # if condition.result_config.format == :console
-        #   ret_data = build_result.build(tp)
-        #   @tp_result_chain.push(ret_data)
-        #   build_result.output(tp)
-        # elsif condition.result_config.format.is_a? Proc
-        #   build_result.output(tp)
-        # else
-        #   # why not push the tp to result chain
-        #   ret_data = build_result.build(tp)
-        #   @tp_result_chain.push(ret_data)
-        # end
-      end
-      track.enable
-      self.tp = track
-    end
-
-    def tp_result_chain
-      result_builder.tp_result_chain
-    end
-  end # END Wrapper
-
-end

data/test/source_route/wrapper_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-class SourceRoute::WrapperTest < Minitest::Test
-
-  def setup
-    @wrapper = SourceRoute::Wrapper.instance
-  end
-
-end