source_route 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d7a56268a17ce2f0ea56258f3eaa28afac00dac
+  data.tar.gz: ffd4b43dd9a3b1dfa298695352cec8486c554d21
+SHA512:
+  metadata.gz: c3a6f2c1acf132f9ef1b8efa0463febbd55e62bc4ecf6f36fc89af0f63793bf662bce96dbfff758663b6753de2e12491284e298da0a25d28f998ca63198320c8
+  data.tar.gz: 334f6cd5aafc1091a17c67ced52bd9f865a3154894a6ec72806c52eba0caa4a23ad5539df249c0e636f217d012019eebd223d8c6b297a407f892542e2f807b16

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  enabled: true

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in source_route.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 raykin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# SourceRoute
+
+Wrapper of TracePoint
+
+## Dependency
+
+    ruby 2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'source_route', git: 'https://github.com/raykin/source-route'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install source_route
+
+## Usage
+
+    SourceRoute.enable /ActiveRecord/
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request
+
+
+### TODO
+
+Following code is a good sample that track file running sequence, how to change it into a good code design and merge into the gem
+
+```ruby
+
+    files = []
+    tp = TracePoint.new(:line) do |tp|
+      if tp.path =~ /bole_api/
+        unless files.include? tp.path
+          puts "#{tp.path}".inspect
+          files.push(tp.path)
+        end
+      end
+    end
+    tp.enable
+
+```
+
+It's better to add html output format, 'cause it can be kept.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task default: :test
+task :test do
+  ENV['ignore_html_generation'] = 'true'
+  $LOAD_PATH.unshift('lib', 'test')
+  Dir.glob('./test/**/*_test.rb') { |f| require f }
+end

data/lib/source_route.rb

@@ -0,0 +1,62 @@
+require 'ostruct'
+require 'logger'
+require 'singleton'
+
+require 'awesome_print'
+
+require "source_route/version"
+require "source_route/wrapper"
+require "source_route/tp_result"
+require "source_route/nature_value"
+
+module SourceRoute
+  extend self
+
+  def wrapper
+    @@wrapper ||= Wrapper.instance
+  end
+
+  def reset
+    wrapper.reset
+  end
+
+  def disable
+    wrapper.reset
+  end
+
+  def enable(match = nil, &block)
+    wrapper.reset
+
+    wrapper.method_id(match) if match # TODO in future future: should add as wrapper.method_id_or(match)
+
+    wrapper.instance_eval(&block) if block_given?
+
+    wrapper.trace
+  end
+
+  # Not implemented. used in irb or pry.
+  def trace(opt, &block)
+    wrapper.reset
+    opt.each do |k, v|
+      wrapper.send(k, v)
+    end
+    wrapper.trace
+    yield
+    wrapper.tp.disable
+    SourceRoute.build_html_output if opt[:output_format] == :html
+  end
+
+  def build_html_output
+    SourceRoute::Formats::Html.render(wrapper)
+  end
+
+  # Not implement yet
+  class Logger < Logger
+  end
+end
+
+module SourceRoute
+  module Formats
+    autoload :Html, 'source_route/formats/html'
+  end
+end

data/lib/source_route/formats/html.rb

@@ -0,0 +1,19 @@
+require 'slim'
+require 'json'
+
+module SourceRoute
+  module Formats
+    module Html
+
+      # results is instance of Wrapper
+      def self.render(results)
+        template_path = File.expand_path "../html_template.slim", __FILE__
+        html_output_str = Slim::Template.new(template_path).render(results)
+        File.open("#{Time.now.strftime('%M%S-%H-%m-%d')}-source-route.html", 'w') do |f|
+          f << html_output_str
+        end
+      end
+
+    end # END Html
+  end
+end

data/lib/source_route/formats/html_template.slim

@@ -0,0 +1,48 @@
+doctype html
+html
+  head
+    title Source Route Result
+    link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css"
+    script src="http://cdnjs.cloudflare.com/ajax/libs/lodash.js/2.4.1/lodash.min.js"
+    script src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"
+
+  body(ng-app="SourceRoute")
+    / workaround for following case:
+    / 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
+        tp_result
+      end
+
+    .data-collect
+      #trace-data data-trace="#{trace_data.to_json}"
+
+    .container(ng-controller="MainCtrl")
+      .top-header
+        h4
+          | Event:
+          =< @conditions.event
+      .trace-flow
+        .row
+          .left-info.col-sm-3
+            .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
+                span(ng-bind="trace.defined_class")
+                span #
+                span(ng-bind="trace.method_id")
+          .right-info.col-sm-3
+
+    script src="http://ajax.googleapis.com/ajax/libs/angularjs/1.2.25/angular.min.js"
+
+    javascript:
+      sourceRoute = angular.module('SourceRoute', [])
+      sourceRoute.controller('MainCtrl', function($scope) {
+        $scope.traces = angular.element("#trace-data").data('trace')
+        // 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')
+      })

data/lib/source_route/nature_value.rb

@@ -0,0 +1,29 @@
+class NilClass
+  def nature_value
+    nil
+  end
+end
+
+class String
+  def nature_value
+    self
+  end
+end
+
+class Class
+  def nature_value
+    self.name
+  end
+end
+
+class Module
+  def nature_value
+    self.name
+  end
+end
+
+class Symbol
+  def nature_value
+    to_s
+  end
+end

data/lib/source_route/tp_result.rb

@@ -0,0 +1,96 @@
+module SourceRoute
+
+  class TpResult
+
+    DEFAULT_ATTRS = {
+      call: [:defined_class, :event, :method_id],
+      return: [:defined_class, :event, :method_id, :return_value]
+    }
+
+    def initialize(wrapper)
+      @wrapper = wrapper
+
+      @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
+    end
+
+    def build(trace_point_instance)
+      @tp = trace_point_instance
+      collect_tp_data
+      collect_local_var_data
+      collect_instance_var_data
+      @collect_data
+    end
+
+    # always run build before it # not a good design
+    def output
+
+      format = @output_config[:output_format].to_sym
+
+      case format
+      when :none
+        # do nothing
+      when :console
+        console_put
+      when :html
+        # I cant solve the problem: to generate html at the end,
+        # I have to know when the application is end
+      when :test
+        # do nothing at now
+      when :Proc
+        # customize not defined yet
+        # format.call(tp)
+      else
+        klass = "SourceRoute::Formats::#{format.to_s.capitalize}"
+        ::SourceRoute.const_get(klass).render(self, trace_point_instance)
+      end
+    end
+
+    private
+
+    def collect_tp_data
+      @collect_data = @output_config[:selected_attrs].inject({}) do |memo, key|
+        memo[key.to_sym] = @tp.send(key) if @tp.respond_to?(key)
+        memo
+      end
+    end
+
+    def collect_local_var_data
+      if @wrapper.conditions.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
+
+        @collect_data.merge!(local_var: local_var_hash)
+      end
+    end
+
+    def collect_instance_var_data
+      if @wrapper.conditions.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
+        @collect_data.merge!(instance_var: instance_var_hash)
+      end
+    end
+
+    def console_put
+      ret = []
+      ret << "#{@collect_data[:defined_class].inspect}##{@collect_data[:method_id]}"
+      left_values = @collect_data.reject { |k, v| %w[defined_class method_id].include? k.to_s }
+      unless left_values == {}
+        ret << left_values
+      end
+      ap ret
+    end
+
+  end # END TpResult
+
+end

data/lib/source_route/version.rb

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

data/lib/source_route/wrapper.rb

@@ -0,0 +1,94 @@
+module SourceRoute
+
+  class Wrapper
+    include Singleton
+
+    attr_accessor :conditions, :tp, :tp_attrs_results
+    attr_accessor :output_include_local_variables, :output_include_instance_variables
+
+    def initialize
+      reset
+    end
+
+    # output_format can be console, html
+    def reset
+      @tp.disable if @tp
+      @conditions = OpenStruct.new(event: :call, negative: {}, positive: {},
+                                   result_config: { output_format: 'none',
+                                     selected_attrs: nil,
+                                     include_local_var: false,
+                                     include_instance_var: false
+                                   })
+      @tp_attrs_results = []
+      self
+    end
+
+    # TODO: make event can be array
+    def event(v)
+      @conditions.event = v.to_sym unless v.nil?
+    end
+
+    def set_result_config(value)
+      unless value.is_a? Hash
+        conditions.result_config = value
+      end
+    end
+
+    def output_format(data = nil, &block)
+      conditions.result_config[:output_format] = if data.nil?
+                                                   block
+                                                 else
+                                                   data
+                                                 end
+    end
+
+    def selected_attrs(data)
+      conditions.result_config[:selected_attrs] = [data].flatten
+    end
+
+    def output_include_local_variables
+      conditions.result_config[:include_local_var] = true
+    end
+
+    def output_include_instance_variables
+      conditions.result_config[:include_instance_var] = true
+    end
+
+    TRACE_POINT_METHODS = [:defined_class, :method_id, :path, :lineno]
+
+    TRACE_POINT_METHODS.each do |m|
+      define_method m do |v|
+        @conditions.positive[m] = v
+      end
+
+      define_method "#{m}_not" do |v|
+        @conditions.negative[m] = v
+      end
+    end
+
+    def trace
+      # 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|
+        negative_break = conditions.negative.any? do |method_key, value|
+          tp.send(method_key).nature_value =~ Regexp.new(value)
+        end
+        next if negative_break
+        positive_break = conditions.positive.any? do |method_key, value|
+          tp.send(method_key).nature_value !~ Regexp.new(value)
+        end
+        next if positive_break
+
+        ret_data = tp_result.build(tp)
+        tp_result.output
+        tp_attrs_results.push(ret_data)
+      end
+      track.enable
+      self.tp = track
+      track
+    end
+
+  end # Wrapper
+
+end

data/source_route.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'source_route/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "source_route"
+  spec.version       = SourceRoute::VERSION
+  spec.authors       = ["raykin"]
+  spec.email         = ["raykincoldxiao@gmail.com"]
+  spec.summary       = %q{Wrapper of TracePoint.}
+  spec.description   = %q{Wrapper of TracePoint.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'awesome_print'
+  spec.add_dependency 'colorize'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'slim'
+end

data/test/fake_app.rb

@@ -0,0 +1,4 @@
+class FakeApp
+  def fakeme
+  end
+end

data/test/sample_app.rb

@@ -0,0 +1,20 @@
+# Dont change it, it's used for stardard test
+# When add more complex test, update FakeApp
+class SampleApp
+
+  def initialize(cool=nil)
+    @cool = cool if cool
+  end
+
+  def nonsense
+  end
+
+  def nonsense_with_params(param1 = nil)
+    param2 = 5
+  end
+
+  # call it with SampleApp.new(:cool), then the instance var will be init before call it
+  def nonsense_with_instance_var
+    nonsense
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require File.join(File.dirname(__FILE__), 'sample_app')
+require File.join(File.dirname(__FILE__), 'fake_app')
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'source_route'
+require 'byebug'

data/test/wrapper_test.rb

@@ -0,0 +1,129 @@
+require 'test_helper'
+
+module SourceRoute
+  class WrapperTest < Minitest::Test
+
+    def setup
+      @wrapper = Wrapper.instance
+      super
+    end
+
+    def teardown
+      SourceRoute.reset
+      super
+    end
+
+    def test_enable_return_true
+      @source_route = SourceRoute.enable /nnnonsense/
+      assert @source_route
+      assert_equal @wrapper, SourceRoute.wrapper
+    end
+
+    def test_catch_call_event_only
+      SourceRoute.enable do
+        event :call
+        method_id /nonsense/
+        output_format :test
+      end
+      SampleApp.new.nonsense
+
+      assert @wrapper.tp
+    end
+
+    def test_catch_class_name_by_first_parameter
+      skip
+      # not supported yet
+      @source_route = SourceRoute.enable 'sampleapp'
+      SampleApp.new.nonsense
+
+      assert @wrapper.tp_attrs_results.size > 0
+    end
+
+    def test_match_class_name_by_block_define
+      @source_route = SourceRoute.enable do
+        defined_class 'SampleApp'
+      end
+
+      SampleApp.new.nonsense
+      assert @wrapper.tp_attrs_results.size > 0
+    end
+
+    def test_source_route_with_only_one_parameter
+      @source_route = SourceRoute.enable 'nonsense'
+      SampleApp.new.nonsense
+
+      ret_value = @wrapper.tp_attrs_results.last
+      assert_equal SampleApp, ret_value[:defined_class]
+    end
+
+    def test_wrapper_reset
+      SourceRoute.enable 'nonsense'
+      SampleApp.new.nonsense
+      assert_equal 1, @wrapper.tp_attrs_results.size
+
+      SourceRoute.reset
+      SampleApp.new.nonsense
+
+      assert_equal 0, @wrapper.tp_attrs_results.size
+    end
+
+    def test_source_route_with_block
+      SourceRoute.trace method_id: 'nonsense', output_format: :html 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
+        SampleApp.new.nonsense
+      end
+      assert @wrapper.tp_attrs_results.size > 0
+      refute @wrapper.tp.enabled?
+    end
+
+    def test_show_local_variables
+      @source_route = SourceRoute.enable 'nonsense_with_params' do
+        output_include_local_variables
+      end
+
+      SampleApp.new.nonsense_with_params(88)
+      assert_equal 1, @wrapper.tp_attrs_results.size
+
+      ret_value = @wrapper.tp_attrs_results.last
+
+      assert_equal 88, ret_value[:local_var][:param1]
+    end
+
+    def test_show_instance_vars
+      @source_route = SourceRoute.enable 'nonsense' do
+        output_include_instance_variables
+      end
+
+      SampleApp.new(:cool).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]
+    end
+
+    # Nothing has tested really
+    def test_html_format_output
+      @source_route = SourceRoute.enable 'nonsense' do
+        output_include_instance_variables
+      end
+
+      SampleApp.new(:cool).nonsense_with_instance_var
+
+      if ENV['ignore_html_generation'] == 'true'
+        # do nothing. it was set in Rakefile, so rake test will not generate html file
+      else
+        SourceRoute.build_html_output
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: source_route
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- raykin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: colorize
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: slim
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/source_route.rb
+- lib/source_route/formats/html.rb
+- lib/source_route/formats/html_template.slim
+- lib/source_route/nature_value.rb
+- lib/source_route/tp_result.rb
+- lib/source_route/version.rb
+- lib/source_route/wrapper.rb
+- source_route.gemspec
+- test/fake_app.rb
+- test/sample_app.rb
+- test/test_helper.rb
+- test/wrapper_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wrapper of TracePoint.
+test_files:
+- test/fake_app.rb
+- test/sample_app.rb
+- test/test_helper.rb
+- test/wrapper_test.rb
+has_rdoc: