Module: Caracal::Core::Rules

Included in:
Document
Defined in:
lib/caracal/core/rules.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
 
# File 'lib/caracal/core/rules.rb', line 12

def self.included(base)
  base.class_eval do
    
    #-------------------------------------------------------------
    # Public Methods
    #-------------------------------------------------------------
    
    def hr(options={}, &block)
      model = Caracal::Core::Models::RuleModel.new(options, &block)
      
      if model.valid?
        contents << model
      else
        raise Caracal::Errors::InvalidModelError, 'Horizontal rules require non-zero :size and :spacing values.'
      end
      model
    end
    
  end
end