rbi 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80af4a72c6b71d1ed72dd5eefc9c2821443cbb7ca00d458bbfd2a381e1297545
-  data.tar.gz: 8d774a3c7094a748a6fab5623eb6da0f5097e00591696e4e22423f3de6a869ee
+  metadata.gz: 97c295f819a7f55175bf02dc1722a7a6ad29c82f92c7f9be2636a47652d0b39f
+  data.tar.gz: f0ab6cb29d0e2a1a0ef78452543258761664d081845b042c0f5f1fc2f74f9773
 SHA512:
-  metadata.gz: 259201aa73a41ef445010bb89bd14f69df1ef107dcfdf1becda6ead491ce067d6a0cbb9520f751272a879d76d65c74bb524a67c037447f74e243fd429749fbe7
-  data.tar.gz: b989d25962cca475a307fcf1e76c8c74d74b3079290532e7be0bd3901446dbc800242641557ddc51e3cf2977970059869228f58bef0ff372537ef934b3a46eb2
+  metadata.gz: cb97cd66fd4231f3609efede4b98f8590cf7fff1382b4dbae1997161a8b2aed5ed10e6bc388d8388a16dc71792ba5b5ec32561b37f353cc8b77cbfb778542a60
+  data.tar.gz: a44902b6c3a669c0d706952459b2ebdbe78bbfdcf75ed50b0d16274f9fafa2cba20adb7ce0b70bf2011765edcfe9ea4cf823bb973618e4babd091fdc5e3fafd8

data/Gemfile

@@ -8,9 +8,10 @@ gemspec
 group(:development, :test) do
   gem("byebug")
   gem("minitest")
+  gem("rake", "~> 13.0")
   gem("rubocop", "~> 1.7", require: false)
   gem("rubocop-shopify", require: false)
   gem("rubocop-sorbet", require: false)
-  gem("sorbet", require: false)
-  gem("tapioca", require: false, github: "Shopify/tapioca", branch: "master")
+  gem("sorbet", ">= 0.5.9204", require: false)
+  gem("tapioca", "0.5.2", require: false)
 end

data/lib/rbi/model.rb

@@ -66,7 +66,8 @@ module RBI
     end
   end
 
-  class EmptyComment < Comment
+  # An arbitrary blank line that can be added both in trees and comments
+  class BlankLine < Comment
     extend T::Sig
 
     sig { params(loc: T.nilable(Loc)).void }
@@ -89,6 +90,13 @@ module RBI
       super(loc: loc)
       @comments = comments
     end
+
+    sig { returns(T::Array[String]) }
+    def annotations
+      comments
+        .select { |comment| comment.text.start_with?("@") }
+        .map { |comment| T.must(comment.text[1..]) }
+    end
   end
 
   class Tree < NodeWithComments
@@ -126,10 +134,10 @@ module RBI
     extend T::Sig
 
     sig { returns(Tree) }
-    attr_reader :root
+    attr_accessor :root
 
     sig { returns(T.nilable(String)) }
-    attr_reader :strictness
+    attr_accessor :strictness
 
     sig { returns(T::Array[Comment]) }
     attr_accessor :comments
@@ -152,6 +160,11 @@ module RBI
     def <<(node)
       @root << node
     end
+
+    sig { returns(T::Boolean) }
+    def empty?
+      @root.empty?
+    end
   end
 
   # Scopes

data/lib/rbi/parser.rb

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "unparser"
+require "parser"
 
 module RBI
   class ParseError < StandardError
@@ -27,6 +27,12 @@ module RBI
     ::Parser::Builders::Default.emit_index                = true
     ::Parser::Builders::Default.emit_arg_inside_procarg0  = true
 
+    sig { void }
+    def initialize
+      # Delay load unparser and only if it has not been loaded already.
+      require "unparser" unless defined?(::Unparser)
+    end
+
     sig { params(string: String).returns(Tree) }
     def self.parse_string(string)
       Parser.new.parse_string(string)
@@ -172,7 +178,7 @@ module RBI
 
         if last_line && comment_line > last_line + 1
           # Preserve empty lines in file headers
-          tree.comments << EmptyComment.new(loc: loc)
+          tree.comments << BlankLine.new(loc: loc)
         end
 
         tree.comments << Comment.new(text, loc: loc)

data/lib/rbi/printer.rb

@@ -97,7 +97,7 @@ module RBI
         v.visit_all(comments)
       end
 
-      unless root.empty?
+      unless root.empty? && root.comments.empty?
         v.printn if strictness || !comments.empty?
         v.visit(root)
       end
@@ -136,6 +136,15 @@ module RBI
       out.string
     end
 
+    sig { params(v: Printer).void }
+    def print_blank_line_before(v)
+      previous_node = v.previous_node
+      return unless previous_node
+      return if previous_node.is_a?(BlankLine)
+      return if previous_node.oneline? && oneline?
+      v.printn
+    end
+
     sig { returns(T::Boolean) }
     def oneline?
       true
@@ -156,14 +165,22 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      text = self.text.strip
-      v.printt("#")
-      v.print(" #{text}") unless text.empty?
-      v.printn
+      lines = text.lines
+
+      if lines.empty?
+        v.printl("#")
+      end
+
+      lines.each do |line|
+        text = line.strip
+        v.printt("#")
+        v.print(" #{text}") unless text.empty?
+        v.printn
+      end
     end
   end
 
-  class EmptyComment
+  class BlankLine
     extend T::Sig
 
     sig { override.params(v: Printer).void }
@@ -193,8 +210,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.printl("# #{loc}") if loc && v.print_locs
       v.visit_all(comments)
@@ -287,8 +303,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.printl("# #{loc}") if loc && v.print_locs
       v.visit_all(comments)
@@ -301,8 +316,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.visit_all(comments)
       sigs.each { |sig| v.visit(sig) }
@@ -338,8 +352,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.visit_all(comments)
       v.visit_all(sigs)
@@ -366,13 +379,14 @@ module RBI
             v.printt
             v.visit(param)
             v.print(",") if pindex < params.size - 1
-            param.comments.each_with_index do |comment, cindex|
+
+            param.comments_lines.each_with_index do |comment, cindex|
               if cindex > 0
                 param.print_comment_leading_space(v, last: pindex == params.size - 1)
               else
                 v.print(" ")
               end
-              v.print("# #{comment.text.strip}")
+              v.print("# #{comment}")
             end
             v.printn
           end
@@ -410,6 +424,11 @@ module RBI
       v.print(" " * (name.size + 1))
       v.print(" ") unless last
     end
+
+    sig { returns(T::Array[String]) }
+    def comments_lines
+      comments.flat_map { |comment| comment.text.lines.map(&:strip) }
+    end
   end
 
   class OptParam
@@ -507,8 +526,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.printl("# #{loc}") if loc && v.print_locs
       v.visit_all(comments)
@@ -529,8 +547,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.printl("# #{loc}") if loc && v.print_locs
       v.visit_all(comments)
@@ -576,13 +593,13 @@ module RBI
             v.printt
             v.visit(param)
             v.print(",") if pindex < params.size - 1
-            param.comments.each_with_index do |comment, cindex|
+            param.comments_lines.each_with_index do |comment, cindex|
               if cindex == 0
                 v.print(" ")
               else
                 param.print_comment_leading_space(v, last: pindex == params.size - 1)
               end
-              v.print("# #{comment.text.strip}")
+              v.print("# #{comment}")
             end
             v.printn
           end
@@ -633,6 +650,11 @@ module RBI
       v.print(" " * (name.size + type.size + 3))
       v.print(" ") unless last
     end
+
+    sig { returns(T::Array[String]) }
+    def comments_lines
+      comments.flat_map { |comment| comment.text.lines.map(&:strip) }
+    end
   end
 
   class TStructField
@@ -640,8 +662,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.printl("# #{loc}") if loc && v.print_locs
       v.visit_all(comments)
@@ -680,8 +701,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.printl("# #{loc}") if loc && v.print_locs
       v.visit_all(comments)
@@ -694,8 +714,7 @@ module RBI
 
     sig { override.params(v: Printer).void }
     def accept_printer(v)
-      previous_node = v.previous_node
-      v.printn if previous_node && (!previous_node.oneline? || !oneline?)
+      print_blank_line_before(v)
 
       v.printl("# #{loc}") if loc && v.print_locs
       v.visit_all(comments)

data/lib/rbi/rewriters/annotate.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RBI
+  module Rewriters
+    class Annotate < Visitor
+      extend T::Sig
+
+      sig { params(annotation: String, annotate_scopes: T::Boolean, annotate_properties: T::Boolean).void }
+      def initialize(annotation, annotate_scopes: false, annotate_properties: false)
+        super()
+        @annotation = annotation
+        @annotate_scopes = annotate_scopes
+        @annotate_properties = annotate_properties
+      end
+
+      sig { override.params(node: T.nilable(Node)).void }
+      def visit(node)
+        case node
+        when Scope
+          annotate_node(node) if @annotate_scopes || root?(node)
+        when Const, Attr, Method, TStructField, TypeMember
+          annotate_node(node) if @annotate_properties
+        end
+        visit_all(node.nodes) if node.is_a?(Tree)
+      end
+
+      private
+
+      sig { params(node: NodeWithComments).void }
+      def annotate_node(node)
+        return if node.annotations.one?(@annotation)
+        node.comments << Comment.new("@#{@annotation}")
+      end
+
+      sig { params(node: Node).returns(T::Boolean) }
+      def root?(node)
+        parent = node.parent_tree
+        parent.is_a?(Tree) && parent.parent_tree.nil?
+      end
+    end
+  end
+
+  class Tree
+    extend T::Sig
+
+    sig { params(annotation: String, annotate_scopes: T::Boolean, annotate_properties: T::Boolean).void }
+    def annotate!(annotation, annotate_scopes: false, annotate_properties: false)
+      visitor = Rewriters::Annotate.new(
+        annotation,
+        annotate_scopes: annotate_scopes,
+        annotate_properties: annotate_properties
+      )
+      visitor.visit(self)
+    end
+  end
+end

data/lib/rbi/rewriters/deannotate.rb

@@ -0,0 +1,45 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RBI
+  module Rewriters
+    class Deannotate < Visitor
+      extend T::Sig
+
+      sig { params(annotation: String).void }
+      def initialize(annotation)
+        super()
+        @annotation = annotation
+      end
+
+      sig { override.params(node: T.nilable(Node)).void }
+      def visit(node)
+        case node
+        when Scope, Const, Attr, Method, TStructField, TypeMember
+          deannotate_node(node)
+        end
+        visit_all(node.nodes) if node.is_a?(Tree)
+      end
+
+      private
+
+      sig { params(node: NodeWithComments).void }
+      def deannotate_node(node)
+        return unless node.annotations.one?(@annotation)
+        node.comments.reject! do |comment|
+          comment.text == "@#{@annotation}"
+        end
+      end
+    end
+  end
+
+  class Tree
+    extend T::Sig
+
+    sig { params(annotation: String).void }
+    def deannotate!(annotation)
+      visitor = Rewriters::Deannotate.new(annotation)
+      visitor.visit(self)
+    end
+  end
+end

data/lib/rbi/rewriters/merge_trees.rb

@@ -47,8 +47,10 @@ module RBI
         end
       end
 
-      sig { params(left: Tree, right: Tree, left_name: String, right_name: String, keep: Keep).returns(Tree) }
+      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)
@@ -57,7 +59,7 @@ module RBI
         tree
       end
 
-      sig { returns(Tree) }
+      sig { returns(MergeTree) }
       attr_reader :tree
 
       sig { params(left_name: String, right_name: String, keep: Keep).void }
@@ -65,15 +67,15 @@ module RBI
         @left_name = left_name
         @right_name = right_name
         @keep = keep
-        @tree = T.let(Tree.new, Tree)
+        @tree = T.let(MergeTree.new, MergeTree)
         @scope_stack = T.let([@tree], T::Array[Tree])
       end
 
-      sig { params(tree: Tree).returns(T::Array[Conflict]) }
+      sig { params(tree: Tree).void }
       def merge(tree)
         v = TreeMerger.new(@tree, left_name: @left_name, right_name: @right_name, keep: @keep)
         v.visit(tree)
-        v.conflicts
+        @tree.conflicts.concat(v.conflicts)
       end
 
       # Used for logging / error displaying purpose
@@ -312,9 +314,31 @@ module RBI
   class Tree
     extend T::Sig
 
-    sig { params(other: Tree).returns(Tree) }
-    def merge(other)
-      Rewriters::Merge.merge_trees(self, other)
+    sig { params(other: Tree, left_name: String, right_name: String, keep: Rewriters::Merge::Keep).returns(MergeTree) }
+    def merge(other, left_name: "left", right_name: "right", keep: Rewriters::Merge::Keep::NONE)
+      Rewriters::Merge.merge_trees(self, other, left_name: left_name, right_name: right_name, keep: keep)
+    end
+  end
+
+  # A tree that _might_ contain conflicts
+  class MergeTree < Tree
+    extend T::Sig
+
+    sig { returns(T::Array[Rewriters::Merge::Conflict]) }
+    attr_reader :conflicts
+
+    sig do
+      params(
+        loc: T.nilable(Loc),
+        comments: T::Array[Comment],
+        conflicts: T::Array[Rewriters::Merge::Conflict],
+        block: T.nilable(T.proc.params(node: Tree).void)
+      ).void
+    end
+    def initialize(loc: nil, comments: [], conflicts: [], &block)
+      super(loc: loc, comments: comments)
+      @conflicts = conflicts
+      block&.call(self)
     end
   end
 

data/lib/rbi/version.rb

@@ -1,7 +1,6 @@
 # typed: true
-# typed: false
 # frozen_string_literal: true
 
 module RBI
-  VERSION = "0.0.3"
+  VERSION = "0.0.7"
 end

data/lib/rbi.rb

@@ -13,6 +13,8 @@ require "rbi/model"
 require "rbi/visitor"
 require "rbi/index"
 require "rbi/rewriters/add_sig_templates"
+require "rbi/rewriters/annotate"
+require "rbi/rewriters/deannotate"
 require "rbi/rewriters/merge_trees"
 require "rbi/rewriters/nest_singleton_methods"
 require "rbi/rewriters/nest_non_public_methods"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -38,34 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.9204
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.9204
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +83,8 @@ files:
 - lib/rbi/parser.rb
 - lib/rbi/printer.rb
 - lib/rbi/rewriters/add_sig_templates.rb
+- lib/rbi/rewriters/annotate.rb
+- lib/rbi/rewriters/deannotate.rb
 - lib/rbi/rewriters/group_nodes.rb
 - lib/rbi/rewriters/merge_trees.rb
 - lib/rbi/rewriters/nest_non_public_methods.rb