write_xlsx 0.85.9 → 1.09.2

data/lib/write_xlsx/format.rb

@@ -2,177 +2,20 @@
 require 'write_xlsx/utility'
 
 module Writexlsx
-  # ==CELL FORMATTING
-  #
-  # This section describes the methods and properties that are available
-  # for formatting cells in Excel. The properties of a cell that can be
-  # formatted include: fonts, colours, patterns, borders, alignment and
-  # number formatting.
-  #
-  # ===Creating and using a Format object
-  #
-  # Cell formatting is defined through a Format object. Format objects
-  # are created by calling the workbook add_format() method as follows:
-  #
-  #     format1 = workbook.add_format             # Set properties later
-  #     format2 = workbook.add_format(props_hash) # Set at creation
-  #
-  # The format object holds all the formatting properties that can be applied
-  # to a cell, a row or a column. The process of setting these properties is
-  # discussed in the next section.
-  #
-  # Once a Format object has been constructed and its properties have been
-  # set it can be passed as an argument to the worksheet write methods as
-  # follows:
-  #
-  #     worksheet.write( 0, 0, 'One', format )
-  #     worksheet.write_string( 1, 0, 'Two', format )
-  #     worksheet.write_number( 2, 0, 3, format )
-  #     worksheet.write_blank( 3, 0, format )
-  #
-  # Formats can also be passed to the worksheet set_row() and set_column()
-  # methods to define the default property for a row or column.
-  #
-  #     worksheet.set_row( 0, 15, format )
-  #     worksheet.set_column( 0, 0, 15, format )
-  #
-  # ===Format methods and Format properties
-  #
-  # The following table shows the Excel format categories, the formatting
-  # properties that can be applied and the equivalent object method:
-  #
-  #     Category   Description       Property        Method Name
-  #     --------   -----------       --------        -----------
-  #     Font       Font type         font            set_font()
-  #                Font size         size            set_size()
-  #                Font color        color           set_color()
-  #                Bold              bold            set_bold()
-  #                Italic            italic          set_italic()
-  #                Underline         underline       set_underline()
-  #                Strikeout         font_strikeout  set_font_strikeout()
-  #                Super/Subscript   font_script     set_font_script()
-  #                Outline           font_outline    set_font_outline()
-  #                Shadow            font_shadow     set_font_shadow()
-  #
-  #     Number     Numeric format    num_format      set_num_format()
-  #
-  #     Protection Lock cells        locked          set_locked()
-  #                Hide formulas     hidden          set_hidden()
-  #
-  #     Alignment  Horizontal align  align           set_align()
-  #                Vertical align    valign          set_align()
-  #                Rotation          rotation        set_rotation()
-  #                Text wrap         text_wrap       set_text_wrap()
-  #                Justify last      text_justlast   set_text_justlast()
-  #                Center across     center_across   set_center_across()
-  #                Indentation       indent          set_indent()
-  #                Shrink to fit     shrink          set_shrink()
-  #
-  #     Pattern    Cell pattern      pattern         set_pattern()
-  #                Background color  bg_color        set_bg_color()
-  #                Foreground color  fg_color        set_fg_color()
-  #
-  #     Border     Cell border       border          set_border()
-  #                Bottom border     bottom          set_bottom()
-  #                Top border        top             set_top()
-  #                Left border       left            set_left()
-  #                Right border      right           set_right()
-  #                Border color      border_color    set_border_color()
-  #                Bottom color      bottom_color    set_bottom_color()
-  #                Top color         top_color       set_top_color()
-  #                Left color        left_color      set_left_color()
-  #                Right color       right_color     set_right_color()
-  #
-  # There are two ways of setting Format properties: by using the object
-  # method interface or by setting the property directly. For example,
-  # a typical use of the method interface would be as follows:
-  #
-  #     format = workbook.add_format
-  #     format.set_bold
-  #     format.set_color( 'red' )
-  #
-  # By comparison the properties can be set directly by passing a hash
-  # of properties to the Format constructor:
-  #
-  #     format = workbook.add_format( :bold => 1, :color => 'red' )
-  #
-  # or after the Format has been constructed by means of the
-  # set_format_properties() method as follows:
-  #
-  #     format = workbook.add_format
-  #     format.set_format_properties( :bold => 1, :color => 'red' )
-  #
-  # You can also store the properties in one or more named hashes and pass
-  # them to the required method:
-  #
-  #     font = {
-  #         :font  => 'Arial',
-  #         :size  => 12,
-  #         :color => 'blue',
-  #         :bold  => 1
-  #     }
-  #
-  #     shading = {
-  #         :bg_color => 'green',
-  #         :pattern  => 1
-  #     }
-  #
-  #     format1 = workbook.add_format( font )           # Font only
-  #     format2 = workbook.add_format( font, shading )  # Font and shading
-  #
-  # The provision of two ways of setting properties might lead you to wonder
-  # which is the best way. The method mechanism may be better is you prefer
-  # setting properties via method calls (which the author did when the code
-  # was first written) otherwise passing properties to the constructor has
-  # proved to be a little more flexible and self documenting in practice.
-  # An additional advantage of working with property hashes is that it allows
-  # you to share formatting between workbook objects as shown in the example
-  # above.
-  #
-  # ===Working with formats
-  #
-  # The default format is Arial 10 with all other properties off.
-  #
-  # Each unique format in WriteXLSX must have a corresponding Format
-  # object. It isn't possible to use a Format with a write() method and then
-  # redefine the Format for use at a later stage. This is because a Format
-  # is applied to a cell not in its current state but in its final state.
-  # Consider the following example:
-  #
-  #     format = workbook.add_format
-  #     format.set_bold
-  #     format.set_color( 'red' )
-  #     worksheet.write( 'A1', 'Cell A1', format )
-  #     format.set_color( 'green' )
-  #     worksheet.write( 'B1', 'Cell B1', format )
-  #
-  # Cell A1 is assigned the Format format which is initially set to the colour
-  # red. However, the colour is subsequently set to green. When Excel displays
-  # Cell A1 it will display the final state of the Format which in this case
-  # will be the colour green.
-  #
-  # In general a method call without an argument will turn a property on,
-  # for example:
-  #
-  #     format1 = workbook.add_format
-  #     format1.set_bold         # Turns bold on
-  #     format1.set_bold( 1 )    # Also turns bold on
-  #     format1.set_bold( 0 )    # Turns bold off
-  #
   class Format
     include Writexlsx::Utility
 
-    attr_reader :xf_index, :dxf_index, :num_format   # :nodoc:
-    attr_reader :underline, :font_script, :size, :theme, :font, :font_family, :hyperlink   # :nodoc:
-    attr_reader :diag_type, :diag_color, :font_only, :color, :color_indexed   # :nodoc:
-    attr_reader :left, :left_color, :right, :right_color, :top, :top_color, :bottom, :bottom_color   # :nodoc:
-    attr_reader :font_scheme   # :nodoc:
-    attr_accessor :num_format_index, :border_index, :font_index   # :nodoc:
-    attr_accessor :fill_index, :font_condense, :font_extend, :diag_border   # :nodoc:
-    attr_accessor :bg_color, :fg_color, :pattern   # :nodoc:
+    attr_reader :xf_index, :dxf_index, :num_format                                                 # :nodoc:
+    attr_reader :underline, :font_script, :size, :theme, :font, :font_family, :hyperlink, :xf_id   # :nodoc:
+    attr_reader :diag_type, :diag_color, :font_only, :color, :color_indexed                        # :nodoc:
+    attr_reader :left, :left_color, :right, :right_color, :top, :top_color, :bottom, :bottom_color # :nodoc:
+    attr_reader :font_scheme                                                                       # :nodoc:
+    attr_accessor :num_format_index, :border_index, :font_index                                    # :nodoc:
+    attr_accessor :fill_index, :font_condense, :font_extend, :diag_border                          # :nodoc:
+    attr_accessor :bg_color, :fg_color, :pattern                                                   # :nodoc:
 
-    attr_accessor :dxf_bg_color, :dxf_fg_color   # :nodoc:
-    attr_reader :rotation, :bold, :italic, :font_strikeout
+    attr_accessor :dxf_bg_color, :dxf_fg_color                                                     # :nodoc:
+    attr_reader :rotation, :bold, :italic, :font_strikeout                                         # :nodoc:
 
     def initialize(formats, params = {})   # :nodoc:
       @formats = formats
@@ -180,7 +23,7 @@ module Writexlsx
       @xf_index       = nil
       @dxf_index      = nil
 
-      @num_format     = 0
+      @num_format     = 'General'
       @num_format_index = 0
       @font_index     = 0
       @font           = 'Calibri'
@@ -200,6 +43,7 @@ module Writexlsx
       @font_extend    = 0
       @theme          = 0
       @hyperlink      = 0
+      @xf_id          = 0
 
       @hidden         = 0
       @locked         = 1
@@ -247,11 +91,11 @@ module Writexlsx
     #
     def copy(other)
       reserve = [
-                 :xf_index,
-                 :dxf_index,
-                 :xdf_format_indices,
-                 :palette
-                ]
+        :xf_index,
+        :dxf_index,
+        :xdf_format_indices,
+        :palette
+      ]
       (instance_variables - reserve).each do |v|
         instance_variable_set(v, other.instance_variable_get(v))
       end
@@ -267,17 +111,6 @@ module Writexlsx
     #
     # Convert hashes of properties to method calls.
     #
-    # The properties of an existing Format object can be also be set by means
-    # of set_format_properties():
-    #
-    #     format = workbook.add_format
-    #     format.set_format_properties(:bold => 1, :color => 'red');
-    #
-    # However, this method is here mainly for legacy reasons. It is preferable
-    # to set the properties in the format constructor:
-    #
-    #     format = workbook.add_format(:bold => 1, :color => 'red');
-    #
     def set_format_properties(*properties)   # :nodoc:
       return if properties.empty?
       properties.each do |property|
@@ -396,7 +229,8 @@ module Writexlsx
         @font,
         @italic,
         @size,
-        @underline
+        @underline,
+        @theme
       ].join(':')
     end
 
@@ -476,13 +310,13 @@ module Writexlsx
 
       colors = Colors::COLORS
 
+      # Return the default color if nil,
+      return 0x00 unless color_code
+
       if color_code.respond_to?(:to_str)
         # Return RGB style colors for processing later.
         return color_code if color_code =~ /^#[0-9A-F]{6}$/i
 
-        # Return the default color if undef,
-        return 0x00 unless color_code
-
         # or the color string converted to an integer,
         return colors[color_code.downcase.to_sym] if colors[color_code.downcase.to_sym]
 
@@ -506,7 +340,7 @@ module Writexlsx
     def set_align(location)
       return unless location             # No default
 
-      location.downcase!
+      location = location.downcase
 
       set_text_h_align(1) if location == 'left'
       set_text_h_align(2) if location == 'centre'
@@ -582,7 +416,7 @@ module Writexlsx
     def set_rotation(rotation)
       if rotation == 270
         rotation = 255
-      elsif rotation >= -90 || rotation <= 90
+      elsif rotation >= -90 && rotation <= 90
         rotation = -rotation + 90 if rotation < 0
       else
         raise "Rotation #{rotation} outside range: -90 <= angle <= 90"
@@ -593,15 +427,15 @@ module Writexlsx
     end
 
     #
-    # Set the properties for the hyperlink style. TODO. This doesn't currently
-    # work. Fix it when styles are supported.
+    # Set the properties for the hyperlink style. This isn't a public method. To
+    # be fixed when styles are supported.
     #
-    def set_hyperlink
-      @hyperlink = 1
+    def set_hyperlink(hyperlink)
+      @xf_id = 1
 
       set_underline(1)
       set_theme(10)
-      set_align('top')
+      @hyperlink = hyperlink
     end
 
     def set_font_info(fonts)
@@ -745,7 +579,7 @@ module Writexlsx
         writer.empty_tag('sz', [ ['val', size] ]) unless dxf_format
 
         if theme == -1
-          # Ignore for excel2003_style
+        # Ignore for excel2003_style
         elsif ptrue?(theme)
           write_color(writer, 'theme', theme)
         elsif ptrue?(@color_indexed)
@@ -804,11 +638,11 @@ module Writexlsx
         ['fontId'  , font_index],
         ['fillId'  , fill_index],
         ['borderId', border_index],
-        ['xfId'    , 0]
+        ['xfId'    , xf_id]
       ]
       attributes << ['applyNumberFormat', 1] if num_format_index > 0
       # Add applyFont attribute if XF format uses a font element.
-      attributes << ['applyFont', 1] if font_index > 0
+      attributes << ['applyFont', 1] if font_index > 0 && !ptrue?(@hyperlink)
       # Add applyFill attribute if XF format uses a fill element.
       attributes << ['applyFill', 1] if fill_index > 0
       # Add applyBorder attribute if XF format uses a border element.
@@ -817,8 +651,10 @@ module Writexlsx
       # Check if XF format has alignment properties set.
       apply_align, align = get_align_properties
       # We can also have applyAlignment without a sub-element.
-      attributes << ['applyAlignment', 1] if apply_align
-      attributes << ['applyProtection', 1] if get_protection_properties
+      attributes << ['applyAlignment', 1] if apply_align || ptrue?(@hyperlink)
+      if get_protection_properties || ptrue?(hyperlink)
+        attributes << ['applyProtection', 1]
+      end
 
       attributes
     end
@@ -841,7 +677,11 @@ module Writexlsx
 
     def write_font_family_scheme(writer)
       if ptrue?(@font_family)
-          writer.empty_tag('family', [ ['val', @font_family] ])
+        writer.empty_tag('family', [ ['val', @font_family] ])
+      end
+
+      if ptrue?(@font_charset)
+        writer.empty_tag('charset', [ ['val', @font_charset] ])
       end
 
       if @font == 'Calibri' && !ptrue?(@hyperlink)

data/lib/write_xlsx/package/app.rb

@@ -7,6 +7,7 @@ module Writexlsx
     class App
 
       include Writexlsx::Utility
+      attr_writer :doc_security
 
       def initialize(workbook)
         @writer = Package::XMLWriterSimple.new
@@ -14,6 +15,7 @@ module Writexlsx
         @part_names    = []
         @heading_pairs = []
         @properties    = {}
+        @doc_security  = 0
       end
 
       def set_xml_writer(filename)
@@ -32,6 +34,7 @@ module Writexlsx
             write_company
             write_links_up_to_date
             write_shared_doc
+            write_hyperlink_base
             write_hyperlinks_changed
             write_app_version
           end
@@ -102,8 +105,8 @@ module Writexlsx
 
         schema   = 'http://schemas.openxmlformats.org/officeDocument/2006/'
         attributes = [
-            ['xmlns',     "#{schema}extended-properties"],
-            ['xmlns:vt',  "#{schema}docPropsVTypes"]
+          ['xmlns',     "#{schema}extended-properties"],
+          ['xmlns:vt',  "#{schema}docPropsVTypes"]
         ]
 
         @writer.tag_elements('Properties', attributes) { yield }
@@ -122,9 +125,7 @@ module Writexlsx
       # Write the <DocSecurity> element.
       #
       def write_doc_security
-        data = 0
-
-        @writer.data_element('DocSecurity', data)
+        @writer.data_element('DocSecurity', @doc_security)
       end
 
       #
@@ -220,6 +221,17 @@ module Writexlsx
         @writer.data_element('SharedDoc', data)
       end
 
+      #
+      # Write the <HyperlinkBase> element.
+      #
+      def write_hyperlink_base
+        data = @properties[:hyperlink_base]
+
+        return unless data
+
+        @writer.data_element('HyperlinkBase', data)
+      end
+
       #
       # Write the <HyperlinksChanged> element.
       #

data/lib/write_xlsx/package/button.rb

@@ -50,8 +50,8 @@ module Writexlsx
       # attributes for <v:fill> element.
       def fill_attributes
         [
-         ['color2',             'buttonFace [67]'],
-         ['o:detectmouseclick', 't']
+          ['color2',             'buttonFace [67]'],
+          ['o:detectmouseclick', 't']
         ]
       end
 
@@ -60,9 +60,9 @@ module Writexlsx
       #
       def write_rotation_lock
         attributes = [
-                      ['v:ext',    'edit'],
-                      ['rotation', 't']
-                     ]
+          ['v:ext',    'edit'],
+          ['rotation', 't']
+        ]
         @writer.empty_tag('o:lock', attributes)
       end
 
@@ -71,9 +71,9 @@ module Writexlsx
       #
       def write_textbox
         attributes = [
-                      ['style', 'mso-direction-alt:auto'],
-                      ['o:singleclick', 'f']
-                     ]
+          ['style', 'mso-direction-alt:auto'],
+          ['o:singleclick', 'f']
+        ]
 
         @writer.tag_elements('v:textbox', attributes) do
           # Write the div element.