Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 2.6 KB

README.md

File metadata and controls

95 lines (60 loc) · 2.6 KB

Axlsx: Office Open XML Spreadsheet Generation

IRC: irc.freenode.net / #axlsx
Git: http://github.com/randym/acts_as_xlsx
Author: Randy Morgan
Copyright: 2011
License: MIT License
Latest Version: 1.0.0a Ruby Version: 1.8.7 - 1.9.3
Release Date: November 30th 2011

Synopsis

Acts_as_xlsx is an active record plugin for Axlsx. It makes generating excel spreadsheets from any subclass of ActiveRecord::Base as simple as a couple of lines of code.

Feature List

**1. Mixes into active record base to provide to_xlsx methods on both class and instance active record inheritors.

**2. Can work at the end of any series of finder methods.

**3. Can accept any set of find options

**4. Automates localization of column heading with i18n support

**5. Lets you specify columns to exclude from the report.

**6. Gives you access to the axlsx package so you can add styles, charts and pictures to satisfy those flashy sales guys.

**7. Plays nicely with both ruby 1.8.7 + rails 2.3 as well as ruby 1.9.3 + rails 3

Installing

To install, use the following command:

$ gem install acts_as_xlsx

Usage

###Examples

Rails

 #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

###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:

  gem install yard
  yard server -g

###Specs

Specs for this gem are still under development.

Changelog

  • October.30.11: 1.0.0a release
    • First pre release

Please see the {file:CHANGELOG.md} document for past release information.

Copyright

Acts_as_xlsx © 2011 by Randy Morgan. Acts_as_xlsx is licensed under the MIT license. Please see the {file:LICENSE} document for more information.