axlsx 1.0.7 → 1.0.8

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

@@ -1,92 +0,0 @@
-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
-  # @see Worksheet#add_row
-  class Row
-
-    # The worksheet this row belongs to
-    # @return [Worksheet]
-    attr_reader :worksheet
-
-    # The cells this row holds
-    # @return [SimpleTypedList]
-    attr_reader :cells
-
-    # The index of this row in the worksheet
-    # @return [Integer]
-    attr_reader :index
-
-    # 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.
-    #   If the types option is an array, cell types are applied by index for each cell
-    #   If the types option is not set, the cell will automatically determine its type.
-    #   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.
-    #   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 
-    # @see Row#array_to_cells
-    # @see Cell
-    def initialize(worksheet, options={})
-      self.worksheet = worksheet
-      @cells = SimpleTypedList.new Cell
-      @worksheet.rows << self
-      array_to_cells(options)
-    end
-
-    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.
-    # @return [String]
-    def to_xml(xml)
-      xml.row(:r => index+1) { @cells.each { |cell| cell.to_xml(xml) } }
-    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
-      c
-    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.
-    # If value option is defined and is a symbol it is applied to all the cells created.
-    # If the value option is an array, cell types are applied by index for each cell
-    # 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 
-    def array_to_cells(options={})
-      values = options[:values] || []
-      DataTypeValidator.validate 'Row.array_to_cells', Array, values
-      types, style = options[:types], options[:style]
-      values.each_with_index do |value, index|        
-        cell_style = style.is_a?(Array) ? style[index] : style
-        cell_type = types.is_a?(Array)? types[index] : types
-        Cell.new(self, value, :style=>cell_style, :type=>cell_type) 
-      end
-    end
-  end
-  
-end

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

@@ -1,194 +0,0 @@
-# -*- coding: utf-8 -*-
-module Axlsx
-  
-  # The Worksheet class represents a worksheet in the workbook. 
-  class Worksheet
-    
-    # The name of the worksheet
-    # If not specified, it is Sheet#{index} where index is this worksheets index in the workbook's worksheet collection.
-    # @return [String]
-    attr_accessor :name
-
-    # The workbook that owns this worksheet
-    # @return [Workbook]
-    attr_reader :workbook
-
-    # The worksheet relationships. This is managed automatically by the worksheet
-    # @return [Relationships]
-    attr_reader :relationships
-
-    # The rows in this worksheet
-    # @note The recommended way to manage rows is Worksheet#add_row
-    # @return [SimpleTypedList]
-    # @see Worksheet#add_row
-    attr_reader :rows
-    
-    # The drawing associated with this worksheet.
-    # @note the recommended way to work with drawings and charts is Worksheet#add_chart
-    # @return [Drawing]
-    # @see Worksheet#add_chart
-    attr_reader :drawing
-
-    # An array of content based calculated column widths.
-    # @note a single auto fit data item is a hash with :longest => [String] and :sz=> [Integer] members.
-    # @return [Array] of Hash 
-    attr_reader :auto_fit_data
-
-    # The part name of this worksheet
-    # @return [String]
-    attr_reader :pn
-
-    # The relationship part name of this worksheet
-    # @return [String]
-    attr_reader :rels_pn
-
-    # The relationship Id of thiw worksheet
-    # @return [String]
-    attr_reader :rId
-
-    # The index of this worksheet in the owning Workbook's worksheets list.
-    # @return [Index]
-    attr_reader :index
-
-    # TODO Merge Cells
-    # attr_reader :merge_cells
-    
-    # Creates a new worksheet.
-    # @note the recommended way to manage worksheets is Workbook#add_worksheet
-    # @see Workbook#add_worksheet
-    # @option options [String] name The name of this sheet.
-    def initialize(wb, options={})
-      @rows = SimpleTypedList.new Row
-      self.workbook = wb
-      @workbook.worksheets << self
-      @auto_fit_data = []
-      self.name = options[:name] || "Sheet" + (index+1).to_s
-      @magick_draw = Magick::Draw.new
-    end
-
-    
-    def name=(v) DataTypeValidator.validate "Worksheet.name", String, v; @name=v end
-    
-    def pn
-      "#{WORKSHEET_PN % (index+1)}"
-    end
-
-    def rels_pn
-      "#{WORKSHEET_RELS_PN % (index+1)}"
-    end
-
-    def rId
-      "rId#{index+1}"
-    end
-    
-    def index
-      @workbook.worksheets.index(self)
-    end
-
-    def drawing
-      @drawing || @drawing = Axlsx::Drawing.new(self)
-    end
-
-    # Adds a row to the worksheet and updates auto fit data
-    # @return [Row]
-    # @option options [Array] values
-    # @option options [Array, Symbol] types 
-    # @option options [Array, Integer] style 
-    def add_row(options={})
-      Row.new(self, options)
-      update_auto_fit_data @rows.last.cells
-      yield @rows.last if block_given?
-      @rows.last
-    end
-
-    # Adds a chart to this worksheets drawing.
-    # @param [Class] chart_type
-    # @option options [Array] start_at
-    # @option options [Array] end_at
-    # @option options [Cell, String] title
-    def add_chart(chart_type, options={})
-      chart = drawing.add_chart(chart_type, options)
-      yield chart if block_given?
-      chart
-    end
-
-    # Serializes the worksheet document
-    # @return [String]
-    def to_xml
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.worksheet(:xmlns => XML_NS, :'xmlns:r' => XML_NS_R) {
-          if @auto_fit_data.size > 0
-            xml.cols {
-              @auto_fit_data.each_with_index do |col, index|
-                min_max = index+1
-                xml.col(:min=>min_max, :max=>min_max, :width => auto_width(col), :customWidth=>"true")
-              end
-            }
-          end
-          xml.sheetData {
-            @rows.each do |row|
-              row.to_xml(xml)
-            end
-          }
-          xml.drawing :"r:id"=>"rId1" if @drawing          
-        }
-      end
-      builder.to_xml(:indent=>0, :save_with=>0)
-    end
-
-    # The worksheet's relationships.
-    def relationships
-        r = Relationships.new
-        r << Relationship.new(DRAWING_R, "../#{@drawing.pn}") if @drawing
-        r
-    end
-
-    private 
-
-    # assigns the owner workbook for this worksheet
-    def workbook=(v) DataTypeValidator.validate "Worksheet.workbook", Workbook, v; @workbook = v; end
-
-    # Updates auto fit data. 
-    # Autofit data attempts to determine the cell in a column that has the greatest width by comparing the length of the text multiplied by the size of the font.
-    # @return [Array] of Cell objects
-    # @param [Array] cells an array of cells
-    def update_auto_fit_data(cells)
-      styles = self.workbook.styles
-      cellXfs, fonts = styles.cellXfs, styles.fonts
-      sz = fonts[0].sz
-
-      cells.each_with_index do |item, index|
-        col = @auto_fit_data[index] || {:longest=>"", :sz=>sz} 
-        cell_xf = cellXfs[item.style]
-        font = fonts[cell_xf.fontId || 0]
-        sz = font.sz || sz
-
-        if (col[:longest].scan(/./mu).size * col[:sz]) < (item.value.to_s.scan(/./mu).size * sz)
-          col[:sz] =  sz
-          col[:longest] = item.value.to_s
-        end
-        @auto_fit_data[index] = col
-      end
-      cells
-    end
-
-    # Determines the proper width for a column based on content.
-    # @note 
-    #  From ECMA docs
-    #   Column width measured as the number of characters of the maximum digit width of the numbers 0 .. 9 as 
-    #   rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
-    #   width = Truncate([{Number of Characters} * {Maximum Digit Width} + {5 pixel padding}]/{Maximum Digit Width}*256)/256
-    # @return [Float]
-    # @param [Hash] A hash of auto_fit_data 
-    def auto_width(col)
-      mdw = 6.0 # maximum digit with is always 6.0 in testable fonts so instead of beating RMagick every time, I am hardcoding it here.
-      mdw_count = 0 
-      best_guess = 1.5  #direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling
-      font_scale = col[:sz].to_f / (self.workbook.styles.fonts[0].sz.to_f || 11.0)
-      col[:longest].scan(/./mu).each do |i|
-        mdw_count +=1 if @magick_draw.get_type_metrics(i).width >= mdw 
-      end
-      ((mdw_count * mdw + 5) / mdw * 256) / 256.0 * best_guess * font_scale      
-    end   
-  end
-end

data/test/content_type/tc_content_type.rb~

@@ -1,81 +0,0 @@
-require 'test/unit'
-require 'axlsx.rb'
-
-class TestContentType < Test::Unit::TestCase
-  def setup    
-    @package = Axlsx::Package.new
-    @doc = Nokogiri::XML(@package.send(:content_types).to_xml)
-  end
-
-  def test_valid_document
-    schema = Nokogiri::XML::Schema(File.open(Axlsx::CONTENT_TYPES_XSD))
-    errors = []
-    schema.validate(@doc).each do |error|
-      puts error.message
-      errors << error
-    end
-    assert_equal(errors.size, 0, "[Content Types].xml Invalid" + errors.map{ |e| e.message }.to_s)
-  end
-
-  def test_pre_built_types
-
-    o_path = "Types Override [@ContentType='%s']"
-    d_path = "Types Default [@ContentType='%s']"
-
-    #default 
-    assert_equal(@doc.css("Types Default").size, 2, "There should be 2 default types")
-  
-    node = @doc.css(d_path % Axlsx::XML_CT).first
-    assert_equal(node["Extension"], "#{Axlsx::XML_EX}", "xml content type invalid")
-
-    node = @doc.css(d_path % Axlsx::RELS_CT).first
-    assert_equal(node["Extension"],"#{Axlsx::RELS_EX}", "relationships content type invalid")
-
-    #overrride
-    assert_equal(@doc.css("Types Override").size, 4, "There should be 4 Override types")
-
-    node = @doc.css(o_path % Axlsx::APP_CT).first
-    assert_equal(node["PartName"], "/#{Axlsx::APP_PN}", "App part name invalid")
-
-    node = @doc.css(o_path % Axlsx::CORE_CT).first
-    assert_equal(node["PartName"], "/#{Axlsx::CORE_PN}", "Core part name invalid")
-
-    node = @doc.css(o_path % Axlsx::STYLES_CT).first
-    assert_equal(node["PartName"], "/xl/#{Axlsx::STYLES_PN}", "Styles part name invalid")
-
-    node = @doc.css(o_path % Axlsx::WORKBOOK_CT).first
-    assert_equal(node["PartName"], "/#{Axlsx::WORKBOOK_PN}", "Workbook part invalid")
-  end
-
-  def test_should_get_worksheet_for_worksheets
-    o_path = "Types Override [@ContentType='%s']"
-
-    ws = @package.workbook.add_worksheet
-    doc = Nokogiri::XML(@package.send(:content_types).to_xml)
-    assert_equal(doc.css("Types Override").size, 5, "adding a worksheet should add another type")
-    assert_equal(doc.css(o_path % Axlsx::WORKSHEET_CT).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid")
-
-    ws = @package.workbook.add_worksheet
-    doc = Nokogiri::XML(@package.send(:content_types).to_xml)
-    assert_equal(doc.css("Types Override").size, 6, "adding workship should add another type")
-    assert_equal(doc.css(o_path % Axlsx::WORKSHEET_CT).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid")
-
-  end
-
-  def test_drawings_and_charts_need_content_types
-    o_path = "Types Override [@ContentType='%s']"
-    ws = @package.workbook.add_worksheet
-
-    c = ws.add_chart Axlsx::Pie3DChart
-    doc = Nokogiri::XML(@package.send(:content_types).to_xml)
-    assert_equal(doc.css("Types Override").size, 7, "expected 7 types got #{doc.css("Types Override").size}")
-    assert_equal(doc.css(o_path % Axlsx::DRAWING_CT).first["PartName"], "/xl/#{ws.drawing.pn}", "Drawing part name invlid")
-    assert_equal(doc.css(o_path % Axlsx::CHART_CT).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid")
-
-    c = ws.add_chart Axlsx::Pie3DChart
-    doc = Nokogiri::XML(@package.send(:content_types).to_xml)
-    assert_equal(doc.css("Types Override").size, 8, "expected 7 types got #{doc.css("Types Override").size}")
-    assert_equal(doc.css(o_path % Axlsx::CHART_CT).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid")
-  end
-
-end

data/test/content_type/tc_default.rb~

@@ -1,40 +0,0 @@
-require 'test/unit'
-require 'axlsx.rb'
-
-class TestDefault < Test::Unit::TestCase
-  def setup    
-  end
-  def teardown
-  end
-  def test_initialization_requires_Extension_and_ContentType
-    assert_raise(ArgumentError, "raises argument error if Extension and/or ContentType are not specified") { Axlsx::Default.new }
-    assert_raise(ArgumentError, "raises argument error if Extension and/or ContentType are not specified") { Axlsx::Default.new :Extension=>"xml" }
-    assert_raise(ArgumentError, "raises argument error if Extension and/or ContentType are not specified") { Axlsx::Default.new :ContentType=>"asdf" }
-
-    assert_nothing_raised {Axlsx::Default.new :Extension=>"foo", :ContentType=>Axlsx::XML_CT}
-
-  end
-  def test_content_type_restriction
-    assert_raise(ArgumentError, "raises argument error if invlalid ContentType is") { Axlsx::Default.new :ContentType=>"asdf" }
-  end
-  
-  def test_to_xml
-    schema = Nokogiri::XML::Schema(File.open(Axlsx::CONTENT_TYPES_XSD))
-    type = Axlsx::Default.new :Extension=>"xml", :ContentType=>Axlsx::XML_CT
-    builder = Nokogiri::XML::Builder.new(:encoding => Axlsx::ENCODING) do |xml|
-      xml.Types(:xmlns => Axlsx::XML_NS_T) {
-        type.to_xml(xml)
-      }
-    end
-    doc = Nokogiri::XML(builder.to_xml)
-    errors = []
-    schema.validate(doc).each do |error|
-      puts error.message
-      errors << error
-    end
-    assert_equal(errors.size, 0, "[Content Types].xml Invalid" + errors.map{ |e| e.message }.to_s)
-    
-  end
-
-
-end

data/test/content_type/tc_override.rb~

@@ -1,40 +0,0 @@
-require 'test/unit'
-require 'axlsx.rb'
-
-class TestOverride < Test::Unit::TestCase
-  def setup    
-  end
-  def teardown
-  end
-  def test_initialization_requires_Extension_and_ContentType
-    err = "requires PartName and ContentType options"
-    assert_raise(ArgumentError, err) { Axlsx::Override.new }
-    assert_raise(ArgumentError, err) { Axlsx::Override.new :PartName=>"xml" }
-    assert_raise(ArgumentError, err) { Axlsx::Override.new :ContentType=>"asdf" }
-    assert_nothing_raised {Axlsx::Override.new :PartName=>"foo", :ContentType=>Axlsx::CHART_CT}
-  end
-
-  def test_content_type_restriction
-    assert_raise(ArgumentError, "requires known content type") { Axlsx::Override.new :ContentType=>"asdf" }
-  end
-  
-  def test_to_xml
-    schema = Nokogiri::XML::Schema(File.open(Axlsx::CONTENT_TYPES_XSD))
-    type = Axlsx::Override.new :PartName=>"somechart.xml", :ContentType=>Axlsx::CHART_CT
-    builder = Nokogiri::XML::Builder.new(:encoding => Axlsx::ENCODING) do |xml|
-      xml.Types(:xmlns => Axlsx::XML_NS_T) {
-        type.to_xml(xml)
-      }
-    end
-    doc = Nokogiri::XML(builder.to_xml)
-    errors = []
-    schema.validate(doc).each do |error|
-      puts error.message
-      errors << error
-    end
-    assert_equal(errors.size, 0, "Override content type caused invalid content_type doc" + errors.map{ |e| e.message }.to_s)
-    
-  end
-
-
-end