typeprof 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bebe3587d198c63b2c2a67a240fa809de0b18edbc72c591b0feabbe6250d1247
-  data.tar.gz: 972889bad9ae90722ae9a920ffac984048473d7da6c9c2c88797ea1039fd1024
+  metadata.gz: 6c01f41e130c6e3bbc112520904ed710a75dea1b167ea112e96a321cd1bceadf
+  data.tar.gz: 1b61e75c07cc8d24570bd998ea852f850b22264aaa1eed1bda425efe11660fba
 SHA512:
-  metadata.gz: 79f5e58776448af3a1f39c004b2016965919bd52844aa2821cbb0a4a096448cec2999ae2d059647366068ded6bf7529f5a72d0269e26955da8f24be63e9eaefc
-  data.tar.gz: d6900c291662cb287a92ef940510d95f4a289b903de9bbeeeb8f6fa7d7c53a76dc2193ea2317c2f4f8e29c627c8be0b18308447446b6de9b6af2de42473e8244
+  metadata.gz: ba66753bc6fe6b21939449ede398ee31c27aa06893884a3e93baebcf60439c9552fa0b1da1b8fd6158f83ef012966f275c83055ba94d2974c10f694e031c40ab
+  data.tar.gz: 6f6d9e688c024eefead28c9fe847686d172919a0c3ae0f5f6441bcb79d947710265e77dc52e4c5d44be699d7ea6bcd978943d0a898621956e6991a19c3874ac0

data/Gemfile.lock

@@ -16,7 +16,7 @@ GIT
 PATH
   remote: .
   specs:
-    typeprof (0.1.2)
+    typeprof (0.1.4)
       rbs (>= 0.12.0)
 
 GEM
@@ -26,7 +26,7 @@ GEM
     docile (1.3.2)
     power_assert (1.2.0)
     rake (13.0.1)
-    rbs (0.12.2)
+    rbs (0.14.0)
     stackprof (0.2.15)
     test-unit (3.3.6)
       power_assert

data/README.md

@@ -30,6 +30,6 @@ class Object
 end
 ```
 
-## Document
+## Documentation
 
 [English](doc/doc.md) / [日本語](doc/doc.ja.md)

data/doc/doc.ja.md

@@ -25,6 +25,11 @@ $ typeprof sig/app.rbs app.rb -o sig/app.gen.rbs
 * `-o OUTFILE`: 標準出力ではなく、指定ファイル名に出力する
 * `-q`: 解析の進捗を表示しない
 * `-v`: 解析の詳細ログを表示する（現状ではデバッグ用出力に近い）
+* `-I DIR`: `require`のファイル探索ディレクトリを追加する
+* `-r GEMNAME`: `GEMNAME`に対応するRBSをロードする
+* `--exclude-dir DIR`: `DIR`以下のファイルの解析結果を出力から省略する。後に指定されているほうが優先される（`--include-dir foo --exclude-dir foo/bar`の場合う、foo/bar/baz.rbの結果は出力されず、foo/baz.rbの結果は出力される）。
+* `--include-dir DIR`: `DIR`以下のファイルの解析結果を出力に含める。後に指定されているほうが優先される（`--exclude-dir foo --include-dir foo/bar`の場合、
+foo/bar/baz.rbの結果は出力されるが、foo/baz.rbの結果は出力されない）。
 * `-fshow-errors`: 実行中に見つけたバグの可能性を出力します（多くの場合、大量のfalse positiveが出ます）。
 * `-fpedantic-output`: デフォルトでは`A | untyped`と推定されたところを単に`A`と出力しますが、より生の出力、つまり`A | untyped`と出力します。
 * `-fshow-container-raw-elements`: （後で書く）

data/doc/doc.md

@@ -25,6 +25,10 @@ Here is a list of currently avaiable options:
 * `-o OUTFILE`: Write the analyze result to OUTFILE instead of standard output
 * `-q`: Hide the progress indicator
 * `-v`: Show the analysis log (Currently, the log is just for debugging and may become very huge)
+* `-I DIR`: Add `DIR` to the file search path of `require`
+* `-r GEMNAME`: Load the RBS files of `GEMNAME`
+* `--exclude-dir DIR`: Omit the result of files that are placed under the directory `DIR`.  If there are some directory specifications, the latter one is stronger.  (Assuming that `--include-dir foo --exclude-dir foo/bar` is specified, the analysis result of foo/bar/baz.rb is omitted, but foo/baz.rb is shown.)
+* `--include-dir DIR`: Show the result of files that are placed under the directory `DIR`.  If there are some directory specifications, the latter one is stronger.  (Assuming that `--exclude-dir foo --include-dir foo/bar` is specified, the analysis result of foo/bar/baz.rb is shown, but foo/baz.rb is omitted.)
 * `-fshow-errors`: Prints out possible bugs found during execution (often a lot of false positives).
 * `-fpedantic-output`: When TypeProf inferred a type `A | untyped`, it simply outputs `A` by default. But this option forces it to output `A | untyped`.
 * `-fshow-container-raw-elements`: (undocumented yet)
@@ -50,7 +54,7 @@ p foo(42)  #=> String
 The analysis results of TypeProf are as follows.
 
 ```
-$ ruby exe/type-profiler test.rb
+$ ruby exe/typeprof test.rb
 # Revealed types
 #  test.rb:2 #=> Integer
 #  test.rb:6 #=> String
@@ -84,7 +88,7 @@ p Foo.new.a #=> Integer | String
 ```
 
 ```
-$ ruby exe/type-profiler test.rb
+$ ruby exe/typeprof test.rb
 # Revealed types
 #  test.rb:11 #=> Integer | String
 
@@ -299,7 +303,7 @@ class Object
   def foo: (Integer) -> Integer | (String) -> String
 end
 ```
- 
+
 ```
 # test.rb
 def foo(n)
@@ -386,9 +390,9 @@ You can update the types; this allows the following code to initialize the array
 ```
 def foo
   a = []
-  
+
   100.times {|n| a << n.to_s}
-  
+
   a
 end
 

data/lib/typeprof/analyzer.rb

@@ -235,8 +235,6 @@ module TypeProf
       @block_to_ctx = {}
       @gvar_table = VarTable.new
 
-      @include_relations = {}
-
       @errors = []
       @reveal_types = {}
       @backward_edges = {}
@@ -274,32 +272,37 @@ module TypeProf
     attr_reader :class_defs
 
     class ClassDef # or ModuleDef
-      def initialize(kind, name, superclass)
+      def initialize(kind, name, superclass, absolute_path)
         @kind = kind
         @superclass = superclass
-        @modules = { true => [], false => [] }
+        @modules = { true => {}, false => {} }
         @name = name
         @consts = {}
         @methods = {}
         @ivars = VarTable.new
         @cvars = VarTable.new
+        @absolute_path = absolute_path
       end
 
-      attr_reader :kind, :modules, :methods, :superclass, :ivars, :cvars
+      attr_reader :kind, :modules, :methods, :superclass, :ivars, :cvars, :absolute_path
       attr_accessor :name, :klass_obj
 
-      def include_module(mod, visible)
+      def include_module(mod, absolute_path)
         # XXX: need to check if mod is already included by the ancestors?
-        unless @modules[false].include?([visible, mod])
-          @modules[false] << [visible, mod]
+        absolute_paths = @modules[false][mod]
+        unless absolute_paths
+          @modules[false][mod] = absolute_paths = Utils::MutableSet.new
         end
+        absolute_paths << absolute_path
       end
 
-      def extend_module(mod, visible)
+      def extend_module(mod, absolute_path)
         # XXX: need to check if mod is already included by the ancestors?
-        unless @modules[true].include?([visible, mod])
-          @modules[true] << [visible, mod]
+        absolute_paths = @modules[true][mod]
+        unless absolute_paths
+          @modules[true][mod] = absolute_paths = Utils::MutableSet.new
         end
+        absolute_paths << absolute_path
       end
 
       def get_constant(name)
@@ -315,7 +318,7 @@ module TypeProf
 
       def get_method(mid, singleton)
         @methods[[singleton, mid]] || begin
-          @modules[singleton].reverse_each do |_visible, mod|
+          @modules[singleton].each_key do |mod|
             meth = mod.get_method(mid, false)
             return meth if meth
           end
@@ -336,22 +339,22 @@ module TypeProf
         @methods[[singleton, mid]] << mdef
         # Need to restart...?
       end
+
+      def set_method(mid, singleton, mdef)
+        @methods[[singleton, mid]] = Utils::MutableSet.new
+        @methods[[singleton, mid]] << mdef
+      end
     end
 
-    def include_module(including_mod, included_mod, visible = true)
+    def include_module(including_mod, included_mod, absolute_path)
       return if included_mod == Type.any
 
-      if visible
-        @include_relations[including_mod] ||= Utils::MutableSet.new
-        @include_relations[including_mod] << included_mod
-      end
-
       including_mod = @class_defs[including_mod.idx]
       included_mod.each_child do |included_mod|
         if included_mod.is_a?(Type::Class)
           included_mod = @class_defs[included_mod.idx]
           if included_mod && included_mod.kind == :module
-            including_mod.include_module(included_mod, visible)
+            including_mod.include_module(included_mod, absolute_path)
           else
             warn "including something that is not a module"
           end
@@ -359,13 +362,13 @@ module TypeProf
       end
     end
 
-    def extend_module(extending_mod, extended_mod, visible = true)
+    def extend_module(extending_mod, extended_mod, absolute_path)
       extending_mod = @class_defs[extending_mod.idx]
       extended_mod.each_child do |extended_mod|
         if extended_mod.is_a?(Type::Class)
           extended_mod = @class_defs[extended_mod.idx]
           if extended_mod && extended_mod.kind == :module
-            extending_mod.extend_module(extended_mod, visible)
+            extending_mod.extend_module(extended_mod, absolute_path)
           else
             warn "extending something that is not a module"
           end
@@ -373,8 +376,8 @@ module TypeProf
       end
     end
 
-    def new_class(cbase, name, type_params, superclass)
-      if cbase && cbase.idx != 0
+    def new_class(cbase, name, type_params, superclass, absolute_path)
+      if cbase && cbase.idx != 1
         show_name = "#{ @class_defs[cbase.idx].name }::#{ name }"
       else
         show_name = name.to_s
@@ -386,7 +389,7 @@ module TypeProf
         else
           superclass_idx = superclass.idx
         end
-        @class_defs[idx] = ClassDef.new(:class, show_name, superclass_idx)
+        @class_defs[idx] = ClassDef.new(:class, show_name, superclass_idx, absolute_path)
         klass = Type::Class.new(:class, idx, type_params, superclass, show_name)
         @class_defs[idx].klass_obj = klass
         cbase ||= klass # for bootstrap
@@ -394,7 +397,7 @@ module TypeProf
         return klass
       else
         # module
-        @class_defs[idx] = ClassDef.new(:module, show_name, nil)
+        @class_defs[idx] = ClassDef.new(:module, show_name, nil, absolute_path)
         mod = Type::Class.new(:module, idx, type_params, nil, show_name)
         @class_defs[idx].klass_obj = mod
         add_constant(cbase, name, mod)
@@ -407,7 +410,7 @@ module TypeProf
 
       idx = @class_defs.size
       superclass = Type::Builtin[:struct]
-      @class_defs[idx] = ClassDef.new(:class, "(Struct)", superclass.idx)
+      @class_defs[idx] = ClassDef.new(:class, "(Struct)", superclass.idx, ep.ctx.iseq.absolute_path)
       klass = Type::Class.new(:class, idx, [], superclass, "(Struct)")
       @class_defs[idx].klass_obj = klass
 
@@ -487,12 +490,17 @@ module TypeProf
       mdef
     end
 
-    def add_attr_method(klass, mid, ivar, kind)
+    def set_method(klass, mid, singleton, mdef)
+      @class_defs[klass.idx].set_method(mid, singleton, mdef)
+      mdef
+    end
+
+    def add_attr_method(klass, absolute_path, mid, ivar, kind)
       if kind == :reader || kind == :accessor
-        add_method(klass, mid, false, AttrMethodDef.new(ivar, :reader))
+        add_method(klass, mid, false, AttrMethodDef.new(ivar, :reader, absolute_path))
       end
       if kind == :writer || kind == :accessor
-        add_method(klass, :"#{ mid }=", false, AttrMethodDef.new(ivar, :writer))
+        add_method(klass, :"#{ mid }=", false, AttrMethodDef.new(ivar, :writer, absolute_path))
       end
     end
 
@@ -512,12 +520,12 @@ module TypeProf
       add_method(recv_ty.klass, mid, true, TypedMethodDef.new([[fargs, ret_ty]]))
     end
 
-    def add_custom_method(klass, mid, impl)
-      add_method(klass, mid, false, CustomMethodDef.new(impl))
+    def set_custom_method(klass, mid, impl)
+      set_method(klass, mid, false, CustomMethodDef.new(impl))
     end
 
-    def add_singleton_custom_method(klass, mid, impl)
-      add_method(klass, mid, true, CustomMethodDef.new(impl))
+    def set_singleton_custom_method(klass, mid, impl)
+      set_method(klass, mid, true, CustomMethodDef.new(impl))
     end
 
     def alias_method(klass, singleton, new, old)
@@ -592,27 +600,39 @@ module TypeProf
     end
 
     class VarTable
+      Entry = Struct.new(:rbs_declared, :read_continuations, :type, :absolute_paths)
+
       def initialize
-        @read, @write = {}, {}
+        @tbl = {}
       end
 
-      attr_reader :write
-
       def add_read!(site, ep, &ctn)
-        @read[site] ||= {}
-        @read[site][ep] = ctn
-        @write[site] ||= Type.bot
-        ctn[@write[site], ep]
+        entry = @tbl[site] ||= Entry.new(false, {}, Type.bot, Utils::MutableSet.new)
+        entry.read_continuations[ep] = ctn
+        entry.absolute_paths << ep.ctx.iseq.absolute_path
+        ctn[entry.type, ep]
       end
 
-      def add_write!(site, ty, &ctn)
-        @write[site] ||= Type.bot
-        @write[site] = @write[site].union(ty)
-        @read[site] ||= {}
-        @read[site].each do |ep, ctn|
+      def add_write!(site, ty, ep, scratch)
+        entry = @tbl[site] ||= Entry.new(!ep, {}, Type.bot, Utils::MutableSet.new)
+        if ep
+          if entry.rbs_declared
+            if !entry.type.consistent?(ty, {})
+              scratch.warn(ep, "inconsistent assignment to RBS-declared global variable")
+              return
+            end
+          end
+          entry.absolute_paths << ep.ctx.iseq.absolute_path
+        end
+        entry.type = entry.type.union(ty)
+        entry.read_continuations.each do |ep, ctn|
           ctn[ty, ep]
         end
       end
+
+      def dump
+        @tbl
+      end
     end
 
     def get_ivar(recv)
@@ -637,11 +657,11 @@ module TypeProf
       end
     end
 
-    def add_ivar_write!(recv, var, ty, &ctn)
+    def add_ivar_write!(recv, var, ty, ep)
       recv.each_child do |recv|
         class_def, singleton = get_ivar(recv)
         next unless class_def
-        class_def.ivars.add_write!([singleton, var], ty, &ctn)
+        class_def.ivars.add_write!([singleton, var], ty, ep, self)
       end
     end
 
@@ -653,11 +673,11 @@ module TypeProf
       end
     end
 
-    def add_cvar_write!(klass, var, ty, &ctn)
+    def add_cvar_write!(klass, var, ty, ep)
       klass.each_child do |klass|
         class_def = @class_defs[klass.idx]
         next unless class_def
-        class_def.cvars.add_write!(var, ty, &ctn)
+        class_def.cvars.add_write!(var, ty, ep, self)
       end
     end
 
@@ -665,8 +685,8 @@ module TypeProf
       @gvar_table.add_read!(var, ep, &ctn)
     end
 
-    def add_gvar_write!(var, ty, &ctn)
-      @gvar_table.add_write!(var, ty, &ctn)
+    def add_gvar_write!(var, ty, ep)
+      @gvar_table.add_write!(var, ty, ep, self)
     end
 
     def error(ep, msg)
@@ -709,7 +729,7 @@ module TypeProf
           gid = @alloc_site_to_global_id[id]
           if gid
             ty = globalize_type(elems.to_local_type(id), env, ep)
-            add_ivar_write!(*gid, ty)
+            add_ivar_write!(*gid, ty, ep)
           end
           menv
         end
@@ -721,7 +741,7 @@ module TypeProf
         gid = @alloc_site_to_global_id[id]
         if gid
           ty = globalize_type(elems.to_local_type(id), env, ep)
-          add_ivar_write!(*gid, ty)
+          add_ivar_write!(*gid, ty, ep)
         end
         env
       end
@@ -749,18 +769,25 @@ module TypeProf
     end
 
     def type_profile
-      counter = 0
+      time = Time.now
+      step_counter = 0
       stat_eps = Utils::MutableSet.new
       while true
         until @worklist.empty?
-          counter += 1
-          if counter % 1000 == 0 && Config.verbose >= 1
-            puts "iter %d, remain: %d" % [counter, @worklist.size]
-            #exit if counter == 20000
-          end
           @ep = @worklist.deletemin
+
+          step_counter += 1
+          if Config.verbose >= 1
+            time2 = Time.now
+            if time2 - time >= 1
+              time = time2
+              $stderr << "\rType Profiling... (%d steps @ %s)\e[K" % [step_counter, @ep.source_location]
+              $stderr.flush
+            end
+          end
+
           stat_eps << @ep
-          step(@ep) # TODO: deletemin
+          step(@ep)
         end
 
         # XXX: it would be good to provide no-dummy-execution mode.
@@ -820,6 +847,7 @@ module TypeProf
           end
         end
       end
+      $stderr.print "\r\e[K" if Config.verbose >= 1
 
       stat_eps
     end
@@ -829,7 +857,7 @@ module TypeProf
 
       Reporters.show_reveal_types(self, @reveal_types, output)
 
-      Reporters.show_gvars(self, @gvar_table.write, output)
+      Reporters.show_gvars(self, @gvar_table, output)
 
       #RubySignatureExporter2.new(
       #  self, @include_relations, @ivar_table.write, @cvar_table.write, @class_defs
@@ -895,7 +923,7 @@ module TypeProf
 
     def set_instance_variable(recv, var, ty, ep, env)
       ty = globalize_type(ty, env, ep)
-      add_ivar_write!(recv, var, ty)
+      add_ivar_write!(recv, var, ty, ep)
     end
 
     def step(ep)
@@ -985,6 +1013,7 @@ module TypeProf
         recv = env.static_env.recv_ty
         if cref.klass.is_a?(Type::Class)
           typed_mdef = check_typed_method(cref.klass, mid, ep.ctx.cref.singleton)
+          recv = Type::Instance.new(recv) if recv.is_a?(Type::Class)
           if typed_mdef
             mdef = ISeqMethodDef.new(iseq, cref)
             typed_mdef.each do |typed_mdef|
@@ -1000,7 +1029,6 @@ module TypeProf
               end
             end
 
-            recv = Type::Instance.new(recv) if recv.is_a?(Type::Class)
             pend_method_execution(iseq, meth, recv, mid, ep.ctx.cref)
           end
         else
@@ -1058,7 +1086,7 @@ module TypeProf
               if cbase == Type.any
                 klass = Type.any
               else
-                klass = new_class(cbase, id, [], superclass)
+                klass = new_class(cbase, id, [], superclass, ep.ctx.iseq.absolute_path)
               end
             end
           end
@@ -1284,7 +1312,7 @@ module TypeProf
         cbase = ep.ctx.cref.klass
         ty = globalize_type(ty, env, ep)
         # TODO: if superclass has the variable, it should be updated
-        add_cvar_write!(cbase, var, ty)
+        add_cvar_write!(cbase, var, ty, ep)
 
       when :getclassvariable
         var, = operands
@@ -1300,7 +1328,7 @@ module TypeProf
         var, = operands
         env, (ty,) = env.pop(1)
         ty = globalize_type(ty, env, ep)
-        add_gvar_write!(var, ty)
+        add_gvar_write!(var, ty, ep)
 
       when :getglobal
         var, = operands
@@ -1311,7 +1339,6 @@ module TypeProf
           env = env.push(ty)
         else
           add_gvar_read!(var, ep) do |ty, ep|
-            ty = Type.nil if ty == Type.bot # HACK
             nenv, ty = localize_type(ty, env, ep)
             merge_env(ep.next, nenv.push(ty))
           end
@@ -1754,7 +1781,7 @@ module TypeProf
           meth.do_send(recv, mid, aargs, ep, env, self, &ctn)
         end
       else
-        if recv != Type.any # XXX: should be configurable
+        if recv != Type.any
           error(ep, "undefined method: #{ globalize_type(recv, env, ep).screen_name(self) }##{ mid }")
         end
         ctn[Type.any, ep, env]
@@ -1773,6 +1800,7 @@ module TypeProf
         blk_env = blk_env.replace_recv_ty(replace_recv_ty) if replace_recv_ty
         arg_blk = aargs.blk_ty
         aargs_ = aargs.lead_tys.map {|aarg| globalize_type(aarg, env, ep) }
+        # XXX: aargs.opt_tys and aargs.kw_ty
         argc = blk_iseq.fargs_format[:lead_num] || 0
         # actual argc == 1, not array, formal argc == 1: yield 42         => do |x|   : x=42
         # actual argc == 1,     array, formal argc == 1: yield [42,43,44] => do |x|   : x=[42,43,44]
@@ -1823,7 +1851,7 @@ module TypeProf
         locals = [Type.nil] * blk_iseq.locals.size
         locals[blk_iseq.fargs_format[:block_start]] = arg_blk if blk_iseq.fargs_format[:block_start]
         env_blk = blk_env.static_env.blk_ty
-        nfargs = FormalArguments.new(aargs_, [], nil, [], nil, nil, env_blk) # XXX: aargs_ -> fargs
+        nfargs = FormalArguments.new(aargs_, [], nil, [], nil, nil, env_blk)
         nctx = Context.new(blk_iseq, blk_ep.ctx.cref, nil)
         nep = ExecutionPoint.new(nctx, 0, blk_ep)
         nenv = Env.new(blk_env.static_env, locals, [], nil)