steep 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ee9143e226c595a96dd859109327d66f97ab2c428601c30f771a12a21a1603
-  data.tar.gz: ec8d8d3cdcde5c0e37c73fdb70faeb0887b5b36ae1590d57dbab1feea95f86ad
+  metadata.gz: 5e0677b34af6d2b65ac33be3c60d126d689e10d3b9fb7eff598b33dabda2dc98
+  data.tar.gz: f126e4ed9b28c55bad922282b280b51a350e0cbc77d25192553437fe0f392917
 SHA512:
-  metadata.gz: 5297a41597af66524e848e02f2c6f6b33d53d9fc52aac03280ec438845414e306dc3ce6a86b643608d34e89e1cabacfc75262013f7f78970661af88d4679f624
-  data.tar.gz: 610747408983f5e98ee292b5a3795e7b61c8dd74b6d255e3768f5c3658676f63c7dd8157cf7cbba492c98d36806e9c08482dcf5d58474e7ffaaaf78ea93c1157
+  metadata.gz: '0940b5f73af0ae31a8b310825e402caf784e9327982122b5e2b19f29ce69ddd4dd4dadf7f07bf93d150cecae2c4ffcb3faa6b237ece6d3653482a1dce12930fe'
+  data.tar.gz: b3fa66639c3ae93d475e6d12b965b526f633c31e244043f22e1c32c5d140e51568602c5087cc85247068010547d0dc4353f78f61c9d7093aefd8933b4b5b2186

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /lib/steep/parser.output
 /lib/steep/parser.rb
+/log

data/.travis.yml

@@ -2,5 +2,6 @@ sudo: false
 language: ruby
 rvm:
   - 2.5.3
+  - 2.6.1
 before_install: gem install bundler -v 1.13.7
 script: bundle exec rake test smoke

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 0.11.0 (2019-05-18)
+
+* Skip `alias` nodes type checking (#85)
+* Add experimental LSP support (#79. #83)
+* Fix logging (#81)
+
 ## 0.10.0 (2019-03-05)
 
 * Add `watch` subcommand (#77)

data/lib/steep.rb

@@ -9,6 +9,7 @@ require "active_support/tagged_logging"
 require "rainbow"
 require "listen"
 require 'pry'
+require 'language_server-protocol'
 
 require "steep/ast/namespace"
 require "steep/names"
@@ -85,6 +86,7 @@ require "steep/drivers/annotations"
 require "steep/drivers/scaffold"
 require "steep/drivers/print_interface"
 require "steep/drivers/watch"
+require "steep/drivers/langserver"
 
 if ENV["NO_COLOR"]
   Rainbow.enabled = false
@@ -92,12 +94,16 @@ end
 
 module Steep
   def self.logger
-    unless @logger
-      @logger = ActiveSupport::TaggedLogging.new(Logger.new(STDERR))
-      @logger.push_tags "Steep #{VERSION}"
-      @logger.level = Logger::WARN
-    end
+    self.log_output = STDERR unless @logger
 
     @logger
   end
+
+  def self.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
+  end
 end

data/lib/steep/cli.rb

@@ -132,7 +132,7 @@ module Steep
     end
 
     def self.available_commands
-      [:check, :validate, :annotations, :scaffold, :interface, :version, :paths, :watch]
+      [:check, :validate, :annotations, :scaffold, :interface, :version, :paths, :watch, :langserver]
     end
 
     def process_global_options
@@ -141,7 +141,9 @@ module Steep
           process_version
           exit 0
         end
-      end.order!
+
+        handle_logging_options(opts)
+      end.order!(argv)
 
       true
     end
@@ -164,6 +166,28 @@ module Steep
       __send__(:"process_#{command}")
     end
 
+    def handle_logging_options(opts)
+      opts.on("--verbose") do
+        Steep.logger.level = Logger::DEBUG
+      end
+
+      opts.on("--log-level=[debug,info,warn,error,fatal]") do |level|
+        lv = {
+          "debug" => Logger::DEBUG,
+          "info" => Logger::INFO,
+          "warn" => Logger::WARN,
+          "error" => Logger::ERROR,
+          "fatal" => Logger::FATAL
+        }[level.downcase] or raise "Unknown error level: #{level}"
+
+        Steep.logger.level = lv
+      end
+
+      opts.on("--log-output=[PATH]") do |file|
+        Steep.log_output = file
+      end
+    end
+
     def handle_dir_options(opts, options)
       opts.on("-I [PATH]") {|path| options << Pathname(path) }
       opts.on("-G [GEM]") {|gem| options << gem }
@@ -183,14 +207,13 @@ module Steep
 
     def process_check
       with_signature_options do |signature_options|
-        verbose = false
         dump_all_types = false
         fallback_any_is_error = false
         strict = false
 
         OptionParser.new do |opts|
+          handle_logging_options opts
           handle_dir_options opts, signature_options
-          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 }
@@ -202,7 +225,6 @@ module Steep
         end
 
         Drivers::Check.new(source_paths: source_paths, signature_dirs: signature_options.paths, 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 || strict
           check.allow_missing_definitions = false if strict
@@ -212,25 +234,29 @@ module Steep
 
     def process_validate
       with_signature_options do |signature_options|
-        verbose = false
-
         OptionParser.new do |opts|
+          handle_logging_options opts
           handle_dir_options opts, signature_options
-          opts.on("--verbose") { verbose = true }
         end.parse!(argv)
 
-        Drivers::Validate.new(signature_dirs: signature_options.paths, stdout: stdout, stderr: stderr).tap do |validate|
-          validate.verbose = verbose
-        end.run
+        Drivers::Validate.new(signature_dirs: signature_options.paths, stdout: stdout, stderr: stderr).run
       end
     end
 
     def process_annotations
+      OptionParser.new do |opts|
+        handle_logging_options opts
+      end.parse!(argv)
+
       source_paths = argv.map {|file| Pathname(file) }
       Drivers::Annotations.new(source_paths: source_paths, stdout: stdout, stderr: stderr).run
     end
 
     def process_scaffold
+      OptionParser.new do |opts|
+        handle_logging_options opts
+      end.parse!(argv)
+
       source_paths = argv.map {|file| Pathname(file) }
       Drivers::Scaffold.new(source_paths: source_paths, stdout: stdout, stderr: stderr).run
     end
@@ -238,6 +264,7 @@ module Steep
     def process_interface
       with_signature_options do |signature_options|
         OptionParser.new do |opts|
+          handle_logging_options opts
           handle_dir_options opts, signature_options
         end.parse!(argv)
 
@@ -251,6 +278,7 @@ module Steep
         fallback_any_is_error = false
 
         OptionParser.new do |opts|
+          handle_logging_options opts
           handle_dir_options opts, signature_options
           opts.on("--strict") { strict = true }
           opts.on("--fallback-any-is-error") { fallback_any_is_error = true }
@@ -270,6 +298,32 @@ module Steep
       end
     end
 
+    def process_langserver
+      with_signature_options do |signature_options|
+        strict = false
+        fallback_any_is_error = false
+
+        OptionParser.new do |opts|
+          handle_logging_options opts
+          handle_dir_options opts, signature_options
+          opts.on("--strict") { strict = true }
+          opts.on("--fallback-any-is-error") { fallback_any_is_error = true }
+        end.parse!(argv)
+
+        source_dirs = argv.map { |path| Pathname(path) }
+        if source_dirs.empty?
+          source_dirs << Pathname(".")
+        end
+
+        Drivers::Langserver.new(source_dirs: source_dirs, signature_dirs: signature_options.paths).tap do |driver|
+          driver.options.fallback_any_is_error = fallback_any_is_error || strict
+          driver.options.allow_missing_definitions = false if strict
+        end.run
+
+        0
+      end
+    end
+
     def process_version
       stdout.puts Steep::VERSION
       0
@@ -278,6 +332,7 @@ module Steep
     def process_paths
       with_signature_options do |signature_options|
         OptionParser.new do |opts|
+          handle_logging_options opts
           handle_dir_options opts, signature_options
         end.parse!(argv)
 

data/lib/steep/drivers/check.rb

@@ -6,7 +6,6 @@ module Steep
       attr_reader :stdout
       attr_reader :stderr
 
-      attr_accessor :verbose
       attr_accessor :accept_implicit_any
       attr_accessor :dump_all_types
       attr_accessor :fallback_any_is_error
@@ -22,7 +21,6 @@ module Steep
         @stdout = stdout
         @stderr = stderr
 
-        self.verbose = false
         self.accept_implicit_any = false
         self.dump_all_types = false
         self.fallback_any_is_error = false
@@ -37,8 +35,6 @@ module Steep
       end
 
       def run
-        Steep.logger.level = Logger::DEBUG if verbose
-
         project = Project.new(Project::SyntaxErrorRaisingListener.new)
 
         source_paths.each do |path|

data/lib/steep/drivers/langserver.rb

@@ -0,0 +1,166 @@
+module Steep
+  module Drivers
+    class Langserver
+      attr_reader :source_dirs
+      attr_reader :signature_dirs
+      attr_reader :options
+      attr_reader :subscribers
+
+      include Utils::EachSignature
+
+      def initialize(source_dirs:, signature_dirs:)
+        @source_dirs = source_dirs
+        @signature_dirs = signature_dirs
+        @options = Project::Options.new
+        @subscribers = {}
+
+        subscribe :initialize do |request:, notifier:|
+          LanguageServer::Protocol::Interface::InitializeResult.new(
+            capabilities: LanguageServer::Protocol::Interface::ServerCapabilities.new(
+              text_document_sync: LanguageServer::Protocol::Interface::TextDocumentSyncOptions.new(
+                open_close: true,
+                change: LanguageServer::Protocol::Constant::TextDocumentSyncKind::FULL,
+              ),
+              hover_provider: true
+            ),
+          )
+        end
+
+        subscribe :shutdown do |request:, notifier:|
+          Steep.logger.warn "Shutting down the server..."
+          exit
+        end
+
+        subscribe :"textDocument/didOpen" do |request:, notifier:|
+          uri = URI.parse(request[:params][:textDocument][:uri])
+          text = request[:params][:textDocument][:text]
+          synchronize_project(uri: uri, text: text, notifier: notifier)
+        end
+
+        subscribe :"textDocument/didChange" do |request:, notifier:|
+          uri = URI.parse(request[:params][:textDocument][:uri])
+          text = request[:params][:contentChanges][0][:text]
+          synchronize_project(uri: uri, text: text, notifier: notifier)
+        end
+
+        subscribe :"textDocument/hover" do |request:, notifier:|
+          Steep.logger.warn request.inspect
+          uri = URI.parse(request[:params][:textDocument][:uri])
+          line = request[:params][:position][:line]
+          column = request[:params][:position][:character]
+          respond_to_hover(uri: uri, line: line, column: column, notifier: notifier, id: request[:id])
+        end
+      end
+
+      def respond_to_hover(uri:, line:, column:, notifier:, id:)
+        path = Pathname(uri.path).relative_path_from(Pathname.pwd)
+
+        if path.extname == ".rb"
+          # line in LSP is zero-origin
+          project.type_of(path: path, line: line + 1, column: column) do |type, node|
+            Steep.logger.warn "type = #{type.to_s}"
+
+            start_position = { line: node.location.line - 1, character: node.location.column }
+            end_position = { line: node.location.last_line - 1, character: node.location.last_column }
+            range = { start: start_position, end: end_position }
+
+            Steep.logger.warn "node = #{node.type}"
+            Steep.logger.warn "range = #{range.inspect}"
+
+            LanguageServer::Protocol::Interface::Hover.new(
+              contents: { kind: "markdown", value: "`#{type}`" },
+              range: range
+            )
+          end
+        end
+      end
+
+      def subscribe(method, &callback)
+        @subscribers[method] = callback
+      end
+
+      def project
+        @project ||= Project.new.tap do |project|
+          source_dirs.each do |path|
+            each_file_in_path(".rb", path) do |file_path|
+              file = Project::SourceFile.new(path: file_path, options: options)
+              file.content = file_path.read
+              project.source_files[file_path] = file
+            end
+          end
+
+          signature_dirs.each do |path|
+            each_file_in_path(".rbi", path) do |file_path|
+              file = Project::SignatureFile.new(path: file_path)
+              file.content = file_path.read
+              project.signature_files[file_path] = file
+            end
+          end
+        end
+      end
+
+      def run
+        writer = LanguageServer::Protocol::Transport::Stdio::Writer.new
+        reader = LanguageServer::Protocol::Transport::Stdio::Reader.new
+        notifier = Proc.new { |method:, params: {}| writer.write(method: method, params: params) }
+
+        reader.read do |request|
+          id = request[:id]
+          method = request[:method].to_sym
+          Steep.logger.warn "Received event: #{method}"
+          subscriber = subscribers[method]
+          if subscriber
+            result = subscriber.call(request: request, notifier: notifier)
+            if id && result
+              writer.write(id: id, result: result)
+            end
+          else
+            Steep.logger.warn "Ignored event: #{method}"
+          end
+        end
+      end
+
+      def synchronize_project(uri:, text:, notifier:)
+        path = Pathname(uri.path).relative_path_from(Pathname.pwd)
+
+        case path.extname
+        when ".rb"
+          file = project.source_files[path] || Project::SourceFile.new(path: path, options: options)
+          file.content = text
+          project.source_files[path] = file
+          project.type_check
+
+          diags = (file.errors || []).map do |error|
+            LanguageServer::Protocol::Interface::Diagnostic.new(
+              message: error.to_s,
+              severity: LanguageServer::Protocol::Constant::DiagnosticSeverity::ERROR,
+              range: LanguageServer::Protocol::Interface::Range.new(
+                start: LanguageServer::Protocol::Interface::Position.new(
+                  line: error.node.loc.line - 1,
+                  character: error.node.loc.column,
+                ),
+                end: LanguageServer::Protocol::Interface::Position.new(
+                  line: error.node.loc.last_line - 1,
+                  character: error.node.loc.last_column,
+                ),
+              )
+            )
+          end
+
+          notifier.call(
+            method: :"textDocument/publishDiagnostics",
+            params: LanguageServer::Protocol::Interface::PublishDiagnosticsParams.new(
+              uri: uri,
+              diagnostics: diags,
+            ),
+          )
+        when ".rbi"
+          file = project.signature_files[path] || Project::SignatureFile.new(path: path)
+          file.content = text
+          project.signature_files[path] = file
+          project.type_check
+        end
+      end
+    end
+  end
+end

data/lib/steep/drivers/validate.rb

@@ -4,21 +4,16 @@ module Steep
       attr_reader :signature_dirs
       attr_reader :stdout
       attr_reader :stderr
-      attr_accessor :verbose
 
       def initialize(signature_dirs:, stdout:, stderr:)
         @signature_dirs = signature_dirs
         @stdout = stdout
         @stderr = stderr
-
-        self.verbose = false
       end
 
       include Utils::EachSignature
 
       def run
-        Steep.logger.level = Logger::DEBUG if verbose
-
         project = Project.new
 
         signature_dirs.each do |path|

data/lib/steep/project.rb

@@ -227,5 +227,28 @@ module Steep
 
       errors
     end
+
+    def type_of(path:, line:, column:)
+      if source_file = source_files[path]
+        case source = source_file.source
+        when Source
+          if typing = source_file.typing
+            node = source.find_node(line: line, column: column)
+
+            type = begin
+              typing.type_of(node: node)
+            rescue RuntimeError
+              AST::Builtin.any_type
+            end
+
+            if block_given?
+              yield type, node
+            else
+              type
+            end
+          end
+        end
+      end
+    end
   end
 end

data/lib/steep/project/file.rb

@@ -42,6 +42,9 @@ module Steep
           rescue ::Parser::SyntaxError => exn
             Steep.logger.warn { "Syntax error on #{path}: #{exn.inspect}" }
             exn
+          rescue EncodingError => exn
+            Steep.logger.warn { "Encoding error on #{path}: #{exn.inspect}" }
+            exn
           end
       end
 

data/lib/steep/source.rb

@@ -288,5 +288,29 @@ module Steep
         enum_for :each_annotation
       end
     end
+
+    # @type method find_node: (line: Integer, column: Integer, ?node: any, ?position: Integer?) -> any
+    def find_node(line:, column:, node: self.node, position: nil)
+      position ||= (line-1).times.sum do |i|
+        node.location.expression.source_buffer.source_line(i+1).size + 1
+      end + column
+
+      range = node.location.expression&.yield_self do |r|
+        r.begin_pos..r.end_pos
+      end
+
+      if range
+        if range === position
+          Source.each_child_node(node) do |child|
+            n = find_node(line: line, column: column, node: child, position: position)
+            if n
+              return n
+            end
+          end
+
+          node
+        end
+      end
+    end
   end
 end

data/lib/steep/type_construction.rb

@@ -1559,9 +1559,9 @@ module Steep
             typing.add_typing node, AST::Builtin.any_type
           end
 
-        when :splat, :sclass
+        when :splat, :sclass, :alias
           yield_self do
-            Steep.logger.error "Unsupported node #{node.type}"
+            Steep.logger.error "Unsupported node #{node.type} (#{node.location.expression.source_buffer.name}:#{node.location.expression.line})"
 
             each_child_node node do |child|
               synthesize(child)

data/lib/steep/version.rb

@@ -1,3 +1,3 @@
 module Steep
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/sig/project.rbi

@@ -13,6 +13,7 @@ class Steep::Source
   def self.parse: (String, path: String, labeling: any) -> instance
   def annotations: (block: any, builder: any, current_module: any) -> Array<annotation>
   def node: -> any
+  def find_node: (line: Integer, column: Integer) -> any
 end
 
 class Steep::Typing
@@ -103,4 +104,6 @@ class Steep::Project
   def signature_updated?: -> bool
   def reload_signature: -> void
   def validate_signature: (any) -> Array<any>
+
+  def type_of: (path: Pathname, line: Integer, column: Integer) -> any
 end

data/steep.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rainbow", "~> 2.2.2", "< 4.0"
   spec.add_runtime_dependency "listen", "~> 3.1"
   spec.add_runtime_dependency "pry", "~> 0.12.2"
+  spec.add_runtime_dependency "language_server-protocol", "~> 3.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steep
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: language_server-protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
 description: Gradual Typing for Ruby
 email:
 - matsumoto@soutaro.com
@@ -214,6 +228,7 @@ files:
 - lib/steep/cli.rb
 - lib/steep/drivers/annotations.rb
 - lib/steep/drivers/check.rb
+- lib/steep/drivers/langserver.rb
 - lib/steep/drivers/print_interface.rb
 - lib/steep/drivers/scaffold.rb
 - lib/steep/drivers/utils/each_signature.rb