spoom 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6a3db37efef69beb451a63043e45e10e8c49cb6c86c774fdc8e01a18aee858
-  data.tar.gz: de6e4f8e97f5802b3843ccde507510d4de081a98f4fdd3b7bf6da62d1b177dcb
+  metadata.gz: d851bf66dbfb8e1d316b27466fde8ee205e55e68b9b489c3f8f234c03e1763d2
+  data.tar.gz: '068972f0ebb9393400dcbf68837be0a58114cc55560438fd329be3b54acfcaaf'
 SHA512:
-  metadata.gz: 74189496b4e9a126ba649fa529f3061c03e334f01c715b571dc12920f97219ea79e6d7f25811d073fc6daa2fa6db04aeb12030fa119fefe94cb822964710e658
-  data.tar.gz: bcefd877fc949636d850a660e389bd0f395ef3fb38b6eed178f2b09b0bc63685202dff5628ac6f39a54597471e4ea8004356971db9d578a0e07fdde986d05a8e
+  metadata.gz: 8315d9c7de9beaf2aa9a5d6963cde78ec6e9e7949659bac85a0ff719080755808fb5a854c2a03f6dcab8134c17bc8d90d145d53d32a3f1632d83a2c6a21ebfaa
+  data.tar.gz: 88fee999fa79caf40dd776ce5253a1337a5acc2507653a2c09adfb3e4723b6a8a06033d34c8f299b3a7a663ef01c2fa4a8243d98fd9f104e9c77ad69f9836ff7

data/Gemfile

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 source "https://rubygems.org"
@@ -6,4 +7,7 @@ gemspec
 
 group(:development) do
   gem('rubocop-shopify', require: false)
+  gem('rubocop-sorbet', require: false)
+  gem('byebug')
+  gem('pry-byebug')
 end

data/Rakefile

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rake/testtask"

data/exe/spoom

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+# typed: true
+# frozen_string_literal: true
+
+require_relative "../lib/spoom"
+
+Spoom::Cli::Main.start(ARGV)

data/lib/spoom.rb

@@ -1,6 +1,13 @@
+# typed: true
 # frozen_string_literal: true
 
 require "sorbet-runtime"
 
+module Spoom
+  class Error < StandardError; end
+end
+
+require "spoom/cli"
+require "spoom/config"
+require "spoom/sorbet"
 require "spoom/version"
-require "spoom/sorbet/config"

data/lib/spoom/cli.rb

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+require "thor"
+
+require_relative "cli/commands/config"
+require_relative "cli/commands/lsp"
+require_relative "cli/commands/run"
+
+module Spoom
+  module Cli
+    class Main < Thor
+      extend T::Sig
+
+      class_option :no_color, desc: "Don't use colors", type: :boolean
+
+      desc "config", "manage Sorbet config"
+      subcommand "config", Spoom::Cli::Commands::Config
+
+      desc "lsp", "send LSP requests to Sorbet"
+      subcommand "lsp", Spoom::Cli::Commands::LSP
+
+      desc "tc", "run Sorbet and parses its output"
+      subcommand "tc", Spoom::Cli::Commands::Run
+
+      # Utils
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/spoom/cli/commands/base.rb

@@ -0,0 +1,36 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'stringio'
+
+module Spoom
+  module Cli
+    module Commands
+      class Base < Thor
+        no_commands do
+          def say_error(message, status = "Error")
+            status = set_color(status, :red)
+
+            buffer = StringIO.new
+            buffer << "#{status}: #{message}"
+            buffer << "\n" unless message.end_with?("\n")
+
+            $stderr.print(buffer.string)
+            $stderr.flush
+          end
+
+          def in_sorbet_project?
+            File.file?(Spoom::Config::SORBET_CONFIG)
+          end
+
+          def in_sorbet_project!
+            unless in_sorbet_project?
+              say_error("not in a Sorbet project (no sorbet/config)")
+              exit(1)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spoom/cli/commands/config.rb

@@ -0,0 +1,67 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../../sorbet/config"
+
+module Spoom
+  module Cli
+    module Commands
+      class Config < Base
+        default_task :show
+
+        desc "show", "show Sorbet config"
+        def show
+          in_sorbet_project!
+          config = Spoom::Sorbet::Config.parse_file(Spoom::Config::SORBET_CONFIG)
+
+          say("Found Sorbet config at `#{Spoom::Config::SORBET_CONFIG}`.")
+
+          say("\nPaths typechecked:")
+          if config.paths.empty?
+            say(" * (default: .)")
+          else
+            config.paths.each do |path|
+              say(" * #{path}")
+            end
+          end
+
+          say("\nPaths ignored:")
+          if config.ignore.empty?
+            say(" * (default: none)")
+          else
+            config.ignore.each do |path|
+              say(" * #{path}")
+            end
+          end
+
+          say("\nAllowed extensions:")
+          if config.allowed_extensions.empty?
+            say(" * .rb (default)")
+            say(" * .rbi (default)")
+          else
+            config.allowed_extensions.each do |ext|
+              say(" * #{ext}")
+            end
+          end
+        end
+
+        desc "files", "show files matching Sorbet config"
+        def files
+          in_sorbet_project!
+          config = Spoom::Sorbet::Config.parse_file(Spoom::Config::SORBET_CONFIG)
+          files = Spoom::Sorbet.srb_files(config)
+
+          say("Files matching `#{Spoom::Config::SORBET_CONFIG}`:")
+          if files.empty?
+            say(" NONE")
+          else
+            files.each do |path|
+              say(" * #{path}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spoom/cli/commands/lsp.rb

@@ -0,0 +1,156 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'shellwords'
+
+require_relative "base"
+require_relative "../symbol_printer"
+require_relative "../../sorbet/lsp"
+
+module Spoom
+  module Cli
+    module Commands
+      class LSP < Base
+        default_task :show
+
+        desc "interactive", "interactive LSP mode"
+        def show
+          in_sorbet_project!
+          lsp = lsp_client
+          # TODO: run interactive mode
+          puts lsp
+        end
+
+        desc "list", "list all known symbols"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def list
+          run do |client|
+            Dir["**/*.rb"].each do |file|
+              res = client.document_symbols(file.to_uri)
+              next if res.empty?
+              puts "Symbols from `#{file}`:"
+              SymbolPrinter.print_object(res, options["no_color"])
+            end
+          end
+        end
+
+        desc "hover", "request hover informations"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def hover(file, line, col)
+          run do |client|
+            res = client.hover(file.to_uri, line.to_i, col.to_i)
+            say "Hovering `#{file}:#{line}:#{col}`:"
+            if res
+              SymbolPrinter.print_object(res, options["no_color"])
+            else
+              puts "<no data>"
+            end
+          end
+        end
+
+        desc "defs", "list definitions of a symbol"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def defs(file, line, col)
+          run do |client|
+            res = client.definitions(file.to_uri, line.to_i, col.to_i)
+            puts "Definitions for `#{file}:#{line}:#{col}`:"
+            SymbolPrinter.print_list(res, options["no_color"])
+          end
+        end
+
+        desc "find", "find symbols matching a query"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def find(query)
+          run do |client|
+            res = client.symbols(query)
+            puts "Symbols matching `#{query}`:"
+            printer = SymbolPrinter.new(2, options["no_color"])
+            res.each do |symbol|
+              next if symbol.location.uri.start_with?("https")
+              printer.visit(symbol)
+            end
+          end
+        end
+
+        desc "symbols", "list symbols from a file"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def symbols(file)
+          run do |client|
+            res = client.document_symbols(file.to_uri)
+            puts "Symbols from `#{file}`:"
+            SymbolPrinter.print_object(res, options["no_color"])
+          end
+        end
+
+        desc "refs", "list references to a symbol"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def refs(file, line, col)
+          run do |client|
+            res = client.references(file.to_uri, line.to_i, col.to_i)
+            puts "References to `#{file}:#{line}:#{col}`:"
+            SymbolPrinter.print_list(res, options["no_color"])
+          end
+        end
+
+        desc "sigs", "list signatures for a symbol"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def sigs(file, line, col)
+          run do |client|
+            res = client.signatures(file.to_uri, line.to_i, col.to_i)
+            puts "Signature for `#{file}:#{line}:#{col}`:"
+            SymbolPrinter.print_list(res, options["no_color"])
+          end
+        end
+
+        desc "types", "display type of a symbol"
+        # TODO: options, filter, limit, kind etc.. filter rbi
+        def types(file, line, col)
+          run do |client|
+            res = client.type_definitions(file.to_uri, line.to_i, col.to_i)
+            say "Type for `#{file}:#{line}:#{col}`:"
+            SymbolPrinter.print_list(res, options["no_color"])
+          end
+        end
+
+        no_commands do
+          def lsp_client
+            in_sorbet_project!
+            client = Spoom::LSP::Client.new(
+              Spoom::Config::SORBET_PATH,
+              "--lsp",
+              "--enable-all-experimental-lsp-features",
+              "--disable-watchman",
+            )
+            client.open(Spoom::Config::WORKSPACE_PATH)
+            client
+          end
+
+          def run(&block)
+            client = lsp_client
+            block.call(client)
+          rescue Spoom::LSP::Error::Diagnostics => err
+            say_error("Sorbet returned typechecking errors for `#{err.uri.from_uri}`")
+            err.diagnostics.each do |d|
+              say_error("#{d.message} (#{d.code})", "  #{d.range}")
+            end
+            exit(1)
+          rescue Spoom::LSP::Error::BadHeaders => err
+            say_error("Sorbet didn't answer correctly (#{err.message})")
+            exit(1)
+          rescue Spoom::LSP::Error => err
+            say_error(err.message)
+            exit(1)
+          ensure
+            begin
+              client&.close
+            rescue
+              # We can't do much if Sorbet refuse to close.
+              # We kill the parent process and let the child be killed.
+              exit(1)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spoom/cli/commands/run.rb

@@ -0,0 +1,92 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Spoom
+  module Cli
+    module Commands
+      class Run < Base
+        default_task :tc
+
+        desc "tc", "run srb tc"
+        option :limit, type: :numeric, aliases: :l
+        option :code, type: :numeric, aliases: :c
+        option :sort, type: :string, aliases: :s
+        def tc
+          in_sorbet_project!
+
+          limit = options[:limit]
+          sort = options[:sort]
+          code = options[:code]
+          colors = !options[:no_color]
+
+          unless limit || code || sort
+            return Spoom::Sorbet.srb_tc(capture_err: false).last
+          end
+
+          output, status = Spoom::Sorbet.srb_tc(capture_err: true)
+          if status
+            $stderr.print(output)
+            return 0
+          end
+
+          errors = Spoom::Sorbet::Errors::Parser.parse_string(output)
+          errors_count = errors.size
+
+          errors = sort == "code" ? errors.sort_by { |e| [e.code, e.file, e.line, e.message] } : errors.sort
+          errors = errors.select { |e| e.code == code } if code
+          errors = T.must(errors.slice(0, limit)) if limit
+
+          errors.each do |e|
+            code = colorize_code(e.code, colors)
+            message = colorize_message(e.message, colors)
+            $stderr.puts "#{code} - #{e.file}:#{e.line}: #{message}"
+          end
+
+          if errors_count == errors.size
+            $stderr.puts "Errors: #{errors_count}"
+          else
+            $stderr.puts "Errors: #{errors.size} shown, #{errors_count} total"
+          end
+
+          1
+        end
+
+        desc "metrics", "run srb tc and display metrics"
+        def metrics
+          in_sorbet_project!
+
+          metrics = Spoom::Sorbet.srb_metrics(capture_err: false)
+          if metrics
+            metrics.show
+          else
+            puts "no data"
+          end
+        end
+
+        no_commands do
+          def colorize_code(code, colors = true)
+            return code.to_s unless colors
+            code.to_s.light_black
+          end
+
+          def colorize_message(message, colors = true)
+            return message unless colors
+
+            cyan = T.let(false, T::Boolean)
+            word = StringIO.new
+            message.chars.each do |c|
+              if c == '`'
+                cyan = !cyan
+                next
+              end
+              word << (cyan ? c.cyan : c.red)
+            end
+            word.string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spoom/cli/symbol_printer.rb

@@ -0,0 +1,71 @@
+# typed: true
+# frozen_string_literal: true
+
+require "colorize"
+
+module Spoom
+  module Cli
+    class SymbolPrinter
+      attr_accessor :seen, :no_color
+
+      def self.print_list(list, no_color)
+        printer = SymbolPrinter.new(2, no_color)
+        list.each do |item|
+          printer.print(" * ")
+          printer.visit(item)
+          printer.printn
+        end
+      end
+
+      def self.print_object(object, no_color)
+        printer = SymbolPrinter.new(2, no_color)
+        printer.visit(object)
+      end
+
+      def initialize(default_indent, no_color = false)
+        @seen = Set.new
+        @current_indent = default_indent
+        @no_color = no_color
+        String.disable_colorization = no_color
+      end
+
+      def indent
+        @current_indent += 2
+      end
+
+      def dedent
+        @current_indent -= 2
+      end
+
+      def print(string)
+        Kernel.print(string)
+      end
+
+      def printn
+        print("\n")
+      end
+
+      def printt
+        print(" " * @current_indent)
+      end
+
+      def visit(object)
+        if object.is_a?(Array)
+          object.each { |e| visit(e) }
+        else
+          object.accept_printer(self)
+        end
+      end
+    end
+  end
+end
+
+class String
+  def to_uri
+    "file://" + File.join(Spoom::Config::WORKSPACE_PATH, self)
+  end
+
+  def from_uri
+    sub("file://#{Spoom::Config::WORKSPACE_PATH}", "")
+  end
+end