writeexcel 0.3.5 → 0.4.0

data/lib/writeexcel/charts/column.rb

@@ -1,156 +1,157 @@
-###############################################################################
-#
-# Column - A writer class for Excel Column charts.
-#
-# Used in conjunction with Chart.
-#
-# See formatting note in Chart.
-#
-# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-require 'writeexcel/chart'
-
-class Chart
-
-  #
-  # ==SYNOPSIS
-  #
-  # To create a simple Excel file with a Column chart using WriteExcel:
-  #
-  #    #!/usr/bin/ruby -w
-  #
-  #    require 'writeexcel'
-  #
-  #    workbook  = WriteExcel.new('chart.xls')
-  #    worksheet = workbook.add_worksheet
-  #
-  #    chart     = workbook.add_chart(:type => Chart::Column)
-  #
-  #    # Configure the chart.
-  #    chart.add_series(
-  #      :categories => '=Sheet1!$A$2:$A$7',
-  #      :values     => '=Sheet1!$B$2:$B$7',
-  #   )
-  #
-  #    # Add the worksheet data the chart refers to.
-  #    data = [
-  #        [ 'Category', 2, 3, 4, 5, 6, 7 ],
-  #        [ 'Value',    1, 4, 5, 2, 1, 5 ]
-  #    ]
-  #
-  #    worksheet.write('A1', data)
-  #
-  #    workbook.close
-  #
-  # ==DESCRIPTION
-  #
-  # 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)
-  #
-  # Once the object is created it can be configured via the following methods
-  # that are common to all chart classes:
-  #
-  #    chart.add_series
-  #    chart.set_x_axis
-  #    chart.set_y_axis
-  #    chart.set_title
-  #
-  # These methods are explained in detail in Chart section of WriteExcel.
-  # Class specific methods or settings, if any, are explained below.
-  #
-  # ==Column Chart Methods
-  #
-  # There aren't currently any column chart specific methods. See the TODO
-  # section of Chart of Writeexcel.
-  #
-  # ==EXAMPLE
-  #
-  # Here is a complete example that demonstrates most of the available
-  # features when creating a chart.
-  #
-  #    #!/usr/bin/ruby -w
-  #
-  #    require 'writeexcel'
-  #
-  #    workbook  = WriteExcel.new('chart_column.xls')
-  #    worksheet = workbook.add_worksheet
-  #    bold      = workbook.add_format(:bold => 1)
-  #
-  #    # Add the worksheet data that the charts will refer to.
-  #    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
-  #    data = [
-  #        [ 2, 3, 4, 5, 6, 7 ],
-  #        [ 1, 4, 5, 2, 1, 5 ],
-  #        [ 3, 6, 7, 5, 4, 3 ]
-  #    ]
-  #
-  #    worksheet.write('A1', headings, bold)
-  #    worksheet.write('A2', data)
-  #
-  #    # Create a new chart object. In this case an embedded chart.
-  #    chart = workbook.add_chart(:type => Chart::Column, :embedded => 1)
-  #
-  #    # Configure the first series. (Sample 1)
-  #    chart.add_series(
-  #      :name       => 'Sample 1',
-  #      :categories => '=Sheet1!$A$2:$A$7',
-  #      :values     => '=Sheet1!$B$2:$B$7',
-  #   )
-  #
-  #    # Configure the second series. (Sample 2)
-  #    chart.add_series(
-  #      :name       => 'Sample 2',
-  #      :categories => '=Sheet1!$A$2:$A$7',
-  #      :values     => '=Sheet1!$C$2:$C$7',
-  #   )
-  #
-  #    # Add a chart title and some axis labels.
-  #    chart.set_title (:name => 'Results of sample analysis')
-  #    chart.set_x_axis(:name => 'Test number')
-  #    chart.set_y_axis(:name => 'Sample length (cm)')
-  #
-  #    # Insert the chart into the worksheet (with an offset).
-  #    worksheet.insert_chart('D2', chart, 25, 10)
-  #
-  #    workbook.close
-  #
-  class Column < Chart
-    ###############################################################################
-    #
-    # new()
-    #
-    #
-    def initialize(*args)   # :nodoc:
-      super(*args)
-    end
-
-    ###############################################################################
-    #
-    # _store_chart_type()
-    #
-    # Implementation of the abstract method from the specific chart class.
-    #
-    # Write the BAR chart BIFF record. Defines a bar or column chart type.
-    #
-    def store_chart_type   # :nodoc:
-      record    = 0x1017     # Record identifier.
-      length    = 0x0006     # Number of bytes to follow.
-      pcOverlap = 0x0000     # Space between bars.
-      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)
-    end
-  end
-end
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Column - A writer class for Excel Column charts.
+#
+# Used in conjunction with Chart.
+#
+# See formatting note in Chart.
+#
+# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel/chart'
+
+class Chart
+
+  #
+  # ==SYNOPSIS
+  #
+  # To create a simple Excel file with a Column chart using WriteExcel:
+  #
+  #    #!/usr/bin/ruby -w
+  #
+  #    require 'writeexcel'
+  #
+  #    workbook  = WriteExcel.new('chart.xls')
+  #    worksheet = workbook.add_worksheet
+  #
+  #    chart     = workbook.add_chart(:type => Chart::Column)
+  #
+  #    # Configure the chart.
+  #    chart.add_series(
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$B$2:$B$7',
+  #   )
+  #
+  #    # Add the worksheet data the chart refers to.
+  #    data = [
+  #        [ 'Category', 2, 3, 4, 5, 6, 7 ],
+  #        [ 'Value',    1, 4, 5, 2, 1, 5 ]
+  #    ]
+  #
+  #    worksheet.write('A1', data)
+  #
+  #    workbook.close
+  #
+  # ==DESCRIPTION
+  #
+  # 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)
+  #
+  # Once the object is created it can be configured via the following methods
+  # that are common to all chart classes:
+  #
+  #    chart.add_series
+  #    chart.set_x_axis
+  #    chart.set_y_axis
+  #    chart.set_title
+  #
+  # These methods are explained in detail in Chart section of WriteExcel.
+  # Class specific methods or settings, if any, are explained below.
+  #
+  # ==Column Chart Methods
+  #
+  # There aren't currently any column chart specific methods. See the TODO
+  # section of Chart of Writeexcel.
+  #
+  # ==EXAMPLE
+  #
+  # Here is a complete example that demonstrates most of the available
+  # features when creating a chart.
+  #
+  #    #!/usr/bin/ruby -w
+  #
+  #    require 'writeexcel'
+  #
+  #    workbook  = WriteExcel.new('chart_column.xls')
+  #    worksheet = workbook.add_worksheet
+  #    bold      = workbook.add_format(:bold => 1)
+  #
+  #    # Add the worksheet data that the charts will refer to.
+  #    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
+  #    data = [
+  #        [ 2, 3, 4, 5, 6, 7 ],
+  #        [ 1, 4, 5, 2, 1, 5 ],
+  #        [ 3, 6, 7, 5, 4, 3 ]
+  #    ]
+  #
+  #    worksheet.write('A1', headings, bold)
+  #    worksheet.write('A2', data)
+  #
+  #    # Create a new chart object. In this case an embedded chart.
+  #    chart = workbook.add_chart(:type => Chart::Column, :embedded => 1)
+  #
+  #    # Configure the first series. (Sample 1)
+  #    chart.add_series(
+  #      :name       => 'Sample 1',
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$B$2:$B$7',
+  #   )
+  #
+  #    # Configure the second series. (Sample 2)
+  #    chart.add_series(
+  #      :name       => 'Sample 2',
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$C$2:$C$7',
+  #   )
+  #
+  #    # Add a chart title and some axis labels.
+  #    chart.set_title (:name => 'Results of sample analysis')
+  #    chart.set_x_axis(:name => 'Test number')
+  #    chart.set_y_axis(:name => 'Sample length (cm)')
+  #
+  #    # Insert the chart into the worksheet (with an offset).
+  #    worksheet.insert_chart('D2', chart, 25, 10)
+  #
+  #    workbook.close
+  #
+  class Column < Chart
+    ###############################################################################
+    #
+    # new()
+    #
+    #
+    def initialize(*args)   # :nodoc:
+      super(*args)
+    end
+
+    ###############################################################################
+    #
+    # _store_chart_type()
+    #
+    # Implementation of the abstract method from the specific chart class.
+    #
+    # Write the BAR chart BIFF record. Defines a bar or column chart type.
+    #
+    def store_chart_type   # :nodoc:
+      record    = 0x1017     # Record identifier.
+      length    = 0x0006     # Number of bytes to follow.
+      pcOverlap = 0x0000     # Space between bars.
+      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)
+    end
+  end
+end

data/lib/writeexcel/charts/external.rb

@@ -1,61 +1,62 @@
-###############################################################################
-#
-# External - A writer class for Excel external charts.
-#
-# Used in conjunction with WriteExcel
-#
-# perltidy with options: -mbl=2 -pt=0 -nola
-#
-# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-require 'writeexcel/chart'
-
-class External < Chart # :nodoc:
-  ###############################################################################
-  #
-  # new()
-  #
-  def initialize(external_filename, *args)
-    super(*args)
-
-    @filename     = external_filename
-    @external_bin = true
-
-    _initialize    # Requires overridden initialize().
-    self
-  end
-
-  ###############################################################################
-  #
-  # _initialize()
-  #
-  # Read all the data into memory for the external binary style chart.
-  #
-  def _initialize
-    filename   = @filename
-    filehandle = File.open(filename, 'rb')
-
-    @filehandle    = filehandle
-    @datasize      = FileTest.size(filename)
-    @using_tmpfile = false
-
-    # Read the entire external chart binary into the the data buffer.
-    # This will be retrieved by _get_data() when the chart is closed().
-    @data = @filehandle.read(@datasize)
-  end
-
-  ###############################################################################
-  #
-  # _close()
-  #
-  # We don't need to create or store Chart data structures when using an
-  # external binary, so we have a default close method.
-  #
-  def close
-    return nil
-  end
-end
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# External - A writer class for Excel external charts.
+#
+# Used in conjunction with WriteExcel
+#
+# perltidy with options: -mbl=2 -pt=0 -nola
+#
+# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel/chart'
+
+class External < Chart # :nodoc:
+  ###############################################################################
+  #
+  # new()
+  #
+  def initialize(external_filename, *args)
+    super(*args)
+
+    @filename     = external_filename
+    @external_bin = true
+
+    _initialize    # Requires overridden initialize().
+    self
+  end
+
+  ###############################################################################
+  #
+  # _initialize()
+  #
+  # Read all the data into memory for the external binary style chart.
+  #
+  def _initialize
+    filename   = @filename
+    filehandle = File.open(filename, 'rb')
+
+    @filehandle    = filehandle
+    @datasize      = FileTest.size(filename)
+    @using_tmpfile = false
+
+    # Read the entire external chart binary into the the data buffer.
+    # This will be retrieved by _get_data() when the chart is closed().
+    @data = @filehandle.read(@datasize)
+  end
+
+  ###############################################################################
+  #
+  # _close()
+  #
+  # We don't need to create or store Chart data structures when using an
+  # external binary, so we have a default close method.
+  #
+  def close
+    nil
+  end
+end

data/lib/writeexcel/charts/line.rb

@@ -1,152 +1,153 @@
-###############################################################################
-#
-# Line - A writer class for Excel Line charts.
-#
-# Used in conjunction with Chart.
-#
-# See formatting note in Chart.
-#
-# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-require 'writeexcel/chart'
-
-class Chart
-
-  #
-  # ==SYNOPSIS
-  #
-  # To create a simple Excel file with a Line chart using WriteExcel:
-  #
-  #    #!/usr/bin/ruby -w
-  #
-  #    require 'writeexcel'
-  #
-  #    workbook  = WriteExcel.new('chart.xls')
-  #    worksheet = workbook.add_worksheet
-  #
-  #    chart     = workbook.add_chart(:type => Chart::Line)
-  #
-  #    # Configure the chart.
-  #    chart.add_series(
-  #      :categories => '=Sheet1!$A$2:$A$7',
-  #      :values     => '=Sheet1!$B$2:$B$7',
-  #   )
-  #
-  #    # Add the worksheet data the chart refers to.
-  #    data = [
-  #        [ 'Category', 2, 3, 4, 5, 6, 7 ],
-  #        [ 'Value',    1, 4, 5, 2, 1, 5 ]
-  #    ]
-  #
-  #    worksheet.write('A1', data)
-  #
-  #    workbook.close
-  #
-  # ==DESCRIPTION
-  #
-  # 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)
-  #
-  # Once the object is created it can be configured via the following methods
-  # that are common to all chart classes:
-  #
-  #    chart.add_series
-  #    chart.set_x_axis
-  #    chart.set_y_axis
-  #    chart.set_title
-  #
-  # These methods are explained in detail in Chart section of WriteExcel.
-  # Class specific methods or settings, if any, are explained below.
-  #
-  # ==Line Chart Methods
-  #
-  # There aren't currently any Line chart specific methods. See the TODO
-  # section of Chart of Writeexcel.
-  #
-  # ==EXAMPLE
-  #
-  # Here is a complete example that demonstrates most of the available
-  # features when creating a chart.
-  #
-  #    #!/usr/bin/ruby -w
-  #
-  #    require 'writeexcel'
-  #
-  #    workbook  = WriteExcel.new('chart_line.xls')
-  #    worksheet = workbook.add_worksheet
-  #    bold      = workbook.add_format(:bold => 1)
-  #
-  #    # Add the worksheet data that the charts will refer to.
-  #    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
-  #    data = [
-  #        [ 2, 3, 4, 5, 6, 7 ],
-  #        [ 1, 4, 5, 2, 1, 5 ],
-  #        [ 3, 6, 7, 5, 4, 3 ]
-  #    ]
-  #
-  #    worksheet.write('A1', headings, bold)
-  #    worksheet.write('A2', data)
-  #
-  #    # Create a new chart object. In this case an embedded chart.
-  #    chart = workbook.add_chart(:type => Chart::Line, :embedded => 1)
-  #
-  #    # Configure the first series. (Sample 1)
-  #    chart.add_series(
-  #      :name       => 'Sample 1',
-  #      :categories => '=Sheet1!$A$2:$A$7',
-  #      :values     => '=Sheet1!$B$2:$B$7',
-  #   )
-  #
-  #    # Configure the second series. (Sample 2)
-  #    chart.add_series(
-  #      :name       => 'Sample 2',
-  #      :categories => '=Sheet1!$A$2:$A$7',
-  #      :values     => '=Sheet1!$C$2:$C$7',
-  #   )
-  #
-  #    # Add a chart title and some axis labels.
-  #    chart.set_title (:name => 'Results of sample analysis')
-  #    chart.set_x_axis(:name => 'Test number')
-  #    chart.set_y_axis(:name => 'Sample length (cm)')
-  #
-  #    # Insert the chart into the worksheet (with an offset).
-  #    worksheet.insert_chart('D2', chart, 25, 10)
-  #
-  #    workbook.close
-  #
-  class Line < Chart
-    ###############################################################################
-    #
-    # new()
-    #
-    #
-    def initialize(*args)   # :nodoc:
-      super(*args)
-    end
-
-    ###############################################################################
-    #
-    # _store_chart_type()
-    #
-    # Implementation of the abstract method from the specific chart class.
-    #
-    # Write the LINE chart BIFF record. Defines a line chart type.
-    #
-    def store_chart_type   # :nodoc:
-      record = 0x1018     # Record identifier.
-      length = 0x0002     # Number of bytes to follow.
-      grbit  = 0x0000     # Option flags.
-
-      header = [record, length].pack('vv')
-      data   = [grbit].pack('v')
-
-      append(header, data)
-    end
-  end
-end
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Line - A writer class for Excel Line charts.
+#
+# Used in conjunction with Chart.
+#
+# See formatting note in Chart.
+#
+# Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel/chart'
+
+class Chart
+
+  #
+  # ==SYNOPSIS
+  #
+  # To create a simple Excel file with a Line chart using WriteExcel:
+  #
+  #    #!/usr/bin/ruby -w
+  #
+  #    require 'writeexcel'
+  #
+  #    workbook  = WriteExcel.new('chart.xls')
+  #    worksheet = workbook.add_worksheet
+  #
+  #    chart     = workbook.add_chart(:type => Chart::Line)
+  #
+  #    # Configure the chart.
+  #    chart.add_series(
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$B$2:$B$7',
+  #   )
+  #
+  #    # Add the worksheet data the chart refers to.
+  #    data = [
+  #        [ 'Category', 2, 3, 4, 5, 6, 7 ],
+  #        [ 'Value',    1, 4, 5, 2, 1, 5 ]
+  #    ]
+  #
+  #    worksheet.write('A1', data)
+  #
+  #    workbook.close
+  #
+  # ==DESCRIPTION
+  #
+  # 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)
+  #
+  # Once the object is created it can be configured via the following methods
+  # that are common to all chart classes:
+  #
+  #    chart.add_series
+  #    chart.set_x_axis
+  #    chart.set_y_axis
+  #    chart.set_title
+  #
+  # These methods are explained in detail in Chart section of WriteExcel.
+  # Class specific methods or settings, if any, are explained below.
+  #
+  # ==Line Chart Methods
+  #
+  # There aren't currently any Line chart specific methods. See the TODO
+  # section of Chart of Writeexcel.
+  #
+  # ==EXAMPLE
+  #
+  # Here is a complete example that demonstrates most of the available
+  # features when creating a chart.
+  #
+  #    #!/usr/bin/ruby -w
+  #
+  #    require 'writeexcel'
+  #
+  #    workbook  = WriteExcel.new('chart_line.xls')
+  #    worksheet = workbook.add_worksheet
+  #    bold      = workbook.add_format(:bold => 1)
+  #
+  #    # Add the worksheet data that the charts will refer to.
+  #    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
+  #    data = [
+  #        [ 2, 3, 4, 5, 6, 7 ],
+  #        [ 1, 4, 5, 2, 1, 5 ],
+  #        [ 3, 6, 7, 5, 4, 3 ]
+  #    ]
+  #
+  #    worksheet.write('A1', headings, bold)
+  #    worksheet.write('A2', data)
+  #
+  #    # Create a new chart object. In this case an embedded chart.
+  #    chart = workbook.add_chart(:type => Chart::Line, :embedded => 1)
+  #
+  #    # Configure the first series. (Sample 1)
+  #    chart.add_series(
+  #      :name       => 'Sample 1',
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$B$2:$B$7',
+  #   )
+  #
+  #    # Configure the second series. (Sample 2)
+  #    chart.add_series(
+  #      :name       => 'Sample 2',
+  #      :categories => '=Sheet1!$A$2:$A$7',
+  #      :values     => '=Sheet1!$C$2:$C$7',
+  #   )
+  #
+  #    # Add a chart title and some axis labels.
+  #    chart.set_title (:name => 'Results of sample analysis')
+  #    chart.set_x_axis(:name => 'Test number')
+  #    chart.set_y_axis(:name => 'Sample length (cm)')
+  #
+  #    # Insert the chart into the worksheet (with an offset).
+  #    worksheet.insert_chart('D2', chart, 25, 10)
+  #
+  #    workbook.close
+  #
+  class Line < Chart
+    ###############################################################################
+    #
+    # new()
+    #
+    #
+    def initialize(*args)   # :nodoc:
+      super(*args)
+    end
+
+    ###############################################################################
+    #
+    # _store_chart_type()
+    #
+    # Implementation of the abstract method from the specific chart class.
+    #
+    # Write the LINE chart BIFF record. Defines a line chart type.
+    #
+    def store_chart_type   # :nodoc:
+      record = 0x1018     # Record identifier.
+      length = 0x0002     # Number of bytes to follow.
+      grbit  = 0x0000     # Option flags.
+
+      header = [record, length].pack('vv')
+      data   = [grbit].pack('v')
+
+      append(header, data)
+    end
+  end
+end