orthoses-rails 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf5adf50ae35b548291c69ba03b7eb6086e1214c863b83c85de0af3c81de3b17
-  data.tar.gz: a162e4dc8583a4a738ac38b41ee7fb65db67349e08b2ead5f8bfc41bc3b057c1
+  metadata.gz: 46bcd93481527f23bfe512d336313721f7cf17fe67bb124e51e016f59cff14c2
+  data.tar.gz: 7a783be26aeeb877069e4c0e431765e274bb07dd25438669ca8dbb58c6417405
 SHA512:
-  metadata.gz: 8c5494faf887bb600e081967321ec6c25e24610206de9014323f13e6b43147711eb05fd1d670f815adca2739f8f80988823a5c7b06adcc193092144b7aafb0d3
-  data.tar.gz: 119911fd1cd01d7fc059fc3c23f989573771126a5ca4aa4a7091a7ca604a0a6d5d86726eda48312969695a30ec70498dd2af060231abca09aecb56212cfa2b68
+  metadata.gz: ef3237aa508e90177b76dd160456404cf37dfcd1907b18ad299b1cd2f95e1abd4971762de5a0679850943b220348b7f7528689eef31be84651a30cbb29eb2601
+  data.tar.gz: 353ee63dc4a5bd7fa82fa59f571766b842690c09bd98d14e4f3f1defbb77ec14870f361149b3ac0ab6b46cad9b933f02ecaf8190a5824a4e3739b088ba14bea4

data/README.md

@@ -5,42 +5,36 @@ Orthoses::Rails automatically generates RBS for methods added by Rails.
 
 ## Features
 
-### Orthoses::ActiveModel::HasSecurePassword
-
-Add signatures that generated form `ActiveModel::SecurePassword::ClassMethods#has_secure_password`.
-
-### Orthoses::ActiveRecord::BelongsTo
-
-Add signatures that generated form `ActiveRecord::Associations::ClassMethods#belongs_to`.
-
-### Orthoses::ActiveRecord::GeneratedAttributeMethods
-
-Add signatures that generated from DB schema columns.
-
-### Orthoses::ActiveRecord::HasMany
-
-Add signatures that generated form `ActiveRecord::Associations::ClassMethods#has_many`.
-
-### Orthoses::ActiveRecord::HasOne
-
-Add signatures that generated form `ActiveRecord::Associations::ClassMethods#has_one`.
-
-### Orthoses::ActiveSupport::ClassAttribute
-
-Add signatures that generated form `Class#class_attribute`.
-
-### Orthoses::ActiveSupport::Concern
-
-Add signature `extend ActiveSupport::Concern` only.
-
-### Orthoses::ActiveSupport::MattrAccessor
-
-Add signatures that generated form `Module#mattr_accessor`, `Module#mattr_reader` and `Module#mattr_writer`.
-
-### Orthoses::ActiveSupport::TimeWithZone
-
-Add signatures `Time` and `ActiveSupport::TimeWithZone`.
-Methods and mixin delegated from `Time` are added to `ActiveSupport::TimeWithZone`.
+### Orthoses::ActiveModel
+
+- `HasSecurePassword`
+  - Add signatures that generated form `has_secure_password`.
+
+### Orthoses::ActiveRecord
+
+- `BelongsTo`
+  - Add signatures that generated form `belongs_to`.
+- `DelegatedType`
+  - Add signatures that generated from `delegated_type`
+- `Enum`
+  - Add signatures that generated from `enum`
+- `HasMany`
+  - Add signatures that generated form `has_many`.
+- `HasOne`
+  - Add signatures that generated form `has_one`.
+- `Scope`
+  - Add signatures that generated form `scope`.
+
+### Orthoses::ActiveSupport
+
+- `ClassAttribute`
+  - Add signatures that generated form `class_attribute`.
+- `Configurable`
+  - Add signatures that generated from `config_accessor`
+- `Delegation`
+  - Add signatures that generated from `delegate`. The type definition of the method or instance variable specified by `to` is required.
+- `MattrAccessor`
+  - Add signatures that generated form `mattr_accessor`, `cattr_accessor`, `mattr_reader`, `cattr_reader`, `mattr_writer` and `cattr_writer`.
 
 ## Installation
 
@@ -68,16 +62,14 @@ Orthoses::Builder.new do
   use YourCustom::Middleware
   use Orthoses::ActiveModel::HasSecurePassword
   use Orthoses::ActiveRecord::BelongsTo
-  use Orthoses::ActiveRecord::GeneratedAttributeMethods
   use Orthoses::ActiveRecord::HasMany
   use Orthoses::ActiveRecord::HasOne
-  use Orthoses::ActiveSupport::Concern
   use Orthoses::ActiveSupport::ClassAttribute
   use Orthoses::ActiveSupport::MattrAccessor
-  use Orthoses::ActiveSupport::TimeWithZone
   use Orthoses::Mixin
   use Orthoses::Constant, strict: false
   use Orthoses::ObjectSpaceAll
+  use Orthoses::Autoload
   run -> () {
     Rake::Task[:environment].invoke
     Rails.application.eager_load!

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,7 +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/query_methods'
+require_relative 'active_record/scope'

data/lib/orthoses/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-26 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses
@@ -53,10 +53,13 @@ files:
 - lib/orthoses/active_model/has_secure_password.rb
 - lib/orthoses/active_record.rb
 - lib/orthoses/active_record/belongs_to.rb
+- lib/orthoses/active_record/delegated_type.rb
+- lib/orthoses/active_record/enum.rb
 - lib/orthoses/active_record/generated_attribute_methods.rb
 - lib/orthoses/active_record/has_many.rb
 - lib/orthoses/active_record/has_one.rb
 - lib/orthoses/active_record/query_methods.rb
+- lib/orthoses/active_record/scope.rb
 - lib/orthoses/active_support.rb
 - lib/orthoses/active_support/class_attribute.rb
 - lib/orthoses/active_support/configurable.rb