tapioca 0.4.0 → 0.4.5

data/lib/tapioca/compilers/dsl/active_record_columns.rb

@@ -0,0 +1,404 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "parlour"
+
+begin
+  require "active_record"
+rescue LoadError
+  return
+end
+
+module Tapioca
+  module Compilers
+    module Dsl
+      # `Tapioca::Compilers::Dsl::ActiveRecordColumns` refines RBI files for subclasses of `ActiveRecord::Base`
+      # (see https://api.rubyonrails.org/classes/ActiveRecord/Base.html). This generator is only
+      # responsible for defining the attribute methods that would be created for the columns that
+      # are defined in the Active Record model.
+      #
+      # **Note:** This generator, by default, generates weak signatures for column methods and treats each
+      # column to be `T.untyped`. This is done on purpose to ensure that the nilability of Active Record
+      # columns do not make it hard for existing code to adopt gradual typing. It is possible, however, to
+      # generate stricter type signatures for your ActiveRecord column types. If your ActiveRecord model extends
+      # a module with name `StrongTypeGeneration`, this generator will generate stricter signatures that follow
+      # closely with the types defined in the schema.
+      #
+      # The `StrongTypeGeneration` module you define in your application should add an `after_initialize` callback
+      # to the model and ensure that all the non-nilable attributes of the model are actually initialized with non-`nil`
+      # values.
+      #
+      # For example, with the following model class:
+      #
+      # ~~~rb
+      # class Post < ActiveRecord::Base
+      # end
+      # ~~~
+      #
+      # and the following database schema:
+      #
+      # ~~~rb
+      # # db/schema.rb
+      # create_table :posts do |t|
+      #   t.string :title, null: false
+      #   t.string :body
+      #   t.boolean :published
+      #   t.timestamps
+      # end
+      # ~~~
+      #
+      # this generator will produce the following methods in the RBI file
+      # `post.rbi`:
+      #
+      # ~~~rbi
+      # # post.rbi
+      # # typed: true
+      # class Post
+      #   sig { returns(T.nilable(::String)) }
+      #   def body; end
+      #
+      #   sig { params(value: T.nilable(::String)).returns(T.nilable(::String)) }
+      #   def body=; end
+      #
+      #   sig { params(args: T.untyped).returns(T::Boolean) }
+      #   def body?; end
+      #
+      #   sig { returns(T.nilable(::ActiveSupport::TimeWithZone)) }
+      #   def created_at; end
+      #
+      #   sig { params(value: ::ActiveSupport::TimeWithZone).returns(::ActiveSupport::TimeWithZone) }
+      #   def created_at=; end
+      #
+      #   sig { params(args: T.untyped).returns(T::Boolean) }
+      #   def created_at?; end
+      #
+      #   sig { returns(T.nilable(T::Boolean)) }
+      #   def published; end
+      #
+      #   sig { params(value: T::Boolean).returns(T::Boolean) }
+      #   def published=; end
+      #
+      #   sig { params(args: T.untyped).returns(T::Boolean) }
+      #   def published?; end
+      #
+      #   sig { returns(::String) }
+      #   def title; end
+      #
+      #   sig { params(value: ::String).returns(::String) }
+      #   def title=(value); end
+      #
+      #   sig { params(args: T.untyped).returns(T::Boolean) }
+      #   def title?(*args); end
+      #
+      #   sig { returns(T.nilable(::ActiveSupport::TimeWithZone)) }
+      #   def updated_at; end
+      #
+      #   sig { params(value: ::ActiveSupport::TimeWithZone).returns(::ActiveSupport::TimeWithZone) }
+      #   def updated_at=; end
+      #
+      #   sig { params(args: T.untyped).returns(T::Boolean) }
+      #   def updated_at?; end
+      #
+      #   ## Also the methods added by https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Dirty.html
+      #   ## Also the methods added by https://api.rubyonrails.org/classes/ActiveModel/Dirty.html
+      #   ## Also the methods added by https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/BeforeTypeCast.html
+      # end
+      # ~~~
+      class ActiveRecordColumns < Base
+        extend T::Sig
+
+        sig { override.params(root: Parlour::RbiGenerator::Namespace, constant: T.class_of(ActiveRecord::Base)).void }
+        def decorate(root, constant)
+          return unless constant.table_exists?
+
+          module_name = "#{constant}::GeneratedAttributeMethods"
+          root.create_module(module_name) do |mod|
+            constant.columns_hash.each_key do |column_name|
+              column_name = column_name.to_s
+              add_methods_for_attribute(mod, constant, column_name)
+            end
+
+            constant.attribute_aliases.each do |attribute_name, column_name|
+              attribute_name = attribute_name.to_s
+              column_name = column_name.to_s
+              new_method_names = constant.attribute_method_matchers.map { |m| m.method_name(attribute_name) }
+              old_method_names = constant.attribute_method_matchers.map { |m| m.method_name(column_name) }
+              methods_to_add = new_method_names - old_method_names
+
+              add_methods_for_attribute(mod, constant, column_name, attribute_name, methods_to_add)
+            end
+          end
+
+          root.path(constant) do |klass|
+            klass.create_include(module_name)
+          end
+        end
+
+        sig { override.returns(T::Enumerable[Module]) }
+        def gather_constants
+          ActiveRecord::Base.descendants.reject(&:abstract_class?)
+        end
+
+        private
+
+        sig do
+          params(
+            klass: Parlour::RbiGenerator::Namespace,
+            name: String,
+            methods_to_add: T.nilable(T::Array[String]),
+            return_type: T.nilable(String),
+            parameters: T::Array[[String, String]]
+          ).void
+        end
+        def add_method(klass, name, methods_to_add, return_type: nil, parameters: [])
+          create_method(
+            klass,
+            name,
+            parameters: parameters.map do |param, type|
+              Parlour::RbiGenerator::Parameter.new(param, type: type)
+            end,
+            return_type: return_type
+          ) if methods_to_add.nil? || methods_to_add.include?(name)
+        end
+
+        sig do
+          params(
+            klass: Parlour::RbiGenerator::Namespace,
+            constant: T.class_of(ActiveRecord::Base),
+            column_name: String,
+            attribute_name: String,
+            methods_to_add: T.nilable(T::Array[String])
+          ).void
+        end
+        def add_methods_for_attribute(klass, constant, column_name, attribute_name = column_name, methods_to_add = nil)
+          getter_type, setter_type = type_for(constant, column_name)
+
+          # Added by ActiveRecord::AttributeMethods::Read
+          #
+          add_method(
+            klass,
+            attribute_name.to_s,
+            methods_to_add,
+            return_type: getter_type
+          )
+
+          # Added by ActiveRecord::AttributeMethods::Write
+          #
+          add_method(
+            klass,
+            "#{attribute_name}=",
+            methods_to_add,
+            parameters: [["value", setter_type]],
+            return_type: setter_type
+          )
+
+          # Added by ActiveRecord::AttributeMethods::Query
+          #
+          add_method(
+            klass,
+            "#{attribute_name}?",
+            methods_to_add,
+            return_type: "T::Boolean"
+          )
+
+          # Added by ActiveRecord::AttributeMethods::Dirty
+          #
+          add_method(
+            klass,
+            "#{attribute_name}_before_last_save",
+            methods_to_add,
+            return_type: as_nilable_type(getter_type)
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_change_to_be_saved",
+            methods_to_add,
+            return_type: "T.nilable([#{getter_type}, #{getter_type}])"
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_in_database",
+            methods_to_add,
+            return_type: as_nilable_type(getter_type)
+          )
+          add_method(
+            klass,
+            "saved_change_to_#{attribute_name}",
+            methods_to_add,
+            return_type: "T.nilable([#{getter_type}, #{getter_type}])"
+          )
+          add_method(
+            klass,
+            "saved_change_to_#{attribute_name}?",
+            methods_to_add,
+            return_type: "T::Boolean"
+          )
+          add_method(
+            klass,
+            "will_save_change_to_#{attribute_name}?",
+            methods_to_add,
+            return_type: "T::Boolean"
+          )
+
+          # Added by ActiveModel::Dirty
+          #
+          add_method(
+            klass,
+            "#{attribute_name}_change",
+            methods_to_add,
+            return_type: "T.nilable([#{getter_type}, #{getter_type}])"
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_changed?",
+            methods_to_add,
+            return_type: "T::Boolean"
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_will_change!",
+            methods_to_add
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_was",
+            methods_to_add,
+            return_type: as_nilable_type(getter_type)
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_previous_change",
+            methods_to_add,
+            return_type: "T.nilable([#{getter_type}, #{getter_type}])"
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_previously_changed?",
+            methods_to_add,
+            return_type: "T::Boolean"
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_previously_was",
+            methods_to_add,
+            return_type: as_nilable_type(getter_type)
+          )
+          add_method(
+            klass,
+            "restore_#{attribute_name}!",
+            methods_to_add
+          )
+
+          # Added by ActiveRecord::AttributeMethods::BeforeTypeCast
+          #
+          add_method(
+            klass,
+            "#{attribute_name}_before_type_cast",
+            methods_to_add,
+            return_type: "T.untyped"
+          )
+          add_method(
+            klass,
+            "#{attribute_name}_came_from_user?",
+            methods_to_add,
+            return_type: "T::Boolean"
+          )
+        end
+
+        sig do
+          params(
+            constant: T.class_of(ActiveRecord::Base),
+            column_name: String
+          ).returns([String, String])
+        end
+        def type_for(constant, column_name)
+          return ["T.untyped", "T.untyped"] if do_not_generate_strong_types?(constant)
+
+          column_type = constant.attribute_types[column_name]
+
+          getter_type =
+            case column_type
+            when ActiveRecord::Type::Integer
+              "::Integer"
+            when ActiveRecord::Type::String
+              "::String"
+            when ActiveRecord::Type::Date
+              "::Date"
+            when ActiveRecord::Type::Decimal
+              "::BigDecimal"
+            when ActiveRecord::Type::Float
+              "::Float"
+            when ActiveRecord::Type::Boolean
+              "T::Boolean"
+            when ActiveRecord::Type::DateTime, ActiveRecord::Type::Time
+              "::DateTime"
+            when ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter
+              "::ActiveSupport::TimeWithZone"
+            else
+              handle_unknown_type(column_type)
+            end
+
+          column = constant.columns_hash[column_name]
+          setter_type = getter_type
+
+          if column&.null
+            return ["T.nilable(#{getter_type})", "T.nilable(#{setter_type})"]
+          end
+
+          if column_name == constant.primary_key ||
+              column_name == "created_at" ||
+              column_name == "updated_at"
+            getter_type = "T.nilable(#{getter_type})"
+          end
+
+          [getter_type, setter_type]
+        end
+
+        sig { params(constant: Module).returns(T::Boolean) }
+        def do_not_generate_strong_types?(constant)
+          Object.const_defined?(:StrongTypeGeneration) &&
+              !(constant.singleton_class < Object.const_get(:StrongTypeGeneration))
+        end
+
+        sig { params(column_type: Object).returns(String) }
+        def handle_unknown_type(column_type)
+          return "T.untyped" unless ActiveModel::Type::Value === column_type
+
+          lookup_return_type_of_method(column_type, :deserialize) ||
+            lookup_return_type_of_method(column_type, :cast) ||
+            lookup_arg_type_of_method(column_type, :serialize) ||
+            "T.untyped"
+        end
+
+        sig { params(column_type: ActiveModel::Type::Value, method: Symbol).returns(T.nilable(String)) }
+        def lookup_return_type_of_method(column_type, method)
+          signature = T::Private::Methods.signature_for_method(column_type.method(method))
+          return unless signature
+
+          return_type = signature.return_type
+          return if T::Types::Simple === return_type && T::Generic === return_type.raw_type
+          return if return_type == T::Private::Types::Void || return_type == T::Private::Types::NotTyped
+
+          return_type.to_s
+        end
+
+        sig { params(column_type: ActiveModel::Type::Value, method: Symbol).returns(T.nilable(String)) }
+        def lookup_arg_type_of_method(column_type, method)
+          signature = T::Private::Methods.signature_for_method(column_type.method(method))
+          return unless signature
+
+          arg_type = signature.arg_types.first.last
+          return if T::Types::Simple === arg_type && T::Generic === arg_type.raw_type
+
+          arg_type.to_s
+        end
+
+        sig { params(type: String).returns(String) }
+        def as_nilable_type(type)
+          return type if type.start_with?("T.nilable(")
+          "T.nilable(#{type})"
+        end
+      end
+    end
+  end
+end

data/lib/tapioca/compilers/dsl/active_record_enum.rb

@@ -0,0 +1,112 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "parlour"
+
+begin
+  require "active_record"
+rescue LoadError
+  # means ActiveRecord is not installed,
+  # so let's not even define the generator.
+  return
+end
+
+module Tapioca
+  module Compilers
+    module Dsl
+      # `Tapioca::Compilers::Dsl::ActiveRecordEnum` decorates RBI files for subclasses of
+      # `ActiveRecord::Base` which declare `enum` fields
+      # (see https://api.rubyonrails.org/classes/ActiveRecord/Enum.html).
+      #
+      # For example, with the following `ActiveRecord::Base` subclass:
+      #
+      # ~~~rb
+      # class Post < ApplicationRecord
+      #   enum title_type: %i(book all web), _suffix: :title
+      # end
+      # ~~~
+      #
+      # this generator will produce the RBI file `post.rbi` with the following content:
+      #
+      # ~~~rbi
+      # # post.rbi
+      # # typed: true
+      # class Post
+      #   sig { void }
+      #   def all_title!; end
+      #
+      #   sig { returns(T::Boolean) }
+      #   def all_title?; end
+      #
+      #   sig { returns(T::Hash[T.any(String, Symbol), Integer]) }
+      #   def self.title_types; end
+      #
+      #   sig { void }
+      #   def book_title!; end
+      #
+      #   sig { returns(T::Boolean) }
+      #   def book_title?; end
+      #
+      #   sig { void }
+      #   def web_title!; end
+      #
+      #   sig { returns(T::Boolean) }
+      #   def web_title?; end
+      # end
+      # ~~~
+      class ActiveRecordEnum < Base
+        extend T::Sig
+
+        sig { override.params(root: Parlour::RbiGenerator::Namespace, constant: T.class_of(::ActiveRecord::Base)).void }
+        def decorate(root, constant)
+          return if constant.defined_enums.empty?
+
+          module_name = "#{constant}::EnumMethodsModule"
+          root.create_module(module_name) do |mod|
+            generate_instance_methods(constant, mod)
+          end
+
+          root.path(constant) do |k|
+            k.create_include(module_name)
+
+            constant.defined_enums.each do |name, enum_map|
+              type = type_for_enum(enum_map)
+              create_method(k, name.pluralize, class_method: true, return_type: type)
+            end
+          end
+        end
+
+        sig { override.returns(T::Enumerable[Module]) }
+        def gather_constants
+          ::ActiveRecord::Base.descendants.reject(&:abstract_class?)
+        end
+
+        private
+
+        sig { params(enum_map: T::Hash[T.untyped, T.untyped]).returns(String) }
+        def type_for_enum(enum_map)
+          value_type = enum_map.values.map { |v| v.class.name }.uniq
+          value_type = if value_type.length == 1
+            value_type.first
+          else
+            "T.any(#{value_type.join(', ')})"
+          end
+
+          "T::Hash[T.any(String, Symbol), #{value_type}]"
+        end
+
+        sig { params(constant: T.class_of(::ActiveRecord::Base), klass: Parlour::RbiGenerator::Namespace).void }
+        def generate_instance_methods(constant, klass)
+          methods = constant.send(:_enum_methods_module).instance_methods
+
+          methods.each do |method|
+            method = method.to_s
+            return_type = "T::Boolean" if method.end_with?("?")
+
+            create_method(klass, method, return_type: return_type)
+          end
+        end
+      end
+    end
+  end
+end