argtrace 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7398f53bb9b94105fc990221979803eaceebffa073e7487b16b558fc65755af6
-  data.tar.gz: 0744ce1ba76244daf8d442465e6ac7828cdf07b51f486b4b661c619f333419cb
+  metadata.gz: 954782bc5b1e4572bb27a4bb008d81dee8a8406b0a55b630d479913cf19dc977
+  data.tar.gz: 12e7d2fa9af906a4ff9d7f431a2c54a6e5140beb3b397de9dc1bac3f9c27fa87
 SHA512:
-  metadata.gz: 274187675f07b8141b2ddbf05be0d344d5ce885cfc945c0d76912b2b77acfcba447eedaa1cc0dba0b671d1dee8b1dbe79fc4772b1747a8f946952a98749ce5f4
-  data.tar.gz: 3e05fa0e9067ec243aca02b4e94a016e9e193cd26d0bd321295dd1c8159926f7a48274eaee52d85121ca60eeb9d5b3dcfef7505f4ddc13fba74c6cd894c0f991
+  metadata.gz: 28085197c7f058c828730753e2bb40bca75646eb88d57515c6c7803b63a06e6a49109ffa914df6667efe6f62a2a33b04d5d3e94184a9eaeedd2c81862eb23147
+  data.tar.gz: 93197b5f6530199b8a6b9e38e93e141ec096da0a83328f15607500ad7057ca5badcb8dba143fd96a94c2a87782a46689f385ea01fa03bfc02d7241bbabe1407a

data/README.md

@@ -39,10 +39,33 @@ $ ruby -r argtrace/autorun  YOUR_PROGRAM_HERE.rb
 ```
 RBS file is saved as "sig.rbs" in current directory.
 
-### Restriction
-Argtrace cannot work with C-extension,
-because TracePoint doesn't provide feature to access arguments of calls into C-extension.
+### 3. Rakefile
+Modify Rakefile to load Argtrace.
+```ruby
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w[-r argtrace/autorun]
+end
+```
+then run as usual like `rake test`.
+RBS file is saved as "sig.rbs" in current directory.
 
+### 4. Minitest
+Modify global helper under test/ to load Argtrace. For example:
+```ruby
+require "argtrace/autorun"
+require "minitest/autorun"
+```
+And add Argtrace to Gemfile
+```ruby
+gem "argtrace"
+```
+then run as usual like `rake test`.
+RBS file is saved as "sig.rbs" in current directory.
+
+### Restriction
+- Argtrace cannot work with C-extension,
+  because TracePoint doesn't provide feature to access arguments of calls into C-extension.
+- Only work with single-thread programs.
 
 ## Contributing
 

data/lib/argtrace/default.rb

@@ -8,8 +8,11 @@ module Argtrace
 
       tracer.set_filter do |tp|
         if [:call, :return].include?(tp.event)
-          tracer.user_source?(tp.defined_class, tp.method_id)
+          ret = tracer.user_source?(tp.defined_class, tp.method_id)
+          # $stderr.puts [tp.event, tp.defined_class, tp.method_id].inspect if ret
+          ret
         else
+          # $stderr.puts [tp.event, tp.defined_class, tp.method_id].inspect if ret
           true
         end
       end
@@ -17,6 +20,7 @@ module Argtrace
       tracer.set_notify do |ev, callinfo|
         if ev == :return
           typelib.learn(callinfo.signature)
+          # $stderr.puts callinfo.signature.inspect
         end
       end
 

data/lib/argtrace/signature.rb

@@ -1,4 +1,3 @@
-
 module Argtrace
 
   # signature of method/block 
@@ -10,6 +9,10 @@ module Argtrace
       @params = []
     end
 
+    def signature_for_block?
+      @method_id == nil
+    end
+
     def merge(all_params, ret)
       unless @params
         @params = []
@@ -19,8 +22,10 @@ module Argtrace
         if i == @params.size
           @params << all_params[i]  # TODO: dup
         else
-          if @params[i].mode == all_params[i].mode &&
-              @params[i].name == all_params[i].name
+          same_mode = @params[i].mode == all_params[i].mode
+          same_name = @params[i].name == all_params[i].name
+          # allow name changing only for block call
+          if same_mode && (signature_for_block? || same_name)
             if all_params[i].mode == :block
               # TODO: buggy
               # merging of block parameter type is quite tricky...
@@ -207,6 +212,7 @@ module Argtrace
           return false
         end
       else
+        # both data should be Class, just compare them
         return other.data < @data
       end
     end

data/lib/argtrace/tracer.rb

@@ -41,20 +41,21 @@ module Argtrace
               #{@stack[id].map{|x| x.signature.to_s}.join("\n  ")}
           EOF
         end
-        type = TypeUnion.new
-        type.add(Type.new_with_value(tp.return_value))
-        ent.signature.return_type = type
       end
       return ent
     end
 
     # find callinfo which use specific block
-    def find_by_block_location(path, lineno)
+    def find_by_block_location(tp)
       id = Thread.current.object_id
       ret = []
       @stack[id].each do |info|
-        if info.block_proc && info.block_proc.source_location == [path, lineno]
-          ret << info
+        if info.block_proc && info.block_proc.source_location == [tp.path, tp.lineno]
+          # Warning: sometimes different block has same location.
+          # I cannot handle such case strictly, but use heuristics by comparing parameter names.
+          if tp.parameters.map{|x| x[1]} == info.block_proc.parameters.map{|x| x[1]}
+            ret << info
+          end
         end
       end
       return ret
@@ -107,10 +108,13 @@ module Argtrace
 
     # process block call/return event
     def trace_block_event(tp)
+      return if tp.event != :b_call
+
       # I cannot determine the called block instance directly, so use block's location.
-      callinfos_with_block = @callstack.find_by_block_location(tp.path, tp.lineno)
+      callinfos_with_block = @callstack.find_by_block_location(tp)
       callinfos_with_block.each do |callinfo|
         block_param = callinfo.signature.get_block_param
+        # $stderr.puts [tp.event, tp.path, tp.lineno, callinfo.block_proc.parameters, tp.parameters].inspect
         block_param_types = get_param_types(callinfo.block_proc.parameters, tp)
         # TODO: return type (but maybe, there is no demand)
         block_param.type.merge(block_param_types, nil)
@@ -158,6 +162,10 @@ module Argtrace
 
         callinfo = @callstack.pop_callstack(tp)
         if callinfo
+          rettype = TypeUnion.new
+          rettype.add(Type.new_with_value(tp.return_value))
+          callinfo.signature.return_type = rettype
+             
           if !skip_flag && @prune_event_count == 0
             @notify_block.call(tp.event, callinfo) if @notify_block
           end
@@ -462,6 +470,12 @@ module Argtrace
       @@running_trace.delete(trace)
     end
 
+    def self.force_stop_all
+      @@running_trace.each do |t|
+        t.disable
+      end
+    end
+
   end
 
 end

data/lib/argtrace/typelib.rb

@@ -15,9 +15,48 @@ module Argtrace
           hmethod[method_id] = [nil, nil]
         }
       }
+      @api_class_cache = {}
+      @api_symbol_cache = {}
+    end
+
+    CLASS_NAME_PATTERN = '[A-Z][A-Za-z0-9_]*'
+    def api_class?(klass)
+      unless @api_class_cache.key?(klass)
+        if /\A(#{CLASS_NAME_PATTERN})(::#{CLASS_NAME_PATTERN})*\z/ =~ klass.to_s
+          @api_class_cache[klass] = true
+        else
+          # this must not be interface class
+          @api_class_cache[klass] = false
+        end
+      end
+      return @api_class_cache[klass]
+    end
+
+    NORMAL_METHOD_NAME_PATTERN = '[A-Za-z0-9_]+[=?!]?'
+    OPERATOR_METHOD_NAME_PATTERN = '[!%&=\-~^|\[+*\]<>\/]+'
+    def api_method?(method_id)
+      unless @api_symbol_cache.key?(method_id)
+        if /\A((#{NORMAL_METHOD_NAME_PATTERN})|(#{OPERATOR_METHOD_NAME_PATTERN}))\z/ =~ method_id.to_s
+          @api_symbol_cache[method_id] = true
+        else
+          # this must not be interface method
+          @api_symbol_cache[method_id] = false
+        end
+      end
+      return @api_symbol_cache[method_id]
     end
 
     def ready_signature(signature)
+      return nil unless api_class?(signature.defined_class)
+      return nil unless api_method?(signature.method_id)
+
+      # DEBUG:
+      # if not @lib.key?(signature.defined_class)
+      #   p [signature.defined_class, signature.method_id, signature.defined_class.to_s, signature.method_id.to_s]
+      # elsif not @lib[signature.defined_class].key?(signature.method_id)
+      #   p [signature.defined_class, signature.method_id, signature.defined_class.to_s, signature.method_id.to_s]
+      # end
+
       pair = @lib[signature.defined_class][signature.method_id]
       index = signature.is_singleton_method ? 1 : 0
       unless pair[index]
@@ -31,8 +70,49 @@ module Argtrace
       return pair[index]
     end
 
+    # remove non-api class from type signature
+    def discard_noise_from_signature(signature)
+      signature.params.each do |param|
+        if param.mode == :block
+          discard_noise_from_signature(param.type)
+        else
+          discard_noise_from_typeunion(param.type)
+        end
+      end
+      discard_noise_from_typeunion(signature.return_type)
+    end
+
+    def discard_noise_from_typeunion(typeunion)
+      return unless typeunion
+      typeunion.union.delete_if{|type| noise_type?(type)}
+    end
+
+    def noise_type?(type)
+      if type.data.is_a?(Symbol)
+        return false
+      end
+      if type.data.is_a?(Array)
+        if type.subdata == nil
+          return false
+        end
+        return !api_class?(type.subdata)
+      end
+      if type.data.is_a?(Class)
+        return !api_class?(type.data)
+      end
+      raise "Unexpected type data : #{type}"
+    end
+
+    # add signature into type library
     def learn(signature)
-      ready_signature(signature).merge(signature.params, signature.return_type)
+      sig = ready_signature(signature)
+      if sig
+        discard_noise_from_signature(signature)
+        sig.merge(signature.params, signature.return_type)
+      else
+        # skip
+        # $stderr.puts [:skip, signature].inspect
+      end
     end
 
     def to_rbs
@@ -41,6 +121,9 @@ module Argtrace
       # TODO: attr_reader/attr_writer/attr_accessor
       mod_root = OutputModule.new
 
+      # DEBUG:
+      # $stderr.puts @lib.inspect
+
       @lib.keys.sort_by{|x| x.to_s}.each do |klass|
         klass_methods = @lib[klass]
 
@@ -50,7 +133,15 @@ module Argtrace
             sig = klass_methods[method_id][instance_or_singleton]
             next unless sig
 
-            mod_root.add_signature(sig)
+            begin
+              mod_root.add_signature(sig)
+            rescue => e
+              $stderr.puts "----- argtrace bug -----"
+              $stderr.puts "#{klass}::#{method_id} (#{sig})"
+              $stderr.puts e.full_message
+              $stderr.puts "------------------------"
+              raise
+            end
           end
         end
       end
@@ -73,33 +164,13 @@ module Argtrace
       @actual_module = Kernel
 
       constname = class_const_name(signature.defined_class)
-      unless constname
-        # cannot handle this
-        return
-      end
-
       add_signature_inner(constname, signature)
     end
 
     # split class name into consts (e.g. Argtrace::TypeLib to ["Argtrace", "TypeLib"])
+    # bad name class is already sanitized, just split.
     def class_const_name(klass)
-      if /^[A-Za-z0-9_:]+$/ =~ klass.to_s
-        # this should be normal name
-        consts = klass.to_s.split("::")
-
-        # assertion
-        resolved_class = consts.inject(Kernel){|mod, const| mod.const_get(const)}
-        if klass != resolved_class
-          $stderr.puts "----- argtrace bug -----"
-          $stderr.puts "#{klass} => #{consts} => #{resolved_class}"
-          $stderr.puts "------------------------"
-          raise "Failed to resolve class by constant"
-        end
-
-        return consts
-      else
-        return nil
-      end
+      klass.to_s.split("::")
     end
 
     def add_signature_inner(name_consts, signature)
@@ -191,6 +262,11 @@ module Argtrace
         # TODO: I can't distinguish nil and untyped.
         return "untyped"
       end
+      if typeunion.union.count{|x| x.data.is_a?(Symbol)} >= 16
+        # too much symbols, this should not be enum.
+        typeunion.union.delete_if{|x| x.data.is_a?(Symbol)}
+        typeunion.add(Type.new_with_type(Symbol))
+      end
       if typeunion.union.size == 2 and typeunion.union.any?{|x| NilClass == x.data}
         # type is nil and sometype, so represent it as "sometype?"
         sometype = typeunion.union.find{|x| NilClass != x.data}

data/lib/argtrace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Argtrace
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: argtrace
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Riki Ishikawa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-14 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies: []
 description: library to trace arguments of method calls or block calls with TracePoint
   and do callback.