axlsx 1.0.1 → 1.0.3

data/README.md

@@ -6,7 +6,7 @@ Axlsx: Office Open XML Spreadsheet Generation
 **Author**:       Randy Morgan
 **Copyright**:    2011    
 **License**:      MIT License    
-**Latest Version**: 1.0.0
+**Latest Version**: 1.0.2
 **Release Date**: November 20th 2011    
 
 Synopsis
@@ -26,6 +26,11 @@ Feature List
 
 **4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String and Time types are automatically identified and serialized to your spreadsheet.
 
+**5. Automatic column widths: Axlsx will automatically determine the appropriate width for your columns based on the content in the worksheet.
+
+**6. Support for both 1904 and 1900 epocs configurable in the workbook.
+
+
 Installing
 ----------
 
@@ -35,19 +40,87 @@ To install Axlsx, use the following command:
     
 Usage
 -----
-
-Generating a workbook with styles and a chart:
-  p = Axlsx::Package.new do |package|
-    package.workbook.add_worksheet do |sheet|
-      sheet.add_row ["First", "Second", "Third"], :style => Axlsx::STYLE_THIN_BORDER
-      sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
-      sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 1: Chart") do |chart|
-        chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
-      end
-    end
-    package.serialize("example1.xlsx")
-  end  
-
+Simple Workbook
+
+     p = Axlsx::Package.new do |package|
+       package.workbook.add_worksheet do |sheet|
+         sheet.add_row ["First", "Second", "Third"]
+         sheet.add_row [1, 2, 3]
+       end
+       package.serialize("example1.xlsx")
+     end  
+
+Generating A Bar Chart
+	   
+     p = Axlsx::Package.new do |package|
+       package.workbook.add_worksheet do |sheet|
+         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 1: Chart") do |chart|
+           chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
+         end
+       end
+       package.serialize("example1.xlsx")
+     end  
+
+Generating A Pie Chart
+
+     p = Axlsx::Package.new do |package|
+       package.workbook.add_worksheet do |sheet|
+         sheet.add_row ["First", "Second", "Third"]
+         sheet.add_row [1, 2, 3]
+         sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 2: Pie Chart") do |chart|
+           chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
+         end
+       end
+       package.serialize("example3.xlsx")
+     end  
+
+Using Custom Styles
+
+     p = Axlsx::Package.new do |package|
+       style_options = { :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
+       header_style = package.workbook.styles.add_style style_options
+       package.workbook.add_worksheet do |sheet|
+         sheet.add_row ["Text Autowidth", "Second", "Third"], :style => header_style
+         sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+       end
+       package.serialize("example3.xlsx")
+     end  
+
+Cell Specifc Styles
+
+     p = Axlsx::Package.new do |package|
+
+       black_cell_spec = { :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
+       blue_cell_spec = { :bg_color => "FF0000FF", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
+
+       black_cell = package.workbook.styles.add_style black_cell_spec
+       blue_cell = package.workbook.styles.add_style blue_cell_spec
+
+       # date1904 support. uncomment the line below if you are working on a mac.
+       # package.workbook.date1904 = true 
+
+       package.workbook.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
+       package.serialize("example3.xlsx")
+     end  
+
+Number and Date formatting
+     p = Axlsx::Package.new do |package|
+       date = package.workbook.styles.add_style :format_code=>"yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER
+       padded = package.workbook.styles.add_style :format_code=>"00#", :border => Axlsx::STYLE_THIN_BORDER
+       percent = package.workbook.styles.add_style :format_code=>"0%", :border => Axlsx::STYLE_THIN_BORDER
+
+       package.workbook.add_worksheet do |sheet|
+         sheet.add_row
+         sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
+         sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded]
+       end
+       package.serialize("example5.xlsx")
+     end  
 
 ### Documentation
 This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
@@ -61,8 +134,11 @@ This gem has 100% test coverage. To execute tests for this gem, simply run rake
 Changelog
 ---------
 
-- **October.10.11**: 0.1.0 release
-
+- **October.20.11**: 0.1.0 release
+- **October.21.11**: 1.0.3 release
+  - Updated documentation
+  - altered package to accept a filename string for serialization instead of a File object.
+  - Updated specs to conform
 Copyright
 ---------
 

data/lib/axlsx/util/constants.rb

@@ -1,7 +1,7 @@
 module Axlsx
 
   # version
-  VERSION="1.0.1"
+  VERSION="1.0.3"
 
   # XML Encoding
   ENCODING = "UTF-8"

data/test/tc_package.rb

@@ -19,19 +19,15 @@ class TestPackage < Test::Unit::TestCase
   def test_serialization
     fname = 'test_serialization.xlsx'
     assert_nothing_raised do
-      if File.writable? fname
-        f = File.open(fname, 'w')      
-        z= @package.serialize(f)      
-        
-        zf = Zip::ZipFile.open(f.path)
+      if File.writable?(fname)
+        z= @package.serialize(fname)              
+        zf = Zip::ZipFile.open(fname)
         @package.send(:parts).each{ |part| zf.get_entry(part[:entry]) }
-        File.delete(f.path)
-        
+        File.delete(fname)        
       else
         puts "Skipping write to disk as write permission is not granted to this user"
       end
-    end
-    
+    end    
   end
   
   def test_validation

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: axlsx
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Randy Morgan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-20 00:00:00 +09:00
+date: 2011-11-21 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -322,8 +322,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-has_rdoc: yard
-homepage: ""
+has_rdoc: axlsx
+homepage: https://rubyforge.org/projects/axlsx/
 licenses: []
 
 post_install_message: 
@@ -351,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: axlsx
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3