activeadmin-xls 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a30a7f1fc93455cecb1aac5d28026454061ebdcd
-  data.tar.gz: a1342476206f3a3b7ba04c15df545d620af315eb
+  metadata.gz: 0061e54090d183ee6259739d20d7db62eb890790
+  data.tar.gz: 7691fe01a10bcdd3aac3239f690ae98f95258460
 SHA512:
-  metadata.gz: acd27c54cbf49c5148d94625f4872b89291513fbea277ff8fb0e96231a40ce8172fb9cae4d91ad4e1adeda135ce45feb704a5396a2c66252a49f97abf3ab9de8
-  data.tar.gz: 9baa56bf539d13050c67b6a9e911323a0d5bd04bd43b6182eb32f0de4e6c125aaca61b32adafa86addd387072d751db5497f1b3273320abbd2aa044912b19f0e
+  metadata.gz: 522ac0e6309ad124d216acdd64228efec606836dd75369f90b9f8e2e806e017c658190a841c56bf54b3e77fe72bd3b5cac00be571db3602745a22f432855f33d
+  data.tar.gz: ffab449bd41cfb19b97d5b879d656f531a2cde929e98a5188b90765a5bce506200fd328f3f49a1ce4819d8837c8d5e994839abf4a36bd3c8e2dc1cbff97d1990

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+rvm:
+  - 2.2
+
+gemfile:
+  - gemfiles/rails_42.gemfile
+  - gemfiles/rails_51.gemfile
+
+script:
+  - bundle exec rake setup
+  - bundle exec rake

data/.yardopts

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

data/Gemfile

@@ -14,4 +14,5 @@ group :test do
   gem 'rspec-mocks', '~> 3.7'
   gem 'rspec-rails', '~> 3.7'
   gem 'simplecov', require: false
+  gem 'codecov', require: false
 end

data/README.md

@@ -1,23 +1,25 @@
 # Active Admin Xls
 
-Excel Spreadsheet Export for [Active Admin](https://www.activeadmin.info/)
+Excel Spreadsheet Export for [Active Admin]
 
-[![Gem Version](https://badge.fury.io/rb/activeadmin-xls.svg)](https://badge.fury.io/rb/activeadmin-xls)
+[![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', '~>1.1.0'
+gem 'activeadmin-xls', '~>2.0.0'
 ```
 
 For Active Admin 1.0, you will also have to update config/initializers/active_admin.rb.  Update the download\_links setting to include xls:
@@ -26,6 +28,10 @@ For Active Admin 1.0, you will also have to update config/initializers/active_ad
 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.
@@ -126,30 +132,46 @@ 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.1
 
 ```text
-bundle install --gemfile=gemfiles/rails_42.gemfile
+bundle install --gemfile=gemfiles/rails_51.gemfile
 ```
 
 ```text
-BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake setup
+BUNDLE_GEMFILE=gemfiles/rails_51.gemfile bundle exec rake setup
 ```
 
 ```text
-BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails_51.gemfile bundle exec rake
 ```
+
+[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

@@ -5,8 +5,27 @@ 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')
-  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

data/activeadmin-xls.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |s|
 
   s.files = git_tracked_files - gem_ignored_files
 
-  s.add_runtime_dependency 'activeadmin', '>= 0.6.6', '< 2'
+  s.add_runtime_dependency 'activeadmin', '>= 1.0.0', '< 2'
   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_51.gemfile

@@ -0,0 +1,22 @@
+#!/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', '1.2.1'
+gem 'devise', '~> 4.2'
+gem 'rails', '5.1.5'
+gem 'turbolinks', '~> 5.0.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/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::xls::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,8 +244,11 @@ module ActiveAdmin
         end
       end
 
-      # remove all columns, and add columns by name
-      # each column_name should be a symbol
+      # 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|
@@ -148,6 +257,9 @@ module ActiveAdmin
       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
@@ -159,15 +271,32 @@ module ActiveAdmin
         to_stream
       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

data/lib/active_admin/xls/dsl.rb

@@ -1,6 +1,6 @@
 module ActiveAdmin
   module Xls
-    # extends activeadmin dsl to include xls
+    # Extends activeadmin dsl to include xls
     module DSL
       delegate(:after_filter,
                :before_filter,
@@ -15,6 +15,53 @@ module ActiveAdmin
                to: :xls_builder,
                prefix: :config)
 
+      # Creates a default XLS Builder to respond to xls requests for this
+      # resource. Options are passed to the Builder initialize method.
+      #
+      # @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] block block given will evaluated against the instance of
+      #   Builder. That means you can call any method on the builder from within
+      #   that block.
+      # @return A new instance of Builder
+      #
+      # @example Using the DSL
+      #   xls(i18n_scope: [:active_admin, :xls, :post],
+      #       header_format: { weight: :bold, color: :blue }) do
+      #     # Specify that you want to white list column output.
+      #     # whitelist
+      #
+      #     # 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 with customization
+      #     column(:author) do |post|
+      #       "#{post.author.first_name} #{post.author.last_name}"
+      #     end
+      #
+      #     # inserting additional data with after_filter
+      #     after_filter do |sheet|
+      #       # todo
+      #     end
+      #
+      #     # inserting data with before_filter
+      #     before_filter do |sheet|
+      #       # todo
+      #     end
+      #   end
+      #
+      # @see Builder
+      # @see https://github.com/zdavatz/spreadsheet/blob/master/lib/spreadsheet/format.rb
       def xls(options = {}, &block)
         config.xls_builder = ActiveAdmin::Xls::Builder.new(
           config.resource_class,

data/lib/active_admin/xls/engine.rb

@@ -1,6 +1,6 @@
 module ActiveAdmin
   module Xls
-    # extends activeadmin with xls downloads
+    # Extends ActiveAdmin with xls downloads
     class Engine < ::Rails::Engine
       engine_name 'active_admin_xls'
 
@@ -14,7 +14,7 @@ module ActiveAdmin
         ActiveAdmin::ResourceDSL.send :include, ActiveAdmin::Xls::DSL
         ActiveAdmin::Resource.send :include, ActiveAdmin::Xls::ResourceExtension
         ActiveAdmin::ResourceController.send(
-          :include,
+          :prepend,
           ActiveAdmin::Xls::ResourceControllerExtension
         )
       end

data/lib/active_admin/xls/resource_controller_extension.rb

@@ -1,25 +1,19 @@
 module ActiveAdmin
   module Xls
+    # Extends the resource controller to respond to xls requests
     module ResourceControllerExtension
-      def self.included(base)
-        base.send :alias_method_chain, :per_page, :xls
-        base.send :alias_method_chain, :index, :xls
-        base.send :alias_method_chain, :rescue_active_admin_access_denied, :xls
-        base.send :respond_to, :xls
+      def self.prepended(base)
+        base.send :respond_to, :xls, only: :index
       end
 
-      def index_with_xls
-        index_without_xls do |format|
+      # Patches index to respond to requests with xls mime type by
+      # sending a generated xls document serializing the current
+      # collection
+      def index
+        super do |format|
           format.xls do
-            xls_collection = if method(:find_collection).arity.zero?
-                               collection
-                             else
-                               find_collection except: :pagination
-                             end
-            xls = active_admin_config.xls_builder.serialize(
-              xls_collection,
-              view_context
-            )
+            xls = active_admin_config.xls_builder.serialize(xls_collection,
+                                                            view_context)
             send_data(xls,
                       filename: xls_filename,
                       type: Mime::Type.lookup_by_extension(:xls))
@@ -29,7 +23,12 @@ module ActiveAdmin
         end
       end
 
-      def rescue_active_admin_access_denied_with_xls(exception)
+      # Patches rescue_active_admin_access_denied to respond to xls
+      # mime type. Provides administrators information on how to
+      # configure activeadmin to respond propertly to xls requests
+      #
+      # param exception [Exception] unauthorized access error
+      def rescue_active_admin_access_denied(exception)
         if request.format == Mime::Type.lookup_by_extension(:xls)
           respond_to do |format|
             format.xls do
@@ -38,27 +37,25 @@ module ActiveAdmin
             end
           end
         else
-          rescue_active_admin_access_denied_without_xls(exception)
+          super(exception)
         end
       end
 
-      # patch per_page to use the CSV record max for pagination
-      # when the format is xls
-      def per_page_with_xls
-        if request.format == Mime::Type.lookup_by_extension(:xls)
-          return max_per_page if respond_to?(:max_per_page, true)
-          active_admin_config.max_per_page
-        end
-
-        per_page_without_xls
-      end
-
       # Returns a filename for the xls file using the collection_name
       # and current date such as 'my-articles-2011-06-24.xls'.
+      #
+      # @return [String] with default filename
       def xls_filename
         timestamp = Time.now.strftime('%Y-%m-%d')
         "#{resource_collection_name.to_s.tr('_', '-')}-#{timestamp}.xls"
       end
+
+      # Returns the collection to use when generating an xls file.
+      # It uses the find_collection function if it is available, and uses
+      # collection if find_collection isn't available.
+      def xls_collection
+        find_collection except: :pagination
+      end
     end
   end
 end

data/lib/active_admin/xls/resource_extension.rb

@@ -1,10 +1,25 @@
 module ActiveAdmin
+  # Provides xls functionality to ActiveAdmin resources
   module Xls
+    # Extends ActiveAdmin Resource
     module ResourceExtension
+      # Sets the XLS Builder
+      #
+      # @param builder [Builder] the new builder object
+      # @return [Builder] the builder for this resource
       def xls_builder=(builder)
         @xls_builder = builder
       end
 
+      # Returns the XLS Builder. Creates a new Builder if none exists.
+      #
+      # @return [Builder] the builder for this resource
+      #
+      # @example Localize column headers
+      #   # app/admin/posts.rb
+      #   ActiveAdmin.register Post do
+      #     config.xls_builder.i18n_scope = [:active_record, :models, :posts]
+      #   end
       def xls_builder
         @xls_builder ||= ActiveAdmin::Xls::Builder.new(resource_class)
       end

data/lib/active_admin/xls/version.rb

@@ -1,5 +1,6 @@
 module ActiveAdmin
   module Xls
-    VERSION = '1.1.0'.freeze
+    # ActiveAdmin XLS gem version
+    VERSION = '2.0.0'.freeze
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,14 @@ SimpleCov.start do
   add_filter '/spec/'
 end
 
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Codecov
+  ]
+end
+
 ENV['RAILS_ENV'] = 'test'
 
 # prepare ENV for rails

data/spec/support/rails_template.rb

@@ -16,24 +16,51 @@ gsub_file(
   "\ncucumber_with_reloading:\n  <<: *test\n  database: db/cucumber.sqlite3"
 )
 
+if File.exist?('config/secrets.yml')
+  require 'securerandom'
+  cucumber_secret = SecureRandom.hex(64)
+  gsub_file 'config/secrets.yml',
+            /\z/,
+            "\ncucumber:\n  secret_key_base: #{cucumber_secret}"
+end
+
+base_record = if Rails::VERSION::MAJOR >= 5
+                'ApplicationRecord'
+              else
+                'ActiveRecord::Base'
+              end
+
 # Generate some test models
 generate :model, 'post title:string body:text published_at:datetime author_id:integer category_id:integer'
-inject_into_file 'app/models/post.rb', "  belongs_to :author, class_name: 'User'\n  belongs_to :category\n  accepts_nested_attributes_for :author\n", after: "class Post < ActiveRecord::Base\n"
-# Rails 3.2.3 model generator declare attr_accessible
-if Rails::VERSION::MAJOR == 3
-  inject_into_file 'app/models/post.rb',
-                   "  attr_accessible :author\n",
-                   before: 'end'
-end
+post_model_setup = if Rails::VERSION::MAJOR >= 5
+                     <<-MODEL
+  belongs_to :author, class_name: 'User'
+  belongs_to :category, optional: true
+  accepts_nested_attributes_for :author
+MODEL
+                   else
+                     <<-MODEL
+  belongs_to :author, class_name: 'User'
+  belongs_to :category
+  accepts_nested_attributes_for :author
+MODEL
+                   end
+inject_into_file 'app/models/post.rb',
+                 post_model_setup,
+                 after: "class Post < #{base_record}\n"
+
 generate :model, 'user type:string first_name:string last_name:string username:string age:integer'
 inject_into_file 'app/models/user.rb',
                  "  has_many :posts, foreign_key: 'author_id'\n",
-                 after: "class User < ActiveRecord::Base\n"
+                 after: "class User < #{base_record}\n"
+
 generate :model, 'publisher --migration=false --parent=User'
+
 generate :model, 'category name:string description:text'
 inject_into_file 'app/models/category.rb',
                  "  has_many :posts\n  accepts_nested_attributes_for :posts\n",
-                 after: "class Category < ActiveRecord::Base\n"
+                 after: "class Category < #{base_record}\n"
+
 generate :model, 'store name:string'
 
 # Generate a model with string ids
@@ -57,13 +84,7 @@ MODEL
 
 inject_into_file 'app/models/tag.rb',
                  id_model_setup,
-                 after: "class Tag < ActiveRecord::Base\n"
-
-if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 1 # Rails 3.1 Gotcha
-  gsub_file 'app/models/tag.rb',
-            /self\.primary_key.*$/,
-            'define_attr_method :primary_key, :id'
-end
+                 after: "class Tag < #{base_record}\n"
 
 # Configure default_url_options in test environment
 inject_into_file(
@@ -86,27 +107,17 @@ append_file 'config/locales/en.yml',
 directory File.expand_path('../templates/admin', __FILE__), 'app/admin'
 
 run 'rm Gemfile'
-run 'rm -r test'
-run 'rm -r spec'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-if Rails::VERSION::MAJOR == 3
-  # we need this routing path, named "logout_path", for testing
-  route <<-ROUTE
-  devise_scope :user do
-    match '/admin/logout' => 'active_admin/devise/sessions#destroy', as: :logout
-  end
-  ROUTE
-end
-
 generate :'active_admin:install'
 
-if Rails::VERSION::MAJOR > 3
-  inject_into_file 'config/initializers/active_admin.rb',
-                   "  config.download_links = %i[csv xml json xls]\n",
-                   after: "  # == Download Links\n"
-end
+run 'rm -r test'
+run 'rm -r spec'
+
+inject_into_file 'config/initializers/active_admin.rb',
+                 "  config.download_links = %i[csv xml json xls]\n",
+                 after: "  # == Download Links\n"
 
 # Setup a root path for devise
 route "root to: 'admin/dashboard#index'"

data/spec/xls/unit/resource_controller_spec.rb

@@ -1,22 +1,7 @@
 require 'spec_helper'
-describe ActiveAdmin::ResourceController do
+describe Admin::CategoriesController, type: :controller do
   let(:mime) { Mime::Type.lookup_by_extension(:xls) }
 
-  let(:request) do
-    ActionController::TestRequest.new.tap do |test_request|
-      test_request.accept = mime
-    end
-  end
-
-  let(:response) { ActionController::TestResponse.new }
-
-  let(:controller) do
-    Admin::CategoriesController.new.tap do |controller|
-      controller.request = request
-      controller.response = response
-    end
-  end
-
   let(:filename) do
     "#{controller.resource_class.to_s.downcase.pluralize}-#{Time.now.strftime('%Y-%m-%d')}.xls"
   end
@@ -27,26 +12,11 @@ describe ActiveAdmin::ResourceController do
 
   context 'when making requests with the xls mime type' do
     it 'returns xls attachment when requested' do
-      controller.send :index
+      request.accept = mime
+      get :index
       disposition = "attachment; filename=\"#{filename}\""
       expect(response.headers['Content-Disposition']).to eq(disposition)
       expect(response.headers['Content-Transfer-Encoding']).to eq('binary')
     end
-
-    it 'returns max_csv_records for per_page' do
-      # this might need to go away!
-      max_csv_records = if controller.respond_to?(:max_csv_records, true)
-                          controller.send(:max_csv_records)
-                        else
-                          controller.send(:per_page)
-                        end
-      expect(controller.send(:per_page)).to eq(max_csv_records)
-    end
-
-    it 'uses the default per_page when we do not specify xls mime type' do
-      controller.request.accept = 'text/html'
-      aa_default_per_page = ActiveAdmin.application.default_per_page
-      expect(controller.send(:per_page)).to eq(aa_default_per_page)
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin-xls
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Todd Hambley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -55,15 +55,16 @@ files:
 - ".gemignore"
 - ".gitignore"
 - ".rspec"
-- ".yardops"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - activeadmin-xls.gemspec
-- gemfiles/rails_32.gemfile
 - gemfiles/rails_42.gemfile
+- gemfiles/rails_51.gemfile
 - lib/active_admin/xls/builder.rb
 - lib/active_admin/xls/dsl.rb
 - lib/active_admin/xls/engine.rb
@@ -71,6 +72,7 @@ files:
 - lib/active_admin/xls/resource_extension.rb
 - lib/active_admin/xls/version.rb
 - lib/activeadmin-xls.rb
+- spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/support/rails_template.rb
 - spec/support/rails_template_with_data.rb
@@ -95,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.yardops

@@ -1 +0,0 @@
---no-private --protected app/**/*.rb - README.md LEGAL

data/gemfiles/rails_32.gemfile

@@ -1,30 +0,0 @@
-#!/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 'rails', '3.2.22.5'
-
-gem 'activeadmin', '0.6.6'
-
-group :assets do
-  gem 'coffee-rails', '~> 3.2.1'
-  gem 'sass-rails',   '~> 3.2.3'
-
-  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  # gem 'therubyracer', :platforms => :ruby
-
-  gem 'uglifier', '>= 1.0.3'
-end
-
-group :test do
-  gem 'shoulda-matchers', '~> 2.8.0'
-  if ruby_major_version > 2 || (ruby_major_version == 2 && ruby_minor_version > 1)
-    gem 'test-unit', '~> 3.0'
-  end
-end
-
-gemspec path: "../"