Class: Class

Inherits:
Object show all
Defined in:
lib/core/facets/class/pathize.rb,
lib/core/facets/class/to_proc.rb,
lib/core/facets/module/revise.rb,
lib/core/facets/class/methodize.rb,
lib/core/facets/class/subclasses.rb,
lib/core/facets/class/descendants.rb,
lib/core/facets/class/preallocate.rb,
lib/core/facets/module/class_extend.rb,
lib/core/facets/class/singleton_class.rb

Instance Method Summary collapse

Instance Method Details

#class_extend(*mods, &block) ⇒ Object

For Class, Module#class_extend is similar to class_eval.

The alternative is to “undef_method :class_extend”, but this seems uneccessarily limited.

Uncommon:

  • require ‘facets/module/class_extend’



84
85
86
87
88
89
90
 
# File 'lib/core/facets/module/class_extend.rb', line 84

def class_extend(*mods, &block)
  class_extension = Module.new
  class_extension.__send__(:include, *mods)
  class_extension.module_eval(&block) if block
  extend(class_extension)
  class_extensions << class_extension
end

#descendants(generations = -1)) ⇒ Object

List all descedents of this class.

class A ; end
class B < A; end
class C < A; end
A.descendants  #=> [B,C]

You may also limit the generational distance the subclass may be from the parent class.

class X ; end
class Y < X; end
class Z < Y; end
X.descendants    #=> [Y,Z]
X.descendants(1) #=> [Y]

NOTE: This is a intensive operation. Do not expect it to be very fast.

Author:

  • Roger Pack



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/core/facets/class/descendants.rb', line 24

def descendants(generations=-1)
  descendants = []
  subclasses.each do |k|
    descendants << k
    if generations != 1
      descendants.concat(k.descendants(generations - 1))
    end
  end
  descendants
end

#methodize ⇒ Object

Translate a class name to a suitable method name.

module ::Example
  class MethodizeExample
  end
end

Example::MethodizeExample.methodize  #=> "example__methodize_example"



14
15
16
 
# File 'lib/core/facets/class/methodize.rb', line 14

def methodize
  name.methodize
end

#pathize ⇒ Object

Converts a class name to a unix path.

module ::Example
  class PathizeExample
  end
end

Example::PathizeExample.pathize  #=> "example/pathize_example"



14
15
16
 
# File 'lib/core/facets/class/pathize.rb', line 14

def pathize
  name.pathize
end

#preallocate(aspect) ⇒ Object

Designate aspect modules to be added to a object at instantiation.

class Firetruck
  def put_out_fire(option)
    "Put out #{option}"
  end
end

module FastFiretruck
  def put_out_fire(option)
    super("very #{option}!")
  end
end

Firetruck.preallocate(FastFiretruck)

ft = Firetruck.new
ft.put_out_fire('fast') #=> "Put out very fast!"

This method is very similar to the idea of #prepend, but it has some limitations in that it works by overriding #new and #allocate and extends an object with the aspect modules on instantiation. A true #prepend implementation would not have to do this –but would be a natural part of the class heirarchy instead. For this reason, this method has been named #preallocate, rather than #prepend.

NOTE: This method is not a common core extension and is not loaded automatically when using require 'facets'.

CREDIT: Trans

Uncommon:

  • require ‘facets/class/preallocate’



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/core/facets/class/preallocate.rb', line 37

def preallocate(aspect)
  _new      = method(:new)
  _allocate = method(:allocate)
  (class << self; self; end).class_eval do
    define_method(:new) do |*args|
      o = _new.call(*args)
      o.extend aspect
      o
    end
    define_method(:allocate) do |*args|
      o = _allocate.call(*args)
      o.extend aspect
      o
    end
  end
end

#singleton_class? ⇒ Boolean Also known as: singleton?

Return true if a class is the singleton class of an object.

Returns:

  • (Boolean)

Uncommon:

  • require ‘facets/class/singleton_class’



9
10
11
 
# File 'lib/core/facets/class/singleton_class.rb', line 9

def singleton_class? 
  ! ancestors.include?( self ) rescue false 
end

#to_proc ⇒ Object

Convert instatiation of a class into a Proc.

class Person
  def initialize(name)
    @name = name
  end

  def inspect
    @name.to_str
  end
end

persons = %w(john bob jane hans).map(&Person)

persons.map{ |p| p.inspect }  #=> ['john', 'bob', 'jane', 'hans']

CREDIT: Daniel Schierbeck



20
21
22
 
# File 'lib/core/facets/class/to_proc.rb', line 20

def to_proc
  proc{|*args| new(*args)}
end