tapioca 0.17.10 → 0.19.0

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

@@ -0,0 +1,60 @@
+# typed: strict
+# frozen_string_literal: true
+
+return unless defined?(ActiveSupport::EnvironmentInquirer)
+
+module Tapioca
+  module Dsl
+    module Compilers
+      # `Tapioca::Dsl::Compilers::ActiveSupportEnvironmentInquirer` decorates an RBI file for non-default environment
+      # files in the `config/environments` directory.
+      #
+      # For example, in a Rails application with the following files:
+      #
+      # - config/environments/development.rb
+      # - config/environments/demo.rb
+      # - config/environments/production.rb
+      # - config/environments/staging.rb
+      # - config/environments/test.rb
+      #
+      # this compiler will produce an RBI file with the following content:
+      # ~~~rbi
+      # # typed: true
+      #
+      # class ActiveSupport::EnvironmentInquirer
+      #   sig { returns(T::Boolean) }
+      #   def demo?; end
+      #
+      #   sig { returns(T::Boolean) }
+      #   def staging?; end
+      # end
+      # ~~~
+      #: [ConstantType = singleton(::ActiveSupport::EnvironmentInquirer)]
+      class ActiveSupportEnvironmentInquirer < Compiler
+        # @override
+        #: -> void
+        def decorate
+          envs = Rails.root.glob("config/environments/*.rb").map { |f| f.basename(".rb").to_s }.sort
+          envs -= ::ActiveSupport::EnvironmentInquirer::DEFAULT_ENVIRONMENTS
+          return if envs.none?
+
+          root.create_path(::ActiveSupport::EnvironmentInquirer) do |mod|
+            envs.each do |env|
+              mod.create_method("#{env}?", return_type: "T::Boolean")
+            end
+          end
+        end
+
+        class << self
+          # @override
+          #: -> T::Enumerable[T::Module[top]]
+          def gather_constants
+            return [] unless defined?(Rails.application) && Rails.application
+
+            [::ActiveSupport::EnvironmentInquirer]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,8 +36,6 @@ module Tapioca
       # ```
       #: [ConstantType = singleton(::Time)]
       class ActiveSupportTimeExt < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -55,8 +53,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -42,8 +42,6 @@ module Tapioca
       # ```
       #: [ConstantType = T::Module[top]]
       class Config < Compiler
-        extend T::Sig
-
         CONFIG_OPTIONS_SUFFIX = "ConfigOptions"
 
         # @override
@@ -93,8 +91,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -60,8 +60,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = (singleton(::FrozenRecord::Base) & Extensions::FrozenRecord)]
       class FrozenRecord < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -85,8 +83,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -36,8 +36,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(GraphQL::Schema::InputObject)]
       class GraphqlInputObject < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -74,8 +72,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -37,8 +37,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(GraphQL::Schema::Mutation)]
       class GraphqlMutation < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -71,8 +69,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -57,8 +57,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::ActiveRecord::Base)]
       class IdentityCache < Compiler
-        extend T::Sig
-
         COLLECTION_TYPE = ->(type) { "T::Array[::#{type}]" } #: ^((T::Module[top] | String) type) -> String
 
         # @override
@@ -92,8 +90,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -81,8 +81,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::JsonApiClient::Resource)]
       class JsonApiClientResource < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -106,8 +104,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants
@@ -142,17 +138,7 @@ module Tapioca
           type = ::JsonApiClient::Schema::TypeFactory.type_for(property.type)
           return "T.untyped" if type.nil?
 
-          sorbet_type = if type.respond_to?(:sorbet_type)
-            line, file = type.method(:sorbet_type).source_location
-
-            $stderr.puts <<~MESSAGE
-              WARNING: `#sorbet_type` is deprecated. Please rename your method to `#__tapioca_type`."
-
-              Defined on line #{line} of #{file}
-            MESSAGE
-
-            type.sorbet_type
-          elsif type.respond_to?(:__tapioca_type)
+          tapioca_type = if type.respond_to?(:__tapioca_type)
             type.__tapioca_type
           elsif type == ::JsonApiClient::Schema::Types::Integer
             "::Integer"
@@ -171,9 +157,9 @@ module Tapioca
           end
 
           if property.default.nil?
-            as_nilable_type(sorbet_type)
+            as_nilable_type(tapioca_type)
           else
-            sorbet_type
+            tapioca_type
           end
         end
 

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

@@ -65,8 +65,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = (Class[::Kredis::Attributes] & ::Kredis::Attributes::ClassMethods & Extensions::Kredis)]
       class Kredis < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -85,8 +83,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -46,8 +46,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = T::Module[top]]
       class MixedInClassAttributes < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -60,8 +58,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -73,8 +73,6 @@ module Tapioca
           prop :default, String
         end
 
-        extend T::Sig
-
         FIELD_RE = /^[a-z_][a-zA-Z0-9_]*$/
 
         # @override
@@ -153,8 +151,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -35,8 +35,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::Rails::Generators::Base)]
       class RailsGenerators < Compiler
-        extend T::Sig
-
         BUILT_IN_MATCHER = /::(ActionMailbox|ActionText|ActiveRecord|Rails)::Generators/
 
         # @override
@@ -57,8 +55,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -43,8 +43,6 @@ module Tapioca
       # * `self.perform_in` will also accept a `ActiveSupport::Duration` value
       #: [ConstantType = singleton(::Sidekiq::Worker)]
       class SidekiqWorker < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -84,8 +82,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -60,8 +60,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = singleton(::SmartProperties)]
       class SmartProperties < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -81,8 +79,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -111,8 +111,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = (T::Module[top] & ::StateMachines::ClassMethods)]
       class StateMachines < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -155,8 +153,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
-
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

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

@@ -80,8 +80,6 @@ module Tapioca
       # ~~~
       #: [ConstantType = T::Module[top]]
       class UrlHelpers < Compiler
-        extend T::Sig
-
         # @override
         #: -> void
         def decorate
@@ -97,7 +95,6 @@ module Tapioca
         end
 
         class << self
-          extend T::Sig
           # @override
           #: -> Enumerable[T::Module[top]]
           def gather_constants

data/lib/tapioca/dsl/helpers/active_model_type_helper.rb

@@ -6,8 +6,6 @@ module Tapioca
     module Helpers
       module ActiveModelTypeHelper
         class << self
-          extend T::Sig
-
           # Returns the type indicated by the custom ActiveModel::Type::Value.
           # Accepts subclasses of ActiveModel::Type::Value as well as classes that implement similar methods.
           #: (untyped type_value) -> String

data/lib/tapioca/dsl/helpers/active_record_column_type_helper.rb

@@ -7,12 +7,9 @@ module Tapioca
   module Dsl
     module Helpers
       class ActiveRecordColumnTypeHelper
-        extend T::Sig
         include RBIHelper
 
         class ColumnTypeOption < T::Enum
-          extend T::Sig
-
           enums do
             Untyped = new("untyped")
             Nilable = new("nilable")
@@ -20,8 +17,6 @@ module Tapioca
           end
 
           class << self
-            extend T::Sig
-
             #: (
             #|   Hash[String, untyped] options,
             #| ) { (String value, ColumnTypeOption default_column_type_option) -> void } -> ColumnTypeOption

data/lib/tapioca/dsl/helpers/active_record_constants_helper.rb

@@ -5,8 +5,6 @@ module Tapioca
   module Dsl
     module Helpers
       module ActiveRecordConstantsHelper
-        extend T::Sig
-
         ReflectionType = T.type_alias do
           T.any(::ActiveRecord::Reflection::ThroughReflection, ::ActiveRecord::Reflection::AssociationReflection)
         end

data/lib/tapioca/dsl/helpers/graphql_type_helper.rb

@@ -7,8 +7,6 @@ module Tapioca
       module GraphqlTypeHelper
         extend self
 
-        extend T::Sig
-
         #: (
         #|   GraphQL::Schema::Argument argument,
         #|   (singleton(GraphQL::Schema::Mutation) | singleton(GraphQL::Schema::InputObject)) constant

data/lib/tapioca/dsl/pipeline.rb

@@ -4,8 +4,6 @@
 module Tapioca
   module Dsl
     class Pipeline
-      extend T::Sig
-
       #: Enumerable[singleton(Compiler)]
       attr_reader :active_compilers
 

data/lib/tapioca/executor.rb

@@ -3,8 +3,6 @@
 
 module Tapioca
   class Executor
-    extend T::Sig
-
     MINIMUM_ITEMS_PER_WORKER = 2 #: Integer
 
     #: (Array[untyped] queue, ?number_of_workers: Integer?) -> void

data/lib/tapioca/gem/events.rb

@@ -5,12 +5,9 @@ module Tapioca
   module Gem
     # @abstract
     class Event
-      extend T::Sig
     end
 
     class SymbolFound < Event
-      extend T::Sig
-
       #: String
       attr_reader :symbol
 
@@ -22,8 +19,6 @@ module Tapioca
     end
 
     class ConstantFound < Event
-      extend T::Sig
-
       #: String
       attr_reader :symbol
 
@@ -41,8 +36,6 @@ module Tapioca
     end
 
     class ForeignConstantFound < ConstantFound
-      extend T::Sig
-
       # @override
       #: -> T::Module[top]
       def constant
@@ -57,8 +50,6 @@ module Tapioca
 
     # @abstract
     class NodeAdded < Event
-      extend T::Sig
-
       #: String
       attr_reader :symbol
 
@@ -74,8 +65,6 @@ module Tapioca
     end
 
     class ConstNodeAdded < NodeAdded
-      extend T::Sig
-
       #: RBI::Const
       attr_reader :node
 
@@ -87,8 +76,6 @@ module Tapioca
     end
 
     class ScopeNodeAdded < NodeAdded
-      extend T::Sig
-
       #: RBI::Scope
       attr_reader :node
 
@@ -102,8 +89,6 @@ module Tapioca
     class ForeignScopeNodeAdded < ScopeNodeAdded; end
 
     class MethodNodeAdded < NodeAdded
-      extend T::Sig
-
       #: UnboundMethod
       attr_reader :method
 

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

@@ -6,7 +6,6 @@ module Tapioca
     module Listeners
       # @abstract
       class Base
-        extend T::Sig
         #: (Pipeline pipeline) -> void
         def initialize(pipeline)
           @pipeline = pipeline

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/dynamic_mixins.rb

@@ -5,8 +5,6 @@ module Tapioca
   module Gem
     module Listeners
       class DynamicMixins < Base
-        extend T::Sig
-
         include Runtime::Reflection
 
         private

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

@@ -5,8 +5,6 @@ module Tapioca
   module Gem
     module Listeners
       class ForeignConstants < Base
-        extend T::Sig
-
         include Runtime::Reflection
 
         private

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

@@ -5,8 +5,6 @@ module Tapioca
   module Gem
     module Listeners
       class Methods < Base
-        extend T::Sig
-
         include RBIHelper
         include Runtime::Reflection
 

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

@@ -5,8 +5,6 @@ module Tapioca
   module Gem
     module Listeners
       class Mixins < Base
-        extend T::Sig
-
         include Runtime::Reflection
 
         private

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

@@ -5,8 +5,6 @@ module Tapioca
   module Gem
     module Listeners
       class RemoveEmptyPayloadScopes < Base
-        extend T::Sig
-
         include Runtime::Reflection
 
         private

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

@@ -5,8 +5,6 @@ module Tapioca
   module Gem
     module Listeners
       class SorbetEnums < Base
-        extend T::Sig
-
         private
 
         # @override

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

@@ -5,8 +5,6 @@ module Tapioca
   module Gem
     module Listeners
       class SorbetHelpers < Base
-        extend T::Sig
-
         include Runtime::Reflection
 
         private