rails-on-sorbet 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d255de247b08a136edde26f15049767590f2e303a78e2551df4ef8998ab84512
-  data.tar.gz: 1d6c912134b2345bd3d6e537b99ab1d89f68f6b6c1ad60f9ea9556a8c025ff3f
+  metadata.gz: f489d9f4fc449469fc2c648b63cce27cf7f6765cf119003037567414d8d82554
+  data.tar.gz: 16383eef9597808df2fe6e1b044ded34c3a3d1cbfcb26f0b029a30e0195171d1
 SHA512:
-  metadata.gz: 7bb596b03ee49d914a6d555eb646b1074357ea2368d24b2dd5a424ce3265de740ab44cbbd7191095cb39622e6991b77e6affa21762a3f5dad6dba078778fea27
-  data.tar.gz: da155d5a8360f016a854a2d9f9ff9b2ee28b60a83f397d6593773730ff4186ecd4af5ed39ca5966f00317862e95235f4479c6ce062ba41cbde709503560ae178
+  metadata.gz: 3ad359e0b378b16ab174854a6a8d552d17b17eb82702c92e4fb06fb6919e42bc543141832c9d91b8be3faa9aa6dcd081e01060484fe4ffb80731d2542730431a
+  data.tar.gz: 3319c64c51f3002bed9d4016aef5c9d4d1216e508212b2eeee6d4190ee792aedbf470cc2caca698eb3dac232ded938fda41452d45a3076528ce98a73ee4b7bd5

data/CHANGELOG.md

@@ -12,6 +12,14 @@ Add changes in new features here. Do not change the gem's version in pull/merge
 ### Changes
 -
 
+## [0.3.4] - 21.10.2025
+
+[Diff](https://github.com/espago/rails-on-sorbet/compare/v0.3.3...v0.3.4)
+
+### Changes
+- Add `Map::Params`
+- Require `TypedRelation` automatically
+
 ## [0.3.3] - 20.10.2025
 
 [Diff](https://github.com/espago/rails-on-sorbet/compare/v0.3.2...v0.3.3)

data/lib/rails/on/sorbet/map.rb

@@ -6,6 +6,9 @@ require 'active_support'
 
 module Map
   extend T::Generic
+
+  # Map type for API params.
+  Params = T.type_alias { Map[T.any(String, Symbol), T.untyped] }
 end
 
 def Map(val) = val # rubocop:disable Style/TopLevelMethodDefinition,Naming/MethodName

data/lib/rails/on/sorbet/version.rb

@@ -3,7 +3,7 @@
 module Rails
   module On
     module Sorbet
-      VERSION = '0.3.3'
+      VERSION = '0.3.4'
     end
   end
 end

data/lib/rails/on/sorbet.rb

@@ -16,3 +16,4 @@ require_relative 'sorbet/alias_association'
 require_relative 'sorbet/current_attributes'
 require_relative 'sorbet/map'
 require_relative 'sorbet/timelike'
+require_relative 'sorbet/typed_relation'

data/rbi/map.rbi

@@ -4,6 +4,32 @@
 #: (ActionController::Parameters | ActiveSupport::HashWithIndifferentAccess) -> Map[String | Symbol, untyped]
 def Map(val); end
 
+# `Map` represents a hash-like object
+# Use the `Map` type in a signature.
+#
+#     #: (Map[Symbol | String, Integer]) -> void
+#     def foo(m)
+#       m["foo"] #=> Integer?
+#     end
+#
+#     hash = { "foo" => 4 } #: Hash[String, Integer]
+#     m = Map(hash) #=> Map[Symbol | String, Integer]
+#     foo(m) # OK
+#
+#     hash = { "foo" => 4 }.with_indifferent_access # => ActiveSupport::HashWithIndifferentAccess
+#     m = Map(hash) #=> Map[Symbol | String, untyped]
+#     foo(m) # OK
+#
+#     params = ActionController::Parameters.new # => ActionController::Parameters
+#     m = Map(params) #=> Map[Symbol | String, untyped]
+#     foo(m) # OK
+#
+# Cast a `Hash`, `ActionController::Parameters` or `ActiveSupport::HashWithIndifferentAccess`
+# to a `Map`. The `Map` type defines common methods shared between these hash-like types.
+#
+# Due to current Sorbet limitations, hash-like types cannot directly implement the `Map` interface.
+# The `Map` method provides a way to cast between hash-like types and `Map` to enable type-safe usage.
+#
 # @requires_ancestor: Object
 # @abstract
 #: [out K, out V]

data/rbi/typed_relation.rbi

@@ -417,6 +417,8 @@ module TypedCommonRelationMethods
   # END CommonRelationMethods
 end
 
+# Represents a typed `ActiveRecord::Relation`.
+#
 # @abstract
 module TypedRelation
   extend T::Generic
@@ -884,6 +886,8 @@ module TypedAssociation
     end
   end
 
+  # Represents a typed `ActiveRecord::Associations::CollectionProxy`
+  #
   # @abstract
   module CollectionProxy
     extend T::Generic

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-on-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Mateusz Drewniak