Merge pull request activeadmin#1626 from forthemakers/1625-pass-options-to-csv

Active Admin developer can pass options for CSV generation

Author: pcreux

app/views/active_admin/resource/index.csv.erb

@@ -7,7 +7,10 @@
               CSV
             end
 
-  csv_output = csv_lib.generate(:col_sep => active_admin_config.csv_builder.column_separator || active_admin_application.csv_column_separator) do |csv|
+  col_sep = active_admin_config.csv_builder.column_separator || active_admin_application.csv_column_separator
+  options = (active_admin_config.csv_builder.options || active_admin_application.csv_options).merge(:col_sep => col_sep)
+
+  csv_output = csv_lib.generate(options) do |csv|
     columns = active_admin_config.csv_builder.columns
     csv << columns.map(&:name)
     collection.each do |resource|

docs/4-csv-format.md

@@ -13,16 +13,20 @@ Customizing the CSV format is as simple as customizing the index page.
       end
     end
 
-You can choose custom separator:
+You can set custom csv options:
 
     ActiveAdmin.register Post do
-      csv :separator => ';' do
+      csv :options => { :force_quotes => true } do
         column :title
         column("Author") { |post| post.author.full_name }
       end
     end
 
-You can also set the custom separator system-wide:
+You can set options for the CSV format system-wide:
 
     # config/initializers/active_admin.rb
-    config.csv_column_separator = ";"
+    # Set the CSV builder separator (default is ",")
+    config.csv_column_separator = ';'
+
+    # Set the CSV builder options (default is {})
+    config.csv_options = { :force_quotes => true }

features/index/format_as_csv.feature

@@ -61,6 +61,24 @@ Feature: Format as CSV
       | Title        | Body |
       | Hello, World | (.*) |
 
+  Scenario: With CSV option customization
+    Given a configuration of:
+    """
+      ActiveAdmin.register Post do
+        csv :options => {:force_quotes => true} do
+          column :title
+          column :body
+        end
+      end
+    """
+    And a post with the title "012345" exists
+    When I am on the index page for posts
+    And I follow "CSV"
+    And I should download a CSV file with "," separator for "posts" containing:
+      | Title  | Body |
+      | 012345 | (.*) |
+    And the CSV file should contain "012345" in quotes
+
   Scenario: With default CSV separator option
     Given a configuration of:
     """
@@ -79,3 +97,22 @@ Feature: Format as CSV
       | Title | Body |
       | Hello, World | (.*) |
 
+  Scenario: With default CSV options
+    Given a configuration of:
+    """
+      ActiveAdmin.application.csv_options = {:force_quotes => true}
+      ActiveAdmin.application.csv_column_separator = ','
+      ActiveAdmin.register Post do
+        csv do
+          column :title
+          column :body
+        end
+      end
+    """
+    And a post with the title "012345" exists
+    When I am on the index page for posts
+    And I follow "CSV"
+    And I should download a CSV file with "," separator for "posts" containing:
+      | Title  | Body |
+      | 012345 | (.*) |
+    And the CSV file should contain "012345" in quotes

features/step_definitions/format_steps.rb

@@ -48,4 +48,9 @@
 
 Then /^I should download a CSV file for "([^"]*)" containing:$/ do |resource_name, table|
   step "I should download a CSV file with \",\" separator for \"#{resource_name}\" containing:", table
-end
+end
+
+Then /^the CSV file should contain "([^"]*)" in quotes$/ do |text|
+  body = page.driver.response.body
+  body.should match(/\"#{text}\"/)
+end

lib/active_admin/application.rb

@@ -12,6 +12,11 @@ def self.inheritable_setting(name, default)
       setting name, default
     end
 
+    def self.deprecated_inheritable_setting(name, default)
+      Namespace.deprecated_setting name, nil
+      deprecated_setting name, default
+    end
+
     # The default namespace to put controllers and routes inside. Set this
     # in config/initializers/active_admin.rb using:
     #
@@ -66,8 +71,8 @@ def self.inheritable_setting(name, default)
     # The namespace root.
     inheritable_setting :root_to, 'dashboard#index'
 
-    # Default CSV separator
-    inheritable_setting :csv_column_separator, ','
+    # Default CSV options
+    inheritable_setting :csv_options, {}
 
     # Active Admin makes educated guesses when displaying objects, this is
     # the list of methods it tries calling in order
@@ -82,6 +87,9 @@ def self.inheritable_setting(name, default)
 
     # == Deprecated Settings
 
+    # @deprecated Default CSV separator will be removed in 0.6.0. Use `csv_options = { :col_sep => ',' }` instead.
+    deprecated_inheritable_setting :csv_column_separator, ','
+
     # @deprecated The default sort order for index pages
     deprecated_setting :default_sort_order, 'id_desc'
 

lib/active_admin/csv_builder.rb

@@ -25,11 +25,12 @@ def self.default_for_resource(resource)
       end
     end
 
-    attr_reader :columns, :column_separator
+    attr_reader :columns, :column_separator, :options
 
     def initialize(options={}, &block)
       @columns          = []
       @column_separator = options.delete(:separator)
+      @options          = options.delete(:options)
       instance_eval &block if block_given?
     end
 

lib/active_admin/resource_dsl.rb

@@ -68,7 +68,7 @@ def form(options = {}, &block)
     #     column("Author") { |post| post.author.full_name }
     #   end
     #
-    #   csv :separator => ";" do
+    #   csv :separator => ";", :options => { :force_quotes => true } do
     #     column :name
     #   end
     #

lib/generators/active_admin/install/templates/active_admin.rb.erb

@@ -116,7 +116,7 @@ ActiveAdmin.setup do |config|
   # Enable and disable Batch Actions
   #
   config.batch_actions = true
-  
+
 
   # == Controller Filters
   #
@@ -134,7 +134,7 @@ ActiveAdmin.setup do |config|
   #
   # To load a stylesheet:
   #   config.register_stylesheet 'my_stylesheet.css'
-  
+
   # You can provide an options hash for more control, which is passed along to stylesheet_link_tag():
   #   config.register_stylesheet 'my_print_stylesheet.css', :media => :print
   #
@@ -146,4 +146,7 @@ ActiveAdmin.setup do |config|
   #
   # Set the CSV builder separator (default is ",")
   # config.csv_column_separator = ','
+  #
+  # Set the CSV builder options (default is {})
+  # config.csv_options = {}
 end

spec/unit/application_spec.rb

@@ -30,7 +30,7 @@
     application.site_title = "New Title"
     application.site_title.should == "New Title"
   end
-  
+
   it "should store the site's title link" do
     application.site_title_link.should == ""
   end
@@ -39,11 +39,11 @@
     application.site_title_link = "http://www.mygreatsite.com"
     application.site_title_link.should == "http://www.mygreatsite.com"
   end
-  
+
   it "should store the site's title image" do
     application.site_title_image.should == ""
   end
-  
+
   it "should set the site's title image" do
     application.site_title_image = "http://railscasts.com/assets/episodes/stills/284-active-admin.png?1316476106"
     application.site_title_image.should == "http://railscasts.com/assets/episodes/stills/284-active-admin.png?1316476106"
@@ -53,7 +53,7 @@
     application.view_factory.should be_an_instance_of(ActiveAdmin::ViewFactory)
   end
 
-  it "should have deprecated admin notes by default" do 
+  it "should have deprecated admin notes by default" do
     application.admin_notes.should be_nil
   end
 
@@ -80,6 +80,19 @@
     end
   end
 
+  describe "inheritable settings" do
+    it "should set csv_options" do
+      application.csv_options.should == {}
+    end
+
+    context "when deprecated" do
+      it "should set and warn csv_column_separator" do
+        ActiveAdmin::Deprecation.should_receive(:warn)
+        application.csv_column_separator.should == ','
+      end
+    end
+  end
+
   describe "files in load path" do
     it "should load files in the first level directory" do
       application.files_in_load_path.should include(File.expand_path("app/admin/dashboard.rb", Rails.root))

spec/unit/csv_builder_spec.rb

@@ -90,4 +90,14 @@
     end
   end
 
+  context "with csv_options" do
+    let(:builder) do
+      ActiveAdmin::CSVBuilder.new :options => {:force_quotes => true}
+    end
+
+    it "should have proper separator" do
+      builder.options.should == {:force_quotes => true}
+    end
+  end
+
 end