Skip to content

Commit

Permalink
Merge pull request #1955 from cheshire137/dirty-relation-sig
Browse files Browse the repository at this point in the history 
Generate *_changed? and *_previously_changed? sigs for belongs_to relations
  • Loading branch information
@paracycle
paracycle authored Jul 16, 2024
2 parents f6028d6 + 588af36 commit 429f1fb
Show file tree
Hide file tree
Showing 2 changed files with 119 additions and 10 deletions.
13 changes: 13 additions & 0 deletions lib/tapioca/dsl/compilers/active_record_associations.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ def populate_associations(mod)
def populate_single_assoc_getter_setter(klass, association_name, reflection)
association_class = type_for(reflection)
association_type = as_nilable_type(association_class)
association_methods_module = constant.generated_association_methods

klass.create_method(
association_name.to_s,
Expand All @@ -206,6 +207,18 @@ def populate_single_assoc_getter_setter(klass, association_name, reflection)
"reset_#{association_name}",
return_type: "void",
)
if association_methods_module.method_defined?("#{association_name}_changed?")
klass.create_method(
"#{association_name}_changed?",
return_type: "T::Boolean",
)
end
if association_methods_module.method_defined?("#{association_name}_previously_changed?")
klass.create_method(
"#{association_name}_previously_changed?",
return_type: "T::Boolean",
)
end
unless reflection.polymorphic?
klass.create_method(
"build_#{association_name}",
Expand Down
116 changes: 106 additions & 10 deletions spec/tapioca/dsl/compilers/active_record_associations_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ class Post < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Post
Expand All @@ -123,6 +123,14 @@ def author=(value); end
sig { params(attributes: T.untyped).returns(T.untyped) }
def author_attributes=(attributes); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def author_changed?; end
sig { returns(T::Boolean) }
def author_previously_changed?; end
<% end %>
sig { params(args: T.untyped, blk: T.untyped).returns(::User) }
def build_author(*args, &blk); end
Expand All @@ -138,6 +146,14 @@ def category=(value); end
sig { params(attributes: T.untyped).returns(T.untyped) }
def category_attributes=(attributes); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def category_changed?; end
sig { returns(T::Boolean) }
def category_previously_changed?; end
<% end %>
sig { params(args: T.untyped, blk: T.untyped).returns(::User) }
def create_author(*args, &blk); end
Expand Down Expand Up @@ -183,7 +199,7 @@ class Post < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Post
Expand All @@ -198,6 +214,14 @@ def category=(value); end
sig { params(attributes: T.untyped).returns(T.untyped) }
def category_attributes=(attributes); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def category_changed?; end
sig { returns(T::Boolean) }
def category_previously_changed?; end
<% end %>
sig { returns(T.untyped) }
def reload_category; end
Expand Down Expand Up @@ -545,7 +569,7 @@ class Comment < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Blog::Core::Post
Expand All @@ -557,6 +581,14 @@ def author; end
sig { params(value: T.nilable(::Blog::Author)).void }
def author=(value); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def author_changed?; end
sig { returns(T::Boolean) }
def author_previously_changed?; end
<% end %>
sig { params(args: T.untyped, blk: T.untyped).returns(::Blog::Author) }
def build_author(*args, &blk); end
Expand Down Expand Up @@ -618,7 +650,7 @@ def drafts=(value); end

assert_equal(expected, rbi_for("Blog::Author"))

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Comment
Expand All @@ -639,6 +671,14 @@ def post; end
sig { params(value: T.nilable(::Blog::Core::Post)).void }
def post=(value); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def post_changed?; end
sig { returns(T::Boolean) }
def post_previously_changed?; end
<% end %>
sig { returns(T.nilable(::Blog::Core::Post)) }
def reload_post; end
Expand Down Expand Up @@ -744,7 +784,7 @@ class Post < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Post
Expand All @@ -771,6 +811,14 @@ def shop; end
sig { params(value: T.nilable(::Shop)).void }
def shop=(value); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def shop_changed?; end
sig { returns(T::Boolean) }
def shop_previously_changed?; end
<% end %>
end
end
RBI
Expand Down Expand Up @@ -831,7 +879,7 @@ class Post < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Post
Expand All @@ -846,6 +894,14 @@ def author=(value); end
sig { params(attributes: T.untyped).returns(T.untyped) }
def author_attributes=(attributes); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def author_changed?; end
sig { returns(T::Boolean) }
def author_previously_changed?; end
<% end %>
sig { params(args: T.untyped, blk: T.untyped).returns(::User) }
def build_author(*args, &blk); end
Expand All @@ -861,6 +917,14 @@ def category=(value); end
sig { params(attributes: T.untyped).returns(T.untyped) }
def category_attributes=(attributes); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def category_changed?; end
sig { returns(T::Boolean) }
def category_previously_changed?; end
<% end %>
sig { params(args: T.untyped, blk: T.untyped).returns(::User) }
def create_author(*args, &blk); end
Expand Down Expand Up @@ -906,7 +970,7 @@ class Post < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Post
Expand All @@ -921,6 +985,14 @@ def category=(value); end
sig { params(attributes: T.untyped).returns(T.untyped) }
def category_attributes=(attributes); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def category_changed?; end
sig { returns(T::Boolean) }
def category_previously_changed?; end
<% end %>
sig { returns(T.untyped) }
def reload_category; end
Expand Down Expand Up @@ -1268,7 +1340,7 @@ class Comment < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Blog::Core::Post
Expand All @@ -1280,6 +1352,14 @@ def author; end
sig { params(value: T.nilable(::Blog::Author)).void }
def author=(value); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def author_changed?; end
sig { returns(T::Boolean) }
def author_previously_changed?; end
<% end %>
sig { params(args: T.untyped, blk: T.untyped).returns(::Blog::Author) }
def build_author(*args, &blk); end
Expand Down Expand Up @@ -1341,7 +1421,7 @@ def drafts=(value); end

assert_equal(expected, rbi_for("Blog::Author"))

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Comment
Expand All @@ -1362,6 +1442,14 @@ def post; end
sig { params(value: T.nilable(::Blog::Core::Post)).void }
def post=(value); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def post_changed?; end
sig { returns(T::Boolean) }
def post_previously_changed?; end
<% end %>
sig { returns(T.nilable(::Blog::Core::Post)) }
def reload_post; end
Expand Down Expand Up @@ -1467,7 +1555,7 @@ class Post < ActiveRecord::Base
end
RUBY

expected = <<~RBI
expected = template(<<~RBI)
# typed: strong
class Post
Expand All @@ -1494,6 +1582,14 @@ def shop; end
sig { params(value: T.nilable(::Shop)).void }
def shop=(value); end
<% if rails_version(">= 7.0") %>
sig { returns(T::Boolean) }
def shop_changed?; end
sig { returns(T::Boolean) }
def shop_previously_changed?; end
<% end %>
end
end
RBI
Expand Down

0 comments on commit 429f1fb

Please sign in to comment.