write_xlsx 0.75.0 → 0.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0997fd3d0c045f87a2365cf8c5bf998f694e31f6
-  data.tar.gz: 67ccbdd8857b463def4dadc4f74c1a9a62081a5a
+  metadata.gz: 15e9357295f571cfc282263876abdaf83e28e652
+  data.tar.gz: 264a4bd65b91a39bc4cdabb518291a7df5894376
 SHA512:
-  metadata.gz: 5f817c43fcea5bd1939dd88204c6b9acbf5609e2b8354f82d9eca8dae9e4e168c4ea94d41d1d14f2ce6e6b01212eff7e9b777e9790ab9794443ea068e9f1688b
-  data.tar.gz: 6b4242ad09a7059121741ef4a67f0b2b01cf66f9de4c6a8dfb461b07026ccc5a9babc729766837c92a93fb25fc11d4788e3cc02b5595cc374a174c6603956bb5
+  metadata.gz: 70bb93acf8c0ecb36ecc45e0c5cb4c1c64c502252878cd3d4bf1c4ab1ad9dd0940dd673cc67c1200d5964597207c678f0996deb4c2466e5bf7f1afb20390903f
+  data.tar.gz: 3759ae9b833ca5e0138098b552370f9c7ab1daae3670c52a4b3539298de2d7aa219021eec5d9a9a475e12871bcd342799e17274acfb009d8028baf331fca8466

data/Changes

@@ -1,4 +1,8 @@
 Change history of write_xlsx rubygem.
+2014-01-31 v0.76.0
+   Added date axis handling to charts.
+   Added support for non-contiguous chart ranges.
+   Fix to remove duplicate set_column() entries.
 
 2013-12-09 v0.75.0
    Added interval unit option for category axes.

data/Gemfile

@@ -1,4 +1,10 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in write_xlsx.gemspec
-gemspec
+if RUBY_VERSION >= "1.9"
+  gem 'rubyzip'
+  group :development do
+    gem 'simplecov'
+  end
+else
+  gem 'rubyzip', '0.9.9'
+end

data/README.md

@@ -1,8 +1,10 @@
 # write_xlsx
 
+[![Gem Version](https://badge.fury.io/rb/write_xlsx.png)](http://badge.fury.io/rb/write_xlsx)
+
 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.75](https://github.com/jmcnamara/excel-writer-xlsx) .
+[Excel::Writer::XLSX-0.76](https://github.com/jmcnamara/excel-writer-xlsx) .
 
 ## Description
 
@@ -82,7 +84,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-2013 Hideo NAKAMURA.
+Copyright (c) 2012-2014 Hideo NAKAMURA.
 
 See LICENSE.txt for further details.
 

data/lib/write_xlsx/chart/axis.rb

@@ -8,12 +8,12 @@ module Writexlsx
     class Axis < Caption
       include Writexlsx::Utility
 
-      attr_accessor :defaults, :reverse
-      attr_accessor :min, :max
-      attr_accessor :minor_unit, :major_unit, :minor_unit_type, :major_unit_type
-      attr_accessor :log_base, :crossing, :position, :position_axis, :label_position, :visible
-      attr_accessor :num_format, :num_format_linked, :num_font, :layout, :interval_unit
-      attr_accessor :major_gridlines, :minor_gridlines, :major_tick_mark
+      attr_accessor :defaults
+      attr_accessor :min, :max, :num_format, :position, :major_tick_mark
+      attr_reader :minor_unit, :major_unit, :minor_unit_type, :major_unit_type
+      attr_reader :log_base, :crossing, :position_axis, :label_position, :visible
+      attr_reader :num_format_linked, :num_font, :layout, :interval_unit
+      attr_reader :major_gridlines, :minor_gridlines, :reverse
 
       #
       # Convert user defined axis values into axis instance.
@@ -22,36 +22,79 @@ module Writexlsx
         super
         args      = (defaults || {}).merge(params)
 
-        @reverse           = args[:reverse]
-        @min               = args[:min]
-        @max               = args[:max]
-        @minor_unit        = args[:minor_unit]
-        @major_unit        = args[:major_unit]
-        @minor_unit_type   = args[:minor_unit_type]
-        @major_unit_type   = args[:major_unit_type]
-        @log_base          = args[:log_base]
-        @crossing          = args[:crossing]
-        @position_axis     = args[:position_axis]
-        @label_position    = args[:label_position]
-        @num_format        = args[:num_format]
-        @num_format_linked = args[:num_format_linked]
-        @interval_unit     = args[:interval_unit]
+        [
+         :reverse, :min, :max, :minor_unit, :major_unit, :minor_unit_type,
+         :major_unit_type, :log_base, :crossing, :position_axis, :label_position,
+         :num_format, :num_format_linked, :interval_unit, :major_tick_mark
+        ].each { |val| instance_variable_set("@#{val}", args[val]) }
         @visible           = args[:visible] || 1
 
+        set_major_minor_gridlines(args)
+        set_position(args)
+        set_position_axis
+        set_font_properties(args)
+        set_axis_name_layout(args)
+      end
+
+      #
+      # Write the <c:numberFormat> element. Note: It is assumed that if a user
+      # defined number format is supplied (i.e., non-default) then the sourceLinked
+      # attribute is 0. The user can override this if required.
+      #
+
+      def write_number_format(writer) # :nodoc:
+        writer.empty_tag('c:numFmt', num_fmt_attributes)
+      end
+
+      #
+      # Write the <c:numFmt> element. Special case handler for category axes which
+      # don't always have a number format.
+      #
+      def write_cat_number_format(writer, cat_has_num_fmt)
+        return unless user_defined_num_fmt_set? || cat_has_num_fmt
+
+        writer.empty_tag('c:numFmt', num_fmt_attributes)
+      end
+
+      private
+
+      def user_defined_num_fmt_set?
+        @defaults && @num_format != @defaults[:num_format]
+      end
+
+      def source_linked
+        value = 1
+        value = 0 if user_defined_num_fmt_set?
+        value = 1 if @num_format_linked
+
+        value
+      end
+
+      def num_fmt_attributes
+        [
+         ['formatCode',   @num_format],
+         ['sourceLinked', source_linked]
+        ]
+      end
+
+      def set_major_minor_gridlines(args)
         # Map major/minor_gridlines properties.
         [:major_gridlines, :minor_gridlines].each do |lines|
           if args[lines] && ptrue?(args[lines][:visible])
-            instance_variable_set("@#{lines}", gridline_properties(args[lines]))
+            instance_variable_set("@#{lines}", Gridline.new(args[lines]))
           else
             instance_variable_set("@#{lines}", nil)
           end
         end
-        @major_tick_mark   = args[:major_tick_mark]
+      end
 
+      def set_position(args)
         # Only use the first letter of bottom, top, left or right.
         @position = args[:position]
         @position = @position.downcase[0, 1] if @position
+      end
 
+      def set_position_axis
         # Set the position for a category axis on or between the tick marks.
         if @position_axis
           if @position_axis == 'on_tick'
@@ -63,85 +106,15 @@ module Writexlsx
             @position_axis = nil
           end
         end
+      end
 
-        # Set the font properties if present.
+      def set_font_properties(args)
         @num_font  = @chart.convert_font_args(args[:num_font])
         @name_font = @chart.convert_font_args(args[:name_font])
-
-        # Set the axis name layout.
-        @layout    = @chart.layout_properties(args[:name_layout], 1)
       end
 
-      #
-      # Write the <c:numberFormat> element. Note: It is assumed that if a user
-      # defined number format is supplied (i.e., non-default) then the sourceLinked
-      # attribute is 0. The user can override this if required.
-      #
-
-      def write_number_format(writer) # :nodoc:
-        source_linked = 1
-
-        # Check if a user defined number format has been set.
-        if @defaults && @num_format != @defaults[:num_format]
-          source_linked = 0
-        end
-
-        # User override of sourceLinked.
-        if ptrue?(@num_format_linked)
-          source_linked = 1
-        end
-
-        attributes = [
-                      ['formatCode',   @num_format],
-                      ['sourceLinked', source_linked]
-                     ]
-
-        writer.empty_tag('c:numFmt', attributes)
-      end
-
-      #
-      # Write the <c:numFmt> element. Special case handler for category axes which
-      # don't always have a number format.
-      #
-      def write_cat_number_format(writer, cat_has_num_fmt)
-        source_linked  = 1
-        default_format = true
-
-        # Check if a user defined number format has been set.
-        if @defaults && @num_format != @defaults[:num_format]
-          source_linked  = 0
-          default_format = false
-        end
-
-        # User override of linkedSource.
-        if @num_format_linked
-          source_linked = 1
-        end
-
-        # Skip if cat doesn't have a num format (unless it is non-default).
-        if !cat_has_num_fmt && default_format
-          return ''
-        end
-
-        attributes = [
-                      ['formatCode',   @num_format],
-                      ['sourceLinked', source_linked]
-                     ]
-
-        writer.empty_tag('c:numFmt', attributes)
-      end
-
-      #
-      # Convert user defined gridline properties to the structure required internally.
-      #
-      def gridline_properties(args)
-        # Set the visible property for the gridline.
-        gridline = { :_visible => args[:visible] }
-
-        # Set the line properties for the gridline.
-        gridline[:_line] = @chart.line_properties(args[:line])
-
-        gridline
+      def set_axis_name_layout(args)
+        @layout    = @chart.layout_properties(args[:name_layout], 1)
       end
     end
   end

data/lib/write_xlsx/chart/bar.rb

@@ -27,23 +27,8 @@ module Writexlsx
         @horiz_val_axis    = 0
         @horiz_cat_axis    = 1
         @show_crosses      = false
-
         # Override and reset the default axis values.
-        if @x_axis.defaults
-          @x_axis.defaults[:major_gridlines] = { :visible => 1 }
-        else
-          @x_axis.defaults = { :major_gridlines => { :visible => 1 } }
-        end
-        if @y_axis.defaults
-          @y_axis.defaults[:major_gridlines] = { :visible => 0 }
-        else
-          @y_axis.defaults = { :major_gridlines => { :visible => 0 } }
-        end
-
-        if @subtype == 'percent_stacked'
-            @x_axis.defaults[:num_format] = '0%'
-        end
-
+        axis_defaults_set
         set_x_axis
         set_y_axis
       end
@@ -68,11 +53,7 @@ module Writexlsx
       # Write the <c:barDir> element.
       #
       def write_bar_dir
-        val  = 'bar'
-
-        attributes = [ ['val', val] ]
-
-        @writer.empty_tag('c:barDir', attributes)
+        @writer.empty_tag('c:barDir', [ ['val', 'bar'] ])
       end
 
       #
@@ -82,6 +63,22 @@ module Writexlsx
       def write_err_dir(direction)
         # do nothing
       end
+
+      private
+
+      def axis_defaults_set
+        if @x_axis.defaults
+          @x_axis.defaults[:major_gridlines] = { :visible => 1 }
+        else
+          @x_axis.defaults = { :major_gridlines => { :visible => 1 } }
+        end
+        if @y_axis.defaults
+          @y_axis.defaults[:major_gridlines] = { :visible => 0 }
+        else
+          @y_axis.defaults = { :major_gridlines => { :visible => 0 } }
+        end
+        @x_axis.defaults[:num_format] = '0%' if @subtype == 'percent_stacked'
+      end
     end
   end
 end

data/lib/write_xlsx/chart/caption.rb

@@ -12,7 +12,7 @@ module Writexlsx
 
       def merge_with_hash(params) # :nodoc:
         @name, @formula = @chart.process_names(params[:name], params[:name_formula])
-        @data_id        = @chart.get_data_id(@formula, params[:data])
+        @data_id        = @chart.data_id(@formula, params[:data])
         @name_font      = @chart.convert_font_args(params[:name_font])
         @layout   = @chart.layout_properties(params[:layout], 1)
 

data/lib/write_xlsx/chart/column.rb

@@ -53,11 +53,7 @@ module Writexlsx
       # Write the <c:barDir> element.
       #
       def write_bar_dir
-        val  = 'col'
-
-        attributes = [ ['val', val] ]
-
-        @writer.empty_tag('c:barDir', attributes)
+        @writer.empty_tag('c:barDir', [ ['val', 'col'] ])
       end
 
       #

data/lib/write_xlsx/chart/line.rb

@@ -18,10 +18,11 @@ module Writexlsx
   class Chart
     class Line < self
       include Writexlsx::Utility
+      include Writexlsx::WriteDPtPoint
 
       def initialize(subtype)
         super(subtype)
-        @default_marker = {:type => 'none'}
+        @default_marker = Marker.new(:type => 'none')
         @smooth_allowed = 1
       end
 
@@ -62,21 +63,6 @@ module Writexlsx
           write_axis_ids(params)
         end
       end
-
-      #
-      # Write an individual <c:dPt> element. Override the parent method to add
-      # markers.
-      #
-      def write_d_pt_point(index, point)
-        @writer.tag_elements('c:dPt') do
-          # Write the c:idx element.
-          write_idx(index)
-          @writer.tag_elements('c:marker') do
-            # Write the c:spPr element.
-            write_sp_pr(point)
-          end
-        end
-      end
     end
   end
 end

data/lib/write_xlsx/chart/pie.rb

@@ -28,13 +28,12 @@ module Writexlsx
 
       def initialize(subtype)
         super(subtype)
-        @vary_data_color = 1
       end
 
       #
       # Override the virtual superclass method with a chart specific method.
       #
-      def write_chart_type(params = {})
+      def write_chart_type
         # Write the c:areaChart element.
         write_pie_chart
       end
@@ -63,7 +62,7 @@ module Writexlsx
       def write_plot_area
         @writer.tag_elements('c:plotArea') do
           # Write the c:layout element.
-          write_layout(@plotarea[:_layout], 'plot')
+          write_layout(@plotarea.layout, 'plot')
           # Write the subclass chart type element.
           write_chart_type
         end
@@ -76,41 +75,32 @@ module Writexlsx
       #
       def write_legend
         position = @legend_position
-        font     = @legend_font
-        overlay  = 0
+        allowed  = %w(right left top bottom)
         delete_series = @legend_delete_series || []
 
-        if position =~ /^overlay_/
-          position.sub!(/^overlay_/, '')
-          overlay = 1
+        if @legend_position =~ /^overlay_/
+          position = @legend_position.sub(/^overlay_/, '')
+          overlay = true
+        else
+          position = @legend_position
+          overlay = false
         end
 
-        allowed = {
-            'right'  => 'r',
-            'left'   => 'l',
-            'top'    => 't',
-            'bottom' => 'b'
-        }
-
         return if position == 'none'
-        return unless allowed.has_key?(position)
-
-        position = allowed[position]
+        return unless allowed.include?(position)
 
         @writer.tag_elements('c:legend') do
           # Write the c:legendPos element.
-          write_legend_pos(position)
+          write_legend_pos(position[0])
           # Remove series labels from the legend.
-          delete_series.each do |index|
-            # Write the c:legendEntry element.
-            write_legend_entry(index)
-          end
+          # Write the c:legendEntry element.
+          delete_series.each { |index| write_legend_entry(index) }
           # Write the c:layout element.
           write_layout(@legend_layout, 'legend')
           # Write the c:overlay element.
-          write_overlay if overlay != 0
+          write_overlay if overlay
           # Write the c:txPr element. Over-ridden.
-          write_tx_pr_legend(0, font)
+          write_tx_pr_legend(0, @legend_font)
         end
       end
 
@@ -149,11 +139,7 @@ module Writexlsx
       # Write the <a:pPr> element for legends.
       #
       def write_a_p_pr_legend(font)
-        rtl  = 0
-
-        attributes = [ ['rtl', rtl] ]
-
-        @writer.tag_elements('a:pPr', attributes) do
+        @writer.tag_elements('a:pPr', [ ['rtl', 0] ]) do
           # Write the a:defRPr element.
           write_a_def_rpr(font)
         end
@@ -163,22 +149,14 @@ module Writexlsx
       # Write the <c:varyColors> element.
       #
       def write_vary_colors
-        val  = 1
-
-        attributes = [ ['val', val] ]
-
-        @writer.empty_tag('c:varyColors', attributes)
+        @writer.empty_tag('c:varyColors', [ ['val', 1] ])
       end
 
       #
       # Write the <c:firstSliceAng> element.
       #
       def write_first_slice_ang
-        val  = 0
-
-        attributes = [ ['val', val] ]
-
-        @writer.empty_tag('c:firstSliceAng', attributes)
+        @writer.empty_tag('c:firstSliceAng', [ ['val', 0] ])
       end
     end
   end

data/lib/write_xlsx/chart/radar.rb

@@ -32,7 +32,7 @@ module Writexlsx
         super(subtype)
         @subtype = subtype || 'marker'
         if @subtype == 'marker'
-          @default_marker = { :type => 'none' }
+          @default_marker = Marker.new(:type => 'none')
         end
 
         # Override and reset the default axis values.
@@ -80,10 +80,7 @@ module Writexlsx
       #
       def write_radar_style
         val = 'marker'
-
-        if @subtype == 'filled'
-          val = 'filled'
-        end
+        val = 'filled' if @subtype == 'filled'
 
         attributes = [ ['val', val] ]
 

data/lib/write_xlsx/chart/scatter.rb

@@ -34,6 +34,7 @@ module Writexlsx
     #
     class Scatter < self
       include Writexlsx::Utility
+      include Writexlsx::WriteDPtPoint
 
       def initialize(subtype)
         super(subtype)
@@ -64,15 +65,8 @@ module Writexlsx
         return if series.empty?
 
         style   = 'lineMarker'
-        subtype = @subtype
-
         # Set the user defined chart subtype
-        case subtype
-        when 'marker_only', 'straight_with_markers', 'straight'
-          style = 'lineMarker'
-        when 'smooth_with_markers', 'smooth'
-          style = 'smoothMarker'
-        end
+        style = 'smoothMarker' if ['smooth_with_markers', 'smooth'].include?(@subtype)
 
         # Add default formatting to the series data.
         modify_series_formatting
@@ -82,10 +76,8 @@ module Writexlsx
           write_scatter_style(style)
           # Write the series elements.
           series.each {|s| write_series(s)}
-
           # Write the c:marker element.
           write_marker_value
-
           # Write the c:axId elements
           write_axis_ids(params)
         end
@@ -141,7 +133,7 @@ module Writexlsx
       def write_plot_area
         @writer.tag_elements('c:plotArea') do
           # Write the c:layout element.
-          write_layout(@plotarea[:_layout], 'plot')
+          write_layout(@plotarea.layout, 'plot')
 
           # Write the subclass chart type elements for primary and secondary axes
           write_chart_type(:primary_axes => 1)
@@ -227,9 +219,7 @@ module Writexlsx
       # Write the <c:scatterStyle> element.
       #
       def write_scatter_style(val)
-        attributes = [ ['val', val] ]
-
-        @writer.empty_tag('c:scatterStyle', attributes)
+        @writer.empty_tag('c:scatterStyle', [ ['val', val] ])
       end
 
       #
@@ -237,44 +227,46 @@ module Writexlsx
       # specified by the user.
       #
       def modify_series_formatting
-        subtype = @subtype
-
         # The default scatter style "markers only" requires a line type
-        if subtype == 'marker_only'
+        if @subtype == 'marker_only'
           # Go through each series and define default values.
           @series.each do |series|
             # Set a line type unless there is already a user defined type.
-            if series.line[:_defined] == 0
-              series.line = { :width => 2.25, :none => 1, :_defined => 1 }
+            unless series.line_defined?
+              series.line = line_properties(:width => 2.25, :none => 1, :_defined => 1)
             end
           end
         end
 
         # Turn markers off for subtypes that don't have them
-        unless subtype =~ /marker/
+        unless @subtype =~ /marker/
           # Go through each series and define default values.
           @series.each do |series|
             # Set a marker type unless there is already a user defined type.
             unless ptrue?(series.marker)
-              series.marker = { :type => 'none', :_defined => 1 }
+              series.marker = Marker.new(:type => 'none', :_defined => 1)
             end
           end
         end
       end
 
       #
-      # Write an individual <c:dPt> element. Override the parent method to add
-      # markers.
+      # Write the <c:valAx> element.
+      # This is for the second valAx in scatter plots.
       #
-      def write_d_pt_point(index, point)
-        @writer.tag_elements('c:dPt') do
-          # Write the c:idx element.
-          write_idx(index)
-          @writer.tag_elements('c:marker') do
-            # Write the c:spPr element.
-            write_sp_pr(point)
-          end
-        end
+      # Usually the X axis.
+      #
+      def write_cat_val_axis(params) # :nodoc:
+        axis_ids = params[:axis_ids]
+        return unless axis_ids && !axis_ids.empty?
+
+        x_axis   = params[:y_axis]
+        y_axis   = params[:x_axis]
+        axis_ids_0 = axis_ids[1]
+        axis_ids_1 = axis_ids[0]
+        position = y_axis.position || params[:position] || @val_axis_position
+
+        write_val_axis_base(x_axis, y_axis, axis_ids_0, axis_ids_1, position)
       end
     end
   end