axlsx_rails 0.1.5 → 0.2.0

data/README.md

@@ -18,70 +18,108 @@ gem 'axlsx_rails'
 
 ##Requirements
 
-* Rails 3.1, tested on 3.1, 3.2, and 4.0
+* Rails 3.1, tested on 3.1, 3.2, and 4.1
+* **As of 0.2.0 requires Axlsx 2.0.1, which requires rubyzip 1.0.0**
+* As of Rails 4.1 you must use `render_to_string` to render a mail attachment.
 
 ##Usage
 
-Axlsx-Rails provides a renderer and a template handler. It adds the :xlsx format and parses .xlsx.axslx templates. This lets you take all the [Axlsx](https://github.com/randym/axlsx) code out of your controller or model and place it inside the template, where view code belongs! **See [this blog post](http://axlsx.blog.randym.net/2012/08/excel-on-rails-like-pro-with-axlsxrails.html) for a more complete walkthrough.**
+Axlsx-Rails provides a renderer and a template handler. It adds the `:xlsx` format and parses `.xlsx.axlsx` templates. This lets you take all the [Axlsx](https://github.com/randym/axlsx) code out of your controller or model and place it inside the template, where view code belongs! **See [this blog post](http://axlsx.blog.randym.net/2012/08/excel-on-rails-like-pro-with-axlsxrails.html) for a more complete walkthrough.**
 
 ###Controller
 
-You can either use the typical format:
+To use Axlsx-Rails set your instance variables in your controller and configure the response if needed:
 
 ```ruby
-respond_to do |format|
-  format.xlsx
+class ButtonController < ApplicationController
+  def action_name
+    @buttons = Button.all
+    respond_to do |format|
+      format.xlsx
+    end
+  end
 end
 ```
 
-or call render directly:
+###Template
+
+Create the template with the `.xlsx.axlsx` extension (`action_name.xlsx.axlsx` for example.) [**Watch out for typos!**](#troubleshooting) In the template, use xlsx_package variable to create your spreadsheet:
 
 ```ruby
-render xlsx: "foobar", filename: "the_latest_foobar", disposition: 'inline'
+wb = xlsx_package.workbook
+wb.add_worksheet(name: "Buttons") do |sheet|
+  @buttons.each do |button|
+    sheet.add_row [button.name, button.category, button.price]
+  end
+end
 ```
 
-If you merely want to specify a file name, you can do it one of two ways:
+This is where you place all your [Axlsx](https://github.com/randym/axlsx) specific markup. Add worksheets, fill content, merge cells, add styles. See the [Axlsx examples](https://github.com/randym/axlsx/tree/master/examples/example.rb) page to see what you can do.
+
+That's it. Call your action and your spreadsheet will be delivered.
+
+###Rendering Options
+
+You can call render in any of the following ways:
 
 ```ruby
-format.xlsx {
-	response.headers['Content-Disposition'] = 'attachment; filename="my_new_filename.xlsx"'
-}
+# rendered, no disposition/filename header
+render 'buttons'
+# rendered from another controller, no disposition/filename header
+render 'featured/latest'
+# template and filename of 'buttons'
+render xlsx: 'buttons'
+# template from featured controller, filename of 'latest'
+render xlsx: 'featured/latest'
+# template from another controller, filename of 'latest_buttons'
+render xlsx: 'latest_buttons', template: 'featured/latest'
 ```
 
-Or:
+###Disposition
+
+To specify a disposition (such as `inline` so the spreadsheet is opened inside the browser), use the `disposition` option:
+
+```ruby
+render xlsx: "buttons", disposition: 'inline'
+```
+
+If `render xlsx:` is called, the disposition defaults to `attachment`.
+
+###File name
+
+If Rails calls Axlsx through default channels (because you use `format.xlsx {}` for example) you must set the filename using the response header:
 
 ```ruby
 format.xlsx {
-  render xlsx: "action_or_template", disposition: "attachment", filename: "my_new_filename.xlsx"
+  response.headers['Content-Disposition'] = 'attachment; filename="my_new_filename.xlsx"'
 }
 ```
 
-> NOTE: Someday it would be nice to merely say something like:
-	render :filename 'blah.xlsx"
-
-###Template
+If you use `render xlsx:` the gem will try to guess the file name: 
 
-This is where you place all your [Axlsx](https://github.com/randym/axlsx) specific markup. Add worksheets, fill content, merge cells, add styles. See the [Axlsx examples](https://github.com/randym/axlsx/tree/master/examples/example.rb) page to see what you can do. 
+```ruby
+# filename of 'buttons'
+render xlsx: 'buttons'
+# filename of 'latest_buttons'
+render xlsx: 'latest_buttons', template: 'featured/latest'
+```
 
-Use the .xlsx.axlsx extension ([watch out for typos!](#troubleshooting)) In the template, use xlsx_package variable, which is set with Axlsx::Package.new:
+If that fails, pass the `:filename` parameter:
 
 ```ruby
-wb = xlsx_package.workbook
-style_shout = wb.styles.add_style sz: 16, b: true, alignment: { horizontal: :center }
-wb.add_worksheet(name: "Foobar") do |sheet|
-  sheet.add_row ['Bad', 'spellers', 'of', 'the', 'world', '...']
-  sheet.add_row ['Untie!']
-  sheet.merge_cells("B1:B6")
-  sheet["B1"].style = style_shout
-end
+render xlsx: "action_or_template", filename: "my_new_filename.xlsx"
 ```
 
+###Acts As Xlsx
+
 If you use [acts_as_xlsx](https://github.com/randym/acts_as_xlsx), configure the active record normally, but specify the package in the template:
 
 ```ruby
 User.to_xlsx package: xlsx_package, (other options)
 ```
 
+###Author
+
 To set the author attribute upon Axlsx::Package.new, insert the following in application.rb:
 
 ```ruby
@@ -90,7 +128,7 @@ config.axlsx_author = "Elmer Fudd"
 
 > NOTE: We really ought to allow the author to be set in each call
 
-####Partials
+###Partials
 
 Partials work as expected:
 
@@ -110,14 +148,14 @@ wb.add_worksheet(name: "Cover Sheet") do |sheet|
 end
 ```
 
-####Mailers
+###Mailers
 
 To use an xlsx template to render a mail attachment, use the following syntax:
 
 ```ruby
 class UserMailer < ActionMailer::Base
   def export(users)
-    xlsx = render handlers: [:axlsx], template: "users/export", locals: {users: users}
+    xlsx = render_to_string handlers: [:axlsx], template: "users/export", locals: {users: users}
     attachments["Users.xlsx"] = {mime_type: Mime::XLSX, content: xlsx}
     ...
   end
@@ -127,14 +165,17 @@ end
 If the template (`users/export`) can refer to only one file (the xlsx.axlsx template), you do not need to specify `handlers`.
 
 ##Troubleshooting
-### Mispellings
-It is easy to get the spelling wrong in the extension name, the format.xlsx statement, or in a render call. If you get the following error in particular: 
 
-```ruby
-  uninitialized constant Mime::XSLX
-```
+###Mispellings
+
+**It is easy to get the spelling wrong in the extension name, the format.xlsx statement, or in a render call.** Here are some possibilities:
 
-it means you have used `format.xslx` instead of `format.xlsx`, or something similar.
+* If it says your template is missing, check that its extension is `.xlsx.axlsx`.
+* If you get the error `uninitialized constant Mime::XSLX` you have used `format.xslx` instead of `format.xlsx`, or something similar.
+
+###What to do
+
+If you are having problems, try to isolate the issue. Use the console or a script to make sure your data is good. Then create the spreadsheet line by line without Axlsx-Rails to see if you are having Axlsx problems. If you can manually create the spreadsheet, create an issue and we will work it out.
 
 ##Dependencies
 
@@ -154,6 +195,13 @@ it means you have used `format.xslx` instead of `format.xlsx`, or something simi
 
 ##Change log
 
+**April 9, 2014**: 0.2.0 release
+
+- Require Axlsx 2.0.1, which requires rubyzip 1.0.0
+- Better render handling and testing, which might break former usage
+- Rails 4.1 testing
+- Mailer example update (**use render_to_string not render**)
+
 **October 11, 2013**
 
 - Handle (and test) respond_to override

data/lib/axlsx_rails/action_controller.rb

@@ -8,17 +8,48 @@ ActionController::Renderers.add :xlsx do |filename, options|
     formats[0] = :xlsx
   end
 
-  if filename =~ /^\/([^\/]+)\/(.+)$/
-    options[:prefixes][0] = $1
-    filename = $2
+  #
+  # The following code lets you call a separate view without
+  # specifying a template:  
+  #
+  #  def called_action
+  #    render pdf: 'diff_action'
+  #    # or
+  #    render pdf: 'controller/diff_action'
+  #  end
+  #
+  # You can always specify a template:
+  #
+  #  def called_action
+  #    render pdf: 'filename', template: 'controller/diff_action'
+  #  end
+  # 
+  # And the normal use case works:
+  #
+  #  def called_action
+  #    render 'diff_action'
+  #    # or
+  #    render 'controller/diff_action'
+  #  end
+  #
+  if options[:template] == action_name
+    if filename =~ /^([^\/]+)\/(.+)$/
+      options[:prefixes] ||= []
+      options[:prefixes].unshift $1
+      options[:template] = $2
+    else
+      options[:template] = filename
+    end
   end
-  options[:template] = filename
 
   disposition   = options.delete(:disposition) || 'attachment'
-  download_name = options.delete(:filename) || "#{filename}.xlsx"
-  download_name += ".xlsx" unless download_name =~ /\.xlsx$/
+  if file_name = options.delete(:filename)
+    file_name += ".xlsx" unless file_name =~ /\.xlsx$/
+  else
+    file_name = "#{filename.gsub(/^.*\//,'')}.xlsx"
+  end
 
-  send_data render_to_string(options), :filename => download_name, :type => Mime::XLSX, :disposition => disposition
+  send_data render_to_string(options), :filename => file_name, :type => Mime::XLSX, :disposition => disposition
 end
 
 # For respond_to default

data/lib/axlsx_rails/version.rb

@@ -1,3 +1,3 @@
 module AxlsxRails
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/spec/axlsx_request_spec.rb

@@ -93,14 +93,19 @@ describe 'Axlsx request', :type => :request do
     @user = User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
     visit "/users/#{@user.id}/render_elsewhere.xlsx"
     page.response_headers['Content-Type'].should == Mime::XLSX.to_s
-    visit "/home/render_elsewhere.xlsx"
-    page.response_headers['Content-Type'].should == Mime::XLSX.to_s
-    visit "/render_elsewhere.xlsx"
-    page.response_headers['Content-Type'].should == Mime::XLSX.to_s
-    File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
-    wb = nil
-    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
-    wb.cell(2,2).should == 'Bugs'
+    [[1,false],[2,false],[3,true],[4,true],[5,false]].each do |s|
+      visit "/home/render_elsewhere.xlsx?type=#{s[0]}"
+      page.response_headers['Content-Type'].should == Mime::XLSX.to_s +
+        (s[1] ? "; charset=utf-8" : '')
+      File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
+      wb = nil
+      expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+      if s[0] == 5
+        wb.cell(1,1).should == 'Bad'
+      else
+        wb.cell(2,2).should == 'Bugs'
+      end
+    end
   end
 
   it "uses respond_with" do

data/spec/ci.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if ENV['RAILS_VERSION'] =~ /^4/
+  puts "Testing Rails 4"
+  exit system('cd spec/dummy_4 && bundle install --without debug && bundle exec rake db:create && bundle exec rake db:migrate && cd ../../ && bundle exec rspec spec')
+else
+  puts "Testing Rails 3"
+  exit system('cd spec/dummy && bundle install --without debug && bundle exec rake db:create && bundle exec rake db:migrate && cd ../../ && bundle exec rspec spec')
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -19,7 +19,22 @@ class HomeController < ApplicationController
   end
 
   def render_elsewhere
-    render :xlsx => "/users/index"
+    case params[:type]
+    when '1'
+      render :xlsx => "home/index", :template => 'users/index'
+    when '2'
+      render :xlsx => "users/index"
+    when '3'
+      render template: "users/index"
+    when '4'
+      render "users/index"
+    else
+      render :xlsx => "index"
+    end
+  end
+
+  def render_file_path
+    render :xlsx => Rails.root.join('app','views','users','index')
   end
 
   def withpartial
@@ -31,7 +46,7 @@ class HomeController < ApplicationController
         if params[:set_direct]
           response.headers['Content-Disposition'] = "attachment; filename=\"filename_test.xlsx\""
         else
-          render xlsx: "useheader", disposition: "attachment", filename: "filename_test.xlsx"
+          render xlsx: "useheader", filename: "filename_test.xlsx"
         end
       }
     end

data/spec/dummy/app/controllers/likes_controller.rb

@@ -13,6 +13,6 @@ class LikesController < ApplicationController
 
   def render_elsewhere
     @user = User.find(params[:user_id])
-    render :xlsx => "/users/index"
+    render :xlsx => "users/index"
   end
 end

data/spec/dummy/app/mailers/notifier.rb

@@ -1,26 +1,14 @@
 class Notifier < ActionMailer::Base
   default :from => 'noreply@company.com'
-  # default :from => "Didier Leser - CESAM Nature <didier.leser@cesam-nature.com>"
 
   def instructions(user)
     @user = user
 
     # normal syntax
-    xlsx = render handlers: [:axlsx], template: 'users/mailers/instructions', layout: false
+    xlsx = render_to_string handlers: [:axlsx], template: 'users/mailers/instructions', layout: false
+    attachments["user_#{user.id}.xlsx"] = {mime_type: Mime::XLSX, content: xlsx}
 
-    # using render_to_string. sometimes not available, but why??
-    # xlsx = render_to_string handlers: [:axlsx], template: 'users/mailers/instructions', layout: false
-
-    # creating own view
-    # av = ActionView::Base.new()
-    # av.view_paths = ActionController::Base.view_paths
-    # av.extend ApplicationHelper
-    # av.assign user: @user
-    # xlsx = av.render handlers: [:axlsx], template: "users/mailers/instructions"
-    
-    attachments["user_#{user.id}.pdf"] = {mime_type: Mime::XLSX, content: xlsx}
     mail :to => user.email, :subject => 'Instructions'
   end
 
-
 end

data/spec/dummy/app/models/like.rb

@@ -1,5 +1,3 @@
 class Like < ActiveRecord::Base
-  attr_accessible :name, :user_id
-
   belongs_to :user
 end

data/spec/dummy/app/models/user.rb

@@ -1,7 +1,6 @@
 require 'acts_as_xlsx'
 class User < ActiveRecord::Base
 	acts_as_xlsx columns: [:id, :name, :last_name, :address, :email]
-  attr_accessible :address, :email, :last_name, :name
 
   has_many :likes
 

data/spec/dummy/config/application.rb

@@ -58,7 +58,7 @@ module Dummy
     # This will create an empty whitelist of attributes available for mass-assignment for all models
     # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
     # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
+    config.active_record.whitelist_attributes = false
 
     # Enable the asset pipeline
     config.assets.enabled = true

data/spec/dummy/db/schema.rb

@@ -9,24 +9,24 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20121206210955) do
+ActiveRecord::Schema.define(version: 20121206210955) do
 
-  create_table "likes", :force => true do |t|
+  create_table "likes", force: true do |t|
     t.string   "name"
     t.integer  "user_id"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
-  create_table "users", :force => true do |t|
+  create_table "users", force: true do |t|
     t.string   "name"
     t.string   "last_name"
     t.string   "address"
     t.string   "email"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
 end

data/spec/dummy/log/development.log

@@ -763,3 +763,66 @@ Migrating to CreateLikes (20121206210955)
    (2.0ms)  commit transaction
    (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
 Connecting to database specified by database.yml
+
+
+Started GET "/" for 127.0.0.1 at 2014-04-08 08:37:57 -0700
+Connecting to database specified by database.yml
+Processing by HomeController#index as HTML
+  Rendered home/index.html.erb within layouts/application (2.1ms)
+Completed 200 OK in 8.8ms (Views: 8.4ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2014-04-08 08:38:06 -0700
+Processing by HomeController#index as HTML
+  Rendered home/index.html.erb within layouts/application (0.4ms)
+Completed 200 OK in 2.2ms (Views: 2.0ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2014-04-08 08:38:08 -0700
+Processing by HomeController#index as HTML
+  Rendered home/index.html.erb within layouts/application (0.5ms)
+Completed 200 OK in 3.1ms (Views: 2.8ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/useheader.xlsx" for 127.0.0.1 at 2014-04-08 08:38:22 -0700
+Processing by HomeController#useheader as XLSX
+  Rendered home/useheader.xlsx.axlsx (8.8ms)
+Completed 200 OK in 11.0ms (Views: 10.5ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2014-04-08 08:38:46 -0700
+Processing by HomeController#index as HTML
+  Rendered home/index.html.erb within layouts/application (0.4ms)
+Completed 200 OK in 2.4ms (Views: 2.0ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/useheader.xlsx" for 127.0.0.1 at 2014-04-08 08:38:51 -0700
+Processing by HomeController#useheader as XLSX
+  Rendered home/useheader.xlsx.axlsx (8.4ms)
+Completed 200 OK in 79848.3ms (Views: 10.9ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2014-04-08 08:47:01 -0700
+Connecting to database specified by database.yml
+Processing by HomeController#index as HTML
+  Rendered home/index.html.erb within layouts/application (1.7ms)
+Completed 200 OK in 8.0ms (Views: 7.5ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/useheader.xlsx" for 127.0.0.1 at 2014-04-08 08:47:04 -0700
+Processing by HomeController#useheader as XLSX
+  Rendered home/useheader.xlsx.axlsx (8.8ms)
+Completed 200 OK in 7766.7ms (Views: 11.2ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/useheader.xlsx" for 127.0.0.1 at 2014-04-08 08:48:02 -0700
+Processing by HomeController#useheader as XLSX
+  Rendered home/useheader.xlsx.axlsx (8.1ms)
+Completed 200 OK in 1862.8ms (Views: 10.4ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/useheader.xlsx" for 127.0.0.1 at 2014-04-08 08:49:44 -0700
+Connecting to database specified by database.yml
+Processing by HomeController#useheader as XLSX
+  Rendered home/useheader.xlsx.axlsx (7.4ms)
+Completed 200 OK in 3316.7ms (Views: 14.6ms | ActiveRecord: 0.0ms)