Class: Representable::Definition

Inherits:
Object
  • Object
show all
Defined in:
lib/representable/definition.rb

Overview

Created at class compile time. Keeps configuration options for one property.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sym, options = {}) ⇒ Definition

Returns a new instance of Definition.



7
8
9
10
11
12
 
# File 'lib/representable/definition.rb', line 7

def initialize(sym, options={})
  @name     = sym.to_s
  @options  = options

  @options[:default] ||= [] if array?  # FIXME: move to CollectionBinding!
end

Instance Attribute Details

#name ⇒ Object (readonly) Also known as: getter

Returns the value of attribute name.



4
5
6
 
# File 'lib/representable/definition.rb', line 4

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



4
5
6
 
# File 'lib/representable/definition.rb', line 4

def options
  @options
end

Instance Method Details

#array? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/representable/definition.rb', line 26

def array?
  options[:collection]
end

#attribute ⇒ Object 



56
57
58
 
# File 'lib/representable/definition.rb', line 56

def attribute
  options[:attribute]
end

#binding ⇒ Object 



72
73
74
 
# File 'lib/representable/definition.rb', line 72

def binding
  options[:binding]
end

#clone ⇒ Object 



14
15
16
 
# File 'lib/representable/definition.rb', line 14

def clone
  self.class.new(name, options.clone) # DISCUSS: make generic Definition.cloned_attribute that passes list to constructor.
end

#content ⇒ Object 



60
61
62
 
# File 'lib/representable/definition.rb', line 60

def content
  options[:content]
end

#create_binding(*args) ⇒ Object 



76
77
78
 
# File 'lib/representable/definition.rb', line 76

def create_binding(*args)
  binding.call(self, *args)
end

#default ⇒ Object 



68
69
70
 
# File 'lib/representable/definition.rb', line 68

def default
  options[:default]
end

#default_for(value) ⇒ Object 



43
44
45
46
 
# File 'lib/representable/definition.rb', line 43

def default_for(value)
  return default if skipable_nil_value?(value)
  value
end

#from ⇒ Object 



38
39
40
41
 
# File 'lib/representable/definition.rb', line 38

def from
  # TODO: deprecate :from.
  (options[:from] || options[:as] || name).to_s
end

#has_default? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/representable/definition.rb', line 48

def has_default?
  options.has_key?(:default)
end

#hash? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/representable/definition.rb', line 30

def hash?
  options[:hash]
end

#representer_module ⇒ Object 



52
53
54
 
# File 'lib/representable/definition.rb', line 52

def representer_module
  options[:extend] or options[:decorator]
end

#setter ⇒ Object 



18
19
20
 
# File 'lib/representable/definition.rb', line 18

def setter
  :"#{name}="
end

#skipable_nil_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/representable/definition.rb', line 64

def skipable_nil_value?(value)
  value.nil? and not options[:render_nil]
end

#sought_type ⇒ Object 



34
35
36
 
# File 'lib/representable/definition.rb', line 34

def sought_type
  options[:class]
end

#sync? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/representable/definition.rb', line 80

def sync?
  options[:parse_strategy] == :sync
end

#typed? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/representable/definition.rb', line 22

def typed?
  sought_type.is_a?(Class) or representer_module or options[:instance]  # also true if only :extend is set, for people who want solely rendering.
end