1 files changed, 38 insertions, 0 deletions
diff --git a/gems/csv_builder/lib/csv_builder.rb b/gems/csv_builder/lib/csv_builder.rb
new file mode 100644
index 00000000000..86b682939dc
--- /dev/null
+++ b/gems/csv_builder/lib/csv_builder.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'tempfile'
+require 'zlib'
+
+require_relative "csv_builder/version"
+require_relative "csv_builder/builder"
+require_relative "csv_builder/single_batch"
+require_relative "csv_builder/stream"
+require_relative "csv_builder/gzip"
+
+# Generates CSV when given a collection and a mapping.
+#
+# Example:
+#
+#     columns = {
+#       'Title' => 'title',
+#       'Comment' => 'comment',
+#       'Author' => -> (post) { post.author.full_name }
+#       'Created At (UTC)' => -> (post) { post.created_at&.strftime('%Y-%m-%d %H:%M:%S') }
+#     }
+#
+#     CsvBuilder.new(@posts, columns).render
+#
+module CsvBuilder
+  #
+  # * +collection+ - The data collection to be used
+  # * +header_to_value_hash+ - A hash of 'Column Heading' => 'value_method'.
+  # * +associations_to_preload+ - An array of records to preload with a batch of records.
+  #
+  # The value method will be called once for each object in the collection, to
+  # determine the value for that row. It can either be the name of a method on
+  # the object, or a lamda to call passing in the object.
+  def self.new(collection, header_to_value_hash, associations_to_preload = [])
+    CsvBuilder::Builder.new(collection, header_to_value_hash, associations_to_preload)
+  end
+end