activeadmin-xls 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5542c9ca3fb9ec53761a8f17c84d33590ac41fd4
+  data.tar.gz: 262f8f4e6e8068e1f8e2fb41744c1695454a965c
+SHA512:
+  metadata.gz: 0d13b40efc0caab8e86510fbec44a8d2c9f9eb196440a311a8a2d8113218782f2311d0afe23700ab1ca394a19f647c87c944f25da3e67e4123011b9fbec4b5a2
+  data.tar.gz: 6b80baec72b523eda62d72975e3158026c76f37a3e0d1ad149264ce4331fa6a583752fa5d63679354c14812b1669b471d0066f2925ad1778e5d212b7295b90f8

data/.bundle/config

@@ -0,0 +1 @@
+--- {}

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = crlf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false

data/.gitignore

@@ -0,0 +1,10 @@
+spec/rails
+*.gem
+coverage
+*.xlsx
+doc
+*.un~
+.yardoc
+.rbenv-version
+.ruby-version
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.yardops

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

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## 1.0.2
+
+### Bug Fixes
+
+* Fixes undefined local variable or `method max_per_page` [#3][] by [@rewritten][]
+
+## 1.0.3
+
+### Updates
+
+* Move require rake from gemspec to lib/activeadmin-xls.rb [#4][] by [@ejaypcanaria][]
+
+<!--- Link List --->
+[#3]: https://github.com/thambley/activeadmin-xls/issues/3
+[#4]: https://github.com/thambley/activeadmin-xls/pull/4
+
+[@rewritten]: https://github.com/rewritten
+[@ejaypcanaria]: https://github.com/ejaypcanaria

data/Gemfile

@@ -0,0 +1,30 @@
+source 'https://rubygems.org'
+
+gem 'activeadmin', '~> 1.0'
+gem 'spreadsheet', '~> 1.1', '>= 1.1.4'
+
+group :development, :test do
+  gem 'haml', require: false
+  gem 'rails-i18n' # Gives us default i18n for many languages
+  gem 'rdiscount' # For yard
+  gem 'sprockets'
+  gem 'sqlite3'
+  gem 'yard'
+end
+
+group :test do
+  gem 'capybara'
+  gem 'cucumber-rails', require: false
+  gem 'database_cleaner'
+  gem 'guard-coffeescript'
+  gem 'guard-rspec'
+  gem 'inherited_resources'
+  gem 'jasmine'
+  gem 'jslint_on_rails', '~> 1.0.6'
+  gem 'launchy'
+  gem 'rspec-mocks'
+  gem 'rspec-rails'
+  gem 'sass-rails'
+  gem 'shoulda-matchers', '1.0.0'
+  gem 'simplecov', require: false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Todd Hambley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,131 @@
+# Active Admin Xls: Excel Spreadsheet Export for Active Admin
+
+**Git**: [http://github.com/thambley/activeadmin-xls](http://github.com/thambley/activeadmin-xls)
+
+**Author**:  Todd Hambley
+
+**Copyright**:    2014 ~ 2017
+
+**License**: MIT License
+
+**Latest Version**: 1.0.4
+
+**Release Date**: 2017.11.22
+
+## 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).
+
+Usage example:
+
+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.
+
+```ruby
+gem 'activeadmin-xls'
+```
+
+## Cool Toys
+
+Here are a few quick examples of things you can easily tweak.
+
+### Localize column headers
+
+```ruby
+# app/admin/posts.rb
+ActiveAdmin.register Post do
+  config.xls_builder.i18n_scope = [:active_record, :models, :posts]
+end
+```
+
+### Use blocks for adding computed fields
+
+```ruby
+# app/admin/posts.rb
+ActiveAdmin.register Post do
+  config.xls_builder.column('author_name') do |resource|
+    resource.author.name
+  end
+end
+```
+
+### Change the column header format
+
+```ruby
+# app/admin/posts.rb
+ActiveAdmin.register Post do
+  config.xls_builder.header_format = { weight: :bold,
+                                       color: :blue }
+end
+```
+
+### Remove columns
+
+```ruby
+# app/admin/posts.rb
+ActiveAdmin.register Post do
+  config.xls_builder.delete_columns :id, :created_at, :updated_at
+end
+```
+
+## Using the DSL
+
+Everything that you do with the config's default builder can be done via
+the resource DSL.
+
+Below is an example of the DSL
+
+```ruby
+ActiveAdmin.register Post do
+
+  # i18n_scope and header style are set via options
+  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
+
+    # deleting columns from the report
+    delete_columns :id, :created_at, :updated_at
+
+    # adding a column to the report
+    column(:author) { |post| "#{post.author.first_name} #{post.author.last_name}" }
+
+    # inserting additional data with after_filter
+    after_filter do |sheet|
+      # todo
+    end
+
+    # inserting data with before_filter
+    before_filter do |sheet|
+      # todo
+    end
+  end
+end
+```
+
+## Specs
+
+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:
+
+```text
+bundle exec rake setup
+```
+
+```text
+bundle exec rake
+```
+
+## Copyright and License
+
+activeadmin-xls © 2014 by [Todd Hambley](mailto:thambley@travelleaders.com).
+
+activeadmin-xls is licensed under the MIT license. Please see the LICENSE document for more information.

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+require "activeadmin"
+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.exists?("spec/rails")
+  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template_with_data.rb"
+end
+
+RSpec::Core::RakeTask.new
+task :default => :spec
+task :test => :spec
+
+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"
+end

data/activeadmin-xls.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/active_admin/xls/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'activeadmin-xls'
+  s.version = ActiveAdmin::Xls::VERSION
+  s.author = 'Todd Hambley'
+  s.email = 'thambley@travelleaders.com'
+  s.homepage = 'https://github.com/thambley/activeadmin-xls'
+  s.platform = Gem::Platform::RUBY
+  s.date = Time.now.strftime('%Y-%m-%d')
+  s.license = 'MIT'
+  s.summary = <<-SUMMARY
+  Adds excel (xls) downloads for resources within the Active Admin framework.
+  SUMMARY
+  s.description = <<-DESC
+  This gem provides excel/xls downloads for resources in Active Admin.
+  DESC
+  s.files = `git ls-files`.split("\n").sort
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+  s.test_files = Dir.glob('{spec/**/*}')
+
+  s.add_runtime_dependency 'activeadmin', '>= 0.6.6', '< 2'
+  s.add_runtime_dependency 'spreadsheet', '~> 1.0'
+
+  s.required_ruby_version = '>= 1.9.2'
+  s.require_path = 'lib'
+end

data/lib/active_admin/xls/builder.rb

@@ -0,0 +1,259 @@
+require 'stringio'
+require 'spreadsheet'
+
+module ActiveAdmin
+  module Xls
+    # Builder for xls data.
+    class Builder
+      include MethodOrProcHelper
+
+      # @param 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
+      #   up localized column headers.
+      # @param [Block] Any 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
+      #     delete_columns :id, :created_at, :updated_at
+      #     column(:author_name) { |post| post.author.name }
+      #     after_filter { |sheet|
+      #
+      #     }
+      #   end
+      #   @see ActiveAdmin::Axlsx::DSL
+      def initialize(resource_class, options = {}, &block)
+        @skip_header = false
+        @columns = resource_columns(resource_class)
+        parse_options options
+        instance_eval(&block) if block_given?
+      end
+
+      # The default header style
+      # @return [Hash]
+      def header_format
+        @header_format ||= {}
+      end
+
+      alias header_style header_format
+
+      # 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
+      # @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
+
+      alias header_style= header_format=
+
+      # Indicates that we do not want to serialize the column headers
+      def skip_header
+        @skip_header = true
+      end
+
+      # The scope to use when looking up column names to generate the
+      # report header
+      def i18n_scope
+        @i18n_scope ||= nil
+      end
+
+      # This is the I18n scope that will be used when looking up your
+      # colum 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
+
+      # The stored block that will be executed after your report is generated.
+      def after_filter(&block)
+        @after_filter = block
+      end
+
+      # the stored block that will be executed before your report is generated.
+      def before_filter(&block)
+        @before_filter = block
+      end
+
+      # The columns this builder will be serializing
+      attr_reader :columns
+
+      # 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
+      # only render specific columns. To remove specific columns use
+      # ignore_column.
+      def clear_columns
+        @columns = []
+      end
+
+      # Clears the default columns array so you can whitelist only the columns
+      # you want to export
+      def whitelist
+        @columns = []
+      end
+
+      # Add a column
+      # @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.
+      def column(name, &block)
+        @columns << Column.new(name, block)
+      end
+
+      # removes columns by name
+      # each column_name should be a symbol
+      def delete_columns(*column_names)
+        @columns.delete_if { |column| column_names.include?(column.name) }
+      end
+
+      # Serializes the collection provided
+      # @return [Spreadsheet::Workbook]
+      def serialize(collection, view_context)
+        @collection = collection
+        @view_context = view_context
+        apply_filter @before_filter
+        export_collection(collection)
+        apply_filter @after_filter
+        to_stream
+      end
+
+      # Xls column
+      class Column
+        def initialize(name, block = nil)
+          @name = name
+          @data = block || @name
+        end
+
+        attr_reader :name, :data
+
+        def localized_name(i18n_scope = nil)
+          return name.to_s.titleize unless i18n_scope
+          I18n.t name, scope: i18n_scope
+        end
+      end
+
+      private
+
+      def to_stream
+        stream = StringIO.new('')
+        book.write stream
+        clean_up
+        stream.string
+      end
+
+      def clean_up
+        @book = @sheet = nil
+      end
+
+      def export_collection(collection)
+        return if columns.none?
+        row_index = 0
+
+        unless @skip_header
+          header_row(collection)
+          row_index = 1
+        end
+
+        collection.each do |resource|
+          fill_row(sheet.row(row_index), resource_data(resource))
+          row_index += 1
+        end
+      end
+
+      # tranform column names into array of localized strings
+      # @return [Array]
+      def header_row(collection)
+        row = sheet.row(0)
+        apply_format_to_row(row, create_format(header_format))
+        fill_row(row, header_data_for(collection))
+      end
+
+      def header_data_for(collection)
+        resource = collection.first
+        columns.map do |column|
+          column.localized_name(i18n_scope) if in_scope(resource, column)
+        end.compact
+      end
+
+      def apply_filter(filter)
+        filter.call(sheet) if filter
+      end
+
+      def parse_options(options)
+        options.each do |key, value|
+          send("#{key}=", value) if respond_to?("#{key}=") && !value.nil?
+        end
+      end
+
+      def resource_data(resource)
+        columns.map do |column|
+          call_method_or_proc_on resource, column.data if in_scope(resource,
+                                                                   column)
+        end
+      end
+
+      def in_scope(resource, column)
+        return true unless column.name.is_a?(Symbol)
+        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)
+        end
+      end
+
+      def create_format(format_hash)
+        Spreadsheet::Format.new format_hash
+      end
+
+      def apply_format_to_row(row, format)
+        row.default_format = format if format
+      end
+
+      def fill_row(row, column)
+        case column
+        when Hash
+          column.each_value { |values| fill_row(row, values) }
+        when Array
+          column.each { |value| fill_row(row, value) }
+        else
+          # raise ArgumentError,
+          #       "column #{column} has an invalid class (#{ column.class })"
+          row.push(column)
+        end
+      end
+
+      def method_missing(method_name, *arguments)
+        if @view_context.respond_to? method_name
+          @view_context.send method_name, *arguments
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @view_context.respond_to?(method_name) || super
+      end
+    end
+  end
+end

data/lib/active_admin/xls/dsl.rb

@@ -0,0 +1,26 @@
+module ActiveAdmin
+  module Xls
+    # extends activeadmin dsl to include xls
+    module DSL
+      delegate(:after_filter,
+               :before_filter,
+               :column,
+               :delete_columns,
+               :header_format,
+               :header_style,
+               :i18n_scope,
+               :skip_header,
+               :whitelist,
+               to: :xls_builder,
+               prefix: :config)
+
+      def xls(options = {}, &block)
+        config.xls_builder = ActiveAdmin::Xls::Builder.new(
+          config.resource_class,
+          options,
+          &block
+        )
+      end
+    end
+  end
+end

data/lib/active_admin/xls/engine.rb

@@ -0,0 +1,20 @@
+module ActiveAdmin
+  module Xls
+    # extends activeadmin with xls downloads
+    class Engine < ::Rails::Engine
+      engine_name 'active_admin_xls'
+
+      initializer 'active_admin.xls', group: :all do
+        if Mime::Type.lookup_by_extension(:xls).nil?
+          Mime::Type.register 'application/vnd.ms-excel', :xls
+        end
+
+        ActiveAdmin::Views::PaginatedCollection.add_format :xls
+
+        ActiveAdmin::ResourceDSL.send :include, ActiveAdmin::Xls::DSL
+        ActiveAdmin::Resource.send :include, ActiveAdmin::Xls::ResourceExtension
+        ActiveAdmin::ResourceController.send :include, ActiveAdmin::Xls::ResourceControllerExtension
+      end
+    end
+  end
+end

data/lib/active_admin/xls/resource_controller_extension.rb

@@ -0,0 +1,57 @@
+module ActiveAdmin
+  module Xls
+    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
+      end
+
+      def index_with_xls
+        index_without_xls do |format|
+          yield format if block_given?
+
+          format.xls do
+            xls = active_admin_config.xls_builder.serialize(collection,
+                                                            view_context)
+            send_data(xls,
+                      filename: xls_filename,
+                      type: Mime::Type.lookup_by_extension(:xls))
+          end
+        end
+      end
+
+      def rescue_active_admin_access_denied_with_xls(exception)
+        if request.format == Mime::Type.lookup_by_extension(:xls)
+          respond_to do |format|
+            format.xls do
+              flash[:error] = "#{exception.message} Review download_links in initializers/active_admin.rb"
+              redirect_backwards_or_to_root
+            end
+          end
+        else
+          rescue_active_admin_access_denied_without_xls(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'.
+      def xls_filename
+        timestamp = Time.now.strftime('%Y-%m-%d')
+        "#{resource_collection_name.to_s.tr('_', '-')}-#{timestamp}.xls"
+      end
+    end
+  end
+end

data/lib/active_admin/xls/resource_extension.rb

@@ -0,0 +1,13 @@
+module ActiveAdmin
+  module Xls
+    module ResourceExtension
+      def xls_builder=(builder)
+        @xls_builder = builder
+      end
+
+      def xls_builder
+        @xls_builder ||= ActiveAdmin::Xls::Builder.new(resource_class)
+      end
+    end
+  end
+end

data/lib/active_admin/xls/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module Xls
+    VERSION = '1.0.4'.freeze
+  end
+end

data/lib/activeadmin-xls.rb

@@ -0,0 +1,9 @@
+require 'rake'
+require 'active_admin'
+
+require 'active_admin/xls/version'
+require 'active_admin/xls/builder'
+require 'active_admin/xls/dsl'
+require 'active_admin/xls/resource_extension'
+require 'active_admin/xls/resource_controller_extension'
+require 'active_admin/xls/engine'