orthoses-rails 0.3.0 → 0.6.0

data/examples/rails/tasks/active_support.rake

@@ -0,0 +1,92 @@
+stdlib_dependencies = %w[benchmark date digest json logger monitor mutex_m pathname singleton time minitest]
+gem_dependencies = %w[nokogiri]
+rails_dependencies = %w[]
+
+VERSIONS.each do |version|
+  namespace version do
+    namespace :active_support do
+      export = "export/activesupport/#{version}"
+
+      desc "export to #{export}"
+      task :export do
+        sh "rm -fr #{export}"
+        sh "mkdir -p #{export}"
+
+        # minimum
+        sh "cp -a out/#{version}/active_support.rbs #{export}"
+        sh "cp -a out/#{version}/active_support #{export}"
+        sh "rm #{export}/active_support/railtie.rbs"
+
+        # core_ext
+        %w[
+          array benchmark big_decimal class date date_and_time date_time digest
+          enumerable file hash integer kernel load_error marshal module name_error numeric
+          object pathname range regexp securerandom string symbol time uri
+        ].each do |lib|
+          out = "out/#{version}/#{lib}"
+          sh "cp -a #{out} #{export}" if File.exist?(out)
+          sh "cp -a #{out}.rbs #{export}" if File.exist?("#{out}.rbs")
+        end
+
+        Pathname(export).join("EXTERNAL_TODO.rbs").write(<<~RBS)
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          module DRb
+            module DRbUndumped
+            end
+          end
+          module Concurrent
+            class Map
+            end
+          end
+        RBS
+
+        case version
+        when "6.0", "6.1"
+          sh "rm -fr #{export}/uri"
+        when "7.0"
+          # deprecated
+          sh "rm -fr #{export}/uri{,.rbs}"
+        end
+
+        generate_test_script(
+          gem: :activesupport,
+          version: version,
+          export: export,
+          stdlib_dependencies: stdlib_dependencies,
+          gem_dependencies: gem_dependencies,
+          rails_dependencies: rails_dependencies,
+        )
+
+        Pathname(export).join('_test').join('test.rb').write(<<~'RUBY')
+          # !!! GENERATED CODE !!!
+          # Please see generators/rails-generator
+
+          require 'active_support/all'
+
+          # Test ActiveSupport::NumericWithFormat
+          42.to_s
+          42.to_s(:phone)
+
+          3.days.ago + 1.minute
+        RUBY
+      end
+
+      desc "validate version=#{version} gem=active_support"
+      task :validate do
+        stdlib_opt = stdlib_dependencies.map{"-r #{_1}"}.join(" ")
+        gem_opt = gem_dependencies.map{"-I ../../.gem_rbs_collection/#{_1}"}.join(" ")
+        rails_opt = rails_dependencies.map{"-I export/#{_1}/#{version}"}.join(" ")
+        sh "rbs #{stdlib_opt} #{gem_opt} #{rails_opt} -I #{export} validate --silent"
+      end
+
+      desc "install to ../../../gems/activesupport/#{version}"
+      task :install do
+        install_to = File.expand_path("../../../gems/activesupport/#{version}", __dir__)
+        sh "rm -fr #{install_to}"
+        sh "cp -a #{export} #{install_to}"
+      end
+    end
+  end
+end

data/lib/orthoses/active_model/has_secure_password.rb

@@ -27,12 +27,12 @@ module Orthoses
           @loader.call
         end
 
-        call_tracer.result.each do |method, argument|
-          next unless method.receiver.kind_of?(Class)
-          base_name = Utils.module_name(method.receiver)
+        call_tracer.captures.each do |capture|
+          next unless capture.method.receiver.kind_of?(Class)
+          base_name = Utils.module_name(capture.method.receiver)
           next unless base_name
 
-          attribute = argument[:attribute] || :password
+          attribute = capture.argument[:attribute] || :password
           full_name = if ::ActiveModel::VERSION::MAJOR < 6
             "ActiveModel::SecurePassword::InstanceMethodsOnActivation"
           else

data/lib/orthoses/active_model.rb

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

data/lib/orthoses/active_record/delegated_type.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveRecord
+    # <= 6.0
+    #   not implemented
+    # >= 6.1
+    #   def delegated_type(role, types:, **options)
+    class DelegatedType
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        target = begin
+          ::ActiveRecord::DelegatedType.instance_method(:delegated_type)
+        rescue NameError
+          Orthoses.logger.warn("[ActiveRecord::DelegatedType] Skip since `delegated_type' is not implemented")
+          return @loader.call
+        end
+        delegated_type = CallTracer.new
+        store = delegated_type.trace(target) do
+          @loader.call
+        end
+
+        delegated_type.captures.each do |capture|
+          base_name = Utils.module_name(capture.method.receiver) or next
+          role = capture.argument[:role]
+          types = capture.argument[:types]
+          options = capture.argument[:options]
+          primary_key = options[:primary_key] || "id"
+
+          content = store[base_name]
+          content << "def #{role}_class: () -> (#{types.join(' | ')})"
+          content << "def #{role}_name: () -> String"
+          content << "def build_#{role}: () -> (#{types.join(' | ')})"
+          types.each do |type|
+            scope_name = type.tableize.gsub("/", "_")
+            singular = scope_name.singularize
+            content << "def #{singular}?: () -> bool"
+            content << "def #{singular}: () -> #{type}?"
+            content << "def #{singular}_#{primary_key}: () -> Integer?"
+          end
+        end
+
+        store
+      end
+    end
+  end
+end

data/lib/orthoses/active_record/enum.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveRecord
+    # <= 6.1
+    #   def enum(definitions)
+    # >= 7.0
+    #   def enum(name = nil, values = nil, **options)
+    class Enum
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        enum = CallTracer.new
+        store = enum.trace(::ActiveRecord::Enum.instance_method(:enum)) do
+          @loader.call
+        end
+
+        enum.captures.each do |capture|
+          base_name = Utils.module_name(capture.method.receiver) or next
+
+          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) }
+          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]}" }
+
+              definitions.each { |name, values| _enum(store, base_name, name, values, **options) }
+            end
+          end
+        end
+
+        store
+      end
+
+      private
+
+      def _enum(store, base_name, name, values, prefix: nil, suffix: nil, **_options)
+        name = name.to_s
+
+        prefix = if prefix
+          prefix == true ? "#{name}_" : "#{prefix}_"
+        end
+
+        suffix = if suffix
+          suffix == true ? "_#{name}" : "_#{suffix}"
+        end
+
+        return_type_param = Hash === values ? "[String, String]" : "[String, Integer]"
+        store[base_name] << "def self.#{name.pluralize}: () -> ActiveSupport::HashWithIndifferentAccess#{return_type_param}"
+
+        pairs = values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index
+        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"
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/active_record/scope.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveRecord
+    # def scope(name, body, &block)
+    class Scope
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        scope = CallTracer.new
+        store = scope.trace(::ActiveRecord::Scoping::Named::ClassMethods.instance_method(:scope)) do
+          @loader.call
+        end
+
+        scope.captures.each do |capture|
+          base_name = Utils.module_name(capture.method.receiver) or next
+
+          name = capture.argument[:name]
+          body = capture.argument[:body]
+
+          definition = "#{name}: #{parameters_to_type(body.parameters)} -> #{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}"
+        end
+
+        store
+      end
+
+      private
+
+      def parameters_to_type(parameters)
+        # @type var res: Array[String]
+        res = []
+        # @type var block: String?
+        block = nil
+        parameters.each do |(type, name)|
+          case type
+          when :req
+            res << "untyped #{name}"
+          when :opt
+            res << "?untyped #{name}"
+          when :keyreq
+            res << "#{name}: untyped"
+          when :key
+            res << "?#{name}: untyped"
+          when :rest
+            res << "*untyped #{name}"
+          when :keyrest
+            res << "**untyped #{name}"
+          when :block
+            block = " { (*untyped) -> untyped }"
+          else
+            raise "unexpected: #{type}"
+          end
+        end
+        "(#{res.join(", ")})#{block}"
+      end
+    end
+  end
+end

data/lib/orthoses/active_record.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require_relative 'active_record/belongs_to'
+require_relative 'active_record/delegated_type'
+require_relative 'active_record/enum'
 require_relative 'active_record/generated_attribute_methods'
 require_relative 'active_record/has_many'
 require_relative 'active_record/has_one'
-require_relative 'active_record/known_sig'
 require_relative 'active_record/query_methods'
+require_relative 'active_record/scope'

data/lib/orthoses/active_support/class_attribute.rb

@@ -28,22 +28,22 @@ module Orthoses
           @loader.call
         end
 
-        call_tracer.result.each do |method, argument|
-          receiver_name = Orthoses::Utils.module_name(method.receiver)
+        call_tracer.captures.each do |capture|
+          receiver_name = Orthoses::Utils.module_name(capture.method.receiver)
           next unless receiver_name
 
           methods = []
           if ::ActiveSupport::VERSION::MAJOR < 6
-            options = argument[:attrs].extract_options!
-            argument[:instance_reader]    = options.fetch(:instance_accessor, true) && options.fetch(:instance_reader, true)
-            argument[:instance_writer]    = options.fetch(:instance_accessor, true) && options.fetch(:instance_writer, true)
-            argument[:instance_predicate] = options.fetch(:instance_predicate, true)
-            argument[:default_value]      = options.fetch(:default, nil)
+            options = capture.argument[:attrs].extract_options!
+            capture.argument[:instance_reader]    = options.fetch(:instance_accessor, true) && options.fetch(:instance_reader, true)
+            capture.argument[:instance_writer]    = options.fetch(:instance_accessor, true) && options.fetch(:instance_writer, true)
+            capture.argument[:instance_predicate] = options.fetch(:instance_predicate, true)
+            capture.argument[:default_value]      = options.fetch(:default, nil)
           end
 
           content = store[receiver_name]
 
-          argument[:attrs].each do |name|
+          capture.argument[:attrs].each do |name|
             next unless @if.nil? || @if.call(method, name)
 
             # skip internal attribute
@@ -52,11 +52,11 @@ module Orthoses
             next if name == :attributes_to_define_after_schema_loads
 
             methods << "def self.#{name}: () -> untyped"
-            methods << "def self.#{name}?: () -> bool" if argument[:instance_predicate]
+            methods << "def self.#{name}?: () -> bool" if capture.argument[:instance_predicate]
             methods << "def self.#{name}=: (untyped value) -> untyped"
-            methods << "def #{name}: () -> untyped" if argument[:instance_reader]
-            methods << "def #{name}?: () -> bool" if argument[:instance_predicate] && argument[:instance_reader]
-            methods << "def #{name}=: (untyped value) -> untyped" if argument[:instance_writer]
+            methods << "def #{name}: () -> untyped" if capture.argument[:instance_reader]
+            methods << "def #{name}?: () -> bool" if capture.argument[:instance_predicate] && capture.argument[:instance_reader]
+            methods << "def #{name}=: (untyped value) -> untyped" if capture.argument[:instance_writer]
             # In RBS, `foo=` and attr_writer :foo cannot live together.
             content.body.delete_if { |line| line.start_with?("attr_writer #{name}:") }
           end

data/lib/orthoses/active_support/configurable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module ActiveSupport
+    # <= 6.1
+    #   def config_accessor(*names, instance_reader: true, instance_writer: true, instance_accessor: true)
+    # >= 7
+    #   def config_accessor(*names, instance_reader: true, instance_writer: true, instance_accessor: true, default: nil)
+    class Configurable
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        config_accessor = CallTracer.new
+        store = config_accessor.trace(::ActiveSupport::Configurable::ClassMethods.instance_method(:config_accessor)) do
+          @loader.call
+        end
+        config_accessor.captures.each do |capture|
+          mod_name = Utils.module_name(capture.method.receiver) or next
+          content = store[mod_name]
+          capture.argument[:names].each do |name|
+            content << "def self.#{name}: () -> untyped"
+            content << "def self.#{name}=: (untyped value) -> untyped"
+            if capture.argument[:instance_accessor]
+              content << "def #{name}: () -> untyped" if capture.argument[:instance_reader]
+              content << "def #{name}=: (untyped value) -> untyped" if capture.argument[:instance_writer]
+            end
+          end
+        end
+
+        store
+      end
+    end
+  end
+end

data/lib/orthoses/active_support/delegation.rb

@@ -24,41 +24,41 @@ module Orthoses
 
         resource = Resource.new(store)
 
-        delegate.result.each do |method, argument|
-          receiver_name = Utils.module_name(method.receiver) or next
+        delegate.captures.each do |capture|
+          receiver_name = Utils.module_name(capture.method.receiver) or next
           receiver_content = store[receiver_name]
-          case argument[:to]
+          case capture.argument[:to]
           when Module
-            to_module_name = Utils.module_name(argument[:to]) or next
-            argument[:methods].each do |arg|
+            to_module_name = Utils.module_name(capture.argument[:to]) or next
+            capture.argument[:methods].each do |arg|
               if sig = resource.build_signature(to_module_name, arg, :singleton, false)
                 receiver_content << "# defined by `delegate` to: #{to_module_name}"
                 receiver_content << sig
               else
-                Orthoses.logger.warn("[ActiveSupport::Delegation] Ignore #{arg.inspect}")
+                Orthoses.logger.warn("[ActiveSupport::Delegation] Ignore since missing type for #{to_module_name}.#{arg.inspect} in #{capture.argument.inspect}")
               end
             end
           else
-            to_name = argument[:to].to_s.to_sym
+            to_name = capture.argument[:to].to_s.to_sym
             tag, to_return_type = resource.find(receiver_name, to_name, :instance, false)
             raise "bug" if tag == :multi
             if to_return_type.nil?
-              Orthoses.logger.warn("[ActiveSupport::Delegation] Ignore #{argument.inspect}")
+              Orthoses.logger.warn("[ActiveSupport::Delegation] Ignore since missing type for #{receiver_name}##{to_name.inspect} in #{capture.argument.inspect}")
               next
             end
             if to_return_type.instance_of?(RBS::Types::Bases::Any)
-              argument[:methods].each do |method|
-                receiver_content << "# defined by `delegate` to: :#{to_name}(#{to_return_type})"
+              capture.argument[:methods].each do |method|
+                receiver_content << "# defined by `delegate` to: #{to_return_type}##{to_name}"
                 receiver_content << "def #{method}: (*untyped, **untyped) -> untyped"
               end
             else
               to_typename = to_return_type.name.relative!.to_s
-              argument[:methods].each do |method|
+              capture.argument[:methods].each do |method|
                 if sig = resource.build_signature(to_typename, method, :instance, true)
-                  receiver_content << "# defined by `delegate` to: :#{to_name}(#{to_return_type})"
+                  receiver_content << "# defined by `delegate` to #{to_return_type}##{to_name}"
                   receiver_content << sig
                 else
-                  Orthoses.logger.warn("[ActiveSupport::Delegation] Ignore #{method.inspect}")
+                  Orthoses.logger.warn("[ActiveSupport::Delegation] Ignore since missing type for #{to_typename}##{method.inspect} in #{capture.argument.inspect}")
                 end
               end
             end
@@ -146,7 +146,7 @@ module Orthoses
             when RBS::AST::Members::Mixin, RBS::AST::Members::LocationOnly
               next
             else
-              binding.irb
+              raise "bug: #{member.class} is not supported yet"
             end
           end
 

data/lib/orthoses/active_support/mattr_accessor.rb

@@ -22,14 +22,14 @@ module Orthoses
           end
         end
 
-        mattr_reader.result.each do |method, argument|
-          base = Orthoses::Utils.module_name(method.receiver) || next
+        mattr_reader.captures.each do |capture|
+          base = Orthoses::Utils.module_name(capture.method.receiver) || next
           methods = []
-          argument[:syms].each do |sym|
+          capture.argument[:syms].each do |sym|
             next unless @if.nil? || @if.call(method, sym)
 
             methods << "def self.#{sym}: () -> untyped"
-            if argument[:instance_reader] && argument[:instance_accessor]
+            if capture.argument[:instance_reader] && capture.argument[:instance_accessor]
               methods << "def #{sym}: () -> untyped"
             end
           end
@@ -38,14 +38,14 @@ module Orthoses
           store[base].concat(methods)
         end
 
-        mattr_writer.result.each do |method, argument|
-          base = Orthoses::Utils.module_name(method.receiver) || next
+        mattr_writer.captures.each do |capture|
+          base = Orthoses::Utils.module_name(capture.method.receiver) || next
           methods = []
-          argument[:syms].each do |sym|
+          capture.argument[:syms].each do |sym|
             next unless @if.nil? || @if.call(method, sym)
 
             methods << "def self.#{sym}=: (untyped val) -> untyped"
-            if argument[:instance_writer] && argument[:instance_accessor]
+            if capture.argument[:instance_writer] && capture.argument[:instance_accessor]
               methods << "def #{sym}=: (untyped val) -> untyped"
             end
           end

data/lib/orthoses/active_support/time_with_zone.rb

@@ -7,11 +7,6 @@ module Orthoses
         @loader = loader
       end
 
-      LOAD_PATHS = [
-        File.expand_path("known_sig/time.rbs", __dir__),
-        File.expand_path("known_sig/active_support/time_with_zone.rbs", __dir__),
-      ]
-
       # Time <= (known Time)
       # TimeWithZone <= (known TimeWithZone, known Time, core Time)
       def call
@@ -27,17 +22,23 @@ module Orthoses
 
       private
 
-      NOT_DELEGATE_METHODS = %i[
+      NOT_DELEGATE_METHODS = Set.new(%i[
         utc
         getgm
         getutc
         gmtime
         localtime
-      ]
+      ])
+
+      TYPE_MERGE_METHODS = Set.new(%i[
+        +
+        -
+      ])
 
       def each_line_from_core_time_definition(store)
         type_name_time = TypeName("::Time")
-        env = Utils.rbs_environment(collection: true).dup
+        type_name_time_with_zone = TypeName("::ActiveSupport::TimeWithZone")
+        env = Utils.rbs_environment(collection: true, cache: false)
         env << store["Time"].to_decl
         env << store["DateAndTime"].to_decl
         env << store["DateAndTime::Zones"].to_decl
@@ -53,6 +54,7 @@ module Orthoses
         one_ancestors.included_modules.each do |included_module|
           yield "include #{included_module.source.name}"
         end
+        twz_methods = builder.build_instance(type_name_time_with_zone).methods
         builder.build_instance(type_name_time).methods.each do |sym, definition_method|
           next if !definition_method.public?
           definition_method.defs.reject! do |type_def|
@@ -70,7 +72,18 @@ module Orthoses
           end
 
           if definition_method.alias_of.nil?
-            yield "def #{sym}: #{definition_method.method_types.join(" | ")}"
+            method_types = definition_method.method_types
+
+            if TYPE_MERGE_METHODS.include?(sym)
+              if twz_definition_method = twz_methods[sym]
+                twz_definition_method.defs.each do |type_def|
+                  if type_def.implemented_in == type_name_time_with_zone
+                    method_types << type_def.type
+                  end
+                end
+              end
+            end
+            yield "def #{sym}: #{method_types.join(" | ")}"
           else
             yield "alias #{sym} #{definition_method.alias_of.defs.first.member.name}"
           end

data/lib/orthoses/active_support.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 require_relative 'active_support/class_attribute'
-require_relative 'active_support/concern'
+require_relative 'active_support/configurable'
 require_relative 'active_support/delegation'
 require_relative 'active_support/mattr_accessor'
 require_relative 'active_support/time_with_zone'
-require_relative 'active_support/known_sig'
 
 module Orthoses
   module ActiveSupport
@@ -15,11 +14,9 @@ module Orthoses
     #     end
     def self.each
       yield ClassAttribute
-      yield Concern
       yield Delegation
       yield MattrAccessor
       yield TimeWithZone
-      yield KnownSig
     end
   end
 end

data/lib/orthoses/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Orthoses
   module Rails
-    VERSION = "0.3.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/orthoses/rails.rb

@@ -3,7 +3,6 @@
 require 'orthoses'
 
 require_relative "rails/version"
-require_relative "rails/known_sig_helper"
 
 require_relative 'active_model'
 require_relative 'active_record'

data/orthoses-rails.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "orthoses"
+  spec.add_dependency "orthoses", ">= 0.10"
 end