feat(audited): Add types for Audited::Audit and update types for Audited::Auditor::AuditedInstanceMethods (#972)

- Add types for `Audited::Audit`
- Update types for `Audited::Auditor::AuditedInstanceMethods`
  - `Audited::Auditor::AuditedInstanceMethods` requires 3 module-type-parameters, `AuditableClass`, `AuditClass` and `AuditClassRelation`
- Update type for `Audited.audit_class=`
  - `Audited.audit_class=`'s arguments accept only `String`, but `@audit_class` type is `String | AuditClass`, so I replace `attr_writer` into `_method-member_`
  - cf. https://github.com/collectiveidea/audited/blob/v5.8.0/README.md#custom-audit-model
  - cf. https://github.com/collectiveidea/audited/blob/v5.8.0/lib/audited.rb#L21-L26

Author: sanfrecce-osaka

gems/audited/5.8/_test/test.rb

@@ -11,6 +11,8 @@ class Post < ActiveRecord::Base
   belongs_to :user
 
   audited only: :title, associated_with: :user, max_audits: 10, comment_required: false
+
+  def draft? = false
 end
 
 class Comment < ActiveRecord::Base
@@ -62,4 +64,20 @@ class User < ActiveRecord::Base
 post = Post.new
 post.revisions
 post.revision(1)
+post.revisions - [Post.new]
+post.revision(1)
+post.revision(:previous)&.draft?
 post.revision_at(Date.parse('2016-01-01'))
+post.revision_at(Date.parse('2016-01-01'))&.draft?
+post.audited_attributes['published_at']
+post.own_and_associated_audits.audited_classes
+post.combine_audits(post.own_and_associated_audits)
+
+audit = Audited::Audit.new
+audit.ancestors.find(1)
+audit.undo
+audit.new_attributes['action']
+audit.old_attributes['action']
+Audited::Audit.as_user(User.new) do
+  Post.create!(title: 'Post audited as user')
+end

gems/audited/5.8/_test/test.rbs

@@ -1,17 +1,19 @@
 class Post < ActiveRecord::Base
   extend Audited::Auditor::ClassMethods
   extend Audited::Auditor::AuditedClassMethods
-  include Audited::Auditor::AuditedInstanceMethods
+  include Audited::Auditor::AuditedInstanceMethods[Post, Audited::Audit, Audited::Audit::ActiveRecord_Relation]
+
+  def draft?: () -> bool
 end
 
 class Comment < ActiveRecord::Base
   extend Audited::Auditor::ClassMethods
   extend Audited::Auditor::AuditedClassMethods
-  include Audited::Auditor::AuditedInstanceMethods
+  include Audited::Auditor::AuditedInstanceMethods[Post, Audited::Audit, Audited::Audit::ActiveRecord_Relation]
 end
 
 class User < ActiveRecord::Base
   extend Audited::Auditor::ClassMethods
   extend Audited::Auditor::AuditedClassMethods
-  include Audited::Auditor::AuditedInstanceMethods
+  include Audited::Auditor::AuditedInstanceMethods[Post, Audited::Audit, Audited::Audit::ActiveRecord_Relation]
 end

gems/audited/5.8/audited.rbs

@@ -5,7 +5,8 @@ module Audited
   attr_accessor self.ignored_default_callbacks: Array[:create | :update | :touch | :destroy]
   attr_accessor self.max_audits: Integer
   attr_accessor self.store_synthesized_enums: bool
-  attr_writer self.audit_class (@audit_class): untyped
+
+  def self.audit_class=: (String audit_class) -> void
 
   def self.audit_class: () -> untyped
 

gems/audited/5.8/audited/audit.rbs

@@ -0,0 +1,43 @@
+module Audited
+  class YAMLIfTextColumnType
+    def self.load: (untyped obj) -> untyped
+
+    def self.dump: (untyped obj) -> untyped
+
+    def self.text_column?: () -> bool
+  end
+
+  class Audit < ActiveRecord::Base
+    def ancestors: () -> ActiveRecord_Relation
+
+    def revision: () -> untyped
+
+    def new_attributes: () -> ActiveSupport::HashWithIndifferentAccess[String, untyped]
+
+    def old_attributes: () -> ActiveSupport::HashWithIndifferentAccess[String, untyped]
+
+    def undo: () -> void
+
+    private
+
+    def set_version_number: () -> void
+
+    def set_audit_user: () -> void
+
+    def set_request_uuid: () -> void
+
+    def set_remote_address: () -> void
+
+    module ClassMethods
+      def as_user: [R] (untyped user) { () -> R } -> R
+
+      def audited_classes: () -> Array[untyped]
+    end
+
+    extend ClassMethods
+
+    class ActiveRecord_Relation < ::ActiveRecord::Relation
+      include ClassMethods
+    end
+  end
+end

gems/audited/5.8/audited/auditor.rbs

@@ -36,13 +36,7 @@ module Audited
       def set_auited_options: (audited_options options) -> void
     end
 
-    module AuditedInstanceMethods
-      interface _AuditsToCombine
-        def last: () -> untyped
-        def pluck: (*untyped keys) -> Array[untyped]
-        def unscope: (*untyped args) -> untyped
-      end
-
+    module AuditedInstanceMethods[AuditableClass, AuditClass, AuditClassRelation]
       REDACTED: "[REDACTED]"
 
       def save_without_auditing: () -> bool
@@ -53,33 +47,33 @@ module Audited
 
       def with_auditing: [R] () { () -> R } -> R
 
-      def revisions: (?Integer from_version) -> Array[untyped]
+      def revisions: (?Integer from_version) -> Array[AuditableClass]
 
-      def revision: (Integer | :previous version) -> void
+      def revision: (Integer | :previous version) -> AuditableClass?
 
-      def revision_at: (ActiveSupport::TimeWithZone | Date | DateTime | Time | String date_or_time) -> void
+      def revision_at: (ActiveSupport::TimeWithZone | Date | DateTime | Time | String date_or_time) -> AuditableClass?
 
-      def audited_attributes: () -> Hash[untyped, untyped]
+      def audited_attributes: () -> Hash[String, untyped]
 
-      def own_and_associated_audits: () -> untyped
+      def own_and_associated_audits: () -> AuditClassRelation
 
-      def combine_audits: (_AuditsToCombine audits_to_combine) -> void
+      def combine_audits: (AuditClassRelation audits_to_combine) -> void
 
       private
 
       def audited_changes: (?for_touch: bool, ?exclude_readonly_attrs: bool) -> Hash[String, untyped]
 
-      def normalize_enum_changes: (Hash[untyped, untyped] changes) -> Hash[untyped, untyped]
+      def normalize_enum_changes: (Hash[String, untyped] changes) -> Hash[String, untyped]
 
-      def redact_values: (Hash[untyped, untyped] filtered_changes) -> Hash[untyped, untyped]
+      def redact_values: (Hash[String, untyped] filtered_changes) -> Hash[String, untyped]
 
-      def filter_encrypted_attrs: (Hash[untyped, untyped] filtered_changes) -> Hash[untyped, untyped]
+      def filter_encrypted_attrs: (Hash[String, untyped] filtered_changes) -> Hash[String, untyped]
 
-      def filter_attr_values: (?audited_changes: Hash[untyped, untyped], ?attrs: Array[untyped], ?placeholder: String) -> Hash[untyped, untyped]
+      def filter_attr_values: (?audited_changes: Hash[String, untyped], ?attrs: Array[String], ?placeholder: String) -> Hash[String, untyped]
 
       def rails_below?: (String rails_version) -> bool
 
-      def audits_to: (?(Integer | :previous)? version) -> untyped
+      def audits_to: (?(Integer | :previous)? version) -> AuditClassRelation
 
       def audit_create: () -> void
 
@@ -103,9 +97,9 @@ module Audited
 
       def auditing_enabled: () -> bool
 
-      def run_conditional_check: (untyped condition, ?matching: bool) -> bool
+      def run_conditional_check: (bool | String | Symbol | _Callable condition, ?matching: bool) -> bool
 
-      def reconstruct_attributes: (Array[untyped] audits) -> Hash[untyped, untyped]
+      def reconstruct_attributes: (AuditClassRelation | Array[AuditClass] audits) -> Hash[String, untyped]
     end
 
     module AuditedClassMethods