boba 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f99ba4fafb5f1a55c1abb60b0c099569f3f4153c4f0f0b43ced158e02fb59b
-  data.tar.gz: 1de40e562d0dbeb3c0b2a987cd4e2898321a62550a239941cb129f5690da042d
+  metadata.gz: e6b2eb9c09c7bcd8a5050115892945fc23749ddc3b9f0376387c914c089c390b
+  data.tar.gz: b17a134072db6a900007bc4a74cba405ca69383039e710e86862de09c6daa93f
 SHA512:
-  metadata.gz: fbc7d9e5ee8248a1175e499f891716d0397136cc20e1e6db65c22c6d61d777ea756c2c992e48694375358a748986bca2bd2c70393601c8185faf49e1ea7f9e39
-  data.tar.gz: 23d4d817f6b1a14345599d027c5fbed2203a32709d1cd955568ee69b7475b4551e31308936c02d4e2c26c403af292070f301c9258eed40fdba0b17414ad346f4
+  metadata.gz: 6d1bd6b43cc6ad2104ad6bcb96f78a53eb7c70068ef948ba0ab172fb8821537963e3a4bf5fe2b810613f9a2e4e9c0a30364bca266e243af1b8cf2800f0d8772a
+  data.tar.gz: 38e5e55631671d0bf64c7c8f64b3d21d8d7c8dbd393b4ffc960f2e958766302bb67dea0c8aeef65ec606f2f395d1194ac1367551a795ae66c7f455ce412f287e

data/README.md

@@ -4,9 +4,7 @@
 
 Boba is a collection of compilers for Sorbet & Tapioca.
 
-Tapioca is very opinionated about what types of compilers or changes are accepted into the repository. See
-[here](https://github.com/Shopify/tapioca?tab=readme-ov-file#dsl-compilers). Boba come in all
-different shapes, sizes, consistencies, etc, and is much less opinionated about what is or is not accepted. Boba is a collection of optional compilers that you can pick and choose from.
+Tapioca is very opinionated about what types of compilers or changes are accepted into the repository. See [here](https://github.com/Shopify/tapioca?tab=readme-ov-file#dsl-compilers). Boba come in all different shapes, sizes, consistencies, etc, and is much less opinionated about what is or is not accepted. Boba is a collection of optional compilers that you can pick and choose from.
 
 ### Available Compilers
 
@@ -21,8 +19,7 @@ group :development do
 end
 ```
 
-We recommend you also use the `only` configuration option in your Tapioca config (typically `sorbet/tapioca/config.yml`)
-to specify only the Tapioca compilers you wish to use.
+We recommend you also use the `only` configuration option in your Tapioca config (typically `sorbet/tapioca/config.yml`) to specify only the Tapioca compilers you wish to use.
 ```yml
 dsl:
   only:
@@ -31,6 +28,36 @@ dsl:
 ```
 This makes it easy to selectively enable only the compilers you want to use in your project.
 
+### Typing Relations
+
+If you'd like to use relation types in your sigs that are less broad than `ActiveRecord::Relation`, such as those specific to a model, Boba provides a railtie to initialize these constants for each class. Move Boba in your gemfile out of the development group:
+
+```ruby
+  gem 'boba'
+```
+
+The railtie will automatically define the `PrivateRelation` constant on each model that inherits from `ActiveRecord::Base`. It can then be used in typing, like thus:
+```ruby
+class Post < ::ActiveRecord::Base
+  scope :recent -> { where('created_at > ?', Date.current) }
+
+  belongs_to :author
+  has_many :comments
+end
+
+sig { params(author: Author).returns(Post::PrivateRelation) }
+def posts_from_author(author); end
+```
+
+and the following should not raise an error:
+
+```ruby
+sig { params(author: Author).returns(Post::PrivateRelation) }
+def recent_posts_from_author(author)
+  posts_from_author(author).recent
+end
+```
+
 ## Contributing
 
 Bugs and feature requests are welcome and should be [filed as issues on github](https://github.com/angellist/boba/issues).
@@ -39,9 +66,7 @@ Bugs and feature requests are welcome and should be [filed as issues on github](
 
 Compilers for any commonly used Ruby or Rails gems are welcome to be contributed. See the [Writing New Compilers section of the Tapioca docs](https://github.com/Shopify/tapioca?tab=readme-ov-file#writing-custom-dsl-compilers) for an introduction to writing compilers.
 
-Since Boba is intended to be used alongside Tapioca and the compilers provided by Boba are intended to be fully optional,
-we will not accept compilers which overwrite the Tapioca default compilers. See the [Tapioca Manual](https://github.com/Shopify/tapioca/blob/main/manual/compilers.md) for a list of these
-compilers. Instead, compilers which extend or overwrite the default Tapioca compilers should be given unique names.
+Since Boba is intended to be used alongside Tapioca and the compilers provided by Boba are intended to be fully optional, we will not accept compilers which overwrite the Tapioca default compilers. See the [Tapioca Manual](https://github.com/Shopify/tapioca/blob/main/manual/compilers.md) for a list of these compilers. Instead, compilers which extend or overwrite the default Tapioca compilers should be given unique names.
 
 Contributed compilers should be well documented, and named after and include a link or reference to the Gem, DSL, or other module they implement RBIs for.
 

data/lib/boba/relations_railtie.rb

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+class Boba::RelationsRailtie < Rails::Railtie
+  railtie_name(:boba)
+
+  initializer("boba.add_private_relation_constant") do
+    ActiveSupport.on_load(:active_record) do
+      module AciveRecordInheritDefineRelationTypes
+        def inherited(child)
+          super(child)
+
+          child.const_set("PrivateRelation", Object)
+        end
+      end
+
+      class ::ActiveRecord::Base
+        class << self
+          prepend AciveRecordInheritDefineRelationTypes
+        end
+      end
+    end
+  end
+end

data/lib/boba/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Boba
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/boba.rb

@@ -0,0 +1,7 @@
+# typed: true
+# frozen_string_literal: true
+
+module Boba
+  require "boba/version"
+  require "boba/relations_railtie" if defined?(Rails)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boba
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Angellist
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-21 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-static-and-runtime
@@ -47,6 +47,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/boba.rb
+- lib/boba/relations_railtie.rb
 - lib/boba/version.rb
 - lib/tapioca/dsl/compilers/active_record_associations_persisted.rb
 - lib/tapioca/dsl/compilers/active_record_columns_persisted.rb
@@ -56,9 +58,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/angellist/boba/issues
-  changelog_uri: https://github.com/angellist/boba/blob/0.0.3/History.md
+  changelog_uri: https://github.com/angellist/boba/blob/0.0.4/History.md
   homepage_uri: https://github.com/angellist/boba
-  source_code_uri: https://github.com/angellist/boba/tree/0.0.3
+  source_code_uri: https://github.com/angellist/boba/tree/0.0.4
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []