steep 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5bc8e25ce0d9d4c9946d0100d3a011ca486086997b4ba86644939cfed1a9b08
-  data.tar.gz: 7d4c26a383e9387a9f4c15c09f488eb24dc5d7ede91b9acc8da1d033f32389ff
+  metadata.gz: 123376eb779b7118cfc9fb097cbd2bd028c4ce154526d5c79339902b170ad2c3
+  data.tar.gz: b6b4c6e49b3f998103582a7c416a5f3603cb9204ab672b2c4b4f911eebc8adcb
 SHA512:
-  metadata.gz: d491cda774d07a99a41be32e9bf7559104d84a68bb36ba590e70d1592a1a4cda40a1bba416c50969279b7e6c1cfd3f4b80274d32e7ef29fa8b71851de4d214f7
-  data.tar.gz: 5140446569e665f76971fbf4dec158a664f8e2e4ae32339480069288c1e3fdbbc50237db5999c3f9d124190859a334696dcb579f09009762c25aa5bdd3361edc
+  metadata.gz: 0f5df26d1601a390adba84efabadd1a6947c601df83ab48fb538dea000b1cc05bb26dffd894f2c7c8c198c2c63e54972e695390de21b9580249b283e6a54d3d4
+  data.tar.gz: c8e99c6e9247fbec030279f02891ba2aa6d2b217b7c8a61f9decc0afa308841245088785e21590858cc5e73f79827cf1515f4e9fa399ffcab18637e6851ac292

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 0.3.0 (2018-05-31)
+
+* Add `interface` command to print interface built for given type
+* Add `--strict` option for `check` command
+* Fix `scaffold` command for empty class/modules
+* Type check method definition with empty body
+* Add `STDOUT` and `StringIO` minimal definition
+* Fix validate command to load stdlib
+* Fix parsing keyword argument type
+
 ## 0.2.0 (2018-05-30)
 
 * Add `attr_reader` and `attr_accessor` syntax to signature (#33)

data/lib/steep.rb

@@ -70,6 +70,7 @@ require "steep/drivers/check"
 require "steep/drivers/validate"
 require "steep/drivers/annotations"
 require "steep/drivers/scaffold"
+require "steep/drivers/print_interface"
 
 if ENV["NO_COLOR"]
   Rainbow.enabled = false

data/lib/steep/cli.rb

@@ -16,7 +16,7 @@ module Steep
     end
 
     def self.available_commands
-      [:check, :validate, :annotations, :scaffold]
+      [:check, :validate, :annotations, :scaffold, :interface]
     end
 
     def setup_global_options
@@ -47,12 +47,14 @@ module Steep
       no_builtin = false
       dump_all_types = false
       fallback_any_is_error = false
+      strict = false
 
       OptionParser.new do |opts|
         opts.on("-I [PATH]") {|path| signature_dirs << Pathname(path) }
         opts.on("--no-builtin") { no_builtin = true }
         opts.on("--verbose") { verbose = true }
         opts.on("--dump-all-types") { dump_all_types = true }
+        opts.on("--strict") { strict = true }
         opts.on("--fallback-any-is-error") { fallback_any_is_error = true }
       end.parse!(argv)
 
@@ -72,15 +74,17 @@ module Steep
       Drivers::Check.new(source_paths: source_paths, signature_dirs: signature_dirs, stdout: stdout, stderr: stderr).tap do |check|
         check.verbose = verbose
         check.dump_all_types = dump_all_types
-        check.fallback_any_is_error = fallback_any_is_error
+        check.fallback_any_is_error = fallback_any_is_error || strict
       end.run
     end
 
     def process_validate
       verbose = false
+      no_builtin = false
 
       OptionParser.new do |opts|
         opts.on("--verbose") { verbose = true }
+        opts.on("--no-builtin") { no_builtin = true }
       end.parse!(argv)
 
       signature_dirs = argv.map {|path| Pathname(path) }
@@ -88,6 +92,10 @@ module Steep
         signature_dirs << Pathname(".")
       end
 
+      unless no_builtin
+        signature_dirs.unshift Pathname(__dir__).join("../../stdlib").realpath
+      end
+
       Drivers::Validate.new(signature_dirs: signature_dirs, stdout: stdout, stderr: stderr).tap do |validate|
         validate.verbose = verbose
       end.run
@@ -102,5 +110,21 @@ module Steep
       source_paths = argv.map {|file| Pathname(file) }
       Drivers::Scaffold.new(source_paths: source_paths, stdout: stdout, stderr: stderr).run
     end
+
+    def process_interface
+      signature_dirs = []
+      no_builtin = false
+
+      OptionParser.new do |opts|
+        opts.on("-I [PATH]") {|path| signature_dirs << Pathname(path) }
+        opts.on("--no-builtin") { no_builtin = true }
+      end
+
+      unless no_builtin
+        signature_dirs.unshift Pathname(__dir__).join("../../stdlib").realpath
+      end
+
+      Drivers::PrintInterface.new(type_name: argv.first, signature_dirs: signature_dirs, stdout: stdout, stderr: stderr).run
+    end
   end
 end

data/lib/steep/drivers/print_interface.rb

@@ -0,0 +1,60 @@
+module Steep
+  module Drivers
+    class PrintInterface
+      attr_reader :type_name
+      attr_reader :signature_dirs
+      attr_reader :stdout
+      attr_reader :stderr
+
+      include Utils::EachSignature
+
+      def initialize(type_name:, signature_dirs:, stdout:, stderr:)
+        @type_name = type_name
+        @signature_dirs = signature_dirs
+        @stdout = stdout
+        @stderr = stderr
+      end
+
+      def run
+        if type_name
+          type = Parser.parse_type(type_name)
+
+          env = AST::Signature::Env.new
+
+          each_signature(signature_dirs, false) do |signature|
+            env.add signature
+          end
+
+          begin
+            builder = Interface::Builder.new(signatures: env)
+            check = Subtyping::Check.new(builder: builder)
+
+            interface = check.resolve(type, with_initialize: true)
+
+            stdout.puts "#{type}"
+            stdout.puts "- Instance variables:"
+            interface.ivars.each do |name, type|
+              puts "  - #{name}: #{type}"
+            end
+            stdout.puts "- Methods:"
+            interface.methods.each do |name, method|
+              puts "  - #{Rainbow(name).blue}:"
+              method.types.each do |method_type|
+                loc = if method_type.location
+                        "#{method_type.location.buffer.name}:#{method_type.location.to_s}"
+                      else
+                        "no location"
+                      end
+                puts "    - #{Rainbow(method_type.to_s).red} (#{loc})"
+              end
+            end
+          rescue Steep::Subtyping::Check::CannotResolveError
+            stderr.puts "🤔 #{Rainbow(type.to_s).red} cannot be resolved to interface"
+          end
+        else
+          stderr.puts "Pass a type name to command line"
+        end
+      end
+    end
+  end
+end

data/lib/steep/drivers/scaffold.rb

@@ -45,6 +45,12 @@ module Steep
           def module?
             kind == :module
           end
+
+          attr_accessor :has_subclass
+
+          def namespace_class?
+            has_subclass && methods.empty? && singleton_methods.empty?
+          end
         end
 
         attr_reader :source
@@ -63,7 +69,7 @@ module Steep
           generate(source.node, current_path: [])
 
           modules.each do |mod|
-            unless mod.methods.empty? && mod.singleton_methods.empty?
+            unless mod.namespace_class?
               io.puts "#{mod.kind} #{mod.name}"
 
               mod.ivars.each do |name, type|
@@ -119,6 +125,10 @@ module Steep
                        current_module: mod)
             end
 
+            if current_module
+              current_module.has_subclass = true
+            end
+
           when :class
             name = module_name(node.children[0])
             klass = Module.new(name: full_name(current_path, name), kind: :class)
@@ -130,6 +140,10 @@ module Steep
                        current_module: klass)
             end
 
+            if current_module
+              current_module.has_subclass = true
+            end
+
           when :def
             name, args, body = node.children
 

data/lib/steep/parser.y

@@ -7,6 +7,7 @@ rule
 target: type_METHOD method_type { result = val[1] }
       | type_SIGNATURE signatures { result = val[1] }
       | type_ANNOTATION annotation { result = val[1] }
+      | type_TYPE type { result = val[1] }
 
 method_type:
   type_params params block_opt ARROW return_type {
@@ -202,6 +203,8 @@ keyword: IDENT
        | INSTANCE
        | BLOCK
        | INCLUDE
+       | IVAR
+       | SELF
 
 signatures: { result = [] }
           | interface signatures { result = [val[0]] + val[1] }
@@ -545,6 +548,10 @@ rescue => exn
   nil
 end
 
+def self.parse_type(input, name: nil)
+  new(:TYPE, buffer: AST::Buffer.new(name: name, content: input), offset: 0).do_parse
+end
+
 class LocatedValue
   attr_reader :location
   attr_reader :value

data/lib/steep/type_construction.rb

@@ -647,6 +647,20 @@ module Steep
             else
               new.synthesize(node.children[2])
             end
+          else
+            return_type = new.method_context&.return_type
+            if return_type && !return_type.is_a?(AST::Types::Void)
+              result = checker.check(
+                Subtyping::Relation.new(sub_type: Types.nil_instance, super_type: return_type),
+                constraints: Subtyping::Constraints.empty
+              )
+              if result.failure?
+                typing.add_error(Errors::MethodBodyTypeMismatch.new(node: node,
+                                                                    expected: return_type,
+                                                                    actual: Types.nil_instance,
+                                                                    result: result))
+              end
+            end            
           end
 
           if module_context

data/lib/steep/version.rb

@@ -1,3 +1,3 @@
 module Steep
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/smoke/stdout/a.rb

@@ -0,0 +1,8 @@
+class A
+  def write_to(io:)
+    io.puts "Hello World"
+  end
+end
+
+A.new(STDOUT)
+A.new(StringIO.new)

data/smoke/stdout/a.rbi

@@ -0,0 +1,7 @@
+interface _Puts
+  def puts: (*any) -> void
+end
+
+class A
+  def write_to: (io: _Puts) -> void
+end

data/stdlib/builtin.rbi

@@ -532,7 +532,12 @@ end
 class Regexp
 end
 
-class File
+class IO
+  def gets: -> (String | nil)
+  def puts: (*any) -> void
+end
+
+class File <: IO
   def self.binread: (String) -> String
   def self.extname: (String) -> String
   def self.basename: (String) -> String
@@ -541,3 +546,10 @@ class File
   def self.read: (String) -> String
                | (String, Integer | nil) -> (String | nil)
 end
+
+STDOUT: IO
+
+class StringIO
+  def initialize: (?String, ?String) -> any
+  def puts: (*any) -> void
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steep
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,6 +170,7 @@ files:
 - lib/steep/cli.rb
 - lib/steep/drivers/annotations.rb
 - lib/steep/drivers/check.rb
+- lib/steep/drivers/print_interface.rb
 - lib/steep/drivers/scaffold.rb
 - lib/steep/drivers/utils/each_signature.rb
 - lib/steep/drivers/utils/validator.rb
@@ -253,6 +254,8 @@ files:
 - smoke/rescue/a.rb
 - smoke/self/a.rb
 - smoke/self/a.rbi
+- smoke/stdout/a.rb
+- smoke/stdout/a.rbi
 - smoke/super/a.rb
 - smoke/super/a.rbi
 - smoke/type_case/a.rb