rbi 0.0.16 → 0.1.0

data/lib/rbi/printer.rb

@@ -22,7 +22,7 @@ module RBI
         out: T.any(IO, StringIO),
         indent: Integer,
         print_locs: T::Boolean,
-        max_line_length: T.nilable(Integer)
+        max_line_length: T.nilable(Integer),
       ).void
     end
     def initialize(out: $stdout, indent: 0, print_locs: false, max_line_length: nil)
@@ -82,6 +82,7 @@ module RBI
     sig { override.params(node: T.nilable(Node)).void }
     def visit(node)
       return unless node
+
       node.accept_printer(self)
     end
 
@@ -122,7 +123,7 @@ module RBI
         out: T.any(IO, StringIO),
         indent: Integer,
         print_locs: T::Boolean,
-        max_line_length: T.nilable(Integer)
+        max_line_length: T.nilable(Integer),
       ).void
     end
     def print(out: $stdout, indent: 0, print_locs: false, max_line_length: nil)
@@ -149,7 +150,7 @@ module RBI
         out: T.any(IO, StringIO),
         indent: Integer,
         print_locs: T::Boolean,
-        max_line_length: T.nilable(Integer)
+        max_line_length: T.nilable(Integer),
       ).void
     end
     def print(out: $stdout, indent: 0, print_locs: false, max_line_length: nil)
@@ -170,6 +171,7 @@ module RBI
       return unless previous_node
       return if previous_node.is_a?(BlankLine)
       return if previous_node.oneline? && oneline?
+
       v.printn
     end
 

data/lib/rbi/rewriters/add_sig_templates.rb

@@ -36,7 +36,7 @@ module RBI
 
         attr.sigs << Sig.new(
           params: params,
-          return_type: "T.untyped"
+          return_type: "T.untyped",
         )
         add_todo_comment(attr)
       end
@@ -47,7 +47,7 @@ module RBI
 
         method.sigs << Sig.new(
           params: method.params.map { |param| SigParam.new(param.name, "T.untyped") },
-          return_type: "T.untyped"
+          return_type: "T.untyped",
         )
         add_todo_comment(method)
       end

data/lib/rbi/rewriters/annotate.rb

@@ -30,6 +30,7 @@ module RBI
       sig { params(node: NodeWithComments).void }
       def annotate_node(node)
         return if node.annotations.one?(@annotation)
+
         node.comments << Comment.new("@#{@annotation}")
       end
 
@@ -49,7 +50,7 @@ module RBI
       visitor = Rewriters::Annotate.new(
         annotation,
         annotate_scopes: annotate_scopes,
-        annotate_properties: annotate_properties
+        annotate_properties: annotate_properties,
       )
       visitor.visit(self)
     end

data/lib/rbi/rewriters/deannotate.rb

@@ -26,6 +26,7 @@ module RBI
       sig { params(node: NodeWithComments).void }
       def deannotate_node(node)
         return unless node.annotations.one?(@annotation)
+
         node.comments.reject! do |comment|
           comment.text == "@#{@annotation}"
         end

data/lib/rbi/rewriters/merge_trees.rb

@@ -47,16 +47,20 @@ module RBI
         end
       end
 
-      sig { params(left: Tree, right: Tree, left_name: String, right_name: String, keep: Keep).returns(MergeTree) }
-      def self.merge_trees(left, right, left_name: "left", right_name: "right", keep: Keep::NONE)
-        left.nest_singleton_methods!
-        right.nest_singleton_methods!
-        rewriter = Rewriters::Merge.new(left_name: left_name, right_name: right_name, keep: keep)
-        rewriter.merge(left)
-        rewriter.merge(right)
-        tree = rewriter.tree
-        ConflictTreeMerger.new.visit(tree)
-        tree
+      class << self
+        extend T::Sig
+
+        sig { params(left: Tree, right: Tree, left_name: String, right_name: String, keep: Keep).returns(MergeTree) }
+        def merge_trees(left, right, left_name: "left", right_name: "right", keep: Keep::NONE)
+          left.nest_singleton_methods!
+          right.nest_singleton_methods!
+          rewriter = Rewriters::Merge.new(left_name: left_name, right_name: right_name, keep: keep)
+          rewriter.merge(left)
+          rewriter.merge(right)
+          tree = rewriter.tree
+          ConflictTreeMerger.new.visit(tree)
+          tree
+        end
       end
 
       sig { returns(MergeTree) }
@@ -293,6 +297,7 @@ module RBI
       parent = T.let(parent_tree, T.nilable(Node))
       while parent
         return parent if parent.is_a?(ConflictTree)
+
         parent = parent.parent_tree
       end
       nil
@@ -305,6 +310,7 @@ module RBI
     sig { override.params(other: Node).void }
     def merge_with(other)
       return unless other.is_a?(NodeWithComments)
+
       other.comments.each do |comment|
         comments << comment unless comments.include?(comment)
       end
@@ -332,7 +338,7 @@ module RBI
         loc: T.nilable(Loc),
         comments: T::Array[Comment],
         conflicts: T::Array[Rewriters::Merge::Conflict],
-        block: T.nilable(T.proc.params(node: Tree).void)
+        block: T.nilable(T.proc.params(node: Tree).void),
       ).void
     end
     def initialize(loc: nil, comments: [], conflicts: [], &block)
@@ -406,12 +412,14 @@ module RBI
     def compatible_with?(other)
       return false unless other.is_a?(Attr)
       return false unless names == other.names
+
       sigs.empty? || other.sigs.empty? || sigs == other.sigs
     end
 
     sig { override.params(other: Node).void }
     def merge_with(other)
       return unless other.is_a?(Attr)
+
       super
       other.sigs.each do |sig|
         sigs << sig unless sigs.include?(sig)
@@ -454,12 +462,14 @@ module RBI
       return false unless other.is_a?(Method)
       return false unless name == other.name
       return false unless params == other.params
+
       sigs.empty? || other.sigs.empty? || sigs == other.sigs
     end
 
     sig { override.params(other: Node).void }
     def merge_with(other)
       return unless other.is_a?(Method)
+
       super
       other.sigs.each do |sig|
         sigs << sig unless sigs.include?(sig)
@@ -545,6 +555,7 @@ module RBI
     sig { override.params(other: Node).void }
     def merge_with(other)
       return unless other.is_a?(TEnumBlock)
+
       super
       other.names.each do |name|
         names << name unless names.include?(name)
@@ -625,7 +636,7 @@ module RBI
         left: Scope,
         right: Scope,
         left_name: String,
-        right_name: String
+        right_name: String,
       ).void
     end
     def initialize(left:, right:, left_name: "left", right_name: "right")

data/lib/rbi/rewriters/nest_non_public_methods.rb

@@ -19,6 +19,7 @@ module RBI
           node.nodes.dup.each do |child|
             visit(child)
             next unless child.is_a?(Method)
+
             child.detach
             case child.visibility
             when Protected

data/lib/rbi/rewriters/nest_singleton_methods.rb

@@ -17,6 +17,7 @@ module RBI
           node.nodes.dup.each do |child|
             visit(child)
             next unless child.is_a?(Method) && child.is_singleton
+
             child.detach
             child.is_singleton = false
             singleton_class << child

data/lib/rbi/rewriters/remove_known_definitions.rb

@@ -48,18 +48,6 @@ module RBI
     class RemoveKnownDefinitions < Visitor
       extend T::Sig
 
-      sig do
-        params(
-          tree: Tree,
-          index: Index
-        ).returns([Tree, T::Array[Operation]])
-      end
-      def self.remove(tree, index)
-        v = RemoveKnownDefinitions.new(index)
-        v.visit(tree)
-        [tree, v.operations]
-      end
-
       sig { returns(T::Array[Operation]) }
       attr_reader :operations
 
@@ -70,6 +58,22 @@ module RBI
         @operations = T.let([], T::Array[Operation])
       end
 
+      class << self
+        extend T::Sig
+
+        sig do
+          params(
+            tree: Tree,
+            index: Index,
+          ).returns([Tree, T::Array[Operation]])
+        end
+        def remove(tree, index)
+          v = RemoveKnownDefinitions.new(index)
+          v.visit(tree)
+          [tree, v.operations]
+        end
+      end
+
       sig { params(nodes: T::Array[Node]).void }
       def visit_all(nodes)
         nodes.dup.each { |node| visit(node) }

data/lib/rbi/rewriters/sort_nodes.rb

@@ -11,20 +11,32 @@ module RBI
         sort_node_names!(node) if node
 
         return unless node.is_a?(Tree)
+
         visit_all(node.nodes)
         original_order = node.nodes.map.with_index.to_h
-        node.nodes.sort! do |a, b|
-          # First we try to compare the nodes by their node rank (based on the node type)
-          res = node_rank(a) <=> node_rank(b)
-          next res if res != 0 # we can sort the nodes by their rank, let's stop here
 
-          # Then, if the nodes ranks are the same (res == 0), we try to compare the nodes by their name
-          res = node_name(a) <=> node_name(b)
-          next res if res && res != 0 # we can sort the nodes by their name, let's stop here
+        # The child nodes could contain private/protected markers. If so, they should not be moved in the file.
+        # Otherwise, some methods could see their privacy change. To avoid that problem, divide the array of child
+        # nodes into chunks based on whether any Visibility nodes appear, and sort the chunks independently. This
+        # applies the ordering rules from the node_rank method as much as possible, while preserving visibility.
+        sorted_nodes = node.nodes.chunk do |n|
+          n.is_a?(Visibility)
+        end.flat_map do |_, nodes|
+          nodes.sort! do |a, b|
+            # First we try to compare the nodes by their node rank (based on the node type)
+            res = node_rank(a) <=> node_rank(b)
+            next res if res != 0 # we can sort the nodes by their rank, let's stop here
+
+            # Then, if the nodes ranks are the same (res == 0), we try to compare the nodes by their name
+            res = node_name(a) <=> node_name(b)
+            next res if res && res != 0 # we can sort the nodes by their name, let's stop here
 
-          # Finally, if the two nodes have the same rank and the same name or at least one node is anonymous then,
-          T.must(original_order[a]) <=> T.must(original_order[b]) # we keep the original order
+            # Finally, if the two nodes have the same rank and the same name or at least one node is anonymous then,
+            T.must(original_order[a]) <=> T.must(original_order[b]) # we keep the original order
+          end
         end
+
+        node.nodes.replace(sorted_nodes)
       end
 
       private

data/lib/rbi/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RBI
-  VERSION = "0.0.16"
+  VERSION = "0.1.0"
 end

data/lib/rbi.rb

@@ -3,11 +3,6 @@
 
 require "sorbet-runtime"
 require "stringio"
-
-module RBI
-  class Error < StandardError; end
-end
-
 require "rbi/loc"
 require "rbi/model"
 require "rbi/visitor"

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rbi
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ast
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.4.0
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.9204
 - !ruby/object:Gem::Dependency
-  name: unparser
+  name: yarp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
 description: 
 email:
 - ruby@shopify.com
@@ -107,14 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: RBI generation framework