rails-on-sorbet 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 057657277f463d4d5784ead1bc900e19797c5bea05a320a5b66b1fe45472768b
-  data.tar.gz: 806b3922d612631f5f6ae5b5f3570fbafe5ba60e2446b95be7c6b495eb0d7f29
+  metadata.gz: 829640700a30c44c134bd05f675cfbf4eb45f43c78d90cd87f52a25f1a8983bd
+  data.tar.gz: 7f50468584b1edc3c2d419c91758bb2f731468bcff1f22642dd81000484f7c77
 SHA512:
-  metadata.gz: 4032afbde300e87f28f6463b7e86036fad5f043d05d3f886be0e942121492b928598e75c381d851893913a1afd6ef6a80284eb51483debbef769f6db86ebfb7d
-  data.tar.gz: 4f4b029c8dc13209457c36e25076f867fc6c607bbf50eb6a77ae3a39fd500841e0986b7f0e2951dc64ccb571c9b6948dae197df98c99a32f3bc730fdba4def50
+  metadata.gz: b98bee4beaaaf076fa5380d796fd80fa6f257f67a1ad6e52fb38264cc696b12803b9ac0a5020024372207a1c2e8627d684ab997aebd62f5dc3ed9238d55d495e
+  data.tar.gz: cd792edc2489914c401f3832ef28b7a69ebe54b15a28ae3ac5fe7bcef24759715b5958e4ae106d37562b6dbf211e542dcc0d8ec4b9a07f1b94b3ada12dd34522

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.2.0] - 18.09.2025
+
+[Diff](https://github.com/espago/rails-on-sorbet/compare/v0.1.1...v0.2.0)
+
+### Changes
+- Change `Rails::On::Sorbet::CurrentAttributes` from a module to a class
+- Favour using `Rails::On::Sorbet::CurrentAttributes` instead of `ActiveSupport::CurrentAttributes`
+
 ## [0.1.1] - 18.09.2025
 
 [Diff](https://github.com/espago/rails-on-sorbet/compare/v0.1.0...v0.1.1)

data/README.md

@@ -16,6 +16,17 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install rails-on-sorbet
 ```
 
+It is recommended to disable strict typechecking for this gem's RBI files
+generated by tapioca.
+
+This can be done by adding these lines to `sorbet/tapioca/config.yml`:
+
+```yml
+gem:
+  typed_overrides:
+    rails-on-sorbet: "false"
+```
+
 ## Usage
 
 This gem adds additional signatures to Rails types and builtin Ruby types that
@@ -90,15 +101,17 @@ Example:
   f.owner == f.user #=> true
 ```
 
-### ActiveSupport::CurrentAttributes
+### Rails::On::Sorbet::CurrentAttributes
+
+This is a subclass of `ActiveSupport::CurrentAttributes` with tapioca/sorbet support.
 
-New optional keyword arguments have been added to `ActiveSupport::CurrentAttributes::attribute`:
+New optional keyword arguments have been added to `attribute`:
 - `type`: the sorbet type of the getter/setter
 - `doc`: a docstring whose content will be used to generate a comment above the rbi signature created by tapioca
 
 Example:
 ```rb
-class Current < ActiveSupport::CurrentAttributes
+class Current < Rails::On::Sorbet::CurrentAttributes
   attribute :session_counter, type: T.nilable(Integer), doc: <<~DOC
     A counter that gets incremented when a new session is created.
   DOC

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

@@ -1,11 +1,11 @@
 # typed: false
 # frozen_string_literal: true
 
+require 'active_support'
+
 module Rails::On::Sorbet
   # Shim for ActiveSupport::CurrentAttributes to support sorbet
-  #
-  # @requires_ancestor: singleton(ActiveSupport::CurrentAttributes)
-  module CurrentAttributes
+  class CurrentAttributes < ActiveSupport::CurrentAttributes
     # Holds the data of a single attribute definition
     class Attribute
       #: Symbol
@@ -25,29 +25,23 @@ module Rails::On::Sorbet
       end
     end
 
-    # Get a map with all defined attributes and their types
-    #
-    #: -> Hash[Symbol, Attribute]
-    def attribute_map
-      @attribute_map ||= {}
-    end
+    class << self
+      # Get a map with all defined attributes and their types
+      #
+      #: -> Hash[Symbol, Attribute]
+      def attribute_map
+        @attribute_map ||= {}
+      end
 
-    # Declare a new attribute with a sorbet type
-    #
-    #: (*Symbol, ?type: untyped, ?doc: String?, ?default: untyped) -> void
-    def attribute(*names, type: nil, doc: nil, default: ::ActiveSupport::CurrentAttributes::NOT_SET)
-      names.each do |name|
-        attribute_map[name] = Attribute.new(name, type, doc)
+      # Declare a new attribute with a sorbet type
+      #
+      #: (*Symbol, ?type: untyped, ?doc: String?, ?default: untyped) -> void
+      def attribute(*names, type: nil, doc: nil, default: ::ActiveSupport::CurrentAttributes::NOT_SET)
+        names.each do |name|
+          attribute_map[name] = Attribute.new(name, type, doc)
+        end
+        super(*names, default: default)
       end
-      super(*names, default: default)
     end
   end
 end
-
-require 'active_support'
-
-module ActiveSupport
-  class CurrentAttributes # rubocop:disable Style/StaticClass
-    extend Rails::On::Sorbet::CurrentAttributes
-  end
-end

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

@@ -9,13 +9,3 @@ module Map
 end
 
 def Map(val) = val # rubocop:disable Style/TopLevelMethodDefinition,Naming/MethodName
-
-#: [K = String, V = untyped]
-class ActionController::Parameters
-  include Map
-end
-
-#: [K = String, V = untyped]
-class ActiveSupport::HashWithIndifferentAccess
-  include Map
-end

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

@@ -3,7 +3,7 @@
 module Rails
   module On
     module Sorbet
-      VERSION = '0.1.1'
+      VERSION = '0.2.0'
     end
   end
 end

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

@@ -3,7 +3,7 @@
 
 module Tapioca
   module Compilers
-    #: [ConstantType = Class & ::Rails::On::Sorbet::CurrentAttributes]
+    #: [ConstantType = singleton(::Rails::On::Sorbet::CurrentAttributes)]
     class RailsOnSorbetCurrentAttributes < Tapioca::Dsl::Compiler
 
       class << self
@@ -11,7 +11,7 @@ module Tapioca
         #: -> Enumerable[Module]
         def gather_constants
           all_classes.select do |klass|
-            klass.singleton_class < ::Rails::On::Sorbet::CurrentAttributes
+            klass < ::Rails::On::Sorbet::CurrentAttributes
           end
         end
       end

metadata

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