write_xlsx 0.77.2 → 0.78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fff0ad728ab04118c85e81ac51f896a2977b5dc
-  data.tar.gz: 0c47ce7030705137f1f737c52586a75134a3fad0
+  metadata.gz: 97af755aa6f07672a642c569fa9916a0e18365d8
+  data.tar.gz: f3ca578778d1725fe6a7936e37d5586bdb834eba
 SHA512:
-  metadata.gz: bd8f0752cfd08e0ce6fa02d73f9652e811f47a06f96b5ca3e6c1c4e99a35cf8f7490d9f23497f688cb8c6270d16f45c0de8920aec9e06f68404f169a7a22e7b7
-  data.tar.gz: a1a9bdd2c569b3b81773f08b911e044501d29534d05f9b9c0d10b34fad8b240bb1df3c73e8e6666cfa4841fe6b974b1296354a87bc648965228006b9a54d5d82
+  metadata.gz: 21399bff146d040567803600ed057b6b2e7eb5d49beee2a4744aefe19ef6987958d4152e050e1d0ee7ec58ad87454ece4bc90250f316f5bbdfb50b7f0a420bbb
+  data.tar.gz: 376f41e382cf9c8f88c35ee1dbe69a567c1189ec20e2b010d9cfa9ef39507abd5eb728893ee2aca931f6dffe5caef1aa23568ab3095fb1468e7208deeb76d0d4

data/Changes

@@ -1,4 +1,11 @@
 Change history of write_xlsx rubygem.
+2014-11-22 v0.78.0
+   Added Doughnut chart with set_rotation and set_hole_size methods.
+   Added set_rotation method to Pie charts.
+   Added set_calc_mode method to control automatic calculation of
+   formulas when worksheet is opened.
+
+
 2014-08-19 v0.77.2
    Fix for issue #16.
 

data/README.md

@@ -4,7 +4,7 @@
 
 gem to create a new file in the Excel 2007+ XLSX format, and you can use the
 same interface as writeexcel gem. write_xlsx is converted from Perl's module
-[Excel::Writer::XLSX-0.77](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.78](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 

data/examples/chart_doughnut.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A demo of a Doughnut chart in Excel::Writer::XLSX.
+#
+# The demo also shows how to set segment colours. It is possible to define
+# chart colors for most types of Excel::Writer::XLSX charts via the
+# add_series() method. However, Pie and Doughtnut charts are a special case
+# since each segment is represented as a point so it is necessary to assign
+# formatting to each point in the series.
+#
+# reverse ('(c)'), March 2011, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_doughnut.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = [ 'Category', 'Values' ]
+data = [
+    [ 'Glazed', 'Chocolate', 'Cream' ],
+    [ 50,       35,          15      ]
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write('A2', data)
+
+# Create a new chart object. In this case an embedded chart.
+chart1 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+
+# Configure the series. Note the use of the array ref to define ranges:
+# [ $sheetname, $row_start, $row_end, $col_start, $col_end ].
+# See below for an alternative syntax.
+chart1.add_series(
+    :name       => 'Doughnut sales data',
+    :categories => [ 'Sheet1', 1, 3, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 3, 1, 1 ]
+);
+
+# Add a title.
+chart1.set_title(:name => 'Popular Doughnut Types')
+
+# Set an Excel chart style. Colors with white outline and shadow.
+chart1.set_style(10)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('C2', chart1, 25, 10)
+
+
+#
+# Create a Doughnut chart with user defined segment colors.
+#
+
+# Create an example Doughnut chart like above.
+chart2 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+
+# Configure the series and add user defined segment colours.
+chart2.add_series(
+    :name       => 'Doughnut sales data',
+    :categories => '=Sheet1!$A$2:$A$4',
+    :values     => '=Sheet1!$B$2:$B$4',
+    :points     => [
+        { :fill => { :color => '#FA58D0' } },
+        { :fill => { :color => '#61210B' } },
+        { :fill => { :color => '#F5F6CE' } }
+    ]
+)
+
+# Add a title.
+chart2.set_title(:name => 'Doughnut Chart with user defined colors')
+
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('C18', chart2, 25, 10)
+
+
+#
+# Create a Doughnut chart with rotation of the segments.
+#
+
+# Create an example Doughnut chart like above.
+chart3 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+
+# Configure the series.
+chart3.add_series(
+    :name       => 'Doughnut sales data',
+    :categories => '=Sheet1!$A$2:$A$4',
+    :values     => '=Sheet1!$B$2:$B$4'
+)
+
+# Add a title.
+chart3.set_title(:name => 'Doughnut Chart with segment rotation')
+
+# Change the angle/rotation of the first segment.
+chart3.set_rotation(90)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('C34', chart3, 25, 10)
+
+
+#
+# Create a Doughnut chart with user defined hole size.
+#
+
+# Create an example Doughnut chart like above.
+chart4 = workbook.add_chart(:type => 'doughnut', :embedded => 1)
+
+# Configure the series.
+chart4.add_series(
+    :name       => 'Doughnut sales data',
+    :categories => '=Sheet1!$A$2:$A$4',
+    :values     => '=Sheet1!$B$2:$B$4'
+)
+
+# Add a title.
+chart4.set_title(:name => 'Doughnut Chart with user defined hole size')
+
+# Change the hole size.
+chart4.set_hole_size(33)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('C50', chart4, 25, 10)
+
+workbook.close

data/lib/write_xlsx/chart.rb

@@ -156,6 +156,9 @@ def self.factory(current_subclass, subtype = nil) # :nodoc:
       when 'Column'
         require 'write_xlsx/chart/column'
         Chart::Column.new(subtype)
+      when 'Doughnut'
+        require 'write_xlsx/chart/doughnut'
+        Chart::Doughnut.new(subtype)
       when 'Line'
         require 'write_xlsx/chart/line'
         Chart::Line.new(subtype)
@@ -1926,7 +1929,7 @@ def write_sp_pr(series) # :nodoc:
         (!fill || !ptrue?(fill[:_defined]))
 
       @writer.tag_elements('c:spPr') do
-        # Write the fill elements for solid charts such as pie and bar.
+        # Write the fill elements for solid charts such as pie/doughnut and bar.
         if fill && fill[:_defined] != 0
           if ptrue?(fill[:none])
             # Write the a:noFill element.

data/lib/write_xlsx/chart/doughnut.rb

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Doughnut - A class for writing Excel Doughnut charts.
+#
+# Used in conjunction with Excel::Writer::XLSX::Chart.
+#
+# See formatting note in Excel::Writer::XLSX::Chart.
+#
+# Copyright 2000-2014, John McNamara, jmcnamara@cpan.org
+# Convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/chart'
+require 'write_xlsx/chart/pie'
+require 'write_xlsx/utility'
+
+module Writexlsx
+  class Chart
+    class Doughnut < Pie
+      include Writexlsx::Utility
+
+      def initialize(subtype)
+        super(subtype)
+        @vary_data_color = 1
+        @hole_size       = 50
+        @rotation        = 0
+      end
+
+      #
+      # set_hole_size
+      #
+      # Set the Doughnut chart hole size.
+      #
+      def set_hole_size(size)
+        return unless size
+
+        if size >= 10 && size <= 90
+          @hole_size = size
+        else
+          raise "Hole size $size outside Excel range: 10 <= size <= 90";
+        end
+      end
+
+      private
+
+      #
+      # write_chart_type
+      #
+      # Override the virtual superclass method with a chart specific method.
+      #
+      def write_chart_type
+        # Write the c:doughnutChart element.
+        write_doughnut_chart
+      end
+
+      #
+      # write_doughnut_chart
+      #
+      # Write the <c:doughnutChart> element. Over-ridden method to remove axis_id code
+      # since Doughnut charts don't require val and cat axes.
+      #
+      def write_doughnut_chart
+        @writer.tag_elements('c:doughnutChart') do
+          # Write the c:varyColors element.
+          write_vary_colors
+
+          # Write the series elements.
+          @series.each { |s| write_ser(s) }
+
+          # Write the c:firstSliceAng element.
+          write_first_slice_ang
+
+          # Write the c:holeSize element.
+          write_hole_size
+        end
+      end
+
+      #
+      # write_hole_size
+      #
+      # Write the <c:holeSize> element.
+      #
+      def write_hole_size
+        @writer.empty_tag('c:holeSize', [ ['val', @hole_size] ])
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/pie.rb

@@ -28,6 +28,20 @@ class Pie < self
 
       def initialize(subtype)
         super(subtype)
+        @vary_data_color = 1
+        @rotation        = 0
+      end
+
+      #
+      # Set the Pie/Doughnut chart rotation: the angle of the first slice.
+      #
+      def set_rotation(rotation)
+        return unless rotation
+        if rotation >= 0 && rotation <= 360
+          @rotation = rotation
+        else
+          raise "Chart rotation $rotation outside range: 0 <= rotation <= 360"
+        end
       end
 
       #
@@ -55,7 +69,7 @@ def write_pie_chart
 
       #
       # Over-ridden method to remove the cat_axis() and val_axis() code since
-      # Pie charts don't require those axes.
+      # Pie/Doughnut charts don't require those axes.
       #
       # Write the <c:plotArea> element.
       #
@@ -156,7 +170,7 @@ def write_vary_colors
       # Write the <c:firstSliceAng> element.
       #
       def write_first_slice_ang
-        @writer.empty_tag('c:firstSliceAng', [ ['val', 0] ])
+        @writer.empty_tag('c:firstSliceAng', [ ['val', @rotation] ])
       end
     end
   end

data/lib/write_xlsx/format.rb

@@ -745,7 +745,9 @@ def write_font(writer, worksheet, dxf_format = nil) #:nodoc:
 
         writer.empty_tag('sz', [ ['val', size] ]) unless dxf_format
 
-        if ptrue?(theme)
+        if theme == -1
+          # Ignore for excel2003_style
+        elsif ptrue?(theme)
           write_color(writer, 'theme', theme)
         elsif ptrue?(@color_indexed)
           write_color(writer, 'indexed', @color_indexed)
@@ -799,7 +801,9 @@ def write_font_shapes(writer)
     end
 
     def write_font_family_scheme(writer)
-      writer.empty_tag('family', [ ['val', @font_family] ])
+      if ptrue?(@font_family)
+          writer.empty_tag('family', [ ['val', @font_family] ])
+      end
 
       if @font == 'Calibri' && !ptrue?(@hyperlink)
         writer.empty_tag('scheme', [ ['val', @font_scheme] ])

data/lib/write_xlsx/utility.rb

@@ -353,8 +353,11 @@ def layout_properties(args, is_text = false)
       properties = is_text ? [:x, :y] : [:x, :y, :width, :height]
 
       # Check for valid properties.
-      allowable = Hash.new
-      allowable[properties.size] = nil
+      args.keys.each do |key|
+        unless properties.include?(key.to_sym)
+            raise "Property '#{key}' not allowed in layout options\n"
+        end
+      end
 
       # Set the layout properties
       layout = Hash.new
@@ -559,6 +562,32 @@ def palette_color(index)
       rgb = @palette[idx]
       sprintf("%02X%02X%02X", *rgb)
     end
+
+    #
+    # Workbook の生成時のオプションハッシュを解析する
+    #
+    def process_workbook_options(*params)
+      case params.size
+      when 0
+        [{}, {}]
+      when 1 # one hash
+        options_keys = [:tempdir, :date_1904, :optimization, :excel2003_style]
+
+        hash = params.first
+        options = hash.reject{|k,v| !options_keys.include?(k)}
+
+        default_format_properties =
+          hash[:default_format_properties] ||
+          hash.reject{|k,v| options_keys.include?(k)}
+
+        [options, default_format_properties.dup]
+      when 2 # array which includes options and default_format_properties
+        options, default_format_properties = params
+        default_format_properties ||= {}
+
+        [options.dup, default_format_properties.dup]
+      end
+    end
   end
 
   module WriteDPtPoint

data/lib/write_xlsx/version.rb

@@ -1,5 +1,5 @@
 require 'write_xlsx/workbook'
 
 class WriteXLSX < Writexlsx::Workbook
-  VERSION = "0.77.2"
+  VERSION = "0.78.0"
 end

data/lib/write_xlsx/workbook.rb

@@ -46,6 +46,7 @@ class Workbook
     attr_reader :image_types, :images  # :nodoc:
     attr_reader :shared_strings  # :nodoc:
     attr_reader :vba_project  # :nodoc:
+    attr_reader :excel2003_style # :nodoc:
     #
     # A new Excel workbook is created using the +new+ constructor
     # which accepts either a filename or an IO object as a parameter.
@@ -87,12 +88,14 @@ class Workbook
     #     formats = { :font => 'Arial', :size => 10.5 }
     #     workbook = WriteXLSX.new('file.xlsx', formats)
     #
-    def initialize(file, default_formats = {})
+    def initialize(file, *option_params)
+      options, default_formats = process_workbook_options(*option_params)
       @writer = Package::XMLWriterSimple.new
 
-      @tempdir  = File.join(Dir.tmpdir, Digest::MD5.hexdigest(Time.now.to_s))
+      @tempdir = options[:tempdir] ||
+        File.join(Dir.tmpdir, Digest::MD5.hexdigest(Time.now.to_s))
       setup_filename(file)
-      @date_1904           = false
+      @date_1904           = options[:date_1904] || false
       @activesheet         = 0
       @firstsheet          = 0
       @selected            = 0
@@ -110,12 +113,13 @@ def initialize(file, default_formats = {})
       @custom_colors       = []
       @doc_properties      = {}
       @local_time          = Time.now
-      @optimization        = 0
+      @optimization        = options[:optimization] || 0
       @x_window            = 240
       @y_window            = 15
       @window_width        = 16095
       @window_height       = 9660
       @tab_ratio           = 500
+      @excel2003_style     = options[:excel2003_style] || false
       @table_count         = 0
       @image_types         = {}
       @images              = []
@@ -123,7 +127,17 @@ def initialize(file, default_formats = {})
       # Structures for the shared strings data.
       @shared_strings = Package::SharedStrings.new
 
-      add_format(default_formats.merge(:xf_index => 0))
+      # Formula calculation default settings.
+      @calc_id             = 124519
+      @calc_mode           = 'auto'
+      @calc_on_load        = true
+
+      if @excel2003_style
+        add_format(default_formats
+                     .merge(:xf_index => 0, :font_family => 0, :font => 'Arial', :size => 10, :theme => -1))
+      else
+        add_format(default_formats.merge(:xf_index => 0))
+      end
       set_color_palette
     end
 
@@ -404,7 +418,13 @@ def add_chart(params = {})
     # See the {Format Class's rdoc}[Format.html] for more details about
     # Format properties and how to set them.
     #
-    def add_format(properties = {})
+    def add_format(property_hash = {})
+      properties = {}
+      if @excel2003_style
+        properties.update(:font => 'Arial', :size => 10, :theme => -1)
+      end
+      properties.update(property_hash)
+
       format = Format.new(@formats, properties)
 
       @formats.formats.push(format)    # Store format reference
@@ -813,6 +833,23 @@ def add_vba_project(vba_project)
       @vba_project = vba_project
     end
 
+    #
+    # set_calc_mode()
+    #
+    # Set the Excel caclcuation mode for the workbook.
+    #
+    def set_calc_mode(mode, calc_id = nil)
+      @calc_mode = mode || 'auto'
+
+      if mode == 'manual'
+          @calc_on_load = false
+      elsif mode == 'auto_except_tables'
+        @calc_mode = 'autoNoTable'
+      end
+
+      @calc_id = calc_id if calc_id
+    end
+
     #
     # Change the RGB components of the elements in the colour palette.
     #
@@ -1139,10 +1176,18 @@ def write_workbook_view #:nodoc:
     end
 
     def write_calc_pr #:nodoc:
-      attributes = [
-                    ['calcId', 124519],
-                    ['fullCalcOnLoad', 1]
-                   ]
+      attributes = [ ['calcId', @calc_id] ]
+
+      case @calc_mode
+      when 'manual'
+        attributes << ['calcMode', 'manual']
+        attributes << ['calcOnSave', 0]
+      when 'autoNoTable'
+        attributes << ['calcMode', 'autoNoTable']
+      end
+
+      attributes << ['fullCalcOnLoad', 1] if @calc_on_load
+
       @writer.empty_tag('calcPr', attributes)
     end