Merge pull request #2636 from ruby/inline--module-class-alias

Add module-class alias declaration

Author: soutaro

config.yml

@@ -511,3 +511,23 @@ nodes:
         c_type: rbs_node
       - name: comment_location
         c_type: rbs_location
+  - name: RBS::AST::Ruby::Annotations::ClassAliasAnnotation
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: keyword_location
+        c_type: rbs_location
+      - name: type_name
+        c_type: rbs_type_name
+      - name: type_name_location
+        c_type: rbs_location
+  - name: RBS::AST::Ruby::Annotations::ModuleAliasAnnotation
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: keyword_location
+        c_type: rbs_location
+      - name: type_name
+        c_type: rbs_type_name
+      - name: type_name_location
+        c_type: rbs_location

docs/inline.md

@@ -449,6 +449,22 @@ MAX_RETRIES = 3
 CONFIG = load_config() #: Hash[String, untyped]
 ```
 
-### Current Limitations
+## Class/module Aliases
+
+Class and module aliases can be defined by assigning existing classes or modules to constants using the `#: class-alias` or `#: module-alias` syntax.
+
+```ruby
+MyObject = Object #: class-alias
+
+MyKernel = Kernel #: module-alias
+```
 
-- Module/class aliases are not supported
+This creates new type names that refer to the same class or module as the original.
+
+The annotations can have optional type name to specify the class/module name, for the case it cannot be infered through the right-hand-side of the constant declaration.
+
+```ruby
+MyObject = object #: class-alias Object
+
+MyKernel = kernel #: module-alias Kernel
+```

ext/rbs_extension/ast_translation.c

@@ -573,6 +573,22 @@ VALUE rbs_struct_to_ruby_value(rbs_translation_context_t ctx, rbs_node_t *instan
             &h
         );
     }
+    case RBS_AST_RUBY_ANNOTATIONS_CLASS_ALIAS_ANNOTATION: {
+        rbs_ast_ruby_annotations_class_alias_annotation_t *node = (rbs_ast_ruby_annotations_class_alias_annotation_t *) instance;
+
+        VALUE h = rb_hash_new();
+        rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_loc_to_ruby_location(ctx, node->base.location));
+        rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_loc_to_ruby_location(ctx, node->prefix_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("keyword_location")), rbs_loc_to_ruby_location(ctx, node->keyword_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("type_name")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->type_name)); // rbs_type_name
+        rb_hash_aset(h, ID2SYM(rb_intern("type_name_location")), rbs_loc_to_ruby_location(ctx, node->type_name_location));
+
+        return CLASS_NEW_INSTANCE(
+            RBS_AST_Ruby_Annotations_ClassAliasAnnotation,
+            1,
+            &h
+        );
+    }
     case RBS_AST_RUBY_ANNOTATIONS_COLON_METHOD_TYPE_ANNOTATION: {
         rbs_ast_ruby_annotations_colon_method_type_annotation_t *node = (rbs_ast_ruby_annotations_colon_method_type_annotation_t *) instance;
 
@@ -621,6 +637,22 @@ VALUE rbs_struct_to_ruby_value(rbs_translation_context_t ctx, rbs_node_t *instan
             &h
         );
     }
+    case RBS_AST_RUBY_ANNOTATIONS_MODULE_ALIAS_ANNOTATION: {
+        rbs_ast_ruby_annotations_module_alias_annotation_t *node = (rbs_ast_ruby_annotations_module_alias_annotation_t *) instance;
+
+        VALUE h = rb_hash_new();
+        rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_loc_to_ruby_location(ctx, node->base.location));
+        rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_loc_to_ruby_location(ctx, node->prefix_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("keyword_location")), rbs_loc_to_ruby_location(ctx, node->keyword_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("type_name")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->type_name)); // rbs_type_name
+        rb_hash_aset(h, ID2SYM(rb_intern("type_name_location")), rbs_loc_to_ruby_location(ctx, node->type_name_location));
+
+        return CLASS_NEW_INSTANCE(
+            RBS_AST_Ruby_Annotations_ModuleAliasAnnotation,
+            1,
+            &h
+        );
+    }
     case RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION: {
         rbs_ast_ruby_annotations_node_type_assertion_t *node = (rbs_ast_ruby_annotations_node_type_assertion_t *) instance;
 

ext/rbs_extension/class_constants.c

@@ -49,9 +49,11 @@ VALUE RBS_AST_Members_MethodDefinition_Overload;
 VALUE RBS_AST_Members_Prepend;
 VALUE RBS_AST_Members_Private;
 VALUE RBS_AST_Members_Public;
+VALUE RBS_AST_Ruby_Annotations_ClassAliasAnnotation;
 VALUE RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation;
 VALUE RBS_AST_Ruby_Annotations_InstanceVariableAnnotation;
 VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
+VALUE RBS_AST_Ruby_Annotations_ModuleAliasAnnotation;
 VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
 VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;
 VALUE RBS_AST_Ruby_Annotations_SkipAnnotation;
@@ -136,9 +138,11 @@ void rbs__init_constants(void) {
     IMPORT_CONSTANT(RBS_AST_Members_Prepend, RBS_AST_Members, "Prepend");
     IMPORT_CONSTANT(RBS_AST_Members_Private, RBS_AST_Members, "Private");
     IMPORT_CONSTANT(RBS_AST_Members_Public, RBS_AST_Members, "Public");
+    IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ClassAliasAnnotation, RBS_AST_Ruby_Annotations, "ClassAliasAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation, RBS_AST_Ruby_Annotations, "ColonMethodTypeAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_InstanceVariableAnnotation, RBS_AST_Ruby_Annotations, "InstanceVariableAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_MethodTypesAnnotation, RBS_AST_Ruby_Annotations, "MethodTypesAnnotation");
+    IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ModuleAliasAnnotation, RBS_AST_Ruby_Annotations, "ModuleAliasAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_NodeTypeAssertion, RBS_AST_Ruby_Annotations, "NodeTypeAssertion");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ReturnTypeAnnotation, RBS_AST_Ruby_Annotations, "ReturnTypeAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_SkipAnnotation, RBS_AST_Ruby_Annotations, "SkipAnnotation");

ext/rbs_extension/class_constants.h

@@ -55,9 +55,11 @@ extern VALUE RBS_AST_Members_MethodDefinition_Overload;
 extern VALUE RBS_AST_Members_Prepend;
 extern VALUE RBS_AST_Members_Private;
 extern VALUE RBS_AST_Members_Public;
+extern VALUE RBS_AST_Ruby_Annotations_ClassAliasAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_InstanceVariableAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
+extern VALUE RBS_AST_Ruby_Annotations_ModuleAliasAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
 extern VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_SkipAnnotation;

include/rbs/ast.h

@@ -45,45 +45,47 @@ enum rbs_node_type {
     RBS_AST_MEMBERS_PREPEND = 29,
     RBS_AST_MEMBERS_PRIVATE = 30,
     RBS_AST_MEMBERS_PUBLIC = 31,
-    RBS_AST_RUBY_ANNOTATIONS_COLON_METHOD_TYPE_ANNOTATION = 32,
-    RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION = 33,
-    RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION = 34,
-    RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION = 35,
-    RBS_AST_RUBY_ANNOTATIONS_RETURN_TYPE_ANNOTATION = 36,
-    RBS_AST_RUBY_ANNOTATIONS_SKIP_ANNOTATION = 37,
-    RBS_AST_RUBY_ANNOTATIONS_TYPE_APPLICATION_ANNOTATION = 38,
-    RBS_AST_STRING = 39,
-    RBS_AST_TYPE_PARAM = 40,
-    RBS_METHOD_TYPE = 41,
-    RBS_NAMESPACE = 42,
-    RBS_SIGNATURE = 43,
-    RBS_TYPE_NAME = 44,
-    RBS_TYPES_ALIAS = 45,
-    RBS_TYPES_BASES_ANY = 46,
-    RBS_TYPES_BASES_BOOL = 47,
-    RBS_TYPES_BASES_BOTTOM = 48,
-    RBS_TYPES_BASES_CLASS = 49,
-    RBS_TYPES_BASES_INSTANCE = 50,
-    RBS_TYPES_BASES_NIL = 51,
-    RBS_TYPES_BASES_SELF = 52,
-    RBS_TYPES_BASES_TOP = 53,
-    RBS_TYPES_BASES_VOID = 54,
-    RBS_TYPES_BLOCK = 55,
-    RBS_TYPES_CLASS_INSTANCE = 56,
-    RBS_TYPES_CLASS_SINGLETON = 57,
-    RBS_TYPES_FUNCTION = 58,
-    RBS_TYPES_FUNCTION_PARAM = 59,
-    RBS_TYPES_INTERFACE = 60,
-    RBS_TYPES_INTERSECTION = 61,
-    RBS_TYPES_LITERAL = 62,
-    RBS_TYPES_OPTIONAL = 63,
-    RBS_TYPES_PROC = 64,
-    RBS_TYPES_RECORD = 65,
-    RBS_TYPES_RECORD_FIELD_TYPE = 66,
-    RBS_TYPES_TUPLE = 67,
-    RBS_TYPES_UNION = 68,
-    RBS_TYPES_UNTYPED_FUNCTION = 69,
-    RBS_TYPES_VARIABLE = 70,
+    RBS_AST_RUBY_ANNOTATIONS_CLASS_ALIAS_ANNOTATION = 32,
+    RBS_AST_RUBY_ANNOTATIONS_COLON_METHOD_TYPE_ANNOTATION = 33,
+    RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION = 34,
+    RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION = 35,
+    RBS_AST_RUBY_ANNOTATIONS_MODULE_ALIAS_ANNOTATION = 36,
+    RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION = 37,
+    RBS_AST_RUBY_ANNOTATIONS_RETURN_TYPE_ANNOTATION = 38,
+    RBS_AST_RUBY_ANNOTATIONS_SKIP_ANNOTATION = 39,
+    RBS_AST_RUBY_ANNOTATIONS_TYPE_APPLICATION_ANNOTATION = 40,
+    RBS_AST_STRING = 41,
+    RBS_AST_TYPE_PARAM = 42,
+    RBS_METHOD_TYPE = 43,
+    RBS_NAMESPACE = 44,
+    RBS_SIGNATURE = 45,
+    RBS_TYPE_NAME = 46,
+    RBS_TYPES_ALIAS = 47,
+    RBS_TYPES_BASES_ANY = 48,
+    RBS_TYPES_BASES_BOOL = 49,
+    RBS_TYPES_BASES_BOTTOM = 50,
+    RBS_TYPES_BASES_CLASS = 51,
+    RBS_TYPES_BASES_INSTANCE = 52,
+    RBS_TYPES_BASES_NIL = 53,
+    RBS_TYPES_BASES_SELF = 54,
+    RBS_TYPES_BASES_TOP = 55,
+    RBS_TYPES_BASES_VOID = 56,
+    RBS_TYPES_BLOCK = 57,
+    RBS_TYPES_CLASS_INSTANCE = 58,
+    RBS_TYPES_CLASS_SINGLETON = 59,
+    RBS_TYPES_FUNCTION = 60,
+    RBS_TYPES_FUNCTION_PARAM = 61,
+    RBS_TYPES_INTERFACE = 62,
+    RBS_TYPES_INTERSECTION = 63,
+    RBS_TYPES_LITERAL = 64,
+    RBS_TYPES_OPTIONAL = 65,
+    RBS_TYPES_PROC = 66,
+    RBS_TYPES_RECORD = 67,
+    RBS_TYPES_RECORD_FIELD_TYPE = 68,
+    RBS_TYPES_TUPLE = 69,
+    RBS_TYPES_UNION = 70,
+    RBS_TYPES_UNTYPED_FUNCTION = 71,
+    RBS_TYPES_VARIABLE = 72,
     RBS_KEYWORD,
     RBS_AST_SYMBOL,
 };
@@ -399,6 +401,15 @@ typedef struct rbs_ast_members_public {
 
 } rbs_ast_members_public_t;
 
+typedef struct rbs_ast_ruby_annotations_class_alias_annotation {
+    rbs_node_t base;
+
+    struct rbs_location *prefix_location;
+    struct rbs_location *keyword_location;
+    struct rbs_type_name *type_name;
+    struct rbs_location *type_name_location;
+} rbs_ast_ruby_annotations_class_alias_annotation_t;
+
 typedef struct rbs_ast_ruby_annotations_colon_method_type_annotation {
     rbs_node_t base;
 
@@ -426,6 +437,15 @@ typedef struct rbs_ast_ruby_annotations_method_types_annotation {
     struct rbs_location_list *vertical_bar_locations;
 } rbs_ast_ruby_annotations_method_types_annotation_t;
 
+typedef struct rbs_ast_ruby_annotations_module_alias_annotation {
+    rbs_node_t base;
+
+    struct rbs_location *prefix_location;
+    struct rbs_location *keyword_location;
+    struct rbs_type_name *type_name;
+    struct rbs_location *type_name_location;
+} rbs_ast_ruby_annotations_module_alias_annotation_t;
+
 typedef struct rbs_ast_ruby_annotations_node_type_assertion {
     rbs_node_t base;
 
@@ -729,9 +749,11 @@ rbs_ast_members_method_definition_overload_t *rbs_ast_members_method_definition_
 rbs_ast_members_prepend_t *rbs_ast_members_prepend_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_type_name_t *name, rbs_node_list_t *args, rbs_node_list_t *annotations, rbs_ast_comment_t *comment);
 rbs_ast_members_private_t *rbs_ast_members_private_new(rbs_allocator_t *allocator, rbs_location_t *location);
 rbs_ast_members_public_t *rbs_ast_members_public_new(rbs_allocator_t *allocator, rbs_location_t *location);
+rbs_ast_ruby_annotations_class_alias_annotation_t *rbs_ast_ruby_annotations_class_alias_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_location_t *keyword_location, rbs_type_name_t *type_name, rbs_location_t *type_name_location);
 rbs_ast_ruby_annotations_colon_method_type_annotation_t *rbs_ast_ruby_annotations_colon_method_type_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_node_list_t *annotations, rbs_node_t *method_type);
 rbs_ast_ruby_annotations_instance_variable_annotation_t *rbs_ast_ruby_annotations_instance_variable_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_ast_symbol_t *ivar_name, rbs_location_t *ivar_name_location, rbs_location_t *colon_location, rbs_node_t *type, rbs_location_t *comment_location);
 rbs_ast_ruby_annotations_method_types_annotation_t *rbs_ast_ruby_annotations_method_types_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_node_list_t *overloads, rbs_location_list_t *vertical_bar_locations);
+rbs_ast_ruby_annotations_module_alias_annotation_t *rbs_ast_ruby_annotations_module_alias_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_location_t *keyword_location, rbs_type_name_t *type_name, rbs_location_t *type_name_location);
 rbs_ast_ruby_annotations_node_type_assertion_t *rbs_ast_ruby_annotations_node_type_assertion_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_node_t *type);
 rbs_ast_ruby_annotations_return_type_annotation_t *rbs_ast_ruby_annotations_return_type_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_location_t *return_location, rbs_location_t *colon_location, rbs_node_t *return_type, rbs_location_t *comment_location);
 rbs_ast_ruby_annotations_skip_annotation_t *rbs_ast_ruby_annotations_skip_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_location_t *skip_location, rbs_location_t *comment_location);

include/rbs/lexer.h

@@ -40,6 +40,7 @@ enum RBSTokenType {
     kBOOL,         /* bool */
     kBOT,          /* bot */
     kCLASS,        /* class */
+    kCLASSALIAS,   /* class-alias */
     kDEF,          /* def */
     kEND,          /* end */
     kEXTEND,       /* extend */
@@ -49,6 +50,7 @@ enum RBSTokenType {
     kINSTANCE,     /* instance */
     kINTERFACE,    /* interface */
     kMODULE,       /* module */
+    kMODULEALIAS,  /* module-alias */
     kNIL,          /* nil */
     kOUT,          /* out */
     kPREPEND,      /* prepend */

lib/rbs/ast/ruby/annotations.rb

@@ -33,6 +33,33 @@ def map_type_name
           end
         end
 
+        class AliasAnnotation < Base
+          attr_reader :keyword_location, :type_name_location, :type_name
+
+          def initialize(location:, prefix_location:, keyword_location:, type_name:, type_name_location:)
+            super(location, prefix_location)
+            @keyword_location = keyword_location
+            @type_name = type_name
+            @type_name_location = type_name_location
+          end
+
+          def map_type_name
+            self.class.new(
+              location:,
+              prefix_location:,
+              keyword_location:,
+              type_name: type_name ? yield(type_name) : nil,
+              type_name_location:
+            ) #: self
+          end
+        end
+
+        class ClassAliasAnnotation < AliasAnnotation
+        end
+
+        class ModuleAliasAnnotation < AliasAnnotation
+        end
+
         class ColonMethodTypeAnnotation < Base
           attr_reader :annotations, :method_type
 
@@ -126,7 +153,7 @@ def initialize(location:, prefix_location:, type_args:, close_bracket_location:,
 
           def map_type_name(&block)
             mapped_type_args = type_args.map { |type| type.map_type_name { yield _1 } }
-            
+
             self.class.new(
               location:,
               prefix_location:,

lib/rbs/ast/ruby/declarations.rb

@@ -182,6 +182,52 @@ def comment
             leading_comment&.as_comment
           end
         end
+
+        class ClassModuleAliasDecl < Base
+          attr_reader :node
+          attr_reader :leading_comment
+          attr_reader :new_name
+          attr_reader :infered_old_name
+          attr_reader :annotation
+
+          def initialize(buffer, node, new_name, infered_old_name, leading_comment, annotation)
+            super(buffer)
+            @node = node
+            @new_name = new_name
+            @infered_old_name = infered_old_name
+            @leading_comment = leading_comment
+            @annotation = annotation
+          end
+
+          def location
+            rbs_location(node.location)
+          end
+
+          def name_location
+            case node
+            when Prism::ConstantWriteNode
+              rbs_location(node.name_loc)
+            when Prism::ConstantPathWriteNode
+              rbs_location(node.target.location)
+            end
+          end
+
+          def old_name
+            # Return explicit type name from annotation if provided, otherwise use inferred name
+            case
+            when annotation.type_name
+              annotation.type_name
+            when infered_old_name
+              infered_old_name
+            else
+              raise "No old name available"
+            end
+          end
+
+          def comment
+            leading_comment&.as_comment
+          end
+        end
       end
     end
   end