Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow Symbol | string to Module methods #1321

Merged
merged 1 commit into from
Jul 14, 2023
Merged

Allow Symbol | string to Module methods #1321

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 34 additions & 32 deletions core/module.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ class Module < Object
#
# Exiting with code 99
#
def alias_method: (::Symbol | ::String new_name, ::Symbol | ::String old_name) -> ::Symbol
def alias_method: (id new_name, id old_name) -> ::Symbol

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -284,7 +284,7 @@ class Module < Object
# end
# Mod.instance_methods.sort #=> [:one, :one=, :two, :two=]
#
def attr_accessor: (*Object::name arg0) -> Array[Symbol]
def attr_accessor: (*id arg0) -> Array[Symbol]

# <!--
# rdoc-file=object.c
Expand All @@ -298,7 +298,7 @@ class Module < Object
# in turn. String arguments are converted to symbols. Returns an array of
# defined method names as symbols.
#
def attr_reader: (*Object::name arg0) -> Array[Symbol]
def attr_reader: (*id arg0) -> Array[Symbol]

# <!--
# rdoc-file=object.c
Expand All @@ -309,7 +309,7 @@ class Module < Object
# *symbol*`.id2name`. String arguments are converted to symbols. Returns an
# array of defined method names as symbols.
#
def attr_writer: (*Object::name arg0) -> Array[Symbol]
def attr_writer: (*id arg0) -> Array[Symbol]

# <!--
# rdoc-file=load.c
Expand All @@ -328,7 +328,7 @@ class Module < Object
# replaced with *filename*. If *const* is defined but not as autoload, does
# nothing.
#
def autoload: (Symbol _module, String filename) -> NilClass
def autoload: (id _module, String filename) -> NilClass

# <!--
# rdoc-file=load.c
Expand All @@ -354,7 +354,7 @@ class Module < Object
# B.autoload?(:CONST) #=> "const.rb", found in A (ancestor)
# B.autoload?(:CONST, false) #=> nil, not found in B itself
#
def autoload?: (Symbol name, ?boolish inherit) -> String?
def autoload?: (id name, ?boolish inherit) -> String?

# <!-- rdoc-file=vm_eval.c -->
# Evaluates the string or block in the context of *mod*, except that when a
Expand Down Expand Up @@ -412,7 +412,7 @@ class Module < Object
# Fred.class_variable_defined?(:@@foo) #=> true
# Fred.class_variable_defined?(:@@bar) #=> false
#
def class_variable_defined?: (Symbol | String arg0) -> bool
def class_variable_defined?: (id arg0) -> bool

# <!--
# rdoc-file=object.c
Expand All @@ -428,7 +428,7 @@ class Module < Object
# end
# Fred.class_variable_get(:@@foo) #=> 99
#
def class_variable_get: (Symbol | String arg0) -> untyped
def class_variable_get: (id arg0) -> untyped

# <!--
# rdoc-file=object.c
Expand All @@ -447,7 +447,7 @@ class Module < Object
# Fred.class_variable_set(:@@foo, 101) #=> 101
# Fred.new.foo #=> 101
#
def class_variable_set: (Symbol | String arg0, untyped arg1) -> untyped
def class_variable_set: (id arg0, untyped arg1) -> untyped

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -527,7 +527,7 @@ class Module < Object
#
# Hash.const_defined? 'foobar' #=> NameError: wrong constant name foobar
#
def const_defined?: (Symbol | String name, ?boolish inherit) -> bool
def const_defined?: (id name, ?boolish inherit) -> bool

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -566,7 +566,7 @@ class Module < Object
#
# Object.const_get 'foobar' #=> NameError: wrong constant name foobar
#
def const_get: (Symbol | String name, ?boolish inherit) -> untyped
def const_get: (id name, ?boolish inherit) -> untyped

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -618,7 +618,7 @@ class Module < Object
#
# Object.const_set('foobar', 42) #=> NameError: wrong constant name foobar
#
def const_set: (Symbol | String arg0, untyped arg1) -> untyped
def const_set: (id arg0, untyped arg1) -> untyped

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -668,7 +668,7 @@ class Module < Object
# p Object.const_source_location('A::C1') # => ["test.rb", 2] -- nesting is supported
# p Object.const_source_location('String') # => [] -- constant is defined in C code
#
def const_source_location: (Symbol | String name, ?boolish inherit) -> ([ String, Integer ] | [ ] | nil)
def const_source_location: (id name, ?boolish inherit) -> ([ String, Integer ] | [ ] | nil)

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -726,8 +726,8 @@ class Module < Object
# I'm Dino!
# #<B:0x401b39e8>
#
def define_method: (Symbol | String arg0, ?Proc | Method | UnboundMethod arg1) -> Symbol
| (Symbol | String arg0) { () -> untyped } -> Symbol
def define_method: (id arg0, ?Proc | Method | UnboundMethod arg1) -> Symbol
| (id arg0) { () -> untyped } -> Symbol

# <!--
# rdoc-file=object.c
Expand All @@ -746,7 +746,7 @@ class Module < Object
# HTTP::NOT_FOUND
# # warning: constant HTTP::NOT_FOUND is deprecated
#
def deprecate_constant: (*Symbol) -> self
def deprecate_constant: (*id) -> self

def eql?: (untyped other) -> bool

Expand Down Expand Up @@ -936,7 +936,7 @@ class Module < Object
#
# Hello there, Dave!
#
def instance_method: (Symbol arg0) -> UnboundMethod
def instance_method: (id arg0) -> UnboundMethod

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -1029,7 +1029,7 @@ class Module < Object
# C.method_defined? "method4" #=> false
# C.method_defined? "private_method2" #=> false
#
def method_defined?: (Symbol | String name, ?boolish inherit) -> bool
def method_defined?: (id name, ?boolish inherit) -> bool

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -1147,7 +1147,7 @@ class Module < Object
# Mod.one #=> "This is one"
# c.call_one #=> "This is the new one"
#
def module_function: (*Symbol | String arg0) -> self
def module_function: (*id arg0) -> self

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -1246,15 +1246,15 @@ class Module < Object
# end
# end
#
def private_class_method: (*Symbol | String arg0) -> self
def private_class_method: (*id arg0) -> self

# <!--
# rdoc-file=object.c
# - mod.private_constant(symbol, ...) => mod
# -->
# Makes a list of existing constants private.
#
def private_constant: (*Symbol arg0) -> self
def private_constant: (*id arg0) -> self

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -1301,7 +1301,7 @@ class Module < Object
# C.private_method_defined? "method2", false #=> false
# C.method_defined? "method2" #=> false
#
def private_method_defined?: (Symbol | String name, ?boolish inherit) -> bool
def private_method_defined?: (id name, ?boolish inherit) -> bool

# <!--
# rdoc-file=vm_method.c
Expand Down Expand Up @@ -1365,7 +1365,7 @@ class Module < Object
# C.protected_method_defined? "method2", false #=> false
# C.method_defined? "method2" #=> true
#
def protected_method_defined?: (Symbol | String name, ?boolish inherit) -> bool
def protected_method_defined?: (id name, ?boolish inherit) -> bool

# <!--
# rdoc-file=vm_method.c
Expand Down Expand Up @@ -1398,23 +1398,23 @@ class Module < Object
# String arguments are converted to symbols. An Array of Symbols and/or Strings
# is also accepted.
#
def public_class_method: (*Symbol | String arg0) -> self
def public_class_method: (*id arg0) -> self

# <!--
# rdoc-file=object.c
# - mod.public_constant(symbol, ...) => mod
# -->
# Makes a list of existing constants public.
#
def public_constant: (*Symbol arg0) -> self
def public_constant: (*id arg0) -> self

# <!--
# rdoc-file=proc.c
# - mod.public_instance_method(symbol) -> unbound_method
# -->
# Similar to *instance_method*, searches public method only.
#
def public_instance_method: (Symbol arg0) -> UnboundMethod
def public_instance_method: (id arg0) -> UnboundMethod

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -1453,7 +1453,7 @@ class Module < Object
# C.public_method_defined? "method2" #=> false
# C.method_defined? "method2" #=> true
#
def public_method_defined?: (Symbol | String name, ?boolish inherit) -> bool
def public_method_defined?: (id name, ?boolish inherit) -> bool

# <!--
# rdoc-file=eval.c
Expand Down Expand Up @@ -1505,7 +1505,7 @@ class Module < Object
# 99
# nil
#
def remove_class_variable: (Symbol arg0) -> untyped
def remove_class_variable: (id arg0) -> untyped

# <!--
# rdoc-file=object.c
Expand All @@ -1515,7 +1515,7 @@ class Module < Object
# previous value. If that constant referred to a module, this will not change
# that module's name and can lead to confusion.
#
def remove_const: (Symbol arg0) -> untyped
def remove_const: (id arg0) -> untyped

# <!--
# rdoc-file=vm_method.c
Expand All @@ -1525,7 +1525,7 @@ class Module < Object
# Removes the method identified by *symbol* from the current class. For an
# example, see Module#undef_method. String arguments are converted to symbols.
#
def remove_method: (*Symbol | String arg0) -> self
def remove_method: (*id arg0) -> self

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -1591,7 +1591,7 @@ class Module < Object
# In parent
# prog.rb:23: undefined method `hello' for #<Child:0x401b3bb4> (NoMethodError)
#
def undef_method: (*Symbol | String arg0) -> self
def undef_method: (*id arg0) -> self

# <!--
# rdoc-file=object.c
Expand Down Expand Up @@ -1629,5 +1629,7 @@ class Module < Object
# `attr_reader(name)` but deprecated. Returns an array of defined method names
# as symbols.
#
def attr: (*Object::name arg0) -> Array[Symbol]
def attr: (*id arg0) -> Array[Symbol]

type id = Symbol | string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Object::name?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, It's very similar to Object::name.
However, I am questioning the correctness of Object::name name.
The expression is ambiguous with name.
The context here is Module, and id is used inside CRuby, as in rb_check_id.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should those using Object::name switch to Module::id instead?

end