Module

ruby/spec describes 89 methods in core/module, and Metorex implements 87 of them. The parameters are what Method#parameters answers under Metorex.

• Module#<: implemented, parameters [[:req]]. Returns whether self is a subclass of other, or nil if there is no relationship between the two:
• Module#<=: implemented, parameters [[:req]]. Returns true if mod is a subclass of other or is the same as other.
• Module#<=>: implemented, parameters [[:req]]. Compares self and other.
• Module#==: implemented, parameters [[:req]]. Equality --- At the Object level, #== returns true only if obj and other are the same object.
• Module#===: implemented, parameters [[:req]]. Case Equality---Returns true if obj is an instance of mod or an instance of one of mod's descendants.
• Module#>: implemented, parameters [[:req]]. Returns true if mod is an ancestor of other.
• Module#>=: implemented, parameters [[:req]]. Returns true if mod is an ancestor of other, or the two modules are the same.
• Module#alias_method: implemented, parameters [[:req], [:req]]. Makes new_name a new copy of the method old_name. An example calling it.
• Module#ancestors: implemented, parameters []. Returns a list of modules included/prepended in mod (including mod itself). An example calling it.
• Module#append_features: implemented, parameters [[:req]]. When this module is included in another, Ruby calls #append_features in this module, passing it the receiving module in mod. An example calling it.
• Module#attr: implemented, parameters [[:rest]]. The first form is equivalent to #attr_reader.
• Module#attr_accessor: implemented, parameters [[:rest]]. Defines a named attribute for this module, where the name is symbol.id2name, creating an instance variable (@name) and a corresponding access method to read it.
• Module#attr_reader: implemented, parameters [[:rest]]. Creates instance variables and corresponding methods that return the value of each instance variable.
• Module#attr_writer: implemented, parameters [[:rest]]. Creates an accessor method to allow assignment to the attribute symbol.id2name.
• Module#autoload: implemented, parameters [[:req], [:req]]. Registers filename to be loaded (using Kernel::require) the first time that const (which may be a String or a symbol) is accessed in the namespace of mod. An example calling it.
• Module#autoload?: implemented, parameters [[:rest]]. Returns filename to be loaded if name is registered as autoload in the namespace of mod or one of its ancestors. An example calling it.
• Module#autoload_relative: not implemented.
• Module#class_eval: implemented, parameters [[:rest]]. Evaluates the string or block in the context of mod, except that when a block is given, constant/class variable lookup is not affected. An example calling it.
• Module#class_exec: implemented, parameters [[:rest]]. Evaluates the given block in the context of the class/module. An example calling it.
• Module#class_variable_defined?: implemented, parameters [[:req]]. Returns true if the given class variable is defined in obj. An example calling it.
• Module#class_variable_get: implemented, parameters [[:req]]. Returns the value of the given class variable (or throws a NameError exception). An example calling it.
• Module#class_variable_set: implemented, parameters [[:req], [:req]]. Sets the class variable named by symbol to the given object. An example calling it.
• Module#class_variables: implemented, parameters [[:rest]]. Returns an array of the names of class variables in mod. An example calling it.
• Module#const_added: implemented, parameters [[:req]]. Invoked as a callback whenever a constant is assigned on the receiver module Chatty. An example calling it.
• Module#const_defined?: implemented, parameters [[:rest]]. Says whether mod or its ancestors have a constant with the given name: An example calling it.
• Module#const_get: implemented, parameters [[:rest]]. Checks for a constant with the given name in mod. An example calling it.
• Module#const_missing: implemented, parameters [[:req]]. Invoked when a reference is made to an undefined constant in mod. An example calling it.
• Module#const_set: implemented, parameters [[:req], [:req]]. Sets the named constant to the given object, returning that object. An example calling it.
• Module#const_source_location: implemented, parameters [[:rest]]. Returns the Ruby source filename and line number containing the definition of the constant specified. An example calling it.
• Module#constants: implemented, parameters [[:rest]]. Returns an array of the names of the constants accessible in mod. An example calling it.
• Module.constants: implemented, parameters [[:rest]]. In the first form, returns an array of the names of all constants accessible from the point of call. An example calling it.
• Module#define_method: implemented, parameters [[:rest]]. Defines an instance method in the receiver. An example calling it.
• Module#define_singleton_method: implemented, parameters [[:rest]]. Defines a public singleton method in the receiver. An example calling it.
• Module#deprecate_constant: implemented, parameters [[:rest]]. Makes a list of existing constants deprecated. An example calling it.
• Module#descendants: not implemented.
• Module#eql?: implemented, parameters [[:req]]. Equality --- At the Object level, #== returns true only if obj and other are the same object. An example calling it.
• Module#equal?: implemented, parameters [[:req]]. Equality --- At the Object level, #== returns true only if obj and other are the same object. An example calling it.
• Module#extend_object: implemented, parameters [[:req]]. Extends the specified object by adding this module's constants and methods (which are added as singleton methods). An example calling it.
• Module#extended: implemented, parameters [[:req]]. The equivalent of included, but for extended modules. An example calling it.
• Module#freeze: implemented, parameters []. Prevents further modifications to mod. An example calling it.
• Module#include: implemented, parameters [[:rest]]. Invokes Module.append_features on each parameter in reverse order. An example calling it.
• Module#include?: implemented, parameters [[:req]]. Returns true if module is included or prepended in mod or one of mod's ancestors. An example calling it.
• Module#included: implemented, parameters [[:req]]. Callback invoked whenever the receiver is included in another module or class. An example calling it.
• Module#included_modules: implemented, parameters []. Returns the list of modules included or prepended in mod or one of mod's ancestors. An example calling it.
• Module#initialize: implemented, parameters []. An example calling it.
• Module#initialize_copy: implemented, parameters [[:req]].
• Module#inspect: implemented, parameters []. Returns a string representing this module or class. An example calling it.
• Module#instance_method: implemented, parameters [[:req]]. Returns an UnboundMethod representing the given instance method in mod. An example calling it.
• Module#instance_methods: implemented, parameters [[:rest]]. Returns an array containing the names of the public and protected instance methods in the receiver. An example calling it.
• Module#method_added: implemented, parameters [[:req]]. Invoked as a callback whenever an instance method is added to the receiver. An example calling it.
• Module#method_defined?: implemented, parameters [[:rest]]. Returns true if the named method is defined by mod. An example calling it.
• Module#method_removed: implemented, parameters [[:req]]. Invoked as a callback whenever an instance method is removed from the receiver. An example calling it.
• Module#method_undefined: implemented, parameters [[:req]]. Invoked as a callback whenever an instance method is undefined from the receiver. An example calling it.
• Module#module_eval: implemented, parameters [[:rest]]. Evaluates the string or block in the context of mod, except that when a block is given, constant/class variable lookup is not affected. An example calling it.
• Module#module_exec: implemented, parameters [[:rest]]. Evaluates the given block in the context of the class/module. An example calling it.
• Module#module_function: implemented, parameters [[:rest]]. Creates module functions for the named methods. An example calling it.
• Module#name: implemented, parameters []. Returns the name of the module mod. An example calling it.
• Module.nesting: implemented, parameters [[:req, :args]]. Returns the list of Modules nested at the point of call. An example calling it.
• Module.new: implemented, parameters [[:rest]]. Creates a new anonymous module. An example calling it.
• Module#prepend: implemented, parameters [[:rest]]. Invokes Module.prepend_features on each parameter in reverse order. An example calling it.
• Module#prepend_features: implemented, parameters [[:req]]. When this module is prepended in another, Ruby calls #prepend_features in this module, passing it the receiving module in mod. An example calling it.
• Module#prepended: implemented, parameters [[:req]]. The equivalent of included, but for prepended modules. An example calling it.
• Module#private: implemented, parameters [[:rest]]. With no arguments, sets the default visibility for subsequently defined methods to private.
• Module#private_class_method: implemented, parameters [[:rest]]. Makes existing class methods private. An example calling it.
• Module#private_constant: implemented, parameters [[:rest]]. Makes a list of existing constants private. An example calling it.
• Module#private_instance_methods: implemented, parameters [[:rest]]. Returns a list of the private instance methods defined in mod. An example calling it.
• Module#private_method_defined?: implemented, parameters [[:rest]]. Returns true if the named private method is defined by mod. An example calling it.
• Module#protected: implemented, parameters [[:rest]]. Sets the visibility of a section or of a list of method names as protected.
• Module#protected_instance_methods: implemented, parameters [[:rest]]. Returns a list of the protected instance methods defined in mod. An example calling it.
• Module#protected_method_defined?: implemented, parameters [[:rest]]. Returns true if the named protected method is defined mod. An example calling it.
• Module#public: implemented, parameters [[:rest]]. With no arguments, sets the default visibility for subsequently defined methods to public.
• Module#public_class_method: implemented, parameters [[:rest]]. Makes a list of existing class methods public. An example calling it.
• Module#public_constant: implemented, parameters [[:rest]]. Makes a list of existing constants public. An example calling it.
• Module#public_instance_method: implemented, parameters [[:req]]. Similar to instance_method, searches public method only. An example calling it.
• Module#public_instance_methods: implemented, parameters [[:rest]]. Returns a list of the public instance methods defined in mod. An example calling it.
• Module#public_method_defined?: implemented, parameters [[:rest]]. Returns true if the named public method is defined by mod. An example calling it.
• Module#refine: implemented, parameters [[:req]]. Refine mod in the receiver.
• Module#refinements: implemented, parameters []. Returns an array of Refinement defined within the receiver. An example calling it.
• Module#remove_class_variable: implemented, parameters [[:req]]. Removes the named class variable from the receiver, returning that variable's value.
• Module#remove_const: implemented, parameters [[:req]]. Removes the definition of the given constant, returning that constant's previous value.
• Module#remove_method: implemented, parameters [[:rest]]. Removes the method identified by symbol from the current class. An example calling it.
• Module#ruby2_keywords: implemented, parameters [[:rest]]. For the given method names, marks the method as passing keywords through a normal argument splat. An example calling it.
• Module#set_temporary_name: implemented, parameters [[:req]]. Sets the temporary name of the module. An example calling it.
• Module#singleton_class?: implemented, parameters []. Returns true if mod is a singleton class or false if it is an ordinary class or module. An example calling it.
• Module#to_s: implemented, parameters []. Returns a string representing this module or class. An example calling it.
• Module#undef_method: implemented, parameters [[:rest]]. Prevents the current class from responding to calls to the named method. An example calling it.
• Module#undefined_instance_methods: implemented, parameters []. Returns a list of the undefined instance methods defined in mod. An example calling it.
• Module.used_refinements: implemented, parameters [[:req, :args]]. Returns an array of all modules used in the current scope. An example calling it.
• Module#using: implemented, parameters [[:req]]. Import class refinements from module into the current class or module definition.

The method summaries are the first sentences of Ruby's own documentation for each method, read from MRI 4.0.6's ri data. Ruby's documentation is distributed under Ruby's license.