caracal 0.1.1 → 0.1.2

data/lib/caracal.rb

@@ -7,6 +7,7 @@ require 'tilt'
 
 # odds & ends
 require 'caracal/errors'
+require 'caracal/utilities'
 require 'caracal/version'
 
 # document

data/lib/caracal/core/file_name.rb

@@ -26,7 +26,7 @@ module Caracal
           # This method sets the name of the output file. Defaults
           # to the name of the library.
           #
-          def file_name(value = nil)
+          def file_name(value=nil)
             v = value.to_s.strip
             @name = (v == '') ? self.class::DEFAULT_FILE_NAME : v
           end

data/lib/caracal/core/fonts.rb

@@ -30,8 +30,8 @@ module Caracal
           
           #============== ATTRIBUTES ==========================
           
-          def font(opts, &block)
-            model = Caracal::Core::Models::FontModel.new(opts, &block)
+          def font(options={}, &block)
+            model = Caracal::Core::Models::FontModel.new(options, &block)
             
             if model.valid?
               register_font(model)

data/lib/caracal/core/images.rb

@@ -16,8 +16,9 @@ module Caracal
           # Public Methods
           #-------------------------------------------------------------
           
-          def img(url = nil, options={}, &block)
-            options.merge!({ url: url }) if url
+          def img(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+            options.merge!({ url: args.first }) if args.first
             
             model = Caracal::Core::Models::ImageModel.new(options, &block)
             if model.valid?

data/lib/caracal/core/list_styles.rb

@@ -19,25 +19,25 @@ module Caracal
           
           def self.default_list_styles
             [
-              { type: :ordered,   level: 0, format: 'decimal',     value: '%1.', left: 720,  line: 360  },
-              { type: :ordered,   level: 1, format: 'lowerLetter', value: '%2.', left: 1440, line: 1080 },
-              { type: :ordered,   level: 2, format: 'lowerRoman',  value: '%3.', left: 2160, line: 1800, align: :right },
-              { type: :ordered,   level: 3, format: 'decimal',     value: '%4.', left: 2880, line: 2520 },
-              { type: :ordered,   level: 4, format: 'lowerLetter', value: '%5.', left: 3600, line: 3240 },
-              { type: :ordered,   level: 5, format: 'lowerRoman',  value: '%6.', left: 4320, line: 3960, align: :right },
-              { type: :ordered,   level: 6, format: 'decimal',     value: '%7.', left: 5040, line: 4680 },
-              { type: :ordered,   level: 7, format: 'lowerLetter', value: '%8.', left: 5760, line: 5400 },
-              { type: :ordered,   level: 8, format: 'lowerRoman',  value: '%9.', left: 6480, line: 6120, align: :right },
-              
-              { type: :unordered, level: 0, format: 'bullet',      value: '●',   left: 720,  line: 360  },
-              { type: :unordered, level: 1, format: 'bullet',      value: '○',   left: 1440, line: 1080 },
-              { type: :unordered, level: 2, format: 'bullet',      value: '■',   left: 2160, line: 1800 },
-              { type: :unordered, level: 3, format: 'bullet',      value: '●',   left: 2880, line: 2520 },
-              { type: :unordered, level: 4, format: 'bullet',      value: '○',   left: 3600, line: 3240 },
-              { type: :unordered, level: 5, format: 'bullet',      value: '■',   left: 4320, line: 3960 },
-              { type: :unordered, level: 6, format: 'bullet',      value: '●',   left: 5040, line: 4680 },
-              { type: :unordered, level: 7, format: 'bullet',      value: '○',   left: 5760, line: 5400 },
-              { type: :unordered, level: 8, format: 'bullet',      value: '■',   left: 6480, line: 6120 }
+              { type: :ordered,   level: 0, format: 'decimal',     value: '%1.', left: 720,  indent: 360  },
+              { type: :ordered,   level: 1, format: 'lowerLetter', value: '%2.', left: 1440, indent: 1080 },
+              { type: :ordered,   level: 2, format: 'lowerRoman',  value: '%3.', left: 2160, indent: 1800, align: :right },
+              { type: :ordered,   level: 3, format: 'decimal',     value: '%4.', left: 2880, indent: 2520 },
+              { type: :ordered,   level: 4, format: 'lowerLetter', value: '%5.', left: 3600, indent: 3240 },
+              { type: :ordered,   level: 5, format: 'lowerRoman',  value: '%6.', left: 4320, indent: 3960, align: :right },
+              { type: :ordered,   level: 6, format: 'decimal',     value: '%7.', left: 5040, indent: 4680 },
+              { type: :ordered,   level: 7, format: 'lowerLetter', value: '%8.', left: 5760, indent: 5400 },
+              { type: :ordered,   level: 8, format: 'lowerRoman',  value: '%9.', left: 6480, indent: 6120, align: :right },
+                                                                                             
+              { type: :unordered, level: 0, format: 'bullet',      value: '●',   left: 720,  indent: 360  },
+              { type: :unordered, level: 1, format: 'bullet',      value: '○',   left: 1440, indent: 1080 },
+              { type: :unordered, level: 2, format: 'bullet',      value: '■',   left: 2160, indent: 1800 },
+              { type: :unordered, level: 3, format: 'bullet',      value: '●',   left: 2880, indent: 2520 },
+              { type: :unordered, level: 4, format: 'bullet',      value: '○',   left: 3600, indent: 3240 },
+              { type: :unordered, level: 5, format: 'bullet',      value: '■',   left: 4320, indent: 3960 },
+              { type: :unordered, level: 6, format: 'bullet',      value: '●',   left: 5040, indent: 4680 },
+              { type: :unordered, level: 7, format: 'bullet',      value: '○',   left: 5760, indent: 5400 },
+              { type: :unordered, level: 8, format: 'bullet',      value: '■',   left: 6480, indent: 6120 }
             ]           
           end
           
@@ -48,7 +48,7 @@ module Caracal
           
           #============== ATTRIBUTES ==========================
           
-          def list_style(options = {}, &block)
+          def list_style(options={}, &block)
             model = Caracal::Core::Models::ListStyleModel.new(options, &block)
             
             if model.valid?

data/lib/caracal/core/lists.rb

@@ -18,7 +18,7 @@ module Caracal
           
           #============== ATTRIBUTES ==========================
           
-          def ol(options = {}, &block)
+          def ol(options={}, &block)
             options.merge!({ type: :ordered, level: 0 })
             
             model = Caracal::Core::Models::ListModel.new(options, &block)
@@ -30,7 +30,7 @@ module Caracal
             model
           end
           
-          def ul(options = {}, &block)
+          def ul(options={}, &block)
             options.merge!({ type: :unordered, level: 0 })
             
             model = Caracal::Core::Models::ListModel.new(options, &block)

data/lib/caracal/core/models/base_model.rb

@@ -12,7 +12,7 @@ module Caracal
         #-------------------------------------------------------------
     
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           options.keep_if { |k,v| option_keys.include? k }
           options.each do |(key, value)|
             send(key, value)

data/lib/caracal/core/models/border_model.rb

@@ -29,7 +29,7 @@ module Caracal
         attr_reader :border_type
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @border_color   = DEFAULT_BORDER_COLOR
           @border_line    = DEFAULT_BORDER_LINE
           @border_size    = DEFAULT_BORDER_SIZE

data/lib/caracal/core/models/image_model.rb

@@ -34,7 +34,7 @@ module Caracal
         
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @image_width  = DEFAULT_IMAGE_WIDTH
           @image_height = DEFAULT_IMAGE_HEIGHT
           @image_align  = DEFAULT_IMAGE_ALIGN

data/lib/caracal/core/models/link_model.rb

@@ -14,6 +14,10 @@ module Caracal
         # Configuration
         #-------------------------------------------------------------
         
+        # constants
+        const_set(:DEFAULT_LINK_COLOR,      '1155cc')
+        const_set(:DEFAULT_LINK_UNDERLINE,  true) 
+        
         # readers (create aliases for superclass methods to conform 
         # to expected naming convention.)
         attr_reader  :link_href
@@ -25,6 +29,13 @@ module Caracal
         alias_method :link_italic,    :text_italic
         alias_method :link_underline, :text_underline
         
+        # initialization
+        def initialize(options={}, &block)
+          @text_color     = DEFAULT_LINK_COLOR
+          @text_underline = DEFAULT_LINK_UNDERLINE
+          
+          super options, &block
+        end
         
         
         #-------------------------------------------------------------

data/lib/caracal/core/models/list_item_model.rb

@@ -56,7 +56,7 @@ module Caracal
         #=============== SUB-METHODS ===========================
         
         # .ol
-        def ol(options = {}, &block)
+        def ol(options={}, &block)
           options.merge!({ type: :ordered, level: list_item_level + 1 })
           
           model = Caracal::Core::Models::ListModel.new(options, &block)
@@ -68,7 +68,7 @@ module Caracal
         end
         
         # .ul
-        def ul(options = {}, &block)
+        def ul(options={}, &block)
           options.merge!({ type: :unordered, level: list_item_level + 1 })
           
           model = Caracal::Core::Models::ListModel.new(options, &block)

data/lib/caracal/core/models/list_model.rb

@@ -26,7 +26,7 @@ module Caracal
         
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @list_type  = DEFAULT_LIST_TYPE
           @list_level = DEFAULT_LIST_LEVEL
           
@@ -91,8 +91,9 @@ module Caracal
         #=============== SUB-METHODS ===========================
         
         # .li
-        def li(content = nil, options = {}, &block)
-          options.merge!({ content: content }) if content
+        def li(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ content: args.first }) if args.first
           options.merge!({ type:    list_type  })
           options.merge!({ level:   list_level })
           

data/lib/caracal/core/models/list_style_model.rb

@@ -14,10 +14,10 @@ module Caracal
         # constants
         const_set(:TYPE_MAP,              { ordered: 1, unordered: 2 })
         const_set(:DEFAULT_STYLE_LEFT,    720)      # units in twips 
-        const_set(:DEFAULT_STYLE_LINE,    360)      # units in twips 
+        const_set(:DEFAULT_STYLE_INDENT,  360)      # units in twips 
         const_set(:DEFAULT_STYLE_ALIGN,   :left)
         const_set(:DEFAULT_STYLE_START,   1)
-        const_set(:DEFAULT_STYLE_RESTART, true)
+        const_set(:DEFAULT_STYLE_RESTART, 1)
         
         # accessors
         attr_reader :style_type
@@ -27,15 +27,15 @@ module Caracal
         attr_reader :style_start
         attr_reader :style_align
         attr_reader :style_left
-        attr_reader :style_line
+        attr_reader :style_indent
         attr_reader :style_restart
         
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @style_align   = DEFAULT_STYLE_ALIGN
           @style_left    = DEFAULT_STYLE_LEFT
-          @style_line    = DEFAULT_STYLE_LINE
+          @style_indent  = DEFAULT_STYLE_INDENT
           @style_start   = DEFAULT_STYLE_START
           @style_restart = DEFAULT_STYLE_RESTART
           
@@ -62,22 +62,11 @@ module Caracal
           self.class.formatted_type(style_type)
         end
         
-        def formatted_restart
-          v = style_restart ? '1' : '0'
-        end
-        
         
         #=============== SETTERS ==============================
         
-        # booleans
-        [:restart].each do |m|
-          define_method "#{ m }" do |value|
-            instance_variable_set("@style_#{ m }", !!value)
-          end
-        end
-        
         # integers
-        [:level, :left, :line, :start].each do |m|
+        [:level, :left, :indent, :start, :restart].each do |m|
           define_method "#{ m }" do |value|
             instance_variable_set("@style_#{ m }", value.to_i)
           end
@@ -119,7 +108,7 @@ module Caracal
         private
         
         def option_keys
-          [:type, :level, :format, :value, :align, :left, :line, :start]
+          [:type, :level, :format, :value, :align, :left, :indent, :start]
         end
         
       end

data/lib/caracal/core/models/margin_model.rb

@@ -28,7 +28,7 @@ module Caracal
         
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @margin_top    = DEFAULT_MARGIN_TOP
           @margin_bottom = DEFAULT_MARGIN_BOTTOM
           @margin_left   = DEFAULT_MARGIN_LEFT

data/lib/caracal/core/models/page_number_model.rb

@@ -23,7 +23,7 @@ module Caracal
         attr_reader :page_number_show
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @page_number_show  = DEFAULT_PAGE_NUMBER_SHOW
           @page_number_align = DEFAULT_PAGE_NUMBER_ALIGN
           

data/lib/caracal/core/models/page_size_model.rb

@@ -23,7 +23,7 @@ module Caracal
         attr_reader :page_height
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @page_width  = DEFAULT_PAGE_WIDTH
           @page_height = DEFAULT_PAGE_HEIGHT
           

data/lib/caracal/core/models/paragraph_model.rb

@@ -27,7 +27,7 @@ module Caracal
         attr_reader :paragraph_underline
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           if content = options.delete(:content)
             text content, options.dup
           end
@@ -93,9 +93,10 @@ module Caracal
         #=============== SUB-METHODS ===========================
         
         # .link
-        def link(content = nil, href = nil, options = {}, &block)
-          options.merge!({ content: content }) if content
-          options.merge!({ href:    href    }) if href
+        def link(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ content: args[0] }) if args[0]
+          options.merge!({ href:    args[1] }) if args[1]
           
           model = Caracal::Core::Models::LinkModel.new(options, &block)
           if model.valid?
@@ -106,8 +107,9 @@ module Caracal
         end
         
         # .text
-        def text(content = nil, options = {}, &block)
-          options.merge!({ content: content }) if content
+        def text(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ content: args.first }) if args.first
           
           model = Caracal::Core::Models::TextModel.new(options, &block)
           if model.valid?

data/lib/caracal/core/models/style_model.rb

@@ -46,7 +46,7 @@ module Caracal
     
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @style_default = false
           @style_base    = DEFAULT_STYLE_BASE
           @style_next    = DEFAULT_STYLE_NEXT

data/lib/caracal/core/models/table_cell_model.rb

@@ -25,7 +25,7 @@ module Caracal
         attr_reader :cell_margins
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @cell_background = DEFAULT_CELL_BACKGROUND
           @cell_margins    = DEFAULT_CELL_MARGINS
           
@@ -57,9 +57,9 @@ module Caracal
         #
         # In all cases, invalid options will simply be ignored.
         #
-        def apply_styles(opts = {})
+        def apply_styles(opts={})
           # make dup of options so we don't
-          # harm any siblings
+          # harm args sent to sibling cells
           options = opts.dup
           
           # first, try apply to self

data/lib/caracal/core/models/table_model.rb

@@ -38,7 +38,7 @@ module Caracal
         attr_reader :table_border_vertical    # returns border model
         
         # initialization
-        def initialize(options = {}, &block)
+        def initialize(options={}, &block)
           @table_align          = DEFAULT_TABLE_ALIGN
           @table_border_color   = DEFAULT_TABLE_BORDER_COLOR
           @table_border_line    = DEFAULT_TABLE_BORDER_LINE
@@ -94,7 +94,7 @@ module Caracal
         #   t.cell_style t.rows[0], background: '3366cc', color: 'ffffff', bold: true
         # end
         #
-        def cell_style(models, options = {})
+        def cell_style(models, options={})
           [models].flatten.each do |m|
             m.apply_styles(options)
           end  

data/lib/caracal/core/page_numbers.rb

@@ -31,10 +31,11 @@ module Caracal
           # This method controls whether and how page numbers are displayed
           # on the document.
           #
-          def page_numbers(show = nil, options = {}, &block)
-            options.merge!({ show: !!show })
-            model = Caracal::Core::Models::PageNumberModel.new(options, &block)
+          def page_numbers(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+            options.merge!({ show: !!args.first }) unless args.first.nil?  # careful: falsey value
             
+            model = Caracal::Core::Models::PageNumberModel.new(options, &block)
             if model.valid?
               @page_number_show  = model.page_number_show
               @page_number_align = model.page_number_align

data/lib/caracal/core/page_settings.rb

@@ -33,7 +33,7 @@ module Caracal
           # This method controls the physical margins of the printed page. Defaults 
           # to 1in on each side.
           #
-          def page_margins(options = {}, &block)
+          def page_margins(options={}, &block)
             model = Caracal::Core::Models::MarginModel.new(options, &block)
 
             if model.valid?
@@ -53,7 +53,7 @@ module Caracal
           # This method controls the physical width and height of the printed page. Defaults 
           # to US standard A4 portrait size.
           #
-          def page_size(options = {}, &block)
+          def page_size(options={}, &block)
             model = Caracal::Core::Models::PageSizeModel.new(options, &block)
             
             if model.valid?

data/lib/caracal/core/relationships.rb

@@ -40,7 +40,7 @@ module Caracal
           
           #============== ATTRIBUTES ==========================
           
-          def relationship(options = {}, &block)
+          def relationship(options={}, &block)
             id = relationship_counter.to_i + 1
             options.merge!({ id: id })
 

data/lib/caracal/core/rules.rb

@@ -16,7 +16,7 @@ module Caracal
           # Public Methods
           #-------------------------------------------------------------
           
-          def hr(options = {}, &block)
+          def hr(options={}, &block)
             model = Caracal::Core::Models::RuleModel.new(options, &block)
             
             if model.valid?