axlsx 1.1.0 → 1.2.0

data/examples/scraping_html.rb

@@ -0,0 +1,91 @@
+    require 'rubygems'
+    require 'nokogiri'
+    require 'open-uri'
+    require 'axlsx'
+
+    class Scraper
+
+       def initialize(url, selector)
+         @url = url
+         @selector = selector
+       end
+
+       def hooks
+         @hooks ||= {}
+       end
+
+       def add_hook(clue, p_roc)
+         hooks[clue] = p_roc
+       end
+
+       def export(file_name)
+         Scraper.clues.each do |clue|
+           if detail = parse_clue(clue)
+             output << [clue, detail.pop]
+             detail.each { |datum| output << ['', datum] }
+           end
+         end
+         serialize(file_name)
+       end
+
+       private
+
+       def self.clues
+         @clues ||= ['Operating system', 'Processors', 'Chipset', 'Memory type', 'Hard drive', 'Graphics',
+                     'Ports', 'Webcam', 'Pointing device', 'Keyboard', 'Network interface', 'Chipset', 'Wireless',
+                     'Power supply type', 'Energy efficiency', 'Weight', 'Minimum dimensions (W x D x H)',
+                     'Warranty', 'Software included', 'Product color']
+       end
+
+       def doc
+         @doc ||= begin 
+                    Nokogiri::HTML(open(@url))
+                  rescue
+                    raise ArgumentError, 'Invalid URL - Nothing to parse'
+                  end
+       end
+
+       def output
+         @output ||= []
+       end
+
+       def selector_for_clue(clue)
+         @selector % clue
+       end
+
+       def parse_clue(clue)
+         if element = doc.at(selector_for_clue(clue))
+           call_hook(clue, element) || element.inner_html.split('<br>').each(&:strip)
+         end
+       end
+
+       def call_hook(clue, element)
+         if hooks[clue].is_a? Proc
+            value = hooks[clue].call(element)
+            value.is_a?(Array) ? value : [value]
+         end
+       end
+
+       def package
+         @package ||= Axlsx::Package.new
+       end
+
+       def serialize(file_name)
+         package.workbook.add_worksheet do |sheet|
+           output.each { |datum| sheet.add_row datum }
+         end
+         package.serialize(file_name)
+       end
+    end
+
+    scraper = Scraper.new("http://h10010.www1.hp.com/wwpc/ie/en/ho/WF06b/321957-321957-3329742-89318-89318-5186820-5231694.html?dnr=1", "//td[text()='%s']/following-sibling::td")
+
+    # define a custom action to take against any elements found.
+    os_parse = Proc.new do |element|
+      element.inner_html.split('<br>').each(&:strip!).each(&:upcase!)
+    end
+
+    scraper.add_hook('Operating system', os_parse)
+
+    scraper.export('foo.xlsx')
+

data/examples/sheet_protection.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+p.workbook.add_worksheet(:name => 'Open Office') { |ws| ws.sheet_protection.password = 'fish' }
+p.serialize 'sheet_protection.xlsx'
+
+

data/examples/sheet_view.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+ws = p.workbook.add_worksheet :name => "Sheetview - Split"
+ws.sheet_view do |vs|
+  vs.pane do |p|
+    p.active_pane = :top_right
+    p.state = :split
+    p.x_split = 11080
+    p.y_split = 5000
+    p.top_left_cell = 'C44'
+  end
+  
+  vs.add_selection(:top_left, { :active_cell => 'A2', :sqref => 'A2' })
+  vs.add_selection(:top_right, { :active_cell => 'I10', :sqref => 'I10' })
+  vs.add_selection(:bottom_left, { :active_cell => 'E55', :sqref => 'E55' })
+  vs.add_selection(:bottom_right, { :active_cell => 'I57', :sqref => 'I57' })
+end
+
+
+ws = p.workbook.add_worksheet :name => "Sheetview - Frozen"
+ws.sheet_view do |vs|
+  vs.pane do |p|
+    p.state = :frozen
+    p.x_split = 3
+    p.y_split = 4
+  end
+end
+
+
+p.serialize 'sheet_view.xlsx'

data/examples/skydrive/real_example.rb

@@ -0,0 +1,63 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require 'axlsx'
+
+Axlsx::Package.new do |p|
+  p.workbook do |wb|
+    styles = wb.styles
+    header = styles.add_style :bg_color => "DD", :sz => 16, :b => true, :alignment => {:horizontal => :center}
+    tbl_header = styles.add_style :b => true, :alignment => { :horizontal => :center }
+    ind_header = styles.add_style :bg_color => "FFDFDEDF", :b => true, :alignment => {:indent => 1}
+    col_header  = styles.add_style :bg_color => "FFDFDEDF", :b => true, :alignment => { :horizontal => :center }
+    label       = styles.add_style :alignment => { :indent => 1 }
+    money       = styles.add_style :num_fmt => 5
+    t_label       = styles.add_style :b => true, :bg_color => "FFDFDEDF"
+    t_money = styles.add_style :b => true, :num_fmt => 5, :bg_color => "FFDFDEDF"
+
+    wb.add_worksheet do |sheet|
+      sheet.add_row
+      sheet.add_row [nil, "College Budget"], :style => [nil, header]
+      sheet.add_row
+      sheet.add_row [nil, "What's coming in this month.", nil, nil, "How am I doing"], :style => tbl_header
+      sheet.add_row [nil, "Item", "Amount", nil, "Item", "Amount"], :style => [nil, ind_header, col_header, nil, ind_header, col_header]
+      sheet.add_row [nil, "Estimated monthly net income", 500, nil, "Monthly income", "=C9"], :style => [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Financial aid", 100, nil, "Monthly expenses", "=C27"], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Allowance from mom & dad", 20000, nil, "Semester expenses", "=F19"], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Total", "=SUM(C6:C8)", nil, "Difference", "=F6 - SUM(F7:F8)"], :style => [nil, t_label, t_money, nil, t_label, t_money]
+      sheet.add_row
+      sheet.add_row [nil, "What's going out this month.", nil, nil, "Semester Costs"], :style => tbl_header
+      sheet.add_row [nil, "Item", "Amount", nil, "Item", "Amount"], :style => [nil, ind_header, col_header, nil, ind_header, col_header]
+      sheet.add_row [nil, "Rent", 650, nil, "Tuition", 200], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Utilities", 120, nil, "Lab fees", 50], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Cell phone", 100, nil, "Other fees", 10], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Groceries", 75, nil, "Books", 150], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Auto expenses", 0, nil, "Deposits", 0], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Student loans", 0, nil, "Transportation", 30], :style =>  [nil, label, money, nil, label, money]
+      sheet.add_row [nil, "Other loans", 350, nil, "Total", "=SUM(F13:F18)"], :style => [nil, label, money, nil, t_label, t_money]
+      sheet.add_row [nil, "Credit cards", 450], :style => [nil, label, money]
+      sheet.add_row [nil, "Insurance", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Laundry", 10], :style => [nil, label, money]
+      sheet.add_row [nil, "Haircuts", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Medical expenses", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Entertainment", 500], :style => [nil, label, money]
+      sheet.add_row [nil, "Miscellaneous", 0], :style => [nil, label, money]
+      sheet.add_row [nil, "Total", "=SUM(C13:C26)"], :style => [nil, t_label, t_money]
+      sheet.add_chart(Axlsx::Pie3DChart) do |chart|
+        chart.title = sheet["B11"]
+        chart.add_series :data => sheet["C13:C26"], :labels => sheet["B13:B26"]
+        chart.start_at 7, 2
+        chart.end_at 12, 15
+      end
+      sheet.add_chart(Axlsx::Bar3DChart, :barDir => :col) do |chart|
+        chart.title = sheet["E11"]
+        chart.add_series :labels => sheet["E13:E18"], :data => sheet["F13:F18"]
+        chart.start_at 7, 16
+        chart.end_at 12, 31
+      end
+      sheet.merged_cells.concat ["B4:C4","E4:F4","B11:C11","E11:F11","B2:F2"]
+      sheet.column_widths 2, nil, nil, 2, nil, nil, 2
+    end
+  end
+  p.use_shared_strings = true
+  p.serialize 'axlsx.xlsx'
+end

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