trace_location 0.9.3 → 0.10.0

data/lib/trace_location.rb

@@ -21,7 +21,8 @@ module TraceLocation # :nodoc:
     Report.build(result.events, result.return_value, options).generate
     true
   rescue StandardError => e
-    $stdout.puts "Failure: #{e.message}"
+    $stderr.puts "Failure: TraceLocation got an unexpected error."
+    $stderr.puts e.full_message
     false
   end
 

data/lib/trace_location/collector.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'binding_of_caller'
 require 'method_source'
 
 module TraceLocation
@@ -14,16 +13,22 @@ module TraceLocation
         hierarchy = 0
         id = 0
         cache = {}
+        method_source_cache = {}
 
         tracer = TracePoint.new(:call, :return) do |trace_point|
-          next if match && !trace_point.path.to_s.match?(/#{match}/)
-          next if ignore && trace_point.path.to_s.match?(/#{ignore}/)
+          next if match && !trace_point.path.to_s.match?(/#{Array(match).join('|')}/)
+          next if ignore && trace_point.path.to_s.match?(/#{Array(ignore).join('|')}/)
 
           id += 1
-          caller_path, caller_lineno = trace_point.binding.of_caller(2).source_location
+          caller_loc = caller_locations(2, 1)[0]
+          caller_path = caller_loc.absolute_path
+          caller_lineno = caller_loc.lineno
           location_cache_key = "#{caller_path}:#{caller_lineno}"
 
           mes = extract_method_from(trace_point)
+          next if mes.source_location[0] == '<internal:prelude>'
+
+          method_source = method_source_cache[mes] ||= remove_indent(mes.source)
 
           case trace_point.event
           when :call
@@ -38,7 +43,7 @@ module TraceLocation
               caller_lineno: caller_lineno,
               owner: mes.owner,
               name: mes.name,
-              source: remove_indent(mes.source),
+              source: method_source,
               hierarchy: hierarchy,
               is_module: trace_point.self.is_a?(Module)
             )
@@ -56,7 +61,7 @@ module TraceLocation
               caller_lineno: caller_lineno,
               owner: mes.owner,
               name: mes.name,
-              source: remove_indent(mes.source),
+              source: method_source,
               hierarchy: hierarchy,
               is_module: trace_point.self.is_a?(Module)
             )
@@ -70,15 +75,19 @@ module TraceLocation
 
       def extract_method_from(trace_point)
         if trace_point.self.is_a?(Module)
-          ::Module.instance_method(:method).bind(trace_point.self).call(trace_point.method_id)
+          ::Module.instance_method(:method)
+                  .bind(trace_point.self)
+                  .call(trace_point.method_id)
         else
-          ::Kernel.instance_method(:method).bind(trace_point.self).call(trace_point.method_id)
+          ::Kernel.instance_method(:method)
+                  .bind(trace_point.self)
+                  .call(trace_point.method_id)
         end
       end
 
       def remove_indent(source)
-        indent = source.split("\n").first.match(/\A(\s+).+\z/)[1]
-        source.split("\n").map { |line| line.gsub(/\A#{indent}/, '') }.join("\n")
+        indent = source[/\A(\s*)/, 1]
+        source.gsub(/^#{indent}/, '')
       end
     end
   end

data/lib/trace_location/config.rb

@@ -2,12 +2,12 @@
 
 module TraceLocation
   class Config # :nodoc:
-    attr_accessor :gems_dir, :dest_dir, :default_format
+    attr_accessor :current_dir, :dest_dir, :default_format
 
     def initialize
-      @gems_dir = File.join(Gem.path[0], 'gems')
+      @current_dir = Dir.pwd
       @dest_dir = Dir.pwd
-      @default_format = :markdown
+      @default_format = :md
     end
   end
 end

data/lib/trace_location/generator/csv.rb

@@ -9,6 +9,7 @@ module TraceLocation
 
       def initialize(events, return_value, options)
         super
+        @current_dir = ::TraceLocation.config.current_dir
         @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
@@ -21,7 +22,7 @@ module TraceLocation
 
       private
 
-      attr_reader :events, :return_value, :dest_dir, :file_path
+      attr_reader :events, :return_value, :current_dir, :dest_dir, :file_path
 
       def setup_dir
         FileUtils.mkdir_p(dest_dir)
@@ -32,7 +33,16 @@ module TraceLocation
           csv << ATTRIBUTES
 
           events.each do |event|
-            csv << ATTRIBUTES.map { |attr| event.public_send(attr) }
+            csv << [
+              event.id,
+              event.event,
+              event.path.to_s.gsub(%r{#{current_dir}/}, ''),
+              event.lineno,
+              event.caller_path.to_s.gsub(%r{#{current_dir}/}, ''),
+              event.caller_lineno,
+              event.owner_with_name,
+              event.hierarchy
+            ]
           end
         end
       end

data/lib/trace_location/generator/log.rb

@@ -11,7 +11,7 @@ module TraceLocation
 
       def initialize(events, return_value, options)
         super
-        @gems_dir = ::TraceLocation.config.gems_dir
+        @current_dir = ::TraceLocation.config.current_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')}.log"
@@ -26,7 +26,7 @@ module TraceLocation
 
       private
 
-      attr_reader :events, :return_value, :gems_dir, :dest_dir, :current, :filename, :file_path
+      attr_reader :events, :return_value, :current_dir, :dest_dir, :current, :filename, :file_path
 
       def setup_dir
         FileUtils.mkdir_p(dest_dir)
@@ -46,12 +46,11 @@ module TraceLocation
       end
 
       def format_events(events)
-        events.select(&:valid?).map do |e|
-          indent = indent(e.hierarchy)
-          event = EVENTS[e.event]
-          path = e.path.to_s.gsub(%r{#{gems_dir}/}, '')
+        events.select(&:valid?).map do |event|
+          indent = indent(event.hierarchy)
+          path = event.path.to_s.gsub(%r{#{current_dir}/}, '')
 
-          %(#{indent}#{event} #{path}:#{e.lineno} [#{e.owner_with_name}])
+          %(#{indent}#{EVENTS[event.event]} #{path}:#{event.lineno} [#{event.owner_with_name}])
         end
       end
 

data/lib/trace_location/generator/markdown.rb

@@ -5,7 +5,7 @@ module TraceLocation
     class Markdown < Base # :nodoc:
       def initialize(events, return_value, options)
         super
-        @gems_dir = ::TraceLocation.config.gems_dir
+        @current_dir = ::TraceLocation.config.current_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"
@@ -20,7 +20,7 @@ module TraceLocation
 
       private
 
-      attr_reader :events, :return_value, :gems_dir, :dest_dir, :current, :filename, :file_path
+      attr_reader :events, :return_value, :current_dir, :dest_dir, :current, :filename, :file_path
 
       def setup_dir
         FileUtils.mkdir_p(dest_dir)
@@ -34,8 +34,9 @@ module TraceLocation
           MARKDOWN
 
           events.select(&:call?).each do |e|
-            path = e.path.to_s.gsub(%r{#{gems_dir}/}, '')
-            caller_path = e.caller_path.to_s.gsub(%r{#{gems_dir}/}, '')
+            path = e.path.to_s.gsub(%r{#{current_dir}/}, '')
+            caller_path = e.caller_path.to_s.gsub(%r{#{current_dir}/}, '')
+
             io.write <<~MARKDOWN
               <details open>
               <summary>#{path}:#{e.lineno}</summary>

data/lib/trace_location/report.rb

@@ -9,6 +9,7 @@ module TraceLocation
     GENERATORS = {
       csv: ::TraceLocation::Generator::Csv,
       log: ::TraceLocation::Generator::Log,
+      md: ::TraceLocation::Generator::Markdown,
       markdown: ::TraceLocation::Generator::Markdown
     }.freeze
 

data/lib/trace_location/version.rb

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

data/trace_location.gemspec

@@ -7,8 +7,8 @@ require 'trace_location/version'
 Gem::Specification.new do |s|
   s.name          = 'trace_location'
   s.version       = TraceLocation::VERSION
-  s.authors       = ['Yoshiyuki Hirano']
-  s.email         = ['yhirano@me.com']
+  s.authors       = ['Yoshiyuki Hirano', 'Misaki Shioi']
+  s.email         = ['yhirano@me.com', 'shioi.mm@gmail.com']
   s.homepage      = 'https://github.com/yhirano55/trace_location'
   s.summary       = 'helps you get tracing the source location of codes'
   s.description   = %(TraceLocation helps you get tracing the source location of codes, and helps you can get reading the huge open souce libraries in Ruby)
@@ -21,9 +21,8 @@ Gem::Specification.new do |s|
   s.bindir        = 'exe'
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.5.0'
+  s.required_ruby_version = '>= 2.6.0'
 
-  s.add_dependency 'binding_of_caller'
   s.add_dependency 'method_source'
 
   s.add_development_dependency 'bundler'

metadata

@@ -1,29 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: trace_location
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Yoshiyuki Hirano
+- Misaki Shioi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2020-06-20 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: method_source
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +71,7 @@ description: TraceLocation helps you get tracing the source location of codes, a
   helps you can get reading the huge open souce libraries in Ruby
 email:
 - yhirano@me.com
+- shioi.mm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -92,7 +80,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
-- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -100,6 +87,21 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/active_record_establish_connection/result.csv
+- examples/active_record_establish_connection/result.log
+- examples/active_record_establish_connection/result.md
+- examples/active_record_validation_process/result.csv
+- examples/active_record_validation_process/result.log
+- examples/active_record_validation_process/result.md
+- examples/has_secure_password/result.csv
+- examples/has_secure_password/result.log
+- examples/has_secure_password/result.md
+- examples/lifecycle_of_rails_application/result.csv
+- examples/lifecycle_of_rails_application/result.log
+- examples/lifecycle_of_rails_application/result.md
+- examples/rendering_process/result.csv
+- examples/rendering_process/result.log
+- examples/rendering_process/result.md
 - lib/trace_location.rb
 - lib/trace_location/collector.rb
 - lib/trace_location/config.rb
@@ -125,14 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: helps you get tracing the source location of codes

data/CHANGELOG.md

@@ -1,19 +0,0 @@
-## v0.3.0
-
-- Log path is shorten
-- Use gems_dir instead of root_dir
-- Don't collect not including gems_dir
-- Fix Regexp
-
-## v0.2.0
-
-- Refactoring: Separate Collector/Report/Generator
-- Display class method or instance method
-
-## v0.1.1
-
-- Update README
-
-## v0.1.0
-
-- Initial Release