add byte order mark option to csv

activeadmin · Nov 13, 2014 · b9ad04e · b9ad04e
1 parent b8c5f5a
commit b9ad04e
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 
 * Unify DSL for index `actions` and `actions dropdown: true` [#3463][] by [@timoschilling][]
 * Add DSL method `includes` for `ActiveRecord::Relation#includes` [#3464][] by [@timoschilling][]
+* BOM (byte order mark) configurable for CSV download [#3519][] by [@timoschilling][]
 * Column block on table index is now sortable by default [#3075][] by [@dmitry][]
 * Allow Arbre to be used inside ActiveAdmin forms [#3486][] by [@varyonic][]
 * Make AA ORM-agnostic [#2545][] by [@johnnyshields][]
@@ -976,6 +977,7 @@ of the highlights. 250 commits. Enough said.
 [#3463]: https://github.com/activeadmin/activeadmin/issues/3463
 [#3464]: https://github.com/activeadmin/activeadmin/issues/3464
 [#3486]: https://github.com/activeadmin/activeadmin/issues/3486
+[#3519]: https://github.com/activeadmin/activeadmin/issues/3519
 [@Bishop]: https://github.com/Bishop
 [@BoboFraggins]: https://github.com/BoboFraggins
 [@DMajrekar]: https://github.com/DMajrekar

diff --git a/features/index/format_as_csv.feature b/features/index/format_as_csv.feature
@@ -65,7 +65,7 @@ Feature: Format as CSV
     Given a configuration of:
     """
       ActiveAdmin.register Post do
-        csv :force_quotes => true do
+        csv :force_quotes => true, :byte_order_mark => "" do
           column :title
           column :body
         end

diff --git a/lib/active_admin/application.rb b/lib/active_admin/application.rb
@@ -71,7 +71,7 @@ def initialize
     inheritable_setting :breadcrumb, true
 
     # Default CSV options
-    inheritable_setting :csv_options, {col_sep: ','}
+    inheritable_setting :csv_options, { col_sep: ',', byte_order_mark: "\xEF\xBB\xBF" }
 
     # Default Download Links options
     inheritable_setting :download_links, true

diff --git a/lib/active_admin/csv_builder.rb b/lib/active_admin/csv_builder.rb
@@ -44,6 +44,10 @@ def build(controller, receiver)
       options = ActiveAdmin.application.csv_options.merge self.options
       columns = exec_columns controller.view_context
 
+      if byte_order_mark = options.delete(:byte_order_mark)
+        receiver << byte_order_mark
+      end
+
       if options.delete(:column_names) { true }
         receiver << CSV.generate_line(columns.map{ |c| encode c.name, options }, options)
       end