axlsx 2.0.1 → 2.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36ce715dcecdf3de554b7683d87d35eccf159a81
-  data.tar.gz: d9550ff6639b90f612e45c0bf40f5a50ac88928e
+  metadata.gz: bbd74d60d15e7375b31b29eb04943c5014519d0a
+  data.tar.gz: 13a7cdaf65bd1da6d7b780b9c8217cf544141679
 SHA512:
-  metadata.gz: 9939c4e2c0bba3911171ae36441f61175d3b4604dfe878a125ac9b391c38c88430426a2c9660e2d1bafe0f7ae1c4a039a09d4410890978bad70509204a43e9d0
-  data.tar.gz: 0b58dc0cb79601febcc3782410e36225d2154c788f7dfe38e11d98a5845554ad0cd8a649656712e058f52e0ad884dafc9a3aa2a6379d5e1784585ca66f7f5b20
+  metadata.gz: 92fdb46000096174c14f32b6783e8758b39535ceb2bc193cfb0f45723c98babe7abfdab3e1ae2af76c999f414e67bf47afe93e46827571db5aa0b3bb97f79492
+  data.tar.gz: 2b7e3f18fa42835e8ca6e48a40b8641cb0d799f898124e827c7993adb097216df788bef033dde4d1a5525338d4d24a28112092f42ce9684f61ad74daf2b09df1

data/README.md

@@ -11,7 +11,7 @@ appreciation for the gem, please don't hesitate to make a donation.
 
 **Git**:[http://github.com/randym/axlsx](http://github.com/randym/axlsx)
 
-**Twitter**: [https://twitter.com/#!/morgan_randy](https://twitter.com/#!/morgan_randy)
+**Twitter**: [https://twitter.com/morgan_randy](https://twitter.com/morgan_randy)
 
 **Google Group**: [https://groups.google.com/forum/?fromgroups#!forum/axlsx](https://groups.google.com/forum/?fromgroups#!forum/axlsx)
 
@@ -50,7 +50,7 @@ There are guides for using axlsx and acts_as_xlsx here:
 
 If you are working with ActiveAdmin see:
 
-[activeadmin_axlsx](http://github.com/randym/activeadmin_axlsx)
+[activeadmin-axlsx](http://github.com/randym/activeadmin-axlsx)
 
 It provies a plugin and dsl for generating downloadable reports.
 
@@ -164,7 +164,10 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
 
 #Change log
 ---------
-
+- **
+  - Added Cell#name so you you can quickly create a defined name for a single cell in your workbook.
+  - Added full book view and sheet state management. This means you can specify how the workbook renders as well as manage sheet visibility.
+  - Added smoothing management for line charts series
 - **September.12.13**:2.0.1
   - Unpinned rubyzip version
 - **September.12.13**:2.0.0

data/Rakefile

@@ -10,18 +10,17 @@ 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"
+  system "yardoc"
+  system "yard stats --list-undoc"
 end
 
-task :test do
-     require 'rake/testtask'
-     Rake::TestTask.new do |t|
-       t.libs << 'test'
-       t.test_files = FileList['test/**/tc_*.rb']
-       t.verbose = false
-       t.warning = true
-     end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/tc_*.rb']
+  t.verbose = false
+  t.warning = true
 end
 
 task :release => :build do

data/examples/auto_filter.rb

@@ -10,7 +10,16 @@ Axlsx::Package.new do |p|
     sheet.add_row ["19.1", "1 min 32 sec", "about 10 hours ago", "1.8.7"]
     sheet.add_row ["19.2", "1 min 28 sec", "about 10 hours ago", "1.9.2"]
     sheet.add_row ["19.3", "1 min 35 sec", "about 10 hours ago", "1.9.3"]
-    sheet.auto_filter = 'A2:D5' 
+    sheet.auto_filter = 'A2:D5'
+    sheet.auto_filter.add_column 3, :filters, :filter_items => ['1.9.2']
+  end
+  p.workbook.add_worksheet(:name => "Table 2") do |sheet|
+    sheet.add_row ["Build Matrix"]
+    sheet.add_row ["Build", "Duration", "Finished", "Rvm"]
+    sheet.add_row ["19.1", "1 min 32 sec", "about 10 hours ago", "1.8.7"]
+    sheet.add_row ["19.2", "1 min 28 sec", "about 10 hours ago", "1.9.2"]
+    sheet.add_row ["19.3", "1 min 35 sec", "about 10 hours ago", "1.9.3"]
+    sheet.auto_filter = 'A2:D5'
     sheet.auto_filter.add_column 3, :filters, :filter_items => ['1.9.2']
   end
 end.serialize('auto_filter.xlsx')

data/examples/conditional_formatting/example_conditional_formatting.rb

@@ -11,8 +11,8 @@ percent = book.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE
 money = book.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
 
 # define the style for conditional formatting
-profitable = book.styles.add_style( :fg_color => "FF428751", :type => :dxf )
-unprofitable = wb.styles.add_style( :fg_color => "FF0000", :type => :dxf )
+profitable = book.styles.add_style( :fg_color => "428751", :type => :dxf )
+unprofitable = book.styles.add_style( :fg_color => "FF0000", :type => :dxf )
 
 book.add_worksheet(:name => "Cell Is") do |ws|
 
@@ -28,7 +28,7 @@ book.add_worksheet(:name => "Cell Is") do |ws|
 # Apply conditional formatting to range B3:B100 in the worksheet
   ws.add_conditional_formatting("B3:B100", { :type => :cellIs, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1 })
 # Apply conditional using the between operator; NOTE: supply an array to :formula for between/notBetween
-  sheet.add_conditional_formatting("C3:C100", { :type => :cellIs, :operator => :between, :formula => ["0.00%","100.00%"], :dxfId => unprofitable, :priority => 1 })
+  ws.add_conditional_formatting("C3:C100", { :type => :cellIs, :operator => :between, :formula => ["0.00%","100.00%"], :dxfId => unprofitable, :priority => 1 })
 end
 
 book.add_worksheet(:name => "Color Scale") do |ws|

data/examples/example.rb

@@ -14,6 +14,7 @@ examples << :surrounding_border
 examples << :deep_custom_borders
 examples << :row_column_style
 examples << :fixed_column_width
+examples << :height
 examples << :outline_level
 examples << :merge_cells
 examples << :images
@@ -40,13 +41,16 @@ examples << :printing
 examples << :header_footer
 examples << :comments
 examples << :panes
+examples << :book_view
 examples << :sheet_view
+examples << :hiding_sheets
 examples << :conditional_formatting
 examples << :streaming
 examples << :shared_strings
 examples << :no_autowidth
 examples << :cached_formula
 examples << :page_breaks
+examples << :rich_text
 
 p = Axlsx::Package.new
 wb = p.workbook
@@ -207,6 +211,7 @@ if examples.include? :row_column_style
     head = s.add_style :bg_color => "00", :fg_color => "FF"
     percent = s.add_style :num_fmt => 9
     wb.add_worksheet(:name => "Columns and Rows") do |sheet|
+      # Note: you must add rows to the document *BEFORE* applying column styles to them
       sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4', 'col5']
       sheet.add_row [1, 2, 0.3, 4, 5.0]
       sheet.add_row [1, 2, 0.2, 4, 5.0]
@@ -243,6 +248,21 @@ if examples.include? :fixed_column_width
   end
 end
 
+
+##Specifying Row height
+
+#```ruby
+if examples.include? :height
+  wb.styles do |s|
+    head = s.add_style :bg_color => "00", :fg_color => "FF"
+    wb.add_worksheet(:name => "fixed row height") do |sheet|
+      sheet.add_row ["This row will have a fixed height", "It will overwite the default row height"], :height => 30
+      sheet.add_row ["This row can have a different height too"], :height => 10, :style => head
+    end
+  end
+end
+
+
 #```ruby
 if examples.include? :outline_level
   wb.add_worksheet(name: 'outline_level') do |sheet|
@@ -279,13 +299,23 @@ if examples.include? :images
   wb.add_worksheet(:name => "Image with Hyperlink") do |sheet|
     img = File.expand_path('../image1.jpeg', __FILE__)
     # specifying the :hyperlink option will add a hyper link to your image.
+    #
     # @note - Numbers does not support this part of the specification.
+
     sheet.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
       image.width=720
       image.height=666
       image.hyperlink.tooltip = "Labeled Link"
-      image.start_at 2, 2
+      image.start_at 0, 0
     end
+
+    # position in block
+    sheet.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
+      image.start_at 22, 14
+      image.end_at 23, 17
+    end
+    # all in one go
+    sheet.add_image(:image_src => img, :start_at => [15, 33], :end_at => [20, 37], :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com")
   end
 end
 #```
@@ -470,7 +500,7 @@ if examples.include? :line_chart
     sheet.add_chart(Axlsx::LineChart, :title => "Simple Line Chart", :rotX => 30, :rotY => 20) do |chart|
       chart.start_at 0, 21
       chart.end_at 10, 41
-      chart.add_series :data => sheet["A3:A6"], :title => sheet["A2"], :color => "FF0000"
+      chart.add_series :data => sheet["A3:A6"], :title => sheet["A2"], :color => "FF0000", :show_marker => true, :smooth => true
       chart.add_series :data => sheet["B3:B6"], :title => sheet["B2"], :color => "00FF00"
       chart.catAxis.title = 'X Axis'
       chart.valAxis.title = 'Y Axis'
@@ -644,7 +674,27 @@ if examples.include? :sheet_view
   end
 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 
+## tuning values for the UI @see Axlsx::WorkbookView
+## ```ruby
+if examples.include? :book_view
+  # when you open example.xml the second sheet is selected, and the horizontal scroll bar is much smaller showing more sheets
+  wb.add_view tab_ratio: 800, active_tab: 1
+end
 
+## Hiding Sheets
+##
+## Sheets can be hidden with the state attribute
+if examples.include? :hiding_sheets
+  wb.add_worksheet name: 'hidden', state: :hidden do |sheet|
+    sheet.add_row ['you cant see me!']
+  end
+  wb.add_worksheet name: 'very hidden', state: :very_hidden do |sheet|
+    sheet.add_row ['you really cant see me!']
+  end
+end
 # conditional formatting
 #
 if examples.include? :conditional_formatting
@@ -763,8 +813,7 @@ if examples.include? :no_autowidth
 end
 #```
 
-
-
+#```ruby
 if examples.include? :cached_formula
   p = Axlsx::Package.new
   p.use_shared_strings = true
@@ -774,4 +823,23 @@ if examples.include? :cached_formula
   end
   p.serialize 'cached_formula.xlsx'
 end
+#```
 
+#```ruby
+if examples.include? :rich_text
+  p = Axlsx::Package.new
+  p.use_shared_strings = true
+  wb = p.workbook
+  wrap_text = wb.styles.add_style({:alignment => {:horizontal => :center, :vertical => :center, :wrap_text => true}}  )
+  rt = Axlsx::RichText.new
+  rt.add_run('I\'m bold, ', :b => true)
+  rt.add_run('I\'m italic, ', :i => true)
+  rt.add_run('I\'m strike' + "\n", :strike => true)
+  rt.add_run('I\'m bold, italic and strike' + "\n", :b => true, :i => true, :strike => true)
+  rt.add_run('I\'m style-less :D')
+  wb.add_worksheet(:name => "RichText") do | sheet |
+    sheet.add_row [rt], :style => wrap_text
+  end
+  p.serialize 'rich_text.xlsx'
+end
+#```

data/examples/merge_cells.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
+require 'axlsx'
+package = Axlsx::Package.new
+package.workbook do |workbook|
+  workbook.add_worksheet name: 'merged_cells' do |sheet|
+    4.times do
+      sheet.add_row %w(a b c d e f g)
+    end
+    sheet.merge_cells "A1:A2"
+    sheet.merge_cells "B1:B2"
+  end
+end
+package.serialize 'merged_cells.xlsx'

data/examples/no_grid_with_borders.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
+require 'axlsx'
+package = Axlsx::Package.new
+package.workbook do |workbook|
+  workbook.styles do |s|
+    gridstyle_border =  s.add_style :border => { :style => :thin, :color =>"FFCDCDCD" }
+    workbook.add_worksheet :name => "Custom Borders"  do |sheet|
+      sheet.sheet_view.show_grid_lines = false
+      sheet.add_row ["with", "grid", "style"], :style => gridstyle_border
+      sheet.add_row ["no", "border"]
+    end
+  end
+end
+package.serialize 'no_grid_with_borders.xlsx'

data/examples/pivot_test.rb

@@ -0,0 +1,63 @@
+class RandomReportGenerator
+  def date
+    Date.today.strftime("%m/%d/%Y")
+  end
+  def member_id
+    @i ||= 0
+    @i += 1
+  end
+  def name
+    "John S."
+  end
+  def gender
+    ["Male", "Female"].sample
+  end
+  def age
+    rand(100)
+  end
+  def city
+    ["New York", "Mountain View", "Newark", "Phoenix"].sample
+  end
+  def state
+    ["NY", "CA", "NJ", "AZ"].sample
+  end
+  def parenting
+    "Foo"
+  end
+  def student
+    "Bar"
+  end
+  def income
+    "Bar"
+  end
+  def education
+    "Bar"
+  end
+  def answer
+    ["Yes", "No", "Maybe", "I dont know"].sample
+  end
+  def run
+    package  = Axlsx::Package.new
+    workbook = package.workbook
+ 
+    workbook.add_worksheet(:name => "Data Sheet") do |sheet|
+      sheet.add_row [
+        "Date", "Member ID", "Name", "Gender", "Age", "City", "State",
+        "Parenting Status", "Student Status", "Income", "Education", "Answer"
+      ]
+      30.times do
+        sheet.add_row [date, member_id, name, gender, age, city, state,
+                       parenting, student, income, education, answer]
+      end
+    end
+ 
+    workbook.add_worksheet(:name => "Summary") do |sheet|
+      pivot_table = Axlsx::PivotTable.new 'A1:B15', "A1:L31", workbook.worksheets[0]
+      pivot_table.rows = ['Answer']
+      pivot_table.data = [{:ref => "Member ID", :subtotal => "count"}]
+      sheet.pivot_tables << pivot_table
+    end
+ 
+    package.serialize("pivot_table.xlsx")
+  end
+end

data/examples/split.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+wb = p.workbook
+wb.add_worksheet name: 'pane' do |sheet|
+  sheet.sheet_view.pane do |pane|
+    pane.top_left_cell = "B2"
+    pane.state = :frozen_split
+    pane.y_split = 2
+    pane.x_split = 1
+    pane.active_pane = :bottom_right
+  end
+end
+p.serialize 'pane.xlsx'

data/lib/axlsx.rb

@@ -10,6 +10,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/stylesheet/styles.rb'
 
@@ -53,7 +54,7 @@ module Axlsx
     cells = sort_cells(cells)
     reference = "#{cells.first.reference(absolute)}:#{cells.last.reference(absolute)}"
     if absolute
-      escaped_name = cells.first.row.worksheet.name.gsub "'", "''"
+      escaped_name = cells.first.row.worksheet.name.gsub ''', "''"
       "'#{escaped_name}'!#{reference}"
     else
       reference
@@ -65,7 +66,7 @@ module Axlsx
   # @param [Array] cells
   # @return [Array]
   def self.sort_cells(cells)
-    cells.sort { |x, y| [x.index, x.row.index] <=> [y.index, y.row.index] }
+    cells.sort { |x, y| [x.index, x.row.row_index] <=> [y.index, y.row.row_index] }
   end
 
   #global reference html entity encoding
@@ -88,20 +89,21 @@ module Axlsx
   # @note This follows the standard spreadsheet convention of naming columns A to Z, followed by AA to AZ etc.
   # @return [String]
   def self.col_ref(index)
-    chars = []
+    chars = ''
     while index >= 26 do
-      chars << ((index % 26) + 65).chr
-      index = (index / 26).to_i - 1
+      index, char = index.divmod(26)
+      chars.prepend((char + 65).chr)
+      index -= 1
     end
-    chars << (index + 65).chr
-    chars.reverse.join
+    chars.prepend((index + 65).chr)
+    chars
   end
 
   # @return [String] The alpha(column)numeric(row) reference for this sell.
   # @example Relative Cell Reference
   #   ws.rows.first.cells.first.r #=> "A1"
   def self.cell_r(c_index, r_index)
-    Axlsx::col_ref(c_index).to_s << (r_index+1).to_s
+    col_ref(c_index) << (r_index+1).to_s
   end
 
   # Creates an array of individual cell references based on an excel reference range.
@@ -113,7 +115,7 @@ module Axlsx
     end_col,   end_row   = name_to_indices($2)
     (start_row..end_row).to_a.map do |row_num|
       (start_col..end_col).to_a.map do |col_num|
-        "#{col_ref(col_num)}#{row_num+1}"
+        cell_r(col_num, row_num)
       end
     end
   end
@@ -127,14 +129,26 @@ module Axlsx
     s.gsub(/_(.)/){ $1.upcase }
   end
 
-    # returns the provided string with all invalid control charaters
-    # removed.
-    # @param [String] str The sting to process
-    # @return [String]
-    def self.sanitize(str)
-      str.gsub(CONTROL_CHAR_REGEX, '')
+  # returns the provided string with all invalid control charaters
+  # removed.
+  # @param [String] str The string to process
+  # @return [String]
+  def self.sanitize(str)
+    str.delete!(CONTROL_CHARS)
+    str
+  end
+  
+  # If value is boolean return 1 or 0
+  # else return the value
+  # @param [Object] value The value to process
+  # @return [Object]
+  def self.booleanize(value)
+    if value == true || value == false
+      value ? 1 : 0
+    else
+      value
     end
-
+  end
 
   # Instructs the serializer to not try to escape cell value input.
   # This will give you a huge speed bonus, but if you content has <, > or other xml character data