trace_location 0.4.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac60bad7314ff13ccd86da5e6b88bff9dd50afedb445a3afabee76495aee49fb
-  data.tar.gz: 911bbeafa5bdb0d29d47e99fdb1cee89b55abc8b9d44f4157c5b9833e5dc093c
+  metadata.gz: b7f8eaee17fe797de0ea3da6917dabcaa764bf9037a5748905061775edb9d3df
+  data.tar.gz: c54da8e56e1ab1d10eaab5ca1c946914ed79b9b371a6705f7854a2f96165ed91
 SHA512:
-  metadata.gz: 211e0891220cb42c8def533b18ca2baeb55fd91c88c847d861482e5a80cae0feba5d5c292ec4b537fcf6173525c49f337bd46ce93f12922a9b6772a92a73227a
-  data.tar.gz: 7fa374686f1131f66e1046469fae708f643a0a6be6040f9773da60c2777e0a8a03c51e8962300d4ffe83d1fe1afd5dd4879fd2e4490db4b134e25185e65770d6
+  metadata.gz: afc12795bbe5f3fcd185ae87163c978484bc4be5bc793ed6df4da83dd8885ccac1df7c3cd2e059520d41577ec95bcda8e3b49ba426abe7daf1a03894ce833405
+  data.tar.gz: 6b680efb7dc27b7dc804df6ef55cdb07f5a78c4f4e0fb42f6733d125f6d04fa07ce2962c65140c502953038c94a6789c827e8c151c7f8713c60051d85b5b3672

data/Gemfile.lock

@@ -1,19 +1,29 @@
 PATH
   remote: .
   specs:
-    trace_location (0.4.0)
+    trace_location (0.9.0)
+      binding_of_caller
+      pry
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.2)
+    debug_inspector (0.0.3)
     diff-lcs (1.3)
     jaro_winkler (1.5.2)
+    method_source (0.9.2)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -27,23 +37,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.68.1)
+    rubocop (0.71.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.5.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  bundler
+  rake
+  rspec
   rubocop
   trace_location!
 

data/README.md

@@ -22,14 +22,307 @@ Or install it yourself as:
 
 You just surround the code which you want to track the process.
 
-### Example 01. Track the lifecycle of Rails application
+### Example 01. Track the validation process of Active Record
+
+```
+% bin/rails c
+
+irb(main):001:0> book = Book.new(title: "My Book Title")
+irb(main):002:0> TraceLocation.trace(ignore: /active_support/) { book.validate }
+Created at /path/to/sampleapp/log/trace_location-2019060401061559579741.md
+=> true
+```
+
+Then you can get a markdown file like this:
+
+--
+
+Generated by [trace_location](https://github.com/yhirano55/trace_location) at 2019-06-04 01:35:41 +0900
+
+<details open>
+<summary>activerecord-5.2.3/lib/active_record/validations.rb:65</summary>
+
+##### ActiveRecord::Validations#valid?
+```ruby
+def valid?(context = nil)
+  context ||= default_validation_context
+  output = super(context)
+  errors.empty? && output
+end
+# called from (irb):2
+```
+
+</details>
+<details open>
+<summary>activerecord-5.2.3/lib/active_record/validations.rb:75</summary>
+
+##### ActiveRecord::Validations#default_validation_context
+```ruby
+def default_validation_context
+  new_record? ? :create : :update
+end
+# called from activerecord-5.2.3/lib/active_record/validations.rb:66
+```
+
+</details>
+<details open>
+<summary>activerecord-5.2.3/lib/active_record/persistence.rb:231</summary>
+
+##### ActiveRecord::Persistence#new_record?
+```ruby
+def new_record?
+  sync_with_transaction_state
+  @new_record
+end
+# called from activerecord-5.2.3/lib/active_record/validations.rb:76
+```
+
+</details>
+<details open>
+<summary>activerecord-5.2.3/lib/active_record/transactions.rb:490</summary>
+
+##### ActiveRecord::Transactions#sync_with_transaction_state
+```ruby
+def sync_with_transaction_state
+  update_attributes_from_transaction_state(@transaction_state)
+end
+# called from activerecord-5.2.3/lib/active_record/persistence.rb:232
+```
+
+</details>
+<details open>
+<summary>activerecord-5.2.3/lib/active_record/transactions.rb:494</summary>
+
+##### ActiveRecord::Transactions#update_attributes_from_transaction_state
+```ruby
+def update_attributes_from_transaction_state(transaction_state)
+  if transaction_state && transaction_state.finalized?
+    restore_transaction_record_state(transaction_state.fully_rolledback?) if transaction_state.rolledback?
+    force_clear_transaction_record_state if transaction_state.fully_committed?
+    clear_transaction_record_state if transaction_state.fully_completed?
+  end
+end
+# called from activerecord-5.2.3/lib/active_record/transactions.rb:491
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/validations.rb:336</summary>
+
+##### ActiveModel::Validations#valid?
+```ruby
+def valid?(context = nil)
+  current_context, self.validation_context = validation_context, context
+  errors.clear
+  run_validations!
+ensure
+  self.validation_context = current_context
+end
+# called from activerecord-5.2.3/lib/active_record/validations.rb:67
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/validations.rb:303</summary>
+
+##### ActiveModel::Validations#errors
+```ruby
+def errors
+  @errors ||= Errors.new(self)
+end
+# called from activemodel-5.2.3/lib/active_model/validations.rb:338
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:74</summary>
+
+##### ActiveModel::Errors#initialize
+```ruby
+def initialize(base)
+  @base     = base
+  @messages = apply_default_array({})
+  @details = apply_default_array({})
+end
+# called from activemodel-5.2.3/lib/active_model/validations.rb:304
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:470</summary>
+
+##### ActiveModel::Errors#apply_default_array
+```ruby
+def apply_default_array(hash)
+  hash.default_proc = proc { |h, key| h[key] = [] }
+  hash
+end
+# called from activemodel-5.2.3/lib/active_model/errors.rb:76
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:470</summary>
+
+##### ActiveModel::Errors#apply_default_array
+```ruby
+def apply_default_array(hash)
+  hash.default_proc = proc { |h, key| h[key] = [] }
+  hash
+end
+# called from activemodel-5.2.3/lib/active_model/errors.rb:77
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:115</summary>
+
+##### ActiveModel::Errors#clear
+```ruby
+def clear
+  messages.clear
+  details.clear
+end
+# called from activemodel-5.2.3/lib/active_model/validations.rb:338
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/validations/callbacks.rb:117</summary>
+
+##### ActiveModel::Validations::Callbacks#run_validations!
+```ruby
+def run_validations!
+  _run_validation_callbacks { super }
+end
+# called from activemodel-5.2.3/lib/active_model/validations.rb:339
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/validations.rb:408</summary>
+
+##### ActiveModel::Validations#run_validations!
+```ruby
+def run_validations!
+  _run_validate_callbacks
+  errors.empty?
+end
+# called from activemodel-5.2.3/lib/active_model/validations/callbacks.rb:118
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/validations.rb:303</summary>
+
+##### ActiveModel::Validations#errors
+```ruby
+def errors
+  @errors ||= Errors.new(self)
+end
+# called from activemodel-5.2.3/lib/active_model/validations.rb:410
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:209</summary>
+
+##### ActiveModel::Errors#empty?
+```ruby
+def empty?
+  size.zero?
+end
+# called from activemodel-5.2.3/lib/active_model/validations.rb:410
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:179</summary>
+
+##### ActiveModel::Errors#size
+```ruby
+def size
+  values.flatten.size
+end
+# called from activemodel-5.2.3/lib/active_model/errors.rb:210
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:188</summary>
+
+##### ActiveModel::Errors#values
+```ruby
+def values
+  messages.select do |key, value|
+    !value.empty?
+  end.values
+end
+# called from activemodel-5.2.3/lib/active_model/errors.rb:180
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/validations.rb:303</summary>
+
+##### ActiveModel::Validations#errors
+```ruby
+def errors
+  @errors ||= Errors.new(self)
+end
+# called from activerecord-5.2.3/lib/active_record/validations.rb:68
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:209</summary>
+
+##### ActiveModel::Errors#empty?
+```ruby
+def empty?
+  size.zero?
+end
+# called from activerecord-5.2.3/lib/active_record/validations.rb:68
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:179</summary>
+
+##### ActiveModel::Errors#size
+```ruby
+def size
+  values.flatten.size
+end
+# called from activemodel-5.2.3/lib/active_model/errors.rb:210
+```
+
+</details>
+<details open>
+<summary>activemodel-5.2.3/lib/active_model/errors.rb:188</summary>
+
+##### ActiveModel::Errors#values
+```ruby
+def values
+  messages.select do |key, value|
+    !value.empty?
+  end.values
+end
+# called from activemodel-5.2.3/lib/active_model/errors.rb:180
+```
+
+</details>
+
+
+
+### Example 02. Track the lifecycle of Rails application
 
 
 ```
 % bin/rails c
 
 irb(main):001:0> env = Rack::MockRequest.env_for('http://localhost:3000/books')
-irb(main):002:0> TraceLocation.trace { status, headers, body = Rails.application.call(env) }
+irb(main):002:0> TraceLocation.trace(format: :log) { status, headers, body = Rails.application.call(env) }
 Created at /path/to/sampleapp/log/trace_location-2019050602051557077971.log
 => true
 ```
@@ -77,91 +370,6 @@ C railties-5.2.3/lib/rails/engine.rb:522 [Rails::Engine#call]
 ..................
 ```
 
-### Example 02. Track the validation process of Active Record
-
-```
-% bin/rails c
-
-irb(main):001:0> book = Book.new(title: "My Book Title")
-irb(main):002:0> TraceLocation.trace { book.validate }
-Created at /path/to/sampleapp/log/trace_location-2019050104049576006131.log
-=> true
-```
-
-Then you can get a log like this:
-
-```
-Logged by TraceLocation gem at 2019-05-06 02:44:29 +0900
-https://github.com/yhirano55/trace_location
-
-[Tracing events] C: Call, R: Return
-
-C activerecord-5.2.3/lib/active_record/validations.rb:65 [ActiveRecord::Validations#valid?]
-  C activerecord-5.2.3/lib/active_record/validations.rb:75 [ActiveRecord::Validations#default_validation_context]
-    C activerecord-5.2.3/lib/active_record/persistence.rb:231 [ActiveRecord::Persistence#new_record?]
-      C activerecord-5.2.3/lib/active_record/transactions.rb:490 [ActiveRecord::Transactions#sync_with_transaction_state]
-        C activerecord-5.2.3/lib/active_record/transactions.rb:494 [ActiveRecord::Transactions#update_attributes_from_transaction_state]
-        R activerecord-5.2.3/lib/active_record/transactions.rb:500 [ActiveRecord::Transactions#update_attributes_from_transaction_state]
-      R activerecord-5.2.3/lib/active_record/transactions.rb:492 [ActiveRecord::Transactions#sync_with_transaction_state]
-    R activerecord-5.2.3/lib/active_record/persistence.rb:234 [ActiveRecord::Persistence#new_record?]
-  R activerecord-5.2.3/lib/active_record/validations.rb:77 [ActiveRecord::Validations#default_validation_context]
-  C activemodel-5.2.3/lib/active_model/validations.rb:336 [ActiveModel::Validations#valid?]
-    C activemodel-5.2.3/lib/active_model/validations.rb:303 [ActiveModel::Validations#errors]
-      C activemodel-5.2.3/lib/active_model/errors.rb:74 [ActiveModel::Errors#initialize]
-        C activemodel-5.2.3/lib/active_model/errors.rb:470 [ActiveModel::Errors#apply_default_array]
-        R activemodel-5.2.3/lib/active_model/errors.rb:473 [ActiveModel::Errors#apply_default_array]
-        C activemodel-5.2.3/lib/active_model/errors.rb:470 [ActiveModel::Errors#apply_default_array]
-        R activemodel-5.2.3/lib/active_model/errors.rb:473 [ActiveModel::Errors#apply_default_array]
-      R activemodel-5.2.3/lib/active_model/errors.rb:78 [ActiveModel::Errors#initialize]
-    R activemodel-5.2.3/lib/active_model/validations.rb:305 [ActiveModel::Validations#errors]
-    C activemodel-5.2.3/lib/active_model/errors.rb:115 [ActiveModel::Errors#clear]
-    R activemodel-5.2.3/lib/active_model/errors.rb:118 [ActiveModel::Errors#clear]
-    C activemodel-5.2.3/lib/active_model/validations/callbacks.rb:117 [ActiveModel::Validations::Callbacks#run_validations!]
-      C activesupport-5.2.3/lib/active_support/callbacks.rb:815 [ActiveRecord::Base#_run_validation_callbacks]
-        C activesupport-5.2.3/lib/active_support/callbacks.rb:94 [ActiveSupport::Callbacks#run_callbacks]
-          C activesupport-5.2.3/lib/active_support/core_ext/class/attribute.rb:124 [ActiveRecord::Base#__callbacks]
-            C activesupport-5.2.3/lib/active_support/core_ext/class/attribute.rb:106 [ActiveRecord::Base.__callbacks]
-            R activesupport-5.2.3/lib/active_support/core_ext/class/attribute.rb:128 [ActiveRecord::Base.__callbacks]
-          R activesupport-5.2.3/lib/active_support/callbacks.rb:95 [ActiveRecord::Base#__callbacks]
-          C activesupport-5.2.3/lib/active_support/callbacks.rb:539 [ActiveSupport::Callbacks::CallbackChain#empty?]
-          R activesupport-5.2.3/lib/active_support/callbacks.rb:539 [ActiveSupport::Callbacks::CallbackChain#empty?]
-          C activemodel-5.2.3/lib/active_model/validations.rb:408 [ActiveModel::Validations#run_validations!]
-            C activesupport-5.2.3/lib/active_support/callbacks.rb:815 [ActiveRecord::Base#_run_validate_callbacks]
-              C activesupport-5.2.3/lib/active_support/callbacks.rb:94 [ActiveSupport::Callbacks#run_callbacks]
-                C activesupport-5.2.3/lib/active_support/core_ext/class/attribute.rb:124 [ActiveRecord::Base#__callbacks]
-                  C activesupport-5.2.3/lib/active_support/core_ext/class/attribute.rb:106 [ActiveRecord::Base.__callbacks]
-                  R activesupport-5.2.3/lib/active_support/core_ext/class/attribute.rb:128 [ActiveRecord::Base.__callbacks]
-                R activesupport-5.2.3/lib/active_support/callbacks.rb:95 [ActiveRecord::Base#__callbacks]
-                C activesupport-5.2.3/lib/active_support/callbacks.rb:539 [ActiveSupport::Callbacks::CallbackChain#empty?]
-                R activesupport-5.2.3/lib/active_support/callbacks.rb:539 [ActiveSupport::Callbacks::CallbackChain#empty?]
-              R activesupport-5.2.3/lib/active_support/callbacks.rb:139 [ActiveSupport::Callbacks#run_callbacks]
-            R activesupport-5.2.3/lib/active_support/callbacks.rb:817 [ActiveRecord::Base#_run_validate_callbacks]
-            C activemodel-5.2.3/lib/active_model/validations.rb:303 [ActiveModel::Validations#errors]
-            R activemodel-5.2.3/lib/active_model/validations.rb:305 [ActiveModel::Validations#errors]
-            C activemodel-5.2.3/lib/active_model/errors.rb:209 [ActiveModel::Errors#empty?]
-              C activemodel-5.2.3/lib/active_model/errors.rb:179 [ActiveModel::Errors#size]
-                C activemodel-5.2.3/lib/active_model/errors.rb:188 [ActiveModel::Errors#values]
-                R activemodel-5.2.3/lib/active_model/errors.rb:192 [ActiveModel::Errors#values]
-              R activemodel-5.2.3/lib/active_model/errors.rb:181 [ActiveModel::Errors#size]
-            R activemodel-5.2.3/lib/active_model/errors.rb:211 [ActiveModel::Errors#empty?]
-          R activemodel-5.2.3/lib/active_model/validations.rb:411 [ActiveModel::Validations#run_validations!]
-        R activesupport-5.2.3/lib/active_support/callbacks.rb:139 [ActiveSupport::Callbacks#run_callbacks]
-      R activesupport-5.2.3/lib/active_support/callbacks.rb:817 [ActiveRecord::Base#_run_validation_callbacks]
-    R activemodel-5.2.3/lib/active_model/validations/callbacks.rb:119 [ActiveModel::Validations::Callbacks#run_validations!]
-  R activemodel-5.2.3/lib/active_model/validations.rb:342 [ActiveModel::Validations#valid?]
-  C activemodel-5.2.3/lib/active_model/validations.rb:303 [ActiveModel::Validations#errors]
-  R activemodel-5.2.3/lib/active_model/validations.rb:305 [ActiveModel::Validations#errors]
-  C activemodel-5.2.3/lib/active_model/errors.rb:209 [ActiveModel::Errors#empty?]
-    C activemodel-5.2.3/lib/active_model/errors.rb:179 [ActiveModel::Errors#size]
-      C activemodel-5.2.3/lib/active_model/errors.rb:188 [ActiveModel::Errors#values]
-      R activemodel-5.2.3/lib/active_model/errors.rb:192 [ActiveModel::Errors#values]
-    R activemodel-5.2.3/lib/active_model/errors.rb:181 [ActiveModel::Errors#size]
-  R activemodel-5.2.3/lib/active_model/errors.rb:211 [ActiveModel::Errors#empty?]
-R activerecord-5.2.3/lib/active_record/validations.rb:69 [ActiveRecord::Validations#valid?]
-
-Result: true
-```
-
 ## License
 
 [MIT License](https://opensource.org/licenses/MIT)

data/lib/trace_location/collector.rb

@@ -1,22 +1,37 @@
 # frozen_string_literal: true
 
+require 'binding_of_caller'
+
 module TraceLocation
   module Collector # :nodoc:
     require_relative 'event'
     Result = Struct.new(:events, :return_value)
 
-    def self.collect(&block)
+    def self.collect(match:, ignore:, &block)
       events = []
       hierarchy = 0
+      id = 0
+      cache = {}
+
       tracer = TracePoint.new(:call, :return) do |trace_point|
-        next unless trace_point.path.include?(::TraceLocation.config.gems_dir)
+        next if match && !trace_point.path.to_s.match?(/#{match}/)
+        next if ignore && trace_point.path.to_s.match?(/#{ignore}/)
+
+        id += 1
+        caller_path, caller_lineno = trace_point.binding.of_caller(2).source_location
+        location_cache_key = "#{caller_path}:#{caller_lineno}"
 
         case trace_point.event
         when :call
+          cache[location_cache_key] = hierarchy
+
           events << Event.new(
+            id: id,
             event: trace_point.event,
             path: trace_point.path,
             lineno: trace_point.lineno,
+            caller_path: caller_path,
+            caller_lineno: caller_lineno,
             method_id: trace_point.method_id,
             defined_class: trace_point.defined_class,
             hierarchy: hierarchy
@@ -24,12 +39,15 @@ module TraceLocation
 
           hierarchy += 1
         when :return
-          hierarchy -= 1
+          hierarchy = cache[location_cache_key] || hierarchy
 
           events << Event.new(
+            id: id,
             event: trace_point.event,
             path: trace_point.path,
             lineno: trace_point.lineno,
+            caller_path: caller_path,
+            caller_lineno: caller_lineno,
             method_id: trace_point.method_id,
             defined_class: trace_point.defined_class,
             hierarchy: hierarchy

data/lib/trace_location/config.rb

@@ -7,7 +7,7 @@ module TraceLocation
     def initialize
       @gems_dir = File.join(Gem.path[0], 'gems')
       @dest_dir = Dir.pwd
-      @default_format = :log
+      @default_format = :markdown
     end
   end
 end

data/lib/trace_location/event.rb

@@ -3,12 +3,15 @@
 module TraceLocation
   class Event # :nodoc:
     CLASS_FORMAT = /\A#<(?:Class|refinement)\:([A-Za-z0-9\:]+).*>\z/.freeze
-    attr_reader :event, :path, :lineno, :method_id, :defined_class, :hierarchy
+    attr_reader :id, :event, :path, :lineno, :caller_path, :caller_lineno, :method_id, :defined_class, :hierarchy
 
-    def initialize(event:, path:, lineno:, method_id:, defined_class:, hierarchy:)
+    def initialize(id:, event:, path:, lineno:, caller_path:, caller_lineno:, method_id:, defined_class:, hierarchy:)
+      @id = id
       @event = event
       @path = path
       @lineno = lineno
+      @caller_path = caller_path
+      @caller_lineno = caller_lineno
       @method_id = method_id
       @defined_class = defined_class
       @hierarchy = hierarchy.to_i

data/lib/trace_location/generator/csv.rb

@@ -5,9 +5,10 @@ require 'csv'
 module TraceLocation
   module Generator
     class Csv < Base # :nodoc:
+      ATTRIBUTES = %w[id event path lineno caller_path caller_lineno method_str hierarchy].freeze
+
       def initialize(events, return_value, options)
-        @events = events
-        @return_value = return_value
+        super
         @dest_dir = options.fetch(:dest_dir) { ::TraceLocation.config.dest_dir }
         @file_path = File.join(@dest_dir, "trace_location-#{Time.now.strftime('%Y%m%d%H%m%s')}.csv")
       end
@@ -28,9 +29,10 @@ module TraceLocation
 
       def create_file
         CSV.open(file_path, 'wb+') do |csv|
-          csv << %w[event method path lineno]
-          events.each do |e|
-            csv << [e.event, e.method_str, e.path, e.lineno]
+          csv << ATTRIBUTES
+
+          events.each do |event|
+            csv << ATTRIBUTES.map { |attr| event.public_send(attr) }
           end
         end
       end

data/lib/trace_location/generator/log.rb

@@ -10,8 +10,7 @@ module TraceLocation
       INDENT_STRING = ' '
 
       def initialize(events, return_value, options)
-        @events = events
-        @return_value = return_value
+        super
         @gems_dir = ::TraceLocation.config.gems_dir
         @dest_dir = options.fetch(:dest_dir) { ::TraceLocation.config.dest_dir }
         @current = Time.now
@@ -34,7 +33,7 @@ module TraceLocation
       end
 
       def create_file
-        File.open(file_path, 'w+') do |io|
+        File.open(file_path, 'wb+') do |io|
           io.puts "Logged by TraceLocation gem at #{current}"
           io.puts 'https://github.com/yhirano55/trace_location'
           io.puts

data/lib/trace_location/generator/markdown.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+module TraceLocation
+  module Generator
+    class Markdown < Base # :nodoc:
+      def initialize(events, return_value, options)
+        super
+        @gems_dir = ::TraceLocation.config.gems_dir
+        @dest_dir = options.fetch(:dest_dir) { ::TraceLocation.config.dest_dir }
+        @current = Time.now
+        @filename = "trace_location-#{@current.strftime('%Y%m%d%H%m%s')}.md"
+        @file_path = File.join(@dest_dir, @filename)
+      end
+
+      def generate
+        setup_dir
+        create_file
+        $stdout.puts "Created at #{file_path}"
+      end
+
+      private
+
+      attr_reader :events, :return_value, :gems_dir, :dest_dir, :current, :filename, :file_path
+
+      def setup_dir
+        FileUtils.mkdir_p(dest_dir)
+      end
+
+      def create_file
+        File.open(file_path, 'wb+') do |io|
+          io.write <<~MARKDOWN
+            Generated by [trace_location](https://github.com/yhirano55/trace_location) at #{current}
+
+          MARKDOWN
+
+          events.select(&:call?).each do |e|
+            pm = begin
+                   Pry::Method.from_str(e.method_str)
+                 rescue StandardError
+                   nil
+                 end
+            next if pm.nil?
+
+            path = e.path.to_s.gsub(%r{#{gems_dir}/}, '')
+            caller_path = e.caller_path.to_s.gsub(%r{#{gems_dir}/}, '')
+            io.write <<~MARKDOWN
+              <details open>
+              <summary>#{path}:#{e.lineno}</summary>
+
+              ##### #{pm.name_with_owner}
+              ```#{pm.source_type}
+              #{pm.source.chomp}
+              # called from #{caller_path}:#{e.caller_lineno}
+              ```
+
+              </details>
+            MARKDOWN
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_location/generator.rb

@@ -5,5 +5,6 @@ module TraceLocation
     require_relative 'generator/base'
     require_relative 'generator/csv'
     require_relative 'generator/log'
+    require_relative 'generator/markdown'
   end
 end

data/lib/trace_location/report.rb

@@ -8,7 +8,8 @@ module TraceLocation
 
     GENERATORS = {
       csv: ::TraceLocation::Generator::Csv,
-      log: ::TraceLocation::Generator::Log
+      log: ::TraceLocation::Generator::Log,
+      markdown: ::TraceLocation::Generator::Markdown
     }.freeze
 
     def self.build(events, return_value, options)

data/lib/trace_location/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TraceLocation
-  VERSION = '0.4.0'
+  VERSION = '0.9.0'
 end

data/lib/trace_location.rb

@@ -14,7 +14,10 @@ end
 
 module TraceLocation # :nodoc:
   def self.trace(options = {}, &block)
-    result = Collector.collect(&block)
+    match = options.delete(:match)
+    ignore = options.delete(:ignore)
+
+    result = Collector.collect(match: match, ignore: ignore, &block)
     Report.build(result.events, result.return_value, options).generate
     true
   rescue StandardError => e

data/trace_location.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.required_ruby_version = '>= 2.5.0'
 
-  s.add_development_dependency 'bundler', '~> 2.0'
-  s.add_development_dependency 'rake', '~> 10.0'
-  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_dependency 'binding_of_caller'
+  s.add_dependency 'pry'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
 end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: trace_location
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Yoshiyuki Hirano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-06-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  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: pry
+  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: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: TraceLocation helps you get tracing the source location of codes, and
   helps you can get reading the huge open souce libraries in Ruby
 email:
@@ -80,6 +108,7 @@ files:
 - lib/trace_location/generator/base.rb
 - lib/trace_location/generator/csv.rb
 - lib/trace_location/generator/log.rb
+- lib/trace_location/generator/markdown.rb
 - lib/trace_location/railtie.rb
 - lib/trace_location/report.rb
 - lib/trace_location/version.rb