Module: Caracal::Core::Lists

Included in:
Document
Defined in:
lib/caracal/core/lists.rb

Overview

This module encapsulates all the functionality related to adding horizontal rules to the document.

Class Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/caracal/core/lists.rb', line 12

def self.included(base)
  base.class_eval do
    
    #-------------------------------------------------------------
    # Public Methods
    #-------------------------------------------------------------
    
    #============== ATTRIBUTES ==========================
    
    def ol(options={}, &block)
      options.merge!({ type: :ordered, level: 0 })
      
      model = Caracal::Core::Models::ListModel.new(options, &block)
      if model.valid?
        contents << model
      else
        raise Caracal::Errors::InvalidModelError, 'Ordered lists require at least one list item.'
      end
      model
    end
    
    def ul(options={}, &block)
      options.merge!({ type: :unordered, level: 0 })
      
      model = Caracal::Core::Models::ListModel.new(options, &block)
      if model.valid?
        contents << model
      else
        raise Caracal::Errors::InvalidModelError, 'Unordered lists require at least one list item.'
      end
      model
    end
    
    
    #============== GETTERS ==========================
    
    def toplevel_lists
      @toplevel_lists ||= []
    end
    
  end
end