steep 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30d4bfab06e5fe0027f3e2cd8d7570fa5b887d7c4ac177c6cfed0003d71f77b7
-  data.tar.gz: ab030947cb032f0fcbb3e9ca7febf38ad489ee4ab21a4a798fb620e9db807ead
+  metadata.gz: b3a5b5a55253f50083410cd7d58bf7cda545301d9a7d5b72a5a8fd3865a76e93
+  data.tar.gz: fcf1273fc81c720266d4cdf2456d996b8f406137b204bb22fe1ad25852850a0a
 SHA512:
-  metadata.gz: cec192c40e6de3ea830b3aa6c2f2cdb619b00af8a75c2a754f8302f94423c7f9f098b3e48e44568c967c38c4f34da19309b74999c8efe5e7636e4714375b9c59
-  data.tar.gz: b39f4f9f986b70426c5f0738840222f9a8241a4bf42df04d2aa17388f2d6a69014e91442a3021fbc8c1f269cf94361b0786a83d5b61e4557af36e773c7ad66d3
+  metadata.gz: a6e6dc76cf7aaf2cdf97965733d6762a1fb75d314d0dd8f859cc617296a433a002a512c829828a927bc43718e2f44776332f1c739d894460d8828195853a24c9
+  data.tar.gz: c3daca75b0a4846302665a9d165f13de175e1e5436d3605fa5c53948bc5548b1a36a19a43e4200d4f3b37ce257e8369ec645602ccb15b419b5fae0f1c34e39b1

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        container_tag:
+        - 2.6.5-bionic
+        - 2.7.0-bionic
+    container:
+      image: rubylang/ruby:${{ matrix.container_tag }}
+    steps:
+    - uses: actions/checkout@v1
+    - name: Run test
+      run: |
+        ruby -v
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bin/setup
+        bundle exec rake build test smoke

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/ruby-signature"]
+	path = vendor/ruby-signature
+	url = https://github.com/ruby/ruby-signature.git

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## master
 
+## 0.12.0 (2020-02-11)
+
+* Add `Steepfile` for configuration
+* Use the latest version of `ruby-signature`
+
 ## 0.11.1 (2019-07-15)
 
 * Relax activesupport versnion requirement (#90)

data/README.md

@@ -8,32 +8,51 @@ Install via RubyGems.
 
 ### Requirements
 
-Steep requires Ruby 2.5.
+Steep requires Ruby 2.6.
 
 ## Usage
 
 Steep does not infer types from Ruby programs, but requires declaring types and writing annotations.
 You have to go on the following three steps.
 
+### 0. `steep init`
+
+Run `steep init` to generate a configuration file.
+
+```
+$ steep init       # Generates Steepfile
+```
+
+Edit the `Steepfile`:
+
+```rb
+target :app do
+  check "lib"
+  signature "sig"
+
+  library "set", "pathname"
+end
+```
+
 ### 1. Declare Types
 
-Declare types in `.rbi` files in `sig` directory.
+Declare types in `.rbs` files in `sig` directory.
 
 ```
 class Person
   @name: String
-  @contacts: Array<Email | Phone>
+  @contacts: Array[Email | Phone]
 
-  def initialize: (name: String) -> any
+  def initialize: (name: String) -> untyped
   def name: -> String
-  def contacts: -> Array<Email | Phone>
+  def contacts: -> Array[Email | Phone]
   def guess_country: -> (String | nil)
 end
 
 class Email
   @address: String
 
-  def initialize: (address: String) -> any
+  def initialize: (address: String) -> untyped
   def address: -> String
 end
 
@@ -41,15 +60,15 @@ class Phone
   @country: String
   @number: String
 
-  def initialize: (country: String, number: String) -> any
+  def initialize: (country: String, number: String) -> untyped
   def country: -> String
   def number: -> String
 
-  def self.countries: -> Hash<String, String>
+  def self.countries: -> Hash[String, String]
 end
 ```
 
-* You can use simple *generics*, like `Hash<String, String>`.
+* You can use simple *generics*, like `Hash[String, String]`.
 * You can use *union types*, like `Email | Phone`.
 * You have to declare not only public methods but also private methods and instance variables.
 * You can declare *singleton methods*, like `self.countries`.
@@ -95,7 +114,7 @@ class Email
   end
 
   def ==(other)
-    # `other` has type of `any`, which means type checking is skipped.
+    # `other` has type of `untyped`, which means type checking is skipped.
     # No type errors can be detected in this method.
     other.is_a?(self.class) && other.address == address
   end
@@ -114,7 +133,7 @@ class Phone
   end
 
   def ==(other)
-    # You cannot use `case` for type case because `other` has type of `any`, not a union type.
+    # You cannot use `case` for type case because `other` has type of `untyped`, not a union type.
     # You have to explicitly declare the type of `other` in `if` expression.
 
     if other.is_a?(Phone)
@@ -134,38 +153,38 @@ end
 Run `steep check` command to type check. 💡
 
 ```
-$ steep check lib
+$ steep check
 lib/phone.rb:46:0: MethodDefinitionMissing: module=::Phone, method=self.countries (class Phone)
 ```
 
 You now find `Phone.countries` method is not implemented yet. 🙃
 
-## Scaffolding
+## Prototyping signature
 
-You can use `steep scaffold` command to generate a signature declaration.
+You can use `rbs prototype` command to generate a signature declaration.
 
 ```
-$ steep scaffold lib/*.rb
+$ rbs prototype rb lib/person.rb lib/email.rb lib/phone.rb
 class Person
-  @name: any
-  @contacts: Array<any>
-  def initialize: (name: any) -> Array<any>
-  def guess_country: () -> any
+  @name: untyped
+  @contacts: Array[untyped]
+  def initialize: (name: untyped) -> Array[untyped]
+  def guess_country: () -> untyped
 end
 
 class Email
-  @address: any
-  def initialize: (address: any) -> any
-  def ==: (any) -> any
-  def hash: () -> any
+  @address: untyped
+  def initialize: (address: untyped) -> untyped
+  def ==: (untyped) -> untyped
+  def hash: () -> untyped
 end
 
 class Phone
-  @country: any
-  @number: any
-  def initialize: (country: any, number: any) -> any
-  def ==: (any) -> void
-  def hash: () -> any
+  @country: untyped
+  @number: untyped
+  def initialize: (country: untyped, number: untyped) -> untyped
+  def ==: (untyped) -> void
+  def hash: () -> untyped
 end
 ```
 
@@ -179,68 +198,7 @@ Because it just prints all `def`s, you may find some odd points:
 
 Generally, these are by our design.
 
-## Commandline
-
-`steep check` is the command to run type checking.
-
-### Signature Directory
-
-Use `-I` option to specify signature file or signature directory.
-
-    $ steep check -I my-types.rbi test.rb
-
-If you don't specify `-I` option, it assumes `sig` directory.
-
-### Detecting Fallback
-
-When Steep finds an expression which cannot be typed, it assumes the type of the node is *any*.
-*any* type does not raise any type error so that fallback to *any* may hide some type errors.
-
-Using `--fallback-any-is-error` option prints the fallbacks.
-
-    $ steep check --fallback-any-is-error test.rb
-
-### Dump All Types
-
-When you are debugging, printing all types of all node in the source code may help.
-
-Use `--dump-all-types` for that.
-
-    $ steep check --dump-all-types test.rb
-
-### Verbose Option
-
-Try `-v` option to report more information about type checking.
-
-### Loading Type definitions from Gems
-
-You can pass `-G` option to specify name of gems to load type definitions.
-
-```
-$ steep check -G strong_json lib
-```
-
-When you are using bundler, Steep load type definitions from bundled gems automatically.
-
-```
-$ bundle exec steep check lib
-```
-
-To disable automatic gem detection from bundler, you can specify `--no-bundler` option.
-
-```
-$ bundle exec steep check --no-bundler -G strong_json lib
-```
-
-## Making a Gem with Type Definition
-
-Put your type definition file in a directory, ship that in your gem, and let `metadata` of the gemspec to contain `"steep_types" => dir_name`.
-
-```rb
-spec.metadata = { "steep_types" => "sig" }
-```
-
-We recommend using `sig` as a name of the directory for type definitions, but you can use any directory.
+`rbs prototype` offers options: `rbi` to generate prototype from Sorbet RBI and `runtime` to generate from runtime API.
 
 ## Examples
 

data/Rakefile

@@ -8,15 +8,19 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
-task :build => :racc
-task :test => :racc
-task :install => :racc
+task :build => :parser
+task :test => :parser
+task :install => [:reset, :parser]
 
-rule /\.rb/ => ".y" do |t|
-  sh "racc", "-v", "-o", "#{t.name}", "#{t.source}"
+task :parser do
+  Dir.chdir "vendor/ruby-signature" do
+    sh "bundle exec rake parser"
+  end
 end
 
-task :racc => "lib/steep/parser.rb"
+task :reset do
+  sh "git submodule update -f --init"
+end
 
 task :smoke do
   sh "bundle", "exec", "bin/smoke_runner.rb", *Dir.glob("smoke/*")

data/Steepfile

@@ -0,0 +1 @@
+target :app do end

data/bin/setup

@@ -6,3 +6,4 @@ set -vx
 bundle install
 
 # Do any other automated setup that you need to do here
+bundle exec rake reset parser

data/bin/smoke_runner.rb

@@ -2,9 +2,11 @@
 
 require "pathname"
 
+$LOAD_PATH << Pathname(__dir__) + '../vendor/ruby-signature/lib'
 $LOAD_PATH << Pathname(__dir__) + "../lib"
 
 require "steep"
+require "steep/cli"
 require "rainbow"
 require "optparse"
 
@@ -44,7 +46,7 @@ ARGV.each do |arg|
           message = src.gsub!(/\A!expects\*(@\+\d+)? +/, '')
           line = comment.location.line
 
-          expectations << Expectation.new(line+offset, message, file).tap {|e| e.prefix_test = true }
+          expectations << Expectation.new(line+offset, message, file.relative_path_from(dir)).tap {|e| e.prefix_test = true }
         end
 
         if src =~ /!expects(@(\+\d+))?/
@@ -52,11 +54,11 @@ ARGV.each do |arg|
           message = src.gsub!(/\A!expects(@\+\d+)? +/, '')
           line = comment.location.line
 
-          expectations << Expectation.new(line+offset, message, file)
+          expectations << Expectation.new(line+offset, message, file.relative_path_from(dir))
         end
 
         if src =~ /ALLOW FAILURE/
-          allowed_paths << file
+          allowed_paths << file.relative_path_from(dir)
         end
       end
 
@@ -67,18 +69,11 @@ ARGV.each do |arg|
   stderr = StringIO.new
   stdout = StringIO.new
 
-  builtin = Pathname(__dir__) + "../stdlib"
   begin
-    driver = Steep::Drivers::Check.new(source_paths: rb_files,
-                                       signature_dirs: [builtin, dir],
-                                       stdout: stdout,
-                                       stderr: stderr)
-
-    driver.fallback_any_is_error = false
-    driver.allow_missing_definitions = false
-
     Rainbow.enabled = false
-    driver.run
+    Dir.chdir(arg) do
+      Steep::Drivers::Check.new(stdout: stdout, stderr: stderr).run
+    end
   rescue => exn
     puts "ERROR: #{exn.inspect}"
     exn.backtrace.each do |loc|
@@ -100,7 +95,7 @@ ARGV.each do |arg|
     end
   end
 
-  lines = stdout.string.each_line.to_a.map(&:chomp)
+  lines = stdout.string.each_line.to_a.map(&:chomp).reject {|line| line =~ /\bFallbackAny\b/ }
 
   expectations.each do |expectation|
     deleted = lines.reject! do |string|

data/exe/rbs

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+load File.join(__dir__, "../vendor/ruby-signature/exe/ruby-signature")

data/exe/ruby-signature

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+load File.join(__dir__, "../vendor/ruby-signature/exe/ruby-signature")

data/exe/steep

@@ -2,6 +2,7 @@
 
 require 'pathname'
 
+$LOAD_PATH << Pathname(__dir__) + "../vendor/ruby-signature/lib"
 $LOAD_PATH << Pathname(__dir__) + "../lib"
 
 require 'steep'

data/lib/steep.rb

@@ -11,6 +11,8 @@ require "listen"
 require 'pry'
 require 'language_server-protocol'
 
+require "ruby/signature"
+
 require "steep/ast/namespace"
 require "steep/names"
 require "steep/ast/location"
@@ -32,29 +34,16 @@ require "steep/ast/types/boolean"
 require "steep/ast/types/tuple"
 require "steep/ast/types/proc"
 require "steep/ast/types/record"
-require "steep/ast/method_type"
 require "steep/ast/type_params"
-require "steep/ast/signature/class"
-require "steep/ast/signature/module"
-require "steep/ast/signature/members"
-require "steep/ast/signature/extension"
-require "steep/ast/signature/interface"
-require "steep/ast/signature/env"
-require "steep/ast/signature/const"
-require "steep/ast/signature/gvar"
-require "steep/ast/signature/alias"
 require "steep/ast/annotation"
 require "steep/ast/annotation/collection"
 require "steep/ast/buffer"
 require "steep/ast/builtin"
+require "steep/ast/types/factory"
 
 require "steep/interface/method_type"
-require "steep/interface/method"
-require "steep/interface/builder"
 require "steep/interface/substitution"
-require "steep/interface/abstract"
-require "steep/interface/instantiated"
-require "steep/interface/ivar_chain"
+require "steep/interface/interface"
 
 require "steep/subtyping/check"
 require "steep/subtyping/result"
@@ -65,8 +54,9 @@ require "steep/subtyping/variable_variance"
 require "steep/subtyping/variable_occurrence"
 
 require "steep/signature/errors"
-require "steep/parser"
+require "steep/signature/validator"
 require "steep/source"
+require "steep/annotation_parser"
 require "steep/typing"
 require "steep/errors"
 require "steep/type_construction"
@@ -74,19 +64,25 @@ require "steep/type_inference/send_args"
 require "steep/type_inference/block_params"
 require "steep/type_inference/constant_env"
 require "steep/type_inference/type_env"
+require "steep/ast/types"
 
 require "steep/project"
 require "steep/project/file"
-require "steep/project/listener"
 require "steep/project/options"
-require "steep/drivers/utils/each_signature"
+require "steep/project/target"
+require "steep/project/dsl"
+require "steep/project/file_loader"
+require "steep/drivers/utils/driver_helper"
 require "steep/drivers/check"
 require "steep/drivers/validate"
 require "steep/drivers/annotations"
-require "steep/drivers/scaffold"
-require "steep/drivers/print_interface"
 require "steep/drivers/watch"
 require "steep/drivers/langserver"
+require "steep/drivers/signature_error_printer"
+require "steep/drivers/trace_printer"
+require "steep/drivers/print_project"
+require "steep/drivers/init"
+require "steep/drivers/vendor"
 
 if ENV["NO_COLOR"]
   Rainbow.enabled = false
@@ -94,16 +90,26 @@ end
 
 module Steep
   def self.logger
-    self.log_output = STDERR unless @logger
-
     @logger
   end
 
+  def self.new_logger(output, prev_level)
+    ActiveSupport::TaggedLogging.new(Logger.new(output)).tap do |logger|
+      logger.push_tags "Steep #{VERSION}"
+      logger.level = prev_level || Logger::WARN
+    end
+  end
+
+  def self.log_output
+    @log_output
+  end
+
   def self.log_output=(output)
+    @log_output = output
     prev_level = @logger&.level
-
-    @logger = ActiveSupport::TaggedLogging.new(Logger.new(output))
-    @logger.push_tags "Steep #{VERSION}"
-    @logger.level = prev_level || Logger::WARN
+    @logger = new_logger(output, prev_level)
   end
+
+  @logger = nil
+  self.log_output = STDERR
 end