write_xlsx 0.51.0 → 0.54.0

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+work
+
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+*.tmproj
+tmtags
+
+# For emacs:
+*~
+\#*
+.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+.redcar
+
+# For rubinius:
+*.rbc

data/Gemfile

@@ -1,14 +1,4 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-  gem "rubyzip", ">= 0"
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "jeweler", "~> 1.6.4"
-  gem "bundler"
-end
-group :test do
-  gem "rdoc"
-end
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in write_xlsx.gemspec
+gemspec

data/LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2012 Hideo NAKAMURA
+Copyright (c) 2012-2013 Hideo NAKAMURA
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -60,6 +60,11 @@ the first worksheet in an Excel XML spreadsheet called ruby.xlsx:
 
 == Recent change
 
+2013-02-07 v0.54.0
+ Added font manipulation to Charts.
+ Added number formats to Chart axes.
+ Added Radar Charts.
+
 2012-11-30 v0.51.0
  Impliment Shape, Table as welll as Excel::Write::XLSX-0.51
 

data/Rakefile

@@ -1,78 +1,11 @@
-# encoding: utf-8
-
+require "bundler/gem_tasks"
 require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "write_xlsx"
-  gem.homepage = "http://github.com/cxn03651/write_xlsx"
-  gem.license = "MIT"
-  gem.summary = %Q{write_xlsx is a gem to create a new file in the Excel 2007+ XLSX format.}
-  gem.description = <<EOS
-write_xlsx s a gem to create a new file in the Excel 2007+ XLSX format, and you can use the same interface as writeexcel gem.
-The WriteXLSX supports the following features:
-  * Multiple worksheets
-  * Strings and numbers
-  * Unicode text
-  * Rich string formats
-  * Formulas (including array formats)
-  * cell formatting
-  * Embedded images
-  * Charts
-  * Autofilters
-  * Data validation
-  * Hyperlinks
-  * Defined names
-  * Grouping/Outlines
-  * Cell comments
-  * Panes
-  * Page set-up and printing options
-
-write_xlsx uses the same interface as writeexcel gem.
 
-documentation is not completed, but writeexcel’s documentation will help you. See http://writeexcel.web.fc2.com/
-
-And you can find many examples in this gem.
-EOS
-  gem.email = "cxn03651@msj.biglobe.ne.jp"
-  gem.authors = ["Hideo NAKAMURA"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
+task :default => :test
 
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
+Rake::TestTask.new do |test|
+  test.libs << 'test'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
-
-# require 'rcov/rcovtask'
-# Rcov::RcovTask.new do |test|
-#   test.libs << 'test'
-#   test.pattern = 'test/**/test_*.rb'
-#   test.verbose = true
-#   test.rcov_opts << '--exclude "gems/*"'
-# end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "write_xlsx #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/examples/chart_radar.rb

@@ -0,0 +1,127 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# A demo of an Area chart in Excel::Writer::XLSX.
+#
+# reverse ('(c)'), October 2012, 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_radar.xlsx')
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Add the worksheet data that the charts will refer to.
+headings = [ 'Number', 'Batch 1', 'Batch 2' ]
+data = [
+    [ 2, 3, 4, 5, 6, 7 ],
+    [ 30, 60, 70, 50, 40, 30 ],
+    [ 25, 40, 50, 30, 50, 40 ]
+]
+
+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 => 'radar', :embedded => 1)
+
+# Configure the first series.
+chart1.add_series(
+    :name       => '=Sheet1!$B$1',
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Configure second series. Note alternative use of array ref to define
+# ranges: [ sheetname, row_start, row_end, col_start, col_end ].
+chart1.add_series(
+    :name       => '=Sheet1!$C$1',
+    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart1.set_title(:name => 'Results of sample analysis')
+chart1.set_x_axis(:name => 'Test number')
+chart1.set_y_axis(:name => 'Sample length (mm)')
+
+# Set an Excel chart style. Blue colors with white outline and shadow.
+chart1.set_style(11)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D2', chart1, 25, 10)
+
+#
+# Create a with_markers chart sub-type
+#
+chart2 = workbook.add_chart(
+                            :type     => 'radar',
+                            :embedded => 1,
+                            :subtype  => 'with_markers'
+                            )
+
+# Configure the first series.
+chart2.add_series(
+    :name       => '=Sheet1!$B$1',
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Configure second series.
+chart2.add_series(
+    :name       => '=Sheet1!$C$1',
+    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart2.set_title(:name  => 'Stacked Chart')
+chart2.set_x_axis(:name => 'Test number')
+chart2.set_y_axis(:name => 'Sample length (mm)')
+
+# Set an Excel chart style. Blue colors with white outline and shadow.
+chart2.set_style(12)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D18', chart2, 25, 11)
+
+#
+# Create a filled chart sub-type
+#
+chart3 = workbook.add_chart(
+                            :type     => 'radar',
+                            :embedded => 1,
+                            :subtype  => 'filled'
+                            )
+
+# Configure the first series.
+chart3.add_series(
+    :name       => '=Sheet1!$B$1',
+    :categories => '=Sheet1!$A$2:$A$7',
+    :values     => '=Sheet1!$B$2:$B$7'
+)
+
+# Configure second series.
+chart3.add_series(
+    :name       => '=Sheet1!$C$1',
+    :categories => [ 'Sheet1', 1, 6, 0, 0 ],
+    :values     => [ 'Sheet1', 1, 6, 2, 2 ]
+)
+
+# Add a chart title and some axis labels.
+chart3.set_title(:name  => 'Percent Stacked Chart')
+chart3.set_x_axis(:name => 'Test number')
+chart3.set_y_axis(:name => 'Sample length (mm)')
+
+# Set an Excel chart style. Blue colors with white outline and shadow.
+chart3.set_style(13)
+
+# Insert the chart into the worksheet (with an offset).
+worksheet.insert_chart('D34', chart3, 25, 11)
+
+workbook.close

data/examples/chart_secondary_axis.rb

@@ -46,7 +46,7 @@ chart.set_legend(:position => 'right')
 # Add a chart title and some axis labels.
 chart.set_title(:name => 'Survey results')
 chart.set_x_axis(:name => 'Days')
-chart.set_y_axis(:name => 'Population', :major_gridlines => {:show => 0})
+chart.set_y_axis(:name => 'Population', :major_gridlines => {:visible => 0})
 chart.set_y2_axis(:name => 'Laser wounds')
 
 # Insert the chart into the worksheet (with an offset).

data/lib/write_xlsx/chart/area.rb

@@ -25,6 +25,13 @@ module Writexlsx
         @subtype = subtype || 'standard'
         @cross_between = 'midCat'
         @show_crosses  = false
+
+        # Override and reset the default axis values.
+        if @subtype == 'percent_stacked'
+          @y_axis[:_defaults][:num_format] = '0%'
+        end
+
+        set_y_axis
       end
 
       #
@@ -60,24 +67,6 @@ module Writexlsx
           write_axis_ids(params)
         end
       end
-
-      #
-      # Over-ridden to add % format. TODO. This will be refactored back up to the
-      # SUPER class later.
-      #
-      # Write the <C:numFmt> element.
-      #
-      def write_number_format(format_code = nil)
-        source_linked = 1
-        format_code = 'General' if !format_code || format_code.empty?
-        format_code = '0%' if @subtype == 'percent_stacked'
-
-        attributes = [
-                      'formatCode',   format_code,
-                      'sourceLinked', source_linked
-                     ]
-        @writer.empty_tag('c:numFmt', attributes)
-      end
     end
   end
 end

data/lib/write_xlsx/chart/bar.rb

@@ -27,6 +27,25 @@ 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
+
+        set_x_axis
+        set_y_axis
       end
 
       #
@@ -34,11 +53,8 @@ module Writexlsx
       #
       def write_chart_type(params)
         if params[:primary_axes] != 0
-          ## Reverse X and Y axes for Bar charts.
+          # Reverse X and Y axes for Bar charts.
           @y_axis, @x_axis = @x_axis, @y_axis
-          if !@y_axis[:_major_gridlines]
-            @y_axis[:_major_gridlines] = {:show => 1}
-          end
           if @y2_axis[:_position] == 'r'
             @y2_axis[:_position] = 't'
           end
@@ -58,25 +74,6 @@ module Writexlsx
 
         @writer.empty_tag('c:barDir', attributes)
       end
-
-      #
-      # Over-ridden to add % format. TODO. This will be refactored back up to the
-      # SUPER class later.
-      #
-      # Write the <c:numFmt> element.
-      #
-      def write_number_format(format_code = 'General')
-        source_linked = 1
-
-        format_code = '0%' if @subtype == 'percent_stacked'
-
-        attributes = [
-                      'formatCode',   format_code,
-                      'sourceLinked', source_linked
-                     ]
-
-        @writer.empty_tag('c:numFmt', attributes)
-      end
     end
   end
 end

data/lib/write_xlsx/chart/column.rb

@@ -32,6 +32,13 @@ module Writexlsx
         super(subtype)
         @subtype = subtype || 'clustered'
         @horiz_val_axis = 0
+
+        # Override and reset the default axis values.
+        if @subtype == 'percent_stacked'
+          @y_axis[:_defaults][:num_format] = '0%'
+        end
+
+        set_y_axis
       end
 
       #
@@ -52,26 +59,6 @@ module Writexlsx
 
         @writer.empty_tag('c:barDir', attributes)
       end
-
-      #
-      # Over-ridden to add % format. TODO. This will be refactored back up to the
-      # SUPER class later.
-      #
-      # Write the <c:numFmt> element.
-      #
-      def write_number_format(format_code = nil)
-        format_code   ||= 'General'
-        source_linked = 1
-
-        format_code = '0%' if @subtype == 'percent_stacked'
-
-        attributes = [
-                      'formatCode',   format_code,
-                      'sourceLinked', source_linked
-                     ]
-
-        @writer.empty_tag('c:numFmt', attributes)
-      end
     end
   end
 end

data/lib/write_xlsx/chart/radar.rb

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Radar - A class for writing Excel Radar charts.
+#
+# Used in conjunction with Chart.
+#
+# See formatting note in Chart.
+#
+# Copyright 2000-2012, 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/utility'
+
+module Writexlsx
+  class Chart
+    # The Column chart module also supports the following sub-types:
+    #
+    #     stacked
+    #     percent_stacked
+    # These can be specified at creation time via the add_chart() Worksheet
+    # method:
+    #
+    #     chart = workbook.add_chart( :type => 'column', :subtype => 'stacked' )
+    #
+    class Radar < self
+      include Writexlsx::Utility
+
+      def initialize(subtype)
+        super(subtype)
+        @subtype = subtype || 'marker'
+        if @subtype == 'marker'
+          @default_marker = { :type => 'none' }
+        end
+
+        # Override and reset the default axis values.
+        @x_axis[:_defaults][:major_gridlines] = { :visible => 1 }
+        set_x_axis
+
+        # Hardcode major_tick_mark for now untill there is an accessor.
+        @y_axis[:_major_tick_mark] = 'cross'
+      end
+
+      #
+      # Override the virtual superclass method with a chart specific method.
+      #
+      def write_chart_type(params)
+        # Write the c:radarChart element.
+        write_radar_chart(params)
+      end
+
+      #
+      # Write the <c:radarChart> element.
+      #
+      def write_radar_chart(params)
+        if ptrue?(params[:primary_axes])
+          series = get_primary_axes_series
+        else
+          series = get_secondary_axes_series
+        end
+
+        return if series.empty?
+
+        @writer.tag_elements('c:radarChart') do
+          # Write the c:radarStyle element.
+          write_radar_style
+
+          # Write the series elements.
+          series.each { |s| write_series(s) }
+
+          # Write the c:axId elements
+          write_axis_ids(params)
+        end
+      end
+
+      #
+      # Write the <c:radarStyle> element.
+      #
+      def write_radar_style
+        val = 'marker'
+
+        if @subtype == 'filled'
+          val = 'filled'
+        end
+
+        attributes = ['val', val]
+
+        @writer.empty_tag('c:radarStyle', attributes)
+      end
+    end
+  end
+end

data/lib/write_xlsx/chart/stock.rb

@@ -27,6 +27,12 @@ module Writexlsx
       def initialize(subtype)
         super(subtype)
         @show_crosses = false
+
+        # Override and reset the default axis values.
+        @x_axis[:_defaults][:num_format] = 'dd/mm/yyyy'
+        @x2_axis[:_defaults][:num_format] = 'dd/mm/yyyy'
+        set_x_axis
+        set_x2_axis
       end
 
       #