orthoses-rails 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec337b1da4ecda39f953797824239ede59c536c74da48cc1dbd01e46eed1d2b0
-  data.tar.gz: b146481d3fda9b3568a1593fd05608f09c811e1181356f2e36d2b010c30dd130
+  metadata.gz: dc7b416eba2452375317a5c028aeae285d135ee8c8ef4129f28170f46d0090d9
+  data.tar.gz: 71148b9456d3038c6960611ac78e764590f8becd9376e1d136fb06549e80a378
 SHA512:
-  metadata.gz: 2bec23dc332048a010d10a2dc01754b969f76d2dd19bfa4b50393c1a764b3de496a35d018560aca04fe43630de497e900bb580774698bda3073ea33dcbf44bb5
-  data.tar.gz: e2dac22ee12a3bf049a73e5609d4a3ca1693c2dbc851c3bb06256e4566e9adad6c991fa9a60b0aaa7b22d6ea19e0c7cbc65c403cd136669d4c98b58deb7d90e7
+  metadata.gz: 6abe5dd4e76632c6039a20da11e44e63851713a4793e31661e246ce00d1de36ced9c0ecfe182efe2108df2e59c54e00cadf4d857eb1e7c447dd36d289de068b5
+  data.tar.gz: 6e1df2008c803ffa594d2fc96312ef9d97bda0570339604a40b47e8ff35c94118dd7ed2ca1cf77f7316cf3464ba7cbdc9ec438d182a4099983c0625ece69024c

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/active_model/attributes.rb

@@ -0,0 +1,55 @@
+# 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]
+          cast_type = capture.argument[:cast_type] || capture.argument[:type]
+
+          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/belongs_to.rb

@@ -18,15 +18,7 @@ module Orthoses
               type = if ref.polymorphic?
                 'untyped'
               else
-                begin
-                  Utils.module_name(ref.klass) or next
-                rescue NameError => e
-                  while e
-                    Orthoses.logger.warn(e.message)
-                    e = e.cause
-                  end
-                  next
-                end
+                Orthoses::ActiveRecord.reflection_klass_name(ref) or next
               end
               opt = "#{type}?"
 

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/has_many.rb

@@ -15,16 +15,7 @@ module Orthoses
 
             lines = base.reflect_on_all_associations(:has_many).flat_map do |ref|
               singular_name = ref.name.to_s.singularize
-              type =
-                begin
-                  Utils.module_name(ref.klass)
-                rescue NameError => e
-                  while e
-                    Orthoses.logger.warn(e.message)
-                    e = e.cause
-                  end
-                  next
-                end
+              type = Orthoses::ActiveRecord.reflection_klass_name(ref) or next
 
               collection_proxy = "::#{type}::ActiveRecord_Associations_CollectionProxy"
               [

data/lib/orthoses/active_record/has_one.rb

@@ -14,16 +14,7 @@ module Orthoses
             base_name = Utils.module_name(base) || next
 
             lines = base.reflect_on_all_associations(:has_one).flat_map do |ref|
-              type =
-                begin
-                  Utils.module_name(ref.klass) or next
-                rescue NameError => e
-                  while e
-                    Orthoses.logger.warn(e.message)
-                    e = e.cause
-                  end
-                  next
-                end
+              type = Orthoses::ActiveRecord.reflection_klass_name(ref) or next
               opt = "#{type}?"
 
               [

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.rb

@@ -43,5 +43,16 @@ module Orthoses
         'untyped'
       end
     end
+
+    def self.reflection_klass_name(ref)
+      Utils.module_name(ref.klass)
+    rescue NameError, ArgumentError => e
+      while e
+        Orthoses.logger.warn(e.message)
+        e = e.cause
+      end
+
+      nil
+    end
   end
 end

data/lib/orthoses/rails/application.rb

@@ -17,6 +17,7 @@ module Orthoses
       def call
         loader = @loader
         Orthoses::Builder.new do
+          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.1.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2023-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
 description: Orthoses middleware collection for Ruby on Rails
 email:
 - co000ri@gmail.com
@@ -38,6 +38,7 @@ files:
 - lib/generators/orthoses/rails/templates/rails.rake
 - lib/orthoses-rails.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