acts_as_xlsx 1.0.3 → 1.0.4

data/.yardopts

@@ -0,0 +1,7 @@
+--protected
+--no-private
+--main README.md
+--title "acts_as_xlsx: a rails plug in for axlsx"
+-
+LICENSE
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+CHANGELOG
+---------
+
+- **December.6.11**: 1.0.3 release
+  - Added Mime type definition for rails to support respond_to |format| style handling in controllers.
+
+- **December.3.11**: 1.0.2 release
+    Added support for chained method columns like :'model.association.attribute'
+
+- **October.30.11**: 1.0.1 release
+  - Patch for inclusion error
+
+- **October.30.11**: 1.0.0 release
+  - First release
+
+- **October.30.11**: 1.0.0a release
+  - First pre release

data/README.md

@@ -7,9 +7,9 @@ Acts as xlsx: Office Open XML Spreadsheet Generation plugin for active record
 **Author**:       Randy Morgan   
 **Copyright**:    2011      
 **License**:      MIT License      
-**Latest Version**: 1.0.3 	   
+**Latest Version**: 1.0.4 	   
 **Ruby Version**: 1.8.7 - 1.9.3  
-**Release Date**: December 6th 2011     
+**Release Date**: December 8th 2011     
 
 Synopsis
 --------
@@ -35,6 +35,8 @@ Feature List
 
 **8. Automatically registers xlsx Mime type for use in respond_to web-service support.
 
+**9. Allows you to specify the Axlsx package to add your data to so you can create a single workbook with a sheet for each to_xlsx call.
+
 Installing
 ----------
 
@@ -47,52 +49,10 @@ Usage
 
 ###Examples
 
-Also see the writeups here: 
-http://axlsx.blogspot.com/
-
-A trivial rails example. In a production environment you will want to you stuff like x_sendfile and Tempfile  
-http://www.therailsway.com/2009/2/22/file-downloads-done-right  
-
-for nginx  
-http://andrewtimberlake.com/blog/how-to-protect-downloads-but-still-have-nginx-serve-the-files   
-
-     #Add the gem to your Gemfile and bundle install
-       gem 'acts_as_xlsx'
-      
-     # app/models/post.rb
-       class Post < ActiveRecord::Base
-         acts_as_xlsx
-       end
-
-     # app/controllers/posts_controller.rb
-       class PostsController < ApplicationController
-         # GET posts/xlsx     
-         def xlsx
-           p = Post.to_xlsx
-           p.serialize('public/downloads/posts.xlsx')
-           send_file 'public/downloads/posts.xlsx', :type=>"application/xlsx"
-         end
-       end
-
-     # dont forget to add posts/xslx to your routes!
-
-In addition to dumping the entire table, it is also possible to specify the columns and method chains to execute in genrating your report.
-       # GET posts/xslx
-       def xlsx	    
-         p = Post.to_xlsx :columns => [:name, :title, :ranking, :'comments.last.content', :'comments.last.author.name']
-         p.serialize('public/downloads/posts.xlsx')
-         send_file 'public/downloads/posts.xlsx', :type=>"application/xlsx"
-       end
-
-If your application uses i18n, you can specify the prefix for column labels as well
-
-       # GET posts/xslx
-       def xlsx	    
-         p = Post.to_xlsx :i18n => 'activerecord.attributes'
-         p.serialize('public/downloads/posts.xlsx')
-         send_file 'public/downloads/posts.xlsx', :type=>"application/xlsx"
-       end
-    
+See the Guides here: 
+
+[http://axlsx.blogspot.com/] (http://axlsx.blogspot.com/)
+
 For examples on how to use axlsx for custom styles, charts, images and more see:
 
         [http://rubygems.org/gems/axlsx] (https://rubygems.org/gems/axlsx)
@@ -111,21 +71,11 @@ This gem has 100% coverage using Test::Unit
  
 Changelog
 ---------
-- **December.6.11**: 1.0.3 release
-  - Added Mime type definition for rails to support respond_to |format| style handling in controllers.
+- **December.7.11**: 1.0.4 release
+  - acts_as_xlsx now supports specifying the Axlsx package the export will be added to
+  - Support for custom named and I18n names for worksheets.
 
-- **December.3.11**: 1.0.2 release
-    Added support for chained method columns like :'model.association.attribute'
 
-- **October.30.11**: 1.0.1 release
-  - Patch for inclusion error
-
-- **October.30.11**: 1.0.0 release
-  - First release
-
-- **October.30.11**: 1.0.0a release
-  - First pre release
- 
 Please see the {file:CHANGELOG.md} document for past release information.
 
 

data/lib/acts_as_xlsx/ar.rb

@@ -43,6 +43,7 @@ module Axlsx
       # @option options [Array, Symbol] types an array of Axlsx types for each cell in data rows or a single type that will be applied to all types.
       # @option options [Integer, Array] style The style to pass to Worksheet#add_row
       # @option options [String] i18n The path to i18n attributes. (usually activerecord.attributes)
+      # @option options [Package] package An Axlsx::Package. When this is provided the output will be added to the package as a new sheet.  # @option options [String] name This will be used to name the worksheet added to the package. If it is not provided the name of the table name will be humanized when i18n is not specified or the I18n.t for the table name.
       # @see Worksheet#add_row
       def to_xlsx(options = {})
 
@@ -53,16 +54,17 @@ module Axlsx
         i18n = options.delete(:i18n) || self.xlsx_i18n
         columns = options.delete(:columns) || self.xlsx_columns
 
-        p = Package.new
+        p = options.delete(:package) || Package.new
         row_style = p.workbook.styles.add_style(row_style) unless row_style.nil?
         header_style = p.workbook.styles.add_style(header_style) unless header_style.nil?
-
+        i18n = self.xlsx_i18n == true ? 'activerecord.attributes' : i18n
+        sheet_name = options.delete(:name) || (i18n ? I18n.t("#{i18n}.#{table_name.underscore}") : table_name.humanize) 
         data = [*find(:all, options)]
         data.compact!
         data.flatten!
 
         return p if data.empty?
-        p.workbook.add_worksheet(:name=>table_name.humanize) do |sheet|
+        p.workbook.add_worksheet(:name=>sheet_name) do |sheet|
           
           col_labels = if i18n
                          columns.map { |c| I18n.t("#{i18n}.#{self.name.underscore}.#{c}") }                         

data/lib/acts_as_xlsx/version.rb

@@ -1,6 +1,6 @@
 module Axlsx
   module Ar
    # The current version of the gem
-   VERSION = "1.0.3"
+   VERSION = "1.0.4"
  end
 end

data/test/tc_acts_as_xlsx.rb

@@ -19,6 +19,16 @@ class TestActsAsXlsx < Test::Unit::TestCase
 end
 
 class TestToXlsx < Test::Unit::TestCase
+  def test_to_xlsx_with_package
+    p = Post.to_xlsx
+    Post.to_xlsx :package=>p, :name=>'another posts'
+    assert_equal p.workbook.worksheets.size, 2
+  end
+
+  def test_to_xlsx_with_name
+    p = Post.to_xlsx :name=>'bob'
+    assert_equal(p.workbook.worksheets.first.name, 'bob')    
+  end
 
   def test_xlsx_columns
     assert_equal( Post.xlsx_columns, Post.column_names.map {|c| c.to_sym})

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_xlsx
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Randy Morgan
@@ -15,26 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-06 00:00:00 Z
+date: 2011-12-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: axlsx
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 13
         segments: 
         - 1
         - 0
-        - 10
-        version: 1.0.10
-  requirement: *id001
+        - 13
+        version: 1.0.13
   type: :runtime
-  prerelease: false
-  name: axlsx
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,12 +47,12 @@ dependencies:
         - 3
         - 9
         version: 2.3.9
-  requirement: *id002
   type: :runtime
-  prerelease: false
-  name: activerecord
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,12 +62,12 @@ dependencies:
         - 0
         - 9
         version: "0.9"
-  requirement: *id003
   type: :development
-  prerelease: false
-  name: rake
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,12 +76,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
   type: :development
-  prerelease: false
-  name: bundler
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  name: sqlite3
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -88,12 +90,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
   type: :development
-  prerelease: false
-  name: sqlite3
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -102,12 +104,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id006
   type: :development
-  prerelease: false
-  name: yard
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  name: rdiscount
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -116,11 +118,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id007
   type: :development
-  prerelease: false
-  name: rdiscount
-description: "    acts_as_xlsx lets you turn any ActiveRecord::Base inheriting class into an excel spreadsheet.\n"
+  version_requirements: *id007
+description: "    acts_as_xlsx lets you turn any ActiveRecord::Base inheriting class into an excel spreadsheet.\n    It can be added to any finder method or scope chain and can use localized column and sheet names with I18n.\n"
 email: digital.ipseity@gmail.com
 executables: []
 
@@ -129,41 +129,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- doc/_index.html
-- doc/Axlsx/Ar/ClassMethods.html
-- doc/Axlsx/Ar/SingletonMethods.html
-- doc/Axlsx/Ar.html
-- doc/Axlsx.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.CHANGELOG.html
-- doc/file.LICENSE.html
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - lib/acts_as_xlsx/ar.rb
 - lib/acts_as_xlsx/version.rb
 - lib/acts_as_xlsx/version.rb~
 - lib/acts_as_xlsx.rb
 - lib/acts_as_xlsx.rb~
+- LICENSE
+- README.md
+- Rakefile
+- CHANGELOG.md
+- .yardopts
 - test/acts_as_xlsx.sqlite3.db
 - test/database.yml
 - test/helper.rb
 - test/helper.rb~
 - test/tc_acts_as_xlsx.rb
 - test/tc_acts_as_xlsx.rb~
-- LICENSE
-- README.md
-- Rakefile
-- CHANGELOG.md
 homepage: https://github.com/randym/acts_as_xlsx
 licenses: []
 
@@ -199,6 +180,11 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: ActiveRecord support for Axlsx
-test_files: []
-
+test_files: 
+- test/acts_as_xlsx.sqlite3.db
+- test/database.yml
+- test/helper.rb
+- test/helper.rb~
+- test/tc_acts_as_xlsx.rb
+- test/tc_acts_as_xlsx.rb~
 has_rdoc: acts_as_xlsx

data/doc/Axlsx.html

@@ -1,127 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Module: Axlsx
-  
-    &mdash; acts_as_xlsx: a rails plug in for axlsx
-  
-</title>
-
-  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
-
-  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
-  relpath = '';
-  if (relpath != '') relpath += '/';
-</script>
-
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-
-
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    
-    <div id="header">
-      <div id="menu">
-  
-    <a href="_index.html">Index (A)</a> &raquo; 
-    
-    
-    <span class="title">Axlsx</span>
-  
-  
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-
-      <div id="search">
-  
-    <a id="class_list_link" href="#">Class List</a>
-  
-    <a id="method_list_link" href="#">Method List</a>
-  
-    <a id="file_list_link" href="#">File List</a>
-  
-</div>
-      <div class="clear"></div>
-    </div>
-    
-    <iframe id="search_frame"></iframe>
-    
-    <div id="content"><h1>Module: Axlsx
-  
-  
-  
-</h1>
-
-<dl class="box">
-  
-  
-    
-  
-    
-  
-  
-  
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/acts_as_xlsx/ar.rb<span class="defines">,<br />
-  lib/acts_as_xlsx/version.rb</span>
-</dd>
-  
-</dl>
-<div class="clear"></div>
-
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>
-Adding to the Axlsx module
-</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-  <h3>See Also:</h3>
-  <ul class="see">
-    
-      <li><a href="http://github.com/randym/axlsx" target="_parent" title="http://github.com/randym/axlsx">http://github.com/randym/axlsx</a></li>
-    
-  </ul>
-
-</div><h2>Defined Under Namespace</h2>
-<p class="children">
-   
-    
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Axlsx/Ar.html" title="Axlsx::Ar (module)">Ar</a></span>
-    
-   
-    
-  
-</p>
-
-
-
-
-
-
-
-</div>
-    
-    <div id="footer">
-  Generated on Tue Dec  6 18:49:19 2011 by 
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.4 (ruby-1.8.7).
-</div>
-
-  </body>
-</html>