tapioca 0.16.5 → 0.16.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8efd13a85ae108c14208f510ff83132f745b956a841afe2dd870ec35f67f19f6
-  data.tar.gz: ef25365cfc4c0b2442e57a9309f9554254f7ba27af19a77e7f187e1e7222fb27
+  metadata.gz: 5a42a478b0396f43dd9e6505c18ac69ca8c32e6ef00b298e6d6e4a8c12536b17
+  data.tar.gz: f24ab38ee1d78f1633f7d580ea5be8f93e13c9c6550d11b5d5bc4171d974929b
 SHA512:
-  metadata.gz: acfd5b028a620f619372ec911269e2c0386c5ab0e4a59d6f2d76718875e7b027518a4334f4eb5df6d5f5c8fc07982456b52c55c026bcb0e9db08a7c24435a7fa
-  data.tar.gz: 40b55848a0aa050064596c194a1c9ead65b1ac45ea34ec14d2dfad1d5fe14c89f97da8a35ad6e02d36ce478cbe9f56928246d15a243b8949ee1a1174a25a95fc
+  metadata.gz: f623d3b5e66a081728d9ae4b3dde4c6c976829ffbd6e606a64def2e8aff489c09911396ca72146c901f72a11d432d6c86ae840e278b8d85fd8ee756e97776542
+  data.tar.gz: e7686bcfed28858bfb8f162ee0bd8a7c9a6cdf286c7227a86032025934b04fa72c29f21c41d7a3c5668edb8aad2d39bf2808a2d98799a7434e94aa9b921c3cf8

data/README.md

@@ -999,7 +999,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Shopif
 
 ### DSL compilers
 
-Contributions to existing DSL compilers are welcome. However, new compilers that support DSLs for gems other than Rails should live outside of Tapioca. Please refer to [writing custom dsl compilers](https://github.com/Shopify/tapioca?tab=readme-ov-file#writing-custom-dsl-compilers) for more information.
+Tapioca ships with a small collection of high quality DSL compilers for popular Ruby gems that are used heavily at Shopify, like Rails and GraphQL. We encourage the community to contribute new DSL compilers, though they shouldn't necessarily live in the Tapioca repo itself.
+
+It's best for DSL compilers to be contributed directly to gems they apply to ([example](https://github.com/Shopify/measured/tree/main/lib/tapioca/dsl/compilers)). This way, when changes are made to the gem's DSL, the gem's DSL compiler can be updated at the same time and be versioned/released together.
+
+If an upstream gem's maintainers don't wish to host a DSL compiler themselves, you can propose contributing it to:
+
+1. Tapioca, if it's a gem that Shopify uses (ask us in an issue or PR)
+2. A third party DSL compiler repository, like [AngelList/Boba](https://github.com/angellist/boba). These are not supported by Shopify.
+
+For help writing a DSL compiler, please refer to [writing custom dsl compilers](https://github.com/Shopify/tapioca?tab=readme-ov-file#writing-custom-dsl-compilers).
 
 ## License
 

data/lib/tapioca/cli.rb

@@ -145,7 +145,7 @@ module Tapioca
       default: {}
     option :lsp_addon,
       type: :boolean,
-      desc: "Generate DSL RBIs from the LSP addon. Internal to tapioca and not intended for end-users",
+      desc: "Generate DSL RBIs from the LSP add-on. Internal to Tapioca and not intended for end-users",
       default: false,
       hide: true
     def dsl(*constant_or_paths)
@@ -266,6 +266,11 @@ module Tapioca
       type: :boolean,
       desc: "Halt upon a load error while loading the Rails application",
       default: true
+    option :lsp_addon,
+      type: :boolean,
+      desc: "Generate Gem RBIs from the LSP add-on. Internal to Tapioca and not intended for end-users",
+      default: false,
+      hide: true
     def gem(*gems)
       set_environment(options)
 
@@ -300,6 +305,7 @@ module Tapioca
         dsl_dir: options[:dsl_dir],
         rbi_formatter: rbi_formatter(options),
         halt_upon_load_error: options[:halt_upon_load_error],
+        lsp_addon: options[:lsp_addon],
       }
 
       command = if verify

data/lib/tapioca/commands/abstract_gem.rb

@@ -27,6 +27,7 @@ module Tapioca
           dsl_dir: String,
           rbi_formatter: RBIFormatter,
           halt_upon_load_error: T::Boolean,
+          lsp_addon: T.nilable(T::Boolean),
         ).void
       end
       def initialize(
@@ -45,7 +46,8 @@ module Tapioca
         auto_strictness: true,
         dsl_dir: DEFAULT_DSL_DIR,
         rbi_formatter: DEFAULT_RBI_FORMATTER,
-        halt_upon_load_error: true
+        halt_upon_load_error: true,
+        lsp_addon: false
       )
         @gem_names = gem_names
         @exclude = exclude
@@ -59,6 +61,7 @@ module Tapioca
         @auto_strictness = auto_strictness
         @dsl_dir = dsl_dir
         @rbi_formatter = rbi_formatter
+        @lsp_addon = lsp_addon
 
         super()
 
@@ -73,39 +76,6 @@ module Tapioca
 
       private
 
-      sig { params(gem_names: T::Array[String]).returns(T::Array[Gemfile::GemSpec]) }
-      def gems_to_generate(gem_names)
-        return @bundle.dependencies if gem_names.empty?
-
-        gem_names.each_with_object([]) do |gem_name, gems|
-          gem = @bundle.gem(gem_name)
-
-          if gem.nil?
-            raise Thor::Error, set_color("Error: Cannot find gem '#{gem_name}'", :red)
-          end
-
-          gems.concat(gem_dependencies(gem)) if @include_dependencies
-          gems << gem
-        end
-      end
-
-      sig do
-        params(
-          gem: Gemfile::GemSpec,
-          dependencies: T::Array[Gemfile::GemSpec],
-        ).returns(T::Array[Gemfile::GemSpec])
-      end
-      def gem_dependencies(gem, dependencies = [])
-        direct_dependencies = gem.dependencies.filter_map { |dependency| @bundle.gem(dependency.name) }
-        gems = dependencies | direct_dependencies
-
-        if direct_dependencies.empty?
-          gems
-        else
-          direct_dependencies.reduce(gems) { |result, gem| gem_dependencies(gem, result) }
-        end
-      end
-
       sig { params(gem: Gemfile::GemSpec).void }
       def compile_gem_rbi(gem)
         gem_name = set_color(gem.name, :yellow, :bold)

data/lib/tapioca/commands/gem_generate.rb

@@ -46,6 +46,41 @@ module Tapioca
       ensure
         GitAttributes.create_generated_attribute_file(@outpath)
       end
+
+      sig { params(gem_names: T::Array[String]).returns(T::Array[Gemfile::GemSpec]) }
+      def gems_to_generate(gem_names)
+        return @bundle.dependencies if gem_names.empty?
+
+        (gem_names - @exclude).each_with_object([]) do |gem_name, gems|
+          gem = @bundle.gem(gem_name)
+
+          if gem.nil?
+            next if @lsp_addon
+
+            raise Thor::Error, set_color("Error: Cannot find gem '#{gem_name}'", :red)
+          end
+
+          gems.concat(gem_dependencies(gem)) if @include_dependencies
+          gems << gem
+        end
+      end
+
+      sig do
+        params(
+          gem: Gemfile::GemSpec,
+          dependencies: T::Array[Gemfile::GemSpec],
+        ).returns(T::Array[Gemfile::GemSpec])
+      end
+      def gem_dependencies(gem, dependencies = [])
+        direct_dependencies = gem.dependencies.filter_map { |dependency| @bundle.gem(dependency.name) }
+        gems = dependencies | direct_dependencies
+
+        if direct_dependencies.empty?
+          gems
+        else
+          direct_dependencies.reduce(gems) { |result, gem| gem_dependencies(gem, result) }
+        end
+      end
     end
   end
 end

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

@@ -101,26 +101,26 @@ module Tapioca
 
         sig { params(attribute_type_value: T.untyped).returns(::String) }
         def type_for(attribute_type_value)
-          type = case attribute_type_value
+          case attribute_type_value
           when ActiveModel::Type::Boolean
-            "T::Boolean"
+            as_nilable_type("T::Boolean")
           when ActiveModel::Type::Date
-            "::Date"
+            as_nilable_type("::Date")
           when ActiveModel::Type::DateTime, ActiveModel::Type::Time
-            "::Time"
+            as_nilable_type("::Time")
           when ActiveModel::Type::Decimal
-            "::BigDecimal"
+            as_nilable_type("::BigDecimal")
           when ActiveModel::Type::Float
-            "::Float"
+            as_nilable_type("::Float")
           when ActiveModel::Type::Integer
-            "::Integer"
+            as_nilable_type("::Integer")
           when ActiveModel::Type::String
-            "::String"
+            as_nilable_type("::String")
           else
-            Helpers::ActiveModelTypeHelper.type_for(attribute_type_value)
+            type = Helpers::ActiveModelTypeHelper.type_for(attribute_type_value)
+            type = as_nilable_type(type) if Helpers::ActiveModelTypeHelper.assume_nilable?(attribute_type_value)
+            type
           end
-
-          as_nilable_type(type)
         end
 
         sig { params(klass: RBI::Scope, method: String, type: String).void }

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

@@ -372,7 +372,7 @@ module Tapioca
             return_type: "T.self_type",
           )
 
-          CALCULATION_METHODS.each do |method_name|
+          (CALCULATION_METHODS + [:size]).each do |method_name|
             case method_name
             when :average, :maximum, :minimum
               klass.create_method(
@@ -400,9 +400,9 @@ module Tapioca
                 ],
                 return_type: "T::Hash[T.untyped, Integer]",
               )
-            when :sum
+            when :sum, :size
               klass.create_method(
-                "sum",
+                method_name.to_s,
                 parameters: [
                   create_opt_param("column_name", type: "T.nilable(T.any(String, Symbol))", default: "nil"),
                   create_block_param("block", type: "T.nilable(T.proc.params(record: T.untyped).returns(T.untyped))"),
@@ -586,6 +586,22 @@ module Tapioca
                 parameters: parameters,
                 return_type: return_type,
               )
+            when :select
+              [relation_methods_module, association_relation_methods_module].each do |mod|
+                mod.create_method(method_name.to_s) do |method|
+                  method.add_rest_param("args")
+                  method.add_block_param("blk")
+
+                  method.add_sig do |sig|
+                    sig.add_param("args", "T.untyped")
+                    sig.return_type = mod == relation_methods_module ? RelationClassName : AssociationRelationClassName
+                  end
+                  method.add_sig do |sig|
+                    sig.add_param("blk", "T.proc.params(record: #{constant_name}).returns(T::Boolean)")
+                    sig.return_type = "T::Array[#{constant_name}]"
+                  end
+                end
+              end
             else
               create_relation_method(
                 method_name,

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

@@ -147,7 +147,17 @@ module Tapioca
           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)
+            type.__tapioca_type
           elsif type == ::JsonApiClient::Schema::Types::Integer
             "::Integer"
           elsif type == ::JsonApiClient::Schema::Types::String

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

@@ -14,7 +14,8 @@ module Tapioca
           def type_for(type_value)
             return "T.untyped" if Runtime::GenericTypeRegistry.generic_type_instance?(type_value)
 
-            type = lookup_return_type_of_method(type_value, :deserialize) ||
+            type = lookup_tapioca_type(type_value) ||
+              lookup_return_type_of_method(type_value, :deserialize) ||
               lookup_return_type_of_method(type_value, :cast) ||
               lookup_return_type_of_method(type_value, :cast_value) ||
               lookup_arg_type_of_method(type_value, :serialize) ||
@@ -22,6 +23,11 @@ module Tapioca
             type.to_s
           end
 
+          sig { params(type_value: T.untyped).returns(T::Boolean) }
+          def assume_nilable?(type_value)
+            !type_value.respond_to?(:__tapioca_type)
+          end
+
           private
 
           MEANINGLESS_TYPES = T.let(
@@ -39,6 +45,11 @@ module Tapioca
             !MEANINGLESS_TYPES.include?(type)
           end
 
+          sig { params(obj: T.untyped).returns(T.nilable(T::Types::Base)) }
+          def lookup_tapioca_type(obj)
+            T::Utils.coerce(obj.__tapioca_type) if obj.respond_to?(:__tapioca_type)
+          end
+
           sig { params(obj: T.untyped, method: Symbol).returns(T.nilable(T::Types::Base)) }
           def lookup_return_type_of_method(obj, method)
             return_type = lookup_signature_of_method(obj, method)&.return_type

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

@@ -211,6 +211,11 @@ module Tapioca
                    ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Range === type
                }
             "T::Range[#{type_for_activerecord_value(column_type.subtype, column_nullability:)}]"
+          when ->(type) {
+                 defined?(ActiveRecord::Locking::LockingType) &&
+                   ActiveRecord::Locking::LockingType === type
+               }
+            as_non_nilable_if_persisted_and_not_nullable("::Integer", column_nullability:)
           else
             as_non_nilable_if_persisted_and_not_nullable(
               ActiveModelTypeHelper.type_for(column_type),

data/lib/tapioca/gemfile.rb

@@ -66,15 +66,24 @@ module Tapioca
 
     sig { returns([T::Enumerable[Spec], T::Array[String]]) }
     def materialize_deps
-      deps = definition.locked_gems.dependencies.values
-      materialized_dependencies = definition.resolve.materialize(deps)
-      missing_spec_names = materialized_dependencies.missing_specs.map(&:name).to_set
-      missing_specs = materialized_dependencies.missing_specs.map do |spec|
-        "#{spec.name} (#{spec.version})"
-      end
-      materialized_dependencies = materialized_dependencies.to_a.reject do |spec|
-        missing_spec_names.include?(spec.name)
+      deps = definition.locked_gems.dependencies.except(*@excluded_gems).values
+      resolve = definition.resolve
+      materialized_dependencies = resolve.materialize(deps)
+
+      if Bundler::VERSION >= "2.6.0"
+        missing_specs = resolve.missing_specs.map do |spec|
+          "#{spec.name} (#{spec.version})"
+        end
+      else
+        missing_spec_names = materialized_dependencies.missing_specs.map(&:name).to_set
+        missing_specs = materialized_dependencies.missing_specs.map do |spec|
+          "#{spec.name} (#{spec.version})"
+        end
+        materialized_dependencies = materialized_dependencies.to_a.reject do |spec|
+          missing_spec_names.include?(spec.name)
+        end
       end
+
       [materialized_dependencies, missing_specs]
     end
 

data/lib/tapioca/loaders/dsl.rb

@@ -85,7 +85,12 @@ module Tapioca
       def load_dsl_compilers
         say("Loading DSL compiler classes... ")
 
-        # Load built-in compilers and custom compilers exported from gems
+        # Load all built-in compilers before any custom compilers
+        Dir.glob("#{Tapioca::LIB_ROOT_DIR}/tapioca/dsl/compilers/*.rb").each do |compiler|
+          require File.expand_path(compiler)
+        end
+
+        # Load all custom compilers exported from gems
         ::Gem.find_files("tapioca/dsl/compilers/*.rb").each do |compiler|
           require File.expand_path(compiler)
         end

data/lib/tapioca/version.rb

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

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.16.5
+  version: 0.16.6
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
 - Alan Wu
 - Alexandre Terrasa
 - Peter Zhu
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,7 +124,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - ruby@shopify.com
 executables:
@@ -271,7 +269,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -286,8 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby Interface file generator for gems, core types and the Ruby standard
   library