trace_location 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1e2f74ef8aefad64a0a962c2a77dbd4a47d8992ca5ef027d0acf47da19e7c2a
-  data.tar.gz: ad9b606d32f96289cb629f0c58f7324e9d9704e084f61fc9bbf2d689836eabee
+  metadata.gz: 0f72080e074e711ead889178f5bf03db6f01b2d1f2baee4c7a0017c8e1b374e2
+  data.tar.gz: 83d066fd0c05fd30488ab17a213d2e6cc871a6b2274e155dd3ee87f2c12cf7a6
 SHA512:
-  metadata.gz: 9835516aba4ce712bd1ef3311947e315e052de1c6cd102967d06d740db127c459754339b92221b7a2904046a8fdfe8391e105ff8001af915b9cd67eef79da1b2
-  data.tar.gz: 24d753f05e76317957adf43a6ab02024558af46f623a4ac548f22130b6bc7d450d238fca16d303986d3d70791b3f112919808f5de750a520c01978880826fe08
+  metadata.gz: d5ea1a2a317eeddd8a02b6013150a8969db58738b724004775f99d4a284cfdc394d620a81bff79063cd07cf295f42f4be98d62b3150c62da83fed95b3f51e6dc
+  data.tar.gz: 9fae9ec4eb6e18de78ffec2e94718fd8eb7b3d3fb8f46964aecce96da4fedfc5efe161d2ce2f514a201e0cb556b3e2759e1f7136a0c9c0b9ef655419e4bedd2a

data/.travis.yml

@@ -3,8 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.6
-  - 2.7.1
+  - 2.6.7
+  - 2.7.3
   - ruby-head
 before_install: gem install bundler -v 2.1.4
 

data/Gemfile.lock

@@ -1,43 +1,50 @@
 PATH
   remote: .
   specs:
-    trace_location (0.10.0)
+    trace_location (0.12.0)
       method_source
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.2)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
     method_source (1.0.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.71.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -2,7 +2,7 @@
 
 [![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.
+TraceLocation helps you trace the source location to ease reading huge open-source libraries in Ruby.
 
 ## Installation
 
@@ -42,6 +42,7 @@ Then you can get logs like this: [.md](https://github.com/yhirano55/trace_locati
 | 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/` |
+| methods | Symbol or Array of method names | `[:call]` |
 
 ## More examples
 

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/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

@@ -8,7 +8,8 @@ module TraceLocation
     Result = Struct.new(:events, :return_value)
 
     class << self
-      def collect(match:, ignore:, &block)
+      def collect(match:, ignore:, methods:, &block)
+        methods = Array(methods) if methods
         events = []
         hierarchy = 0
         id = 0
@@ -18,6 +19,7 @@ module TraceLocation
         tracer = TracePoint.new(:call, :return) do |trace_point|
           next if match && !trace_point.path.to_s.match?(/#{Array(match).join('|')}/)
           next if ignore && trace_point.path.to_s.match?(/#{Array(ignore).join('|')}/)
+          next if methods && !methods.include?(trace_point.method_id)
 
           id += 1
           caller_loc = caller_locations(2, 1)[0]
@@ -26,7 +28,7 @@ module TraceLocation
           location_cache_key = "#{caller_path}:#{caller_lineno}"
 
           mes = extract_method_from(trace_point)
-          next if mes.source_location[0] == '<internal:prelude>'
+          next if mes.source_location[0].match?(/\A(?:<internal:.+>|\(eval\))\z/)
 
           method_source = method_source_cache[mes] ||= remove_indent(mes.source)
 

data/lib/trace_location/version.rb

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

data/lib/trace_location.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: trace_location
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Yoshiyuki Hirano
 - Misaki Shioi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -72,7 +72,8 @@ description: TraceLocation helps you get tracing the source location of codes, a
 email:
 - yhirano@me.com
 - shioi.mm@gmail.com
-executables: []
+executables:
+- trace_location
 extensions: []
 extra_rdoc_files: []
 files:
@@ -102,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
@@ -119,7 +122,7 @@ homepage: https://github.com/yhirano55/trace_location
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: helps you get tracing the source location of codes
 test_files: []