Class: Object

Inherits:
BasicObject
Defined in:
lib/shopify/extlib/object.rb,
lib/shopify/extlib/inflection.rb

Overview

:nodoc:all

Instance Method Summary collapse

Instance Method Details

#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.



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/shopify/extlib/object.rb', line 64

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.



80
81
82
83
84
85
86
87
 
# File 'lib/shopify/extlib/object.rb', line 80

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) ⇒ TrueClass, FalseClass

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:

  • (TrueClass, FalseClass) —

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



147
148
149
150
 
# File 'lib/shopify/extlib/object.rb', line 147

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

#instance_variable_defined?(variable) ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
 
# File 'lib/shopify/extlib/object.rb', line 158

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

#make_module(str) ⇒ NilClass

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:

  • (NilClass) 


95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/shopify/extlib/object.rb', line 95

def make_module(str)
  mod = str.split("::")
  current_module = self
  mod.each do |x|
    unless current_module.const_defined?(x)
      current_module.class_eval "module #{x}; end"
    end
    current_module = current_module.const_get(x)
  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.



59
 
# File 'lib/shopify/extlib/object.rb', line 59

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

#plural ⇒ Object Also known as: pluralize

Raises:

  • (MethodNotFound) 


431
432
433
434
 
# File 'lib/shopify/extlib/inflection.rb', line 431

def plural
  raise MethodNotFound, caller(1) unless self.respond_to?(:to_s)
  Extlib::Inflection.plural(to_s)
end

#quacks_like?(duck) ⇒ TrueClass, FalseClass

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:

  • duck (Symbol, Class, Array) —

    The thing to compare the object to.

Returns:

  • (TrueClass, FalseClass) —

    True if the object quacks like duck.



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/shopify/extlib/object.rb', line 119

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

#singular ⇒ Object Also known as: singularize

Raises:

  • (MethodNotFound) 


426
427
428
429
 
# File 'lib/shopify/extlib/inflection.rb', line 426

def singular
  raise MethodNotFound, caller(1) unless self.respond_to?(:to_s)
  Extlib::Inflection.singular(to_s)
end

#try_dup ⇒ Object

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

Returns:



135
136
137
 
# File 'lib/shopify/extlib/object.rb', line 135

def try_dup
  self.dup
end