axlsx 1.0.10 → 1.0.11

data/doc/top-level-namespace.html

@@ -94,7 +94,7 @@
 </div>
     
     <div id="footer">
-  Generated on Wed Nov 30 08:53:53 2011 by 
+  Generated on Mon Dec  5 14:21:23 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.8.7).
 </div>

data/examples/example.rb

@@ -9,7 +9,7 @@ if ARGV.size == 0 || ARGV.include?("1")
       p = Axlsx::Package.new
       p.workbook.add_worksheet do |sheet|
         sheet.add_row ["First", "Second", "Third"]
-        sheet.add_row [1, 2, 3]
+        sheet.add_row [1, 2, Time.now]
       end
       p.serialize("example1.xlsx")
 end
@@ -18,26 +18,29 @@ if ARGV.size==0 || ARGV.include?("2")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["A Simple Bar Chart"]
        sheet.add_row ["First", "Second", "Third"]
        sheet.add_row [1, 2, 3]
-       sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 2: Chart") do |chart|
-         chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
+       sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A4", :end_at => "F17", :title=>sheet["A1"]) do |chart|
+         chart.add_series :data => sheet["A3:C3"], :labels => sheet["A2:C2"]
        end
      end  
      p.serialize("example2.xlsx")
+
 end
 #Generating A Pie Chart
 if ARGV.size==0 || ARGV.include?("3")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
-       sheet.add_row ["First", "Second", "Third"]
-       sheet.add_row [1, 2, 3]
+       sheet.add_row ["First", "Second", "Third", "Fourth"]
+       sheet.add_row [1, 2, 3, "=PRODUCT(A2:C2)"]
        sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 3: Pie Chart") do |chart|
-         chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
+         chart.add_series :data => sheet["A2:D2"], :labels => sheet["A1:D1"]
        end
      end  
      p.serialize("example3.xlsx")
+
 end
 
 #Using Custom Styles
@@ -45,13 +48,14 @@ if ARGV.size==0 || ARGV.include?("4")
 
      p = Axlsx::Package.new
      wb = p.workbook
-     black_cell = wb.styles.add_style :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
-     blue_cell = wb.styles.add_style  :bg_color => "FF0000FF", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
+     black_cell = wb.styles.add_style :bg_color => "00", :fg_color => "FF", :sz=>14, :alignment => { :horizontal=> :center }
+     blue_cell = wb.styles.add_style  :bg_color => "0000FF", :fg_color => "FF", :sz=>14, :alignment => { :horizontal=> :center }
      wb.add_worksheet do |sheet|
        sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
        sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
      end
      p.serialize("example4.xlsx")
+
 end
 #Using Custom Formatting and date1904
 if ARGV.size==0 || ARGV.include?("5")
@@ -80,6 +84,7 @@ if ARGV.size==0 || ARGV.include?("6")
      p.validate.each do |error|
        puts error.inspect
      end
+
 end      
 #Generating A Line Chart
 if ARGV.size==0 || ARGV.include?("7")
@@ -91,26 +96,29 @@ if ARGV.size==0 || ARGV.include?("7")
        sheet.add_chart(Axlsx::Line3DChart, :title=>"example 6: Line Chart") do |chart|
          chart.start_at 0, 2
          chart.end_at 10, 15
-         chart.add_series :data=>sheet.rows.first.cells[(1..-1)], :title=> sheet.rows.first.cells.first
+         chart.add_series :data=>["B1:E1"], :title=> sheet["A1"]
          chart.add_series :data=>sheet.rows.last.cells[(1..-1)], :title=> sheet.rows.last.cells.first
        end
        
      end  
      p.serialize("example7.xlsx")
+
 end
+
 #Add an Image
 if ARGV.size==0 || ARGV.include?("8")
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
        img = File.expand_path('examples/image1.jpeg') 
-       sheet.add_image(:image_src => img) do |image|
+       sheet.add_image(:image_src => img, :noSelect=>true, :noMove=>true) do |image|
          image.width=720
          image.height=666
          image.start_at 2, 2
        end
      end  
      p.serialize("example8.xlsx")
+
 end
 
 #Asian Language Support
@@ -123,11 +131,13 @@ if ARGV.size==0 || ARGV.include?("9")
        sheet.add_row ["한국어/조선말"]
      end  
      p.serialize("example9.xlsx")
+
 end
 
 
 #Styling Columns
 if ARGV.size==0 || ARGV.include?("10")
+
      p = Axlsx::Package.new
      percent = p.workbook.styles.add_style :num_fmt => 9
      p.workbook.add_worksheet do |sheet|
@@ -138,10 +148,12 @@ if ARGV.size==0 || ARGV.include?("10")
      end
      p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1
      p.serialize("example10.xlsx")
+
 end
 
 #Styling Rows
 if ARGV.size==0 || ARGV.include?("11")
+
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
        sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
@@ -149,27 +161,42 @@ if ARGV.size==0 || ARGV.include?("11")
        sheet.add_row [1, 2, 0.2, 4]
        sheet.add_row [1, 2, 0.1, 4]
      end
-     head = p.workbook.styles.add_style :bg_color => "FF000000", :fg_color=>"FFFFFFFF"
+     head = p.workbook.styles.add_style :bg_color => "00", :fg_color=>"FF"
      percent = p.workbook.styles.add_style :num_fmt => 9
      p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1
      p.workbook.worksheets.first.row_style 0, head
      p.serialize("example11.xlsx")
+
 end
 
-#Rails 3
-      
-     #  class MyModel < ActiveRecord::Base
-     #    acts_as_axlsx
-     #  end
-     #
-     # class MyModelController <  ApplicationController
-     #
-     #   GET /posts/xlsx
-     #   def xlsx
-     #     p = Post.to_xlsx
-     #     p.serialize('posts.xlsx')
-     #     send_file 'posts.xlsx', :type=>"application/xlsx", :x_sendfile=>true
-     #   end
+#Using formula
+if ARGV.size==0 || ARGV.include?("12")
+
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
+       sheet.add_row [1, 2, 3, "=SUM(A2:C2)"]
+     end
+     p.serialize("example12.xlsx")
+
+end
+
+
+#Using cell specific styling and range / name based access
+if ARGV.size==0 || ARGV.include?("13")
+
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet(:name=>'My Worksheet') do |sheet|
+         # cell level style overides when adding cells
+         sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4'], :sz => 16
+         sheet.add_row [1, 2, 3, "=SUM(A2:C2)"]
+         # cell level style overrides via sheet range
+         sheet["A1:D1"].each { |c| c.color = "FF0000"}
+     end     
+     p.workbook['My Worksheet!A1:D2'].each { |c| c.style = Axlsx::STYLE_THIN_BORDER }
+     p.serialize("example13.xlsx")
+
+end
 
      
 

data/lib/axlsx.rb

@@ -1,10 +1,13 @@
-
 Encoding::default_internal = 'UTF-8' unless RUBY_VERSION < '1.9'
 Encoding::default_external = 'UTF-8' unless RUBY_VERSION < '1.9'
 
 require 'axlsx/util/simple_typed_list.rb'
 require 'axlsx/util/constants.rb'
 require 'axlsx/util/validators.rb'
+
+# to be included with parsable intitites.
+#require 'axlsx/util/parser.rb'
+
 require 'axlsx/stylesheet/styles.rb'
 
 require 'axlsx/doc_props/app.rb'
@@ -38,4 +41,14 @@ module Axlsx
     ref += ":#{items.last.r_abs}" if items.size > 1
     ref
   end
+
+  def self.name_to_indices(name)
+    raise ArgumentError, 'invalid cell name' unless name.size > 1
+    v = name[/[A-Z]+/].reverse.chars.reduce({:base=>1, :i=>0}) do  |v, c|        
+      v[:i] += ((c.bytes.first - 65) + v[:base]); v[:base] *= 26; v 
+    end
+
+    [v[:i]-1, ((name[/[1-9]+/]).to_i)-1]
+
+  end
 end

data/lib/axlsx/drawing/chart.rb

@@ -51,8 +51,8 @@ module Axlsx
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
-      start_at(*options[:start_at]) if options[:start_at]
-      end_at(*options[:end_at]) if options[:start_at]
+      start_at *options[:start_at] if options[:start_at]
+      end_at *options[:end_at] if options[:start_at]
       yield self if block_given?
     end
 
@@ -140,7 +140,8 @@ module Axlsx
     # @param [Integer] x The column
     # @param [Integer] y The row
     # @return [Marker]
-    def start_at(x, y)
+    def start_at(x, y=0)
+      x, y = *parse_coord_args(x, y)
       @graphic_frame.anchor.from.col = x
       @graphic_frame.anchor.from.row = y
     end
@@ -151,12 +152,27 @@ module Axlsx
     # @param [Integer] x The column
     # @param [Integer] y The row
     # @return [Marker]
-    def end_at(x, y)
+    def end_at(x, y=0)
+      x, y = *parse_coord_args(x, y)
       @graphic_frame.anchor.to.col = x
       @graphic_frame.anchor.to.row = y
     end
 
     private
+
+    def parse_coord_args(x, y=0)
+      if x.is_a?(String)
+        x, y = *Axlsx::name_to_indices(x)
+      end
+      if x.is_a?(Cell)
+        x, y = *x.pos
+      end
+      if x.is_a?(Array)
+        x, y = *x
+      end
+      [x, y]
+    end
+
     def view3D=(v) DataTypeValidator.validate "#{self.class}.view3D", View3D, v; @view3D = v; end
 
   end

data/lib/axlsx/drawing/drawing.rb

@@ -27,7 +27,7 @@ module Axlsx
   require 'axlsx/drawing/bar_3D_chart.rb'
   require 'axlsx/drawing/line_3D_chart.rb'
 
-
+  require 'axlsx/drawing/picture_locking.rb'
   require 'axlsx/drawing/pic.rb'
 
   # A Drawing is a canvas for charts. Each worksheet has a single drawing that manages anchors.

data/lib/axlsx/drawing/pic.rb

@@ -26,6 +26,8 @@ module Axlsx
     # @return [OneCellAnchor]
     attr_reader :anchor
 
+    # The picture locking attributes for this picture
+    attr_reader :picture_locking
    
     # Creates a new Pic(ture) object
     # @param [Anchor] anchor the anchor that holds this image
@@ -43,6 +45,7 @@ module Axlsx
       end
       start_at(*options[:start_at]) if options[:start_at]
       yield self if block_given?
+      @picture_locking = PictureLocking.new(options)
     end
     
     def image_src=(v) 
@@ -94,7 +97,7 @@ module Axlsx
     def width=(v)
       @anchor.width = v
     end
-
+    
     # providing access to update the anchor's height attribute
     # @param [Integer] v
     # @see OneCellAnchor.width
@@ -126,7 +129,7 @@ module Axlsx
         xml.send('xdr:nvPicPr') {
           xml.send('xdr:cNvPr', :id=>"2", :name=>name, :descr=>descr)
           xml.send('xdr:cNvPicPr') {
-            xml.send('a:picLocks', :noChangeAspect=>1)
+            picture_locking.to_xml(xml)
           }
         }
         xml.send('xdr:blipFill') {

data/lib/axlsx/drawing/picture_locking.rb

@@ -0,0 +1,72 @@
+module Axlsx
+  # The picture locking class defines the locking properties for pictures in your workbook. 
+  class PictureLocking
+    
+    
+    attr_reader :noGrp
+    attr_reader :noSelect
+    attr_reader :noRot
+    attr_reader :noChangeAspect
+    attr_reader :noMove
+    attr_reader :noResize
+    attr_reader :noEditPoints
+    attr_reader :noAdjustHandles
+    attr_reader :noChangeArrowheads
+    attr_reader :noChangeShapeType
+
+    # Creates a new PictureLocking object
+    # @option options [Boolean] noGrp
+    # @option options [Boolean] noSelect
+    # @option options [Boolean] noRot
+    # @option options [Boolean] noChangeAspect
+    # @option options [Boolean] noMove
+    # @option options [Boolean] noResize
+    # @option options [Boolean] noEditPoints
+    # @option options [Boolean] noAdjustHandles
+    # @option options [Boolean] noChangeArrowheads
+    # @option options [Boolean] noChangeShapeType
+    def initialize(options={})
+      @noChangeAspect = true
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end        
+
+    # @see noGrp
+    def noGrp=(v) Axlsx::validate_boolean v; @noGrp = v end    
+
+    # @see noSelect
+    def noSelect=(v) Axlsx::validate_boolean v; @noSelect = v end    
+
+    # @see noRot
+    def noRot=(v) Axlsx::validate_boolean v; @noRot = v end    
+
+    # @see noChangeAspect
+    def noChangeAspect=(v) Axlsx::validate_boolean v; @noChangeAspect = v end    
+
+    # @see noMove
+    def noMove=(v) Axlsx::validate_boolean v; @noMove = v end    
+
+    # @see noResize
+    def noResize=(v) Axlsx::validate_boolean v; @noResize = v end    
+
+    # @see noEditPoints
+    def noEditPoints=(v) Axlsx::validate_boolean v; @noEditPoints = v end    
+
+    # @see noAdjustHandles
+    def noAdjustHandles=(v) Axlsx::validate_boolean v; @noAdjustHandles = v end    
+
+    # @see noChangeArrowheads
+    def noChangeArrowheads=(v) Axlsx::validate_boolean v; @noChangeArrowheads = v end    
+
+    # @see noChangeShapeType
+    def noChangeShapeType=(v) Axlsx::validate_boolean v; @noChangeShapeType = v end    
+
+    # Serializes the picture locking
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml[:a].picLocks(self.instance_values)      
+    end
+  end
+end

data/lib/axlsx/package.rb

@@ -16,12 +16,6 @@ module Axlsx
       yield self if block_given?
     end
 
-    # Accepts a ruport table for serialization to xlsx
-    # @param [Table] table a ruport Table object
-    def ruport_table(table)
-      puts table
-    end
-
     # The workbook this package will serialize or validate.
     # @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned.
     # @raise ArgumentError if workbook parameter is not a Workbook instance.
@@ -39,6 +33,13 @@ module Axlsx
       yield @workbook if block_given?
       @workbook
     end
+    
+    #def self.parse(input, confirm_valid = false)
+    #  p = Package.new
+    #  z = Zip::ZipFile.open(input)
+    #  p.workbook = Workbook.parse z.get_entry(WORKBOOK_PN)
+    #  p
+    #end    
 
     # @see workbook
     def workbook=(workbook) DataTypeValidator.validate "Package.workbook", Workbook, workbook; @workbook = workbook; end
@@ -76,7 +77,8 @@ module Axlsx
       end
       true
     end
-
+    
+    
     # Validate all parts of the package against xsd schema. 
     # @return [Array] An array of all validation errors found.
     # @note This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip and OpenPackagingConventions-XMLSchema.zip

data/lib/axlsx/stylesheet/color.rb

@@ -5,16 +5,19 @@ module Axlsx
     # @return [Boolean]
     attr_reader :auto
     
-    # Backwards compatability color index
-    # return [Integer]
-    #attr_reader :indexed
-
     # The color as defined in rgb terms. 
     # @note 
     #  rgb colors need to conform to ST_UnsignedIntHex. That basically means put 'FF' before you color
-    # @example rgb colors
-    #  "FF000000" is black
-    #  "FFFFFFFF" is white
+    # When assigning the rgb value the behavior is much like CSS selectors and can use shorthand versions as follows:
+    # If you provide a two character value it will be repeated for each r, g, b assignment
+    # If you provide data that is not 2 characters in length, and is less than 8 characters it will be padded with "F"
+    # @example
+    #        Color.new :rgb => "FF000000"
+    #          => #<Axlsx::Color:0x102106b68 @rgb="FF000000">
+    #        Color.new :rgb => "0A"
+    #          => #<Axlsx::Color:0x102106b68 @rgb="FF0A0A0A">
+    #        Color.new :rgb => "00BB"
+    #          => #<Axlsx::Color:0x102106b68 @rgb="FFFF00BB">
     # @return [String]
     attr_reader :rgb
 
@@ -39,8 +42,15 @@ module Axlsx
     end
     # @see auto
     def auto=(v) Axlsx::validate_boolean v; @auto = v end    
-    # @see rgb
-    def rgb=(v) Axlsx::validate_string v; @rgb = v end    
+    # @see color
+    def rgb=(v)
+      Axlsx::validate_string(v)
+      v.upcase!
+      v = v * 3 if v.size == 2
+      v = v.rjust(8, 'FF')
+      raise ArgumentError, "Invalid color rgb value: #{v}." unless v.match(/[0-9A-F]{8}/)
+      @rgb = v
+    end
     # @see tint
     def tint=(v) Axlsx::validate_float v; @tint = v end