steep 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91398a985c422d844373a28dadd59f8e55b73e8f
+  data.tar.gz: bdf3272c32938f7b5e762cfffce099b26630115b
+SHA512:
+  metadata.gz: 1345b14455a625814b4beafcab5ad3327f47b2dd0be200a5ecbc73157c83ab8074b6069a80acffb8fe563987c042f133820c33c07d1a7baa4039d29e35438735
+  data.tar.gz: 455b3c6502ef94579bb859f12cbaca314285f426cf1a0b3cf5a9cad0c1533664738f8674b20ebde46ef8b8fcaa443ace1ece38f57922e5427465771afbf98f77

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/lib/steep/parser.output
+/lib/steep/parser.rb

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7
+script: bundle exec rake test smoke

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in steep.gemspec
+gemspec

data/README.md

@@ -0,0 +1,95 @@
+# Steep - Gradual Typing for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'steep'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install steep
+
+## Usage
+
+Run `steep check` command in project dir.
+
+```
+$ steep check
+$ steep check lib
+```
+
+It loads signatures from the global registry and `sig` dir in current dir.
+If you want to load signuatres from dir different from `sig`, pass `-I` parameter.
+
+```
+$ steep check -I signauture -I sig .
+```
+
+Note that when `-I` option is given, `steep` does not load signatures from `sig` dir.
+
+## Type Annotations
+
+You have to write type annotations in your Ruby program.
+
+```rb
+# @import ActiveRecord.Try
+
+class Foo
+  # @class Foo<A> extends Object
+  
+  # @attribute results: (readonly) Array<A>
+  attr_reader :results
+  
+  # @type initialize: () -> _
+  def initialize()
+    @results = []
+  end
+  
+  # @type plus: (Addable<X, A>, X) -> A
+  def plus(x, y)
+    (x + y).try do |a|
+      results << a
+      a
+    end
+  end
+end
+```
+
+## Signature
+
+Steep does not allow types to be constructed from Ruby programs.
+You have to write down signatures by yourself.
+
+### Signature Scaffolding
+
+Steep allows generate a *scaffold* from Ruby programs.
+
+```
+$ steep scaffold lib/**/*.rb
+```
+
+The generated scaffold includes:
+
+* Signature definition for each class/module defined in the given program
+* Method definition stub for each method
+
+The scaffold may be a good starting point for writing signatures.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/steep.
+

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+task :build => :racc
+task :test => :racc
+task :install => :racc
+
+rule /\.rb/ => ".y" do |t|
+  sh "racc", "-v", "-o", "#{t.name}", "#{t.source}"
+end
+
+task :racc => "lib/steep/parser.rb"
+
+task :smoke do
+  sh "bundle", "exec", "bin/smoke_runner.rb", *Dir.glob("smoke/*")
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "steep"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/smoke_runner.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+require "pathname"
+
+$LOAD_PATH << Pathname(__dir__) + "../lib"
+
+require "steep"
+require "rainbow"
+require "optparse"
+
+verbose = false
+
+OptionParser.new do |opts|
+  opts.on("-v", "--verbose") do verbose = true end
+end.parse!(ARGV)
+
+Expectation = Struct.new(:line, :message)
+
+failed = false
+
+ARGV.each do |arg|
+  dir = Pathname(arg)
+  puts "🏇 Running smoke test in #{dir}..."
+
+  rb_files = []
+  expectations = []
+
+  dir.children.each do |file|
+    if file.extname == ".rb"
+      buffer = ::Parser::Source::Buffer.new(file.to_s)
+      buffer.source = file.read
+      parser = ::Parser::CurrentRuby.new
+
+      _, comments, _ = parser.tokenize(buffer)
+      comments.each do |comment|
+        src = comment.text.gsub(/\A#\s*/, '')
+
+        if src =~ /!expects(@(\+\d+))?/
+          offset = $2&.to_i || 1
+          message = src.gsub!(/\A!expects(@\+\d+)? +/, '')
+          line = comment.location.line
+
+          expectations << Expectation.new(line+offset, message)
+        end
+      end
+
+      rb_files << file
+    end
+  end
+
+  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.run
+  rescue => exn
+    puts "ERROR: #{exn.inspect}"
+    exn.backtrace.each do |loc|
+      puts "  #{loc}"
+    end
+
+    failed = true
+  end
+
+  if verbose
+    stdout.string.each_line do |line|
+      puts "stdout> #{line.chomp}"
+    end
+
+    stderr.string.each_line do |line|
+      puts "stderr> #{line.chomp}"
+    end
+  end
+
+  lines = stdout.string.each_line.to_a.map(&:chomp)
+
+  expectations.each do |expectation|
+    deleted = lines.reject! do |string|
+      string =~ /:#{expectation.line}:\d+: #{Regexp.quote expectation.message}\Z/
+    end
+
+    unless deleted
+      puts Rainbow("  💀 Expected error not found: #{expectation.line}:#{expectation.message}").red
+      failed = true
+    end
+  end
+
+  unless lines.empty?
+    lines.each do |line|
+      puts Rainbow("  🤦‍♀️ Unexpected error found: #{line}").red
+    end
+    failed = true
+  end
+end
+
+if failed
+  exit(1)
+else
+  puts Rainbow("All smoke test pass 😆").blue
+end

data/exe/steep

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+$LOAD_PATH << Pathname(__dir__) + "../lib"
+
+require 'steep'
+require 'steep/cli'
+
+begin
+  Steep::CLI.new(argv: ARGV.dup, stdout: STDOUT, stderr: STDERR, stdin: STDIN).run
+rescue => exn
+  STDERR.puts exn.inspect
+  exn.backtrace.each do |t|
+    STDERR.puts "  #{t}"
+  end
+  exit 2
+end

data/lib/steep.rb

@@ -0,0 +1,33 @@
+require "steep/version"
+
+require "pathname"
+require "parser/current"
+require "ast_utils"
+
+require "steep/types"
+require "steep/type_name"
+require "steep/interface"
+require "steep/signature/class"
+require "steep/signature/interface"
+require "steep/signature/errors"
+require "steep/signature/extension"
+require "steep/types/any"
+require "steep/types/name"
+require "steep/types/var"
+require "steep/types/union"
+require "steep/types/class"
+require "steep/types/instance"
+require "steep/types/merge"
+require "steep/type_assignability"
+require "steep/parser"
+require "steep/annotation"
+require "steep/source"
+require "steep/typing"
+require "steep/errors"
+require "steep/type_construction"
+
+require "steep/drivers/check"
+
+module Steep
+  # Your code goes here...
+end

data/lib/steep/annotation.rb

@@ -0,0 +1,223 @@
+module Steep
+  module Annotation
+    class Base; end
+
+    class VarType < Base
+      attr_reader :var
+      attr_reader :type
+
+      def initialize(var:, type:)
+        @var = var
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(VarType) &&
+          other.var == var &&
+          other.type == type
+      end
+    end
+
+    class MethodType < Base
+      attr_reader :method
+      attr_reader :type
+
+      def initialize(method:, type:)
+        @method = method
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(MethodType) &&
+          other.method == method &&
+          other.type == type
+      end
+    end
+
+    class ReturnType < Base
+      attr_reader :type
+
+      def initialize(type:)
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(ReturnType) && other.type == type
+      end
+    end
+
+    class BlockType < Base
+      attr_reader :type
+
+      def initialize(type:)
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(BlockType) && other.type == type
+      end
+    end
+
+    class SelfType < Base
+      attr_reader :type
+
+      def initialize(type:)
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(SelfType) && other.type == type
+      end
+    end
+
+    class InstanceType < Base
+      attr_reader :type
+
+      def initialize(type:)
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(InstanceType) && other.type == type
+      end
+    end
+
+    class ModuleType < Base
+      attr_reader :type
+
+      def initialize(type:)
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(ModuleType) && other.type == type
+      end
+    end
+
+    class Implements < Base
+      attr_reader :module_name
+
+      def initialize(module_name:)
+        @module_name = module_name
+      end
+
+      def ==(other)
+        other.is_a?(Implements) && other.module_name == module_name
+      end
+    end
+
+    class NameType < Base
+      attr_reader :name
+      attr_reader :type
+
+      def initialize(name:, type:)
+        @name = name
+        @type = type
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && other.name == name && other.type == type
+      end
+    end
+
+    class ConstType < NameType
+    end
+
+    class IvarType < NameType
+    end
+
+    class Dynamic < Base
+      attr_reader :name
+
+      def initialize(name:)
+        @name = name
+      end
+
+      def ==(other)
+        other.is_a?(Dynamic) && other.name == name
+      end
+    end
+
+    class Collection
+      attr_reader :var_types
+      attr_reader :method_types
+      attr_reader :annotations
+      attr_reader :block_type
+      attr_reader :return_type
+      attr_reader :self_type
+      attr_reader :const_types
+      attr_reader :instance_type
+      attr_reader :module_type
+      attr_reader :implement_module
+      attr_reader :ivar_types
+      attr_reader :dynamics
+
+      def initialize(annotations:)
+        @var_types = {}
+        @method_types = {}
+        @const_types = {}
+        @ivar_types = {}
+        @dynamics = Set.new
+
+        annotations.each do |annotation|
+          case annotation
+          when VarType
+            var_types[annotation.var] = annotation
+          when MethodType
+            method_types[annotation.method] = annotation
+          when BlockType
+            @block_type = annotation.type
+          when ReturnType
+            @return_type = annotation.type
+          when SelfType
+            @self_type = annotation.type
+          when ConstType
+            @const_types[annotation.name] = annotation.type
+          when InstanceType
+            @instance_type = annotation.type
+          when ModuleType
+            @module_type = annotation.type
+          when Implements
+            @implement_module = annotation.module_name
+          when IvarType
+            ivar_types[annotation.name] = annotation.type
+          when Dynamic
+            dynamics << annotation.name
+          else
+            raise "Unexpected annotation: #{annotation.inspect}"
+          end
+        end
+
+        @annotations = annotations
+      end
+
+      def lookup_var_type(name)
+        var_types[name]&.type
+      end
+
+      def lookup_method_type(name)
+        method_types[name]&.type
+      end
+
+      def lookup_const_type(node)
+        const_types[node]
+      end
+
+      def +(other)
+        self.class.new(annotations: annotations.reject {|a| a.is_a?(BlockType) } + other.annotations)
+      end
+
+      def any?(&block)
+        annotations.any?(&block)
+      end
+
+      def size
+        annotations.size
+      end
+
+      def include?(obj)
+        annotations.include?(obj)
+      end
+    end
+  end
+end