axlsx 1.1.4 → 1.3.1

data/examples/sprk2012/images.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
+
+require 'axlsx'
+package = Axlsx::Package.new do |package|
+  package.workbook.add_worksheet(:name => "imagex") do |sheet|
+    img_path = File.expand_path('../../image1.jpeg', __FILE__)
+    sheet.add_image(:image_src => img_path, :width => 720, :height => 666, :start_at => [2,2])
+  end
+end.serialize 'images.xlsx'

data/examples/sprk2012/line_chart.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
+require 'axlsx'
+
+data = [ ['oil-bbl',9591.411671,8860.714604,8237.936509,7700.523067,7231.831842,6819.307902,6453.297235,6126.251755,5832.182748,5566.276532,5324.618706,5103.992757,4901.730597,4715.600022,4543.718862,4384.488699,4236.543136,4098.707009,3969.963937,3849.430276,3736.33405,3629.997786,3529.824424,3435.28568,3345.912388,3261.286414,3181.033882,3104.819438,3032.341401,2963.327615,2897.531915,2834.731083,2774.722219,2717.320479,2662.357097,2609.677666,2559.140642,2510.616021,2463.984182,2419.134871,2375.966292,2334.384311,2294.301748,2255.637735,2218.317165,2182.270173,2147.431696,2113.741056,2081.141602,2049.580377,2019.007821,1989.377502,1960.645871,1932.772042,1905.71759,1879.446367,1853.924338,1829.119424,1805.001366,1781.541597,1758.713122,1736.490414,1714.849315,1693.766943,1673.22161,1653.192744,1633.660817,1614.607284,1596.014514,1577.865741,1560.145009,1542.837121,1525.927597,1509.402632,1493.249056,1477.454298,1462.006352,1446.893746,1432.105512,1417.631159,1403.460647,1389.584361,1375.993094,1362.678018,1349.630672,1336.842938,1324.307026,1312.015455,1299.961043,1288.136885,1276.536347,1265.153047,1253.980847,1243.013838,1232.246332,1221.672852,1211.288119,1201.087047,1191.064732,1181.216443,1171.537618,1162.023853,1152.670896,1143.474642,1134.431125,1125.536513,1116.787101,1108.179309,1099.709672,1091.37484,1083.171571,1075.096725,1067.147265,1059.320247,1051.612821,1044.022223,1036.545778,1029.180889,1021.92504,1014.775789],
+
+         ['gas-mcf', 940970.153,836556.732,748476.939,673307.64,608520.158,552204.935,502892.3,459432.263,420911.806,386596.658,355889.491,328299.357,303418.988,280907.679,260478.232,241886.857,224925.287,209414.552,195200.029,182147.455,170139.707,159074.174,148860.596,139419.282,130679.626,122578.864,115061.035,108076.1,101579.19,95529.972,89892.104,84632.762,79722.24,75133.597,70842.349,66826.213,63064.865,59539.742,56233.86,53131.662,50218.869,47482.365,44910.082,42490.907,40214.588,38071.662,36053.382,34151.656,32358.989,30668.434,29073.545,27568.334,26147.237,24805.079,23537.041,22338.633,21205.67,20134.246,19120.717,18161.677,17253.941,16394.533,15580.663,14809.724,14079.269,13387.006,12730.786,12108.59,11518.524,10958.809,10427.774,9923.847,9445.55,8991.492,8560.364,8150.934,7762.041,7392.59,7041.551,6707.951,6390.874,6089.452,5802.871,5530.358,5271.185,5024.664,4790.145,4567.013,4354.687,4152.618,3960.286,3777.198,3602.889,3436.919,3278.87,3128.347,2984.976,2848.401,2718.287,2594.316,2476.184,2363.606,2256.309,2154.037,2056.545,1963.599,1874.982,1790.482,1709.903,1633.054,1559.758,1489.844,1423.151,1359.525,1298.821,1240.899,1185.628,1132.883,1082.544,1034.499],
+
+         ['water-bbl',940.97,836.557,748.477,673.308,608.52,552.205,502.892,459.432,420.912,386.597,355.889,328.299,303.419,280.908,260.478,241.887,224.925,209.415,195.2,182.147,170.14,159.074,148.861,139.419,130.68,122.579,115.061,108.076,101.579,95.53,89.892,84.633,79.722,75.134,70.842,66.826,63.065,59.54,56.234,53.132,50.219,47.482,44.91,42.491,40.215,38.072,36.053,34.152,32.359,30.668,29.074,27.568,26.147,24.805,23.537,22.339,21.206,20.134,19.121,18.162,17.254,16.395,15.581,14.81,14.079,13.387,12.731,12.109,11.519,10.959,10.428,9.924,9.446,8.991,8.56,8.151,7.762,7.393,7.042,6.708,6.391,6.089,5.803,5.53,5.271,5.025,4.79,4.567,4.355,4.153,3.96,3.777,3.603,3.437,3.279,3.128,2.985,2.848,2.718,2.594,2.476,2.364,2.256,2.154,2.057,1.964,1.875,1.79,1.71,1.633,1.56,1.49,1.423,1.36,1.299,1.241,1.186,1.133,1.083,1.034] ]
+
+package = Axlsx::Package.new
+package.workbook.add_worksheet(:name => 'volumes') do |ws|
+
+  # perspective, rotX and rotY flatten the 3D chart
+  # hPercent sets the chart height to 100%
+  chart_options = {  :perspective => 0,
+                     :hPercent => 100,
+                     :rotX => 0,
+                     :rotY => 0,
+                     :start_at => "A4",
+                     :end_at => 'M44',
+                     :title => 'Monthly forcast for Type Curve Gas secondary - gross ngl' }
+
+  chart = ws.add_chart(Axlsx::Line3DChart, chart_options)
+
+  # Set up log based scaling and appropriate min/max values for Y axis
+  chart.valAxis.scaling.logBase = 10
+  chart.valAxis.scaling.min = 0.1
+  chart.valAxis.scaling.max = 10000000.0
+
+  # No poing in showing the series axis labels as the chart is flattened!
+  chart.serAxis.delete = true
+
+  # Knock the catAxis labels down to the forced min.
+  chart.catAxis.crosses = :min
+
+  # set up cat labels / markes to show every 12th item
+  chart.catAxis.tickLblSkip = 12
+  chart.catAxis.tickMarkSkip = 12
+
+  #rgb colors for our data series
+  colors = ['00FF00', 'FF0000', '0000FF']
+
+  data.each_with_index do |value, index|
+    ws.add_row value
+    chart.add_series :data => ws.rows.last.cells[(1..value.size-1)],
+      :labels => (0..value.size).map{ |i| i },
+      :title => ws.rows.last.cells.first,
+      :color => colors[index]
+  end
+end
+
+package.serialize 'line_chart.xlsx'
+

data/examples/sprk2012/styles.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
+
+require 'axlsx'
+package = Axlsx::Package.new
+package.workbook do |workbook|
+  workbook.styles do |s|
+    black_cell = s.add_style :bg_color => "00", :fg_color => "FF", :sz => 14, :alignment => { :horizontal=> :center }
+    blue_cell =  s.add_style  :bg_color => "0000FF", :fg_color => "FF", :sz => 20, :alignment => { :horizontal=> :center }
+
+    workbook.add_worksheet(:name => "Styles") do |sheet|
+      # Applies the black_cell style to the first and third cell, and the blue_cell style to the second.
+      sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
+
+      # Applies the thin border to all three cells
+      sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+    end
+  end
+end
+package.serialize 'styles.xlsx'
+

data/examples/styles.rb

@@ -0,0 +1,62 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+require 'date'
+
+p = Axlsx::Package.new
+wb = p.workbook
+wb.styles do |style|
+
+  # Date/Time Styles
+  #
+  # The most important thing to remember about OOXML styles is that they are
+  # exclusive. This means that each style must define all the components it
+  # requires to render the cell the way you want. A good example of this is
+  # changing the font size for a date. You cannot specify just the font size,
+  # you must also specify the number format or format code so that renders
+  # know how to display the serialized date float value 
+  #
+  # The parts that make up a custom styles are:
+  #
+  # fonts(Font), fills(Fill), borders(Border) and number formats(NumFmt).
+  # Getting to know those classes will help you make the most out of custom
+  # styling. However axlsx certainly does not expect you to create all those
+  # objects manually.
+  #
+  # workbook.styles.add_style provides a helper method 'add_style' for defining
+  # styles in one go. The docs for that method are definitely worth a read.
+  # @see Style#add_style
+
+  # When no style is applied to a cell, axlsx will automatically apply date/time
+  # formatting to Date and Time objects for you. However, if you are defining
+  # custom styles, you define all aspects of the style you want to apply.
+  #
+  # An aside on styling and auto-width. Auto-width calculations do not
+  # currently take into account any style or formatting you have applied to the
+  # data in your cells as it would require the creation of a rendering engine,
+  # and frankly kill performance. If you are doing a lot of custom formatting,
+  # you are going to be better served by specifying fixed column widths.
+  #
+  # Let's look at an example:
+  #
+  # A style that only applies a font size
+  large_font = wb.styles.add_style :sz => 20
+
+  # A style that applies both a font size and a predefined number format.
+  # @see NumFmt
+  predefined_format = wb.styles.add_style :sz => 20, :num_fmt => 14
+
+  # A style that a applies a font size and a custom formatting code
+  custom_format = wb.styles.add_style :sz => 20, :format_code => 'yyyy-mm-dd'
+
+
+  wb.add_worksheet do |sheet|
+
+    # We then apply those styles positionally
+    sheet.add_row [123, "123", Time.now], style: [nil, large_font, predefined_format]
+    sheet.add_row [123, "123", Date.new(2012, 9, 14)], style: [large_font, nil, custom_format]
+    sheet.add_row [123, "123", Date.new(2000, 9, 12)] # This uses the axlsx default format_code (14)
+  end
+
+end
+p.serialize 'styles.xlsx'
+

data/examples/two_cell_anchor_image.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+src = "#{File.dirname(__FILE__)}/image1.png"
+p.workbook.add_worksheet(:name => 'double_anchor') do |ws|
+  ws.add_image(:image_src => src, :start_at => [0,0], :end_at => [2,4])
+end
+p.serialize('two_cell_anchor_image.xlsx')

data/lib/axlsx/content_type/content_type.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 module Axlsx
+
   require 'axlsx/content_type/default.rb'
   require 'axlsx/content_type/override.rb'
 
@@ -21,4 +22,5 @@ module Axlsx
     end
 
   end
+
 end

data/lib/axlsx/content_type/default.rb

@@ -1,41 +1,56 @@
 # encoding: UTF-8
 module Axlsx
+
   # An default content part. These parts are automatically created by for you based on the content of your package.
   class Default
 
+    #Creates a new Default object
+    # @option options [String] extension
+    # @option options [String] content_type
+    # @raise [ArgumentError] An argument error is raised if both extension and content_type are not specified.
+    def initialize(options={})
+      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
+      options.each do |name, value|
+        self.send("#{name}=", value) if self.respond_to? "#{name}="
+      end
+    end
+
+    # Error string for option validation
+    INVALID_ARGUMENTS = "extension and content_type are required"
+
     # The extension of the content type.
     # @return [String]
-    attr_reader :Extension
+    attr_reader :extension
+    alias :Extension :extension
 
     # The type of content.
     # @return [String]
-    attr_reader :ContentType
+    attr_reader :content_type
+    alias :ContentType :content_type
 
-    #Creates a new Default object
-    # @option options [String] Extension
-    # @option options [String] ContentType
-    # @raise [ArgumentError] An argument error is raised if both Extension and ContentType are not specified.
-    def initialize(options={})
-      raise ArgumentError, "Extension and ContentType are required" unless options[:Extension] && options[:ContentType]
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
     # Sets the file extension for this content type.
-    def Extension=(v) Axlsx::validate_string v; @Extension = v end
+    def extension=(v) Axlsx::validate_string v; @extension = v end
+    alias :Extension= :extension=
 
     # Sets the content type
     # @see Axlsx#validate_content_type
-    def ContentType=(v) Axlsx::validate_content_type v; @ContentType = v end
+    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
+    alias :ContentType= :content_type=
 
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<Default '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
       str << '/>'
     end
 
+    private
+    def validate_options(options)
+      (options[:Extension] || options[:extension]) && (options[:content_type] || options[:ContentType])
+    end
+
   end
+
 end

data/lib/axlsx/content_type/override.rb

@@ -1,42 +1,57 @@
 # encoding: UTF-8
 module Axlsx
+
   # An override content part. These parts are automatically created by for you based on the content of your package.
   class Override
 
-    # The type of content.
-    # @return [String]
-    attr_reader :ContentType
-
-    # The name and location of the part.
-    # @return [String]
-    attr_reader :PartName
-
     #Creates a new Override object
     # @option options [String] PartName
     # @option options [String] ContentType
     # @raise [ArgumentError] An argument error is raised if both PartName and ContentType are not specified.
     def initialize(options={})
-      raise ArgumentError, "PartName and ContentType are required" unless options[:PartName] && options[:ContentType]
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
+      options.each do |name, value|
+        self.send("#{name}=", value) if self.respond_to? "#{name}="
       end
     end
 
+    # Error message for invalid options
+    INVALID_ARGUMENTS = 'part_name and content_type are required'
+
+    # The type of content.
+    # @return [String]
+    attr_reader :content_type
+    alias :ContentType :content_type
+
+    # The name and location of the part.
+    # @return [String]
+    attr_reader :part_name
+    alias :PartName :part_name
+
     # The name and location of the part.
-    def PartName=(v) Axlsx::validate_string v; @PartName = v end
+    def part_name=(v) Axlsx::validate_string v; @part_name = v end
+    alias :PartName= :part_name=
 
     # The content type.
     # @see Axlsx#validate_content_type
-    def ContentType=(v) Axlsx::validate_content_type v; @ContentType = v end
+    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
+    alias :ContentType= :content_type=
 
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<Override '
-      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
       str << '/>'
     end
 
+    private 
+
+    def validate_options(options)
+      (options[:PartName] || options[:part_name]) && (options[:ContentType] || options[:content_type])
+    end
+
   end
+
 end