axlsx_rails 0.1.4 → 0.1.5

data/Guardfile

@@ -11,5 +11,6 @@ guard 'rspec', :version => 2 do
   watch(%r{spec/dummy/app/controllers/.+\.rb$}) { ["spec/axlsx_renderer_spec.rb", "spec/axlsx_builder_spec.rb", "axlsx_request_spec.rb"] }
   watch('lib/axlsx_rails/action_controller.rb') { ["spec/axlsx_renderer_spec.rb", "spec/axlsx_request_spec.rb"] }
   watch('lib/axlsx_rails/template_handler.rb')  { "spec/axlsx_builder_spec.rb" }
+  watch(%r{spec/dummy/app/mailers/.+\.rb$}) { "spec/axlsx_mailer_spec.rb" }
   watch(%r{spec/dummy/app/views/.+\.erb})       { "spec/axlsx_request_spec.rb" }
 end

data/README.md

@@ -1,8 +1,12 @@
 Axlsx-Rails — Axlsx templates for Rails views
 ===================================================
 
+[![Gem
+Version](https://badge.fury.io/rb/axlsx_rails.png)](http://badge.fury.io/rb/axlsx_rails)
 [![Build Status](https://secure.travis-ci.org/straydogstudio/axlsx_rails.png?branch=master)](http://travis-ci.org/straydogstudio/axlsx_rails)
 [![Dependency Status](https://gemnasium.com/straydogstudio/axlsx_rails.png?branch=master)](https://gemnasium.com/straydogstudio/axlsx_rails)
+[![Coverage
+Status](https://coveralls.io/repos/straydogstudio/axlsx_rails/badge.png)](https://coveralls.io/r/straydogstudio/axlsx_rails)
 
 ##Installation
 
@@ -14,11 +18,11 @@ gem 'axlsx_rails'
 
 ##Requirements
 
-* Rails 3.1, but it has only been tested on 3.2.6+
+* Rails 3.1, tested on 3.1, 3.2, and 4.0
 
 ##Usage
 
-Axlsx-Rails provides a renderer and a template handler. It adds the :xlsx format and parses .xlsx.axslx templates.
+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.**
 
 ###Controller
 
@@ -43,6 +47,7 @@ format.xlsx {
 	response.headers['Content-Disposition'] = 'attachment; filename="my_new_filename.xlsx"'
 }
 ```
+
 Or:
 
 ```ruby
@@ -56,7 +61,9 @@ format.xlsx {
 
 ###Template
 
-Use the .xlsx.axlsx extension (sorry if your lysdexic!) In the template, use xlsx_package variable, which is set with Axlsx::Package.new:
+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. 
+
+Use the .xlsx.axlsx extension ([watch out for typos!](#troubleshooting)) In the template, use xlsx_package variable, which is set with Axlsx::Package.new:
 
 ```ruby
 wb = xlsx_package.workbook
@@ -103,6 +110,32 @@ wb.add_worksheet(name: "Cover Sheet") do |sheet|
 end
 ```
 
+####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}
+    attachments["Users.xlsx"] = {mime_type: Mime::XLSX, content: xlsx}
+    ...
+  end
+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
+```
+
+it means you have used `format.xslx` instead of `format.xlsx`, or something similar.
+
 ##Dependencies
 
 - [Axlsx](https://github.com/randym/axlsx)
@@ -111,22 +144,54 @@ end
 
 * [Noel Peden](https://github.com/straydogstudio)
 
+##Contributors
+
+* [randym](https://github.com/randym)
+* [sugi](https://github.com/sugi)
+* [envek](https://github.com/envek)
+* [engwan](https://github.com/engwan)
+* [maxd](https://github.com/maxd)
+
 ##Change log
 
-- **December 6, 2012**: 0.1.3 release
-  - Fix for absolute template paths
+**October 11, 2013**
+
+- Handle (and test) respond_to override
+
+**October 4, 2013**
+
+- Added coveralls
+- Raised testing to axlsx 2.0.1, roo 1.12.2, and rubyzip 1.0.0
+
+**July 25, 2013**
+
+- Documentation improved
+- Testing for generating partial in mailer
+
+**January 18, 2013**: 0.1.4 release
+
+- Now supports Rails 4 (thanks [Envek](https://github.com/Envek))
+- If you call render :xlsx on a request without :xlsx format, it should force the :xlsx format. Works on Rails 3.2+.
+
+**December 6, 2012**: 0.1.3 release
+
+- Fix for absolute template paths
+
+**July 25, 2012**: 0.1.2 release
+
+- Partials tested
+
+**July 19, 2012**: 0.1.1 release
+
+- Travis-ci added (thanks [randym](https://github.com/randym))
+- render statements and filename tests fixes (thanks [engwan](https://github.com/engwan))
 
-- **July 25, 2012**: 0.1.2 release
-	- Partials tested
+**July 17, 2012**: 0.1.0 release
 
-- **July 19, 2012**: 0.1.1 release
-	- Travis-ci added (thanks [randym](https://github.com/randym))
-	- render statements and filename tests fixes (thanks [engwan](https://github.com/engwan))
+- Tests completed
+- Acts_as_xlsx tested, example in docs		
 
-- **July 17, 2012**: 0.1.0 release
-	- Tests completed
-	- Acts_as_xlsx tested, example in docs
+**July 12, 2012**: 0.0.1 release
 
-- **July 12, 2012**: 0.0.1 release
-	- Initial posting.
-	- It works, but there are no tests! Bad programmer!
+- Initial posting.
+- It works, but there are no tests! Bad programmer!

data/lib/axlsx_rails/action_controller.rb

@@ -24,6 +24,10 @@ end
 # For respond_to default
 class ActionController::Responder
   def to_xlsx
-    controller.render :xlsx => controller.action_name
+    if @default_response
+      @default_response.call(options)
+    else
+      controller.render({:xlsx => controller.action_name}.merge(options))
+    end
   end
 end

data/lib/axlsx_rails/version.rb

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

data/spec/axlsx_builder_spec.rb

@@ -24,11 +24,11 @@ describe 'Axlsx template handler' do
       xlsx_package, wb = nil
       eval( AB.call template )
       xlsx_package.serialize('/tmp/axlsx_temp.xlsx')
-      expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+      expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
       wb.cell(2,3).should == 'c'
     end
 
     #TODO:
     # Test if author field is set - does roo parse that?
   end
-end
+end

data/spec/axlsx_mailer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "Mailer", type: :request do
+  before :each do
+    @user = User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+  end
+
+  it "attaches an xlsx file" do
+    visit "/users/#{@user.id}/send_instructions"
+    last_email = ActionMailer::Base.deliveries.last
+    last_email.to.should == [@user.email]
+    last_email.attachments.first.should be
+    last_email.attachments.first.content_type.should == Mime::XLSX.to_s + "; charset=UTF-8"
+  end
+end

data/spec/axlsx_request_spec.rb

@@ -1,4 +1,4 @@
-require'spec_helper'
+require 'spec_helper'
 describe 'Axlsx request', :type => :request do
 
   it "has a working dummy app" do
@@ -11,7 +11,7 @@ describe 'Axlsx request', :type => :request do
     page.response_headers['Content-Type'].should == Mime::XLSX.to_s + "; charset=utf-8"
     File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
     wb = nil
-    expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
     wb.cell(2,1).should == 'Untie!'
   end
 
@@ -23,7 +23,19 @@ describe 'Axlsx request', :type => :request do
 
     File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
     wb = nil
-    expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    wb.cell(2,1).should == 'Untie!'
+  end
+
+  it "downloads an excel file from respond_to while specifying filename in direct format" do
+    visit '/useheader.xlsx?set_direct=true'
+
+    page.response_headers['Content-Type'].should == Mime::XLSX.to_s + "; charset=utf-8"
+    page.response_headers['Content-Disposition'].should include("filename=\"filename_test.xlsx\"")
+
+    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,1).should == 'Untie!'
   end
 
@@ -35,7 +47,7 @@ describe 'Axlsx request', :type => :request do
 
     File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
     wb = nil
-    expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
     wb.cell(2,1).should == 'Untie!'
   end
 
@@ -47,7 +59,7 @@ describe 'Axlsx request', :type => :request do
     page.response_headers['Content-Type'].should == Mime::XLSX.to_s + "; charset=utf-8"
     File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
     wb = nil
-    expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
     wb.cell(3,2).should == 'Bugs'
   end
 
@@ -56,7 +68,7 @@ describe 'Axlsx request', :type => :request do
     page.response_headers['Content-Type'].should == Mime::XLSX.to_s + "; charset=utf-8"
     File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
     wb = nil
-    expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
     wb.cell(1,1,wb.sheets[0]).should == 'Cover'
     wb.cell(2,1,wb.sheets[1]).should == "Untie!"
   end
@@ -70,7 +82,7 @@ describe 'Axlsx request', :type => :request do
     page.response_headers['Content-Type'].should == Mime::XLSX.to_s + "; charset=utf-8"
     File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
     wb = nil
-    expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
     wb.cell(1,1).should == 'Bugs'
     wb.cell(2,1).should == 'Carrots'
     wb.cell(3,1).should == 'Celery'
@@ -87,10 +99,22 @@ describe 'Axlsx request', :type => :request do
     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 = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+    expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
     wb.cell(2,2).should == 'Bugs'
   end
 
+  it "uses respond_with" do
+    User.destroy_all
+    @user = User.create name: 'Responder', last_name: 'Bunny', address: '1234 Right Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    expect {
+      visit "/users/#{@user.id}.xlsx"
+    }.to_not raise_error
+    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,1).should == 'Untie!'
+  end
+
   unless Rails.version < '3.2'
     it "handles missing format with render :xlsx" do
       visit '/another'
@@ -100,7 +124,7 @@ describe 'Axlsx request', :type => :request do
 
       File.open('/tmp/axlsx_temp.xlsx', 'w') {|f| f.write(page.source) }
       wb = nil
-      expect{ wb = Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
+      expect{ wb = Roo::Excelx.new('/tmp/axlsx_temp.xlsx') }.to_not raise_error
       wb.cell(2,1).should == 'Untie!'
     end
   end

data/spec/ci.sh

@@ -1,2 +1,2 @@
 #!/usr/bin/env sh
-cd spec/dummy && bundle install --without debug && bundle exec rake db:create && bundle exec rake db:migrate && cd ../../ && bundle exec rake spec
+cd spec/dummy && bundle install --without debug && bundle exec rake db:create && bundle exec rake db:migrate && cd ../../ && bundle exec rspec spec

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

@@ -28,8 +28,11 @@ class HomeController < ApplicationController
   def useheader
     respond_to do |format|
       format.xlsx {
-        render xlsx: "useheader", disposition: "attachment", filename: "filename_test.xlsx"
-        # response.headers['Content-Disposition'] = "attachment; filename=\"filename_test.xlsx\""
+        if params[:set_direct]
+          response.headers['Content-Disposition'] = "attachment; filename=\"filename_test.xlsx\""
+        else
+          render xlsx: "useheader", disposition: "attachment", filename: "filename_test.xlsx"
+        end
       }
     end
   end

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

@@ -1,4 +1,6 @@
 class UsersController < ApplicationController
+  respond_to :xlsx, :html
+
   # GET /users
   # GET /users.json
   def index
@@ -9,4 +11,17 @@ class UsersController < ApplicationController
       format.xlsx
     end
   end
+
+  def show
+    @user = User.find(params[:id])
+    respond_with(@user) do |format|
+      format.xlsx { render "respond_with.xlsx.axlsx" }
+    end
+  end
+
+  def send_instructions
+    @user = User.find(params[:user_id])
+    @user.send_instructions
+    render text: "Email sent"
+  end
 end

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

@@ -0,0 +1,26 @@
+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
+
+    # 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/user.rb

@@ -4,4 +4,8 @@ class User < ActiveRecord::Base
   attr_accessible :address, :email, :last_name, :name
 
   has_many :likes
+
+  def send_instructions
+    Notifier.instructions(self).deliver
+  end
 end

data/spec/dummy/app/views/notifier/instructions.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <h1>Instructions</h1>
+    <p>
+      You have successfully signed up to example.com,
+      your username is: <%= @user.email %>.<br/>
+    </p>
+    <p>Thanks for joining and have a great day!</p>
+  </body>
+  </html>

data/spec/dummy/app/views/users/mailers/instructions.xlsx.axlsx

@@ -0,0 +1,5 @@
+wb = xlsx_package.workbook
+wb.add_worksheet(name: "Instructions") do |sheet|
+  sheet.add_row [@user.id, @user.name, @user.email]
+  sheet.add_row ['', 'Instructions', '']
+end

data/spec/dummy/app/views/users/respond_with.xlsx.axlsx

@@ -0,0 +1,8 @@
+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("A2:E2")
+  sheet["A2"].style = style_shout
+end

data/spec/dummy/config/environments/development.rb

@@ -34,4 +34,6 @@ Dummy::Application.configure do
 
   # Expands the lines which load the assets
   config.assets.debug = true
+
+  config.eager_load = false
 end

data/spec/dummy/config/environments/production.rb

@@ -64,4 +64,6 @@ Dummy::Application.configure do
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
   # config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  config.eager_load = true
 end

data/spec/dummy/config/environments/test.rb

@@ -1,5 +1,6 @@
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
+  config.eager_load = false if Rails.version >= '4.0'
 
   # The test environment is used exclusively to run your application's
   # test suite. You never need to work with it otherwise. Remember that
@@ -12,7 +13,7 @@ Dummy::Application.configure do
   config.static_cache_control = "public, max-age=3600"
 
   # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
+  # config.whiny_nils = true
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
@@ -34,4 +35,6 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  config.eager_load = false
 end