Merge pull request #678 from Shopify/uk-fix-smart-properties

Refactor how `SmartProperties` methods are generated

Author: paracycle

lib/tapioca/compilers/dsl/smart_properties.rb

@@ -71,14 +71,15 @@ def decorate(root, constant)
           )
           return if properties.keys.empty?
 
-          instance_methods = constant.instance_methods(false).map(&:to_s).to_set
-
           root.create_path(constant) do |k|
-            properties.values.each do |property|
-              generate_methods_for_property(k, property) do |method_name|
-                !instance_methods.include?(method_name)
+            smart_properties_methods_name = "SmartPropertiesGeneratedMethods"
+            k.create_module(smart_properties_methods_name) do |mod|
+              properties.values.each do |property|
+                generate_methods_for_property(mod, property)
               end
             end
+
+            k.create_include(smart_properties_methods_name)
           end
         end
 
@@ -95,26 +96,21 @@ def gather_constants
 
         sig do
           params(
-            klass: RBI::Scope,
-            property: ::SmartProperties::Property,
-            block: T.proc.params(arg: String).returns(T::Boolean)
+            mod: RBI::Scope,
+            property: ::SmartProperties::Property
           ).void
         end
-        def generate_methods_for_property(klass, property, &block)
+        def generate_methods_for_property(mod, property)
           type = type_for(property)
 
           if property.writable?
             name = property.name.to_s
             method_name = "#{name}="
 
-            klass.create_method(
-              method_name,
-              parameters: [create_param(name, type: type)],
-              return_type: type
-            ) if block.call(method_name)
+            mod.create_method(method_name, parameters: [create_param(name, type: type)], return_type: type)
           end
 
-          klass.create_method(property.reader.to_s, return_type: type) if block.call(property.reader.to_s)
+          mod.create_method(property.reader.to_s, return_type: type)
         end
 
         BOOLEANS = T.let([

spec/tapioca/cli/dsl_spec.rb

@@ -101,11 +101,15 @@ class Post
             # Please instead update this file by running `bin/tapioca dsl Post`.
 
             class Post
-              sig { returns(T.nilable(::String)) }
-              def title; end
+              include SmartPropertiesGeneratedMethods
 
-              sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
-              def title=(title); end
+              module SmartPropertiesGeneratedMethods
+                sig { returns(T.nilable(::String)) }
+                def title; end
+
+                sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
+                def title=(title); end
+              end
             end
           RBI
 
@@ -206,11 +210,15 @@ class Comment
             # Please instead update this file by running `bin/tapioca dsl Post`.
 
             class Post
-              sig { returns(T.nilable(::String)) }
-              def title; end
+              include SmartPropertiesGeneratedMethods
 
-              sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
-              def title=(title); end
+              module SmartPropertiesGeneratedMethods
+                sig { returns(T.nilable(::String)) }
+                def title; end
+
+                sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
+                def title=(title); end
+              end
             end
           RBI
 
@@ -222,11 +230,15 @@ def title=(title); end
             # Please instead update this file by running `bin/tapioca dsl Namespace::Comment`.
 
             class Namespace::Comment
-              sig { returns(::String) }
-              def body; end
+              include SmartPropertiesGeneratedMethods
 
-              sig { params(body: ::String).returns(::String) }
-              def body=(body); end
+              module SmartPropertiesGeneratedMethods
+                sig { returns(::String) }
+                def body; end
+
+                sig { params(body: ::String).returns(::String) }
+                def body=(body); end
+              end
             end
           RBI
 
@@ -277,11 +289,15 @@ class Role
             # Please instead update this file by running `bin/tapioca dsl Foo::Role`.
 
             class Foo::Role
-              sig { returns(T.nilable(::String)) }
-              def title; end
+              include SmartPropertiesGeneratedMethods
 
-              sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
-              def title=(title); end
+              module SmartPropertiesGeneratedMethods
+                sig { returns(T.nilable(::String)) }
+                def title; end
+
+                sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
+                def title=(title); end
+              end
             end
           RBI
 
@@ -428,11 +444,15 @@ class Post
             # typed: true
 
             class Post
-              sig { returns(T.nilable(::String)) }
-              def title; end
+              include SmartPropertiesGeneratedMethods
 
-              sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
-              def title=(title); end
+              module SmartPropertiesGeneratedMethods
+                sig { returns(T.nilable(::String)) }
+                def title; end
+
+                sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
+                def title=(title); end
+              end
             end
           RBI
         end
@@ -663,15 +683,18 @@ def gather_constants
             class Post
               include GeneratedBar
               include GeneratedFoo
-
-              sig { returns(T.nilable(::String)) }
-              def title; end
-
-              sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
-              def title=(title); end
+              include SmartPropertiesGeneratedMethods
 
               module GeneratedBar; end
               module GeneratedFoo; end
+
+              module SmartPropertiesGeneratedMethods
+                sig { returns(T.nilable(::String)) }
+                def title; end
+
+                sig { params(title: T.nilable(::String)).returns(T.nilable(::String)) }
+                def title=(title); end
+              end
             end
           RBI