tapioca 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659ca0696f2d5827518829428768bcd7b679532b7f554b893d16915c6d2389df
-  data.tar.gz: 2500137b33f2a4c4491200c579f6fc762c8a183257f741bfbd86148c7561db4d
+  metadata.gz: 1af20de26e446268513156110cac416ce7ba2b35f96f4bb7898960d640aa4333
+  data.tar.gz: 4d760ed85be418d9c9dc166d61ea59ccaf312c929bd4930709abc4b946f3876f
 SHA512:
-  metadata.gz: 54af5a5d84ce82b7ed58ff41d0656f1979f180edbc90bd08750e6767e1cfb400a92522bb8f9ba23739c1f00739db0049a019f1635516e1fbe4789dfb4a10bf4d
-  data.tar.gz: 5e3e2784bdd12d0bc9f79d7aefc21ad07b71d4b50962c4f4e391ec9be9958f6accf1e82a1e076c88f243209487066ee23d13377a864bf7bc7d6cd8b10db8e79a
+  metadata.gz: 1bf6bbf64b782f072a23109ca90cf9c3743b82501bf304badcd97b816583f2fff3ec3574d58df22f05af716d750ba86589074f43a1ee5d3f9e383fdb83c8ee02
+  data.tar.gz: a4d066179177ee84ee349bb7a8514d9b2ad8836051b33adc45ca3708948ddc01a002d6d54fd9c42cc0993ca5e30f74a61f5f5ad8a603ef493b50bee0c7d6ef93

data/README.md

@@ -161,7 +161,7 @@ All operations performed in working directory.
 Please review changes and commit them.
 ```
 
-This will load your application, find all the gems required by it and generate an RBI file for each gem under the `sorbet/rbi/gems` directory for each of those gems. This process will also import signatures that can be found inside each gem sources, and, optionally, any YARD documentation inside the gem.
+This will load your application, find all the gems required by it and generate an RBI file for each gem under the `sorbet/rbi/gems` directory for each of those gems. This process will also import signatures that can be found inside each gem sources, and, optionally, any documentation inside the gem.
 
 <!-- START_HELP_COMMAND_GEM -->
 ```shell
@@ -187,7 +187,7 @@ Options:
                                                                                                      # Default: {"activesupport" => "false"}
                [--verify], [--no-verify], [--skip-verify]                                            # Verify RBIs are up-to-date
                                                                                                      # Default: false
-               [--doc], [--no-doc], [--skip-doc]                                                     # Include YARD documentation from sources when generating RBIs. Warning: this might be slow
+               [--doc], [--no-doc], [--skip-doc]                                                     # Include documentation from sources when generating RBIs
                                                                                                      # Default: true
                [--loc], [--no-loc], [--skip-loc]                                                     # Include comments with source location when generating RBIs
                                                                                                      # Default: true

data/lib/tapioca/cli.rb

@@ -225,7 +225,7 @@ module Tapioca
       default: false
     option :doc,
       type: :boolean,
-      desc: "Include YARD documentation from sources when generating RBIs. Warning: this might be slow",
+      desc: "Include documentation from sources when generating RBIs",
       default: true
     option :loc,
       type: :boolean,

data/lib/tapioca/dsl/compiler.rb

@@ -139,11 +139,16 @@ module Tapioca
 
       #: (RBI::Scope scope, (Method | UnboundMethod) method_def, ?class_method: bool) -> void
       def create_method_from_def(scope, method_def, class_method: false)
+        parameters = compile_method_parameters_to_rbi(method_def)
+        return_type = compile_method_return_type_to_rbi(method_def)
+        type_params = extract_type_parameters(parameters.map(&:type).push(return_type))
+
         scope.create_method(
           method_def.name.to_s,
-          parameters: compile_method_parameters_to_rbi(method_def),
-          return_type: compile_method_return_type_to_rbi(method_def),
+          parameters: parameters,
+          return_type: return_type,
           class_method: class_method,
+          type_params: type_params,
         )
       end
 

data/lib/tapioca/dsl/compilers/aasm.rb

@@ -90,7 +90,10 @@ module Tapioca
               end
 
               # Create all of the methods for each event
-              parameters = [create_rest_param("opts", type: "T.untyped")]
+              parameters = [
+                create_rest_param("opts", type: "T.untyped"),
+                create_block_param("block", type: "T.nilable(T.proc.void)"),
+              ]
               state_machine.events.each do |event|
                 model.create_method(event.name.to_s, parameters: parameters)
                 model.create_method("#{event.name}!", parameters: parameters)

data/lib/tapioca/gem/listeners/documentation.rb

@@ -0,0 +1,94 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Tapioca
+  module Gem
+    module Listeners
+      class Documentation < Base
+        IGNORED_COMMENTS = [
+          ":doc:",
+          ":nodoc:",
+          "typed:",
+          "frozen_string_literal:",
+          "encoding:",
+          "warn_indent:",
+          "shareable_constant_value:",
+          "rubocop:",
+          "@requires_ancestor:",
+        ] #: Array[String]
+
+        #: (Pipeline pipeline, Rubydex::Graph gem_graph) -> void
+        def initialize(pipeline, gem_graph)
+          super(pipeline)
+
+          @gem_graph = gem_graph
+        end
+
+        private
+
+        #: (String line) -> bool
+        def rbs_comment?(line)
+          line.start_with?(": ", "| ")
+        end
+
+        # @override
+        #: (ConstNodeAdded event) -> void
+        def on_const(event)
+          event.node.comments = documentation_comments(event.symbol)
+        end
+
+        # @override
+        #: (ScopeNodeAdded event) -> void
+        def on_scope(event)
+          event.node.comments = documentation_comments(event.symbol)
+        end
+
+        # @override
+        #: (MethodNodeAdded event) -> void
+        def on_method(event)
+          name = if event.constant.singleton_class?
+            "#{event.symbol}::<#{event.symbol.split("::").last}>##{event.node.name}()"
+          else
+            "#{event.symbol}##{event.node.name}()"
+          end
+          event.node.comments = documentation_comments(name, sigs: event.node.sigs)
+        end
+
+        #: (String name, ?sigs: Array[RBI::Sig]) -> Array[RBI::Comment]
+        def documentation_comments(name, sigs: [])
+          declaration = @gem_graph[name]
+          # For attr_writer methods (name ending in =), fall back to reader docs
+          if declaration.nil? && name.end_with?("=()")
+            declaration = @gem_graph[name.delete_suffix("=()") + "()"]
+          end
+          # For singleton methods (Class::<Class>#method()), fall back to instance method docs.
+          # This handles module_function and extend self methods which Rubydex indexes
+          # only under the instance method name.
+          if declaration.nil? && name.include?("::<")
+            declaration = @gem_graph[name.sub(/::<[^>]+>#/, "#")]
+          end
+          return [] unless declaration
+
+          comments = declaration.definitions.flat_map(&:comments)
+          comments.uniq!
+          return [] if comments.empty?
+
+          lines = comments
+            .map { |comment| comment.string.gsub(/^#+ ?/, "") }
+            .reject { |line| IGNORED_COMMENTS.any? { |comment| line.include?(comment) } || rbs_comment?(line) }
+
+          # Strip leading and trailing blank lines, matching YARD's behavior
+          lines = lines.reverse_each.drop_while(&:empty?).reverse_each.drop_while(&:empty?)
+
+          lines.map! { |line| RBI::Comment.new(line) }
+        end
+
+        # @override
+        #: (NodeAdded event) -> bool
+        def ignore?(event)
+          event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
+        end
+      end
+    end
+  end
+end

data/lib/tapioca/gem/listeners/sorbet_signatures.rb

@@ -8,8 +8,6 @@ module Tapioca
         include Runtime::Reflection
         include RBIHelper
 
-        TYPE_PARAMETER_MATCHER = /T\.type_parameter\(:?([[:word:]]+)\)/
-
         private
 
         # @override
@@ -42,9 +40,7 @@ module Tapioca
           sig.return_type = return_type
           @pipeline.push_symbol(return_type)
 
-          parameter_types.values.join(", ").scan(TYPE_PARAMETER_MATCHER).flatten.uniq.each do |k, _|
-            sig.type_params << k
-          end
+          sig.type_params.concat(extract_type_parameters(parameter_types.values.map(&:to_s).push(return_type)))
 
           case signature.mode
           when "abstract"

data/lib/tapioca/gem/listeners.rb

@@ -14,5 +14,5 @@ require "tapioca/gem/listeners/sorbet_signatures"
 require "tapioca/gem/listeners/sorbet_type_variables"
 require "tapioca/gem/listeners/subconstants"
 require "tapioca/gem/listeners/foreign_constants"
-require "tapioca/gem/listeners/yard_doc"
+require "tapioca/gem/listeners/documentation"
 require "tapioca/gem/listeners/source_location"

data/lib/tapioca/gem/pipeline.rb

@@ -32,6 +32,7 @@ module Tapioca
 
         @payload_symbols = Static::SymbolLoader.payload_symbols #: Set[String]
         @bootstrap_symbols = load_bootstrap_symbols(@gem) #: Set[String]
+        gem_graph = Static::SymbolLoader.graph_from_paths(@gem.files) if include_doc
 
         @bootstrap_symbols.each { |symbol| push_symbol(symbol) }
 
@@ -46,7 +47,7 @@ module Tapioca
         @node_listeners << Gem::Listeners::SorbetRequiredAncestors.new(self)
         @node_listeners << Gem::Listeners::SorbetSignatures.new(self)
         @node_listeners << Gem::Listeners::Subconstants.new(self)
-        @node_listeners << Gem::Listeners::YardDoc.new(self) if include_doc
+        @node_listeners << Gem::Listeners::Documentation.new(self, gem_graph) if include_doc
         @node_listeners << Gem::Listeners::ForeignConstants.new(self)
         @node_listeners << Gem::Listeners::SourceLocation.new(self) if include_loc
         @node_listeners << Gem::Listeners::RemoveEmptyPayloadScopes.new(self)

data/lib/tapioca/gemfile.rb

@@ -177,22 +177,6 @@ module Tapioca
         end
       end
 
-      #: -> void
-      def parse_yard_docs
-        files.each do |path|
-          YARD.parse(path.to_s, [], Logger::Severity::FATAL)
-        rescue RangeError
-          # In some circumstances, YARD will raise an error when parsing a file
-          # that is actually valid Ruby. We don't want tapioca to halt in these
-          # cases, so we'll rescue the error, pretend like there was no
-          # documentation, and move on.
-          #
-          # This can be removed when https://github.com/lsegal/yard/issues/1536
-          # is resolved and released.
-          []
-        end
-      end
-
       #: -> Array[String]
       def exported_rbi_files
         @exported_rbi_files ||= Dir.glob("#{full_gem_path}/rbi/**/*.rbi").sort

data/lib/tapioca/helpers/rbi_helper.rb

@@ -94,6 +94,13 @@ module Tapioca
       end
     end
 
+    TYPE_PARAMETER_MATCHER = /T\.type_parameter\(:?([[:word:]]+)\)/
+
+    #: (Array[String] type_strings) -> Array[String]
+    def extract_type_parameters(type_strings)
+      type_strings.join(", ").scan(TYPE_PARAMETER_MATCHER).flatten.uniq
+    end
+
     #: (String name) -> bool
     def valid_method_name?(name)
       Prism.parse_success?("def self.#{name}(a); end")

data/lib/tapioca/internal.rb

@@ -41,7 +41,7 @@ require "shellwords"
 require "tempfile"
 require "thor"
 require "yaml"
-require "yard-sorbet"
+require "rubydex"
 require "prism"
 
 require "tapioca/helpers/gem_helper"

data/lib/tapioca/rbi_ext/model.rb

@@ -65,10 +65,11 @@ module RBI
     #|   ?return_type: String?,
     #|   ?class_method: bool,
     #|   ?visibility: RBI::Visibility,
-    #|   ?comments: Array[RBI::Comment]
+    #|   ?comments: Array[RBI::Comment],
+    #|   ?type_params: Array[String]
     #| ) ?{ (RBI::Method node) -> void } -> void
     def create_method(name, parameters: [], return_type: nil, class_method: false, visibility: RBI::Public.new,
-      comments: [], &block)
+      comments: [], type_params: [], &block)
       return unless Tapioca::RBIHelper.valid_method_name?(name)
 
       sigs = []
@@ -77,7 +78,7 @@ module RBI
         # If there is no block, and the params and return type have not been supplied, then
         # we create a single signature with the given parameters and return type
         params = parameters.map { |param| RBI::SigParam.new(param.param.name.to_s, param.type) }
-        sigs << RBI::Sig.new(params: params, return_type: return_type || "T.untyped")
+        sigs << RBI::Sig.new(params: params, return_type: return_type || "T.untyped", type_params: type_params)
       end
 
       method = RBI::Method.new(

data/lib/tapioca/runtime/reflection.rb

@@ -213,9 +213,16 @@ module Tapioca
 
       #: (T::Module[top] constant) -> Set[String]
       def file_candidates_for(constant)
-        relevant_methods_for(constant).filter_map do |method|
+        # Grab all source files for (relevant) methods defined on the constant
+        candidates = relevant_methods_for(constant).filter_map do |method|
           method.source_location&.first
         end.to_set
+
+        # Add the source file for the constant definition itself, if available.
+        source_location_candidate = const_source_location(name_of(constant).to_s)&.file
+        candidates.add(source_location_candidate) if source_location_candidate
+
+        candidates
       end
 
       #: (T::Module[top] constant) -> untyped

data/lib/tapioca/static/symbol_loader.rb

@@ -18,6 +18,19 @@ module Tapioca
           T.must(@payload_symbols)
         end
 
+        #: (Array[Pathname] paths) -> Rubydex::Graph
+        def graph_from_paths(paths)
+          graph = Rubydex::Graph.new
+          graph.index_all(paths.map(&:to_s))
+          graph.resolve
+          graph
+        end
+
+        #: (Gemfile::GemSpec gem) -> Set[String]
+        def gem_symbols(gem)
+          symbols_from_paths(gem.files)
+        end
+
         #: (Gemfile::GemSpec gem) -> Set[String]
         def engine_symbols(gem)
           gem_engine = engines.find do |engine|
@@ -43,11 +56,6 @@ module Tapioca
           Set.new
         end
 
-        #: (Gemfile::GemSpec gem) -> Set[String]
-        def gem_symbols(gem)
-          symbols_from_paths(gem.files)
-        end
-
         #: (Array[Pathname] paths) -> Set[String]
         def symbols_from_paths(paths)
           return Set.new if paths.empty?

data/lib/tapioca/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Tapioca
-  VERSION = "0.18.0"
+  VERSION = "0.19.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -83,47 +83,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.2
 - !ruby/object:Gem::Dependency
-  name: sorbet-static-and-runtime
+  name: rubydex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.11087
+        version: 0.1.0.beta10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.11087
+        version: 0.1.0.beta10
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: sorbet-static-and-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 0.5.11087
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 0.5.11087
 - !ruby/object:Gem::Dependency
-  name: yard-sorbet
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rbi
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +253,7 @@ files:
 - lib/tapioca/gem/events.rb
 - lib/tapioca/gem/listeners.rb
 - lib/tapioca/gem/listeners/base.rb
+- lib/tapioca/gem/listeners/documentation.rb
 - lib/tapioca/gem/listeners/dynamic_mixins.rb
 - lib/tapioca/gem/listeners/foreign_constants.rb
 - lib/tapioca/gem/listeners/methods.rb
@@ -266,7 +267,6 @@ files:
 - lib/tapioca/gem/listeners/sorbet_type_variables.rb
 - lib/tapioca/gem/listeners/source_location.rb
 - lib/tapioca/gem/listeners/subconstants.rb
-- lib/tapioca/gem/listeners/yard_doc.rb
 - lib/tapioca/gem/pipeline.rb
 - lib/tapioca/gem_info.rb
 - lib/tapioca/gemfile.rb

data/lib/tapioca/gem/listeners/yard_doc.rb

@@ -1,110 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Tapioca
-  module Gem
-    module Listeners
-      class YardDoc < Base
-        IGNORED_COMMENTS = [
-          ":doc:",
-          ":nodoc:",
-          "typed:",
-          "frozen_string_literal:",
-          "encoding:",
-          "warn_indent:",
-          "shareable_constant_value:",
-          "rubocop:",
-          "@requires_ancestor:",
-        ] #: Array[String]
-
-        IGNORED_SIG_TAGS = ["param", "return"] #: Array[String]
-
-        #: (Pipeline pipeline) -> void
-        def initialize(pipeline)
-          YARD::Registry.clear
-          super(pipeline)
-          pipeline.gem.parse_yard_docs
-        end
-
-        private
-
-        #: (String line) -> bool
-        def rbs_comment?(line)
-          line.start_with?(": ", "| ")
-        end
-
-        # @override
-        #: (ConstNodeAdded event) -> void
-        def on_const(event)
-          event.node.comments = documentation_comments(event.symbol)
-        end
-
-        # @override
-        #: (ScopeNodeAdded event) -> void
-        def on_scope(event)
-          event.node.comments = documentation_comments(event.symbol)
-        end
-
-        # @override
-        #: (MethodNodeAdded event) -> void
-        def on_method(event)
-          separator = event.constant.singleton_class? ? "." : "#"
-          event.node.comments = documentation_comments(
-            "#{event.symbol}#{separator}#{event.node.name}",
-            sigs: event.node.sigs,
-          )
-        end
-
-        #: (String name, ?sigs: Array[RBI::Sig]) -> Array[RBI::Comment]
-        def documentation_comments(name, sigs: [])
-          yard_docs = YARD::Registry.at(name)
-          return [] unless yard_docs
-
-          docstring = yard_docs.docstring
-          return [] if /(copyright|license)/i.match?(docstring)
-
-          comments = docstring.lines
-            .reject { |line| IGNORED_COMMENTS.any? { |comment| line.include?(comment) } || rbs_comment?(line) }
-            .map! { |line| RBI::Comment.new(line) }
-
-          tags = yard_docs.tags
-          tags.reject! { |tag| IGNORED_SIG_TAGS.include?(tag.tag_name) } unless sigs.empty?
-
-          comments << RBI::Comment.new("") if comments.any? && tags.any?
-
-          tags.sort_by { |tag| [tag.tag_name, tag.name.to_s] }.each do |tag|
-            line = +"@#{tag.tag_name}"
-
-            tag_name = tag.name
-            line << " #{tag_name}" if tag_name
-
-            tag_types = tag.types
-            line << " [#{tag_types.join(", ")}]" if tag_types&.any?
-
-            tag_text = tag.text
-            if tag_text && !tag_text.empty?
-              text_lines = tag_text.lines
-
-              # Example are a special case because we want the text to start on the next line
-              line << " #{text_lines.shift&.strip}" unless tag.tag_name == "example"
-
-              text_lines.each do |text_line|
-                line << "\n  #{text_line.strip}"
-              end
-            end
-
-            comments << RBI::Comment.new(line)
-          end
-
-          comments
-        end
-
-        # @override
-        #: (NodeAdded event) -> bool
-        def ignore?(event)
-          event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
-        end
-      end
-    end
-  end
-end