writeexcel 0.4.1 → 0.4.2

data/lib/writeexcel/chart.rb

@@ -33,22 +33,24 @@ require 'writeexcel/colors'
 # sub-classes.
 #
 #
-#     Spreadsheet::WriteExcel::BIFFwriter
+#     BIFFwriter
 #                     ^
 #                     |
-#     Spreadsheet::WriteExcel::Worksheet
+#     Writeexcel::Worksheet
 #                     ^
 #                     |
-#     Spreadsheet::WriteExcel::Chart
+#     Writeexcel::Chart
 #                     ^
 #                     |
-#     Spreadsheet::WriteExcel::Chart::* (sub-types)
+#     Writeexcel::Chart::* (sub-types)
 #
 
 #
 # = Chart
 # Chart - A writer class for Excel Charts.
 #
+module Writeexcel
+
 class Chart < Worksheet
   require 'writeexcel/helper'
   private :convert_to_ascii_if_ascii
@@ -59,7 +61,25 @@ class Chart < Worksheet
   #
   # Factory method for returning chart objects based on their class type.
   #
-  def self.factory(klass, *args)       #:nodoc:
+  def self.factory(type, *args)       #:nodoc:
+    klass =
+    case type
+    when 'Chart::Column'
+      Chart::Column
+    when 'Chart::Bar'
+      Chart::Bar
+    when 'Chart::Line'
+      Chart::Line
+    when 'Chart::Area'
+      Chart::Area
+    when 'Chart::Pie'
+      Chart::Pie
+    when 'Chart::Scatter'
+      Chart::Scatter
+    when 'Chart::Stock'
+      Chart::Stock
+    end
+
     klass.new(*args)
   end
 
@@ -1072,24 +1092,7 @@ class Chart < Worksheet
   # Write the FRAME chart substream.
   #
   def store_plotarea_frame_stream   # :nodoc:
-    area = @plotarea
-
-    store_frame(0x00, 0x03)
-    store_begin
-
-    store_lineformat(
-      area[:line_color_rgb], area[:line_pattern],
-      area[:line_weight],    area[:line_options],
-      area[:line_color_index]
-    )
-
-    store_areaformat(
-      area[:fg_color_rgb],   area[:bg_color_rgb],
-      area[:area_pattern],   area[:area_options],
-      area[:fg_color_index], area[:bg_color_index]
-    )
-
-    store_end
+    store_area_frame_stream_common(:plot)
   end
 
   ###############################################################################
@@ -1099,9 +1102,19 @@ class Chart < Worksheet
   # Write the FRAME chart substream for and embedded chart.
   #
   def store_chartarea_frame_stream   # :nodoc:
-    area = @chartarea
+    store_area_frame_stream_common(:chart)
+  end
+
+  def store_area_frame_stream_common(type)
+    if type == :plot
+      area  = @plotarea
+      grbit = 0x03
+    else
+      area = @chartarea
+      grbit = 0x02
+    end
 
-    store_frame(0x00, 0x02)
+    store_frame(0x00, grbit)
     store_begin
 
     store_lineformat(
@@ -1118,6 +1131,7 @@ class Chart < Worksheet
 
     store_end
   end
+  private :store_area_frame_stream_common
 
   ###############################################################################
   #
@@ -1290,18 +1304,8 @@ class Chart < Worksheet
     catCrossDate = 0x0000     # Crossing point.
     grbit        = 0x00EF     # Option flags.
 
-    header = [record, length].pack('vv')
-    data  = [catMin].pack('v')
-    data += [catMax].pack('v')
-    data += [catMajor].pack('v')
-    data += [unitMajor].pack('v')
-    data += [catMinor].pack('v')
-    data += [unitMinor].pack('v')
-    data += [unitBase].pack('v')
-    data += [catCrossDate].pack('v')
-    data += [grbit].pack('v')
-
-    append(header, data)
+    store_simple(record, length, catMin, catMax, catMajor, unitMajor,
+                 catMinor, unitMinor, unitBase, catCrossDate, grbit)
   end
 
   ###############################################################################
@@ -1315,10 +1319,7 @@ class Chart < Worksheet
     length   = 0x0002     # Number of bytes to follow.
     # num_axes            # Number of axes used.
 
-    header = [record, length].pack('vv')
-    data = [num_axes].pack('v')
-
-    append(header, data)
+    store_simple(record, length, num_axes)
   end
 
   ###############################################################################
@@ -1357,10 +1358,7 @@ class Chart < Worksheet
     length      = 0x0002     # Number of bytes to follow.
     line_format = 0x0001     # Axis line format.
 
-    header = [record, length].pack('vv')
-    data = [line_format].pack('v')
-
-    append(header, data)
+    store_simple(record, length, line_format)
   end
 
   ###############################################################################
@@ -1398,9 +1396,7 @@ class Chart < Worksheet
     record = 0x1033     # Record identifier.
     length = 0x0000     # Number of bytes to follow.
 
-    header = [record, length].pack('vv')
-
-    append(header)
+    store_simple(record, length)
   end
 
   ###############################################################################
@@ -1417,13 +1413,7 @@ class Chart < Worksheet
     catMark  = 0x0001     # Frequency of ticks.
     grbit    = 0x0001     # Option flags.
 
-    header = [record, length].pack('vv')
-    data   = [catCross].pack('v')
-    data  += [catLabel].pack('v')
-    data  += [catMark].pack('v')
-    data  += [grbit].pack('v')
-
-    append(header, data)
+    store_simple(record, length, catCross, catLabel, catMark, grbit)
   end
 
   ###############################################################################
@@ -1490,10 +1480,7 @@ class Chart < Worksheet
     length = 0x0002     # Number of bytes to follow.
     type   = 0x0001     # Drop/hi-lo line type.
 
-    header = [record, length].pack('vv')
-    data   = [type].pack('v')
-
-    append(header, data)
+    store_simple(record, length, type)
   end
 
   ###############################################################################
@@ -1550,13 +1537,7 @@ class Chart < Worksheet
     # point_number             # Point number.
     grbit         = 0x0000     # Format flags.
 
-    header = [record, length].pack('vv')
-    data  = [point_number].pack('v')
-    data += [series_index].pack('v')
-    data += [series_number].pack('v')
-    data += [grbit].pack('v')
-
-    append(header, data)
+    store_simple(record, length, point_number, series_index, series_number, grbit)
   end
 
   ###############################################################################
@@ -1571,10 +1552,7 @@ class Chart < Worksheet
     length = 0x0002     # Number of bytes to follow.
     type   = 0x0002     # Type.
 
-    header = [record, length].pack('vv')
-    data  = [type].pack('v')
-
-    append(header, data)
+    store_simple(record, length, type)
   end
 
   ###############################################################################
@@ -1588,10 +1566,7 @@ class Chart < Worksheet
     length      = 0x0002     # Number of bytes to follow.
     percent_gap = 0x0096     # Drop bar width gap (%).
 
-    header = [record, length].pack('vv')
-    data  = [percent_gap].pack('v')
-
-    append(header, data)
+    store_simple(record, length, percent_gap)
   end
 
   ###############################################################################
@@ -1604,9 +1579,7 @@ class Chart < Worksheet
     record = 0x1034     # Record identifier.
     length = 0x0000     # Number of bytes to follow.
 
-    header = [record, length].pack('vv')
-
-    append(header)
+    store_simple(record, length)
   end
 
   ###############################################################################
@@ -1624,14 +1597,7 @@ class Chart < Worksheet
     # height_basis           # Height basis, in twips.
     # scale_basis            # Scale by chart area or plot area.
 
-    header = [record, length].pack('vv')
-    data   = [width_basis].pack('v')
-    data  += [height_basis].pack('v')
-    data  += [height].pack('v')
-    data  += [scale_basis].pack('v')
-    data  += [index].pack('v')
-
-    append(header, data)
+    store_simple(record, length, width_basis, height_basis, height, scale_basis, index)
   end
 
   ###############################################################################
@@ -1646,10 +1612,7 @@ class Chart < Worksheet
     length = 0x0002     # Number of bytes to follow.
     # index             # Font index.
 
-    header = [record, length].pack('vv')
-    data   = [index].pack('v')
-
-    append(header, data)
+    store_simple(record, length, index)
   end
 
   ###############################################################################
@@ -1664,11 +1627,7 @@ class Chart < Worksheet
     # frame_type            # Frame type.
     # grbit                 # Option flags.
 
-    header = [record, length].pack('vv')
-    data  = [frame_type].pack('v')
-    data += [grbit].pack('v')
-
-    append(header, data)
+    store_simple(record, length, frame_type, grbit)
   end
 
   ###############################################################################
@@ -1767,12 +1726,7 @@ class Chart < Worksheet
     link_index1 = 0x0000     # Link index 1.
     link_index2 = 0x0000     # Link index 2.
 
-    header = [record, length].pack('vv')
-    data  = [link_type].pack('v')
-    data += [link_index1].pack('v')
-    data += [link_index2].pack('v')
-
-    append(header, data)
+    store_simple(record, length, link_type, link_index1, link_index2)
   end
 
   ###############################################################################
@@ -1786,10 +1740,7 @@ class Chart < Worksheet
     length  = 0x0002     # Number of bytes to follow.
     percent = 0x0000     # Distance % from center.
 
-    header = [record, length].pack('vv')
-    data   = [percent].pack('v')
-
-    append(header, data)
+    store_simple(record, length, percent)
   end
 
   ###############################################################################
@@ -1803,9 +1754,7 @@ class Chart < Worksheet
     record = 0x1035     # Record identifier.
     length = 0x0000     # Number of bytes to follow.
 
-    header = [record, length].pack('vv')
-
-    append(header)
+    store_simple(record, length)
   end
 
   ###############################################################################
@@ -1906,15 +1855,8 @@ class Chart < Worksheet
     bubble_type    = 0x0001     # Type: bubble.
     bubble_count   = 0x0000     # Num of bubble values.
 
-    header = [record, length].pack('vv')
-    data  = [category_type].pack('v')
-    data += [value_type].pack('v')
-    data += [category_count].pack('v')
-    data += [value_count].pack('v')
-    data += [bubble_type].pack('v')
-    data += [bubble_count].pack('v')
-
-    append(header, data)
+    store_simple(record, length, category_type, value_type,
+                 category_count, value_count, bubble_type, bubble_count)
   end
 
   ###############################################################################
@@ -1962,10 +1904,7 @@ class Chart < Worksheet
     length = 0x0002     # Number of bytes to follow.
     # series            # Series parent.
 
-    header = [record, length].pack('vv')
-    data = [series].pack('v')
-
-    append(header, data)
+    store_simple(record, length, series)
   end
 
   ###############################################################################
@@ -1979,10 +1918,7 @@ class Chart < Worksheet
     length     = 0x0002     # Number of bytes to follow.
     chartgroup = 0x0000     # Chart group index.
 
-    header = [record, length].pack('vv')
-    data = [chartgroup].pack('v')
-
-    append(header, data)
+    store_simple(record, length, chartgroup)
   end
 
   ###############################################################################
@@ -1999,11 +1935,7 @@ class Chart < Worksheet
 
     grbit = 0x000A if @embedded
 
-    header = [record, length].pack('vv')
-    data  = [grbit].pack('v')
-    data += [empty_cells].pack('v')
-
-    append(header, data)
+    store_simple(record, length, grbit, empty_cells)
   end
 
   ###############################################################################
@@ -2171,8 +2103,11 @@ class Chart < Worksheet
   # Setup the default configuration data for a chart.
   #
   def set_default_config_data   # :nodoc:
-    #<<< Perltidy ignore this.
-    @config = {
+    @config = default_config_data
+  end
+
+  def default_config_data   # :nodoc:
+    {
         :axisparent      => [ 0, 0x00F8, 0x01F5, 0x0E7F, 0x0B36              ],
         :axisparent_pos  => [ 2, 2, 0x008C, 0x01AA, 0x0EEA, 0x0C52           ],
         :chart           => [ 0x0000, 0x0000, 0x02DD51E0, 0x01C2B838         ],
@@ -2192,8 +2127,9 @@ class Chart < Worksheet
         :x_axis_text_pos => [ 2, 2, 0, 0,  0x2B,  0x17                       ],
         :y_axis_text     => [ 0x002D, 0x06AA, 0x5F, 0x1CC, 0x0281, 0x00, 90  ],
         :y_axis_text_pos => [ 2, 2, 0, 0, 0x17,  0x44                        ],
-    }  #>>>
+    }
   end
+  private :default_config_data
 
   ###############################################################################
   #
@@ -2219,8 +2155,7 @@ class Chart < Worksheet
       :line_options     => 0x0009,
     }
 
-    #<<< Perltidy ignore this.
-    @config = {
+    @config = default_config_data.merge({
         :axisparent      => [ 0, 0x01D8, 0x031D, 0x0D79, 0x07E9              ],
         :axisparent_pos  => [ 2, 2, 0x010C, 0x0292, 0x0E46, 0x09FD           ],
         :chart           => [ 0x0000, 0x0000, 0x01847FE8, 0x00F47FE8         ],
@@ -2231,15 +2166,12 @@ class Chart < Worksheet
         :legend          => [ 0x044E, 0x0E4A, 0x088D, 0x0123, 0x0, 0x1, 0xF  ],
         :legend_pos      => [ 5, 2, 0x044E, 0x0E4A, 0, 0                     ],
         :legend_text     => [ 0xFFFFFFD9, 0xFFFFFFC1, 0, 0, 0x00B1, 0x0000   ],
-        :legend_text_pos => [ 2, 2, 0, 0, 0, 0                               ],
         :series_text     => [ 0xFFFFFFD9, 0xFFFFFFC1, 0, 0, 0x00B1, 0x1020   ],
-        :series_text_pos => [ 2, 2, 0, 0, 0, 0                               ],
         :title_text      => [ 0x060F, 0x004C, 0x038A, 0x016F, 0x0081, 0x1030 ],
-        :title_text_pos  => [ 2, 2, 0, 0, 0x73, 0x1D                         ],
         :x_axis_text     => [ 0x07EF, 0x0C8F, 0x153, 0x123, 0x81, 0x00       ],
-        :x_axis_text_pos => [ 2, 2, 0, 0, 0x2B, 0x17                         ],
         :y_axis_text     => [ 0x0057, 0x0564, 0xB5, 0x035D, 0x0281, 0x00, 90 ],
-        :y_axis_text_pos => [ 2, 2, 0, 0, 0x17, 0x44                         ],
-    }  #>>>
+    })
   end
-end
+end  # class Chart
+
+end  # module Writeexcel

data/lib/writeexcel/charts/area.rb

@@ -15,6 +15,8 @@
 
 require 'writeexcel'
 
+module Writeexcel
+
 class Chart
 
   #
@@ -29,7 +31,7 @@ class Chart
   #    workbook  = WriteExcel.new('chart.xls')
   #    worksheet = workbook.add_worksheet
   #
-  #    chart     = workbook.add_chart(:type => Chart::Area)
+  #    chart     = workbook.add_chart(:type => 'Chart::Area')
   #
   #    # Configure the chart.
   #    chart.add_series(
@@ -52,7 +54,7 @@ class Chart
   # This module implements Area charts for WriteExcel. The chart object is
   #  created via the Workbook add_chart method:
   #
-  #    chart = workbook.add_chart(:type => Chart::Area)
+  #    chart = workbook.add_chart(:type => 'Chart::Area')
   #
   # Once the object is created it can be configured via the following methods
   # that are common to all chart classes:
@@ -95,7 +97,7 @@ class Chart
   #    worksheet.write('A2', data)
   #
   #    # Create a new chart object. In this case an embedded chart.
-  #    chart = workbook.add_chart(:type => Chart::Area, :embedded => 1)
+  #    chart = workbook.add_chart(:type => 'Chart::Area', :embedded => 1)
   #
   #    # Configure the first series. (Sample 1)
   #    chart.add_series(
@@ -144,10 +146,9 @@ class Chart
       length = 0x0002     # Number of bytes to follow.
       grbit  = 0x0001     # Option flags.
 
-      header = [record, length].pack('vv')
-      data = [grbit].pack('v')
-
-      append(header, data)
+      store_simple(record, length, grbit)
     end
   end
-end
+end  # class Chart
+
+end  # module Writeexcel

data/lib/writeexcel/charts/bar.rb

@@ -15,6 +15,8 @@
 
 require 'writeexcel/chart'
 
+module Writeexcel
+
 class Chart
 
   #
@@ -29,7 +31,7 @@ class Chart
   #    workbook  = WriteExcel.new('chart.xls')
   #    worksheet = workbook.add_worksheet
   #
-  #    chart     = workbook.add_chart(:type => Chart::Bar)
+  #    chart     = workbook.add_chart(:type => 'Chart::Bar')
   #
   #    # Configure the chart.
   #    chart.add_series(
@@ -52,7 +54,7 @@ class Chart
   # This module implements Bar charts for WriteExcel. The chart object is
   #  created via the Workbook add_chart method:
   #
-  #    chart = workbook.add_chart(:type => Chart::Bar)
+  #    chart = workbook.add_chart(:type => 'Chart::Bar')
   #
   # Once the object is created it can be configured via the following methods
   # that are common to all chart classes:
@@ -95,7 +97,7 @@ class Chart
   #    worksheet.write('A2', data)
   #
   #    # Create a new chart object. In this case an embedded chart.
-  #    chart = workbook.add_chart(:type => Chart::Bar, :embedded => 1)
+  #    chart = workbook.add_chart(:type => 'Chart::Bar', :embedded => 1)
   #
   #    # Configure the first series. (Sample 1)
   #    chart.add_series(
@@ -150,12 +152,7 @@ class Chart
       pcGap     = 0x0096     # Space between cats.
       grbit     = 0x0001     # Option flags.
 
-      header = [record, length].pack('vv')
-      data  = [pcOverlap].pack('v')
-      data += [pcGap].pack('v')
-      data += [grbit].pack('v')
-
-      append(header, data)
+      store_simple(record, length, pcOverlap, pcGap, grbit)
     end
 
     ###############################################################################
@@ -175,4 +172,6 @@ class Chart
       @config[:y_axis_text_pos] = [ 2,      2,      0,      0,     0x45,  0x17 ]
     end
   end
-end
+end  # class Chart
+
+end  # module Writeexcel

data/lib/writeexcel/charts/column.rb

@@ -15,6 +15,8 @@
 
 require 'writeexcel/chart'
 
+module Writeexcel
+
 class Chart
 
   #
@@ -29,7 +31,7 @@ class Chart
   #    workbook  = WriteExcel.new('chart.xls')
   #    worksheet = workbook.add_worksheet
   #
-  #    chart     = workbook.add_chart(:type => Chart::Column)
+  #    chart     = workbook.add_chart(:type => 'Chart::Column')
   #
   #    # Configure the chart.
   #    chart.add_series(
@@ -52,7 +54,7 @@ class Chart
   # This module implements Column charts for WriteExcel. The chart object is
   #  created via the Workbook add_chart method:
   #
-  #    chart = workbook.add_chart(:type => Chart::Column)
+  #    chart = workbook.add_chart(:type => 'Chart::Column')
   #
   # Once the object is created it can be configured via the following methods
   # that are common to all chart classes:
@@ -95,7 +97,7 @@ class Chart
   #    worksheet.write('A2', data)
   #
   #    # Create a new chart object. In this case an embedded chart.
-  #    chart = workbook.add_chart(:type => Chart::Column, :embedded => 1)
+  #    chart = workbook.add_chart(:type => 'Chart::Column', :embedded => 1)
   #
   #    # Configure the first series. (Sample 1)
   #    chart.add_series(
@@ -146,12 +148,9 @@ class Chart
       pcGap     = 0x0096     # Space between cats.
       grbit     = 0x0000     # Option flags.
 
-      header = [record, length].pack('vv')
-      data  = [pcOverlap].pack('v')
-      data += [pcGap].pack('v')
-      data += [grbit].pack('v')
-
-      append(header, data)
+      store_simple(record, length, pcOverlap, pcGap, grbit)
     end
   end
-end
+end  # class Chart
+
+end  # module Writeexcel

data/lib/writeexcel/charts/external.rb

@@ -15,6 +15,8 @@
 
 require 'writeexcel/chart'
 
+module Writeexcel
+
 class External < Chart # :nodoc:
   ###############################################################################
   #
@@ -59,4 +61,6 @@ class External < Chart # :nodoc:
   def close
     nil
   end
-end
+end  # class Chart
+
+end  # module Writeexcel

data/lib/writeexcel/charts/line.rb

@@ -15,6 +15,8 @@
 
 require 'writeexcel/chart'
 
+module Writeexcel
+
 class Chart
 
   #
@@ -29,7 +31,7 @@ class Chart
   #    workbook  = WriteExcel.new('chart.xls')
   #    worksheet = workbook.add_worksheet
   #
-  #    chart     = workbook.add_chart(:type => Chart::Line)
+  #    chart     = workbook.add_chart(:type => 'Chart::Line')
   #
   #    # Configure the chart.
   #    chart.add_series(
@@ -52,7 +54,7 @@ class Chart
   # This module implements Line charts for WriteExcel. The chart object is
   #  created via the Workbook add_chart method:
   #
-  #    chart = workbook.add_chart(:type => Chart::Line)
+  #    chart = workbook.add_chart(:type => 'Chart::Line')
   #
   # Once the object is created it can be configured via the following methods
   # that are common to all chart classes:
@@ -95,7 +97,7 @@ class Chart
   #    worksheet.write('A2', data)
   #
   #    # Create a new chart object. In this case an embedded chart.
-  #    chart = workbook.add_chart(:type => Chart::Line, :embedded => 1)
+  #    chart = workbook.add_chart(:type => 'Chart::Line', :embedded => 1)
   #
   #    # Configure the first series. (Sample 1)
   #    chart.add_series(
@@ -144,10 +146,9 @@ class Chart
       length = 0x0002     # Number of bytes to follow.
       grbit  = 0x0000     # Option flags.
 
-      header = [record, length].pack('vv')
-      data   = [grbit].pack('v')
-
-      append(header, data)
+      store_simple(record, length, grbit)
     end
   end
-end
+end  # class Chart
+
+end  # module Writeexcel