Class: Object

Inherits:
BasicObject
Defined in:
lib/extlib/blank.rb,
lib/extlib/object.rb,
lib/extlib/try_dup.rb

Instance Method Summary collapse

Instance Method Details

#blank? ⇒ TrueClass, FalseClass

Returns true if the object is nil or empty (if applicable)

[].blank?         #=>  true
[1].blank?        #=>  false
[nil].blank?      #=>  false

Returns:



12
13
14
 
# File 'lib/extlib/blank.rb', line 12

def blank?
  nil? || (respond_to?(:empty?) && empty?)
end

#full_const_get(name) ⇒ Object

Returns The constant corresponding to the name.

Parameters:

  • name (String) —

    The name of the constant to get, e.g. “Merb::Router”.

Returns:

  • (Object) —

    The constant corresponding to the name.



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/extlib/object.rb', line 67

def full_const_get(name)
  list = name.split("::")
  list.shift if list.first.blank?
  obj = self
  list.each do |x|
    # This is required because const_get tries to look for constants in the
    # ancestor chain, but we only want constants that are HERE
    obj = obj.const_defined?(x) ? obj.const_get(x) : obj.const_missing(x)
  end
  obj
end

#full_const_set(name, value) ⇒ Object

Returns The constant corresponding to the name.

Parameters:

  • name (String) —

    The name of the constant to get, e.g. “Merb::Router”.

  • value (Object) —

    The value to assign to the constant.

Returns:

  • (Object) —

    The constant corresponding to the name.



83
84
85
86
87
88
89
90
 
# File 'lib/extlib/object.rb', line 83

def full_const_set(name, value)
  list = name.split("::")
  toplevel = list.first.blank?
  list.shift if toplevel
  last = list.pop
  obj = list.empty? ? Object : Object.full_const_get(list.join("::"))
  obj.const_set(last, value) if obj && !obj.const_defined?(last)
end

#in?(arrayish, *more) ⇒ Boolean

Returns True if the object is included in arrayish (+ more).

Examples:

1.in?() #=> true

1.in?(1,2,3) #=> true

Parameters:

  • arrayish (#include?) —

    Container to check, to see if it includes the object.

  • *more (Array) —

    additional args, will be flattened into arrayish

Returns:

  • (Boolean) —

    True if the object is included in arrayish (+ more)



163
164
165
166
 
# File 'lib/extlib/object.rb', line 163

def in?(arrayish,*more)
  arrayish = more.unshift(arrayish) unless more.empty?
  arrayish.include?(self)
end

#instance_variable_defined?(variable) ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/extlib/object.rb', line 174

def instance_variable_defined?(variable)
  instance_variables.include?(variable.to_s)
end

#make_module(string) ⇒ nil

Defines module from a string name (e.g. Foo::Bar::Baz) If module already exists, no exception raised.

Parameters:

  • name (String) —

    The name of the full module name to make

Returns:

  • (nil) 


98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/extlib/object.rb', line 98

def make_module(string)
  current_module = self
  string.split('::').each do |part|
    current_module = if current_module.const_defined?(part)
      current_module.const_get(part)
    else
      current_module.const_set(part, Module.new)
    end
  end
  current_module
end

#meta_class ⇒ Class

Extracts the singleton class, so that metaprogramming can be done on it.

Examples:

Setup 
class MyString < String; end

MyString.instance_eval do
  define_method :foo do
    puts self
  end
end

MyString.meta_class.instance_eval do
  define_method :bar do
    puts self
  end
end

def String.add_meta_var(var)
  self.meta_class.instance_eval do
    define_method var do
      puts "HELLO"
    end
  end
end
MyString.new("Hello").foo #=> "Hello"
MyString.new("Hello").bar
  #=> NoMethodError: undefined method `bar' for "Hello":MyString
MyString.foo
  #=> NoMethodError: undefined method `foo' for MyString:Class
MyString.bar
  #=> MyString
String.bar
  #=> NoMethodError: undefined method `bar' for String:Class
MyString.add_meta_var(:x)
MyString.x #=> HELLO

Returns:

  • (Class) —

    The meta class.



62
 
# File 'lib/extlib/object.rb', line 62

def meta_class() class << self; self end end

#quacks_like?(duck) ⇒ Boolean

Note:

The behavior of the method depends on the type of duck as follows:

Symbol

Check whether the object respond_to?(duck).

Class

Check whether the object is_a?(duck).

Array

Check whether the object quacks_like? at least one of the options in the array.

Returns True if the object quacks like duck.

Parameters:

Returns:

  • (Boolean) —

    True if the object quacks like duck.



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/extlib/object.rb', line 122

def quacks_like?(duck)
  case duck
  when Symbol
    self.respond_to?(duck)
  when Class
    self.is_a?(duck)
  when Array
    duck.any? {|d| self.quacks_like?(d) }
  else
    false
  end
end

#try_call(*args) ⇒ Object

If receiver is callable, calls it and returns result. If not, just returns receiver itself

Returns:



147
148
149
150
151
152
153
 
# File 'lib/extlib/object.rb', line 147

def try_call(*args)
  if self.respond_to?(:call)
    self.call(*args)
  else
    self
  end
end

#try_dup ⇒ Object

Override this in a child if it cannot be dup’ed

Returns:



138
139
140
 
# File 'lib/extlib/object.rb', line 138

def try_dup
  self.dup
end