Module: Brief::Model::ClassMethods
- Defined in:
- lib/brief/model.rb
Instance Attribute Summary collapse
Instance Method Summary collapse
- #==(other) ⇒ Object
- #accessor_property_names ⇒ Object
- #after_initialize(&block) ⇒ Object
- #attribute_names ⇒ Object
- #content_schema_summary ⇒ Object
- #create_change_handler(_attribute, *_args, &block) ⇒ Object
- #defined_actions ⇒ Object
- #defined_in(*args) ⇒ Object
- #definition ⇒ Object
- #definition=(_value) ⇒ Object
- #documentation(*args) ⇒ Object
- #documentation_content ⇒ Object
- #documentation_path(*args) ⇒ Object
- #each(*args, &block) ⇒ Object
- #example_body(*args) ⇒ Object
- #example_content ⇒ Object
- #example_path(*args) ⇒ Object
- #finalize ⇒ Object
- #generate_template_content_from(object = {}, include_frontmatter = true) ⇒ Object
- #has_actions? ⇒ Boolean
- #metadata_schema_summary ⇒ Object
- #method_missing(meth, *args, &block) ⇒ Object
- #new_doc_name(&block) ⇒ Object
- #new_doc_template(&block) ⇒ Object
- #section_mapping(*args) ⇒ Object
- #section_mappings(*args) ⇒ Object
- #template_body(*args) ⇒ Object
- #template_content ⇒ Object
- #template_path(*args) ⇒ Object
-
#to_documentation ⇒ Object
Looks to see if there is a documentation markdown file for the model and if so, will return the documentation info as a Hash.
- #to_schema ⇒ Object
- #where(*args, &_block) ⇒ Object
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(meth, *args, &block) ⇒ Object
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/brief/model.rb', line 365 def method_missing(meth, *args, &block) # these methods have a special effect on the behavior of the # model definition. we need to make sure we call finalize after # them if %w(meta content template example actions helpers).include?(meth.to_s) definition.send(meth, *args, &block) finalize elsif %w(defined_helper_methods defined_actions).include?(meth.to_s) definition.send(meth) elsif meth.to_s.match(/^on_(.*)_change$/) create_change_handler(Regexp.last_match[1], *args, &block) else super end end |
Instance Attribute Details
#name ⇒ Object
271 272 273 |
# File 'lib/brief/model.rb', line 271 def name @name || to_s.split('::').last.underscore.gsub('_', ' ').titlecase end |
#type_alias ⇒ Object
277 278 279 |
# File 'lib/brief/model.rb', line 277 def type_alias @type_alias || name.parameterize.gsub(/-/, '_') end |
Instance Method Details
#==(other) ⇒ Object
123 124 125 |
# File 'lib/brief/model.rb', line 123 def ==(other) type_alias && type_alias == other.type_alias end |
#accessor_property_names ⇒ Object
127 128 129 |
# File 'lib/brief/model.rb', line 127 def accessor_property_names (definition.content_schema.attributes.keys + definition..keys).uniq end |
#after_initialize(&block) ⇒ Object
265 266 267 |
# File 'lib/brief/model.rb', line 265 def after_initialize(&block) (self.after_initialization_hooks ||= []).push(block) end |
#attribute_names ⇒ Object
309 310 311 |
# File 'lib/brief/model.rb', line 309 def attribute_names attribute_set.map(&:name) end |
#content_schema_summary ⇒ Object
156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/brief/model.rb', line 156 def content_schema_summary base = definition.content_schema.attributes base.keys.inject({}) do |memo, key| val = base[key] args = Array(val[:args]) first = args.first memo[key] = first if first memo end end |
#create_change_handler(_attribute, *_args, &block) ⇒ Object
381 382 383 |
# File 'lib/brief/model.rb', line 381 def create_change_handler(_attribute, *_args, &block) block.call(self) end |
#defined_actions ⇒ Object
234 235 236 |
# File 'lib/brief/model.rb', line 234 def defined_actions definition.defined_actions ||= [] end |
#defined_in(*args) ⇒ Object
346 347 348 |
# File 'lib/brief/model.rb', line 346 def defined_in(*args) definition.send(:defined_in, *args) end |
#definition ⇒ Object
281 282 283 |
# File 'lib/brief/model.rb', line 281 def definition @definition ||= Brief::Model::Definition.new(name, type_alias: type_alias, model_class: self) end |
#definition=(_value) ⇒ Object
285 286 287 |
# File 'lib/brief/model.rb', line 285 def definition=(_value) @definition end |
#documentation(*args) ⇒ Object
342 343 344 |
# File 'lib/brief/model.rb', line 342 def documentation(*args) definition.send(:documentation, *args) end |
#documentation_content ⇒ Object
202 203 204 205 206 |
# File 'lib/brief/model.rb', line 202 def documentation_content if documentation_path && documentation_path.exist? return documentation_path.read.to_s end end |
#documentation_path(*args) ⇒ Object
360 361 362 363 |
# File 'lib/brief/model.rb', line 360 def documentation_path(*args) definition.send(:documentation_path=, *args) unless args.empty? definition.send(:documentation_path) end |
#each(*args, &block) ⇒ Object
261 262 263 |
# File 'lib/brief/model.rb', line 261 def each(*args, &block) Array(models).send(:each, *args, &block) end |
#example_body(*args) ⇒ Object
318 319 320 |
# File 'lib/brief/model.rb', line 318 def example_body(*args) definition.send(:example_body, *args).to_s.strip end |
#example_content ⇒ Object
186 187 188 189 190 191 192 |
# File 'lib/brief/model.rb', line 186 def example_content if example_path && example_path.exist? return example_path.read.to_s end definition.example_body.to_s end |
#example_path(*args) ⇒ Object
355 356 357 358 |
# File 'lib/brief/model.rb', line 355 def example_path(*args) definition.send(:example_path=, *args) unless args.empty? definition.send(:example_path) end |
#finalize ⇒ Object
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/brief/model.rb', line 238 def finalize klass = self klass.name ||= klass.to_s.split('::').last.humanize klass.type_alias ||= klass.name.parameterize.gsub(/-/, '_') klass.attribute_set.map(&:name).each do |attr| unless klass.method_defined?("find_by_#{ attr }") klass.define_singleton_method("find_by_#{ attr }") do |value| where(attr => value).first end end end klass.definition.apply_config Brief::Repository.define_document_finder_methods end |
#generate_template_content_from(object = {}, include_frontmatter = true) ⇒ Object
297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/brief/model.rb', line 297 def generate_template_content_from(object={}, include_frontmatter = true) @erb ||= ERB.new(template_body) content = @erb.result(binding) frontmatter = object.slice(*attribute_names) base = '' base += frontmatter.to_hash.to_yaml + "---\n" if include_frontmatter base += content base end |
#has_actions? ⇒ Boolean
230 231 232 |
# File 'lib/brief/model.rb', line 230 def has_actions? definition.has_actions? end |
#metadata_schema_summary ⇒ Object
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/brief/model.rb', line 168 def base = definition. base.keys.inject({}) do |memo, key| val = base[key] args = Array(val[:args]) first = args.first.to_s if args.length == 1 && first == key.to_s memo[key] = "string" elsif args.length >= 2 memo[key] = args.last end memo end end |
#new_doc_name(&block) ⇒ Object
332 333 334 335 336 337 338 339 340 |
# File 'lib/brief/model.rb', line 332 def new_doc_name(&block) if block definition.new_doc_name_block = block elsif definition.new_doc_name_block definition.new_doc_name_block.call else "#{ self.type_alias }-#{ DateTime.now.strftime("%Y-%m-%d") }.md" end end |
#new_doc_template(&block) ⇒ Object
322 323 324 325 326 327 328 329 330 |
# File 'lib/brief/model.rb', line 322 def new_doc_template(&block) if block definition.new_doc_template_block = block elsif definition.new_doc_template_block definition.new_doc_template_block.call else example_content end end |
#section_mapping(*args) ⇒ Object
289 290 291 |
# File 'lib/brief/model.rb', line 289 def section_mapping(*args) definition.send(:section_mapping, *args) end |
#section_mappings(*args) ⇒ Object
293 294 295 |
# File 'lib/brief/model.rb', line 293 def section_mappings(*args) definition.send(:section_mappings, *args) end |
#template_body(*args) ⇒ Object
313 314 315 316 |
# File 'lib/brief/model.rb', line 313 def template_body(*args) res = definition.send(:template_body, *args) res.to_s.length == 0 ? example_body : res.to_s.strip end |
#template_content ⇒ Object
194 195 196 197 198 199 200 |
# File 'lib/brief/model.rb', line 194 def template_content if template_path && template_path.exist? return template_path.read.to_s end definition.template_body.to_s end |
#template_path(*args) ⇒ Object
350 351 352 353 |
# File 'lib/brief/model.rb', line 350 def template_path(*args) definition.send(:template_path=, *args) unless args.empty? definition.send(:template_path) end |
#to_documentation ⇒ Object
Looks to see if there is a documentation markdown file for the model and if so, will return the documentation info as a Hash
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/brief/model.rb', line 133 def to_documentation docs = definition.documentation path = if docs.markdown Pathname(docs.markdown) elsif defined_in basename = defined_in.basename.to_s.gsub(/.rb/,'') defined_in.parent.join('..','documentation',"#{basename}.md") end if path model_doc = Brief::Briefcase::Documentation::ModelDoc.new(path) { content: model_doc.content, rendered: model_doc.rendered, path: path } else { } end end |
#to_schema ⇒ Object
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/brief/model.rb', line 208 def to_schema { schema: { content: content_schema_summary, metadata: , }, documentation: to_documentation, defined_in: defined_in, class_name: to_s, type_alias: type_alias, name: name, group: name.to_s.pluralize, actions: defined_actions, example: example_content, template: template_content, urls: { browse_url: "browse/#{ type_alias.to_s.pluralize }", schema_url: "schema/#{ type_alias }" } } end |
#where(*args, &_block) ⇒ Object
257 258 259 |
# File 'lib/brief/model.rb', line 257 def where(*args, &_block) Brief::DocumentMapper::Query.new(self).send(:where, *args) end |