activeadmin-xls 1.0.5 → 2.0.3

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,
@@ -9,11 +9,59 @@ module ActiveAdmin
                :header_format,
                :header_style,
                :i18n_scope,
+               :only_columns,
                :skip_header,
                :whitelist,
                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'
 
@@ -13,7 +13,10 @@ module ActiveAdmin
 
         ActiveAdmin::ResourceDSL.send :include, ActiveAdmin::Xls::DSL
         ActiveAdmin::Resource.send :include, ActiveAdmin::Xls::ResourceExtension
-        ActiveAdmin::ResourceController.send :include, ActiveAdmin::Xls::ResourceControllerExtension
+        ActiveAdmin::ResourceController.send(
+          :prepend,
+          ActiveAdmin::Xls::ResourceControllerExtension
+        )
       end
     end
   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,23 @@ 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.
+      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.0.5'.freeze
+    # ActiveAdmin XLS gem version
+    VERSION = '2.0.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin-xls
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.3
 platform: ruby
 authors:
 - Todd Hambley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: spreadsheet
   requirement: !ruby/object:Gem::Requirement
@@ -44,8 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: |2
-    This gem provides excel/xls downloads for resources in Active Admin.
+description: "  This gem provides excel/xls downloads for resources in Active Admin.\n"
 email: thambley@travelleaders.com
 executables: []
 extensions: []
@@ -55,15 +48,17 @@ 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_52.gemfile
+- gemfiles/rails_60.gemfile
 - lib/active_admin/xls/builder.rb
 - lib/active_admin/xls/dsl.rb
 - lib/active_admin/xls/engine.rb
@@ -71,18 +66,6 @@ files:
 - lib/active_admin/xls/resource_extension.rb
 - lib/active_admin/xls/version.rb
 - lib/activeadmin-xls.rb
-- spec/spec_helper.rb
-- spec/support/rails_template.rb
-- spec/support/rails_template_with_data.rb
-- spec/support/templates/admin/stores.rb
-- spec/support/templates/cucumber.rb
-- spec/support/templates/cucumber_with_reloading.rb
-- spec/support/templates/en.yml
-- spec/xls/unit/build_download_format_links_spec.rb
-- spec/xls/unit/builder_spec.rb
-- spec/xls/unit/dsl_spec.rb
-- spec/xls/unit/resource_controller_spec.rb
-- spec/xls/unit/resource_spec.rb
 homepage: https://github.com/thambley/activeadmin-xls
 licenses:
 - MIT
@@ -95,7 +78,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:
   - - ">="
@@ -103,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Adds excel (xls) downloads for resources within the Active Admin framework.

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: "../"

data/spec/spec_helper.rb

@@ -1,38 +0,0 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter '/rails/'
-  add_filter '/spec/'
-end
-
-ENV['RAILS_ENV'] = 'test'
-
-# prepare ENV for rails
-require 'rails'
-ENV['RAILS_ROOT'] = File.expand_path(
-  "../rails/rails-#{Rails::VERSION::STRING}",
-  __FILE__
-)
-
-# ensure testing application is in place
-unless File.exist?(ENV['RAILS_ROOT'])
-  puts 'Please run bundle exec rake setup before running the specs.'
-  exit
-end
-
-# load up activeadmin and activeadmin-xls
-require 'active_record'
-require 'active_admin'
-require 'devise'
-require 'activeadmin-xls'
-ActiveAdmin.application.load_paths = [ENV['RAILS_ROOT'] + '/app/admin']
-
-# start up rails
-require ENV['RAILS_ROOT'] + '/config/environment'
-
-# and finally,here's rspec
-require 'rspec/rails'
-
-# Disabling authentication in specs so that we don't have to worry about
-# it allover the place
-ActiveAdmin.application.authentication_method = false
-ActiveAdmin.application.current_user_method = false

data/spec/support/rails_template.rb

@@ -1,102 +0,0 @@
-# Rails template to build the sample app for specs
-
-# Create a cucumber database and environment
-copy_file File.expand_path('../templates/cucumber.rb', __FILE__),
-          'config/environments/cucumber.rb'
-copy_file File.expand_path('../templates/cucumber_with_reloading.rb', __FILE__),
-          'config/environments/cucumber_with_reloading.rb'
-
-gsub_file 'config/database.yml', /^test:.*\n/, "test: &test\n"
-gsub_file 'config/database.yml',
-          /\z/,
-          "\ncucumber:\n  <<: *test\n  database: db/cucumber.sqlite3"
-gsub_file 'config/database.yml',
-          /\z/,
-          "\ncucumber_with_reloading:\n  <<: *test\n  database: db/cucumber.sqlite3"
-
-# 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
-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"
-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"
-generate :model, 'store name:string'
-
-# Generate a model with string ids
-generate :model, 'tag name:string'
-gsub_file(Dir['db/migrate/*_create_tags.rb'][0], /\:tags\sdo\s.*/, ":tags, id: false, primary_key: :id do |t|\n\t\t\tt.string :id\n" )
-id_model_setup = <<-MODEL
-  self.primary_key = :id
-  before_create :set_id
-
-  private
-  def set_id
-    self.id = 8.times.inject('') { |s,e| s << (i = Kernel.rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr }
-  end
-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
-
-# Configure default_url_options in test environment
-inject_into_file 'config/environments/test.rb',
-                 "  config.action_mailer.default_url_options = { host: 'example.com' }\n",
-                 after: "config.cache_classes = true\n"
-
-puts File.expand_path('../../../lib/activeadmin-xls', __FILE__)
-# Add our local Active Admin to the load path
-inject_into_file 'config/environment.rb',
-                 "\nrequire \"#{File.expand_path('../../../lib/activeadmin-xls', __FILE__)}\"\n",
-                 after: "require File.expand_path('../application', __FILE__)"
-
-# Add some translations
-append_file 'config/locales/en.yml',
-            File.read(File.expand_path('../templates/en.yml', __FILE__))
-
-# Add predefined admin resources
-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
-
-# Setup a root path for devise
-route "root to: 'admin/dashboard#index'"
-
-rake 'db:migrate'
-rake 'db:test:prepare'
-run '/usr/bin/env RAILS_ENV=cucumber rake db:migrate'