Class NameDescriptor
In: ri/ri_util.rb
Parent: Object

Break argument into its constituent class or module names, an optional method type, and a method name

Methods

full_class_name   new  

Attributes

class_names  [R] 
is_class_method  [R]  true and false have the obvious meaning. nil means we don‘t care
method_name  [R] 

Public Class methods

new(arg)

arg may be

  1. a class or module name (optionally qualified with other class or module names (Kernel, File::Stat etc)
  2. a method name
  3. a method name qualified by a optionally fully qualified class or module name

We‘re fairly casual about delimiters: folks can say Kernel::puts, Kernel.puts, or Kernel\puts for example. There‘s one exception: if you say IO::read, we look for a class method, but if you say IO.read, we look for an instance method

[Source]

    # File ri/ri_util.rb, line 28
28:   def initialize(arg)
29:     @class_names = []
30:     separator = nil
31: 
32:     tokens = arg.split(/(\.|::|#)/)
33: 
34:     # Skip leading '::', '#' or '.', but remember it might
35:     # be a method name qualifier
36:     separator = tokens.shift if tokens[0] =~ /^(\.|::|#)/
37: 
38:     # Skip leading '::', but remember we potentially have an inst
39: 
40:     # leading stuff must be class names
41:     
42:     while tokens[0] =~ /^[A-Z]/
43:       @class_names << tokens.shift
44:       unless tokens.empty?
45:         separator = tokens.shift
46:         break unless separator == "::"
47:       end
48:     end
49:     
50:     # Now must have a single token, the method name, or an empty
51:     # array
52:     unless tokens.empty?
53:       @method_name = tokens.shift
54:       # We may now have a trailing !, ?, or = to roll into
55:       # the method name
56:       if !tokens.empty? && tokens[0] =~ /^[!?=]$/
57:         @method_name << tokens.shift
58:       end
59: 
60:       if @method_name =~ /::|\.|#/ or !tokens.empty?
61:         raise RiError.new("Bad argument: #{arg}") 
62:       end
63:       if separator && separator != '.'
64:         @is_class_method = separator == "::"
65:       end
66:     end
67:   end

Public Instance methods

full_class_name()

Return the full class name (with ’::’ between the components) or "" if there‘s no class name

[Source]

    # File ri/ri_util.rb, line 72
72:   def full_class_name
73:     @class_names.join("::")
74:   end

[Validate]