write_xlsx 0.83.0 → 0.85.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055ac6da5fa4ffabd709a61116271eb670a1a946
-  data.tar.gz: da5f1f06369023fec4603457d29cd60b1638e317
+  metadata.gz: 4ef56ba78bc0dc29b679deb80865e971e73c9a7d
+  data.tar.gz: 8f59b217f920752fe91ff5291ccb335c0ecc5052
 SHA512:
-  metadata.gz: 8b09a5444cce89ac0b182f9a82d37ade0e41e5a081cd0c885dcb288e8b6c67a6424ce44dc69e9c6e4e302d4271fb29b9997365ad379629103af99f55fee115ad
-  data.tar.gz: cfd9852383a7cf97b141ab4ec6a1d5eac376cb05c3e6ecbb64a48e3c799bf513c043273e4a26c8890abb36331278e5705ec5abe34806102ceb615ff58a148bf5
+  metadata.gz: 6228d2653d110defdf4ae1f7c19e0ce8cf868c00ec404a39d081c4f09c1c8bd4894f65d078dce84ba471f9fc382442f000d5f9953d52f0b0afd1031b3078a05d
+  data.tar.gz: 409bdff580f1c80d2a457d92d744ec5cca67b16dedfb6614474dd12e3f2867f4e0027a9c2074deb3c4ec262df23668e21aa5baae7c9da547e00dd1ac3239d700

data/.travis.yml

@@ -1,8 +1,23 @@
 language: ruby
 rvm:
+- 2.3.1
+- 2.3.0
+- 2.2.5
+- 2.2.4
+- 2.2.3
+- 2.2.2
+- 2.2.1
 - 2.2.0
+- 2.1.10
+- 2.1.9
+- 2.1.8
+- 2.1.7
+- 2.1.6
 - 2.1.5
+- 2.1.4
+- 2.1.3
 - 2.1.2
 - 2.1.1
+- 2.1.0
 - 2.0.0
 - 1.9.3

data/Changes

@@ -1,4 +1,19 @@
 Change history of write_xlsx rubygem.
+
+2017-05-19 v0.85.1
+   Fix for missing method Workbook#set_tempdir
+
+2016-06-01 v0.85.0
+   Fix url encoding of links to external files and dirs.
+
+2016-03-11 v0.84.0
+   Added support for chart axis display units (thousands, million, etc.).
+   Added option to set printing in black and white.
+   Added chart styles example.
+   Added gradient fill support.
+   Added support for clustered charts.
+   Added support for boolean error codes.
+
 2015-04-12 v0.83.0
    Added option to combine two different chart types. For example to
    create a Pareto chart.

data/README.md

@@ -5,7 +5,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.83](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.84](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 
@@ -85,7 +85,7 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 Original Perl module was written by John McNamara(jmcnamara@cpan.org).
 
 Converted to ruby by Hideo NAKAMURA(cxn03651@msj.biglobe.ne.jp)
-Copyright (c) 2012-2015 Hideo NAKAMURA.
+Copyright (c) 2012-2017 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 

data/examples/chart_clustered.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#
+# A demo of a clustered category chart in Excel::Writer::XLSX.
+#
+# reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_clustered.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = ['Types',  'Sub Type',   'Value 1', 'Value 2', 'Value 3']
+data = [
+  ['Type 1', 'Sub Type A', 5000,      8000,      6000],
+  ['',       'Sub Type B', 2000,      3000,      4000],
+  ['',       'Sub Type C', 250,       1000,      2000],
+  ['Type 2', 'Sub Type D', 6000,      6000,      6500],
+  ['',       'Sub Type E', 500,       300,       200]
+]
+
+worksheet.write('A1', headings, bold)
+worksheet.write_col('A2', data)
+
+# Create a new chart object. In this case an embedded chart.
+chart = workbook.add_chart(:type => 'column', :embedded => 1)
+
+# Configure the series. Note, that the categories are 2D ranges (from column A
+# to column B). This creates the clusters. The series are shown as formula
+# strings for clarity but you can also use the array syntax. See the docs.
+chart.add_series(
+  :name       => '=Sheet1!$C$1',
+  :categories => '=Sheet1!$A$2:$B$6',
+  :values     => '=Sheet1!$C$2:$C$6'
+)
+
+chart.add_series(
+  :name       => '=Sheet1!$D$1',
+  :categories => '=Sheet1!$A$2:$B$6',
+  :values     => '=Sheet1!$D$2:$D$6'
+)
+
+chart.add_series(
+  :name       => '=Sheet1!$E$1',
+  :categories => '=Sheet1!$A$2:$B$6',
+  :values     => '=Sheet1!$E$2:$E$6'
+)
+
+# Set the Excel chart style.
+chart.set_style(37)
+
+# Turn off the legend.
+chart.set_legend(:position => 'none')
+
+# Insert the chart into the worksheet.
+worksheet.insert_chart('G3', chart)
+
+workbook.close

data/examples/chart_styles.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# An example showing all 48 default chart styles available in Excel 2007
+# using Excel::Writer::XLSX.. Note, these styles are not the same as the
+# styles available in Excel 2013.
+#
+# reverse ('(c)'), March 2015, John McNamara, jmcnamara@cpan.org
+# convert to ruby by Hideo NAKAMURA, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('chart_styles.xlsx')
+
+# Show the styles for all of these chart types.
+chart_types = ['column', 'area', 'line', 'pie']
+
+
+chart_types.each do |chart_type|
+  # Add a worksheet for each chart type.
+  worksheet = workbook.add_worksheet(chart_type.capitalize)
+  worksheet.zoom = 30
+  style_number = 1
+
+  # Create 48 charts, each with a different style.
+  0.step(89, 15) do |row_num|
+    0.step(63, 8) do |col_num|
+      chart = workbook.add_chart(
+        :type     => chart_type,
+        :embedded => 1
+      )
+
+      chart.add_series( :values => '=Data!$A$1:$A$6' )
+      chart.set_title( :name => "Style #{style_number}" )
+      chart.set_legend( :none => 1 )
+      chart.set_style( style_number )
+
+      worksheet.insert_chart(row_num, col_num, chart)
+      style_number += 1
+    end
+  end
+end
+
+# Create a worksheet with data for the charts.
+data = [ 10, 40, 50, 20, 10, 50 ]
+data_worksheet = workbook.add_worksheet('Data')
+data_worksheet.write_col('A1', data)
+data_worksheet.hide
+
+workbook.close

data/lib/write_xlsx/chart.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 require 'write_xlsx/package/xml_writer_simple'
+require 'write_xlsx/gradient'
 require 'write_xlsx/utility'
 require 'write_xlsx/chart/axis'
 require 'write_xlsx/chart/caption'
@@ -37,8 +38,9 @@ def attributes
 
   class ChartArea
     include Writexlsx::Utility
+    include Writexlsx::Gradient
 
-    attr_reader :line, :fill, :layout
+    attr_reader :line, :fill, :gradient, :layout
 
     def initialize(params = {})
       @layout = layout_properties(params[:layout])
@@ -49,9 +51,16 @@ def initialize(params = {})
       # Set the line properties for the chartarea.
       @line = border ? line_properties(border) : line_properties(params[:line])
 
+      # Set the gradient fill properties for the series.
+      @gradient = gradient_properties(params[:gradient])
+
       # Map deprecated Spreadsheet::WriteExcel fill colour.
       fill = params[:color] ? { :color => params[:color] } : params[:fill]
       @fill = fill_properties(fill)
+
+      if ptrue?(@gradient)
+        @fill = nil
+      end
     end
 
     private
@@ -641,6 +650,7 @@ def get_data_type(data) # :nodoc:
       # Check for no data in the series.
       return 'none' unless data
       return 'none' if data.empty?
+      return 'multi_str' if data.first.kind_of?(Array)
 
       # If the token isn't a number assume it is a string.
       data.each do |token|
@@ -1089,6 +1099,10 @@ def write_cat(series) # :nodoc:
           @cat_has_num_fmt = false
           # Write the c:strRef element.
           write_str_ref(formula, data, type)
+        elsif type == 'multi_str'
+          @cat_has_num_fmt = false
+          # Write the c:multiLvLStrRef element.
+          write_multi_lvl_str_ref(formula, data)
         else
           @cat_has_num_fmt = true
           # Write the c:numRef element.
@@ -1146,6 +1160,32 @@ def write_str_ref(formula, data, type) # :nodoc:
       write_num_or_str_ref('c:strRef', formula, data, type)
     end
 
+    #
+    # Write the <c:multiLvLStrRef> element.
+    #
+    def write_multi_lvl_str_ref(formula, data)
+      return if data.empty?
+
+      @writer.tag_elements('c:multiLvlStrRef') do
+        # Write the c:f element.
+        write_series_formula(formula)
+
+        @writer.tag_elements('c:multiLvlStrCache') do
+
+          # Write the c:ptCount element.
+          write_pt_count(data.last.size)
+
+          # Write the data arrays in reverse order.
+          data.reverse.each do |arr|
+            @writer.tag_elements('c:lvl') do
+              # Write the c:pt element.
+              arr.each_with_index {|a, i| write_pt(i, a)}
+            end
+          end
+        end
+      end
+    end
+
     #
     # Write the <c:numLit> element for literal number list elements.
     #
@@ -1329,6 +1369,9 @@ def write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)  # :no
 
         # Write the c:minorUnit element.
         write_c_minor_unit(y_axis.minor_unit)
+
+        # Write the c:dispUnits element.
+        write_disp_units(y_axis.display_units, y_axis.display_units_visible)
       end
     end
 
@@ -2045,11 +2088,12 @@ def write_symbol(val) # :nodoc:
     # Write the <c:spPr> element.
     #
     def write_sp_pr(series) # :nodoc:
-      line = series.line
-      fill = series.fill
+      line     = series.line
+      fill     = series.fill
+      gradient = series.gradient if series.respond_to?(:gradient)
 
       return if (!line || !ptrue?(line[:_defined])) &&
-        (!fill || !ptrue?(fill[:_defined]))
+        (!fill || !ptrue?(fill[:_defined])) && !gradient
 
       @writer.tag_elements('c:spPr') do
         # Write the fill elements for solid charts such as pie/doughnut and bar.
@@ -2062,6 +2106,10 @@ def write_sp_pr(series) # :nodoc:
             write_a_solid_fill(fill)
           end
         end
+        if ptrue?(gradient)
+          # Write the a:gradFill element.
+          write_a_grad_fill(gradient)
+        end
         # Write the a:ln element.
         write_a_ln(line) if line && ptrue?(line[:_defined])
       end
@@ -2642,6 +2690,145 @@ def write_c_smooth(smooth)
       @writer.empty_tag('c:smooth', attributes)
     end
 
+    #
+    # Write the <c:dispUnits> element.
+    #
+    def write_disp_units(units, display)
+      return unless ptrue?(units)
+
+      attributes = [ ['val', units] ]
+
+      @writer.tag_elements('c:dispUnits') do
+        @writer.empty_tag('c:builtInUnit', attributes)
+        if ptrue?(display)
+          @writer.tag_elements('c:dispUnitsLbl') do
+            @writer.empty_tag('c:layout')
+          end
+        end
+     end
+    end
+
+    #
+    # Write the <a:gradFill> element.
+    #
+    def write_a_grad_fill(gradient)
+      attributes = [
+        ['flip',        'none'],
+        ['rotWithShape', 1]
+      ]
+      attributes = [] if gradient[:type] == 'linear'
+
+      @writer.tag_elements('a:gradFill', attributes) do
+
+        # Write the a:gsLst element.
+        write_a_gs_lst(gradient)
+
+        if gradient[:type] == 'linear'
+          # Write the a:lin element.
+          write_a_lin(gradient[:angle])
+        else
+          # Write the a:path element.
+          write_a_path(gradient[:type])
+
+          # Write the a:tileRect element.
+          write_a_tile_rect(gradient[:type])
+        end
+      end
+    end
+
+    #
+    # Write the <a:gsLst> element.
+    #
+    def write_a_gs_lst(gradient)
+      positions = gradient[:positions]
+      colors    = gradient[:colors]
+
+      @writer.tag_elements('a:gsLst') do
+        (0..colors.size-1).each do |i|
+          pos = (positions[i] * 1000).to_i
+
+          attributes = [ ['pos', pos] ]
+          @writer.tag_elements('a:gs', attributes) do
+
+            color = color(colors[i])
+
+            # Write the a:srgbClr element.
+            # TODO: Wait for a feature request to support transparency.
+            write_a_srgb_clr( color );
+          end
+        end
+      end
+    end
+
+    #
+    # Write the <a:lin> element.
+    #
+    def write_a_lin(angle)
+     scaled = 0
+
+     angle = (60000 * angle).to_i
+
+     attributes = [
+         ['ang',    angle],
+         ['scaled', scaled]
+      ]
+
+      @writer.empty_tag('a:lin', attributes)
+    end
+
+    #
+    # Write the <a:path> element.
+    #
+    def write_a_path(type)
+      attributes = [ ['path', type] ]
+
+      @writer.tag_elements('a:path', attributes) do
+        # Write the a:fillToRect element.
+        write_a_fill_to_rect(type)
+      end
+    end
+
+    #
+    # Write the <a:fillToRect> element.
+    #
+    def write_a_fill_to_rect(type)
+      attributes = []
+
+      if type ==  'shape'
+        attributes = [
+          ['l' , 50000],
+          ['t' , 50000],
+          ['r' , 50000],
+          ['b' , 50000]
+        ]
+      else
+        attributes = [
+          ['l', 100000],
+          ['t', 100000]
+        ]
+      end
+
+      @writer.empty_tag('a:fillToRect', attributes)
+    end
+
+    #
+    # Write the <a:tileRect> element.
+    #
+    def write_a_tile_rect(type)
+      attributes = []
+
+      if type == 'shape'
+        attributes = []
+      else
+        attributes = [
+          ['r', -100000],
+          ['b', -100000]
+        ]
+      end
+
+      @writer.empty_tag('a:tileRect', attributes)
+    end
+
     def write_bars_base(tag, format)
       if format.line_defined? || format.fill_defined?
         @writer.tag_elements(tag) { write_sp_pr(format) }