axlsx 1.2.0 → 1.2.1

data/README.md

@@ -25,7 +25,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 
 **Rubinius Version**: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.
 
-**Release Date**: August 5th 2012
+**Release Date**: August 12th 2012
 
 If you are working in rails, or with active record see:
 * http://github.com/randym/acts_as_xlsx
@@ -145,6 +145,10 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
+- **August.12.12**: 1.2.1
+   - Add support for hyperlinks in worksheets
+   - Fix example that was using old style cell merging with concact.
+   - Fix bug that occurs when calculating the font_size for cells that use a user specified style which does not define sz
 - **August.5.12**: 1.2.0
    - rebuilt worksheet serialization to clean up the code base a bit.
    - added data labels for charts
@@ -229,6 +233,7 @@ done without the help of the people below.
 
 [straydogstudio](https://github.com/straydocstudio) - For making an AWESOME axlsx templating gem for rails.
 
+[MitchellAJ](https://github.com/MitchellAJ) - For catching a bug in font_size calculations, finding some old code in an example and above all for reporting all of that brilliantly
 #Copyright and License
 ----------
 

data/examples/example.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby -w -s
 # -*- coding: utf-8 -*-
-# $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
 
 #```ruby
 require 'axlsx'
@@ -202,8 +202,32 @@ wb.add_worksheet(:name => "Automatic cell types") do |sheet|
   sheet.add_row ["Date", "Time", "String", "Boolean", "Float", "Integer"]
   sheet.add_row [Date.today, Time.now, "value", true, 0.1, 1], :style => [date_format, time_format]
 end
+
+
+# Hyperlinks in worksheet
+wb.add_worksheet(:name => 'hyperlinks') do |sheet|
+  # external references
+  sheet.add_row ['axlsx']
+  sheet.add_hyperlink :location => 'https://github.com/randym/axlsx', :ref => sheet.rows.first.cells.first
+
+  # internal references
+  sheet.add_row ['next sheet']
+end
+
+wb.add_worksheet(:name => 'Next Sheet') do |sheet|
+  sheet.add_row ['hello!']
+end
 #```
 
+##Number formatting and currency
+wb.add_worksheet(:name => "Formats and Currency") do |sheet|
+  currency = wb.styles.add_style :num_fmt => 5
+  red_negative = wb.styles.add_style :num_fmt => 8
+  comma = wb.styles.add_style :num_fmt => 3
+  super_funk = wb.styles.add_style :format_code => '[Green]"super funk: " #'
+  sheet.add_row %w(Currency RedNegative, Comma Custom)
+  sheet.add_row [1500, -122.34, 123456789, 594829], :style=> [currency, red_negative, comma, super_funk]
+end
 
 ##Generating A Bar Chart
 

data/examples/hyperlinks.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+wb.add_worksheet(:name => 'hyperlinks') do |sheet|
+  # external references
+  sheet.add_row ['axlsx']
+  sheet.add_hyperlink :location => 'https://github.com/randym/axlsx', :ref => sheet.rows.first.cells.first
+  # internal references
+  sheet.add_row ['next sheet']
+  sheet.add_hyperlink :location => "'Next Sheet'!A1", :target => :sheet, :ref => 'A2'
+end
+
+wb.add_worksheet(:name => 'Next Sheet') do |sheet|
+  sheet.add_row ['hello!']
+end
+
+p.serialize 'hyperlinks.xlsx'

data/examples/skydrive/real_example.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
 
 require 'axlsx'
 
@@ -54,7 +54,7 @@ Axlsx::Package.new do |p|
         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"]
+      %w(B4:C4 E4:F4 B11:C11 E11:F11 B2:F2).each { |range| sheet.merge_cells(range) }
       sheet.column_widths 2, nil, nil, 2, nil, nil, 2
     end
   end

data/lib/axlsx/doc_props/app.rb

@@ -134,15 +134,15 @@ module Axlsx
 
     # Sets the template property of your app.xml file
     def template=(v) Axlsx::validate_string v; @template = v; end
-    alias :Template :template
+    alias :Template= :template=
 
     # Sets the manager property of your app.xml file
     def manager=(v) Axlsx::validate_string v; @manager = v; end
-    alias :Manager :manager
+    alias :Manager= :manager=
 
     # Sets the company property of your app.xml file
     def company=(v) Axlsx::validate_string v; @company = v; end
-    alias :Company :company
+    alias :Company= :company=
     # Sets the pages property of your app.xml file
     def pages=(v) Axlsx::validate_int v; @pages = v; end
 

data/lib/axlsx/util/constants.rb

@@ -76,7 +76,7 @@ module Axlsx
   # image rels namespace
   IMAGE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"
 
-  # image rels namespace
+  # hyperlink rels namespace
   HYPERLINK_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
 
   # comment rels namespace

data/lib/axlsx/util/simple_typed_list.rb

@@ -43,7 +43,9 @@ module Axlsx
     def to_ary
       @list
     end
-
+   
+    alias :to_a :to_ary
+    
     # Unlock the list
     # @return [self]
     def unlock

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 module Axlsx
   # The current version
-  VERSION="1.2.0"
+  VERSION="1.2.1"
 end

data/lib/axlsx/workbook/workbook.rb

@@ -27,6 +27,8 @@ require 'axlsx/workbook/worksheet/dimension.rb'
 require 'axlsx/workbook/worksheet/sheet_data.rb'
 require 'axlsx/workbook/worksheet/worksheet_drawing.rb'
 require 'axlsx/workbook/worksheet/worksheet_comments.rb'
+require 'axlsx/workbook/worksheet/worksheet_hyperlink'
+require 'axlsx/workbook/worksheet/worksheet_hyperlinks'
 require 'axlsx/workbook/worksheet/worksheet.rb'
 require 'axlsx/workbook/shared_strings_table.rb'
 require 'axlsx/workbook/defined_name.rb'

data/lib/axlsx/workbook/worksheet/cell.rb

@@ -343,7 +343,7 @@ module Axlsx
     private
 
     def font_size
-        sz || @styles.fonts[@styles.cellXfs[style].fontId].sz
+        sz || @styles.fonts[@styles.cellXfs[style].fontId].sz || @styles.fonts[0].sz
     end
 
     # Utility method for setting inline style attributes

data/lib/axlsx/workbook/worksheet/worksheet.rb

@@ -70,7 +70,13 @@ module Axlsx
     def tables
       @tables ||=  Tables.new self
     end
-    
+
+    # A typed collection of hyperlinks associated with this worksheet
+    # @return [WorksheetHyperlinks]
+    def hyperlinks
+      @hyperlinks ||= WorksheetHyperlinks.new self
+    end
+
     # The a shortcut to the worksheet_comments list of comments
     # @return [Array|SimpleTypedList]
     def comments
@@ -391,6 +397,14 @@ module Axlsx
       data_validations << dv
     end
 
+    # Adds a new hyperlink to the worksheet
+    # @param [Hash] options for the hyperlink
+    # @see WorksheetHyperlink for a list of options
+    # @return [WorksheetHyperlink]
+    def add_hyperlink(options={})
+      hyperlinks.add(options)
+    end
+
     # Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects and all the other dirty details.
     # @param [Class] chart_type
     # @option options [Array] start_at
@@ -490,12 +504,21 @@ module Axlsx
     # @return [Relationships]
     def relationships
       r = Relationships.new
-      r + [tables.relationships, 
-           worksheet_comments.relationships, 
+      r + [tables.relationships,
+           worksheet_comments.relationships,
+           hyperlinks.relationships,
            worksheet_drawing.relationship].flatten.compact || []
       r
     end
 
+    # identifies the index of an object withing the collections used in generating relationships for the worksheet
+    # @param [Any] object the object to search for
+    # @return [Integer] The index of the object
+    def relationships_index_of(object)
+      objects = [tables.to_a, worksheet_comments.comments.to_a, hyperlinks.to_a, worksheet_drawing.drawing].flatten.compact || []
+      objects.index(object)
+    end
+
     # Returns the cell or cells defined using excel style A1:B3 references.
     # @param [String|Integer] cell_def the string defining the cell or range of cells, or the rownumber
     # @return [Cell, Array]
@@ -548,7 +571,7 @@ module Axlsx
       [sheet_pr, dimension, sheet_view, column_info,
        sheet_data, @sheet_protection, protected_ranges,
        auto_filter, merged_cells, conditional_formattings,
-       data_validations, print_options, page_margins,
+       data_validations, hyperlinks, print_options, page_margins,
        page_setup, worksheet_drawing, worksheet_comments,
        tables]
     end

data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb

@@ -0,0 +1,101 @@
+module Axlsx
+
+  # A worksheet hyperlink object. Note that this is not the same as a drawing hyperlink object.
+  class WorksheetHyperlink
+
+    # Creates a new hyperlink object.
+    # @note the preferred way to add hyperlinks to your worksheet is the Worksheet#add_hyperlink method
+    # @param [Worksheet] worksheet the Worksheet that owns this hyperlink
+    # @param [Hash] options options to use when creating this hyperlink
+    # @option [String] display Display string, if different from string in string table. This is a property on the hyperlink object, but does not need to appear in the spreadsheet application UI.
+    # @option [String] location Location within target. If target is a workbook (or this workbook) this shall refer to a sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file.
+    # @option [String] tooltip The tip to display when the user positions the mouse cursor over this hyperlink
+    # @option [Symbol] target This is :external by default. If you set it to anything else, the location is interpreted to be the current workbook.
+    # @option [String|Cell] ref The location of this hyperlink in the worksheet
+    def initialize(worksheet, options={})
+      DataTypeValidator.validate "Hyperlink.worksheet", [Worksheet], worksheet
+      @worksheet = worksheet
+      @target = :external
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      yield self if block_given?
+    end
+
+    # String attributes for this object
+    STRING_ATTRIBUTES = %w(display location tooltip)
+
+    #Cell location of hyperlink on worksheet.
+    # @return [String]
+    attr_reader :ref
+
+    # Sets the target for this hyperlink. Anything other than :external instructs the library to treat the location as an in-workbook reference.
+    # @param [Symbol] target
+    def target=(target)
+      @target = target
+    end
+
+    # Sets the cell location of this hyperlink in the worksheet
+    # @param [String|Cell] cell_reference The string reference or cell that defines where this hyperlink shows in the worksheet.
+    def ref=(cell_reference)
+      cell_reference = cell_reference.r if cell_reference.is_a?(Cell)
+
+      Axlsx::validate_string cell_reference
+      @ref = cell_reference
+    end
+
+    # Dynamically create string attribute accessors
+    STRING_ATTRIBUTES.each do |attr|
+      class_eval %{
+        # The #{attr} attribute reader
+        # @return [String]
+        attr_reader :#{attr}
+
+        # The #{attr} writer
+        # @param [String] value The value to assign to #{attr}
+        # @return [String]
+        def #{attr}=(value)
+          Axlsx::validate_string(value)
+          @#{attr}= value
+        end
+      }
+    end
+
+    # The relationship required by this hyperlink when the taget is :external
+    # @return [Relationship]
+    def relationship
+      return unless @target == :external
+      Relationship.new HYPERLINK_R, location, :target_mode => :External
+    end
+
+    # The id of the relationship for this object
+    # @return [String]
+    def id
+      return unless @target == :external
+      "rId#{(@worksheet.relationships_index_of(self)+1)}"
+    end
+
+    # Seralize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str='')
+      str << '<hyperlink '
+      serialization_values.map { |key, value| str << key.to_s << '="' << value.to_s << '" ' }
+      str << '/>'
+    end
+
+    # The values to be used in serialization based on the target.
+    # location should only be specified for non-external targets.
+    # r:id should only be specified for external targets.
+    # @return [Hash]
+    def serialization_values
+      h = instance_values.reject { |key, value| !%w(display ref tooltip).include?(key) }
+      if @target == :external
+        h['r:id'] = id
+      else
+        h['location'] = location
+      end
+      h
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb

@@ -0,0 +1,35 @@
+module Axlsx
+  #A collection of hyperlink objects for a worksheet
+  class WorksheetHyperlinks < SimpleTypedList
+
+    # Creates a new Hyperlinks collection
+    # @param [Worksheet] worksheet the worksheet that owns these hyperlinks
+    def initialize(worksheet)
+      DataTypeValidator.validate "Hyperlinks.worksheet", [Worksheet], worksheet
+      @worksheet = worksheet
+      super WorksheetHyperlink
+    end
+
+    # Creates and adds a new hyperlink based on the options provided
+    # @see WorksheetHyperlink#initialize
+    # @return [WorksheetHyperlink]
+    def add(options)
+      @list << WorksheetHyperlink.new(@worksheet, options)
+      @list.last
+    end
+
+    def relationships
+      return [] if empty?
+      map { |hyperlink| hyperlink.relationship }
+    end
+
+    # seralize the collection of hyperlinks
+    # @return [String]
+    def to_xml_string(str='')
+      return if empty?
+      str << '<hyperlinks>'
+      @list.each { |hyperlink| hyperlink.to_xml_string(str) }
+      str << '</hyperlinks>'
+    end
+  end
+end

data/test/tc_package.rb

@@ -7,6 +7,7 @@ class TestPackage < Test::Unit::TestCase
     ws = @package.workbook.add_worksheet
     ws.add_row ['Can', 'we', 'build it?']
     ws.add_row ['Yes!', 'We', 'can!']
+    ws.add_hyperlink :ref => ws.rows.first.cells.last, :location => 'https://github.com/randym'
     ws.workbook.add_defined_name("#{ws.name}!A1:C2", :name => '_xlnm.Print_Titles', :hidden => true)
     ws.protect_range('A1:C1')
     ws.protect_range(ws.rows.last.cells)

data/test/workbook/worksheet/tc_cell.rb

@@ -268,6 +268,22 @@ class TestCell < Test::Unit::TestCase
 
   end
 
+  def test_font_size_with_custom_style_and_no_sz
+    @c.style = @c.row.worksheet.workbook.styles.add_style :bg_color => 'FF00FF'
+    sz = @c.send(:font_size)
+    assert_equal(sz, @c.row.worksheet.workbook.styles.fonts.first.sz)
+  end
+
+  def test_font_size_with_custom_sz
+    @c.style = @c.row.worksheet.workbook.styles.add_style :sz => 52
+    sz = @c.send(:font_size)
+    assert_equal(sz, 52)
+  end
+
+  def test_cell_with_sz
+    @c.sz = 25
+    assert_equal(25, @c.send(:font_size))
+  end
   def test_to_xml
     # TODO This could use some much more stringent testing related to the xml content generated!
     @ws.add_row [Time.now, Date.today, true, 1, 1.0, "text", "=sum(A1:A2)"]

data/test/workbook/worksheet/tc_worksheet_hyperlink.rb

@@ -0,0 +1,64 @@
+require 'tc_helper.rb'
+
+class TestWorksheetHyperlink < Test::Unit::TestCase
+  def setup
+    p = Axlsx::Package.new
+    wb = p.workbook
+    @ws = wb.add_worksheet
+    @options = { :location => 'https://github.com/randym/axlsx', :tooltip => 'axlsx', :ref => 'A1', :display => 'AXSLX', :target => :internal }
+    @a = @ws.add_hyperlink @options
+  end
+
+  def test_initailize
+    assert_raise(ArgumentError) { Axlsx::WorksheetHyperlink.new }
+  end
+
+  def test_location
+    assert_equal(@options[:location], @a.location)
+  end
+
+  def test_tooltip
+    assert_equal(@options[:tooltip], @a.tooltip)
+  end
+
+  def test_target
+    assert_equal(@options[:target], @a.instance_values['target'])
+  end
+
+  def test_display
+    assert_equal(@options[:display], @a.display)
+  end
+  def test_ref
+    assert_equal(@options[:ref], @a.ref)
+  end
+
+  def test_id
+    @a.target = :external
+
+    assert_equal("rId1", @a.id)
+    @a.target = :internal
+    assert_equal(nil, @a.id)
+  end
+
+
+  def test_to_xml_string_with_non_external
+    doc = Nokogiri::XML(@ws.to_xml_string)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@ref='#{@a.ref}']").size, 1)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@tooltip='#{@a.tooltip}']").size, 1)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@location='#{@a.location}']").size, 1)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@display='#{@a.display}']").size, 1)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@r:id='#{@a.id}']").size, 0)
+  end
+
+  def test_to_xml_stirng_with_external
+    @a.target = :external
+    doc = Nokogiri::XML(@ws.to_xml_string)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@ref='#{@a.ref}']").size, 1)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@tooltip='#{@a.tooltip}']").size, 1)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@display='#{@a.display}']").size, 1)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@location='#{@a.location}']").size, 0)
+    assert_equal(doc.xpath("//xmlns:hyperlink[@r:id='#{@a.id}']").size, 1)
+  end
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: axlsx
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-05 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -226,6 +226,8 @@ files:
 - lib/axlsx/workbook/worksheet/worksheet.rb
 - lib/axlsx/workbook/worksheet/worksheet_comments.rb
 - lib/axlsx/workbook/worksheet/worksheet_drawing.rb
+- lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb
+- lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb
 - lib/axlsx.rb
 - lib/schema/dc.xsd
 - lib/schema/dcmitype.xsd
@@ -275,6 +277,7 @@ files:
 - examples/example_streamed.xlsx
 - examples/extractive.pdf
 - examples/extractive.rb
+- examples/hyperlinks.rb
 - examples/image1.gif
 - examples/image1.jpeg
 - examples/image1.jpg
@@ -285,6 +288,7 @@ files:
 - examples/shared_strings_example.xlsx
 - examples/sheet_protection.rb
 - examples/sheet_view.rb
+- examples/skydrive/axlsx.xlsx
 - examples/skydrive/real_example.rb
 - examples/two_cell_anchor_image.rb
 - LICENSE
@@ -385,6 +389,7 @@ files:
 - test/workbook/worksheet/tc_sheet_protection.rb
 - test/workbook/worksheet/tc_sheet_view.rb
 - test/workbook/worksheet/tc_worksheet.rb
+- test/workbook/worksheet/tc_worksheet_hyperlink.rb
 homepage: https://github.com/randym/axlsx
 licenses: []
 post_install_message: 
@@ -405,7 +410,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2125383540867602531
+      hash: 1432590865513954049
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -506,4 +511,5 @@ test_files:
 - test/workbook/worksheet/tc_sheet_protection.rb
 - test/workbook/worksheet/tc_sheet_view.rb
 - test/workbook/worksheet/tc_worksheet.rb
+- test/workbook/worksheet/tc_worksheet_hyperlink.rb
 has_rdoc: axlsx