axlsx 2.1.0.pre → 3.0.0.pre

data/lib/axlsx/rels/relationships.rb

@@ -10,14 +10,17 @@ require 'axlsx/rels/relationship.rb'
     def initialize
       super Relationship
     end
-    
+
     # The relationship instance for the given source object, or nil if none exists.
     # @see Relationship#source_obj
     # @return [Relationship]
     def for(source_obj)
       find{ |rel| rel.source_obj == source_obj }
     end
-    
+
+    # serialize relationships
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
       str << ('<Relationships xmlns="' << RELS_R << '">')

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -73,5 +73,14 @@ module Axlsx
       serialized_tag('numFmt', str)
     end
 
+    # Override to avoid removing underscores
+    def serialized_attributes(str = '', additional_attributes = {})
+      attributes = declared_attributes.merge! additional_attributes
+      attributes.each do |key, value|
+        str << "#{Axlsx.camel(key, false)}=\"#{Axlsx.booleanize(value)}\" "
+      end
+      str
+    end
+
   end
 end

data/lib/axlsx/stylesheet/styles.rb

@@ -128,7 +128,7 @@ module Axlsx
     # @option options [Boolean] i Indicates if the text should be italicised
     # @option options [Boolean] u Indicates if the text should be underlined
     # @option options [Boolean] strike Indicates if the text should be rendered with a strikethrough
-    # @option options [Boolean] strike Indicates if the text should be rendered with a shadow
+    # @option options [Boolean] shadow Indicates if the text should be rendered with a shadow
     # @option options [Integer] charset The character set to use.
     # @option options [Integer] family The font family to use.
     # @option options [String] font_name The name of the font to use

data/lib/axlsx/util/constants.rb

@@ -67,7 +67,7 @@ module Axlsx
   APP_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties".freeze
 
   # core rels namespace
-  CORE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/metadata/core-properties".freeze
+  CORE_R = "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties".freeze
 
   # digital signature rels namespace
   DIGITAL_SIGNATURE_R = "http://schemas.openxmlformats.org/package/2006/relationships/digital- signature/signature".freeze
@@ -385,13 +385,16 @@ module Axlsx
   # @see http://www.codetable.net/asciikeycodes
   pattern = "\x0-\x08\x0B\x0C\x0E-\x1F"
   pattern = pattern.respond_to?(:encode) ? pattern.encode('UTF-8') : pattern
-  
+
   # The regular expression used to remove control characters from worksheets
   CONTROL_CHARS = pattern.freeze
-  
+
+  # ISO 8601 date recognition
   ISO_8601_REGEX = /\A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z/.freeze
-  
+
+  # FLOAT recognition
   FLOAT_REGEX = /\A[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?\Z/.freeze
-  
+
+  # Numeric recognition
   NUMERIC_REGEX = /\A[+-]?\d+?\Z/.freeze
 end

data/lib/axlsx/util/mime_type_utils.rb

@@ -0,0 +1,11 @@
+module Axlsx
+  # This module defines some utils related with mime type detection
+  module MimeTypeUtils
+    # Detect a file mime type
+    # @param [String] v File path
+    # @return [String] File mime type
+    def self.get_mime_type(v)
+      MimeMagic.by_magic(File.open(v)).to_s
+    end
+  end
+end

data/lib/axlsx/util/simple_typed_list.rb

@@ -147,7 +147,7 @@ module Axlsx
     # determines if the index is protected
     # @param [Integer] index
     def protected? index
-      return false unless locked_at.is_a? Fixnum
+      return false unless locked_at.is_a? Integer
       index < locked_at
     end
 

data/lib/axlsx/util/validators.rb

@@ -56,13 +56,13 @@ module Axlsx
          raise ArgumentError, (ERR_TYPE % [v.inspect, name, types.inspect]) unless other.call(v)
       end
       v_class = v.is_a?(Class) ? v : v.class
-      Array(types).each do |t| 
+      Array(types).each do |t|
         return if v_class <= t
       end
       raise ArgumentError, (ERR_TYPE % [v.inspect, name, types.inspect])
     end
   end
-  
+
 
   # Requires that the value can be converted to an integer
   # @para, [Any] v the value to validate
@@ -78,18 +78,19 @@ module Axlsx
   def self.validate_angle(v)
     raise ArgumentError, (ERR_ANGLE % v.inspect) unless (v.to_i >= -5400000 && v.to_i <= 5400000)
   end
-  
+
+  # Validates an unsigned intger
   UINT_VALIDATOR = lambda { |arg| arg.respond_to?(:>=) && arg >= 0 }
-  
-  # Requires that the value is a Fixnum or Integer and is greater or equal to 0
+
+  # Requires that the value is a Integer and is greater or equal to 0
   # @param [Any] v The value validated
-  # @raise [ArgumentError] raised if the value is not a Fixnum or Integer value greater or equal to 0
+  # @raise [ArgumentError] raised if the value is not a Integer value greater or equal to 0
   # @return [Boolean] true if the data is valid
   def self.validate_unsigned_int(v)
     DataTypeValidator.validate(:unsigned_int, Integer, v, UINT_VALIDATOR)
   end
 
-  # Requires that the value is a Fixnum Integer or Float and is greater or equal to 0
+  # Requires that the value is a Integer or Float and is greater or equal to 0
   # @param [Any] v The value validated
   # @raise [ArgumentError] raised if the value is not a Fixnun, Integer, Float value greater or equal to 0
   # @return [Boolean] true if the data is valid
@@ -104,7 +105,7 @@ module Axlsx
   end
 
   # Requires that the value is a form that can be evaluated as a boolean in an xml document.
-  # The value must be an instance of Fixnum, String, Integer, Symbol, TrueClass or FalseClass and
+  # The value must be an instance of String, Integer, Symbol, TrueClass or FalseClass and
   # it must be one of 0, 1, "true", "false", :true, :false, true, false, "0", or "1"
   # @param [Any] v The value validated
   def self.validate_boolean(v)
@@ -148,7 +149,7 @@ module Axlsx
     RestrictionValidator.validate "cell run style u", [:none, :single, :double, :singleAccounting, :doubleAccounting], v
   end
 
-  # validates cell style family which must be between 1 and 5 
+  # validates cell style family which must be between 1 and 5
   def self.validate_family(v)
     RestrictionValidator.validate "cell run style family", 1..5, v
   end
@@ -304,4 +305,8 @@ module Axlsx
     RestrictionValidator.validate :visibility, [:visible, :hidden, :very_hidden], v
   end
 
+  # Requires that the value is one of :default, :circle, :dash, :diamond, :dot, :picture, :plus, :square, :star, :triangle, :x
+  def self.validate_marker_symbol(v)
+    RestrictionValidator.validate :marker_symbol, [:default, :circle, :dash, :diamond, :dot, :picture, :plus, :square, :star, :triangle, :x], v
+  end
 end

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 module Axlsx
 
   # The current version
-  VERSION = "2.1.0.pre"
+  VERSION = "3.0.0.pre"
 end

data/lib/axlsx/workbook/workbook.rb

@@ -11,6 +11,7 @@ require 'axlsx/workbook/worksheet/cell_serializer.rb'
 require 'axlsx/workbook/worksheet/cell.rb'
 require 'axlsx/workbook/worksheet/page_margins.rb'
 require 'axlsx/workbook/worksheet/page_set_up_pr.rb'
+require 'axlsx/workbook/worksheet/outline_pr.rb'
 require 'axlsx/workbook/worksheet/page_setup.rb'
 require 'axlsx/workbook/worksheet/header_footer.rb'
 require 'axlsx/workbook/worksheet/print_options.rb'
@@ -96,6 +97,15 @@ require 'axlsx/workbook/worksheet/selection.rb'
       @use_shared_strings = v
     end
 
+    # If true reverse the order in which the workbook is serialized
+    # @return [Boolean]
+    attr_reader :is_reversed
+
+    def is_reversed=(v)
+      Axlsx::validate_boolean(v)
+      @is_reversed = v
+    end
+
 
    # A collection of worksheets associated with this workbook.
     # @note The recommended way to manage worksheets is add_worksheet
@@ -270,6 +280,10 @@ require 'axlsx/workbook/worksheet/selection.rb'
       worksheet
     end
 
+    # Adds a new WorkbookView
+    # @return WorkbookViews
+    # @option options [Hash] options passed into the added WorkbookView
+    # @see WorkbookView#initialize
     def add_view(options={})
       views << WorkbookView.new(options)
     end
@@ -344,7 +358,11 @@ require 'axlsx/workbook/worksheet/selection.rb'
       str << ('<workbookPr date1904="' << @@date1904.to_s << '"/>')
       views.to_xml_string(str)
       str << '<sheets>'
-      worksheets.each { |sheet| sheet.to_sheet_node_xml_string(str) }
+      if is_reversed
+        worksheets.reverse_each { |sheet| sheet.to_sheet_node_xml_string(str) }
+      else
+        worksheets.each { |sheet| sheet.to_sheet_node_xml_string(str) }
+      end
       str << '</sheets>'
       defined_names.to_xml_string(str)
       unless pivot_tables.empty?

data/lib/axlsx/workbook/workbook_view.rb

@@ -33,7 +33,7 @@ module Axlsx
 
 
     # Creates a new BookView object
-    # @params [Hash] options  A hash of key/value pairs that will be mapped to this instances attributes.
+    # @param [Hash] options  A hash of key/value pairs that will be mapped to this instances attributes.
     # @option [Symbol] visibility Specifies visible state of the workbook window. The default value for this attribute is :visible.
     # @option [Boolean] minimized Specifies a boolean value that indicates whether the workbook window is minimized.
     # @option [Boolean] show_horizontal_scroll Specifies a boolean value that indicates whether to display the horizontal scroll bar in the user interface.
@@ -41,7 +41,7 @@ module Axlsx
     # @option [Boolean] show_sheet_tabs Specifies a boolean value that indicates whether to display the sheet tabs in the user interface.
     # @option [Integer] tab_ratio Specifies ratio between the workbook tabs bar and the horizontal scroll bar.
     # @option [Integer] first_sheet Specifies the index to the first sheet in this book view.
-    # @option [Integer] active_tab Specifies an unsignedInt that contains the index to the active sheet in this book view. 
+    # @option [Integer] active_tab Specifies an unsignedInt that contains the index to the active sheet in this book view.
     # @option [Integer] x_window Specifies the X coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
     # @option [Integer] y_window Specifies the Y coordinate for the upper left corner of the workbook window. The unit of measurement for this value is twips.
     # @option [Integer] window_width Specifies the width of the workbook window. The unit of measurement for this value is twips.
@@ -68,7 +68,9 @@ module Axlsx
                           :show_sheet_tabs, :auto_filter_date_grouping
 
 
-
+    # Serialize the WorkbookView
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = '')
        str << '<workbookView '
        serialized_attributes str

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

@@ -37,14 +37,14 @@ module Axlsx
       # to get less GC cycles
       type = options.delete(:type) || cell_type_from_value(value)
       self.type = type unless type == :string
-      
+
 
       val = options.delete(:style)
       self.style = val unless val.nil? || val == 0
       val = options.delete(:formula_value)
       self.formula_value = val unless val.nil?
-      
-      parse_options(options) 
+
+      parse_options(options)
 
       self.value = value
       value.cell = self if contains_rich_text?
@@ -64,9 +64,10 @@ module Axlsx
                      :family, :b, :i, :strike, :outline,
                      :shadow, :condense, :extend, :u,
                      :vertAlign, :sz, :color, :scheme].freeze
-                     
+
+    # An array of valid cell types
     CELL_TYPES = [:date, :time, :float, :integer, :richtext,
-                  :string, :boolean, :iso_8601].freeze
+                  :string, :boolean, :iso_8601, :text].freeze
 
     # The index of the cellXfs item to be applied to this cell.
     # @return [Integer]
@@ -79,7 +80,7 @@ module Axlsx
     # @return [Row]
     attr_reader :row
 
-    # The cell's data type. Currently only six types are supported, :date, :time, :float, :integer, :string and :boolean.
+    # The cell's data type.
     # Changing the type for a cell will recast the value into that type. If no type option is specified in the constructor, the type is
     # automatically determed.
     # @see Cell#cell_type_from_value
@@ -93,7 +94,7 @@ module Axlsx
     def type
       defined?(@type) ? @type : :string
     end
-    
+
     # @see type
     def type=(v)
       RestrictionValidator.validate :cell_type, CELL_TYPES, v
@@ -104,7 +105,7 @@ module Axlsx
     # The value of this cell.
     # @return [String, Integer, Float, Time, Boolean] casted value based on cell's type attribute.
     attr_reader :value
-    
+
     # @see value
     def value=(v)
       #TODO: consider doing value based type determination first?
@@ -115,15 +116,15 @@ module Axlsx
     # @return [Boolean]
     def is_text_run?
       defined?(@is_text_run) && @is_text_run && !contains_rich_text?
-    end 
-    
+    end
+
     def contains_rich_text?
       type == :richtext
     end
-    
+
     # Indicates if the cell is good for shared string table
     def plain_string?
-      type == :string &&         # String typed
+      (type == :string || type == :text) &&         # String typed
         !is_text_run? &&          # No inline styles
         !@value.nil? &&           # Not nil
         !@value.empty? &&         # Not empty
@@ -347,7 +348,9 @@ module Axlsx
 
     # returns the name of the cell
     attr_reader :name
-    
+
+    # Attempts to determine the correct width for this cell's content
+    # @return [Float]
     def autowidth
       return if is_formula? || value.nil?
       if contains_rich_text?
@@ -363,12 +366,12 @@ module Axlsx
         string_width(value, font_size)
       end
     end
-    
+
     # Returns the sanatized value
     # TODO find a better way to do this as it accounts for 30% of
     # processing time in benchmarking...
     def clean_value
-      if type == :string && !Axlsx::trust_input
+      if (type == :string || type == :text) && !Axlsx::trust_input
         Axlsx::sanitize(::CGI.escapeHTML(@value.to_s))
       else
         @value.to_s
@@ -376,17 +379,17 @@ module Axlsx
     end
 
     private
-    
+
     def styles
       row.worksheet.styles
     end
-    
+
     # Returns the width of a string according to the current style
     # This is still not perfect...
     #  - scaling is not linear as font sizes increase
     def string_width(string, font_size)
       font_scale = font_size / 10.0
-      (string.to_s.count(Worksheet::THIN_CHARS) + 3.0) * (font_size/10.0)
+      (string.to_s.count(Worksheet::THIN_CHARS) + 3.0) * font_scale
     end
 
     # we scale the font size if bold style is applied to either the style font or
@@ -452,7 +455,11 @@ module Axlsx
         v
       when :time
         self.style = STYLE_DATE if self.style == 0
-        v.respond_to?(:to_time) ? v.to_time : v
+        if !v.is_a?(Time) && v.respond_to?(:to_time)
+          v.to_time
+        else
+          v
+        end
       when :float
         v.to_f
       when :integer

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

@@ -14,7 +14,7 @@ module Axlsx
         method = cell.type
         self.send(method, cell, str)
         str << '</c>'
-      end 
+      end
 
       # builds an xml text run based on this cells attributes.
       # @param [String] str The string instance this run will be concated to.
@@ -22,7 +22,7 @@ module Axlsx
       def run_xml_string(cell, str = '')
         if cell.is_text_run?
           valid = RichTextRun::INLINE_STYLES - [:value, :type]
-          data = Hash[cell.instance_values.map{ |k, v| [k.to_sym, v] }] 
+          data = Hash[cell.instance_values.map{ |k, v| [k.to_sym, v] }]
           data = data.select { |key, value| valid.include?(key) && !value.nil? }
           RichText.new(cell.value.to_s, data).to_xml_string(str)
         elsif cell.contains_rich_text?
@@ -124,7 +124,7 @@ module Axlsx
           inline_string_serialization cell, str
         end
       end
-      
+
       # Serializes cells that are of the type richtext
       # @param [Cell] cell The cell that is being serialized
       # @param [String] str The string the serialized content will be appended to.
@@ -137,6 +137,18 @@ module Axlsx
         end
       end
 
+      # Serializes cells that are of the type text
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def text(cell, str)
+        if cell.ssti.nil?
+          inline_string_serialization cell, str
+        else
+          value_serialization 's', cell.ssti, str
+        end
+      end
+
       private
 
       def numeric(cell, str = '')
@@ -147,8 +159,6 @@ module Axlsx
         str << ('t="' << serialization_type.to_s << '"') if serialization_type
         str << ('><v>' << serialization_value.to_s << '</v>')
       end
-
-
     end
   end
 end

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

@@ -8,6 +8,9 @@ module Axlsx
       super(Cfvo)
     end
 
+    # Serialize the Cfvo object
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str='')
       each { |cfvo| cfvo.to_xml_string(str) }
     end

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

@@ -1,6 +1,6 @@
 module Axlsx
 
-  # The cols class manages the col object used to manage column widths. 
+  # The cols class manages the col object used to manage column widths.
   # This is where the magic happens with autowidth
   class Cols < SimpleTypedList
 
@@ -10,11 +10,14 @@ module Axlsx
       @worksheet = worksheet
     end
 
+    # Serialize the Cols object
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = '')
      return if empty?
      str << '<cols>'
      each { |item| item.to_xml_string(str) }
-     str << '</cols>' 
+     str << '</cols>'
     end
   end
 end