rbi 0.0.10 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b81ff4cdb9cb4776c5592c2838906188b7db79620511303a209d6d7ae395c491
-  data.tar.gz: 9da4440f160522287e3e9aca18b4d535759b11ebe59fae994d6f51be473e1e2f
+  metadata.gz: c5ef2a157e342a16c69748e0f09b67839152d10e99a3b7eab4da23354b8993f9
+  data.tar.gz: 6622c783e58b67a950e4661a025f8d0a9508612eda9ee53af45f72e6c5057286
 SHA512:
-  metadata.gz: c7b23d94ec81f396057fe0aeb60f75d46799241ec61e097096f6b65cd9d1730fe6ab3bab0442e2f44c62c82e31481d5c26d127b84715ec8fd74fcee939d96857
-  data.tar.gz: 1fee917b50d5931574db3159349765d5a0d3b50ed12628afdf458eb011fd37bd140025588fdceb2124afc3ff7c5e8073b45bdd2ecfc3eb601ee2be6788f0fd29
+  metadata.gz: 598e6384b4aca8b6db5aa97d6a00e6a75cb1bb4273d5401006c969c4d89730797942c8d0ff7fed0a8da25f6170747126c064c6aadbec210ebb28e4781772ab26
+  data.tar.gz: 6021bd1134be4dfd834ece8648ea904ad30666216411c7524a9f4245f14ecab7b1e6da9d013a8c0bb4a9620fde7db83190b54f7bb512f7d1d23275300112482e

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/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

@@ -289,7 +289,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 +429,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 +575,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 +602,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

data/lib/rbi/printer.rb

@@ -117,16 +117,23 @@ module RBI
       end
     end
 
-    sig { params(out: T.any(IO, StringIO), indent: Integer, print_locs: T::Boolean).void }
-    def print(out: $stdout, indent: 0, print_locs: false)
-      p = Printer.new(out: out, indent: indent, print_locs: print_locs)
+    sig do
+      params(
+        out: T.any(IO, StringIO),
+        indent: Integer,
+        print_locs: T::Boolean,
+        max_line_length: T.nilable(Integer)
+      ).void
+    end
+    def print(out: $stdout, indent: 0, print_locs: false, max_line_length: nil)
+      p = Printer.new(out: out, indent: indent, print_locs: print_locs, max_line_length: max_line_length)
       p.visit_file(self)
     end
 
-    sig { params(indent: Integer, print_locs: T::Boolean).returns(String) }
-    def string(indent: 0, print_locs: false)
+    sig { params(indent: Integer, print_locs: T::Boolean, max_line_length: T.nilable(Integer)).returns(String) }
+    def string(indent: 0, print_locs: false, max_line_length: nil)
       out = StringIO.new
-      print(out: out, indent: indent, print_locs: print_locs)
+      print(out: out, indent: indent, print_locs: print_locs, max_line_length: max_line_length)
       out.string
     end
   end
@@ -193,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
@@ -448,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
 
@@ -663,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
@@ -751,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

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RBI
-  VERSION = "0.0.10"
+  VERSION = "0.0.13"
 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.10
+  version: 0.0.13
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -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