activeadmin-xls 1.0.4

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/rails/"
+end
+
+# 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.exists?(ENV['RAILS_ROOT'])
+  puts "Please run bundle exec rake setup before running the specs."
+  exit
+end
+
+# load up activeadmin and activeadmin-xls
+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'
+ActiveAdmin.application.authentication_method = false
+ActiveAdmin.application.current_user_method = false

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", "\nrequire \"activeadmin-xls\"\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"

data/spec/support/rails_template_with_data.rb

@@ -0,0 +1,59 @@
+# Use the default
+apply File.expand_path("../rails_template.rb", __FILE__)
+
+# Register Active Admin controllers
+%w{ Post User Category }.each do |type|
+  generate :'active_admin:resource', type
+end
+
+scopes = <<-EOF
+  scope :all, :default => true
+
+  scope :drafts do |posts|
+    posts.where(["published_at IS NULL"])
+  end
+
+  scope :scheduled do |posts|
+    posts.where(["posts.published_at IS NOT NULL AND posts.published_at > ?", Time.now.utc])
+  end
+
+  scope :published do |posts|
+    posts.where(["posts.published_at IS NOT NULL AND posts.published_at < ?", Time.now.utc])
+  end
+
+  scope :my_posts do |posts|
+    posts.where(:author_id => current_admin_user.id)
+  end
+
+EOF
+inject_into_file 'app/admin/posts.rb', scopes , :after => "ActiveAdmin.register Post do\n"
+
+# Setup some default data
+append_file "db/seeds.rb", <<-EOF
+  users = ["Jimi Hendrix", "Jimmy Page", "Yngwie Malmsteen", "Eric Clapton", "Kirk Hammett"].collect do |name|
+    first, last = name.split(" ")
+    User.create!  :first_name => first,
+                  :last_name => last,
+                  :username => [first,last].join('-').downcase,
+                  :age => rand(80)
+  end
+
+  categories = ["Rock", "Pop Rock", "Alt-Country", "Blues", "Dub-Step"].collect do |name|
+    Category.create! :name => name
+  end
+
+  published_at_values = [Time.now.utc - 5.days, Time.now.utc - 1.day, nil, Time.now.utc + 3.days]
+
+  1_000.times do |i|
+    user = users[i % users.size]
+    cat = categories[i % categories.size]
+    published_at = published_at_values[i % published_at_values.size]
+    Post.create :title => "Blog Post \#{i}",
+                :body => "Blog post \#{i} is written by \#{user.username} about \#{cat.name}",
+                :category_id => cat.id,
+                :published_at => published_at,
+                :author => user
+  end
+EOF
+
+rake 'db:seed'

data/spec/support/templates/admin/stores.rb

@@ -0,0 +1 @@
+ActiveAdmin.register Store

data/spec/support/templates/cucumber.rb

@@ -0,0 +1,24 @@
+require File.expand_path('config/environments/test', Rails.root)
+
+# rails/railties/lib/rails/test_help.rb aborts if the environment is not 'test'. (Rails 3.0.0.beta3)
+# We can't run Cucumber/RSpec/Test_Unit tests in different environments then.
+#
+# For now, I patch StringInquirer so that Rails.env.test? returns true when Rails.env is 'test' or 'cucumber'
+#
+# https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/4458-rails-should-allow-test-to-run-in-cucumber-environment
+module ActiveSupport
+  class StringInquirer < String
+    def method_missing(method_name, *arguments)
+      if method_name.to_s[-1,1] == "?"
+        test_string = method_name.to_s[0..-2]
+        if test_string == 'test'
+          self == 'test' or self == 'cucumber'
+        else
+          self == test_string
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/spec/support/templates/cucumber_with_reloading.rb

@@ -0,0 +1,5 @@
+require File.expand_path('config/environments/cucumber', Rails.root)
+
+Rails.application.class.configure do
+  config.cache_classes = false
+end

data/spec/support/templates/en.yml

@@ -0,0 +1,15 @@
+# Sample translations used to test ActiveAdmin's I18n integration.
+  axlsx:
+    post:
+      id: ID
+      title: Title
+      body: Content
+      published_at: Published On
+      author: Publisher
+      created_at: Created
+      updated_at: Updated
+  activerecord:
+    models:
+      store:
+        one: Bookstore
+        other: Bookstores

data/spec/xls/unit/build_download_format_links_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+describe ActiveAdmin::Views::PaginatedCollection do
+  def arbre(assigns = {}, helpers = mock_action_view, &block)
+    Arbre::Context.new(assigns, helpers, &block)
+  end
+
+  def render_arbre_component(assigns = {}, helpers = mock_action_view, &block)
+    arbre(assigns, helpers, &block).children.first
+  end
+
+  # Returns a fake action view instance to use with our renderers
+  def mock_action_view(assigns = {})
+    controller = ActionView::TestCase::TestController.new
+    ActionView::Base.send :include, ActionView::Helpers
+    ActionView::Base.send :include, ActiveAdmin::ViewHelpers
+    ActionView::Base.send :include, Rails.application.routes.url_helpers
+    ActionView::Base.new(ActionController::Base.view_paths, assigns, controller)
+  end
+
+  let(:view) do
+    view = mock_action_view
+    view.request.stub!(:query_parameters).and_return({:controller => 'admin/posts', :action => 'index', :page => '1'})
+    view.controller.params = {:controller => 'admin/posts', :action => 'index'}
+    view
+  end
+
+  # Helper to render paginated collections within an arbre context
+  def paginated_collection(*args)
+    render_arbre_component({:paginated_collection_args => args}, view) do
+      paginated_collection(*paginated_collection_args)
+    end
+  end
+
+  let(:collection) do
+    posts = [Post.new(:title => "First Post")]
+    Kaminari.paginate_array(posts).page(1).per(5)
+  end
+
+  let(:pagination) { paginated_collection(collection) }
+
+  before do
+    collection.stub!(:reorder) { collection }
+  end
+
+  it "renders the xls download link" do
+    pagination.children.last.content.should match(/XLS/)
+  end
+end

data/spec/xls/unit/builder_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+
+module ActiveAdmin
+  module Xls
+    describe Builder do
+
+      let(:builder) { Builder.new(Post) }
+      let(:content_columns) { Post.content_columns }
+
+      context 'the default builder' do
+        subject { builder }
+        its(:header_style) { should == { :bg_color => '00', :fg_color => 'FF', :sz => 12, :alignment => { :horizontal => :center } } }
+        its(:i18n_scope) { should be_nil }
+        its("columns.size") { should == content_columns.size + 1 }
+      end
+
+      context 'customizing a builder' do
+        it 'deletes columns we tell it we dont want' do
+          builder.delete_columns :id, :body
+          builder.columns.size.should == content_columns.size - 1
+        end
+
+        it 'lets us say we dont want the header' do
+          builder.skip_header
+          builder.instance_values["skip_header"].should be_true
+        end
+
+        it 'lets us add custom columns' do
+          builder.column(:hoge)
+          builder.columns.size.should == content_columns.size + 2
+        end
+
+        it 'lets us clear all columns' do
+          builder.clear_columns
+          builder.columns.size.should == 0
+        end
+
+        context 'Using Procs for delayed content generation' do
+
+          let(:post) { Post.new(:title => "Hot Dawg") }
+
+          before do
+            builder.column(:hoge) { |resource| "#{resource.title} - with cheese" }
+          end
+
+          it 'stores the block when defining a column for later execution.' do
+            builder.columns.last.data.should be_a(Proc)
+          end
+
+          it 'evaluates custom column blocks' do
+            builder.columns.last.data.call(post).should == "Hot Dawg - with cheese"
+          end
+        end
+      end
+
+      context 'sheet generation without headers' do
+        let!(:users) {  [User.new(first_name: 'bob', last_name: 'nancy')] }
+
+        let!(:posts) {  [Post.new(title: 'bob', body: 'is a swell guy', author: users.first)] }
+
+        let!(:builder) {
+          Builder.new(Post, header_style: { sz: 10, fg_color: "FF0000" }, i18n_scope: [:xls, :post]) do
+            skip_header
+          end
+        }
+
+        before do
+          User.stub!(:all) { users }
+          Post.stub!(:all) { posts }
+          # disable clean up so we can get the package.
+          builder.stub(:clean_up) { false }
+          builder.serialize(Post.all)
+          @package = builder.send(:package)
+          @collection = builder.collection
+        end
+
+        it 'does not serialize the header' do
+          not_header = @package.workbook.worksheets.first.rows.first
+          not_header.cells.first.value.should_not == 'Title'
+        end
+      end
+
+      context 'whitelisted sheet generation' do
+        let!(:users) {  [User.new(first_name: 'bob', last_name: 'nancy')] }
+
+        let!(:posts) {  [Post.new(title: 'bob', body: 'is a swell guy', author: users.first)] }
+
+        let!(:builder) {
+          Builder.new(Post, header_style: { sz: 10, fg_color: "FF0000" }, i18n_scope: [:xls, :post]) do
+            skip_header
+            whitelist
+            column :title
+          end
+        }
+
+        before do
+          User.stub!(:all) { users }
+          Post.stub!(:all) { posts }
+          # disable clean up so we can get the package.
+          builder.stub(:clean_up) { false }
+          builder.serialize(Post.all)
+          @package = builder.send(:package)
+          @collection = builder.collection
+        end
+
+        it 'does not serialize the header' do
+          sheet = @package.workbook.worksheets.first
+          sheet.rows.first.cells.size.should == 1
+          sheet.rows.first.cells.first.value.should == @collection.first.title
+        end
+      end
+
+      context 'Sheet generation with a highly customized configuration.' do
+
+        let!(:users) {  [User.new(first_name: 'bob', last_name: 'nancy')] }
+
+        let!(:posts) {  [Post.new(title: 'bob', body: 'is a swell guy', author: users.first)] }
+
+        let!(:builder) {
+          Builder.new(Post, header_style: { sz: 10, fg_color: "FF0000" }, i18n_scope: [:xls, :post]) do
+            delete_columns :id, :created_at, :updated_at
+            column(:author) { |resource| "#{resource.author.first_name} #{resource.author.last_name}" }
+            after_filter { |sheet|
+              sheet.add_row []
+              sheet.add_row ['Author Name', 'Number of Posts']
+              data = []
+              labels = []
+              User.all.each do |user|
+                data << user.posts.size
+                labels << "#{user.first_name} #{user.last_name}"
+                sheet.add_row [labels.last, data.last]
+              end
+              chart_color =  %w(88F700 279CAC B2A200 FD66A3 F20062 C8BA2B 67E6F8 DFFDB9 FFE800 B6F0F8)
+              sheet.add_chart(::xls::Pie3DChart, :title => "post by author") do |chart|
+                chart.add_series :data => data, :labels => labels, :colors => chart_color
+                chart.start_at 4, 0
+                chart.end_at 7, 20
+              end
+            }
+            before_filter do |sheet|
+              collection.first.author.first_name = 'Set In Proc'
+              sheet.add_row ['Created', Time.zone.now]
+              sheet.add_row []
+            end
+          end
+        }
+
+        before(:all) do
+          User.stub!(:all) { users }
+          Post.stub!(:all) { posts }
+          # disable clean up so we can get the package.
+          builder.stub(:clean_up) { false }
+          builder.serialize(Post.all)
+          @package = builder.send(:package)
+          @collection = builder.collection
+        end
+
+        it 'provides the collection object' do
+          @collection.count.should == Post.all.count
+        end
+
+        it 'merges our customizations with the default header style' do
+          builder.header_style[:sz].should be(10)
+          builder.header_style[:fg_color].should == 'FF0000'
+          builder.header_style[:bg_color].should == '00'
+        end
+
+        it 'uses the specified i18n_scope' do
+          builder.i18n_scope.should == [:xls, :post]
+        end
+
+        it 'translates the header row based on our i18n scope' do
+          header_row = @package.workbook.worksheets.first.rows[2]
+          header_row.cells.map(&:value).should == ['Title', 'Content', 'Published On', 'Publisher']
+        end
+
+        it 'processes the before filter' do
+          @package.workbook.worksheets.first["A1"].value.should == 'Created'
+        end
+
+        it 'lets us work against the collection in the before filter' do
+          @package.workbook.worksheets.first.rows.last.cells.first.value.should == 'Set In Proc nancy'
+        end
+
+        it 'processes the after filter' do
+          @package.workbook.charts.size.should == 1
+        end
+
+        it 'has no OOXML validation errors' do
+          @package.validate.size.should ==  0
+        end
+      end
+    end
+  end
+end

data/spec/xls/unit/dsl_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module ActiveAdmin
+  module Xls
+    describe ::ActiveAdmin::ResourceDSL do
+      context 'in a registraiton block' do
+        let(:builder) {
+          config = ActiveAdmin.register(Post) do
+            xls(i18n_scope: [:rspec], header_style: { sz: 20 }) do
+              delete_columns :id, :created_at
+              column(:author) { |post| post.author.first_name }
+              before_filter { |sheet| sheet.add_row ['before_filter'] }
+              after_filter { |sheet| sheet.add_row['after_filter'] }
+              skip_header
+            end
+          end
+          config.xls_builder
+        }
+
+
+        it "uses our customized i18n scope" do
+          builder.i18n_scope.should == [:rspec]
+        end
+
+        it "removed the columns we told it to ignore" do
+          [:id, :create_at].each do |removed|
+            builder.columns.index{|column| column.name == removed}.should be_nil
+          end
+        end
+
+        it "added the columns we declared" do
+          builder.columns.index{ |column| column.name == :author}.should_not be_nil
+        end
+
+        it "has a before filter set" do
+          builder.instance_values["before_filter"].should be_a(Proc)
+        end
+        it "has an after filter set" do
+          builder.instance_values["after_filter"].should be_a(Proc)
+        end
+
+        it "indicates that the header should be excluded" do
+          builder.instance_values['skip_header'].should be_true
+        end
+
+        it "updates the header style" do
+          builder.header_style[:sz].should be(20)
+        end
+      end
+    end
+  end
+end

data/spec/xls/unit/resource_controller_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+describe ActiveAdmin::ResourceController 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) { "#{controller.resource_class.to_s.downcase.pluralize}-#{Time.now.strftime("%Y-%m-%d")}.xls" }
+
+  it 'generates an xls filename' do
+    controller.xls_filename.should == filename
+  end
+
+  context 'when making requests with the xls mime type' do
+     it 'returns xls attachment when requested' do
+      controller.send :index
+      response.headers["Content-Disposition"].should == "attachment; filename=\"#{filename}\""
+      response.headers["Content-Transfer-Encoding"].should == 'binary'
+    end
+
+    it 'returns max_csv_records for per_page' do
+      controller.send(:per_page).should == controller.send(:max_csv_records)
+    end
+
+    it 'kicks back to the default per_page when we are not specifying a xls mime type' do
+      controller.request.accept = 'text/html'
+      controller.send(:per_page).should == ActiveAdmin.application.default_per_page
+    end
+  end
+end
+

data/spec/xls/unit/resource_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper' 
+include ActiveAdmin
+
+module ActiveAdmin
+  module Xls
+    describe Resource do
+      let(:resource) { ActiveAdmin.register(Post) }
+
+      let(:custom_builder) do
+        Builder.new(Post) do |builder|
+          column(:fake) { :fake }
+        end
+      end
+
+      context 'when registered' do
+        it "each resource has an xls_builer" do
+          resource.xls_builder.should be_a(Builder)
+        end
+
+        it "We can specify our own configured builder" do
+          lambda { resource.xls_builder = custom_builder }.should_not raise_error
+        end
+      end
+    end
+  end
+end