tapioca 0.13.1 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d49ca562ccbe7a00137e647a6e96499d6699b3c4c0d7d29f513a19d32fd17cd1
-  data.tar.gz: a7761368e37e779e7478892d81701bbc8096522103de6cd948b845e69d52d6d4
+  metadata.gz: 160e94dc5b5280b1b9e1cb84813fbc8f5f137c56ac2f0222693e35beaa647b2e
+  data.tar.gz: ca8e98b7e4685f71fdb8b104a55df21e4d9c0bc2001eb6490508f22661a430d7
 SHA512:
-  metadata.gz: 5ba58ce9b4be09cd647255a82ecac17049c946ba0d55dffc86160a69514f2e3c802b6f3b1627ddbbe92aba96e53a0d574191c1dfcb0a5af604e1294cebe6c9d4
-  data.tar.gz: c011df4fac4986b9cf33707059de3c86adbad54d26adcab75f949293f2a116bd5b1da5a1f5698ee70ecf497bdefe0fe7cfb03dc99b607eb78b4cd2f46aeffb60
+  metadata.gz: d61c8c74b3d7f05818a43814c3d876df6a849ebecb6cd86f853a14b2bc19ec34186eb7f9185ca4cab43baf88bdac90191923fbc5b59577b1548659ee618c336a
+  data.tar.gz: b474f48b7e0e427919d154a9da43877c0a9de1ef1e5ec9284299cbcb0b26a9178b9225eb264f1e55dcbea2cbd909c17d4161a3f23b02b7cedf36dbb467c91cb3

data/README.md

@@ -52,6 +52,7 @@ Tapioca makes it easy to work with [Sorbet](https://sorbet.org) in your codebase
   * [RBI files for missing constants and methods](#rbi-files-for-missing-constants-and-methods)
   * [Configuration](#configuration)
 * [Contributing](#contributing)
+  * [DSL compilers](#dsl-compilers)
 * [License](#license)
 <!-- END_TOC -->
 
@@ -973,6 +974,10 @@ annotations:
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/tapioca. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://github.com/Shopify/tapioca/blob/main/CODE_OF_CONDUCT.md) code of conduct.
 
+### 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.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/tapioca/blob/main/LICENSE.txt).

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

@@ -667,18 +667,25 @@ module Tapioca
               end
               sigs = [
                 common_relation_methods_module.create_sig(
-                  parameters: [create_param("args", type: id_types)],
+                  parameters: { args: id_types },
                   return_type: constant_name,
                 ),
                 common_relation_methods_module.create_sig(
-                  parameters: [create_param("args", type: array_type)],
+                  parameters: { args: array_type },
                   return_type: "T::Enumerable[#{constant_name}]",
                 ),
+                common_relation_methods_module.create_sig(
+                  parameters: {
+                    args: "NilClass",
+                    block: "T.proc.params(object: #{constant_name}).void)",
+                  },
+                  return_type: as_nilable_type(constant_name),
+                ),
               ]
               common_relation_methods_module.create_method_with_sigs(
                 "find",
                 sigs: sigs,
-                parameters: [RBI::ReqParam.new("args")],
+                parameters: [RBI::OptParam.new("args", "nil"), RBI::BlockParam.new("block")],
               )
             when :find_by
               create_common_method(
@@ -714,11 +721,11 @@ module Tapioca
             when :first, :last, :take
               sigs = [
                 common_relation_methods_module.create_sig(
-                  parameters: [create_opt_param("limit", type: "NilClass", default: "nil")],
+                  parameters: { limit: "NilClass" },
                   return_type: as_nilable_type(constant_name),
                 ),
                 common_relation_methods_module.create_sig(
-                  parameters: [create_param("limit", type: "Integer")],
+                  parameters: { limit: "Integer" },
                   return_type: "T::Array[#{constant_name}]",
                 ),
               ]
@@ -786,12 +793,23 @@ module Tapioca
                 return_type: "Numeric",
               )
             when :count
-              create_common_method(
+              sigs = [
+                common_relation_methods_module.create_sig(
+                  parameters: { column_name: "T.nilable(T.any(String, Symbol))" },
+                  return_type: "Integer",
+                ),
+                common_relation_methods_module.create_sig(
+                  parameters: { column_name: "NilClass", block: "T.proc.params(object: #{constant_name}).void" },
+                  return_type: "Integer",
+                ),
+              ]
+              common_relation_methods_module.create_method_with_sigs(
                 "count",
+                sigs: sigs,
                 parameters: [
-                  create_opt_param("column_name", type: "T.untyped", default: "nil"),
+                  RBI::OptParam.new("column_name", "nil"),
+                  RBI::BlockParam.new("block"),
                 ],
-                return_type: "Integer",
               )
             when :ids
               create_common_method("ids", return_type: "Array")
@@ -819,26 +837,20 @@ module Tapioca
             case method_name
             when :find_each
               order = ActiveRecord::Batches.instance_method(:find_each).parameters.include?([:key, :order])
+              parameters = {
+                start: "T.untyped",
+                finish: "T.untyped",
+                batch_size: "Integer",
+                error_on_ignore: "T.untyped",
+                order: ("Symbol" if order),
+              }.compact
               sigs = [
                 common_relation_methods_module.create_sig(
-                  parameters: [
-                    create_kw_opt_param("start", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
-                    create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
-                    *(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
-                    create_block_param("block", type: "T.proc.params(object: #{constant_name}).void"),
-                  ],
+                  parameters: parameters.merge(block: "T.proc.params(object: #{constant_name}).void"),
                   return_type: "void",
                 ),
                 common_relation_methods_module.create_sig(
-                  parameters: [
-                    create_kw_opt_param("start", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
-                    create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
-                    *(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
-                  ],
+                  parameters: parameters,
                   return_type: "T::Enumerator[#{constant_name}]",
                 ),
               ]
@@ -856,26 +868,20 @@ module Tapioca
               )
             when :find_in_batches
               order = ActiveRecord::Batches.instance_method(:find_in_batches).parameters.include?([:key, :order])
+              parameters = {
+                start: "T.untyped",
+                finish: "T.untyped",
+                batch_size: "Integer",
+                error_on_ignore: "T.untyped",
+                order: ("Symbol" if order),
+              }.compact
               sigs = [
                 common_relation_methods_module.create_sig(
-                  parameters: [
-                    create_kw_opt_param("start", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
-                    create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
-                    *(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
-                    create_block_param("block", type: "T.proc.params(object: T::Array[#{constant_name}]).void"),
-                  ],
+                  parameters: parameters.merge(block: "T.proc.params(object: T::Array[#{constant_name}]).void"),
                   return_type: "void",
                 ),
                 common_relation_methods_module.create_sig(
-                  parameters: [
-                    create_kw_opt_param("start", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("batch_size", type: "Integer", default: "1000"),
-                    create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
-                    *(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
-                  ],
+                  parameters: parameters,
                   return_type: "T::Enumerator[T::Enumerator[#{constant_name}]]",
                 ),
               ]
@@ -894,30 +900,22 @@ module Tapioca
             when :in_batches
               order = ActiveRecord::Batches.instance_method(:in_batches).parameters.include?([:key, :order])
               use_ranges = ActiveRecord::Batches.instance_method(:in_batches).parameters.include?([:key, :use_ranges])
+              parameters = {
+                of: "Integer",
+                start: "T.untyped",
+                finish: "T.untyped",
+                load: "T.untyped",
+                error_on_ignore: "T.untyped",
+                order: ("Symbol" if order),
+                use_ranges: ("T.untyped" if use_ranges),
+              }.compact
               sigs = [
                 common_relation_methods_module.create_sig(
-                  parameters: [
-                    create_kw_opt_param("of", type: "Integer", default: "1000"),
-                    create_kw_opt_param("start", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("load", type: "T.untyped", default: "false"),
-                    create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
-                    *(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
-                    *(create_kw_opt_param("use_ranges", type: "T.untyped", default: "nil") if use_ranges),
-                    create_block_param("block", type: "T.proc.params(object: #{RelationClassName}).void"),
-                  ],
+                  parameters: parameters.merge(block: "T.proc.params(object: #{RelationClassName}).void"),
                   return_type: "void",
                 ),
                 common_relation_methods_module.create_sig(
-                  parameters: [
-                    create_kw_opt_param("of", type: "Integer", default: "1000"),
-                    create_kw_opt_param("start", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("finish", type: "T.untyped", default: "nil"),
-                    create_kw_opt_param("load", type: "T.untyped", default: "false"),
-                    create_kw_opt_param("error_on_ignore", type: "T.untyped", default: "nil"),
-                    *(create_kw_opt_param("order", type: "Symbol", default: ":asc") if order),
-                    *(create_kw_opt_param("use_ranges", type: "T.untyped", default: "nil") if use_ranges),
-                  ],
+                  parameters: parameters,
                   return_type: "::ActiveRecord::Batches::BatchEnumerator",
                 ),
               ]

data/lib/tapioca/loaders/dsl.rb

@@ -63,6 +63,10 @@ module Tapioca
       def load_dsl_compilers
         say("Loading DSL compiler classes... ")
 
+        ::Gem.find_files("tapioca/dsl/compilers/*.rb").each do |compiler|
+          require File.expand_path(compiler)
+        end
+
         Dir.glob([
           "#{@tapioca_path}/generators/**/*.rb", # TODO: Here for backcompat, remove later
           "#{@tapioca_path}/compilers/**/*.rb",
@@ -70,10 +74,6 @@ module Tapioca
           require File.expand_path(compiler)
         end
 
-        ::Gem.find_files("tapioca/dsl/compilers/*.rb").each do |compiler|
-          require File.expand_path(compiler)
-        end
-
         say("Done", :green)
       end
 

data/lib/tapioca/rbi_ext/model.rb

@@ -88,7 +88,8 @@ module RBI
     end
     def create_method(name, parameters: [], return_type: "T.untyped", class_method: false, visibility: RBI::Public.new,
       comments: [])
-      sig = create_sig(parameters: parameters, return_type: return_type)
+      sig_params = parameters.to_h { |param| [param.param.name, param.type] }
+      sig = create_sig(parameters: sig_params, return_type: return_type)
       create_method_with_sigs(
         name,
         sigs: [sig],
@@ -126,13 +127,13 @@ module RBI
 
     sig do
       params(
-        parameters: T::Array[RBI::TypedParam],
+        parameters: T::Hash[T.any(String, Symbol), String],
         return_type: String,
       ).returns(RBI::Sig)
     end
-    def create_sig(parameters: [], return_type: "T.untyped")
-      params = parameters.map do |param|
-        RBI::SigParam.new(param.param.name, param.type)
+    def create_sig(parameters:, return_type: "T.untyped")
+      params = parameters.map do |name, type|
+        RBI::SigParam.new(name.to_s, type)
       end
       RBI::Sig.new(params: params, return_type: return_type)
     end

data/lib/tapioca/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.13.2
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -288,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: A Ruby Interface file generator for gems, core types and the Ruby standard