orthoses-rails 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9681e80e9a106b8d984c304a0f26777deb5e2077aba6f8a0321f52976e24bcc
-  data.tar.gz: c1f248d0e236bc72491e507da185317d55d607cebf4d6364209cd1601cacb6aa
+  metadata.gz: a9a2d180cb8faa295dc3043ea66a379ee71939436075104c0f85b63d6aede665
+  data.tar.gz: e02fa19ea12dfd296936673d67ecc6457b0e16101c18d4851747e0b895dace96
 SHA512:
-  metadata.gz: 8ff02244b5844c28186021d4379818a5a0b56ffcb693425f500e3145ff36da721a278c972a6a324e3b3b26bcb3ce9652c98f9fb3c15549fd51924371362d37fb
-  data.tar.gz: 284d60f37efb290cf6e5230dd10cda55066278e89e4b81866896793c535b4864edc7cb13c389d0c98a861c34630fba09df3bb04b1035291f7c4cc46666d22b9b
+  metadata.gz: 9e97ed8964e301618db94df7c0d410310ea3bd9605f66c9d7d0431dc71546e0faaff24f918ce05a58510250f7563934a9adb3977662d3526db0198016801ba77
+  data.tar.gz: 5d43746f2bcb1ae068902a66a0da54a852bb173fcdd85ff5d9ce0f07e2051cbbc31e7b1a2c8e0469b28e2ca6ca1661edb76a1665e6d7a3356c6bedb9de97cf00

data/lib/generators/orthoses/rails/templates/rails.rake

@@ -17,6 +17,13 @@ namespace :orthoses do
       # Complement missing const name.
       use Orthoses::MissingName
 
+      # You can use other publicly available middleware.
+      # `Orthoses::YARD` is available at https://github.com/ksss/orthoses-yard.
+      # By using this middleware, you can add the capability
+      # to generate type information from YARD documentation.
+      # use Orthoses::YARD,
+      #   parse: ['{app/lib}/**/*.rb']
+
       # You can load hand written RBS.
       # use Orthoses::LoadRBS,
       #   paths: Dir.glob(Rails.root / "sig/hand-written/**/*.rbs")

data/lib/orthoses/action_mailer/base.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActionMailer
+    class Base
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        @loader.call.tap do |store|
+          ::ActionMailer::Base.descendants.each do |mailer_class|
+            base_name = Utils.module_name(mailer_class) or next
+            content = store[base_name]
+            mailer_class.action_methods.each do |action_method|
+              method_object = mailer_class.instance_method(action_method)
+              parameters = method_parameters_to_rbs_method_type(method_object).to_s.gsub(' -> untyped', '')
+              content << "def self.#{action_method}: #{parameters} -> ::ActionMailer::MessageDelivery"
+            end
+          end
+        end
+      end
+
+      private
+
+      def method_parameters_to_rbs_method_type(method_object)
+        required_positionals = []
+        optional_positionals = []
+        rest_positionals = nil
+        trailing_positionals = []
+        required_keywords = {}
+        optional_keywords = {}
+        rest_keywords = nil
+        requireds = required_positionals
+        block = nil
+        untyped = RBS::Types::Bases::Any.new(location: nil)
+
+        method_object.parameters.each do |kind, name|
+          case kind
+          when :req
+            requireds << ::RBS::Types::Function::Param.new(name: name, type: untyped)
+          when :opt
+            requireds = trailing_positionals
+            optional_positionals << ::RBS::Types::Function::Param.new(name: name, type: untyped)
+          when :rest
+            requireds = trailing_positionals
+            name = nil if name == :*
+            rest_positionals = ::RBS::Types::Function::Param.new(name: name, type: untyped)
+          when :keyreq
+            required_keywords[name] = ::RBS::Types::Function::Param.new(name: nil, type: untyped)
+          when :key
+            optional_keywords[name] = ::RBS::Types::Function::Param.new(name: nil, type: untyped)
+          when :keyrest
+            rest_keywords = ::RBS::Types::Function::Param.new(name: name, type: untyped)
+          when :block
+            block = RBS::Types::Block.new(
+              type: RBS::Types::Function.empty(untyped).update(rest_positionals: RBS::Types::Function::Param.new(name: nil, type: untyped)),
+              required: true,
+              self_type: nil
+            )
+          else
+            raise "bug"
+          end
+        end
+
+        function = ::RBS::Types::Function.new(
+          required_positionals: required_positionals,
+          optional_positionals: optional_positionals,
+          rest_positionals: rest_positionals,
+          trailing_positionals: trailing_positionals,
+          required_keywords: required_keywords,
+          optional_keywords: optional_keywords,
+          rest_keywords: rest_keywords,
+          return_type: untyped,
+        )
+        ::RBS::MethodType.new(
+          location: nil,
+          type_params: [],
+          type: function,
+          block: block
+        )
+      end
+    end
+  end
+end

data/lib/orthoses/action_mailer.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'action_mailer/base'

data/lib/orthoses/active_model/attributes.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveModel
+    # < 7.0
+    #   def attribute(name, type = Type::Value.new, **options)
+    # >= 7.0
+    #   def attribute(name, cast_type = nil, default: NO_DEFAULT_PROVIDED, **options)
+    class Attributes
+      DEFAULT_TYPES = {
+        big_integer: '::Integer',
+        binary: '::String',
+        boolean: 'bool',
+        date: '::Date',
+        datetime: '::Time',
+        decimal: '::BigDecimal',
+        float: '::Float',
+        immutable_string: '::String',
+        integer: '::Integer',
+        string: '::String',
+        time: '::Time'
+      }
+
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        attribute = CallTracer::Lazy.new
+        store = attribute.trace('ActiveModel::Attributes::ClassMethods#attribute') do
+          @loader.call
+        end
+        attribute.captures.each do |capture|
+          receiver_name = Utils.module_name(capture.method.receiver) or next
+          name = capture.argument[:name]
+          active_model_version = Gem::Version.new(::ActiveModel::VERSION::STRING)
+          cast_type =
+            if active_model_version >= Gem::Version.new('7.1')
+              # https://github.com/rails/rails/commit/608cbfae36b125d7962b7ed9083c9e9e6ce70b88
+              capture.argument[:*].first
+            elsif active_model_version >= Gem::Version.new('7.0')
+              capture.argument[:cast_type]
+            else
+              capture.argument[:type]
+            end
+
+          return_type = DEFAULT_TYPES[cast_type] || 'untyped'
+
+          generated_attribute_methods = "#{receiver_name}::ActiveModelGeneratedAttributeMethods"
+          c = store[generated_attribute_methods]
+          c.header = "module #{generated_attribute_methods}"
+          c << "def #{name}: () -> #{return_type}?"
+          c << "def #{name}=: (untyped) -> untyped"
+
+          unless store[receiver_name].body.include?("include #{generated_attribute_methods}")
+            store[receiver_name] << "include #{generated_attribute_methods}"
+          end
+        end
+
+        store
+      end
+    end
+  end
+end

data/lib/orthoses/active_model.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative 'active_model/attributes'
 require_relative 'active_model/has_secure_password'

data/lib/orthoses/active_record/enum.rb

@@ -67,15 +67,35 @@ module Orthoses
 
         return_type_param = Hash === values ? "[String, String]" : "[String, Integer]"
         store[base_name] << "def self.#{name.pluralize}: () -> ActiveSupport::HashWithIndifferentAccess#{return_type_param}"
+        enum_methods_content = store["#{base_name}::ActiveRecord_Enum_EnumMethods"]
+        enum_methods_content.header = "module #{base_name}::ActiveRecord_Enum_EnumMethods"
 
-        pairs = values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index
+        pairs = (values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index).to_h
         pairs.each do |label, value|
           value_method_name = "#{prefix}#{label}#{suffix}"
-          enum_methods_content = store["#{base_name}::ActiveRecord_Enum_EnumMethods"]
-          enum_methods_content.header = "module #{base_name}::ActiveRecord_Enum_EnumMethods"
           enum_methods_content << "def #{value_method_name}?: () -> bool"
           enum_methods_content << "def #{value_method_name}!: () -> bool"
+
+          value_method_alias = "#{prefix}#{label.to_s.gsub(/[\W&&[:ascii:]]+/, "_")}#{suffix}"
+          if value_method_alias != value_method_name
+            enum_methods_content << "def #{value_method_alias}?: () -> bool"
+            enum_methods_content << "def #{value_method_alias}!: () -> bool"
+          end
+        end
+
+        # Expressing type casting.
+        store[base_name] << "def #{name}: () -> (#{pairs.keys.map { |k| "\"#{k}\"" }.join(" | ")})"
+        symbol_pattern = if pairs.keys.any? { |key| key.match?(/[^a-zA-Z_]/) }
+          "(Symbol) -> void"
+        else
+          "(#{pairs.keys.map{|key|key.to_sym.inspect}.join(" | ")}) -> void"
         end
+        overloads = [
+          symbol_pattern,
+          "(#{pairs.keys.map{|key|key.to_s.inspect}.join(" | ")}) -> void",
+          "(#{pairs.values.map(&:inspect).join(" | ")}) -> void",
+        ]
+        store[base_name] << "def #{name}=: #{overloads.join(" | ")}"
       end
     end
   end

data/lib/orthoses/active_record/generated_attribute_methods.rb

@@ -4,8 +4,6 @@ module Orthoses
   module ActiveRecord
     class GeneratedAttributeMethods
       TARGET_TYPE_MAP = {
-        "attribute" => "() -> %<type>s",
-        "attribute=" => "(%<type>s) -> %<type>s",
         "attribute?" => "() -> bool",
         "attribute_before_last_save" => "() -> %<opt>s",
         "attribute_before_type_cast" => "() -> %<type>s",
@@ -50,13 +48,14 @@ module Orthoses
               opt = "#{req}?"
               type = col.null ? opt : req
 
-              ::ActiveRecord::Base.attribute_method_matchers.each do |matcher|
-                tmpl = TARGET_TYPE_MAP[matcher.target]
+              lines << "attr_accessor #{name}: #{type}"
+              attribute_method_patterns(::ActiveRecord::Base).each do |matcher|
+                tmpl = TARGET_TYPE_MAP[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|
-              ::ActiveRecord::Base.attribute_method_matchers.each do |matcher|
+              attribute_method_patterns(::ActiveRecord::Base).each do |matcher|
                 lines << "alias #{matcher.method_name(alias_name)} #{matcher.method_name(column_name)}"
               end
             end
@@ -69,6 +68,20 @@ module Orthoses
           end
         end
       end
+
+      private
+
+      def attribute_method_patterns(const)
+        if const.respond_to?(:attribute_method_patterns)
+          const.attribute_method_patterns
+        else
+          const.attribute_method_matchers.each do |matcher|
+            def matcher.proxy_target
+              target
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/orthoses/active_record/relation.rb

@@ -19,7 +19,16 @@ module Orthoses
             class_specific_proxy = "#{model_name}::ActiveRecord_Associations_CollectionProxy"
             class_specific_generated_relation_methods = "#{model_name}::GeneratedRelationMethods"
 
+            # 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"
+              end
+              (klass.singleton_class.included_modules - ::ActiveRecord::Relation.included_modules).each do |mod|
+                mname = Utils.module_name(mod) or next
+                store[mname].header = "module #{mname}"
+                c << "include #{mname}"
+              end
             end
 
             store[class_specific_relation].tap do |c|

data/lib/orthoses/active_record/scope.rb

@@ -20,7 +20,7 @@ module Orthoses
           name = capture.argument[:name]
           body = capture.argument[:body]
 
-          definition = "#{name}: #{parameters_to_type(body.parameters)} -> #{base_name}::ActiveRecord_Relation"
+          definition = "#{name}: #{parameters_to_type(parameters(body))} -> #{base_name}::ActiveRecord_Relation"
           store[base_name] << "def self.#{definition}"
           store["#{base_name}::GeneratedRelationMethods"].header = "module #{base_name}::GeneratedRelationMethods"
           store["#{base_name}::GeneratedRelationMethods"] << "def #{definition}"
@@ -58,6 +58,14 @@ module Orthoses
         end
         "(#{res.join(", ")})#{block}"
       end
+
+      def parameters(body)
+        if body.respond_to?(:to_proc)
+          body.to_proc.parameters
+        else
+          body.method(:call).parameters
+        end
+      end
     end
   end
 end

data/lib/orthoses/active_support/concern.rb

@@ -36,7 +36,7 @@ module Orthoses
       def members_prototype_of(mod_name)
         mod = Object.const_get(mod_name)
         runtime = ::RBS::Prototype::Runtime.new(patterns: nil, env: nil, merge: false)
-        type_name = runtime.to_type_name(mod_name)
+        type_name = TypeName(mod_name)
         [].tap do |members|
           runtime.generate_methods(mod, type_name, members)
         end

data/lib/orthoses/rails/application.rb

@@ -17,6 +17,9 @@ module Orthoses
       def call
         loader = @loader
         Orthoses::Builder.new do
+          use Orthoses::ActionMailer::Base
+
+          use Orthoses::ActiveModel::Attributes
           use Orthoses::ActiveModel::HasSecurePassword
 
           use Orthoses::ActiveRecord::BelongsTo

data/lib/orthoses/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Orthoses
   module Rails
-    VERSION = "1.2.0"
+    VERSION = "1.4.0"
   end
 end

data/lib/orthoses/rails.rb

@@ -2,6 +2,7 @@
 
 require 'orthoses'
 
+require_relative 'action_mailer'
 require_relative 'active_model'
 require_relative 'active_record'
 require_relative 'active_storage'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-02 00:00:00.000000000 Z
+date: 2023-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
 description: Orthoses middleware collection for Ruby on Rails
 email:
 - co000ri@gmail.com
@@ -37,7 +37,10 @@ files:
 - lib/generators/orthoses/rails/install_generator.rb
 - lib/generators/orthoses/rails/templates/rails.rake
 - lib/orthoses-rails.rb
+- lib/orthoses/action_mailer.rb
+- lib/orthoses/action_mailer/base.rb
 - lib/orthoses/active_model.rb
+- lib/orthoses/active_model/attributes.rb
 - lib/orthoses/active_model/has_secure_password.rb
 - lib/orthoses/active_record.rb
 - lib/orthoses/active_record/belongs_to.rb