Class: Brief::Model::Definition

Inherits:
Object
  • Object
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.



13
14
15
16
17
18
19
20
21
 
# File 'lib/brief/model/definition.rb', line 13

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 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/brief/model/definition.rb', line 140

def method_missing(meth, *args, &block)
  args = args.dup

  if inside_content?
    if meth.to_sym == :define_section
      opts = args.extract_options!
      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_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

#metadata_schema ⇒ Object

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 



109
110
111
 
# File 'lib/brief/model/definition.rb', line 109

def actions(&block)
  helpers(&block)
end

#apply_config ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/brief/model/definition.rb', line 46

def apply_config
  # define a virtus attribute mapping
  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

  # defined helpers adds an anonymous module include
  Array(defined_helpers).each { |mod| model_class.send(:include, mod) }

  model_class.defined_actions += Array(defined_actions)
  true
end

#content(_options = {}, &block) ⇒ Object 



84
85
86
87
 
# File 'lib/brief/model/definition.rb', line 84

def content(_options = {}, &block)
  @current = :content
  instance_eval(&block)
end

#create_model_class ⇒ Object 



65
66
67
68
69
 
# File 'lib/brief/model/definition.rb', line 65

def create_model_class
  unless (model_namespace.const_get(type_alias.camelize) rescue nil)
    model_namespace.const_set(type_alias.camelize, Class.new)
  end
end

#defined_actions ⇒ Object 



113
114
115
 
# File 'lib/brief/model/definition.rb', line 113

def defined_actions
  Array(defined_helpers).map(&:instance_methods).flatten
end

#example(body = nil, _options = {}) ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/brief/model/definition.rb', line 89

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

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/brief/model/definition.rb', line 105

def has_actions?
  !@defined_actions.empty?
end

#helpers(&block) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/brief/model/definition.rb', line 117

def helpers(&block)
  self.defined_helpers ||= []

  if block
    mod = Module.new
    mod.module_eval(&block)

    self.defined_helpers << mod
  end
end

#inside_content? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/brief/model/definition.rb', line 132

def inside_content?
  @current == :content
end

#inside_meta? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/brief/model/definition.rb', line 128

def inside_meta?
  @current == :meta
end

#meta(_options = {}, &block) ⇒ Object 



79
80
81
82
 
# File 'lib/brief/model/definition.rb', line 79

def meta(_options = {}, &block)
  @current = :meta
  instance_eval(&block)
end

#model_class ⇒ Object 



71
72
73
 
# File 'lib/brief/model/definition.rb', line 71

def model_class
  @model_class || model_namespace.const_get(type_alias.camelize) rescue Brief.default_model_class
end

#model_namespace ⇒ Object 



75
76
77
 
# File 'lib/brief/model/definition.rb', line 75

def model_namespace
  Brief.configuration.model_namespace || Brief::Model
end

#section_mapping(identifier) ⇒ Object 



136
137
138
 
# File 'lib/brief/model/definition.rb', line 136

def section_mapping(identifier)
  section_mappings.fetch(identifier)
end

#template(body = nil, _options = {}) ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/brief/model/definition.rb', line 97

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

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/brief/model/definition.rb', line 23

def valid?
  name.to_s.length > 0 && type_alias.to_s.length > 0
end

#validate! ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/brief/model/definition.rb', line 27

def validate!
  definition = self

  if valid?
    create_model_class.tap do |k|
      k.send(:include, Brief::Model)

      k.definition ||= definition

      k.name ||= name
      k.type_alias ||= type_alias

      Brief::Model.classes << k
    end

    apply_config
  end
end