rbi 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1232511f52f703972d6946a815937759221dcae1b15f762dad7e214760c5551b
-  data.tar.gz: 66df06e9f8f8975b6260eca5b3a8756a5126fa6f76e3ffcdd2a9d58cf4f179a2
+  metadata.gz: 97c295f819a7f55175bf02dc1722a7a6ad29c82f92c7f9be2636a47652d0b39f
+  data.tar.gz: f0ab6cb29d0e2a1a0ef78452543258761664d081845b042c0f5f1fc2f74f9773
 SHA512:
-  metadata.gz: ec7d1e8a75d67d1ff57f13d29e60e25c71f650ef0b948e0b617ab9bed4a4fc7ccbf0cb44d4746532077378dfc848a8eef9a4e244e082e7aef3e6971036a8f7c5
-  data.tar.gz: ac6d329c267dd116df762972b7baa4f3d43277b4a26e3c05e42290a55aca33182149d9361ca4622d50bc63587661f4d99af284626ee72f7f809f8d7f3c78c251
+  metadata.gz: cb97cd66fd4231f3609efede4b98f8590cf7fff1382b4dbae1997161a8b2aed5ed10e6bc388d8388a16dc71792ba5b5ec32561b37f353cc8b77cbfb778542a60
+  data.tar.gz: a44902b6c3a669c0d706952459b2ebdbe78bbfdcf75ed50b0d16274f9fafa2cba20adb7ce0b70bf2011765edcfe9ea4cf823bb973618e4babd091fdc5e3fafd8

data/Gemfile

@@ -13,5 +13,5 @@ group(:development, :test) do
   gem("rubocop-shopify", require: false)
   gem("rubocop-sorbet", require: false)
   gem("sorbet", ">= 0.5.9204", require: false)
-  gem("tapioca", require: false, github: "Shopify/tapioca", branch: "master")
+  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

@@ -178,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

@@ -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
@@ -171,7 +180,7 @@ module RBI
     end
   end
 
-  class EmptyComment
+  class BlankLine
     extend T::Sig
 
     sig { override.params(v: Printer).void }
@@ -201,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)
@@ -295,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)
@@ -309,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) }
@@ -346,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)
@@ -521,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)
@@ -543,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)
@@ -659,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)
@@ -699,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)
@@ -713,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,7 +47,7 @@ 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!
@@ -59,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 }
@@ -67,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
@@ -314,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

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RBI
-  VERSION = "0.0.6"
+  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.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -83,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