Class: GatherContent::Config::Element::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/gather_content/config/elements/base.rb

Direct Known Subclasses

ChoiceCheckbox, ChoiceRadio, Files, Text

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = nil, required = nil, label = nil, microcopy = nil) ⇒ Base

Returns a new instance of Base.


7
8
9
10
11
12
 
# File 'lib/gather_content/config/elements/base.rb', line 7

def initialize(name = nil, required = nil, label = nil, microcopy = nil)
  @name = name
  @required = required
  @label = label
  @microcopy = microcopy
end

Instance Attribute Details

#label ⇒ Object

Returns the value of attribute label.


5
6
7
 
# File 'lib/gather_content/config/elements/base.rb', line 5

def label
  @label
end

#microcopy ⇒ Object

Returns the value of attribute microcopy.


5
6
7
 
# File 'lib/gather_content/config/elements/base.rb', line 5

def microcopy
  @microcopy
end

#name ⇒ Object

Returns the value of attribute name.


5
6
7
 
# File 'lib/gather_content/config/elements/base.rb', line 5

def name
  @name
end

#required ⇒ Object

Returns the value of attribute required.


5
6
7
 
# File 'lib/gather_content/config/elements/base.rb', line 5

def required
  @required
end

Instance Method Details

#serialize(options = nil) ⇒ Object

Raises:

  • (ArgumentError) 

14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/gather_content/config/elements/base.rb', line 14

def serialize(options = nil)
  raise ArgumentError, "name is required" unless name.present?
  raise ArgumentError, "label is required" unless label.present?

  {
    name: name,
    required: !!required,
    label: label,
    microcopy: microcopy
  }
end

#to_json(options = nil) ⇒ Object 


26
27
28
 
# File 'lib/gather_content/config/elements/base.rb', line 26

def to_json(options = nil)
  serialize.to_json(options)
end