Ruby Language
Introspección
Buscar..
Ver los métodos de un objeto.
Inspeccionar un objeto
Puede encontrar los métodos públicos a los que un objeto puede responder utilizando los methods
o los methods
public_methods
, que devuelven una matriz de símbolos:
class Foo
def bar; 42; end
end
f = Foo.new
def f.yay; 17; end
p f.methods.sort
#=> [:!, :!=, :!~, :<=>, :==, :===, :=~, :__id__, :__send__, :bar, :class, :clone,
#=> :define_singleton_method, :display, :dup, :enum_for, :eql?, :equal?, :extend,
#=> :freeze, :frozen?, :hash, :inspect, :instance_eval, :instance_exec,
#=> :instance_of?, :instance_variable_defined?, :instance_variable_get,
#=> :instance_variable_set, :instance_variables, :is_a?, :itself, :kind_of?,
#=> :method, :methods, :nil?, :object_id, :private_methods, :protected_methods,
#=> :public_method, :public_methods, :public_send, :remove_instance_variable,
#=> :respond_to?, :send, :singleton_class, :singleton_method, :singleton_methods,
#=> :taint, :tainted?, :tap, :to_enum, :to_s, :trust, :untaint, :untrust,
#=> :untrusted?, :yay]
Para una lista más específica, puede eliminar métodos comunes a todos los objetos, por ejemplo,
p (f.methods - Object.methods).sort
#=> [:bar,:yay]
Alternativamente, puede pasar false
a methods
o public_methods
:
p f.methods(false) # public and protected singleton methods of `f`
#=> [:yay]
p f.public_methods(false)
#=> [:yay, :bar]
Puede encontrar los métodos privados y protegidos de un objeto utilizando private_methods
y protected_methods
:
p f.private_methods.sort
#=> [:Array, :Complex, :DelegateClass, :Float, :Hash, :Integer, :Rational, :String,
#=> :__callee__, :__dir__, :__method__, :`, :abort, :at_exit, :autoload, :autoload?,
#=> :binding, :block_given?, :caller, :caller_locations, :catch,
#=> :default_src_encoding, :eval, :exec, :exit, :exit!, :fail, :fork, :format, :gem,
#=> :gem_original_require, :gets, :global_variables, :initialize, :initialize_clone,
#=> :initialize_copy, :initialize_dup, :irb_binding, :iterator?, :lambda, :load,
#=> :local_variables, :loop, :method_missing, :open, :p, :print, :printf, :proc,
#=> :putc, :puts, :raise, :rand, :readline, :readlines, :require, :require_relative,
#=> :respond_to_missing?, :select, :set_trace_func, :singleton_method_added,
#=> :singleton_method_removed, :singleton_method_undefined, :sleep, :spawn,
#=> :sprintf, :srand, :syscall, :system, :test, :throw, :trace_var, :trap,
#=> :untrace_var, :warn]
p f.protected_methods
#=> []
Al igual que con methods
y public_methods
, puede pasar false
a private_methods
y protected_methods
a recortar los métodos heredados.
Inspeccionar una clase o módulo
Además de methods
, public_methods
, protected_methods
, y private_methods
, clases y módulos exponer instance_methods
, public_instance_methods
, protected_instance_methods
, y private_instance_methods
para determinar los métodos expuestos para los objetos que heredan de la clase o módulo. Como antes, puede pasar false
a estos métodos para excluir métodos heredados:
p Foo.instance_methods.sort
#=> [:!, :!=, :!~, :<=>, :==, :===, :=~, :__id__, :__send__, :bar, :class,
#=> :clone, :define_singleton_method, :display, :dup, :enum_for, :eql?,
#=> :equal?, :extend, :freeze, :frozen?, :hash, :inspect, :instance_eval,
#=> :instance_exec, :instance_of?, :instance_variable_defined?,
#=> :instance_variable_get, :instance_variable_set, :instance_variables,
#=> :is_a?, :itself, :kind_of?, :method, :methods, :nil?, :object_id,
#=> :private_methods, :protected_methods, :public_method, :public_methods,
#=> :public_send, :remove_instance_variable, :respond_to?, :send,
#=> :singleton_class, :singleton_method, :singleton_methods, :taint,
#=> :tainted?, :tap, :to_enum, :to_s, :trust, :untaint, :untrust, :untrusted?]
p Foo.instance_methods(false)
#=> [:bar]
Finalmente, si olvida los nombres de la mayoría de estos en el futuro, puede encontrar todos estos métodos utilizando methods
:
p f.methods.grep(/methods/)
#=> [:private_methods, :methods, :protected_methods, :public_methods,
#=> :singleton_methods]
p Foo.methods.grep(/methods/)
#=> [:public_instance_methods, :instance_methods, :private_instance_methods,
#=> :protected_instance_methods, :private_methods, :methods,
#=> :protected_methods, :public_methods, :singleton_methods]
Ver las variables de instancia de un objeto
Es posible consultar un objeto acerca de sus variables de instance_variables
usando instance_variables
, instance_variable_defined?
y instance_variable_get
, y remove_instance_variable
usando instance_variable_set
y remove_instance_variable
:
class Foo
attr_reader :bar
def initialize
@bar = 42
end
end
f = Foo.new
f.instance_variables #=> [:@bar]
f.instance_variable_defined?(:@baz) #=> false
f.instance_variable_defined?(:@bar) #=> true
f.instance_variable_get(:@bar) #=> 42
f.instance_variable_set(:@bar, 17) #=> 17
f.bar #=> 17
f.remove_instance_variable(:@bar) #=> 17
f.bar #=> nil
f.instance_variables #=> []
Los nombres de las variables de instancia incluyen el símbolo @
. Obtendrá un error si lo omite:
f.instance_variable_defined?(:jim)
#=> NameError: `jim' is not allowed as an instance variable name
Ver variables globales y locales
El Kernel
expone métodos para obtener la lista de global_variables
y local_variables
:
cats = 42
$demo = "in progress"
p global_variables.sort
#=> [:$!, :$", :$$, :$&, :$', :$*, :$+, :$,, :$-0, :$-F, :$-I, :$-K, :$-W, :$-a,
#=> :$-d, :$-i, :$-l, :$-p, :$-v, :$-w, :$., :$/, :$0, :$1, :$2, :$3, :$4, :$5,
#=> :$6, :$7, :$8, :$9, :$:, :$;, :$<, :$=, :$>, :$?, :$@, :$DEBUG, :$FILENAME,
#=> :$KCODE, :$LOADED_FEATURES, :$LOAD_PATH, :$PROGRAM_NAME, :$SAFE, :$VERBOSE,
#=> :$\, :$_, :$`, :$binding, :$demo, :$stderr, :$stdin, :$stdout, :$~]
p local_variables
#=> [:cats]
A diferencia de las variables de instancia, no hay métodos específicos para obtener, configurar o eliminar variables globales o locales. Buscar dicha funcionalidad suele ser una señal de que su código debe reescribirse para usar un Hash para almacenar los valores. Sin embargo, si debe modificar variables globales o locales por nombre, puede usar eval
con una cadena:
var = "$demo"
eval(var) #=> "in progress"
eval("#{var} = 17")
p $demo #=> 17
Por defecto, eval
evaluará sus variables en el alcance actual. Para evaluar las variables locales en un ámbito diferente, debe capturar el enlace donde existen las variables locales.
def local_variable_get(name, bound=nil)
foo = :inside
eval(name,bound)
end
def test_1
foo = :outside
p local_variable_get("foo")
end
def test_2
foo = :outside
p local_variable_get("foo",binding)
end
test_1 #=> :inside
test_2 #=> :outside
En lo anterior, test_1
no pasó un enlace a local_variable_get
, por lo que la eval
se ejecutó dentro del contexto de ese método, donde una variable local llamada foo
se estableció en :inside
.
Ver variables de clase
Las clases y los módulos tienen los mismos métodos para introspeccionar variables de instancia que cualquier otro objeto. La clase y los módulos también tienen métodos similares para consultar las variables de la clase ( @@these_things
):
p Module.methods.grep(/class_variable/)
#=> [:class_variables, :class_variable_get, :remove_class_variable,
#=> :class_variable_defined?, :class_variable_set]
class Foo
@@instances = 0
def initialize
@@instances += 1
end
end
class Bar < Foo; end
5.times{ Foo.new }
3.times{ Bar.new }
p Foo.class_variables #=> [:@@instances]
p Bar.class_variables #=> [:@@instances]
p Foo.class_variable_get(:@@instances) #=> 8
p Bar.class_variable_get(:@@instances) #=> 8
Similar a las variables de instancia, el nombre de las variables de clase debe comenzar con @@
, o aparecerá un error:
p Bar.class_variable_defined?( :instances )
#=> NameError: `instances' is not allowed as a class variable name