Class: Brief::Model::Definition
- Inherits:
-
Object
- Object
- Brief::Model::Definition
show all
- Defined in:
- lib/brief/model/definition.rb
Instance Attribute Summary collapse
Instance Method Summary
collapse
Constructor Details
#initialize(name, options = {}) ⇒ Definition
Returns a new instance of Definition.
14
15
16
17
18
19
20
21
22
|
# File 'lib/brief/model/definition.rb', line 14
def initialize(name, options = {})
@name = name
@options = options
@type_alias = options.fetch(:type_alias) { name.downcase.parameterize.gsub(/-/, '_') }
@metadata_schema = {}.to_mash
@section_mappings = {}.to_mash
@content_schema = { attributes: {} }.to_mash
@model_class = options[:model_class]
end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(meth, *args, &block) ⇒ Object
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
# File 'lib/brief/model/definition.rb', line 128
def method_missing(meth, *args, &block)
args = args.dup
if inside_content?
if meth.to_sym == :define_section
opts = args.
identifier = args.first
section_mappings[identifier] ||= Brief::Document::Section::Mapping.new(identifier, opts)
section_mapping(identifier).instance_eval(&block) if block
else
content_schema.attributes[meth] = { args: args, block: block }
end
elsif inside_meta?
if args.first.is_a?(Hash)
args.unshift(String)
end
args.unshift(meth)
metadata_schema[meth] = { args: args, block: block }
else
super
end
end
|
Instance Attribute Details
#content_schema ⇒ Object
Returns the value of attribute content_schema.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def content_schema
@content_schema
end
|
#defined_actions ⇒ Object
Returns the value of attribute defined_actions.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def defined_actions
@defined_actions
end
|
#defined_helpers ⇒ Object
Returns the value of attribute defined_helpers.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def defined_helpers
@defined_helpers
end
|
#example_body ⇒ Object
Returns the value of attribute example_body.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def example_body
@example_body
end
|
Returns the value of attribute metadata_schema.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def metadata_schema
@metadata_schema
end
|
#name ⇒ Object
Returns the value of attribute name.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def name
@name
end
|
#options ⇒ Object
Returns the value of attribute options.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def options
@options
end
|
#section_mappings ⇒ Object
Returns the value of attribute section_mappings.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def section_mappings
@section_mappings
end
|
#template_body ⇒ Object
Returns the value of attribute template_body.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def template_body
@template_body
end
|
#type_alias ⇒ Object
Returns the value of attribute type_alias.
3
4
5
|
# File 'lib/brief/model/definition.rb', line 3
def type_alias
@type_alias
end
|
Instance Method Details
#actions(&block) ⇒ Object
94
95
96
97
|
# File 'lib/brief/model/definition.rb', line 94
def actions(&block)
self.defined_actions ||= []
helpers(true, &block)
end
|
#apply_config ⇒ Object
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
# File 'lib/brief/model/definition.rb', line 34
def apply_config
metadata_schema.values.each do |settings|
begin
settings[:args] = Array(settings[:args])
settings[:args][1] = String if settings[:args][1] == ''
model_class.send(:attribute, *(settings[:args]))
rescue => e
raise "Error in metadata schema definition.\n #{ settings.inspect } \n\n #{e.message}"
end
end
Array(self.defined_helpers).each { |mod| model_class.send(:include, mod) }
true
end
|
#content(_options = {}, &block) ⇒ Object
69
70
71
72
|
# File 'lib/brief/model/definition.rb', line 69
def content(_options = {}, &block)
@current = :content
instance_eval(&block)
end
|
#defined_helper_methods ⇒ Object
52
53
54
|
# File 'lib/brief/model/definition.rb', line 52
def defined_helper_methods
defined_helpers.map(&:instance_methods).flatten
end
|
#example(body = nil, _options = {}) ⇒ Object
74
75
76
77
78
79
80
|
# File 'lib/brief/model/definition.rb', line 74
def example(body = nil, _options = {})
if body.is_a?(Hash)
options = body
elsif body.is_a?(String)
self.example_body = body
end
end
|
#has_actions? ⇒ Boolean
90
91
92
|
# File 'lib/brief/model/definition.rb', line 90
def has_actions?
self.defined_actions.empty?
end
|
#helpers(include_in_command_list = false, &block) ⇒ Object
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# File 'lib/brief/model/definition.rb', line 99
def helpers(include_in_command_list=false, &block)
self.defined_helpers ||= []
if block
mod = Module.new
mod.module_eval(&block)
if include_in_command_list
self.defined_actions ||= []
self.defined_actions += mod.instance_methods
self.defined_actions.uniq!
end
self.defined_helpers << mod
end
end
|
#inside_content? ⇒ Boolean
120
121
122
|
# File 'lib/brief/model/definition.rb', line 120
def inside_content?
@current == :content
end
|
116
117
118
|
# File 'lib/brief/model/definition.rb', line 116
def inside_meta?
@current == :meta
end
|
64
65
66
67
|
# File 'lib/brief/model/definition.rb', line 64
def meta(_options = {}, &block)
@current = :meta
instance_eval(&block)
end
|
#model_class ⇒ Object
56
57
58
|
# File 'lib/brief/model/definition.rb', line 56
def model_class
@model_class || model_namespace.const_get(type_alias.camelize) rescue Brief.default_model_class
end
|
#model_namespace ⇒ Object
#section_mapping(identifier) ⇒ Object
124
125
126
|
# File 'lib/brief/model/definition.rb', line 124
def section_mapping(identifier)
section_mappings.fetch(identifier)
end
|
#template(body = nil, _options = {}) ⇒ Object
82
83
84
85
86
87
88
|
# File 'lib/brief/model/definition.rb', line 82
def template(body = nil, _options = {})
if body.is_a?(Hash)
options = body
elsif body.is_a?(String)
self.template_body = body
end
end
|
#valid? ⇒ Boolean
24
25
26
|
# File 'lib/brief/model/definition.rb', line 24
def valid?
name.to_s.length > 0 && type_alias.to_s.length > 0
end
|
#validate! ⇒ Object
28
29
30
31
32
|
# File 'lib/brief/model/definition.rb', line 28
def validate!
if valid?
apply_config
end
end
|