caxlsx 3.3.0 → 3.4.0

data/lib/axlsx/util/accessors.rb

@@ -14,7 +14,6 @@ module Axlsx
 
     # Defines the class level xxx_attr_accessor methods
     module ClassMethods
-
       # Creates one or more string validated attr_accessors
       # @param [Array] symbols An array of symbols representing the
       # names of the attributes you will add to your class.
@@ -22,7 +21,6 @@ module Axlsx
         validated_attr_accessor(symbols, :validate_string)
       end
 
-
       # Creates one or more usigned integer attr_accessors
       # @param [Array] symbols An array of symbols representing the
       # names of the attributes you will add to your class
@@ -51,14 +49,14 @@ module Axlsx
       # @param [Array] symbols The names of the attributes to create
       # @param [String] validator The axlsx validation method to use when
       # validating assignation.
-      # @see lib/axlsx/util/validators.rb 
+      # @see lib/axlsx/util/validators.rb
       def validated_attr_accessor(symbols, validator)
         symbols.each do |symbol|
           attr_reader symbol
+
           module_eval(SETTER % [symbol, validator, symbol], __FILE__, __LINE__)
         end
       end
     end
   end
 end
-

data/lib/axlsx/util/constants.rb

@@ -1,5 +1,4 @@
 module Axlsx
-
   # XML Encoding
   ENCODING = "UTF-8".freeze
 
@@ -96,7 +95,7 @@ module Axlsx
   # comment relation for nil target
   COMMENT_R_NULL = "http://purl.oclc.org/ooxml/officeDocument/relationships/comments".freeze
 
-  #vml drawing relation namespace
+  # vml drawing relation namespace
   VML_DRAWING_R = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing'
 
   # VML Drawing content type
@@ -159,10 +158,9 @@ module Axlsx
   # png content type
   PNG_CT = "image/png".freeze
 
-  #drawing content type
+  # drawing content type
   DRAWING_CT = "application/vnd.openxmlformats-officedocument.drawing+xml".freeze
 
-
   # xml content type extensions
   XML_EX = "xml".freeze
 
@@ -239,7 +237,7 @@ module Axlsx
   COMMENT_PN = "comments%d.xml".freeze
 
   # location of schema files for validation
-  SCHEMA_BASE = (File.dirname(__FILE__)+'/../../schema/').freeze
+  SCHEMA_BASE = (File.dirname(__FILE__) + '/../../schema/').freeze
 
   # App validation schema
   APP_XSD = (SCHEMA_BASE + "shared-documentPropertiesExtended.xsd").freeze

data/lib/axlsx/util/mime_type_utils.rb

@@ -1,3 +1,5 @@
+require 'open-uri'
+
 module Axlsx
   # This module defines some utils related with mime type detection
   module MimeTypeUtils
@@ -7,5 +9,16 @@ module Axlsx
     def self.get_mime_type(v)
       Marcel::MimeType.for(Pathname.new(v))
     end
+
+    # Detect a file mime type from URI
+    # @param [String] v URI
+    # @return [String] File mime type
+    def self.get_mime_type_from_uri(v)
+      if URI.respond_to?(:open)
+        Marcel::MimeType.for(URI.open(v))
+      else
+        Marcel::MimeType.for(URI.parse(v).open)
+      end
+    end
   end
 end

data/lib/axlsx/util/options_parser.rb

@@ -2,11 +2,10 @@ module Axlsx
   # This module defines a single method for parsing options in class
   # initializers.
   module OptionsParser
-
     # Parses an options hash by calling any defined method by the same
     # name of the key postfixed with an '='
     # @param [Hash] options Options to parse.
-    def parse_options(options={})
+    def parse_options(options = {})
       options.each do |key, value|
         key = :"#{key}="
         self.send(key, value) if !value.nil? && self.respond_to?(key)

data/lib/axlsx/util/serialized_attributes.rb

@@ -2,7 +2,6 @@ module Axlsx
   # This module allows us to define a list of symbols defining which
   # attributes will be serialized for a class.
   module SerializedAttributes
-
     # Extend with class methods
     def self.included(base)
       base.send :extend, ClassMethods
@@ -10,8 +9,7 @@ module Axlsx
 
     # class methods applied to all includers
     module ClassMethods
-
-      # This is the method to be used in inheriting classes to specify 
+      # This is the method to be used in inheriting classes to specify
       # which of the instance values are serializable
       def serializable_attributes(*symbols)
         @xml_attributes = symbols
@@ -43,7 +41,7 @@ module Axlsx
       end
     end
 
-    # serializes the instance values of the defining object based on the 
+    # serializes the instance values of the defining object based on the
     # list of serializable attributes.
     # @param [String] str The string instance to append this
     # serialization to.
@@ -73,12 +71,13 @@ module Axlsx
     # @param [String] str The string instance to which serialized data is appended
     # @param [Array] additional_attributes An array of additional attribute names.
     # @return [String] The serialized output.
-    def serialized_element_attributes(str='', additional_attributes=[], &block)
+    def serialized_element_attributes(str = '', additional_attributes = [], &block)
       attrs = self.class.xml_element_attributes + additional_attributes
       values = Axlsx.instance_values_for(self)
       attrs.each do |attribute_name|
         value = values[attribute_name.to_s]
         next if value.nil?
+
         value = yield value if block_given?
         element_name = Axlsx.camel(attribute_name, false)
         str << "<#{element_name}>#{value}</#{element_name}>"

data/lib/axlsx/util/simple_typed_list.rb

@@ -1,6 +1,4 @@
-# encoding: UTF-8
 module Axlsx
-
   # A SimpleTypedList is a type restrictive collection that allows some of the methods from Array and supports basic xml serialization.
   # @private
   class SimpleTypedList
@@ -8,12 +6,13 @@ module Axlsx
     # @param [Array, Class] type An array of Class objects or a single Class object
     # @param [String] serialize_as The tag name to use in serialization
     # @raise [ArgumentError] if all members of type are not Class objects
-    def initialize type, serialize_as=nil, start_size = 0
+    def initialize type, serialize_as = nil, start_size = 0
       if type.is_a? Array
         type.each { |item| raise ArgumentError, "All members of type must be Class objects" unless item.is_a? Class }
         @allowed_types = type
       else
         raise ArgumentError, "Type must be a Class object or array of Class objects" unless type.is_a? Class
+
         @allowed_types = [type]
       end
       @serialize_as = serialize_as unless serialize_as.nil?
@@ -39,12 +38,13 @@ module Axlsx
     # any non populated cell in the matrix will be a nil value
     def transpose
       return @list.clone if @list.size == 0
+
       row_count = @list.size
-      max_column_count = @list.map{|row| row.cells.size}.max
+      max_column_count = @list.map { |row| row.cells.size }.max
       result = Array.new(max_column_count) { Array.new(row_count) }
       # yes, I know it is silly, but that warning is really annoying
       row_count.times do |row_index|
-         max_column_count.times do |column_index|
+        max_column_count.times do |column_index|
           datum = if @list[row_index].cells.size >= max_column_count
                     @list[row_index].cells[column_index]
                   elsif block_given?
@@ -55,7 +55,7 @@ module Axlsx
       end
       result
     end
-    
+
     # Lock this list at the current size
     # @return [self]
     def lock
@@ -69,7 +69,7 @@ module Axlsx
       @locked_at = nil
       self
     end
-    
+
     def to_ary
       @list
     end
@@ -82,9 +82,9 @@ module Axlsx
     # one of the allowed types
     # @return [SimpleTypedList]
     def +(v)
-      v.each do |item| 
+      v.each do |item|
         DataTypeValidator.validate :SimpleTypedList_plus, @allowed_types, item
-        @list << item 
+        @list << item
       end
     end
 
@@ -96,10 +96,9 @@ module Axlsx
       DataTypeValidator.validate :SimpleTypedList_push, @allowed_types, v
       @list << v
       @list.size - 1
-    end 
-    
+    end
+
     alias :push :<<
-    
 
     # delete the item from the list
     # @param [Any] v The item to be deleted.
@@ -108,6 +107,7 @@ module Axlsx
     def delete(v)
       return unless include? v
       raise ArgumentError, "Item is protected and cannot be deleted" if protected? index(v)
+
       @list.delete v
     end
 
@@ -117,6 +117,7 @@ module Axlsx
     def delete_at(index)
       @list[index]
       raise ArgumentError, "Item is protected and cannot be deleted" if protected? index
+
       @list.delete_at index
     end
 
@@ -128,6 +129,7 @@ module Axlsx
     def []=(index, v)
       DataTypeValidator.validate :SimpleTypedList_insert, @allowed_types, v
       raise ArgumentError, "Item is protected and cannot be changed" if protected? index
+
       @list[index] = v
       v
     end
@@ -140,6 +142,7 @@ module Axlsx
     def insert(index, v)
       DataTypeValidator.validate :SimpleTypedList_insert, @allowed_types, v
       raise ArgumentError, "Item is protected and cannot be changed" if protected? index
+
       @list.insert(index, v)
       v
     end
@@ -148,6 +151,7 @@ module Axlsx
     # @param [Integer] index
     def protected? index
       return false unless locked_at.is_a? Integer
+
       index < locked_at
     end
 
@@ -164,16 +168,13 @@ module Axlsx
         end
       }
     end
-                   
+
     def to_xml_string(str = '')
       classname = @allowed_types[0].name.split('::').last
-      el_name = serialize_as.to_s || (classname[0,1].downcase + classname[1..-1])
+      el_name = serialize_as.to_s || (classname[0, 1].downcase + classname[1..-1])
       str << ('<' << el_name << ' count="' << size.to_s << '">')
       each { |item| item.to_xml_string(str) }
       str << ('</' << el_name << '>')
     end
-
   end
-
-
 end

data/lib/axlsx/util/storage.rb

@@ -1,61 +1,58 @@
-# encoding: UTF-8
 module Axlsx
-
   # The Storage class represents a storage object or stream in a compound file.
   class Storage
-
     # Packing for the Storage when pushing an array of items into a byte stream
     # Name, name length, type, color, left sibling, right sibling, child, classid, state, created, modified, sector, size
     PACKING = "s32 s1 c2 l3 x16 x4 q2 l q".freeze
 
     # storage types
     TYPES = {
-      :root=>5,
-      :stream=>2,
-      :storage=>1
+      :root => 5,
+      :stream => 2,
+      :storage => 1
     }.freeze
 
     # Creates a byte string for this storage
-    # @return [String] 
+    # @return [String]
     def to_s
-     data = [@name.concat(Array.new(32-@name.size, 0)), 
-             @name_size, 
-             @type, 
-             @color, 
-             @left, 
-             @right, 
-             @child, 
-             @created,
-             @modified, 
-             @sector, 
-             @size].flatten
+      data = [@name.concat(Array.new(32 - @name.size, 0)),
+              @name_size,
+              @type,
+              @color,
+              @left,
+              @right,
+              @child,
+              @created,
+              @modified,
+              @sector,
+              @size].flatten
       data.pack(PACKING)
     end
 
     # storage colors
     COLORS = {
-      :red=>0, 
-      :black=>1
+      :red => 0,
+      :black => 1
     }
 
     # The color of this node in the directory tree. Defaults to black if not specified
     # @return [Integer] color
     attr_reader :color
-    
+
     # Sets the color for this storage
     # @param [Integer] v Must be one of the COLORS constant hash values
     def color=(v)
-      RestrictionValidator.validate :storage_color, COLORS.values, v      
+      RestrictionValidator.validate :storage_color, COLORS.values, v
       @color = v
     end
 
     # The size of the name for this node.
-    # interesting to see that office actually uses 'R' for the root directory and lists the size as 2 bytes - thus is it *NOT* null 
+    # interesting to see that office actually uses 'R' for the root directory and lists the size as 2 bytes - thus is it *NOT* null
     # terminated. I am making this r/w so that I can override the size
     # @return [Integer] color
     attr_reader :name_size
 
-    # the name of the stream    
+    # the name of the stream
     attr_reader :name
 
     # sets the name of the stream.
@@ -87,16 +84,16 @@ module Axlsx
     # @return [Integer] sector
     attr_accessor :sector
 
-    # The 0 based index in the directoies chain for this the left sibling of this storage. 
-    
+    # The 0 based index in the directoies chain for this the left sibling of this storage.
+
     # @return [Integer] left
-    attr_accessor :left 
+    attr_accessor :left
 
-    # The 0 based index in the directoies chain for this the right sibling of this storage. 
+    # The 0 based index in the directoies chain for this the right sibling of this storage.
     # @return [Integer] right
-    attr_accessor :right 
+    attr_accessor :right
 
-    # The 0 based index in the directoies chain for the child of this storage. 
+    # The 0 based index in the directoies chain for the child of this storage.
     # @return [Integer] child
     attr_accessor :child
 
@@ -113,14 +110,14 @@ module Axlsx
     # @return [Integer] type
     attr_reader :type
 
-    # Sets the type for this storage. 
-    # @param [Integer] v the type to specify must be one of the TYPES constant hash values. 
+    # Sets the type for this storage.
+    # @param [Integer] v the type to specify must be one of the TYPES constant hash values.
     def type=(v)
-      RestrictionValidator.validate :storage_type, TYPES.values, v      
+      RestrictionValidator.validate :storage_type, TYPES.values, v
       @type = v
     end
 
-    # Creates a new storage object. 
+    # Creates a new storage object.
     # @param [String] name the name of the storage
     # @option options [Integer] color (black)
     # @option options [Integer] type (storage)
@@ -131,7 +128,7 @@ module Axlsx
     # @option options [Integer] created (0)
     # @option options [Integer] modified (0)
     # @option options [Integer] sector (0)
-    def initialize(name, options= {})
+    def initialize(name, options = {})
       @left = @right = @child = -1
       @sector = @size = @created = @modified = 0
       options.each do |o|
@@ -141,6 +138,5 @@ module Axlsx
       @type ||= (data.nil? ? TYPES[:storage] : TYPES[:stream])
       self.name = name
     end
- 
   end
 end

data/lib/axlsx/util/validators.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module Axlsx
   # Validate a value against a specific list of allowed values.
   class RestrictionValidator
@@ -10,6 +9,7 @@ module Axlsx
     # @return [Boolean] true if validation succeeds.
     def self.validate(name, choices, v)
       raise ArgumentError, (ERR_RESTRICTION % [v.to_s, name, choices.inspect]) unless choices.include?(v)
+
       true
     end
   end
@@ -32,6 +32,7 @@ module Axlsx
       raise ArgumentError, (ERR_RANGE % [value.inspect, min.to_s, max.to_s, inclusive]) unless passes
     end
   end
+
   # Validates the value against the regular expression provided.
   class RegexValidator
     # @param [String] name The name of what is being validated. This is included in the output when the value is invalid
@@ -51,9 +52,9 @@ module Axlsx
     # @raise [ArugumentError] Raised if the class of the value provided is not in the specified array of types or the block passed returns false
     # @return [Boolean] true if validation succeeds.
     # @see validate_boolean
-    def self.validate(name, types, v, other=false)
+    def self.validate(name, types, v, other = false)
       if other.is_a?(Proc)
-         raise ArgumentError, (ERR_TYPE % [v.inspect, name, types.inspect]) unless other.call(v)
+        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|
@@ -63,7 +64,6 @@ module Axlsx
     end
   end
 
-
   # Requires that the value can be converted to an integer
   # @para, [Any] v the value to validate
   # @raise [ArgumentError] raised if the value cannot be converted to an integer
@@ -144,6 +144,7 @@ module Axlsx
   def self.validate_page_orientation(v)
     RestrictionValidator.validate "page_orientation", [:default, :landscape, :portrait], v
   end
+
   # Requires that the value is one of :none, :single, :double, :singleAccounting, :doubleAccounting
   def self.validate_cell_u(v)
     RestrictionValidator.validate "cell run style u", [:none, :single, :double, :singleAccounting, :doubleAccounting], v
@@ -153,6 +154,7 @@ module Axlsx
   def self.validate_family(v)
     RestrictionValidator.validate "cell run style family", 1..5, v
   end
+
   # Requires that the value is valid pattern type.
   # valid pattern types must be one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, :darkVertical, :darkDown,
   # :darkUp, :darkGrid, :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, :lightTrellis, :gray125, or :gray0625.
@@ -215,6 +217,7 @@ module Axlsx
   def self.validate_scatter_style(v)
     Axlsx::RestrictionValidator.validate "ScatterChart.scatterStyle", [:none, :line, :lineMarker, :marker, :smooth, :smoothMarker], v.to_sym
   end
+
   # Requires that the value is a valid horizontal_alignment
   # :general, :left, :center, :right, :fill, :justify, :centerContinuous, :distributed are allowed
   # @param [Any] v The value validated

data/lib/axlsx/util/zip_command.rb

@@ -1,9 +1,7 @@
-# encoding: UTF-8
 require 'open3'
 require 'shellwords'
 
 module Axlsx
-
   # The ZipCommand class supports zipping the Excel file contents using
   # a binary zip program instead of RubyZip's `Zip::OutputStream`.
   #

data/lib/axlsx/version.rb

@@ -1,5 +1,4 @@
 module Axlsx
-
   # The current version
-  VERSION = "3.3.0"
+  VERSION = "3.4.0"
 end

data/lib/axlsx/workbook/defined_name.rb

@@ -2,9 +2,9 @@
 #    <definedName name="_xlnm.Print_Titles" localSheetId="0">Sheet1!$1:$1</definedName>
 #  </definedNames>
 
-#<xsd:complexType name="CT_DefinedName">
+# <xsd:complexType name="CT_DefinedName">
 # <xsd:simpleContent>
-# <xsd:extension base="ST_Formula">
+#  <xsd:extension base="ST_Formula">
 # <xsd:attribute name="name" type="s:ST_Xstring" use="required"/>
 # <xsd:attribute name="comment" type="s:ST_Xstring" use="optional"/>
 # <xsd:attribute name="customMenu" type="s:ST_Xstring" use="optional"/>
@@ -97,7 +97,7 @@ module Axlsx
     #                                       version of the workbook that is published to or rendered on a Web or application server.
     # @option [Boolean] workbook_parameter - Specifies a boolean value that indicates that the name is used as a workbook parameter on a
     #                                        version of the workbook that is published to or rendered on a Web or application server.
-    def initialize(formula, options={})
+    def initialize(formula, options = {})
       @formula = formula
       parse_options options
     end
@@ -116,10 +116,11 @@ module Axlsx
     boolean_attr_accessor :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden
 
     serializable_attributes :short_cut_key, :status_bar, :help, :description, :custom_menu, :comment,
-      :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden, :local_sheet_id
+                            :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden, :local_sheet_id
 
-    def to_xml_string(str='')
+    def to_xml_string(str = '')
       raise ArgumentError, 'you must specify the name for this defined name. Please read the documentation for Axlsx::DefinedName for more details' unless name
+
       str << ('<definedName ' << 'name="' << name << '" ')
       serialized_attributes str
       str << ('>' << @formula << '</definedName>')

data/lib/axlsx/workbook/defined_names.rb

@@ -1,7 +1,6 @@
 module Axlsx
   # a simple types list of DefinedName objects
   class DefinedNames < SimpleTypedList
-
     # creates the DefinedNames object
     def initialize
       super DefinedName
@@ -12,10 +11,10 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       return if empty?
+
       str << '<definedNames>'
       each { |defined_name| defined_name.to_xml_string(str) }
       str << '</definedNames>'
     end
   end
 end
-

data/lib/axlsx/workbook/shared_strings_table.rb

@@ -1,6 +1,4 @@
-# encoding: UTF-8
 module Axlsx
-
   # The Shared String Table class is responsible for managing and serializing common strings in a workbook.
   # While the ECMA-376 spec allows for both inline and shared strings it seems that at least some applications like iWorks Numbers
   # and Google Docs require that the shared string table is populated in order to interoperate properly.
@@ -9,7 +7,6 @@ module Axlsx
   # @note Serialization performance is affected by using this serialization method so if you do not need interoperability
   # it is recomended that you use the default inline string method of serialization.
   class SharedStringsTable
-
     # The total number of strings in the workbook including duplicates
     # Empty cells are treated as blank strings
     # @return [Integer]
@@ -33,12 +30,12 @@ module Axlsx
     # Creates a new Shared Strings Table agains an array of cells
     # @param [Array] cells This is an array of all of the cells in the workbook
     # @param [Symbol] xml_space The xml:space behavior for the shared string table.
-    def initialize(cells, xml_space=:preserve)
+    def initialize(cells, xml_space = :preserve)
       @index = 0
       @xml_space = xml_space
       @unique_cells = {}
       @shared_xml_string = ""
-      shareable_cells = cells.flatten.select{ |cell| cell.plain_string? || cell.contains_rich_text? }
+      shareable_cells = cells.flatten.select { |cell| cell.plain_string? || cell.contains_rich_text? }
       @count = shareable_cells.size
       resolve(shareable_cells)
     end
@@ -46,7 +43,7 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str='')
+    def to_xml_string(str = '')
       Axlsx::sanitize(@shared_xml_string)
       str << ('<?xml version="1.0" encoding="UTF-8"?><sst xmlns="' << XML_NS << '"')
       str << (' count="' << @count.to_s << '" uniqueCount="' << unique_count.to_s << '"')