Module: DuckRecord::AttributeMethods::ClassMethods

Defined in:
lib/duck_record/attribute_methods.rb

Instance Method Summary collapse

Instance Method Details

#attribute_names ⇒ Object

Returns an array of column names as strings if it’s not an abstract class and table exists. Otherwise it returns an empty array.

class Person < DuckRecord::Base
end

Person.attribute_names
# => ["id", "created_at", "updated_at", "name", "age"]



145
146
147
148
149
150
151
 
# File 'lib/duck_record/attribute_methods.rb', line 145

def attribute_names
  @attribute_names ||= if !abstract_class?
    attribute_types.keys
  else
    []
  end
end

#class_method_defined_within?(name, klass, superklass = klass.superclass) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/duck_record/attribute_methods.rb', line 125

def class_method_defined_within?(name, klass, superklass = klass.superclass) # :nodoc:
  if klass.respond_to?(name, true)
    if superklass.respond_to?(name, true)
      klass.method(name).owner != superklass.method(name).owner
    else
      true
    end
  else
    false
  end
end

#dangerous_attribute_method?(name) ⇒ Boolean

A method name is ‘dangerous’ if it is already (re)defined by Active Record, but not by any ancestors. (So ‘puts’ is not dangerous but ‘save’ is.)

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/duck_record/attribute_methods.rb', line 103

def dangerous_attribute_method?(name) # :nodoc:
  method_defined_within?(name, Base)
end

#dangerous_class_method?(method_name) ⇒ Boolean

A class method is ‘dangerous’ if it is already (re)defined by Active Record, but not by any ancestors. (So ‘puts’ is not dangerous but ‘new’ is.)

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/duck_record/attribute_methods.rb', line 121

def dangerous_class_method?(method_name)
  BLACKLISTED_CLASS_METHODS.include?(method_name.to_s) || class_method_defined_within?(method_name, Base)
end

#define_attribute_methods ⇒ Object

Generates all the attribute related methods for columns in the database accessors, mutators and query methods.



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/duck_record/attribute_methods.rb', line 51

def define_attribute_methods # :nodoc:
  return false if @attribute_methods_generated
  # Use a mutex; we don't want two threads simultaneously trying to define
  # attribute methods.
  generated_attribute_methods.synchronize do
    return false if @attribute_methods_generated
    superclass.define_attribute_methods unless self == base_class
    super(attribute_names)
    @attribute_methods_generated = true
  end
  true
end

#has_attribute?(attr_name) ⇒ Boolean

Returns true if the given attribute exists, otherwise false.

class Person < DuckRecord::Base
end

Person.has_attribute?('name')   # => true
Person.has_attribute?(:age)     # => true
Person.has_attribute?(:nothing) # => false

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/duck_record/attribute_methods.rb', line 161

def has_attribute?(attr_name)
  attribute_types.key?(attr_name.to_s)
end

#inherited(child_class) ⇒ Object

:nodoc:



36
37
38
39
 
# File 'lib/duck_record/attribute_methods.rb', line 36

def inherited(child_class) #:nodoc:
  child_class.initialize_generated_modules
  super
end

#initialize_generated_modules ⇒ Object

:nodoc:



41
42
43
44
45
46
47
 
# File 'lib/duck_record/attribute_methods.rb', line 41

def initialize_generated_modules # :nodoc:
  @generated_attribute_methods = GeneratedAttributeMethods.new { extend Mutex_m }
  @attribute_methods_generated = false
  include @generated_attribute_methods

  super
end

#instance_method_already_implemented?(method_name) ⇒ Boolean

Raises an DuckRecord::DangerousAttributeError exception when an Active Record method is defined in the model, otherwise false.

class Person < DuckRecord::Base
  def save
    'already defined by Active Record'
  end
end

Person.instance_method_already_implemented?(:save)
# => DuckRecord::DangerousAttributeError: save is defined by Active Record. Check to make sure that you don't have an attribute or method with the same name.

Person.instance_method_already_implemented?(:name)
# => false

Returns:

  • (Boolean) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/duck_record/attribute_methods.rb', line 85

def instance_method_already_implemented?(method_name)
  if dangerous_attribute_method?(method_name)
    raise DangerousAttributeError, "#{method_name} is defined by Active Record. Check to make sure that you don't have an attribute or method with the same name."
  end

  if superclass == Base
    super
  else
    # If ThisClass < ... < SomeSuperClass < ... < Base and SomeSuperClass
    # defines its own attribute method, then we don't want to overwrite that.
    defined = method_defined_within?(method_name, superclass, Base) &&
      ! superclass.instance_method(method_name).owner.is_a?(GeneratedAttributeMethods)
    defined || super
  end
end

#method_defined_within?(name, klass, superklass = klass.superclass) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/duck_record/attribute_methods.rb', line 107

def method_defined_within?(name, klass, superklass = klass.superclass) # :nodoc:
  if klass.method_defined?(name) || klass.private_method_defined?(name)
    if superklass.method_defined?(name) || superklass.private_method_defined?(name)
      klass.instance_method(name).owner != superklass.instance_method(name).owner
    else
      true
    end
  else
    false
  end
end

#undefine_attribute_methods ⇒ Object

:nodoc:



64
65
66
67
68
69
 
# File 'lib/duck_record/attribute_methods.rb', line 64

def undefine_attribute_methods # :nodoc:
  generated_attribute_methods.synchronize do
    super if defined?(@attribute_methods_generated) && @attribute_methods_generated
    @attribute_methods_generated = false
  end
end