source_route 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67d1a63084f0e5b6a0f2e7fb6f066d8b02510590
-  data.tar.gz: f7cc2c6ddc3632cde00f74a97b634834df307154
+  metadata.gz: c9a1ba833697d52c2138c558b5c94ec6dec3516d
+  data.tar.gz: 1635e5de83aaf367d91b9867c68b38fc269df07e
 SHA512:
-  metadata.gz: 001a12df5c3bbb0c3ae80d92f1661732ddbd44689f72cb214b84a3b55e01d266282273e094347ed795816fe3d66fc524247ffa4b3a6a3a5d4cce87f8da70b3b2
-  data.tar.gz: 8bd9da28ab7372e981ca605e63402f6bd7637db273be83c920db5b3548a9c6b0af01082b78cf6762a230fda79678be491586ec156168251b5b17195ce6c84a21
+  metadata.gz: cf1d68cce07fb6b22ba6e0a01b297ec383ae3bc82cd5ce98404207b649e0abaab1d5be2b491a59ad80f3c288cd1a2377fa0c816602c452239bc9142735d74be2
+  data.tar.gz: cefc0e26d83f5f9488f203ff12d28224cd02d7473b6af0bc07db6596f8a5d6f1773f8d119ff6abb9ee94ad68f2d51e9bff8d6ddbb32eeb7bbeea16d350d660bf

data/README.md

@@ -35,21 +35,4 @@ Or install it yourself as:
 
 ### 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.
+Add debug option to provider more verbose messages of what has happened

data/examples/show_init_files_when_rails_server_start.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+# copy this file content to bin/rails, then run ./bin/rails s, it should show init files in order
+
+require 'source_route'
+
+SourceRoute.enable do
+  file_paths = []
+  event :line
+  path 'your_rails_application_root_dir_name'
+  output_format do |tp|
+    unless file_paths.include? tp.path
+      puts tp.path
+      file_paths.push(tp.path)
+    end
+  end
+end
+
+# The above source route block defines similar trace point feature as following
+    # files = []
+    # tp = TracePoint.new(:line) do |tp|
+    #   if tp.path =~ /your_rails_application_root_dir_name/
+    #     unless files.include? tp.path
+    #       puts "#{tp.path}".inspect
+    #       files.push(tp.path)
+    #     end
+    #   end
+    # end
+    # tp.enable
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/lib/source_route/tp_result.rb

@@ -29,27 +29,26 @@ module SourceRoute
       @collect_data
     end
 
-    # must run build before it # not a good design
-    def output
+    def output(tp_ins)
 
-      format = @output_config[:output_format].to_sym
+      format = @output_config[:output_format]
+      format = format.to_sym if format.respond_to? :to_sym
 
       case format
       when :none
         # do nothing
-      when :console
+      when :console # need @collect_data
         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)
+      when Proc
+        format.call(tp_ins)
       else
         klass = "SourceRoute::Formats::#{format.to_s.capitalize}"
-        ::SourceRoute.const_get(klass).render(self, trace_point_instance)
+        ::SourceRoute.const_get(klass).render(self, tp_ins)
       end
     end
 

data/lib/source_route/version.rb

@@ -1,3 +1,3 @@
 module SourceRoute
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 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(events: :call, negative: {}, positive: {},
+      @conditions = OpenStruct.new(events: [:call], negative: {}, positive: {},
                                    result_config: { output_format: 'none',
                                      selected_attrs: nil,
                                      include_local_var: false,
@@ -27,6 +27,7 @@ module SourceRoute
       @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
@@ -34,15 +35,15 @@ module SourceRoute
     end
 
     def output_format(data = nil, &block)
-      conditions.result_config[:output_format] = if data.nil?
+      conditions.result_config[:output_format] = if block_given?
                                                    block
                                                  else
                                                    data
                                                  end
     end
 
-    def selected_attrs(data)
-      conditions.result_config[:selected_attrs] = [data].flatten
+    def selected_attrs(*attr)
+      conditions.result_config[:selected_attrs] = Array(attr)
     end
 
     def output_include_local_variables
@@ -79,9 +80,12 @@ module SourceRoute
         end
         next if positive_break
 
-        ret_data = tp_result.build(tp)
-        tp_attrs_results.push(ret_data)
-        tp_result.output
+        unless conditions[:result_config][:output_format].is_a? Proc
+          ret_data = tp_result.build(tp)
+          tp_attrs_results.push(ret_data)
+        end
+
+        tp_result.output(tp)
       end
       track.enable
       self.tp = track

data/lib/source_route.rb

@@ -21,7 +21,7 @@ module SourceRoute
   end
 
   def disable
-    wrapper.reset
+    wrapper.tp.disable
   end
 
   def enable(match = nil, &block)

data/test/test_helper.rb

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

data/test/wrapper_test.rb

@@ -39,7 +39,7 @@ module SourceRoute
       assert @wrapper.tp_attrs_results.size > 0
     end
 
-    def test_match_class_name_by_block_define
+    def test_match_class_name
       @source_route = SourceRoute.enable do
         defined_class 'SampleApp'
       end
@@ -67,12 +67,19 @@ module SourceRoute
       assert_equal 0, @wrapper.tp_attrs_results.size
     end
 
-    def test_source_route_with_block
-      SourceRoute.trace method_id: 'nonsense', output_format: :test do
+    def test_source_route_with_block_only
+      paths = []
+      SourceRoute.enable 'nonsense' do
         SampleApp.new.nonsense
+        output_format do |tp|
+          paths.push tp.path
+        end
       end
-      assert_equal 1, @wrapper.tp_attrs_results.size
-      refute @wrapper.tp.enabled?
+      SampleApp.new.nonsense
+
+      assert_equal 0, @wrapper.tp_attrs_results.size
+      assert_equal 1, paths.size
+      assert_includes paths.first, 'sample_app'
     end
 
     def test_trace_without_first_hash_option
@@ -94,6 +101,7 @@ module SourceRoute
     def test_show_local_variables
       SourceRoute.enable 'nonsense_with_params' do
         output_include_local_variables
+        output_format :console
       end
 
       SampleApp.new.nonsense_with_params(88)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: source_route
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -107,6 +107,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/show_init_files_when_rails_server_start.rb
 - lib/source_route.rb
 - lib/source_route/formats/html.rb
 - lib/source_route/formats/html_template.slim
@@ -148,3 +149,4 @@ test_files:
 - test/sample_app.rb
 - test/test_helper.rb
 - test/wrapper_test.rb
+has_rdoc: