boba 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1a24d2252ed9eb33a76c1c41c91fbfcc55d1d6e19e98961f596ac290532bd79
-  data.tar.gz: 2ddb912bbb1b5009a6c2b4d77ee14369ed6355ad479b36c365be25b1fa26effd
+  metadata.gz: 63c47fee7660d2248135eb4b850664f22fb6ada8a21154f0c0854e441d4e956a
+  data.tar.gz: 516e3f237a09e382f50ed4d345441b22f1a6db37708f3f07e6f16144f6ed7f50
 SHA512:
-  metadata.gz: 999ccb4621fcddf7e37f9b7a3d921620410f4cebede0cc1833d3fb674f596b447e30e84e1459701deff389a70b40ba80a7f8d61129b6af20b0e69d2d131d1c82
-  data.tar.gz: 73201802ffa626d966c1ea17677dfe741874c4a62057702e3cfe5dded02dd82e2e18cddea3678df03fa79ea64e7bebad81ba5e691dadc10058af8cdaaa9cd00d
+  metadata.gz: f65bb7c5e6182f46d9c514e1adf192aebcbce33e6e5dda4eaacab6e06f8fa0f0f7ba51c4afb7113fd5753ec01b8d891163f1f03a1f4747ebabe1e9d4d8ede147
+  data.tar.gz: 5f169eecab72a3e26f886d45513ad718afb659b0935e2b69f07417d6603e5c9adb5cdadd066f0dba6fbe3a42a13ab03e0cbe6932538228083e3fd971677de2f2

data/README.md

@@ -19,13 +19,19 @@ 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. For instance, the following is an example `tapioca/config.yml` using the Boba `ActiveRecord` compilers with the `persisted` options:
+
 ```yml
+gem:
 dsl:
+  compiler_options:
+    ActiveRecordColumnTypes: persisted
+    ActiveRecordAssociationTypes: persisted
   only:
-    Compiler1
-    Compiler2
+    - ActiveRecordAssociationsPersisted
+    - ActiveRecordColumnsPersisted
 ```
+
 This makes it easy to selectively enable only the compilers you want to use in your project.
 
 ### Typing Relations
@@ -68,6 +74,12 @@ def recent_posts_from_author(author)
 end
 ```
 
+### A Note on Tapioca Dependencies
+
+The core `ActiveRecordAssociationsPersisted` and `ActiveRecordColumnsPersisted` compilers are extensions of Tapioca's corresponding compilers, and depend on monkey patching internal methods. As such, Boba's dependent Tapioca version must be restricted to known good versions and cannot use the more lenient pessimistic version pinning (`~>`), since even minor or patch versions of Tapioca can introduce breaking changes that would be frustrating or difficult for consumers.
+
+We try to stay as up-to-date with Tapioca versions as possible, but can sometimes fall behind. Please submit an issue or pull request (including any needed updates) if we miss a Tapioca version you'd like to upgrade to, and we will address it as soon as possible.
+
 ## Contributing
 
 Bugs and feature requests are welcome and should be [filed as issues on github](https://github.com/angellist/boba/issues).

data/lib/boba/version.rb

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

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

@@ -56,7 +56,7 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
           def gather_constants
             Tapioca::Dsl::Compilers::ActiveRecordRelations.gather_constants
           end

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

@@ -57,7 +57,7 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
           def gather_constants
             all_classes.select { |c| c < ::FlagShihTzu }
           end

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

@@ -60,7 +60,7 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
           def gather_constants
             descendants_of(::ActiveRecord::Base).reject(&:abstract_class?)
           end

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

@@ -60,7 +60,7 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
           def gather_constants
             all_classes.select { |c| c < ::MoneyRails::ActiveRecord::Monetizable }
           end

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

@@ -0,0 +1,93 @@
+# typed: strict
+# frozen_string_literal: true
+
+return unless defined?(Noticed::Event) && defined?(Noticed::Ephemeral)
+
+module Tapioca
+  module Dsl
+    module Compilers
+      # `Tapioca::Dsl::Compilers::Noticed` decorates RBI files for subclasses
+      # of `Noticed::Event` and `Noticed::Ephemeral`.
+      #
+      # For example, with the following notifier class:
+      #
+      # ~~~rb
+      # class NewCommentNotifier < Noticed::Event
+      #   required_params :comment
+      #   deliver_by :email
+      # end
+      # ~~~
+      #
+      # This compiler will produce the RBI file `new_comment_notifier.rbi` with the following content:
+      #
+      # ~~~rbi
+      # # new_comment_notifier.rbi
+      # # typed: true
+      # class NewCommentNotifier
+      #   class << self
+      #     sig { params(params: T::Hash[Symbol, T.untyped]).returns(NewCommentNotifier) }
+      #     def with(params); end
+      #
+      #     sig { params(recipients: T.untyped, enqueue_job: T.nilable(T::Boolean), options: T.untyped).returns(NewCommentNotifier) }
+      #     def deliver(recipients = T.unsafe(nil), enqueue_job: T.unsafe(nil), **options); end
+      #
+      #     sig { params(recipients: T.untyped, enqueue_job: T.nilable(T::Boolean), options: T.untyped).returns(NewCommentNotifier) }
+      #     def deliver_later(recipients = T.unsafe(nil), enqueue_job: T.unsafe(nil), **options); end
+      #   end
+      # end
+      # ~~~
+      class Noticed < Tapioca::Dsl::Compiler
+        extend T::Sig
+
+        ConstantType = type_member do
+          { fixed: T.any(T.class_of(::Noticed::Event), T.class_of(::Noticed::Ephemeral)) }
+        end
+
+        class << self
+          extend T::Sig
+
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
+          def gather_constants
+            all_classes.select do |klass|
+              klass < ::Noticed::Event || klass < ::Noticed::Ephemeral
+            end
+          end
+        end
+
+        sig { override.void }
+        def decorate
+          root.create_path(constant) do |klass|
+            singleton = RBI::SingletonClass.new
+            klass << singleton
+
+            singleton.create_method(
+              "with",
+              parameters: [create_param("params", type: "T::Hash[Symbol, T.untyped]")],
+              return_type: "::#{constant}",
+            )
+
+            singleton.create_method(
+              "deliver",
+              parameters: [
+                create_opt_param("recipients", type: "T.untyped", default: "T.unsafe(nil)"),
+                create_kw_opt_param("enqueue_job", type: "T.nilable(T::Boolean)", default: "T.unsafe(nil)"),
+                create_kw_rest_param("options", type: "T.untyped"),
+              ],
+              return_type: "::#{constant}",
+            )
+
+            singleton.create_method(
+              "deliver_later",
+              parameters: [
+                create_opt_param("recipients", type: "T.untyped", default: "T.unsafe(nil)"),
+                create_kw_opt_param("enqueue_job", type: "T.nilable(T::Boolean)", default: "T.unsafe(nil)"),
+                create_kw_rest_param("options", type: "T.untyped"),
+              ],
+              return_type: "::#{constant}",
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -43,7 +43,7 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
           def gather_constants
             all_classes.select { |c| c < ::Paperclip::Glue }
           end

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

@@ -119,7 +119,7 @@ module Tapioca
           "GeneratedAssociationRelationMethods",
         ].freeze
 
-        ConstantType = type_member { { fixed: T.all(Module, ::StateMachines::ClassMethods) } }
+        ConstantType = type_member { { fixed: T.all(T::Module[T.anything], ::StateMachines::ClassMethods) } }
 
         sig { override.void }
         def decorate
@@ -168,7 +168,7 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
           def gather_constants
             all_classes.select { |mod| ::StateMachines::InstanceMethods > mod }
           end
@@ -176,7 +176,7 @@ module Tapioca
 
         private
 
-        sig { params(constant: Module).returns(T::Boolean) }
+        sig { params(constant: T::Module[T.anything]).returns(T::Boolean) }
         def uses_active_record_integration?(constant)
           ::StateMachines::Integrations.match(constant)&.integration_name == :active_record
         end

metadata

@@ -1,42 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: boba
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Angellist
 bindir: bin
 cert_chain: []
-date: 2025-07-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sorbet-static-and-runtime
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.12698
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.12698
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.12698
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.12698
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.17.7
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.17.7
+        version: 0.18.0
 email:
 - alex.stathis@angellist.com
 executables: []
@@ -58,6 +72,7 @@ files:
 - lib/tapioca/dsl/compilers/flag_shih_tzu.rb
 - lib/tapioca/dsl/compilers/kaminari.rb
 - lib/tapioca/dsl/compilers/money_rails.rb
+- lib/tapioca/dsl/compilers/noticed.rb
 - lib/tapioca/dsl/compilers/paperclip.rb
 - lib/tapioca/dsl/compilers/state_machines_extended.rb
 homepage: https://github.com/angellist/boba
@@ -65,9 +80,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/angellist/boba/issues
-  changelog_uri: https://github.com/angellist/boba/blob/0.1.5/History.md
+  changelog_uri: https://github.com/angellist/boba/blob/0.1.7/History.md
   homepage_uri: https://github.com/angellist/boba
-  source_code_uri: https://github.com/angellist/boba/tree/0.1.5
+  source_code_uri: https://github.com/angellist/boba/tree/0.1.7
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -83,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Custom Tapioca compilers
 test_files: []