source_route 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9a1ba833697d52c2138c558b5c94ec6dec3516d
-  data.tar.gz: 1635e5de83aaf367d91b9867c68b38fc269df07e
+  metadata.gz: 53b09f104ea2720d70ee2312d8233aeefbc5ea6c
+  data.tar.gz: 33f9ec189a6d23df94cd85bd27da378561ebda00
 SHA512:
-  metadata.gz: cf1d68cce07fb6b22ba6e0a01b297ec383ae3bc82cd5ce98404207b649e0abaab1d5be2b491a59ad80f3c288cd1a2377fa0c816602c452239bc9142735d74be2
-  data.tar.gz: cefc0e26d83f5f9488f203ff12d28224cd02d7473b6af0bc07db6596f8a5d6f1773f8d119ff6abb9ee94ad68f2d51e9bff8d6ddbb32eeb7bbeea16d350d660bf
+  metadata.gz: 64e04570f8a30d20631c86003bc3d311ac15f69a0e31d1b6e080220a553c1e8ad51699745fe4be6bf4f6c82f53266248ca78117e3f0f79da60effa506afdecaf
+  data.tar.gz: f1ba59748e527c875f5f4ac2b9a46cb3287f845f43ee62b38db9ad3cbf8f57ba89c08921c25e21ae53349fadaacd168ba0ec7d255431ac61f327483edfa1bbed

data/README.md

@@ -22,7 +22,49 @@ Or install it yourself as:
 
 ## Usage
 
-    SourceRoute.enable /ActiveRecord/
+#### In irb or pry terminal
+
+    SourceRoute.trace output_format: :console, event: :c_call do
+      'abc'.upcase
+    end
+
+#### In rails console
+
+    SourceRoute.trace defined_class: 'ActiveRecord', output_format: html do
+      User.new
+    end
+
+It will generate a html file, open it and you can get the trace of User.new
+
+The intereting part is when you run the above command again(in same console),
+you will get a different trace file.
+
+#### In your ruby application
+
+    SourceRoute.enable :wanted_method_name
+    .... # here is your code
+    ....
+    # may be code this in another file
+    SourceRoute.build_html_output
+
+Same as the previous example, you will get a html file showing the code trace.
+
+#### In a small application, you may try this
+
+    SourceRoute.enable do
+      defined_class :wanted_class_name
+      output_format :console
+    end
+    .... # here is your code
+
+It will output the trace when you run the application.
+
+see more usage in examples.
+
+## Test
+
+    $ bundle install
+    $ rake
 
 ## Contributing
 
@@ -36,3 +78,5 @@ Or install it yourself as:
 ### TODO
 
 Add debug option to provider more verbose messages of what has happened
+
+Support SourceRoute.enable :wanted_method_or_class, at now only SourceRoute.enable :wanted_method works

data/lib/source_route.rb

@@ -36,6 +36,7 @@ module SourceRoute
 
   # Not implemented. used in irb or pry.
   def trace(opt, &block)
+    opt[:output_format] ||= :silence
     wrapper.reset
     opt.each do |k, v|
       wrapper.send(k, v)

data/lib/source_route/formats/html_template.slim

@@ -24,7 +24,7 @@ html
       .top-header
         h4
           | Event:
-          =< @conditions.event
+          =< @conditions.events
       .trace-flow
         .row
           .left-info.col-sm-4
@@ -63,10 +63,11 @@ html
         $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')
+        var all_counter = 'ALL ' + $scope.traces.length
+        $scope.definedClasses.unshift(all_counter)
 
         $scope.selectKlass = function(klass) {
-          if (klass == 'ALL') {
+          if (klass == all_counter) {
             $scope.selectedKlass = undefined
           } else {
             $scope.selectedKlass = klass

data/lib/source_route/tp_result.rb

@@ -2,9 +2,21 @@ module SourceRoute
 
   class TpResult
 
+    # see event description in TracePoint API Doc
     DEFAULT_ATTRS = {
       call: [:defined_class, :method_id],
-      return: [:defined_class, :method_id, :return_value]
+      return: [:defined_class, :method_id, :return_value],
+      c_call: [:defined_class, :method_id],
+      line: [:path, :lineno],
+      # following are not tested yet
+      class: [:defined_class],
+      end: [:defined_class],
+      c_return: [:defined_class, :method_id, :return_value],
+      raise: [:raised_exception],
+      b_call: [:binding, :defined_class, :method_id],
+      b_return: [:binding, :defined_class, :method_id],
+      thread_begin: [:defined_class, :method_id],
+      thread_end: [:defined_class, :method_id]
     }
 
     def initialize(wrapper)
@@ -42,7 +54,7 @@ module SourceRoute
       when :html
         # I cant solve the problem: to generate html at the end,
         # I have to know when the application is end
-      when :test
+      when :test, :silence
         # do nothing at now
       when Proc
         format.call(tp_ins)

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/source_route/wrapper.rb

@@ -58,11 +58,11 @@ module SourceRoute
 
     TRACE_POINT_METHODS.each do |m|
       define_method m do |v|
-        @conditions.positive[m] = v
+        @conditions.positive[m] = v.to_s
       end
 
       define_method "#{m}_not" do |v|
-        @conditions.negative[m] = v
+        @conditions.negative[m] = v.to_s
       end
     end
 

data/source_route.gemspec

@@ -21,8 +21,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'awesome_print'
   spec.add_dependency 'colorize'
+  spec.add_dependency 'slim'
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'slim'
   spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
 end

data/test/wrapper_test.rb

@@ -41,7 +41,7 @@ module SourceRoute
 
     def test_match_class_name
       @source_route = SourceRoute.enable do
-        defined_class 'SampleApp'
+        defined_class :SampleApp
       end
 
       SampleApp.new.nonsense
@@ -82,6 +82,13 @@ module SourceRoute
       assert_includes paths.first, 'sample_app'
     end
 
+    def test_trace_with_c_call
+      SourceRoute.trace event: :c_call do
+        'abc'.upcase
+      end
+      assert_equal 2, @wrapper.tp_attrs_results.size
+    end
+
     def test_trace_without_first_hash_option
       SourceRoute.trace output_format: :test do
         SampleApp.new.nonsense

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - raykin
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !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: :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
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: slim
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  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
     requirements:
     - - ">="