tapioca 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f969345b0846479b6ab150b42641cbe90a746c59f4d995f10b4cb2dbdcaf588
-  data.tar.gz: a3dcf9bc8b505fb6be05da572b00a0efbb3f544ce7dd2303a55ed2119b34deef
+  metadata.gz: 3c5b81fee880c497fca1e34c644d6da53e4f155e45f564c95eb886f0f6c30d69
+  data.tar.gz: d0973ab750b577064e5891c0fbd9dd71ddeb82b54d7d8dfcabad4841052e8d6d
 SHA512:
-  metadata.gz: 103484877f92cdb0c43d74b2b92462a977082b959ad26a2ed198895941e2e066961884f207eb167db8d6f86b941075b1216bac13d99f69ff6eb85e7bef3f7760
-  data.tar.gz: 2c11680ac5c9be37fb25b8c944e641f471c59bcb95e0e7f427d5839b56702730468e7afc71f8db22efefcad4f04ffad7a66ad15a981a9097b7217df51ca89d2b
+  metadata.gz: 105ab9194d3e62657fedff6d0fd78b187980b5084af80be294690c00a86ac1544b29bd9d86951f50072c895516ce1541251ac2ff05cbb3a2acbbee5d0e103b51
+  data.tar.gz: 612f856fd4b36301dbfee4cdd80615ee4a684447ea077037c5a72e1c7c216be7c465aae13a5b4462a8db9889929765703293d2935036d7ac1e94b8d21d4ee5fb

data/README.md

@@ -473,6 +473,8 @@ Options:
   -e, [--environment=ENVIRONMENT]                # The Rack/Rails environment to use when generating RBIs
                                                  # Default: development
   -l, [--list-compilers], [--no-list-compilers]  # List all loaded compilers
+          [--app-root=APP_ROOT]                  # The path to the Rails application
+                                                 # Default: .
   -c, [--config=<config file path>]              # Path to the Tapioca configuration file
                                                  # Default: sorbet/tapioca/config.yml
   -V, [--verbose], [--no-verbose]                # Verbose output for debugging purposes
@@ -635,6 +637,8 @@ There are two main parts to the DSL compiler API: `gather_constants` and `decora
 * The `gather_constants` class method collects all classes (or modules) that should be processed by this specific DSL compiler.
 * The `decorate` method defines how to generate the necessary RBI definitions for the gathered constants.
 
+Every compiler must declare the type member `ConstantType` in order for Sorbet to understand what the return type of the `constant` attribute reader is. It needs to be assigned the correct type variable matching the type of constants that `gather_constants` returns. This generic variable allows Sorbet to type-check method calls on the `constant` reader in your `decorate` method. See the Sorbet documentation on [generics](https://sorbet.org/docs/generics) for more information.
+
 You can now run the new RBI compiler through the normal DSL generation process (your custom compiler will be loaded automatically by Tapioca):
 
 ```shell
@@ -822,6 +826,7 @@ dsl:
   rbi_max_line_length: 120
   environment: development
   list_compilers: false
+  app_root: "."
 gem:
   outdir: sorbet/rbi/gems
   file_header: true

data/lib/tapioca/cli.rb

@@ -9,6 +9,8 @@ module Tapioca
 
     FILE_HEADER_OPTION_DESC = "Add a \"This file is generated\" header on top of each generated RBI file"
 
+    check_unknown_options!
+
     class_option :config,
       aliases: ["-c"],
       banner: "<config file path>",
@@ -121,6 +123,10 @@ module Tapioca
       type: :boolean,
       desc: "List all loaded compilers",
       default: false
+    option :app_root,
+      type: :string,
+      desc: "The path to the Rails application",
+      default: "."
     def dsl(*constants)
       set_environment(options)
 
@@ -136,6 +142,7 @@ module Tapioca
         verbose: options[:verbose],
         number_of_workers: options[:workers],
         rbi_formatter: rbi_formatter(options),
+        app_root: options[:app_root],
       )
 
       Tapioca.silence_warnings do
@@ -279,7 +286,10 @@ module Tapioca
         payload: options[:payload],
         number_of_workers: options[:workers],
       )
-      command.execute
+
+      Tapioca.silence_warnings do
+        command.execute
+      end
     end
 
     desc "annotations", "Pull gem RBI annotations from remote sources"
@@ -305,7 +315,10 @@ module Tapioca
         netrc_file: netrc_file(options),
         typed_overrides: options[:typed_overrides],
       )
-      command.execute
+
+      Tapioca.silence_warnings do
+        command.execute
+      end
     end
 
     map ["--version", "-v"] => :__print_version

data/lib/tapioca/commands/check_shims.rb

@@ -51,26 +51,18 @@ module Tapioca
         payload_path = T.let(nil, T.nilable(String))
 
         if @payload
-          if sorbet_supports?(:print_payload_sources)
-            Dir.mktmpdir do |dir|
-              payload_path = dir
-              result = sorbet("--no-config --print=payload-sources:#{payload_path}")
-
-              unless result.status
-                raise Thor::Error, <<~ERROR
-                  "Sorbet failed to dump payload"
-                  #{result.err}
-                ERROR
-              end
-
-              index_rbis(index, "payload", payload_path, number_of_workers: @number_of_workers)
+          Dir.mktmpdir do |dir|
+            payload_path = dir
+            result = sorbet("--no-config --print=payload-sources:#{payload_path}")
+
+            unless result.status
+              raise Thor::Error, <<~ERROR
+                "Sorbet failed to dump payload"
+                #{result.err}
+              ERROR
             end
-          else
-            raise Thor::Error, <<~ERROR
-              The version of Sorbet used in your Gemfile.lock does not support `--print=payload-sources`
-              Current: v#{SORBET_GEM_SPEC.version}
-              Required: #{FEATURE_REQUIREMENTS[:print_payload_sources]}
-            ERROR
+
+            index_rbis(index, "payload", payload_path, number_of_workers: @number_of_workers)
           end
         end
 

data/lib/tapioca/commands/dsl.rb

@@ -22,6 +22,7 @@ module Tapioca
           auto_strictness: T::Boolean,
           gem_dir: String,
           rbi_formatter: RBIFormatter,
+          app_root: String,
         ).void
       end
       def initialize(
@@ -37,7 +38,8 @@ module Tapioca
         number_of_workers: nil,
         auto_strictness: true,
         gem_dir: DEFAULT_GEM_DIR,
-        rbi_formatter: DEFAULT_RBI_FORMATTER
+        rbi_formatter: DEFAULT_RBI_FORMATTER,
+        app_root: "."
       )
         @requested_constants = requested_constants
         @outpath = outpath
@@ -52,6 +54,7 @@ module Tapioca
         @auto_strictness = auto_strictness
         @gem_dir = gem_dir
         @rbi_formatter = rbi_formatter
+        @app_root = app_root
 
         super()
       end
@@ -61,6 +64,7 @@ module Tapioca
         Loaders::Dsl.load_application(
           tapioca_path: @tapioca_path,
           eager_load: @requested_constants.empty?,
+          app_root: @app_root,
         )
 
         pipeline = create_pipeline
@@ -87,6 +91,7 @@ module Tapioca
         Loaders::Dsl.load_application(
           tapioca_path: @tapioca_path,
           eager_load: @requested_constants.empty?,
+          app_root: @app_root,
         )
 
         if @should_verify

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

@@ -241,6 +241,7 @@ module Tapioca
 
           klass.create_method(
             association_name.to_s,
+            comments: association_comments(reflection),
             return_type: relation_class,
           )
           klass.create_method(
@@ -320,6 +321,40 @@ module Tapioca
           end
         end
 
+        sig { params(reflection: ReflectionType).returns(T::Array[RBI::Comment]) }
+        def association_comments(reflection)
+          anchor_name = case reflection
+          when ActiveRecord::Reflection::HasOneReflection
+            "the-has-one-association"
+          when ActiveRecord::Reflection::HasManyReflection
+            "the-has-many-association"
+          when ActiveRecord::Reflection::HasAndBelongsToManyReflection
+            "the-has-and-belongs-to-many-association"
+          when ActiveRecord::Reflection::BelongsToReflection
+            "the-belongs-to-association"
+          when ActiveRecord::Reflection::ThroughReflection
+            delegate_reflection = reflection.send(:delegate_reflection)
+            declaration = declaration(delegate_reflection)
+            if T.must(declaration).match?("has_one")
+              "the-has-one-through-association"
+            else
+              "the-has-many-through-association"
+            end
+          end
+
+          if anchor_name
+            url = "https://guides.rubyonrails.org/association_basics.html##{anchor_name}"
+            association_name = anchor_name.sub(/^the-(.*)-association$/, '\1')
+            comment = <<~MSG
+              This method is created by ActiveRecord on the `#{reflection.active_record.name}` class because it declared `#{declaration(reflection)}`.
+              🔗 [Rails guide for `#{association_name.gsub("-", "_")}` association](#{url})
+            MSG
+            [RBI::Comment.new(comment)]
+          else
+            []
+          end
+        end
+
         sig do
           params(
             reflection: ReflectionType,

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

@@ -243,15 +243,9 @@ module Tapioca
           # The model always extends the generated relation module
           model.create_extend(RelationMethodsModuleName)
 
-          # This feature is only available in versions of Sorbet with special support for
-          # handling `NilClass` returns from `to_ary`. We should not be typing `to_ary` like
-          # this for older versions since it will make all flatten operations be
-          # `T::Array[NilClass]`, otherwise.
-          if sorbet_supports?(:to_ary_nil_support)
-            # Type the `to_ary` method as returning `NilClass` so that flatten stops recursing
-            # See https://github.com/sorbet/sorbet/pull/4706 for details
-            model.create_method("to_ary", return_type: "NilClass", visibility: RBI::Private.new)
-          end
+          # Type the `to_ary` method as returning `NilClass` so that flatten stops recursing
+          # See https://github.com/sorbet/sorbet/pull/4706 for details
+          model.create_method("to_ary", return_type: "NilClass", visibility: RBI::Private.new)
 
           create_relation_class(model)
           create_association_relation_class(model)

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

@@ -95,7 +95,18 @@ module Tapioca
               case descriptor
               when Google::Protobuf::EnumDescriptor
                 descriptor.to_h.each do |sym, val|
-                  klass.create_constant(sym.to_s, value: val.to_s)
+                  # For each enum value, create a namespaced constant on the root rather than an un-namespaced
+                  # constant within the class. This is because un-namespaced constants might conflict with reserved
+                  # Ruby words, such as "BEGIN." By namespacing them, we avoid this problem.
+                  #
+                  # Invalid syntax:
+                  # class Foo
+                  #   BEGIN = 3
+                  # end
+                  #
+                  # Valid syntax:
+                  # Foo::BEGIN = 3
+                  root.create_constant("#{constant}::#{sym}", value: val.to_s)
                 end
 
                 klass.create_method(

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

@@ -41,6 +41,8 @@ module Tapioca
               "::ActiveSupport::TimeWithZone"
             when ActiveRecord::Enum::EnumType
               "::String"
+            when ActiveRecord::Type::Serialized
+              serialized_column_type(column_type)
             else
               handle_unknown_type(column_type)
             end
@@ -119,6 +121,23 @@ module Tapioca
             "T.any(::String, ::Symbol)"
           end
         end
+
+        sig { params(column_type: ActiveRecord::Type::Serialized).returns(String) }
+        def serialized_column_type(column_type)
+          case column_type.coder
+          when ActiveRecord::Coders::YAMLColumn
+            case column_type.coder.object_class
+            when Array.singleton_class
+              "T::Array[T.untyped]"
+            when Hash.singleton_class
+              "T::Hash[T.untyped, T.untyped]"
+            else
+              "T.untyped"
+            end
+          else
+            "T.untyped"
+          end
+        end
       end
     end
   end

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

@@ -25,7 +25,7 @@ module Tapioca
           when GraphQL::Types::ISO8601Date.singleton_class
             type_for_constant(Date)
           when GraphQL::Types::ISO8601DateTime.singleton_class
-            type_for_constant(DateTime)
+            type_for_constant(Time)
           when GraphQL::Types::JSON.singleton_class
             "T::Hash[::String, T.untyped]"
           when GraphQL::Schema::Enum.singleton_class

data/lib/tapioca/gem/pipeline.rb

@@ -342,7 +342,7 @@ module Tapioca
 
       sig { params(constant: Module, strict: T::Boolean).returns(T::Boolean) }
       def defined_in_gem?(constant, strict: true)
-        files = Set.new(get_file_candidates(constant))
+        files = get_file_candidates(constant)
           .merge(Runtime::Trackers::ConstantDefinition.files_for(constant))
 
         return !strict if files.empty?
@@ -352,13 +352,11 @@ module Tapioca
         end
       end
 
-      sig { params(constant: Module).returns(T::Array[String]) }
+      sig { params(constant: Module).returns(T::Set[String]) }
       def get_file_candidates(constant)
-        wrapped_module = Pry::WrappedModule.new(constant)
-
-        wrapped_module.send(:method_candidates).flatten.filter_map(&:source_file).uniq
+        file_candidates_for(constant)
       rescue ArgumentError, NameError
-        []
+        Set.new
       end
 
       sig { params(name: String).void }

data/lib/tapioca/helpers/rbi_helper.rb

@@ -23,22 +23,14 @@ module Tapioca
       def serialize_type_variable(type, variance, fixed, upper, lower)
         variance = nil if variance == :invariant
 
-        bounds = []
-        bounds << "fixed: #{fixed}" if fixed
-        bounds << "lower: #{lower}" if lower
-        bounds << "upper: #{upper}" if upper
-
-        parameters = []
         block = []
+        block << "fixed: #{fixed}" if fixed
+        block << "lower: #{lower}" if lower
+        block << "upper: #{upper}" if upper
 
+        parameters = []
         parameters << ":#{variance}" if variance
 
-        if sorbet_supports?(:type_variable_block_syntax)
-          block = bounds
-        else
-          parameters.concat(bounds)
-        end
-
         serialized = type.dup
         serialized << "(#{parameters.join(", ")})" unless parameters.empty?
         serialized << " { { #{block.join(", ")} } }" unless block.empty?

data/lib/tapioca/helpers/sorbet_helper.rb

@@ -20,9 +20,7 @@ module Tapioca
     SORBET_PAYLOAD_URL = "https://github.com/sorbet/sorbet/tree/master/rbi"
 
     FEATURE_REQUIREMENTS = T.let({
-      to_ary_nil_support: ::Gem::Requirement.new(">= 0.5.9220"),         # https://github.com/sorbet/sorbet/pull/4706
-      print_payload_sources: ::Gem::Requirement.new(">= 0.5.9818"),      # https://github.com/sorbet/sorbet/pull/5504
-      type_variable_block_syntax: ::Gem::Requirement.new(">= 0.5.9892"), # https://github.com/sorbet/sorbet/pull/5639
+      # feature_name: ::Gem::Requirement.new(">= ___"), # https://github.com/sorbet/sorbet/pull/___
     }.freeze, T::Hash[Symbol, ::Gem::Requirement])
 
     sig { params(sorbet_args: String).returns(Spoom::ExecResult) }

data/lib/tapioca/loaders/dsl.rb

@@ -9,9 +9,9 @@ module Tapioca
       class << self
         extend T::Sig
 
-        sig { params(tapioca_path: String, eager_load: T::Boolean).void }
-        def load_application(tapioca_path:, eager_load: true)
-          loader = new(tapioca_path: tapioca_path)
+        sig { params(tapioca_path: String, eager_load: T::Boolean, app_root: String).void }
+        def load_application(tapioca_path:, eager_load: true, app_root: ".")
+          loader = new(tapioca_path: tapioca_path, app_root: app_root)
           loader.load
         end
       end
@@ -26,12 +26,13 @@ module Tapioca
 
       protected
 
-      sig { params(tapioca_path: String, eager_load: T::Boolean).void }
-      def initialize(tapioca_path:, eager_load: true)
+      sig { params(tapioca_path: String, eager_load: T::Boolean, app_root: String).void }
+      def initialize(tapioca_path:, eager_load: true, app_root: ".")
         super()
 
         @tapioca_path = tapioca_path
         @eager_load = eager_load
+        @app_root = app_root
       end
 
       sig { void }
@@ -64,6 +65,7 @@ module Tapioca
         load_rails_application(
           environment_load: true,
           eager_load: @eager_load,
+          app_root: @app_root,
         )
 
         say("Done", :green)
@@ -71,7 +73,7 @@ module Tapioca
 
       sig { void }
       def abort_if_pending_migrations!
-        return unless File.exist?("config/application.rb")
+        return unless File.exist?("#{@app_root}/config/application.rb")
         return unless defined?(::Rake)
 
         Rails.application.load_tasks

data/lib/tapioca/loaders/loader.rb

@@ -33,16 +33,16 @@ module Tapioca
         load_rails_engines
       end
 
-      sig { params(environment_load: T::Boolean, eager_load: T::Boolean).void }
-      def load_rails_application(environment_load: false, eager_load: false)
-        return unless File.exist?("config/application.rb")
+      sig { params(environment_load: T::Boolean, eager_load: T::Boolean, app_root: String).void }
+      def load_rails_application(environment_load: false, eager_load: false, app_root: ".")
+        return unless File.exist?("#{app_root}/config/application.rb")
 
         silence_deprecations
 
         if environment_load
-          require "./config/environment"
+          require "./#{app_root}/config/environment"
         else
-          require "./config/application"
+          require "./#{app_root}/config/application"
         end
 
         eager_load_rails_app if eager_load

data/lib/tapioca/rbi_ext/model.rb

@@ -83,13 +83,16 @@ module RBI
         return_type: String,
         class_method: T::Boolean,
         visibility: RBI::Visibility,
+        comments: T::Array[RBI::Comment],
       ).void
     end
-    def create_method(name, parameters: [], return_type: "T.untyped", class_method: false, visibility: RBI::Public.new)
+    def create_method(name, parameters: [], return_type: "T.untyped", class_method: false, visibility: RBI::Public.new,
+      comments: [])
       return unless Tapioca::RBIHelper.valid_method_name?(name)
 
       sig = RBI::Sig.new(return_type: return_type)
-      method = RBI::Method.new(name, sigs: [sig], is_singleton: class_method, visibility: visibility)
+      method = RBI::Method.new(name, sigs: [sig], is_singleton: class_method, visibility: visibility,
+        comments: comments)
       parameters.each do |param|
         method << param.param
         sig << RBI::SigParam.new(param.param.name, param.type)

data/lib/tapioca/runtime/reflection.rb

@@ -183,6 +183,61 @@ module Tapioca
 
         T.cast(result, Module)
       end
+
+      sig { params(constant: Module).returns(T::Set[String]) }
+      def file_candidates_for(constant)
+        relevant_methods_for(constant).filter_map do |method|
+          method.source_location&.first
+        end.to_set
+      end
+
+      private
+
+      sig { params(constant: Module).returns(T::Array[UnboundMethod]) }
+      def relevant_methods_for(constant)
+        methods = methods_for(constant).select(&:source_location)
+          .reject { |x| method_defined_by_forwardable_module?(x) }
+
+        return methods unless methods.empty?
+
+        constants_of(constant).flat_map do |const_name|
+          if (mod = child_module_for_parent_with_name(constant, const_name.to_s))
+            relevant_methods_for(mod)
+          else
+            []
+          end
+        end
+      end
+
+      sig { params(constant: Module).returns(T::Array[UnboundMethod]) }
+      def methods_for(constant)
+        modules = [constant, singleton_class_of(constant)]
+        method_list_methods = [
+          PUBLIC_INSTANCE_METHODS_METHOD,
+          PROTECTED_INSTANCE_METHODS_METHOD,
+          PRIVATE_INSTANCE_METHODS_METHOD,
+        ]
+
+        modules.product(method_list_methods).flat_map do |mod, method_list_method|
+          method_list_method.bind_call(mod, false).map { |name| mod.instance_method(name) }
+        end
+      end
+
+      sig { params(parent: Module, name: String).returns(T.nilable(Module)) }
+      def child_module_for_parent_with_name(parent, name)
+        return if parent.autoload?(name)
+
+        child = constantize(name, inherit: true, namespace: parent)
+        return unless Module === child
+        return unless name_of(child) == "#{name_of(parent)}::#{name}"
+
+        child
+      end
+
+      sig { params(method: UnboundMethod).returns(T::Boolean) }
+      def method_defined_by_forwardable_module?(method)
+        method.source_location&.first == Object.const_source_location(:Forwardable)&.first
+      end
     end
   end
 end

data/lib/tapioca/static/symbol_loader.rb

@@ -62,14 +62,14 @@ module Tapioca
 
         sig { params(paths: T::Array[Pathname]).returns(T::Set[String]) }
         def symbols_from_paths(paths)
-          output = T.cast(Tempfile.create("sorbet") do |file|
+          output = Tempfile.create("sorbet") do |file|
             file.write(Array(paths).join("\n"))
             file.flush
 
             symbol_table_json_from("@#{file.path.shellescape}")
-          end, T.nilable(String))
+          end
 
-          return Set.new if output.nil? || output.empty?
+          return Set.new if output.empty?
 
           SymbolTableParser.parse_json(output)
         end

data/lib/tapioca/static/symbol_table_parser.rb

@@ -43,6 +43,12 @@ module Tapioca
 
           next if name.nil?
           next unless SKIP_PARSE_KINDS.include?(kind)
+
+          # Turn singleton class names to attached class names
+          if (match_data = name.match(/<Class:(.*)>/))
+            name = match_data[1]
+          end
+
           next if name.match?(/[<>()$]/)
           next if name.match?(/^[0-9]+$/)
           next if name == "T::Helpers"

data/lib/tapioca/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,20 +55,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.21.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rbi
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +64,7 @@ dependencies:
         version: 0.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.14
+        version: 0.0.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -88,21 +74,21 @@ dependencies:
         version: 0.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.14
+        version: 0.0.16
 - !ruby/object:Gem::Dependency
   name: sorbet-static-and-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9204
+        version: 0.5.9892
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9204
+        version: 0.5.9892
 - !ruby/object:Gem::Dependency
   name: spoom
   requirement: !ruby/object:Gem::Requirement