axlsx 1.0.16 → 1.1.0

data/lib/axlsx/workbook/worksheet/page_margins.rb

@@ -0,0 +1,97 @@
+module Axlsx
+  # PageMargins specify the margins when printing a worksheet.
+  #
+  # For compatibility, PageMargins serialize to an empty string, unless at least one custom margin value
+  # has been specified. Otherwise, it serializes to a PageMargin element specifying all 6 margin values
+  # (using default values for margins that have not been specified explicitly).
+  #
+  # @note The recommended way to manage page margins is via Worksheet#page_margins
+  # @see Worksheet#page_margins
+  # @see Worksheet#initialize
+  class PageMargins
+
+    # Default left and right margin (in inches)
+    DEFAULT_LEFT_RIGHT = 0.75
+
+    # Default top and bottom margins (in inches)
+    DEFAULT_TOP_BOTTOM = 1.00
+
+    # Default header and footer margins (in inches)
+    DEFAULT_HEADER_FOOTER = 0.50
+
+    # Left margin (in inches)
+    # @return [Float]
+    attr_reader :left
+
+    # Right margin (in inches)
+    # @return [Float]
+    attr_reader :right
+
+    # Top margin (in inches)
+    # @return [Float]
+    attr_reader :top
+
+    # Bottom margin (in inches)
+    # @return [Float]
+    attr_reader :bottom
+
+    # Header margin (in inches)
+    # @return [Float]
+    attr_reader :header
+
+    # Footer margin (in inches)
+    # @return [Float]
+    attr_reader :footer
+
+    # Creates a new PageMargins object
+    # @option options [Numeric] left The left margin in inches
+    # @option options [Numeric] right The right margin in inches
+    # @option options [Numeric] bottom The bottom margin in inches
+    # @option options [Numeric] top The top margin in inches
+    # @option options [Numeric] header The header margin in inches
+    # @option options [Numeric] footer The footer margin in inches
+    def initialize(options={})
+      # Default values taken from MS Excel for Mac 2011
+      @left = @right = DEFAULT_LEFT_RIGHT
+      @top = @bottom = DEFAULT_TOP_BOTTOM
+      @header = @footer = DEFAULT_HEADER_FOOTER
+
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+
+    # Set some or all margins at once.
+    # @param [Hash] margins the margins to set (possible keys are :left, :right, :top, :bottom, :header and :footer).
+    def set(margins)
+      margins.select do |k, v|
+        next unless [:left, :right, :top, :bottom, :header, :footer].include? k
+        send("#{k}=", v)
+      end
+    end
+
+    # @see left
+    def left=(v); Axlsx::validate_unsigned_numeric(v); @left = v end
+    # @see right
+    def right=(v); Axlsx::validate_unsigned_numeric(v); @right = v end
+    # @see top
+    def top=(v); Axlsx::validate_unsigned_numeric(v); @top = v end
+    # @see bottom
+    def bottom=(v); Axlsx::validate_unsigned_numeric(v); @bottom = v end
+    # @see header
+    def header=(v); Axlsx::validate_unsigned_numeric(v); @header = v end
+    # @see footer
+    def footer=(v); Axlsx::validate_unsigned_numeric(v); @footer = v end
+
+    # Serializes the page margins element
+    # @param [String] str
+    # @return [String]
+    # @note For compatibility, this is a noop unless custom margins have been specified.
+    # @see #custom_margins_specified?
+    def to_xml_string(str = '')
+      str << '<pageMargins '
+      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/row.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A Row is a single row in a worksheet.
   # @note The recommended way to manage rows and cells is to use Worksheet#add_row
@@ -12,6 +13,22 @@ module Axlsx
     # @return [SimpleTypedList]
     attr_reader :cells
 
+    # The height of this row in points, if set explicitly.
+    # @return [Float]
+    attr_reader :height
+
+    # TODO  18.3.1.73
+    # collapsed
+    # customFormat
+    # hidden
+    # outlineLevel
+    # ph
+    # s (style)
+    # spans
+    # thickTop
+    # thickBottom
+
+
     # Creates a new row. New Cell objects are created based on the values, types and style options.
     # A new cell is created for each item in the values array. style and types options are applied as follows:
     #   If the types option is defined and is a symbol it is applied to all the cells created.
@@ -22,38 +39,50 @@ module Axlsx
     #   If the style option is not defined, the default style (0) is applied to each cell.
     # @param [Worksheet] worksheet
     # @option options [Array] values
-    # @option options [Array, Symbol] types 
-    # @option options [Array, Integer] style 
+    # @option options [Array, Symbol] types
+    # @option options [Array, Integer] style
+    # @option options [Float] height the row's height (in points)
     # @see Row#array_to_cells
     # @see Cell
     def initialize(worksheet, values=[], options={})
+      @height = nil
       self.worksheet = worksheet
       @cells = SimpleTypedList.new Cell
       @worksheet.rows << self
+      self.height = options.delete(:height) if options[:height]
       array_to_cells(values, options)
     end
 
     # The index of this row in the worksheet
     # @return [Integer]
-    def index 
+    def index
       worksheet.rows.index(self)
     end
-    
+
     # Serializes the row
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @param [Integer] r_index The row index, 0 based.
+    # @param [String] str The string this rows xml will be appended to.
     # @return [String]
-    def to_xml(xml)
-      xml.row(:r => index+1) { @cells.each { |cell| cell.to_xml(xml) } }
+    def to_xml_string(r_index, str = '')
+      str << '<row r="' << (r_index + 1 ).to_s << '" '
+      if custom_height?
+        str << 'customHeight="1" ht="' << height.to_s << '">'
+      else
+        str << '>'
+      end
+      @cells.each_with_index { |cell, c_index| cell.to_xml_string(r_index, c_index, str) }
+      str << '</row>'
+      str
     end
 
     # Adds a singel sell to the row based on the data provided and updates the worksheet's autofit data.
     # @return [Cell]
     def add_cell(value="", options={})
       c = Cell.new(self, value, options)
-      update_auto_fit_data
+      worksheet.send(:update_column_info, self.cells, self.cells.map(&:style))
       c
     end
-    
+
     # sets the style for every cell in this row
     def style=(style)
       cells.each_with_index do | cell, index |
@@ -63,23 +92,26 @@ module Axlsx
     end
 
     # returns the cells in this row as an array
-    # This lets us transpose the rows into columns 
+    # This lets us transpose the rows into columns
     # @return [Array]
     def to_ary
       @cells.to_ary
     end
 
+    # @see height
+    def height=(v); Axlsx::validate_unsigned_numeric(v) unless v.nil?; @height = v end
+
+    # true if the row height has been manually set
+    # @return [Boolean]
+    # @see #height
+    def custom_height?
+      @height != nil
+    end
+
     private
 
     # assigns the owning worksheet for this row
     def worksheet=(v) DataTypeValidator.validate "Row.worksheet", Worksheet, v; @worksheet=v; end
-    
-    # Tell the worksheet to update autofit data for the columns based on this row's cells.
-    # @return [SimpleTypedList]
-    def update_auto_fit_data
-      worksheet.send(:update_auto_fit_data, self.cells)
-    end
-
 
     # Converts values, types, and style options into cells and associates them with this row.
     # A new cell is created for each item in the values array.
@@ -88,13 +120,13 @@ module Axlsx
     # If the style option is defined and is an Integer, it is applied to all cells created.
     # If the style option is an array, style is applied by index for each cell.
     # @option options [Array] values
-    # @option options [Array, Symbol] types 
-    # @option options [Array, Integer] style 
+    # @option options [Array, Symbol] types
+    # @option options [Array, Integer] style
     def array_to_cells(values, options={})
       values = values
       DataTypeValidator.validate 'Row.array_to_cells', Array, values
       types, style = options.delete(:types), options.delete(:style)
-      values.each_with_index do |value, index|        
+      values.each_with_index do |value, index|
         cell_style = style.is_a?(Array) ? style[index] : style
         options[:style] = cell_style if cell_style
         cell_type = types.is_a?(Array)? types[index] : types
@@ -103,5 +135,5 @@ module Axlsx
       end
     end
   end
-  
+
 end

data/lib/axlsx/workbook/worksheet/table.rb

@@ -0,0 +1,96 @@
+# encoding: UTF-8
+module Axlsx
+  # Table
+  # @note Worksheet#add_table is the recommended way to create tables for your worksheets.
+  # @see README for examples
+  class Table
+
+
+    # The reference to the table data
+    # @return [String]
+    attr_reader :ref
+
+    # The name of the table.
+    # @return [String]
+    attr_reader :name
+
+    # The style for the table.
+    # @return [TableStyle]
+    attr_reader :style
+
+    # Creates a new Table object
+    # @param [String] ref The reference to the table data.
+    # @param [Sheet] ref The sheet containing the table data.
+    # @option options [Cell, String] name
+    # @option options [TableStyle] style
+    def initialize(ref, sheet, options={})
+      @ref = ref
+      @sheet = sheet
+      @style = nil
+      @sheet.workbook.tables << self
+      @name = "Table#{index+1}"
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      yield self if block_given?
+    end
+
+    # The index of this chart in the workbooks charts collection
+    # @return [Integer]
+    def index
+      @sheet.workbook.tables.index(self)
+    end
+
+    # The part name for this table
+    # @return [String]
+    def pn
+      "#{TABLE_PN % (index+1)}"
+    end
+
+    # The relation reference id for this table
+    # @return [String]
+    def rId
+      "rId#{index+1}"
+    end
+
+    # The name of the Table.
+    # @param [String, Cell] v
+    # @return [Title]
+    def name=(v)
+      DataTypeValidator.validate "#{self.class}.name", [String], v
+      if v.is_a?(String)
+        @name = v
+      end
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<table xmlns="' << XML_NS << '" id="' << (index+1).to_s << '" name="' << @name << '" displayName="' << @name.gsub(/\s/,'_') << '" '
+      str << 'ref="' << @ref << '" totalsRowShown="0">'
+      str << '<autoFilter ref="' << @ref << '"/>'
+      str << '<tableColumns count="' << header_cells.length.to_s << '">'
+      header_cells.each_with_index do |cell,index|
+        str << '<tableColumn id ="' << (index+1).to_s << '" name="' << cell.value << '"/>'
+      end
+      str << '</tableColumns>'
+      #TODO implement tableStyleInfo
+      str << '<tableStyleInfo showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0" name="TableStyleMedium9" />'
+      str << '</table>'
+    end
+
+    # The style for the table.
+    # TODO
+    # def style=(v) DataTypeValidator.validate "Table.style", Integer, v, lambda { |arg| arg >= 1 && arg <= 48 }; @style = v; end
+
+    private
+
+    # get the header cells (hackish)
+    def header_cells
+      header = @ref.gsub(/^(\w+)(\d+)\:(\w+)\d+$/, '\1\2:\3\2')
+      @sheet[header]
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/table.rb~

@@ -0,0 +1,97 @@
+# encoding: UTF-8
+module Axlsx
+  # Table
+  # @note Worksheet#add_table is the recommended way to create charts for your worksheets.
+  # @see README for examples
+  class Table
+
+
+    # The reference to the table data
+    # @return [String]
+    attr_reader :ref
+
+    # The name of the table.
+    # @return [String]
+    attr_reader :name
+
+    # The style for the table. 
+    # @return [TableStyle]
+    attr_reader :style
+   
+    # Creates a new Table object
+    # @param [String] ref The reference to the table data.
+    # @param [Sheet] ref The sheet containing the table data.
+    # @option options [Cell, String] name
+    # @option options [TableStyle] style
+    def initialize(ref, sheet, options={})
+      @ref = ref
+      @sheet = sheet
+      @style = nil
+      @sheet.workbook.tables << self
+      @name = "Table#{index+1}"
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      yield self if block_given?
+    end
+
+    # The index of this chart in the workbooks charts collection
+    # @return [Integer]
+    def index
+      @sheet.workbook.tables.index(self)
+    end
+
+    # The part name for this table
+    # @return [String]
+    def pn
+      "#{TABLE_PN % (index+1)}"
+    end
+    
+    # The relation reference id for this table
+    # @return [String]
+    def rId
+      "rId#{index+1}"
+    end
+
+    # The name of the Table.
+    # @param [String, Cell] v
+    # @return [Title]
+    def name=(v) 
+      DataTypeValidator.validate "#{self.class}.name", [String], v
+      if v.is_a?(String)
+        @name = v
+      end
+    end
+
+    
+    # The style for the table.
+    # TODO 
+    # def style=(v) DataTypeValidator.validate "Chart.style", Integer, v, lambda { |arg| arg >= 1 && arg <= 48 }; @style = v; end
+
+    # Table Serialization
+    # serializes the table
+    def to_xml
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.table(:xmlns => XML_NS, :id => index+1, :name => @name, :displayName => @name.gsub(/\s/,'_'), :ref => @ref, :totalsRowShown => 0) {
+          xml.autoFilter :ref=>@ref 
+          xml.tableColumns(:count => header_cells.length) {
+            header_cells.each_with_index do |cell,index|
+              xml.tableColumn :id => index+1, :name => cell.value
+            end
+          }
+          xml.tableStyleInfo :showFirstColumn=>"0", :showLastColumn=>"0", :showRowStripes=>"1", :showColumnStripes=>"0", :name=>"TableStyleMedium9"
+          #TODO implement tableStyleInfo
+        }
+      end
+      builder.to_xml(:save_with => 0)
+    end
+
+    private
+    
+    # get the header cells (hackish)
+    def header_cells 
+      header = @ref.gsub(/^(\w+)(\d+)\:(\w+)\d+$/, '\1\2:\3\2')
+      @sheet[header]
+    end
+  end
+end