activeadmin-xls 1.0.5 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3cefe4337bc929cc027541a8b378764fcee9c29
-  data.tar.gz: 6ece12827ba7c2e0b85772b357c368a29d973c51
+  metadata.gz: '08d961ae05e4dca5b44e3e1615ce356fb8dd7e59'
+  data.tar.gz: 2c8f37c8e0c43cf10e91b9889576efeb3ff98297
 SHA512:
-  metadata.gz: a505457094d423aad3857be11f8aaf26adafa48957678296019324c15736be6bc89c40be0b41e4e3ea79ed17d9abd205e4463937aca9f40618193bf7eb3e8de4
-  data.tar.gz: 689a4ae242134e3cc0e7d7729b539eadca9349bbd141431422b7f0a83b10be7b3f72012ec60c92019b036973b9debe6f3e0b9ef947d35f815a51bb2dffb9c4a2
+  metadata.gz: c523bd762b313b3cb7002044462b80d5b300bb49c37606aa2b72da2da5e29702ba3c85c021fd886aad099fb606e6c5f2e0bff78118e872673311e66af7862bf5
+  data.tar.gz: fffc68d9617a1b2d61a7e639d4579379f4a4779eaa570d485c52dc86270649171fdf81b5583cf3d0f023ed66267e8011a5339c98fab73e63bddc148bf1ec9d41

data/.gitignore

@@ -1,7 +1,7 @@
 spec/rails
 *.gem
 coverage
-*.xlsx
+*.xls
 doc
 *.un~
 .yardoc

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+  - 2.6.5
+
+gemfile:
+  - gemfiles/rails_42.gemfile
+  - gemfiles/rails_52.gemfile
+  - gemfiles/rails_60.gemfile
+
+script:
+  - bundle exec rake setup
+  - bundle exec rake

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb - README.md LICENSE

data/CHANGELOG.md

@@ -1,33 +1,83 @@
 # Changelog
 
+## [Unreleased]
+
+## 2.0.3
+
+### Changed
+
+* ignore test/ folder for gem building [#21][] by [@cprodhomme][]
+
+## 2.0.2
+
+### Changed
+
+* Remove ActiveAdmin runtime dependency version limit '<2' [#16][] by [@reaper][]
+
+## 2.0.1
+
+### Fixed
+
+* fix issue with xls_builder retaining data between requests when there is an exception on a computed field [#13][]
+
+## 2.0.0
+
+### Changed
+
+* Drop support for ruby 1.9, rails 3.2, and ActiveAdmin 0.6.6.
+* Add support for rails 5.1 [#8][]
+
+## 1.1.0
+
+### Added
+
+* Add only_columns [#7][]
+
+### Fixed
+
+* Fix typo in README.md [#11][] by [@cpunion][]
+
+### Changed
+
+* Update tests for ActiveAdmin 1.2
+
 ## 1.0.5
 
-### Updates
+### Fixed
 
 * Fix #1 - Unnecessary database access
 * Fix broken tests
 
 ## 1.0.4
 
-### Updates
+### Fixed
 
 * Minor bug fixes / typo corrections
 
 ## 1.0.3
 
-### Updates
+### Fixed
 
 * Move require rake from gemspec to lib/activeadmin-xls.rb [#4][] by [@ejaypcanaria][]
 
 ## 1.0.2
 
-### Bug Fixes
+### Fixed
 
 * Fixes undefined local variable or `method max_per_page` [#3][] by [@rewritten][]
 
 <!--- Link List --->
 [#3]: https://github.com/thambley/activeadmin-xls/issues/3
 [#4]: https://github.com/thambley/activeadmin-xls/pull/4
+[#7]: https://github.com/thambley/activeadmin-xls/issues/7
+[#8]: https://github.com/thambley/activeadmin-xls/issues/8
+[#11]: https://github.com/thambley/activeadmin-xls/pull/11
+[#13]: https://github.com/thambley/activeadmin-xls/issues/13
+[#16]: https://github.com/thambley/activeadmin-xls/pull/16
+[#21]: https://github.com/thambley/activeadmin-xls/pull/21
 
 [@rewritten]: https://github.com/rewritten
 [@ejaypcanaria]: https://github.com/ejaypcanaria
+[@cpunion]: https://github.com/cpunion
+[@reaper]: https://github.com/reaper
+[@cprodhomme]: https://github.com/cprodhomme

data/Gemfile

@@ -4,11 +4,11 @@ gem 'spreadsheet', '~> 1.1', '>= 1.1.4'
 
 group :development, :test do
   gem 'rails-i18n' # Gives us default i18n for many languages
-  gem 'sqlite3'
   gem 'yard'
 end
 
 group :test do
+  gem 'codecov', require: false
   gem 'cucumber-rails', require: false
   gem 'database_cleaner'
   gem 'rspec-mocks', '~> 3.7'

data/README.md

@@ -1,34 +1,38 @@
-# Active Admin Xls: Excel Spreadsheet Export for Active Admin
+# Active Admin Xls
 
-**Git**: [http://github.com/thambley/activeadmin-xls](http://github.com/thambley/activeadmin-xls)
+Excel Spreadsheet Export for [Active Admin]
 
-**Author**:  Todd Hambley
-
-**Copyright**:    2014 ~ 2017
-
-**License**: MIT License
-
-**Latest Version**: 1.0.4
-
-**Release Date**: 2017.11.22
+[![Version][rubygems_badge]][rubygems]
+[![Travis CI][travis_badge]][travis]
+[![Quality][codeclimate_badge]][codeclimate]
+[![Coverage][codecov_badge]][codecov]
+[![Inch CI][inch_badge]][inch]
 
 ## Synopsis
 
 This gem provides xls downloads for Active Admin resources.
 
-This gem borrows heavily from [https://github.com/randym/activeadmin-axlsx](https://github.com/randym/activeadmin-axlsx) and [https://github.com/splendeo/to_xls](https://github.com/splendeo/to_xls).
+This gem borrows heavily from [activeadmin-axlsx] and [to_xls].
 
-Usage example:
+## Usage
 
-Add the following to your Gemfile and you are good to go.
-All resource index views will now include a link for download directly
-to xls.
+Add the following to your Gemfile. All resource index views will now include a link for download directly to xls.
 
 ```ruby
-gem 'activeadmin-xls'
+gem 'activeadmin-xls', '~>2.0.0'
 ```
 
-## Cool Toys
+For Active Admin 1.0 and above, you will also have to update config/initializers/active_admin.rb.  Update the download\_links setting to include xls:
+
+```ruby
+config.download_links = %i[csv xml json xls]
+```
+
+## Dependencies
+
+This gem depends on [spreadsheet] to generate xls files.
+
+## Examples
 
 Here are a few quick examples of things you can easily tweak.
 
@@ -71,6 +75,15 @@ ActiveAdmin.register Post do
 end
 ```
 
+### Restrict columns to a list
+
+```ruby
+# app/admin/posts.rb
+ActiveAdmin.register Post do
+  config.xls_builder.only_columns :title, :author
+end
+```
+
 ## Using the DSL
 
 Everything that you do with the config's default builder can be done via
@@ -91,10 +104,13 @@ ActiveAdmin.register Post do
     # Do not serialize the header, only output data.
     # skip_header
 
+    # restrict columns to a list without customization
+    # only_columns :title, :author
+
     # deleting columns from the report
     delete_columns :id, :created_at, :updated_at
 
-    # adding a column to the report
+    # adding a column to the report with customization
     column(:author) { |post| "#{post.author.first_name} #{post.author.last_name}" }
 
     # inserting additional data with after_filter
@@ -110,42 +126,66 @@ ActiveAdmin.register Post do
 end
 ```
 
-## Specs
+## Testing
 
 Running specs for this gem requires that you construct a rails application.
 
 To execute the specs, navigate to the gem directory, run bundle install and run these to rake tasks:
 
-### Rails 3.2
+### Rails 4.2
 
 ```text
-bundle install --gemfile=gemfiles/rails_32.gemfile
+bundle install --gemfile=gemfiles/rails_42.gemfile
 ```
 
 ```text
-BUNDLE_GEMFILE=gemfiles/rails_32.gemfile bundle exec rake setup
+BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake setup
 ```
 
 ```text
-BUNDLE_GEMFILE=gemfiles/rails_32.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake
 ```
 
-### Rails 4.2
+### Rails 5.2
 
 ```text
-bundle install --gemfile=gemfiles/rails_42.gemfile
+bundle install --gemfile=gemfiles/rails_52.gemfile
 ```
 
 ```text
-BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake setup
+BUNDLE_GEMFILE=gemfiles/rails_52.gemfile bundle exec rake setup
 ```
 
 ```text
-BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails_52.gemfile bundle exec rake
 ```
 
-## Copyright and License
+### Rails 6.0
 
-activeadmin-xls © 2014 by [Todd Hambley](mailto:thambley@travelleaders.com).
+```text
+bundle install --gemfile=gemfiles/rails_60.gemfile
+```
+
+```text
+BUNDLE_GEMFILE=gemfiles/rails_60.gemfile bundle exec rake setup
+```
+
+```text
+BUNDLE_GEMFILE=gemfiles/rails_60.gemfile bundle exec rake
+```
 
-activeadmin-xls is licensed under the MIT license. Please see the LICENSE document for more information.
+[Active Admin]:https://www.activeadmin.info/
+[activeadmin-axlsx]:https://github.com/randym/activeadmin-axlsx
+[to_xls]:https://github.com/splendeo/to_xls
+[spreadsheet]:https://github.com/zdavatz/spreadsheet
+
+[rubygems_badge]: https://img.shields.io/gem/v/activeadmin-xls.svg
+[rubygems]: https://rubygems.org/gems/activeadmin-xls
+[travis_badge]: https://img.shields.io/travis/thambley/activeadmin-xls/master.svg
+[travis]: https://travis-ci.org/thambley/activeadmin-xls
+[codeclimate_badge]: https://api.codeclimate.com/v1/badges/e294712bac54d4520182/maintainability
+[codeclimate]: https://codeclimate.com/github/thambley/activeadmin-xls/maintainability
+[codecov_badge]: https://codecov.io/gh/thambley/activeadmin-xls/branch/master/graph/badge.svg
+[codecov]: https://codecov.io/gh/thambley/activeadmin-xls
+[inch_badge]: http://inch-ci.org/github/thambley/activeadmin-xls.svg?branch=master
+[inch]: http://inch-ci.org/github/thambley/activeadmin-xls

data/Rakefile

@@ -1,12 +1,31 @@
 #!/usr/bin/env rake
+require File.expand_path('../lib/active_admin/xls/version', __FILE__)
 require 'rspec/core/rake_task'
 
 desc 'Creates a test rails app for the specs to run against'
 task :setup do
   require 'rails/version'
-  system('mkdir spec/rails') unless File.exist?('spec/rails')
-  puts "system \"bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template_with_data.rb\""
-  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template_with_data.rb"
+  base_dir = 'spec/rails'
+  app_dir = "#{base_dir}/rails-#{Rails::VERSION::STRING}"
+  template = 'rails_template_with_data'
+
+  if File.exist? app_dir
+    puts "test app #{app_dir} already exists; skipping"
+  else
+    system "mkdir -p #{base_dir}"
+    args = %W[
+      -m spec/support/#{template}.rb
+      --skip-bundle
+      --skip-listen
+      --skip-turbolinks
+      --skip-test-unit
+      --skip-coffee
+    ]
+
+    command = ['bundle', 'exec', 'rails', 'new', app_dir, *args].join(' ')
+    env = { 'BUNDLE_GEMFILE' => ENV['BUNDLE_GEMFILE'] }
+    Bundler.with_clean_env { Kernel.exec(env, command) }
+  end
 end
 
 RSpec::Core::RakeTask.new
@@ -17,6 +36,7 @@ desc 'build the gem'
 task :build do
   system 'gem build activeadmin-xls.gemspec'
 end
+
 desc 'build and release the gem'
 task release: :build do
   system "gem push activeadmin-xls-#{ActiveAdmin::Xls::VERSION}.gem"

data/activeadmin-xls.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
   git_tracked_files = `git ls-files`.split("\n").sort
   gem_ignored_files = `git ls-files -i -X .gemignore`.split("\n")
 
-  s.files = git_tracked_files - gem_ignored_files
+  s.files = (git_tracked_files - gem_ignored_files).reject { |f| f.match(%r{^(test|spec|features)/}) }
 
-  s.add_runtime_dependency 'activeadmin', '>= 0.6.6', '< 2'
+  s.add_runtime_dependency 'activeadmin', '>= 1.0.0'
   s.add_runtime_dependency 'spreadsheet', '~> 1.0'
 
-  s.required_ruby_version = '>= 1.9.2'
+  s.required_ruby_version = '>= 2.0.0'
   s.require_path = 'lib'
 end

data/gemfiles/rails_42.gemfile

@@ -6,9 +6,11 @@ ruby_minor_version = RUBY_VERSION.split('.')[1].to_i
 
 eval_gemfile(File.expand_path(File.join('..', 'Gemfile'), __dir__))
 
-gem 'activeadmin', '1.0.0'
+gem 'activeadmin', '1.4.3'
 gem 'devise', '~> 4.2'
-gem 'rails', '4.2.10'
+gem 'rails', '4.2.11'
+gem 'sprockets', '< 4.0'
+gem 'sqlite3', '~> 1.3.0'
 gem 'turbolinks', '~> 5.0.0'
 gem 'tzinfo-data'
 

data/gemfiles/rails_52.gemfile

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+source 'https://rubygems.org'
+
+ruby_major_version = RUBY_VERSION.split('.')[0].to_i
+ruby_minor_version = RUBY_VERSION.split('.')[1].to_i
+
+eval_gemfile(File.expand_path(File.join('..', 'Gemfile'), __dir__))
+
+gem 'activeadmin', '2.4.0'
+gem 'bootsnap', require: false
+gem 'devise', '~> 4.7'
+gem 'rails', ' ~> 5.2'
+gem 'sqlite3', '~> 1.4.0'
+gem 'turbolinks', '~> 5.2.0'
+gem 'tzinfo-data'
+
+group :test do
+  gem 'shoulda-matchers', '~> 3.1'
+  if ruby_major_version > 2 || (ruby_major_version == 2 && ruby_minor_version > 1)
+    gem 'test-unit', '~> 3.0'
+  end
+end
+
+gemspec path: "../"

data/gemfiles/rails_60.gemfile

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+source 'https://rubygems.org'
+
+ruby_major_version = RUBY_VERSION.split('.')[0].to_i
+ruby_minor_version = RUBY_VERSION.split('.')[1].to_i
+
+eval_gemfile(File.expand_path(File.join('..', 'Gemfile'), __dir__))
+
+gem 'activeadmin', '2.4.0'
+gem 'bootsnap', require: false
+gem 'devise', '~> 4.7'
+gem 'rails', '~> 6'
+gem 'sqlite3', '~> 1.4.0'
+gem 'turbolinks', '~> 5.2.0'
+gem 'tzinfo-data'
+gem 'webpacker', '~> 4.x'
+
+group :test do
+  gem 'shoulda-matchers', '~> 3.1'
+  if ruby_major_version > 2 || (ruby_major_version == 2 && ruby_minor_version > 1)
+    gem 'test-unit', '~> 3.0'
+  end
+end
+
+gemspec path: "../"

data/lib/active_admin/xls/builder.rb

@@ -7,26 +7,28 @@ module ActiveAdmin
     class Builder
       include MethodOrProcHelper
 
-      # @param resource_class The resource this builder generate column
+      # @param [Class] resource_class The resource this builder generate column
       #   information for.
-      # @param [Hash] options the options for this builder
-      # @option [Hash] :header_format - a hash of format properties to apply
-      #   to the header row. Any properties specified will be merged with the
-      #   default header styles. @see https://github.com/zdavatz/spreadsheet/blob/master/lib/spreadsheet/format.rb
-      # @option [Array] :i18n_scope - the I18n scope to use when looking
+      # @param [Hash] options the options for the builder
+      # @option options [Hash] :header_format A hash of format properties to
+      #   apply to the header row. Any properties specified will be merged with
+      #   the default header styles.
+      # @option options [Array] :i18n_scope the I18n scope to use when looking
       #   up localized column headers.
-      # @param [Block] Any block given will evaluated against this instance of
+      # @param [Block] block Block given will evaluated against this instance of
       #   Builder. That means you can call any method on the builder from within
       #   that block.
       # @example
-      #   ActiveAdmin::Xls:Builder.new(Post, i18n: [:xls]) do
+      #   ActiveAdmin::Xls::Builder.new(Post, i18n: [:xls]) do
       #     delete_columns :id, :created_at, :updated_at
       #     column(:author_name) { |post| post.author.name }
-      #     after_filter { |sheet|
-      #
-      #     }
+      #     after_filter do |sheet|
+      #       # todo
+      #     end
       #   end
-      #   @see ActiveAdmin::Axlsx::DSL
+      #
+      # @see DSL
+      # @see https://github.com/zdavatz/spreadsheet/blob/master/lib/spreadsheet/format.rb
       def initialize(resource_class, options = {}, &block)
         @skip_header = false
         @resource_class = resource_class
@@ -39,6 +41,8 @@ module ActiveAdmin
 
       # The default header style
       # @return [Hash]
+      #
+      # @see https://github.com/zdavatz/spreadsheet/blob/master/lib/spreadsheet/format.rb
       def header_format
         @header_format ||= {}
       end
@@ -47,9 +51,28 @@ module ActiveAdmin
 
       # This has can be used to override the default header style for your
       # sheet. Any values you provide will be merged with the default styles.
-      # Precidence is given to your hash
+      # Precedence is given to your hash
+      #
+      # @example In Builder.new
+      #   options = {
+      #     header_format: { weight: :bold },
+      #     i18n_scope: %i[xls post]
+      #   }
+      #   Builder.new(Post, options) do
+      #     skip_header
+      #   end
+      #
+      # @example With DSL
+      #   ActiveAdmin.register Post do
+      #     xls(header_format: { weight: :bold }, i18n_scope: %i[xls post]) do
+      #       skip_header
+      #     end
+      #   end
+      #
+      # @example Simple DSL without block
+      #   xls header_format: { weight: :bold }
+      #
       # @see https://github.com/zdavatz/spreadsheet/blob/master/lib/spreadsheet/format.rb
-      # for more details on how to create and apply style.
       def header_format=(format_hash)
         @header_format = header_format.merge(format_hash)
       end
@@ -57,33 +80,85 @@ module ActiveAdmin
       alias header_style= header_format=
 
       # Indicates that we do not want to serialize the column headers
+      #
+      # @example In Builder.new
+      #   options = {
+      #     header_format: { weight: :bold },
+      #     i18n_scope: %i[xls post]
+      #   }
+      #   Builder.new(Post, options) do
+      #     skip_header
+      #   end
+      #
+      # @example With DSL
+      #   ActiveAdmin.register Post do
+      #     xls(header_format: { weight: :bold }, i18n_scope: %i[xls post]) do
+      #       skip_header
+      #     end
+      #   end
       def skip_header
         @skip_header = true
       end
 
-      # The scope to use when looking up column names to generate the
-      # report header
-      attr_reader :i18n_scope
-
-      # This is the I18n scope that will be used when looking up your
-      # colum names in the current I18n locale.
+      # The I18n scope that will be used when looking up your
+      # column names in the current I18n locale.
       # If you set it to [:active_admin, :resources, :posts] the
       # serializer will render the value at active_admin.resources.posts.title
       # in the current translations
+      #
       # @note If you do not set this, the column name will be titleized.
-      attr_writer :i18n_scope
+      attr_accessor :i18n_scope
 
       # The stored block that will be executed after your report is generated.
+      #
+      # @yieldparam sheet [Spreadsheet::Worksheet] the worksheet where the
+      #   collection has been serialized
+      #
+      # @example With DSL
+      #   xls do
+      #     after_filter do |sheet|
+      #       row_number = sheet.dimensions[1]
+      #       sheet.update_row(row_number)
+      #       row_number += 1
+      #       sheet.update_row(row_number, 'Author Name', 'Number of Posts')
+      #       users = collection.map(&:author).uniq(&:id)
+      #       users.each do |user|
+      #         row_number += 1
+      #         sheet.update_row(row_number,
+      #                          "#{user.first_name} #{user.last_name}",
+      #                          user.posts.size)
+      #       end
+      #     end
+      #   end
       def after_filter(&block)
         @after_filter = block
       end
 
       # the stored block that will be executed before your report is generated.
+      #
+      # @yieldparam sheet [Spreadsheet::Worksheet] the worksheet where the
+      #   collection has been serialized
+      #
+      # @example with DSL
+      #   xls do
+      #     before_filter do |sheet|
+      #       users = collection.map(&:author)
+      #       users.each do |user|
+      #         user.first_name = 'Set In Proc' if user.first_name == 'bob'
+      #       end
+      #       row_number = sheet.dimensions[1]
+      #       sheet.update_row(row_number, 'Created', Time.zone.now)
+      #       row_number += 1
+      #       sheet.update_row(row_number, '')
+      #     end
+      #   end
       def before_filter(&block)
         @before_filter = block
       end
 
-      # The columns this builder will be serializing
+      # Returns the columns the builder will serialize.
+      #
+      # @return [Array<Column>] columns configued on the builder.
       def columns
         # execute each update from @column_updates
         # set @columns_loaded = true
@@ -92,13 +167,20 @@ module ActiveAdmin
       end
 
       # The collection we are serializing.
+      #
       # @note This is only available after serialize has been called,
       # and is reset on each subsequent call.
       attr_reader :collection
 
-      # removes all columns from the builder. This is useful when you want to
+      # Removes all columns from the builder. This is useful when you want to
       # only render specific columns. To remove specific columns use
       # ignore_column.
+      #
+      # @example Using alias whitelist
+      #   Builder.new(Post, header_style: {}, i18n_scope: %i[xls post]) do
+      #     whitelist
+      #     column :title
+      #   end
       def clear_columns
         @columns_loaded = true
         @column_updates = []
@@ -114,6 +196,18 @@ module ActiveAdmin
       # @param [Symbol] name The name of the column.
       # @param [Proc] block A block of code that is executed on the resource
       #                     when generating row data for this column.
+      #
+      # @example With block
+      #   xls(i18n_scope: [:rspec], header_style: { size: 20 }) do
+      #     delete_columns :id, :created_at
+      #     column(:author) { |post| post.author.first_name }
+      #   end
+      #
+      # @example With default value
+      #   Builder.new(Post, header_style: {}, i18n_scope: %i[xls post]) do
+      #     whitelist
+      #     column :title
+      #   end
       def column(name, &block)
         if @columns_loaded
           columns << Column.new(name, block)
@@ -125,8 +219,20 @@ module ActiveAdmin
         end
       end
 
-      # removes columns by name
-      # each column_name should be a symbol
+      # Removes columns by name.
+      # Each column_name should be a symbol.
+      #
+      # @example In Builder.new
+      #   options = {
+      #     header_style: { size: 10, color: 'red' },
+      #     i18n_scope: %i[xls post]
+      #   }
+      #   Builder.new(Post, options) do
+      #     delete_columns :id, :created_at, :updated_at
+      #     column(:author) do |resource|
+      #       "#{resource.author.first_name} #{resource.author.last_name}"
+      #     end
+      #   end
       def delete_columns(*column_names)
         if @columns_loaded
           columns.delete_if { |column| column_names.include?(column.name) }
@@ -138,27 +244,61 @@ module ActiveAdmin
         end
       end
 
+      # Removes all columns, and add columns by name.
+      # Each column_name should be a symbol
+      #
+      # @example
+      #   config.xls_builder.only_columns :title, :author
+      def only_columns(*column_names)
+        clear_columns
+        column_names.each do |column_name|
+          column column_name
+        end
+      end
+
       # Serializes the collection provided
+      #
+      # @param collection [Enumerable] list of resources to serialize
+      # @param view_context object on which unknown methods may be executed
       # @return [Spreadsheet::Workbook]
       def serialize(collection, view_context = nil)
         @collection = collection
         @view_context = view_context
+        book = Spreadsheet::Workbook.new
+        sheet = book.create_worksheet
         load_columns unless @columns_loaded
-        apply_filter @before_filter
-        export_collection(collection)
-        apply_filter @after_filter
-        to_stream
+        apply_filter @before_filter, sheet
+        export_collection collection, sheet
+        apply_filter @after_filter, sheet
+        to_stream book
       end
 
-      # Xls column
+      # Xls column information
       class Column
+        # @param name [String, Symbol] Name of the column. If the name of the
+        #   column is an existing attribute of the resource class, the value
+        #   can be retreived automatically if no block is specified
+        # @param block [Proc] A procedure to generate data for the column
+        #   instead of retreiving the value from the resource directly
         def initialize(name, block = nil)
           @name = name
           @data = block || @name
         end
 
-        attr_reader :name, :data
+        # @return [String, Symbol] Column name
+        attr_reader :name
+
+        # @return [String, Symbol, Proc] The column name used to look up the
+        #   value, or a block used to generate the value to display.
+        attr_reader :data
 
+        # Returns a localized version of the column name if a scope is given.
+        # Otherwise, it returns the titleized column name without translation.
+        #
+        # @param i18n_scope [String, Symbol, Array<String>, Array<Symbol>]
+        #   Translation scope.  If not provided, the column name will be used.
+        #
+        # @see I18n
         def localized_name(i18n_scope = nil)
           return name.to_s.titleize unless i18n_scope
           I18n.t name, scope: i18n_scope
@@ -176,18 +316,13 @@ module ActiveAdmin
         columns
       end
 
-      def to_stream
+      def to_stream(book)
         stream = StringIO.new('')
         book.write stream
-        clean_up
         stream.string
       end
 
-      def clean_up
-        @book = @sheet = nil
-      end
-
-      def export_collection(collection)
+      def export_collection(collection, sheet)
         return if columns.none?
         row_index = sheet.dimensions[1]
 
@@ -216,7 +351,7 @@ module ActiveAdmin
         end.compact
       end
 
-      def apply_filter(filter)
+      def apply_filter(filter, sheet)
         filter.call(sheet) if filter
       end
 
@@ -238,14 +373,6 @@ module ActiveAdmin
         resource.respond_to?(column.name)
       end
 
-      def sheet
-        @sheet ||= book.create_worksheet
-      end
-
-      def book
-        @book ||= ::Spreadsheet::Workbook.new
-      end
-
       def resource_columns(resource)
         [Column.new(:id)] + resource.content_columns.map do |column|
           Column.new(column.name.to_sym)