caxlsx 3.2.0 → 3.4.0

data/lib/axlsx.rb

@@ -1,185 +1,218 @@
-# encoding: UTF-8
-require 'htmlentities'
-require 'axlsx/version.rb'
-require 'marcel'
-
-require 'axlsx/util/simple_typed_list.rb'
-require 'axlsx/util/constants.rb'
-require 'axlsx/util/validators.rb'
-require 'axlsx/util/accessors.rb'
-require 'axlsx/util/serialized_attributes'
-require 'axlsx/util/options_parser'
-require 'axlsx/util/mime_type_utils'
-require 'axlsx/util/zip_command'
-
-require 'axlsx/stylesheet/styles.rb'
-
-require 'axlsx/doc_props/app.rb'
-require 'axlsx/doc_props/core.rb'
-require 'axlsx/content_type/content_type.rb'
-require 'axlsx/rels/relationships.rb'
-
-require 'axlsx/drawing/drawing.rb'
-require 'axlsx/workbook/workbook.rb'
-require 'axlsx/package.rb'
-#required gems
-require 'nokogiri'
-require 'zip'
-
-#core dependencies
-require 'bigdecimal'
-require 'time'
-
-#if object does not have this already, I am borrowing it from active_support.
-# I am a very big fan of activesupports instance_values method, but do not want to require nor include the entire
-# library just for this one method.
-if !Object.respond_to?(:instance_values)
-  Object.send :public  # patch for 1.8.7 as it uses private scope
-  Object.send :define_method, :instance_values do
-    Hash[instance_variables.map { |name| [name.to_s[1..-1], instance_variable_get(name)] }]
-  end
-end
-
-# xlsx generation with charts, images, automated column width, customizable styles
-# and full schema validation. Axlsx excels at helping you generate beautiful
-# Office Open XML Spreadsheet documents without having to understand the entire
-# ECMA specification. Check out the README for some examples of how easy it is.
-# Best of all, you can validate your xlsx file before serialization so you know
-# for sure that anything generated is going to load on your client's machine.
-module Axlsx
-
-  # determines the cell range for the items provided
-  def self.cell_range(cells, absolute=true)
-    return "" unless cells.first.is_a? Cell
-
-    first_cell, last_cell = cells.minmax_by(&:pos)
-    reference = "#{first_cell.reference(absolute)}:#{last_cell.reference(absolute)}"
-    if absolute
-      escaped_name = first_cell.row.worksheet.name.gsub ''', "''"
-      "'#{escaped_name}'!#{reference}"
-    else
-      reference
-    end
-  end
-
-  # sorts the array of cells provided to start from the minimum x,y to
-  # the maximum x.y#
-  # @param [Array] cells
-  # @return [Array]
-  def self.sort_cells(cells)
-    cells.sort_by(&:pos)
-  end
-
-  #global reference html entity encoding
-  # @return [HtmlEntities]
-  def self.coder
-    @@coder ||= ::HTMLEntities.new
-  end
-
-  # returns the x, y position of a cell
-  def self.name_to_indices(name)
-    raise ArgumentError, 'invalid cell name' unless name.size > 1
-
-    letters_str = name[/[A-Z]+/]
-
-    # capitalization?!?
-    v = letters_str.reverse.chars.reduce({:base=>1, :i=>0}) do  |val, c|
-      val[:i] += ((c.bytes.first - 64) * val[:base])
-
-      val[:base] *= 26
-
-      next val
-    end
-
-    col_index = (v[:i] - 1)
-
-    numbers_str = name[/[1-9][0-9]*/]
-
-    row_index = (numbers_str.to_i - 1)
-
-    return [col_index, row_index]
-  end
-
-  # converts the column index into alphabetical values.
-  # @note This follows the standard spreadsheet convention of naming columns A to Z, followed by AA to AZ etc.
-  # @return [String]
-  def self.col_ref(index)
-    chars = ''
-    while index >= 26 do
-      index, char = index.divmod(26)
-      chars.prepend((char + 65).chr)
-      index -= 1
-    end
-    chars.prepend((index + 65).chr)
-    chars
-  end
-
-  # @return [String] The alpha(column)numeric(row) reference for this sell.
-  # @example Relative Cell Reference
-  #   ws.rows.first.cells.first.r #=> "A1"
-  def self.cell_r(c_index, r_index)
-    col_ref(c_index) << (r_index+1).to_s
-  end
-
-  # Creates an array of individual cell references based on an excel reference range.
-  # @param [String] range A cell range, for example A1:D5
-  # @return [Array]
-  def self.range_to_a(range)
-    range.match(/^(\w+?\d+)\:(\w+?\d+)$/)
-    start_col, start_row = name_to_indices($1)
-    end_col,   end_row   = name_to_indices($2)
-    (start_row..end_row).to_a.map do |row_num|
-      (start_col..end_col).to_a.map do |col_num|
-        cell_r(col_num, row_num)
-      end
-    end
-  end
-
-  # performs the increadible feat of changing snake_case to CamelCase
-  # @param [String] s The snake case string to camelize
-  # @return [String]
-  def self.camel(s="", all_caps = true)
-    s = s.to_s
-    s = s.capitalize if all_caps
-    s.gsub(/_(.)/){ $1.upcase }
-  end
-
-  # returns the provided string with all invalid control charaters
-  # removed.
-  # @param [String] str The string to process
-  # @return [String]
-  def self.sanitize(str)
-    if str.frozen?
-      str.delete(CONTROL_CHARS)
-    else
-      str.delete!(CONTROL_CHARS)
-      str
-    end
-  end
-
-  # If value is boolean return 1 or 0
-  # else return the value
-  # @param [Object] value The value to process
-  # @return [Object]
-  def self.booleanize(value)
-    if value == true || value == false
-      value ? 1 : 0
-    else
-      value
-    end
-  end
-
-  # Instructs the serializer to not try to escape cell value input.
-  # This will give you a huge speed bonus, but if you content has <, > or other xml character data
-  # the workbook will be invalid and excel will complain.
-  def self.trust_input
-    @trust_input ||= false
-  end
-
-  # @param[Boolean] trust_me A boolean value indicating if the cell value content is to be trusted
-  # @return [Boolean]
-  # @see Axlsx::trust_input
-  def self.trust_input=(trust_me)
-    @trust_input = trust_me
-  end
-end
+require 'htmlentities'
+require 'axlsx/version.rb'
+require 'marcel'
+
+require 'axlsx/util/simple_typed_list.rb'
+require 'axlsx/util/constants.rb'
+require 'axlsx/util/validators.rb'
+require 'axlsx/util/accessors.rb'
+require 'axlsx/util/serialized_attributes'
+require 'axlsx/util/options_parser'
+require 'axlsx/util/mime_type_utils'
+require 'axlsx/util/zip_command'
+
+require 'axlsx/stylesheet/styles.rb'
+
+require 'axlsx/doc_props/app.rb'
+require 'axlsx/doc_props/core.rb'
+require 'axlsx/content_type/content_type.rb'
+require 'axlsx/rels/relationships.rb'
+
+require 'axlsx/drawing/drawing.rb'
+require 'axlsx/workbook/workbook.rb'
+require 'axlsx/package.rb'
+# required gems
+require 'nokogiri'
+require 'zip'
+
+# core dependencies
+require 'bigdecimal'
+require 'set'
+require 'time'
+
+begin
+  if Gem.loaded_specs.has_key?("axlsx_styler")
+    raise StandardError.new("Please remove `axlsx_styler` from your Gemfile, the associated functionality is now built-in to `caxlsx` directly.")
+  end
+rescue
+  # Do nothing
+end
+
+# xlsx generation with charts, images, automated column width, customizable styles
+# and full schema validation. Axlsx excels at helping you generate beautiful
+# Office Open XML Spreadsheet documents without having to understand the entire
+# ECMA specification. Check out the README for some examples of how easy it is.
+# Best of all, you can validate your xlsx file before serialization so you know
+# for sure that anything generated is going to load on your client's machine.
+module Axlsx
+  # I am a very big fan of activesupports instance_values method, but do not want to require nor include the entire
+  # library just for this one method.
+  #
+  # Defining as a class method on Axlsx to refrain from monkeypatching Object for all users of this gem.
+  def self.instance_values_for(object)
+    Hash[object.instance_variables.map { |name| [name.to_s[1..-1], object.instance_variable_get(name)] }]
+  end
+
+  # determines the cell range for the items provided
+  def self.cell_range(cells, absolute = true)
+    return "" unless cells.first.is_a? Cell
+
+    first_cell, last_cell = cells.minmax_by(&:pos)
+    reference = "#{first_cell.reference(absolute)}:#{last_cell.reference(absolute)}"
+    if absolute
+      escaped_name = first_cell.row.worksheet.name.gsub '&apos;', "''"
+      "'#{escaped_name}'!#{reference}"
+    else
+      reference
+    end
+  end
+
+  # sorts the array of cells provided to start from the minimum x,y to
+  # the maximum x.y#
+  # @param [Array] cells
+  # @return [Array]
+  def self.sort_cells(cells)
+    cells.sort_by(&:pos)
+  end
+
+  # global reference html entity encoding
+  # @return [HtmlEntities]
+  def self.coder
+    @@coder ||= ::HTMLEntities.new
+  end
+
+  # returns the x, y position of a cell
+  def self.name_to_indices(name)
+    raise ArgumentError, 'invalid cell name' unless name.size > 1
+
+    letters_str = name[/[A-Z]+/]
+
+    # capitalization?!?
+    v = letters_str.reverse.chars.reduce({ :base => 1, :i => 0 }) do |val, c|
+      val[:i] += ((c.bytes.first - 64) * val[:base])
+
+      val[:base] *= 26
+
+      next val
+    end
+
+    col_index = (v[:i] - 1)
+
+    numbers_str = name[/[1-9][0-9]*/]
+
+    row_index = (numbers_str.to_i - 1)
+
+    return [col_index, row_index]
+  end
+
+  # converts the column index into alphabetical values.
+  # @note This follows the standard spreadsheet convention of naming columns A to Z, followed by AA to AZ etc.
+  # @return [String]
+  def self.col_ref(index)
+    chars = ''
+    while index >= 26 do
+      index, char = index.divmod(26)
+      chars.prepend((char + 65).chr)
+      index -= 1
+    end
+    chars.prepend((index + 65).chr)
+    chars
+  end
+
+  # @return [String] The alpha(column)numeric(row) reference for this sell.
+  # @example Relative Cell Reference
+  #   ws.rows.first.cells.first.r #=> "A1"
+  def self.cell_r(c_index, r_index)
+    col_ref(c_index) << (r_index + 1).to_s
+  end
+
+  # Creates an array of individual cell references based on an excel reference range.
+  # @param [String] range A cell range, for example A1:D5
+  # @return [Array]
+  def self.range_to_a(range)
+    range.match(/^(\w+?\d+)\:(\w+?\d+)$/)
+    start_col, start_row = name_to_indices($1)
+    end_col,   end_row   = name_to_indices($2)
+    (start_row..end_row).to_a.map do |row_num|
+      (start_col..end_col).to_a.map do |col_num|
+        cell_r(col_num, row_num)
+      end
+    end
+  end
+
+  # performs the increadible feat of changing snake_case to CamelCase
+  # @param [String] s The snake case string to camelize
+  # @return [String]
+  def self.camel(s = "", all_caps = true)
+    s = s.to_s
+    s = s.capitalize if all_caps
+    s.gsub(/_(.)/) { $1.upcase }
+  end
+
+  # returns the provided string with all invalid control charaters
+  # removed.
+  # @param [String] str The string to process
+  # @return [String]
+  def self.sanitize(str)
+    if str.frozen?
+      str.delete(CONTROL_CHARS)
+    else
+      str.delete!(CONTROL_CHARS)
+      str
+    end
+  end
+
+  # If value is boolean return 1 or 0
+  # else return the value
+  # @param [Object] value The value to process
+  # @return [Object]
+  def self.booleanize(value)
+    if value == true || value == false
+      value ? 1 : 0
+    else
+      value
+    end
+  end
+
+  # utility method for performing a deep merge on a Hash
+  # @param [Hash] Hash to merge into
+  # @param [Hash] Hash to be added
+  def self.hash_deep_merge(first_hash, second_hash)
+    first_hash.merge(second_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        Axlsx.hash_deep_merge(this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  # Instructs the serializer to not try to escape cell value input.
+  # This will give you a huge speed bonus, but if you content has <, > or other xml character data
+  # the workbook will be invalid and excel will complain.
+  def self.trust_input
+    @trust_input ||= false
+  end
+
+  # @param[Boolean] trust_me A boolean value indicating if the cell value content is to be trusted
+  # @return [Boolean]
+  # @see Axlsx::trust_input
+  def self.trust_input=(trust_me)
+    @trust_input = trust_me
+  end
+
+  # Whether to treat values starting with an equals sign as formulas or as literal strings.
+  # Allowing user-generated data to be interpreted as formulas is a security risk.
+  # See https://www.owasp.org/index.php/CSV_Injection for details.
+  # @return [Boolean]
+  def self.escape_formulas
+    !defined?(@escape_formulas) || @escape_formulas.nil? ? false : @escape_formulas
+  end
+
+  # Sets whether to treat values starting with an equals sign as formulas or as literal strings.
+  # @param [Boolean] value The value to set.
+  def self.escape_formulas=(value)
+    Axlsx.validate_boolean(value)
+    @escape_formulas = value
+  end
+end

data/lib/caxlsx.rb

@@ -1,2 +1 @@
-# encoding: UTF-8
-require 'axlsx.rb'
+require 'axlsx.rb'

data/lib/schema/dc.xsd

@@ -1,118 +1,118 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
-           xmlns="http://purl.org/dc/elements/1.1/"
-           targetNamespace="http://purl.org/dc/elements/1.1/"
-           elementFormDefault="qualified"
-           attributeFormDefault="unqualified">
-
-  <xs:annotation>
-    <xs:documentation xml:lang="en">
-      DCMES 1.1 XML Schema
-      XML Schema for http://purl.org/dc/elements/1.1/ namespace
-
-      Created 2003-04-02
-
-      Created by
-
-      Tim Cole (t-cole3@uiuc.edu)
-      Tom Habing (thabing@uiuc.edu)
-      Jane Hunter (jane@dstc.edu.au)
-      Pete Johnston (p.johnston@ukoln.ac.uk),
-      Carl Lagoze (lagoze@cs.cornell.edu)
-
-      This schema declares XML elements for the 15 DC elements from the
-      http://purl.org/dc/elements/1.1/ namespace.
-
-      It defines a complexType SimpleLiteral which permits mixed content
-      and makes the xml:lang attribute available. It disallows child elements by
-      use of minOcccurs/maxOccurs.
-
-      However, this complexType does permit the derivation of other complexTypes
-      which would permit child elements.
-
-      All elements are declared as substitutable for the abstract element any,
-      which means that the default type for all elements is dc:SimpleLiteral.
-
-    </xs:documentation>
-
-  </xs:annotation>
-
-
-  <xs:import namespace="http://www.w3.org/XML/1998/namespace"
-             schemaLocation="xml.xsd">
-  </xs:import>
-
-  <xs:complexType name="SimpleLiteral">
-        <xs:annotation>
-        <xs:documentation xml:lang="en">
-            This is the default type for all of the DC elements.
-            It permits text content only with optional
-            xml:lang attribute.
-            Text is allowed because mixed="true", but sub-elements
-            are disallowed because minOccurs="0" and maxOccurs="0"
-            are on the xs:any tag.
-
-    	    This complexType allows for restriction or extension permitting
-            child elements.
-    	</xs:documentation>
-  	</xs:annotation>
-
-   <xs:complexContent mixed="true">
-    <xs:restriction base="xs:anyType">
-     <xs:sequence>
-      <xs:any processContents="lax" minOccurs="0" maxOccurs="0"/>
-     </xs:sequence>
-     <xs:attribute ref="xml:lang" use="optional"/>
-    </xs:restriction>
-   </xs:complexContent>
-  </xs:complexType>
-
-  <xs:element name="any" type="SimpleLiteral" abstract="true"/>
-
-  <xs:element name="title" substitutionGroup="any"/>
-  <xs:element name="creator" substitutionGroup="any"/>
-  <xs:element name="subject" substitutionGroup="any"/>
-  <xs:element name="description" substitutionGroup="any"/>
-  <xs:element name="publisher" substitutionGroup="any"/>
-  <xs:element name="contributor" substitutionGroup="any"/>
-  <xs:element name="date" substitutionGroup="any"/>
-  <xs:element name="type" substitutionGroup="any"/>
-  <xs:element name="format" substitutionGroup="any"/>
-  <xs:element name="identifier" substitutionGroup="any"/>
-  <xs:element name="source" substitutionGroup="any"/>
-  <xs:element name="language" substitutionGroup="any"/>
-  <xs:element name="relation" substitutionGroup="any"/>
-  <xs:element name="coverage" substitutionGroup="any"/>
-  <xs:element name="rights" substitutionGroup="any"/>
-
-  <xs:group name="elementsGroup">
-  	<xs:annotation>
-    	<xs:documentation xml:lang="en">
-    	    This group is included as a convenience for schema authors
-            who need to refer to all the elements in the
-            http://purl.org/dc/elements/1.1/ namespace.
-    	</xs:documentation>
-  	</xs:annotation>
-
-  <xs:sequence>
-    <xs:choice minOccurs="0" maxOccurs="unbounded">
-      <xs:element ref="any"/>
-    </xs:choice>
-    </xs:sequence>
-  </xs:group>
-
-  <xs:complexType name="elementContainer">
-  	<xs:annotation>
-    	<xs:documentation xml:lang="en">
-    		This complexType is included as a convenience for schema authors who need to define a root
-    		or container element for all of the DC elements.
-    	</xs:documentation>
-  	</xs:annotation>
-
-    <xs:choice>
-      <xs:group ref="elementsGroup"/>
-    </xs:choice>
-  </xs:complexType>
-
-
-</xs:schema>
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns="http://purl.org/dc/elements/1.1/"
+           targetNamespace="http://purl.org/dc/elements/1.1/"
+           elementFormDefault="qualified"
+           attributeFormDefault="unqualified">
+
+  <xs:annotation>
+    <xs:documentation xml:lang="en">
+      DCMES 1.1 XML Schema
+      XML Schema for http://purl.org/dc/elements/1.1/ namespace
+
+      Created 2003-04-02
+
+      Created by
+
+      Tim Cole (t-cole3@uiuc.edu)
+      Tom Habing (thabing@uiuc.edu)
+      Jane Hunter (jane@dstc.edu.au)
+      Pete Johnston (p.johnston@ukoln.ac.uk),
+      Carl Lagoze (lagoze@cs.cornell.edu)
+
+      This schema declares XML elements for the 15 DC elements from the
+      http://purl.org/dc/elements/1.1/ namespace.
+
+      It defines a complexType SimpleLiteral which permits mixed content
+      and makes the xml:lang attribute available. It disallows child elements by
+      use of minOcccurs/maxOccurs.
+
+      However, this complexType does permit the derivation of other complexTypes
+      which would permit child elements.
+
+      All elements are declared as substitutable for the abstract element any,
+      which means that the default type for all elements is dc:SimpleLiteral.
+
+    </xs:documentation>
+
+  </xs:annotation>
+
+
+  <xs:import namespace="http://www.w3.org/XML/1998/namespace"
+             schemaLocation="xml.xsd">
+  </xs:import>
+
+  <xs:complexType name="SimpleLiteral">
+        <xs:annotation>
+        <xs:documentation xml:lang="en">
+            This is the default type for all of the DC elements.
+            It permits text content only with optional
+            xml:lang attribute.
+            Text is allowed because mixed="true", but sub-elements
+            are disallowed because minOccurs="0" and maxOccurs="0"
+            are on the xs:any tag.
+
+    	    This complexType allows for restriction or extension permitting
+            child elements.
+    	</xs:documentation>
+  	</xs:annotation>
+
+   <xs:complexContent mixed="true">
+    <xs:restriction base="xs:anyType">
+     <xs:sequence>
+      <xs:any processContents="lax" minOccurs="0" maxOccurs="0"/>
+     </xs:sequence>
+     <xs:attribute ref="xml:lang" use="optional"/>
+    </xs:restriction>
+   </xs:complexContent>
+  </xs:complexType>
+
+  <xs:element name="any" type="SimpleLiteral" abstract="true"/>
+
+  <xs:element name="title" substitutionGroup="any"/>
+  <xs:element name="creator" substitutionGroup="any"/>
+  <xs:element name="subject" substitutionGroup="any"/>
+  <xs:element name="description" substitutionGroup="any"/>
+  <xs:element name="publisher" substitutionGroup="any"/>
+  <xs:element name="contributor" substitutionGroup="any"/>
+  <xs:element name="date" substitutionGroup="any"/>
+  <xs:element name="type" substitutionGroup="any"/>
+  <xs:element name="format" substitutionGroup="any"/>
+  <xs:element name="identifier" substitutionGroup="any"/>
+  <xs:element name="source" substitutionGroup="any"/>
+  <xs:element name="language" substitutionGroup="any"/>
+  <xs:element name="relation" substitutionGroup="any"/>
+  <xs:element name="coverage" substitutionGroup="any"/>
+  <xs:element name="rights" substitutionGroup="any"/>
+
+  <xs:group name="elementsGroup">
+  	<xs:annotation>
+    	<xs:documentation xml:lang="en">
+    	    This group is included as a convenience for schema authors
+            who need to refer to all the elements in the
+            http://purl.org/dc/elements/1.1/ namespace.
+    	</xs:documentation>
+  	</xs:annotation>
+
+  <xs:sequence>
+    <xs:choice minOccurs="0" maxOccurs="unbounded">
+      <xs:element ref="any"/>
+    </xs:choice>
+    </xs:sequence>
+  </xs:group>
+
+  <xs:complexType name="elementContainer">
+  	<xs:annotation>
+    	<xs:documentation xml:lang="en">
+    		This complexType is included as a convenience for schema authors who need to define a root
+    		or container element for all of the DC elements.
+    	</xs:documentation>
+  	</xs:annotation>
+
+    <xs:choice>
+      <xs:group ref="elementsGroup"/>
+    </xs:choice>
+  </xs:complexType>
+
+
+</xs:schema>