orthoses-rails 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc54caaf37167d7f0daa8a69f17d0776ab4475e5f416c82b27df0598624c5479
-  data.tar.gz: 400219e841b26f2d07996717634a16ba1d983b5abb4a1272ca8fc5f5b7b5d0a2
+  metadata.gz: 9c6dae9c8bb5c75510f72e22da5f64146257fa400f727556fc9ba362b5314451
+  data.tar.gz: 4b1abfccbdfaf8257cae7bfc680e3d224928b20ef1c9a7d6db95ba87a200bead
 SHA512:
-  metadata.gz: 52963191cb29945fe832adf1688474cb554803c743cd023f98de8dad3fe9bdc7e5461b426c5e6bbe6146dcc9d7ee02e9fc810b9a9814950240fe2bb66bd118b1
-  data.tar.gz: 7fe661c22f957eef62f2dc04eef9845e7000f052c88deddf7e359b99e962c44a6fdd5411efe6d3db6342ebf3c47ced1fbfd6454564427559112d170eee65e914
+  metadata.gz: c649345760163f2df4e274b8fc10e6c07431301829bc3a0e32ab76a1e1586859affadb56e61c397177b25553b4fe3bebaf40dde4c25ee216f3a479bdab5a8169
+  data.tar.gz: f6cebe8cdb7fddab69d3654fe70e84a03790182901b5335d2da2f5289f815f7802ff2508cce1abd8840b0c984eace3d8f355e07279f86c229cc6f7896acc5c76

data/README.md

@@ -15,15 +15,122 @@ $ bundle exec rbs collection install
 Build your Rake task for RBS generation.
 
 ```
-$ bin/rails generate orthoses:rails:install
+$ bundle exec rails generate orthoses:rails:install
 ```
 
 Then run the rake task.
 
 ```
-$ bin/rails orthoses:rails
+$ bundle exec rails orthoses:rails
 ```
 
+Output is stored in the `sig/orthoses` directory.
+
+## Output example
+
+```rb
+class User < ApplicationRecord
+  has_one :email_account, dependent: :destroy
+end
+```
+
+```rbs
+class User < ::ApplicationRecord
+  include User::GeneratedAssociationMethods
+  include User::GeneratedAttributeMethods
+  extend User::ActiveRecord_Persistence_ClassMethods
+  extend _ActiveRecord_Relation_ClassMethods[User, User::ActiveRecord_Relation, Integer]
+end
+
+class User::ActiveRecord_Associations_CollectionProxy < ::ActiveRecord::Associations::CollectionProxy
+  include _ActiveRecord_Relation[User, Integer]
+  include Enumerable[User]
+end
+
+module User::ActiveRecord_Persistence_ClassMethods
+  def build: (?id: Integer, ?created_at: ActiveSupport::TimeWithZone?, ?updated_at: ActiveSupport::TimeWithZone?, ?nickname: String?, **untyped) ?{ (User) -> void } -> User
+           | (Array[Hash[Symbol, untyped]]) ?{ (User) -> void } -> Array[User]
+
+  def create: (?id: Integer, ?created_at: ActiveSupport::TimeWithZone?, ?updated_at: ActiveSupport::TimeWithZone?, ?nickname: String?, **untyped) ?{ (User) -> void } -> User
+            | (Array[Hash[Symbol, untyped]]) ?{ (User) -> void } -> Array[User]
+
+  def create!: (?id: Integer, ?created_at: ActiveSupport::TimeWithZone?, ?updated_at: ActiveSupport::TimeWithZone?, ?nickname: String?, **untyped) ?{ (User) -> void } -> User
+             | (Array[Hash[Symbol, untyped]]) ?{ (User) -> void } -> Array[User]
+end
+
+class User::ActiveRecord_Relation < ::ActiveRecord::Relation
+  include Enumerable[User]
+  include User::GeneratedRelationMethods
+  include _ActiveRecord_Relation[User, Integer]
+end
+
+module ::User::GeneratedAssociationMethods
+  def build_email_account: (?untyped attributes) ?{ (EmailAccount) -> void } -> EmailAccount
+
+  def create_email_account: (?untyped attributes) ?{ (EmailAccount) -> void } -> EmailAccount
+
+  def create_email_account!: (?untyped attributes) ?{ (EmailAccount) -> void } -> EmailAccount
+
+  def email_account: () -> EmailAccount?
+
+  def email_account=: (EmailAccount?) -> EmailAccount?
+
+  # ...snip...
+end
+
+module ::User::GeneratedAttributeMethods
+  attr_accessor id: ::Integer
+
+  attr_accessor nickname: ::String?
+
+  attr_accessor updated_at: ::ActiveSupport::TimeWithZone?
+
+  attr_accessor created_at: ::ActiveSupport::TimeWithZone?
+
+  # ...snip...
+end
+
+module ::User::GeneratedRelationMethods
+  # ...snip...
+end
+```
+
+## Supported methods
+
+### ActionMailer
+
+- Action methods
+
+### ActiveModel
+
+- `attribute`
+- `has_secure_password`
+
+### ActiveRecord
+
+- Column attribute methods
+- `belongs_to`
+- `delegated_type`
+- `enum`
+- `has_many`
+- `has_one`
+- Relation and CollectionProxy methods
+- `scope`
+- `secure_token`
+
+### ActiveStorage
+
+- `has_one_attached`
+
+### ActiveSupport
+
+- `alias_attribute`
+- `class_attribute`
+- `class_methods`
+- `config_accessor`
+- `delegate`
+- `mattr_accessor`
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/orthoses/active_record/enum.rb

@@ -2,8 +2,6 @@
 
 module Orthoses
   module ActiveRecord
-    # <= 6.1
-    #   def enum(definitions)
     # >= 7.0
     #   def enum(name = nil, values = nil, **options)
     class Enum
@@ -26,27 +24,19 @@ module Orthoses
             store[base_name] << sig
           end
 
-          if capture.argument[:definitions]
-            # on rails 6
-            definitions = capture.argument[:definitions].slice!(:_prefix, :_suffix, :_scopes, :_default)
-            options = capture.argument[:definitions].transform_keys { |key| :"#{key[1..-1]}" }
-            definitions.each { |name, values| _enum(store, base_name, name, values, **options) }
+          name = capture.argument[:name]
+          values = capture.argument[:values]
+          options = capture.argument[:options]
+          if name
+            # rails 7 style
+            values, options = options, {} unless values
+            _enum(store, base_name, name, values, **options)
           else
-            # on rails 7
-            name = capture.argument[:name]
-            values = capture.argument[:values]
-            options = capture.argument[:options]
-            if name
-              # rails 7 style
-              values, options = options, {} unless values
-              _enum(store, base_name, name, values, **options)
-            else
-              # rails 6 style
-              definitions = options.slice!(:_prefix, :_suffix, :_scopes, :_default)
-              options.transform_keys! { |key| :"#{key[1..-1]}" }
+            # rails 6 style (will remove rails 8)
+            definitions = options.slice!(:_prefix, :_suffix, :_scopes, :_default)
+            options.transform_keys! { |key| :"#{key[1..-1]}" }
 
-              definitions.each { |name, values| _enum(store, base_name, name, values, **options) }
-            end
+            definitions.each { |name, values| _enum(store, base_name, name, values, **options) }
           end
         end
 
@@ -87,6 +77,7 @@ module Orthoses
         # Expressing type casting.
         overloads = [] #: Array[String]
         if pairs.length <= @strict_limit
+          store[base_name] << "type #{name}_return = #{pairs.keys.map { |k| "\"#{k}\"" }.join(" | ")}"
           if pairs.keys.any? { |key| key.match?(/[^a-zA-Z_]/) }
             overloads << "(Symbol) -> void"
           else
@@ -94,12 +85,13 @@ module Orthoses
           end
           overloads << "(#{pairs.keys.map{|key|key.to_s.inspect}.join(" | ")}) -> void"
           overloads << "(#{pairs.values.map(&:inspect).join(" | ")}) -> void"
-          store[base_name] << "def #{name}: () -> (#{pairs.keys.map { |k| "\"#{k}\"" }.join(" | ")})"
+          store[base_name] << "def #{name}: () -> #{name}_return"
           store[base_name] << "def #{name}=: #{overloads.join(" | ")}"
         else
+          store[base_name] << "type #{name}_return = String"
           overloads << "(Symbol | String) -> void"
           overloads << "(#{pairs.values.map { |v| Orthoses::Utils.object_to_rbs(v) }.uniq.join(" | ")}) -> void"
-          store[base_name] << "def #{name}: () -> String"
+          store[base_name] << "def #{name}: () -> #{name}_return"
           store[base_name] << "def #{name}=: #{overloads.join(" | ")}"
         end
       end

data/lib/orthoses/active_record/generated_attribute_methods.rb

@@ -25,8 +25,12 @@ module Orthoses
         "will_save_change_to_attribute?" => "() -> bool",
       }
 
-      def initialize(loader)
+      def initialize(loader, targets: TARGET_TYPE_MAP.keys)
         @loader = loader
+        unless targets.all? { |target| TARGET_TYPE_MAP.key?(target) }
+          raise ArgumentError, "Unknown target type: #{targets - TARGET_TYPE_MAP.keys}"
+        end
+        @targets = targets
       end
 
       def call
@@ -50,12 +54,13 @@ module Orthoses
 
               lines << "attr_accessor #{name}: #{type}"
               attribute_method_patterns(::ActiveRecord::Base).each do |matcher|
-                tmpl = TARGET_TYPE_MAP[matcher.proxy_target] or next
+                tmpl = target_type(matcher.proxy_target) or next
                 lines << "def #{matcher.method_name(name)}: #{tmpl % {type: type, opt: opt}}"
               end
             end
             klass.attribute_aliases.each do |alias_name, column_name|
               attribute_method_patterns(::ActiveRecord::Base).each do |matcher|
+                next unless matcher.proxy_target == "attribute" || target_type(matcher.proxy_target)
                 lines << "alias #{matcher.method_name(alias_name)} #{matcher.method_name(column_name)}"
               end
             end
@@ -82,6 +87,11 @@ module Orthoses
           end
         end
       end
+
+      def target_type(target)
+        return unless @targets.include?(target)
+        TARGET_TYPE_MAP[target]
+      end
     end
   end
 end

data/lib/orthoses/active_record/relation.rb

@@ -23,7 +23,7 @@ module Orthoses
             # Expressing delegation.
             store[class_specific_generated_relation_methods].tap do |c|
               klass.singleton_methods(false).each do |singleton_method|
-                c << "def #{singleton_method}: (*untyped, **untyped) -> untyped"
+                c << "def #{singleton_method}: (?) -> untyped"
               end
               if @strict
                 (klass.singleton_class.included_modules - ::ActiveRecord::Relation.included_modules).each do |mod|
@@ -44,6 +44,7 @@ module Orthoses
             store[class_specific_proxy].tap do |c|
               c.header = "class #{class_specific_proxy} < ::ActiveRecord::Associations::CollectionProxy"
               c << "include _ActiveRecord_Relation[#{model_name}, #{primary_key}]"
+              c << "include Enumerable[#{model_name}]"
             end
 
             store[model_name].tap do |c|

data/lib/orthoses/active_record/scope.rb

@@ -32,6 +32,10 @@ module Orthoses
       private
 
       def parameters_to_type(parameters)
+        # foo(...)
+        if parameters in [[:rest, :*], [:keyrest, :**], [:block, :&]]
+          return "(?)"
+        end
         # @type var res: Array[String]
         res = []
         # @type var block: String?

data/lib/orthoses/active_support/delegation.rb

@@ -50,7 +50,7 @@ module Orthoses
               # no type found
               capture.argument[:methods].each do |method|
                 receiver_content << "# defined by `delegate` to: #{to_return_type}##{to_name}"
-                receiver_content << "#{prefix}def #{method}: (*untyped, **untyped) -> untyped"
+                receiver_content << "#{prefix}def #{method}: (?) -> untyped"
               end
             else
               # found return type in store or env

data/lib/orthoses/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Orthoses
   module Rails
-    VERSION = "1.8.1"
+    VERSION = "1.9.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-rails
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - ksss
 bindir: exe
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
@@ -84,14 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Orthoses middleware collection for Ruby on Rails
 test_files: []