activeadmin-axlsx 1.0.0a

data/activeadmin-axlsx.gemspec

@@ -0,0 +1,23 @@
+require 'rake'
+require File.expand_path('../lib/active_admin/axlsx/version', __FILE__)
+Gem::Specification.new do |s|
+  s.name        = 'activeadmin-axlsx'
+  s.version     = ActiveAdmin::Axlsx::VERSION
+  s.author	    = "Randy Morgan"
+  s.email       = 'digital.ipseity@gmail.com'
+  s.homepage   	= 'https://github.com/randym/activeadmin-axlsx'
+  s.platform    = Gem::Platform::RUBY
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = "Adds excel downloads for resources within the Active Admin framework via Axlsx."
+  s.description = <<-eof
+  This gem uses axlsx to provide excel/xlsx downloads for resources in Active Admin. Often, users are happier with excel, so why not give it to them instead of CSV?
+  eof
+  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.5.0'
+  s.add_runtime_dependency 'axlsx'
+
+  s.required_ruby_version = '>= 1.9.2'
+  s.require_path = 'lib'
+end

data/lib/active_admin/axlsx.rb

@@ -0,0 +1,34 @@
+require 'active_admin'
+require 'active_admin/axlsx/autoload_extension'
+require 'active_admin/axlsx/build_download_format_links'
+require 'active_admin/axlsx/version'
+require 'active_admin/axlsx/builder'
+require 'active_admin/axlsx/dsl'
+require 'active_admin/axlsx/resource_extension'
+require 'active_admin/axlsx/resource_controller_extension'
+class Railtie < ::Rails::Railtie
+  config.after_initialize do
+    begin
+      if Mime::Type.lookup_by_extension(:xlsx).nil?
+        # The mime type to be used in respond_to |format| style web-services in rails
+        Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+      end
+    rescue NameError
+      puts "Mime module not defined. Skipping registration of xlsx"
+    end
+    ActiveAdmin.send :include, ActiveAdmin::Axlsx::AutoloadExtension
+    ActiveAdmin::ResourceDSL.send :include, ActiveAdmin::Axlsx::DSL
+    ActiveAdmin::Resource.send :include, ActiveAdmin::Axlsx::ResourceExtension
+    ActiveAdmin::ResourceController.send :include, ActiveAdmin::Axlsx::ResourceControllerExtension
+    # TODO remove < 0.5.1 block once active admin has released.
+    # Pull request to fix build download format links has already been merged into active admin.
+    if ActiveAdmin::VERSION < '0.5.1'
+      ActiveAdmin::Views::PaginatedCollection.send :include, ActiveAdmin::Axlsx::BuildDownloadFormatLinks
+      ActiveAdmin::Views::Pages::Index.send :include, ActiveAdmin::Axlsx::BuildDownloadFormatLinks
+    else
+      ActiveAdmin::Views::PaginatedCollection.add_format :xlsx
+    end
+  end
+end
+
+

data/lib/active_admin/axlsx/autoload_extension.rb

@@ -0,0 +1,7 @@
+module ActiveAdmin
+  module Axlsx
+    module AutoloadExtension
+      autoload :XlsxBuilder,              'active_admin/xlsx_builder'
+    end
+  end
+end

data/lib/active_admin/axlsx/build_download_format_links.rb

@@ -0,0 +1,13 @@
+module ActiveAdmin
+  module Axlsx
+    module BuildDownloadFormatLinks
+      def self.included(base)
+        base.send :alias_method_chain, :build_download_format_links, :xlsx
+      end
+
+      def build_download_format_links_with_xlsx(formats = [:csv, :xml, :json, :xlsx])
+        build_download_format_links_without_xlsx(formats)
+      end
+    end
+  end
+end

data/lib/active_admin/axlsx/builder.rb

@@ -0,0 +1,116 @@
+require 'axlsx'
+
+module ActiveAdmin
+  module Axlsx
+    # XlsxBuilder extends CSVBuilder adding in xlsx specific options
+    #
+    # Usage example
+    #
+    #   xlsx_builder = XlsxBuilder.new
+    #   xlsx_builder.column :id
+    #   xlsx_builder.column('Name') { |resource| resource.full_name }
+    #
+    #   xlsx_builder = XlsxBuilder.new :shared_strings => true
+    #   xlsx_builder.column :id
+    #
+    #   xlsx_builder = XlsxBuiler.new :header_style => { :bg_color => '00', :fg_color => 'FF', :sz => 14, :alignment => { :horizontal => :center } }
+    #   xlsx_buider.i18n_scope [:active_record, :models, :posts]
+    class Builder < ActiveAdmin::CSVBuilder
+
+      include MethodOrProcHelper
+
+      @@default_header_style =  { :bg_color => '00', :fg_color => 'FF', :sz => 12, :alignment => { :horizontal => :center } }
+
+      # Return a default XlsxBuilder for a resource
+      # The XlsxBuilder columns will be id, follwed by this resource's content columns
+      # The default header_style is applied.
+      def self.default_for_resource(resource)
+        xlsx_builder = super
+        xlsx_builder.header_style = @@default_header_style
+        xlsx_builder
+      end
+
+      attr_reader :columns
+
+      # when this is set to true the xlsx file will be generated with
+      # shared strings and will inter-operate with Numbers for Mac
+      # This is true by default, but you can set it to false to minimize the generation time.
+      attr_accessor :shared_strings
+
+      # This has can be used to override the default header style for your
+      # sheet.
+      # @see https://github.com/randym/axlsx for more details on how to
+      # create and apply style.
+      # @return [Hash]
+      attr_accessor :header_style
+
+      # 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_accessor :i18n_scope
+
+      # @param [Hash] options the options for this builder
+      # @option [Hash] :header_style - a hash of style properties to apply
+      #   to the header row
+      # @option [Array] :i18n_scope - the I18n scope to use when looking
+      #   up localized column headers.
+      # @option [Boolean] :shared_strings - Tells the serializer to use
+      # shared strings or not when parsing out the package. 
+      # @note shared strings are an optional part of the ECMA-376 spec,and
+      # are only required when you need to support Numbers.
+      def initialize(options={}, &block)
+        super
+        @header_style = options.delete(:header_style) || @@default_header_style
+        @i18n_scope = options.delete(:i18n_scope)
+        @shared_strings = options.delete(:shared_strings) || true
+        instance_eval &block if block_given?
+      end
+
+      # the Axlsx::Package
+      def package
+        @package ||= ::Axlsx::Package.new(:use_shared_strings => shared_strings)
+      end
+
+      # Serializes the collection provided
+      # @return [Axlsx::Package]
+      def serialize(collection)
+        header_style_id = package.workbook.styles.add_style header_style
+        package.workbook.add_worksheet do |sheet|
+          sheet.add_row header_row, :style => header_style_id
+          collection.each do |resource| 
+            sheet.add_row columns.map { |column| call_method_or_proc_on resource, column.data }
+          end
+        end
+        package
+      end
+
+      # tranform column names into array of localized strings
+      # @return [Array]
+      def header_row
+        columns.map { |column| column.localized_name(i18n_scope) }
+      end
+
+      # Add a column
+      def column(name, &block)
+        @columns << Column.new(name, block)
+      end
+
+      class Column
+        attr_reader :name, :data
+
+        def initialize(name, block = nil)
+          @name = name.to_sym
+          @data = block || @name
+        end
+
+        def localized_name(i18n_scope = nil)
+          return name.to_s.titleize unless i18n_scope
+          I18n.t name, i18n_scope
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/axlsx/dsl.rb

@@ -0,0 +1,24 @@
+module ActiveAdmin
+  module Axlsx
+    module DSL
+      # Configure the xlsx format
+      #
+      # For example:
+      #
+      #   xlsx do
+      #     i18n_scope = [:active_admin, :resources, :post]
+      #     column :name
+      #     column(:author) { |post| post.author.full_name }
+      #   end
+      #
+      #   xlsx :header_style => { :bg_color => "00", :fg_color => "FF" } do
+      #     column :name
+      #   end
+      def xlsx(options={}, &block)
+        config.xlsx_builder = XlsxBuilder.new(options, &block)
+      end
+
+    end
+  end
+end
+

data/lib/active_admin/axlsx/resource_controller_extension.rb

@@ -0,0 +1,33 @@
+module ActiveAdmin
+  module Axlsx
+    module ResourceControllerExtension
+      def self.included(base)
+        base.send :alias_method_chain, :per_page, :xlsx
+        base.send :alias_method_chain, :index, :xlsx
+        base.send :respond_to, :xlsx
+      end
+
+      def index_with_xlsx(options={}, &block)
+        index_without_xlsx(options) do |format|
+           format.xlsx do
+            xlsx = active_admin_config.xlsx_builder.serialize(collection)
+            send_data xlsx.to_stream.read, :filename => "#{xlsx_filename}", :type => "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" 
+          end
+        end
+      end
+
+      def per_page_with_xlsx
+          if request.format == 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+            return max_csv_records
+          end
+          per_page_without_xlsx
+      end
+
+      # Returns a filename for the xlsx file using the collection_name
+      # and current date such as 'my-articles-2011-06-24.xlsx'.
+      def xlsx_filename
+        "#{resource_collection_name.to_s.gsub('_', '-')}-#{Time.now.strftime("%Y-%m-%d")}.xlsx"
+      end
+    end
+  end
+end

data/lib/active_admin/axlsx/resource_extension.rb

@@ -0,0 +1,20 @@
+module ActiveAdmin
+  module Axlsx
+    module ResourceExtension
+
+      def xlsx_builder=(builder)
+        @xlsx_builder = builder
+      end
+
+      def xlsx_builder
+        @xlsx_builder ||= default_xlsx_builder
+      end
+
+      private
+
+      def default_xlsx_builder
+        @default_xlsx_builder ||= Axlsx::Builder.default_for_resource(resource_class)
+      end
+    end
+  end
+end

data/lib/active_admin/axlsx/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module Axlsx
+    VERSION = '1.0.0a'
+  end
+end

data/lib/activeadmin-axlsx.rb

@@ -0,0 +1 @@
+require 'active_admin/axlsx.rb'

data/spec/axlsx/unit/builder_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+module ActiveAdmin
+  module Axlsx
+    describe Builder do
+      context "with shared strings" do
+        let(:builder) do
+          Builder.new :shared_strings => true
+        end
+
+        it "should be set to use shared strings" do 
+          builder.shared_strings.should be_true
+        end
+      end
+
+      context "with i18n_scope" do
+        let(:builder) do
+          Builder.new :i18n_scope => [:active_admin, :resource, :category]
+        end
+
+        it "should have the defined i18n_scope set" do
+          builder.i18n_scope.should == [:active_admin, :resource, :category]
+        end
+      end
+
+      context "with a customized header style" do
+        let (:header_style) do
+          { :bg_color => '00', :fg_color => 'FF', :sz => 12, :alignment => { :horizontal=> :center } }
+        end
+
+        let (:builder) do
+          Builder.new :header_style => header_style
+        end
+
+        it "should be set up with a header style" do
+          header_style.each { |key , value| builder.header_style[key].should == value }
+        end
+      end
+    end
+  end
+end

data/spec/axlsx/unit/resource_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper' 
+include ActiveAdmin
+
+module ActiveAdmin
+  module Axlsx
+    describe Resource do
+      before { load_defaults! }
+
+      let(:application){ ActiveAdmin::Application.new }
+      let(:namespace){ Namespace.new(application, :admin) }
+
+      def config(options = {})
+        @config ||= Resource.new(namespace, Category, options)
+      end
+
+      describe "#xlsx_builder" do
+        context "when no xlsx_builder set" do
+          it "should return a default xlsx_builder with id and content columns" do
+            config.xlsx_builder.columns.size.should == Category.content_columns.size + 1
+          end
+        end
+
+        context "when xslx_builder set" do
+          it "should return the xlsx_builder we set" do
+            xlsx_builder = Builder.new
+            config.xlsx_builder = xlsx_builder
+            config.xlsx_builder.should == xlsx_builder
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rails'
+require 'activeadmin'
+
+ENV['RAILS_ROOT'] = File.expand_path("../rails/rails-#{Rails::VERSION::STRING}", __FILE__)
+
+unless File.exists?(ENV['RAILS_ROOT'])
+  puts "Please run bundle exec rake setup before running the specs."
+  exit
+end
+
+def load_defaults!
+  ActiveAdmin.unload!
+  ActiveAdmin.load!
+  ActiveAdmin.register(Category)
+  ActiveAdmin.register(User)
+  ActiveAdmin.register(Post){ belongs_to :user, :optional => true }
+end
+
+ENV['RAILS_ENV'] = 'test'
+ActiveAdmin.application.load_paths = [ENV['RAILS_ROOT'] + "/app/admin"]
+require ENV['RAILS_ROOT'] + '/config/environment'
+require 'activeadmin-axlsx'

data/spec/support/rails_template.rb

@@ -0,0 +1,73 @@
+# 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
+inject_into_file 'app/models/post.rb', "  attr_accessible :author\n", :before => "end" if Rails::VERSION::STRING >= '3.2.3'
+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 = <<-EOF
+  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
+EOF
+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"
+
+# Add our local Active Admin to the load path
+inject_into_file "config/environment.rb", "\n$LOAD_PATH.unshift('#{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))}')\nrequire \"active_admin\"\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'))
+
+# we need this routing path, named "logout_path", for testing
+route <<-EOS
+  devise_scope :user do
+    match '/admin/logout' => 'active_admin/devise/sessions#destroy', :as => :logout
+  end
+EOS
+
+generate :'active_admin:install'
+
+# 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"