trace_location 0.9.3.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53f06873752fb59bd283cfdab5418d69be411bd03d9dcb9c73aebfefacf1286
-  data.tar.gz: 75d433e5b116f864e2393bea2417949335775aa619be186eb6c145268283f779
+  metadata.gz: 010e65cd3a2447cb0816fd31bb62eec1acb6546a0cc2d8667df523027d24abd4
+  data.tar.gz: 9bce85eda13a6836c0195d05265dcaf9794d4f2356d6a0b5ad5cf25d915db5b9
 SHA512:
-  metadata.gz: 6206f594de72240102b08f14e2620924d9e0310393305c55266b743f3a28e3af22fe018ffa429f2eb19e07a95a707511c6550b239357227b3dc792e11a78041d
-  data.tar.gz: 6ad2e38892b0794c714345da2ef873f71f329983ceb679a068db0496ff982fea77f0bc886c01ea2bf3fd42f119082446921147f752cef1a1b10c9f7e704cf656
+  metadata.gz: 274ae1e802b7eb65e81cabd20fc66bd7b8ba2c7427e6eb2e5e6dee0a9415350a26cad2827f670151b9e94329b4702bca8086432b94179c20b15e48fca3a5265e
+  data.tar.gz: 367ae84388dd7a5b331ed780b99e6539a9f895aa5be06acdde803501a1bef8f24c155b7334031d4dc6314272332511773dfe4139ac825c63c53df5dc346c6c91

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
 
 Metrics:
   Enabled: false

data/.travis.yml

@@ -3,5 +3,11 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.1
+  - 2.6.6
+  - 2.7.1
+  - ruby-head
+before_install: gem install bundler -v 2.1.4
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile.lock

@@ -1,25 +1,21 @@
 PATH
   remote: .
   specs:
-    trace_location (0.9.3.1)
-      binding_of_caller
+    trace_location (0.11.0)
       method_source
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    binding_of_caller (0.8.0)
-      debug_inspector (>= 0.0.1)
-    debug_inspector (0.0.3)
     diff-lcs (1.3)
     jaro_winkler (1.5.2)
-    method_source (0.9.2)
+    method_source (1.0.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
     rainbow (3.0.0)
-    rake (12.3.2)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -54,4 +50,4 @@ DEPENDENCIES
   trace_location!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,5 +1,7 @@
 # TraceLocation
 
+[![Build Status](https://travis-ci.org/yhirano55/trace_location.svg?branch=master)](https://travis-ci.org/yhirano55/trace_location)
+
 TraceLocation helps you get tracing the source location of codes, and helps you can get reading the huge open souce libraries in Ruby.
 
 ## Installation
@@ -37,9 +39,9 @@ Then you can get logs like this: [.md](https://github.com/yhirano55/trace_locati
 
 | name | content | example |
 |:-----|:--------|:--------|
-| format | `:markdown`, `:log`, `:csv` (default: `:markdown`) | `:markdown` |
-| match | Regexp for allow list | `/activerecord/` |
-| ignore | Regexp for deny list | `/bootsnap\|activesupport/` |
+| format | `:md`, `:log`, `:csv` (default: `:md`) | `:md` |
+| match | Regexp, Symbol, String or Array for allow list | `[:activerecord, :activesupport]` |
+| ignore | Regexp, Symbol, String or Array for deny list | `/bootsnap\|activesupport/` |
 
 ## More examples
 
@@ -69,7 +71,7 @@ Results: [.md](https://github.com/yhirano55/trace_location/blob/master/examples/
 ```ruby
 class User < ApplicationRecord
   # temporary surrounding with TraceLocation#trace
-  Trace.location(format: :markdown, ignore: /activesupport/) do
+  TraceLocation.trace(format: :md, ignore: /activesupport/) do
     has_secure_password
   end
 ```
@@ -87,7 +89,7 @@ class BooksController < ApplicationController
     @books = Book.all
 
     # temporary surrounding with TraceLocation#trace
-    TraceLocation.trace(format: :markdown, ignore: /activesupport|rbenv|concurrent-ruby/) do
+    TraceLocation.trace(format: :md, ignore: /activesupport|rbenv|concurrent-ruby/) do
       render json: @books
     end
   end

data/exe/trace_location

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'trace_location'
+require 'trace_location/cli'
+
+TraceLocation::CLI.new(ARGV).run

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/cli.rb

@@ -0,0 +1,59 @@
+require 'optparse'
+
+module TraceLocation
+  class CLI
+    attr_reader :argv
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      opt = OptionParser.new
+      opt.on('-f FORMAT', '--format=FORMAT', 'Report format (default: :md)', &:to_sym)
+      opt.on('-m REGEXP', '--match=REGEXP') { |str| Regexp.new(str) }
+      opt.on('-i REGEXP', '--ignore=REGEXP') { |str| Regexp.new(str) }
+      opt.on('-d DIR', '--dest-dir=DIR')
+      opt.on('-e code')
+
+      params = {}
+      opt.order!(argv, into: params)
+      params.transform_keys! { |k| k.to_s.gsub('-', '_').to_sym }
+
+      if code = params.delete(:e)
+        exec_code code, params
+      else
+        file = argv.shift
+        unless file
+          puts opt.help
+          exit 1
+        end
+
+        exec_command file, params
+      end
+    end
+
+    private
+
+    def exec_command(cmd, params)
+      path =
+        if File.exist?(cmd)
+          cmd
+        else
+          `which #{cmd}`.chomp
+        end
+
+      $PROGRAM_NAME = cmd
+
+      TraceLocation.trace(params) do
+        load path
+      end
+    end
+
+    def exec_code(code, params)
+      TraceLocation.trace(params) do
+        eval code
+      end
+    end
+  end
+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].match?(/\A(?:<internal:.+>|\(eval\))\z/)
+
+          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)
             )
@@ -81,8 +86,8 @@ module TraceLocation
       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

@@ -7,7 +7,7 @@ module TraceLocation
     def initialize
       @current_dir = Dir.pwd
       @dest_dir = Dir.pwd
-      @default_format = :markdown
+      @default_format = :md
     end
   end
 end

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.1'
+  VERSION = '0.11.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.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Yoshiyuki Hirano
+- Misaki Shioi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2020-08-12 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,7 +71,9 @@ 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
-executables: []
+- shioi.mm@gmail.com
+executables:
+- trace_location
 extensions: []
 extra_rdoc_files: []
 files:
@@ -114,7 +103,9 @@ files:
 - examples/rendering_process/result.csv
 - examples/rendering_process/result.log
 - examples/rendering_process/result.md
+- exe/trace_location
 - lib/trace_location.rb
+- lib/trace_location/cli.rb
 - lib/trace_location/collector.rb
 - lib/trace_location/config.rb
 - lib/trace_location/event.rb
@@ -139,14 +130,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