rbi 0.0.11 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 727196c54429957687b3624d4b5a895e526973b045689a7689edb9cd73c97ca9
-  data.tar.gz: 115a6efabd78950aa980d0b03e3b9910f474ad03cdf04f7a87b56ed38bdc30b7
+  metadata.gz: 570f1035fa8bb56861eabd49590fbf2374f428c053f0fc189e27958feedf0c4b
+  data.tar.gz: 0dbb944e45b675851de18089c22a23c4c527f03dfca281426db8fb3cff94372e
 SHA512:
-  metadata.gz: 7357ca0bb3e8700a95d1ea6e285e710f3545a9016e36bc0a64fe0682da80328d5c645b4d6cd3d14bba14e7ccd6b9134c225944ce27625de6a26a995f5283d173
-  data.tar.gz: 71559ec6d855d46d3ac7bb074dbfd24fa024aaa6563dd241a7c286b66d138bf18f6c6e688ee33df99bdc240cbd6f683ebc068cb5c98b7e2b37dde6d4c9debca8
+  metadata.gz: 45e5f53144cc46f1cd2c86b55c1d490ab5bd4b2d3bf5e593b3f6405e6b4583645c13130cdc6762f0e5eb18f5f74bfa1dfe990d108f6db21da394ba4d30a7b810
+  data.tar.gz: 603617b73fc3e4e862f897bf0b10b165efd4ac608c07b71e3ef43e1190e4d1fff2f26484a65d8f4d9e5965eafa99435d02bf668fef756abe5a24f1fa3e41f52b

data/Gemfile

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 source "https://rubygems.org"

data/Rakefile

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

data/lib/rbi/formatter.rb

@@ -0,0 +1,66 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RBI
+  class Formatter
+    extend T::Sig
+
+    sig { returns(T::Boolean) }
+    attr_accessor :add_sig_templates, :group_nodes, :nest_singleton_methods, :nest_non_public_methods, :sort_nodes
+
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_line_length
+
+    sig do
+      params(
+        add_sig_templates: T::Boolean,
+        group_nodes: T::Boolean,
+        max_line_length: T.nilable(Integer),
+        nest_singleton_methods: T::Boolean,
+        nest_non_public_methods: T::Boolean,
+        sort_nodes: T::Boolean
+      ).void
+    end
+    def initialize(
+      add_sig_templates: false,
+      group_nodes: false,
+      max_line_length: nil,
+      nest_singleton_methods: false,
+      nest_non_public_methods: false,
+      sort_nodes: false
+    )
+      @add_sig_templates = add_sig_templates
+      @group_nodes = group_nodes
+      @max_line_length = max_line_length
+      @nest_singleton_methods = nest_singleton_methods
+      @nest_non_public_methods = nest_non_public_methods
+      @sort_nodes = sort_nodes
+    end
+
+    sig { params(file: RBI::File).returns(String) }
+    def print_file(file)
+      format_file(file)
+      file.string(max_line_length: @max_line_length)
+    end
+
+    sig { params(tree: RBI::Tree).returns(String) }
+    def print_tree(tree)
+      format_tree(tree)
+      tree.string(max_line_length: @max_line_length)
+    end
+
+    sig { params(file: RBI::File).void }
+    def format_file(file)
+      format_tree(file.root)
+    end
+
+    sig { params(tree: RBI::Tree).void }
+    def format_tree(tree)
+      tree.add_sig_templates! if @add_sig_templates
+      tree.nest_singleton_methods! if @nest_singleton_methods
+      tree.nest_non_public_methods! if @nest_non_public_methods
+      tree.group_nodes! if @group_nodes
+      tree.sort_nodes! if @sort_nodes
+    end
+  end
+end

data/lib/rbi/loc.rb

@@ -32,5 +32,20 @@ module RBI
     def to_s
       "#{file}:#{begin_line}:#{begin_column}-#{end_line}:#{end_column}"
     end
+
+    sig { returns(T.nilable(String)) }
+    def source
+      file = self.file
+      return nil unless file
+      return nil unless ::File.file?(file)
+
+      return ::File.read(file) unless begin_line && end_line
+
+      string = String.new
+      ::File.foreach(file).with_index do |line, line_number|
+        string << line if line_number + 1 >= begin_line && line_number + 1 <= end_line
+      end
+      string
+    end
   end
 end

data/lib/rbi/model.rb

@@ -1026,7 +1026,7 @@ module RBI
     attr_accessor :return_type
 
     sig { returns(T::Boolean) }
-    attr_accessor :is_abstract, :is_override, :is_overridable
+    attr_accessor :is_abstract, :is_override, :is_overridable, :is_final
 
     sig { returns(T::Array[String]) }
     attr_reader :type_params
@@ -1041,6 +1041,7 @@ module RBI
         is_abstract: T::Boolean,
         is_override: T::Boolean,
         is_overridable: T::Boolean,
+        is_final: T::Boolean,
         type_params: T::Array[String],
         checked: T.nilable(Symbol),
         loc: T.nilable(Loc),
@@ -1053,6 +1054,7 @@ module RBI
       is_abstract: false,
       is_override: false,
       is_overridable: false,
+      is_final: false,
       type_params: [],
       checked: nil,
       loc: nil,
@@ -1064,6 +1066,7 @@ module RBI
       @is_abstract = is_abstract
       @is_override = is_override
       @is_overridable = is_overridable
+      @is_final = is_final
       @type_params = type_params
       @checked = checked
       block&.call(self)
@@ -1078,7 +1081,7 @@ module RBI
     def ==(other)
       return false unless other.is_a?(Sig)
       params == other.params && return_type == other.return_type && is_abstract == other.is_abstract &&
-        is_override == other.is_override && is_overridable == other.is_overridable &&
+        is_override == other.is_override && is_overridable == other.is_overridable && is_final == other.is_final &&
         type_params == other.type_params && checked == other.checked
     end
   end

data/lib/rbi/parser.rb

@@ -17,6 +17,39 @@ module RBI
     end
   end
 
+  class UnexpectedParserError < StandardError
+    extend T::Sig
+
+    sig { returns(Loc) }
+    attr_reader :last_location
+
+    sig { params(parent_exception: Exception, last_location: Loc).void }
+    def initialize(parent_exception, last_location)
+      super(parent_exception)
+      set_backtrace(parent_exception.backtrace)
+      @last_location = last_location
+    end
+
+    sig { params(io: T.any(IO, StringIO)).void }
+    def print_debug(io: $stderr)
+      io.puts ""
+      io.puts "##################################"
+      io.puts "### RBI::Parser internal error ###"
+      io.puts "##################################"
+      io.puts ""
+      io.puts "There was an internal parser error while processing this source."
+      io.puts ""
+      io.puts "Error: #{message} while parsing #{last_location}:"
+      io.puts ""
+      io.puts last_location.source || "<no source>"
+      io.puts ""
+      io.puts "Please open an issue at https://github.com/Shopify/rbi/issues/new."
+      io.puts ""
+      io.puts "##################################"
+      io.puts ""
+    end
+  end
+
   class Parser
     extend T::Sig
 
@@ -77,6 +110,19 @@ module RBI
       builder.tree
     rescue ::Parser::SyntaxError => e
       raise ParseError.new(e.message, Loc.from_ast_loc(file, e.diagnostic.location))
+    rescue ParseError => e
+      raise e
+    rescue => e
+      last_node = builder&.last_node
+      last_location = if last_node
+        Loc.from_ast_loc(file, last_node.location)
+      else
+        Loc.new(file: file)
+      end
+
+      exception = UnexpectedParserError.new(e, last_location)
+      exception.print_debug
+      raise exception
     end
   end
 
@@ -113,6 +159,9 @@ module RBI
     sig { returns(Tree) }
     attr_reader :tree
 
+    sig { returns(T.nilable(::AST::Node)) }
+    attr_reader :last_node
+
     sig do
       params(
         file: String,
@@ -127,6 +176,7 @@ module RBI
       @nodes_comments_assoc = nodes_comments_assoc
       @tree = T.let(Tree.new, Tree)
       @scopes_stack = T.let([@tree], T::Array[Tree])
+      @last_node = T.let(nil, T.nilable(::AST::Node))
       @last_sigs = T.let([], T::Array[RBI::Sig])
 
       separate_header_comments
@@ -141,6 +191,8 @@ module RBI
     sig { override.params(node: T.nilable(Object)).void }
     def visit(node)
       return unless node.is_a?(AST::Node)
+      @last_node = node
+
       case node.type
       when :module, :class, :sclass
         scope = parse_scope(node)
@@ -165,6 +217,8 @@ module RBI
       else
         visit_all(node.children)
       end
+
+      @last_node = nil
     end
 
     private
@@ -289,7 +343,14 @@ module RBI
         names = node.children[2..-1].map { |child| parse_name(child) }
         MixesInClassMethods.new(*names, loc: loc, comments: comments)
       when :public, :protected, :private
-        visibility = Visibility.new(method_name, loc: loc)
+        visibility = case method_name
+        when :protected
+          Protected.new(loc: loc)
+        when :private
+          Private.new(loc: loc)
+        else
+          Public.new(loc: loc)
+        end
         nested_node = node.children[2]
         case nested_node&.type
         when :def, :defs
@@ -422,7 +483,14 @@ module RBI
     sig { params(node: AST::Node).returns(TEnumBlock) }
     def parse_enum(node)
       enum = TEnumBlock.new
-      node.children[2].children.each do |child|
+
+      body = if node.children[2].type == :begin
+        node.children[2].children
+      else
+        [node.children[2]]
+      end
+
+      body.each do |child|
         enum << parse_name(child)
       end
       enum.loc = node_loc(node)
@@ -561,7 +629,7 @@ module RBI
     sig { params(node: AST::Node).returns(Sig) }
     def self.build(node)
       v = SigBuilder.new
-      v.visit_all(node.children[2..-1])
+      v.visit_all(node.children)
       v.current
     end
 
@@ -588,6 +656,9 @@ module RBI
       visit(node.children[0]) if node.children[0]
       name = node.children[1]
       case name
+      when :sig
+        arg = node.children[2]
+        @current.is_final = arg && arg.children[0] == :final
       when :abstract
         @current.is_abstract = true
       when :override
@@ -595,19 +666,25 @@ module RBI
       when :overridable
         @current.is_overridable = true
       when :checked
-        @current.checked = node.children[2].children[0]
+        if node.children.length >= 3
+          @current.checked = node.children[2].children[0]
+        end
       when :type_parameters
         node.children[2..-1].each do |child|
           @current.type_params << child.children[0].to_s
         end
       when :params
-        node.children[2].children.each do |child|
-          name = child.children[0].children[0].to_s
-          type = parse_expr(child.children[1])
-          @current << SigParam.new(name, type)
+        if node.children.length >= 3
+          node.children[2].children.each do |child|
+            name = child.children[0].children[0].to_s
+            type = parse_expr(child.children[1])
+            @current << SigParam.new(name, type)
+          end
         end
       when :returns
-        @current.return_type = parse_expr(node.children[2])
+        if node.children.length >= 3
+          @current.return_type = parse_expr(node.children[2])
+        end
       when :void
         @current.return_type = nil
       else

data/lib/rbi/printer.rb

@@ -200,7 +200,7 @@ module RBI
       end
 
       lines.each do |line|
-        text = line.strip
+        text = line.rstrip
         v.printt("#")
         v.print(" #{text}") unless text.empty?
         v.printn
@@ -455,7 +455,7 @@ module RBI
 
     sig { returns(T::Array[String]) }
     def comments_lines
-      comments.flat_map { |comment| comment.text.lines.map(&:strip) }
+      comments.flat_map { |comment| comment.text.lines.map(&:rstrip) }
     end
   end
 
@@ -670,7 +670,9 @@ module RBI
 
     sig { params(v: Printer).void }
     def print_as_line(v)
-      v.printt("sig { ")
+      v.printt("sig")
+      v.print("(:final)") if is_final
+      v.print(" { ")
       sig_modifiers.each do |modifier|
         v.print("#{modifier}.")
       end
@@ -758,7 +760,7 @@ module RBI
 
     sig { returns(T::Array[String]) }
     def comments_lines
-      comments.flat_map { |comment| comment.text.lines.map(&:strip) }
+      comments.flat_map { |comment| comment.text.lines.map(&:rstrip) }
     end
   end
 

data/lib/rbi/rewriters/group_nodes.rb

@@ -47,6 +47,8 @@ module RBI
     sig { returns(Group::Kind) }
     def group_kind
       case self
+      when Group
+        kind
       when Include, Extend
         Group::Kind::Mixins
       when RequiresAncestor

data/lib/rbi/version.rb

@@ -1,6 +1,6 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module RBI
-  VERSION = "0.0.11"
+  VERSION = "0.0.14"
 end

data/lib/rbi.rb

@@ -23,4 +23,5 @@ require "rbi/rewriters/remove_known_definitions"
 require "rbi/rewriters/sort_nodes"
 require "rbi/parser"
 require "rbi/printer"
+require "rbi/formatter"
 require "rbi/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbi
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.14
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.4.0
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +77,7 @@ files:
 - README.md
 - Rakefile
 - lib/rbi.rb
+- lib/rbi/formatter.rb
 - lib/rbi/index.rb
 - lib/rbi/loc.rb
 - lib/rbi/model.rb