axlsx 2.1.0.pre → 3.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbd74d60d15e7375b31b29eb04943c5014519d0a
-  data.tar.gz: 13a7cdaf65bd1da6d7b780b9c8217cf544141679
+  metadata.gz: 0ace95e053d44bf7ebbd97250359660526f4672d
+  data.tar.gz: fbbcb63a35a7c7b39a15895e6c7d6478ea32a5a6
 SHA512:
-  metadata.gz: 92fdb46000096174c14f32b6783e8758b39535ceb2bc193cfb0f45723c98babe7abfdab3e1ae2af76c999f414e67bf47afe93e46827571db5aa0b3bb97f79492
-  data.tar.gz: 2b7e3f18fa42835e8ca6e48a40b8641cb0d799f898124e827c7993adb097216df788bef033dde4d1a5525338d4d24a28112092f42ce9684f61ad74daf2b09df1
+  metadata.gz: cce5eb9c776949ceb488f48d6014eeff6090203b90ca80dc43a553c5439f847a4885f698772eed72096a82049048ba9a26e7013a5e0de5a984fe7c7f6afe6cac
+  data.tar.gz: 2a882ec60dd5ddf6e96f662c69f00db4ce0516e1063797f3341e630549f17813796f868e00b8c7548531cf48c3f804c84759f5367e548ac466857273a9745702

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 CHANGELOG
 ---------
+- **April.1.17**:3.0.0-pre
+  - Support for ruby versions limited to officially supported version
+  - Updates to dependency gems, especially nokogiri and ruby-zip
+  - Patch options parsing for two cell anchor
+  - Remove support for depreciated worksheet members
 - **November.25.12**:1.3.4
   - Support for headers and footers for worksheets
   - bug fix: Properly escape hyperlink urls

data/README.md

@@ -1,12 +1,10 @@
 Axlsx: Office Open XML Spreadsheet Generation
 ====================================
-[![Build Status](https://secure.travis-ci.org/randym/axlsx.png?branch=master)](http://travis-ci.org/randym/axlsx/)
+[![Build Status](https://secure.travis-ci.org/randym/axlsx.svg?branch=master)](http://travis-ci.org/randym/axlsx/)
 
-If you are using axlsx for comercial purposes, or just want to show your
+If you are using axlsx for commercial purposes, or just want to show your
 appreciation for the gem, please don't hesitate to make a donation.
 
-[![Click here to lend your support to: axlsx and make a donation at www.pledgie.com !](http://www.pledgie.com/campaigns/17814.png?skin_name=chrome)](http://www.pledgie.com/campaigns/17814)
-
 **IRC**:[irc.freenode.net / #axlsx](irc://irc.freenode.net/axlsx)
 
 **Git**:[http://github.com/randym/axlsx](http://github.com/randym/axlsx)
@@ -17,17 +15,17 @@ appreciation for the gem, please don't hesitate to make a donation.
 
 **Author**: Randy Morgan
 
-**Copyright**: 2011 - 2013
+**Copyright**: 2011 - 2017
 
 **License**: MIT License
 
-**Latest Version**: 2.0.1
+**Latest Version**: 3.0.0
 
-**Ruby Version**: 1.9.2, 1.9.3, 2.0.0
+**Ruby Version**: 2.2.7, 2.3.4, 2.4.1
 
 **JRuby Version**: 1.9 modes
 
-**Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
+**Rubinius Version**: rubinius 3 * lower versions may run, this gem always tests against head.
 
 **Release Date**: September 12th 2013
 
@@ -52,7 +50,7 @@ If you are working with ActiveAdmin see:
 
 [activeadmin-axlsx](http://github.com/randym/activeadmin-axlsx)
 
-It provies a plugin and dsl for generating downloadable reports.
+It provides a plugin and dsl for generating downloadable reports.
 
 The examples directory contains a number of more specific examples as
 well.
@@ -153,7 +151,7 @@ There is much, much more you can do with this gem. If you get stuck, grab me on
 
 This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
 
-     gem install yard
+     gem install yard kramdown
 
      yard server -g
 
@@ -231,16 +229,15 @@ related to themes, which axlsx does not implement at this time.
    - you must set 'use_shared_strings' to true. This is most
      conveniently done just before rendering by calling Package.use_shared_strings = true prior to serialization.
 
-```ruby
-p = Axlsx::Package.new
-p.workbook.add_worksheet(:name => "Basic Worksheet") do |sheet|
-  sheet.add_row ["First Column", "Second", "Third"]
-  sheet.add_row [1, 2, 3]
-end
-p.use_shared_strings = true
-p.serialize('simple.xlsx')
-```
-
+  ```ruby
+  p = Axlsx::Package.new
+  p.workbook.add_worksheet(:name => "Basic Worksheet") do |sheet|
+    sheet.add_row ["First Column", "Second", "Third"]
+    sheet.add_row [1, 2, 3]
+  end
+  p.use_shared_strings = true
+  p.serialize('simple.xlsx')
+  ```
    - charts do not render
 
 

data/Rakefile

@@ -9,7 +9,6 @@ task :benchmark do
 end
 
 task :gendoc do
-  #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
   system "yardoc"
   system "yard stats --list-undoc"
 end

data/examples/conditional_formatting/example_conditional_formatting.rb

@@ -9,6 +9,7 @@ book = p.workbook
 # define your regular styles
 percent = book.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE_THIN_BORDER)
 money = book.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
+status = book.styles.add_style(:border => Axlsx::STYLE_THIN_BORDER)
 
 # define the style for conditional formatting
 profitable = book.styles.add_style( :fg_color => "428751", :type => :dxf )
@@ -71,4 +72,18 @@ book.add_worksheet(:name => "Icon Set") do |ws|
   ws.add_conditional_formatting("B3:B100", { :type => :iconSet, :dxfId => profitable, :priority => 1, :icon_set => icon_set })
 end
 
+book.add_worksheet(:name => "Contains Text") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total", "Status"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})", (10000*((rows/2-i) * (rows/2-i))) > 100000 ? "PROFIT" : "LOSS"], :style=>[nil, money, percent, status]
+  end
+
+# Apply conditional formatting to range D3:D100 in the worksheet
+  ws.add_conditional_formatting("D3:D100", { :type => :containsText, :operator => :equal, :text => "PROFIT", :dxfId => profitable, :priority => 1 })
+  ws.add_conditional_formatting("D3:D100", { :type => :containsText, :operator => :equal, :text => "LOSS", :dxfId => unprofitable, :priority => 1 })
+end
+
 p.serialize('example_conditional_formatting.xlsx')

data/examples/example.rb

@@ -51,6 +51,7 @@ examples << :no_autowidth
 examples << :cached_formula
 examples << :page_breaks
 examples << :rich_text
+examples << :tab_color
 
 p = Axlsx::Package.new
 wb = p.workbook
@@ -676,7 +677,7 @@ end
 
 ## Book Views
 #
-## Book views let you specify which sheet the show as active when the user opens the work book as well as a bunch of other 
+## Book views let you specify which sheet the show as active when the user opens the work book as well as a bunch of other
 ## tuning values for the UI @see Axlsx::WorkbookView
 ## ```ruby
 if examples.include? :book_view
@@ -700,6 +701,7 @@ end
 if examples.include? :conditional_formatting
   percent = wb.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE_THIN_BORDER)
   money = wb.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
+  status = wb.styles.add_style(:border => Axlsx::STYLE_THIN_BORDER)
 
   # define the style for conditional formatting
   profitable = wb.styles.add_style( :fg_color => "FF428751", :type => :dxf )
@@ -763,6 +765,19 @@ if examples.include? :conditional_formatting
     icon_set = Axlsx::IconSet.new
     sheet.add_conditional_formatting("B3:B100", { :type => :iconSet, :dxfId => profitable, :priority => 1, :icon_set => icon_set })
   end
+
+  wb.add_worksheet(:name => "Contains Text") do |sheet|
+    sheet.add_row ["Previous Year Quarterly Profits (JPY)"]
+    sheet.add_row ["Quarter", "Profit", "% of Total", "Status"]
+    offset = 3
+    rows = 20
+    offset.upto(rows + offset) do |i|
+      sheet.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})", (10000*((rows/2-i) * (rows/2-i))) > 100000 ? "PROFIT" : "LOSS"], :style=>[nil, money, percent, status]
+    end
+  # Apply conditional formatting to range D3:D100 in the worksheet to match words.
+    sheet.add_conditional_formatting("D3:D100", { :type => :containsText, :operator => :equal, :text => "PROFIT", :dxfId => profitable, :priority => 1 })
+    sheet.add_conditional_formatting("D3:D100", { :type => :containsText, :operator => :equal, :text => "LOSS", :dxfId => unprofitable, :priority => 1 })
+  end
 end
 
 # Page Breaks
@@ -843,3 +858,18 @@ if examples.include? :rich_text
   p.serialize 'rich_text.xlsx'
 end
 #```
+
+##Change tab color of sheet
+
+#```ruby
+if examples.include? :tab_color
+  p = Axlsx::Package.new
+  p.use_shared_strings = true
+  wb = p.workbook
+  wb.add_worksheet(:name => "Change Tab Color") do |sheet|
+    sheet.add_row ["Check", "out", "the", "Tab Color", "below!"]
+    sheet.sheet_pr.tab_color = "FFFF6666"
+  end
+  p.serialize 'tab_color.xlsx'
+end
+##```

data/lib/axlsx.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 require 'htmlentities'
 require 'axlsx/version.rb'
+require 'mimemagic'
 
 require 'axlsx/util/simple_typed_list.rb'
 require 'axlsx/util/constants.rb'
@@ -10,7 +11,7 @@ require 'axlsx/util/serialized_attributes'
 require 'axlsx/util/options_parser'
 # to be included with parsable intitites.
 #require 'axlsx/util/parser.rb'
-require 'axlsx/util/string'
+require 'axlsx/util/mime_type_utils'
 
 require 'axlsx/stylesheet/styles.rb'
 
@@ -134,10 +135,14 @@ module Axlsx
   # @param [String] str The string to process
   # @return [String]
   def self.sanitize(str)
-    str.delete!(CONTROL_CHARS)
-    str
+    if str.frozen?
+      str.delete(CONTROL_CHARS)
+    else
+      str.delete!(CONTROL_CHARS)
+      str
+    end
   end
-  
+
   # If value is boolean return 1 or 0
   # else return the value
   # @param [Object] value The value to process

data/lib/axlsx/drawing/area_chart.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The AreaChart is a two dimentional line chart (who would have guessed?) that you can add to your worksheet.
+  # @example Creating a chart
+  #   # This example creates a line in a single sheet.
+  #   require "rubygems" # if that is your preferred way to manage gems!
+  #   require "axlsx"
+  #
+  #   p = Axlsx::Package.new
+  #   ws = p.workbook.add_worksheet
+  #   ws.add_row ["This is a chart with no data in the sheet"]
+  #
+  #   chart = ws.add_chart(Axlsx::AreaChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
+  #   chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
+  #
+  # @see Worksheet#add_chart
+  # @see Worksheet#add_row
+  # @see Chart#add_series
+  # @see Series
+  # @see Package#serialize
+  class AreaChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    def cat_axis
+      axes[:cat_axis]
+    end
+    alias :catAxis :cat_axis
+
+    # the category axis
+    # @return [ValAxis]
+    def val_axis
+      axes[:val_axis]
+    end
+    alias :valAxis :val_axis
+
+     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_reader :grouping
+
+    # Creates a new line chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Symbol] grouping
+    # @see Chart
+    def initialize(frame, options={})
+      @vary_colors = false
+      @grouping = :standard
+      super(frame, options)
+      @series_type = AreaSeries
+      @d_lbls = nil
+    end
+
+    # @see grouping
+    def grouping=(v)
+      RestrictionValidator.validate "AreaChart.grouping", [:percentStacked, :standard, :stacked], v
+      @grouping = v
+    end
+
+    # The node name to use in serialization. As AreaChart is used as the
+    # base class for Liine3DChart we need to be sure to serialize the
+    # chart based on the actual class type and not a fixed node name.
+    # @return [String]
+    def node_name
+      path = self.class.to_s
+      if i = path.rindex('::')
+        path = path[(i+2)..-1]
+      end
+      path[0] = path[0].chr.downcase
+      path
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << ("<c:" << node_name << ">")
+        str << ('<c:grouping val="' << grouping.to_s << '"/>')
+        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
+        @series.each { |ser| ser.to_xml_string(str) }
+        @d_lbls.to_xml_string(str) if @d_lbls
+        yield if block_given?
+        axes.to_xml_string(str, :ids => true)
+        str << ("</c:" << node_name << ">")
+        axes.to_xml_string(str)
+      end
+    end
+
+    # The axes for this chart. AreaCharts have a category and value
+    # axis.
+    # @return [Axes]
+    def axes
+      @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+    end
+  end
+end

data/lib/axlsx/drawing/area_series.rb

@@ -0,0 +1,110 @@
+# encoding: UTF-8
+module Axlsx
+  # A AreaSeries defines the title, data and labels for line charts
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class AreaSeries < Series
+
+    # The data for this series.
+    # @return [ValAxisData]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [CatAxisData]
+    attr_reader :labels
+
+    # The fill color for this series.
+    # Red, green, and blue is expressed as sequence of hex digits, RRGGBB. A perceptual gamma of 2.2 is used.
+    # @return [String]
+    attr_reader :color
+
+    # show markers on values
+    # @return [Boolean]
+    attr_reader :show_marker
+
+    # custom marker symbol
+    # @return [String]
+    attr_reader :marker_symbol
+
+    # line smoothing on values
+    # @return [Boolean]
+    attr_reader :smooth
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @param [Chart] chart
+    def initialize(chart, options={})
+      @show_marker = false
+      @marker_symbol = options[:marker_symbol] ? options[:marker_symbol] : :default
+      @smooth = false
+      @labels, @data = nil, nil
+      super(chart, options)
+      @labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
+      @data = NumDataSource.new(options) unless options[:data].nil?
+    end
+
+    # @see color
+    def color=(v)
+      @color = v
+    end
+
+    # @see show_marker
+    def show_marker=(v)
+      Axlsx::validate_boolean(v)
+      @show_marker = v
+    end
+
+    # @see marker_symbol
+    def marker_symbol=(v)
+      Axlsx::validate_marker_symbol(v)
+      @marker_symbol = v
+    end
+
+    # @see smooth
+    def smooth=(v)
+      Axlsx::validate_boolean(v)
+      @smooth = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        if color
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '<a:ln w="28800">'
+          str << '<a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '</a:ln>'
+          str << '<a:round/>'
+          str << '</c:spPr>'
+        end
+
+        if !@show_marker
+          str << '<c:marker><c:symbol val="none"/></c:marker>'
+        elsif @marker_symbol != :default
+          str << '<c:marker><c:symbol val="' + @marker_symbol.to_s + '"/></c:marker>'
+        end
+
+        @labels.to_xml_string(str) unless @labels.nil?
+        @data.to_xml_string(str) unless @data.nil?
+        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
+      end
+    end
+
+    private
+
+    # assigns the data for this series
+    def data=(v) DataTypeValidator.validate "Series.data", [NumDataSource], v; @data = v; end
+
+    # assigns the labels for this series
+    def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
+
+  end
+end

data/lib/axlsx/drawing/bar_chart.rb

@@ -0,0 +1,143 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The BarChart is a three dimentional barchart (who would have guessed?) that you can add to your worksheet.
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see Package#serialize
+  # @see README for an example
+  class BarChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    def cat_axis
+      axes[:cat_axis]
+    end
+    alias :catAxis :cat_axis
+
+    # the value axis
+    # @return [ValAxis]
+    def val_axis
+      axes[:val_axis]
+    end
+    alias :valAxis :val_axis
+
+    # The direction of the bars in the chart
+    # must be one of [:bar, :col]
+    # @return [Symbol]
+    def bar_dir
+      @bar_dir ||= :bar
+    end
+    alias :barDir :bar_dir
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    attr_reader :gap_depth
+    alias :gapDepth :gap_depth
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    def gap_width
+      @gap_width ||= 150
+    end
+    alias :gapWidth :gap_width
+
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    def grouping
+      @grouping ||= :clustered
+    end
+
+    # The shabe of the bars or columns
+    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
+    # @return [Symbol]
+    def shape
+      @shape ||= :box
+    end
+
+    # validation regex for gap amount percent
+    GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
+
+    # Creates a new bar chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Symbol] bar_dir
+    # @option options [Symbol] grouping
+    # @option options [String] gap_width
+    # @option options [String] gap_depth
+    # @option options [Symbol] shape
+    # @see Chart
+    def initialize(frame, options={})
+      @vary_colors = true
+      @gap_width, @gap_depth, @shape = nil, nil, nil
+      super(frame, options)
+      @series_type = BarSeries
+      @d_lbls = nil
+    end
+
+    # The direction of the bars in the chart
+    # must be one of [:bar, :col]
+    def bar_dir=(v)
+      RestrictionValidator.validate "BarChart.bar_dir", [:bar, :col], v
+      @bar_dir = v
+    end
+    alias :barDir= :bar_dir=
+
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    def grouping=(v)
+      RestrictionValidator.validate "BarChart.grouping", [:percentStacked, :clustered, :standard, :stacked], v
+      @grouping = v
+    end
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    def gap_width=(v)
+      RegexValidator.validate "BarChart.gap_width", GAP_AMOUNT_PERCENT, v
+      @gap_width=(v)
+    end
+    alias :gapWidth= :gap_width=
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    def gap_depth=(v)
+      RegexValidator.validate "BarChart.gap_didth", GAP_AMOUNT_PERCENT, v
+      @gap_depth=(v)
+    end
+    alias :gapDepth= :gap_depth=
+
+    # The shabe of the bars or columns
+    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
+    def shape=(v)
+      RestrictionValidator.validate "BarChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
+      @shape = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        str << '<c:barChart>'
+        str << ('<c:barDir val="' << bar_dir.to_s << '"/>')
+        str << ('<c:grouping val="' << grouping.to_s << '"/>')
+        str << ('<c:varyColors val="' << vary_colors.to_s << '"/>')
+        @series.each { |ser| ser.to_xml_string(str) }
+        @d_lbls.to_xml_string(str) if @d_lbls
+        str << ('<c:gapWidth val="' << @gap_width.to_s << '"/>') unless @gap_width.nil?
+        str << ('<c:gapDepth val="' << @gap_depth.to_s << '"/>') unless @gap_depth.nil?
+        str << ('<c:shape val="' << @shape.to_s << '"/>') unless @shape.nil?
+        axes.to_xml_string(str, :ids => true)
+        str << '</c:barChart>'
+        axes.to_xml_string(str)
+      end
+    end
+
+    # A hash of axes used by this chart. Bar charts have a value and
+    # category axes specified via axes[:val_axes] and axes[:cat_axis]
+    # @return [Axes]
+    def axes
+     @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+    end
+  end
+end