csv_builder 1.1.7 → 2.0.0

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== 2.0.0 release 2011-04-22
+* Move to Jeweler for release management
+* Official Rails 3 release without regard for Rails 2
+* Fix specs for Rspec 2.5 and Rails 3.0.7
+
+== 1.1.8 (not released to gemcutter)
+* Specs (Vidmantas Kabosis)
+* Ruby 1.9 compability (Vidmantas Kabosis)
+* CSV options are again passed to the builder (Vidmantas Kabosis)
+
 == 1.1.7 release 2009-12-27
 
 * Forgot to add transliterating filter to gem spec

data/README.md

@@ -0,0 +1,99 @@
+**Important Note** Though I did not write this code, I did convert it to a gem and I'm currently the sole owner on
+rubygems.  With Joel Chippindale's approval I've taken over defacto maintainership of this gem.  My use case is
+primarily under rails 3, but I will accept patches for the 2.3.x version as well.
+
+# CSV Builder
+
+The CSV Builder Rails plugin provides a simple templating system for serving dynamically generated CSV files from your
+application.
+
+
+
+## Requirements
+
+The current version of CSV Builder works with:
+
+* Rails 3.x
+* Ruby 1.8 or 1.9
+
+The legacy version (1.1.x) was originally developed and tested for Rails 2.1.  See [the legacy
+docs](https://github.com/econsultancy/csv_builder) for more details.
+
+
+
+## Install
+
+### Install as a gem (recommended)
+
+    $ gem install csv_builder
+
+If you are using Bundler then [you know what to do](http://gembundler.com).
+
+
+
+## Example
+
+CSV template files are suffixed with `.csv.csvbuilder`, for example `index.csv.csvbuilder`
+
+Add rows to your CSV file in the template by pushing arrays of columns into the csv object.
+
+     # First row
+     csv << [ 'cell 1', 'cell 2' ]
+     # Second row
+     csv << [ 'another cell value', 'and another' ]
+     # etc...
+
+You can set the default filename for that a browser will use for 'save as' by setting `@filename` instance variable in
+your controller's action method e.g.
+
+    @filename = 'report.csv'
+
+You can set the input encoding and output encoding by setting `@input_encoding` and `@output_encoding` instance
+variables.  These default to 'UTF-8' and 'LATIN1' respectively. e.g.
+
+    @output_encoding = 'UTF-8'
+
+You can set `@csv_options` instance variable to define options for FasterCSV generator. For example: 
+
+    @csv_options = { :force_quotes => true, :col_sep => ';' }
+
+You can respond with csv in your controller as well:
+
+    respond_to do |format|
+      format.html
+      format.csv # make sure you have action_name.csv.csvbuilder template in place
+    end 
+
+You can also attach a csv file to mail sent out by your application by
+including a snippet like the following in your mailer method
+
+    attachment "text/csv" do |attachment|
+      attachment.body = render(:file => 'example/index.csv.csvbuilder')
+      attachment.filename = 'report.csv'
+    end
+
+
+
+## Contributions
+
+As of version 2.0 this gem has a rudimentary spec suite for Rails 3.  The test suite has been run under both Ruby 1.8
+and 1.9.  The requirements are in the Gemfile within the test spec directory.  So first you can run:
+
+    cd spec/rails_app && bundle install
+
+To install the main testing requirements.  Then return back to the root directory and run:
+
+    rake spec
+
+I will also take patches for Rails 2.3.x, though I personally have no further need of that branch.
+
+
+
+== Troubleshooting
+
+There's a known bug of encoding error in Ruby 1.9
+
+For more details see https://rails.lighthouseapp.com/projects/8994/tickets/2188-i18n-fails-with-multibyte-strings-in-ruby-19-similar-to-2038
+
+
+Copyright (c) 2008 Econsultancy.com, 2009 Vidmantas Kabošis & 2011 Gabe da Silveira released under the MIT license

data/Rakefile

@@ -1,5 +1,7 @@
-require 'rake'
 require 'rake/rdoctask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'jeweler'
 
 desc 'Generate documentation for the csv_builder plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
@@ -10,3 +12,22 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('CHANGELOG.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc 'Test the csv builder'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern   = "./spec/**/*_spec.rb"
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "csv_builder"
+  gem.homepage = "http://github.com/dasil003/csv_builder"
+  gem.license = "MIT"
+  gem.summary = %Q{CSV template handler for Rails}
+  gem.description = %Q{CSV template handler for Rails.  Enables :format => 'csv' in controllers, with templates of the form report.csv.csvbuilder.}
+  gem.email = "gabe@websaviour.com"
+  gem.authors = ['Econsultancy', 'Vidmantas Kabosis', "Gabe da Silveira"]
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/csv_builder.gemspec

@@ -0,0 +1,116 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{csv_builder}
+  s.version = "2.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Econsultancy", "Vidmantas Kabosis", "Gabe da Silveira"]
+  s.date = %q{2011-04-22}
+  s.description = %q{CSV template handler for Rails.  Enables :format => 'csv' in controllers, with templates of the form report.csv.csvbuilder.}
+  s.email = %q{gabe@websaviour.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.rdoc",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "csv_builder.gemspec",
+    "lib/csv_builder.rb",
+    "lib/csv_builder/railtie.rb",
+    "lib/csv_builder/template_handler.rb",
+    "lib/csv_builder/transliterating_filter.rb",
+    "rails/init.rb",
+    "spec/controllers/csv_builder_spec.rb",
+    "spec/rails_app/.gitignore",
+    "spec/rails_app/Gemfile",
+    "spec/rails_app/README",
+    "spec/rails_app/Rakefile",
+    "spec/rails_app/app/controllers/application_controller.rb",
+    "spec/rails_app/app/helpers/application_helper.rb",
+    "spec/rails_app/app/views/layouts/application.html.erb",
+    "spec/rails_app/config.ru",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/database.yml",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/mime_types.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/initializers/session_store.rb",
+    "spec/rails_app/config/locales/en.yml",
+    "spec/rails_app/config/routes.rb",
+    "spec/rails_app/db/seeds.rb",
+    "spec/rails_app/doc/README_FOR_APP",
+    "spec/rails_app/lib/tasks/.gitkeep",
+    "spec/rails_app/public/404.html",
+    "spec/rails_app/public/422.html",
+    "spec/rails_app/public/500.html",
+    "spec/rails_app/public/favicon.ico",
+    "spec/rails_app/public/images/rails.png",
+    "spec/rails_app/public/index.html",
+    "spec/rails_app/public/javascripts/application.js",
+    "spec/rails_app/public/javascripts/controls.js",
+    "spec/rails_app/public/javascripts/dragdrop.js",
+    "spec/rails_app/public/javascripts/effects.js",
+    "spec/rails_app/public/javascripts/prototype.js",
+    "spec/rails_app/public/javascripts/rails.js",
+    "spec/rails_app/public/robots.txt",
+    "spec/rails_app/public/stylesheets/.gitkeep",
+    "spec/rails_app/script/rails",
+    "spec/rails_app/test/performance/browsing_test.rb",
+    "spec/rails_app/test/test_helper.rb",
+    "spec/rails_app/vendor/plugins/.gitkeep",
+    "spec/spec_helper.rb",
+    "spec/templates/csv_builder_reports/complex.csv.csvbuilder",
+    "spec/templates/csv_builder_reports/encoding.csv.csvbuilder",
+    "spec/templates/csv_builder_reports/simple.csv.csvbuilder",
+    "spec/templates/csv_builder_reports/simple.html.erb"
+  ]
+  s.homepage = %q{http://github.com/dasil003/csv_builder}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{CSV template handler for Rails}
+  s.test_files = [
+    "spec/controllers/csv_builder_spec.rb",
+    "spec/rails_app/app/controllers/application_controller.rb",
+    "spec/rails_app/app/helpers/application_helper.rb",
+    "spec/rails_app/config/application.rb",
+    "spec/rails_app/config/boot.rb",
+    "spec/rails_app/config/environment.rb",
+    "spec/rails_app/config/environments/development.rb",
+    "spec/rails_app/config/environments/production.rb",
+    "spec/rails_app/config/environments/test.rb",
+    "spec/rails_app/config/initializers/backtrace_silencers.rb",
+    "spec/rails_app/config/initializers/inflections.rb",
+    "spec/rails_app/config/initializers/mime_types.rb",
+    "spec/rails_app/config/initializers/secret_token.rb",
+    "spec/rails_app/config/initializers/session_store.rb",
+    "spec/rails_app/config/routes.rb",
+    "spec/rails_app/db/seeds.rb",
+    "spec/rails_app/test/performance/browsing_test.rb",
+    "spec/rails_app/test/test_helper.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/csv_builder.rb

@@ -1,66 +1,16 @@
-require 'fastercsv'
-require 'iconv'
-
-module ActionView # :nodoc:
-  module TemplateHandlers
-    # Template handler for csv templates
-    #
-    # Add rows to your CSV file in the template by pushing arrays of columns into csv
-    #
-    #   # First row
-    #   csv << [ 'cell 1', 'cell 2' ]
-    #   # Second row
-    #   csv << [ 'another cell value', 'and another' ]
-    #   # etc...
-    #
-    # You can set the default filename for that a browser will use for 'save as' by
-    # setting <tt>@filename</tt> instance variable in your controller's action method
-    # e.g.
-    #
-    #   @filename = 'report.csv'
-    #
-    # You can also set the input encoding and output encoding by setting
-    # <tt>@input_encoding</tt> and <tt>@output_encoding</tt> instance variables.
-    # These default to 'UTF-8' and 'LATIN1' respectively. e.g.
-    #
-    #   @output_encoding = 'UTF-8'
-    class CsvBuilder < TemplateHandler
-      include Compilable
-
-      def self.line_offset
-        9
-      end
-
-      def compile(template)
-        <<-EOV
-        begin
-          output = FasterCSV.generate do |faster_csv|
-            csv = TransliteratingFilter.new(faster_csv)
-            #{template.source}
-          end
+# encoding: utf-8
 
-          unless defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base)
-            @filename ||= "\#{controller.action_name}.csv"
-            if controller.request.env['HTTP_USER_AGENT'] =~ /msie/i
-              controller.response.headers['Pragma'] = 'public'
-              controller.response.headers["Content-type"] = "text/plain" 
-              controller.response.headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'
-              controller.response.headers['Content-Disposition'] = "attachment; filename=\#{@filename}"
-              controller.response.headers['Expires'] = "0" 
-            else
-              controller.response.headers["Content-Type"] ||= 'text/csv'
-              controller.response.headers["Content-Disposition"] = "attachment; filename=\#{@filename}"
-              controller.response.headers["Content-Transfer-Encoding"] = "binary"
-            end
-          end
-
-          output
-        rescue Exception => e
-          RAILS_DEFAULT_LOGGER.warn("Exception \#{e} \#{e.message} with class \#{e.class.name} thrown when rendering CSV")
-          raise e
-        end
-        EOV
-      end
-    end
+module CsvBuilder
+  if RUBY_VERSION.to_f >= 1.9
+    require 'csv'
+    CSV_LIB = CSV
+  else
+    require 'fastercsv'
+    CSV_LIB = FasterCSV
   end
 end
+
+require 'iconv'
+require 'csv_builder/transliterating_filter'
+require 'csv_builder/template_handler'
+require 'csv_builder/railtie'

data/lib/csv_builder/railtie.rb

@@ -0,0 +1,5 @@
+class CsvBuilder::Railtie < Rails::Railtie
+  initializer "csv_builder.register_template_handler.action_view" do
+    ActionView::Template.register_template_handler 'csvbuilder', CsvBuilder::TemplateHandler
+  end
+end

data/lib/csv_builder/template_handler.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+module CsvBuilder # :nodoc:
+
+    # Template handler for csv templates
+    #
+    # Add rows to your CSV file in the template by pushing arrays of columns into csv
+    #
+    #   # First row
+    #   csv << [ 'cell 1', 'cell 2' ]
+    #   # Second row
+    #   csv << [ 'another cell value', 'and another' ]
+    #   # etc...
+    #
+    # You can set the default filename for that a browser will use for 'save as' by
+    # setting <tt>@filename</tt> instance variable in your controller's action method
+    # e.g.
+    #
+    #   @filename = 'report.csv'
+    #
+    # You can also set the input encoding and output encoding by setting
+    # <tt>@input_encoding</tt> and <tt>@output_encoding</tt> instance variables.
+    # These default to 'UTF-8' and 'LATIN1' respectively. e.g.
+    #
+    #   @output_encoding = 'UTF-8'
+    class TemplateHandler < ActionView::Template::Handler
+      include ActionView::Template::Handlers::Compilable
+
+      def compile(template)
+        <<-EOV
+        begin
+          output = CsvBuilder::CSV_LIB.generate(@csv_options || {}) do |faster_csv|
+            csv = CsvBuilder::TransliteratingFilter.new(faster_csv, @input_encoding || 'UTF-8', @output_encoding || 'LATIN1')
+            #{template.source}
+          end
+
+          unless defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base)
+            @filename ||= "\#{controller.action_name}.csv"
+            if controller.request.env['HTTP_USER_AGENT'] =~ /msie/i
+              controller.response.headers['Pragma'] = 'public'
+              controller.response.headers["Content-type"] = "text/plain"
+              controller.response.headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'
+              controller.response.headers['Content-Disposition'] = "attachment; filename=\#{@filename}"
+              controller.response.headers['Expires'] = "0"
+            else
+              controller.response.headers["Content-Type"] ||= 'text/csv'
+              controller.response.headers["Content-Disposition"] = "attachment; filename=\#{@filename}"
+              controller.response.headers["Content-Transfer-Encoding"] = "binary"
+            end
+          end
+
+          output
+        rescue Exception => e
+          Rails.logger.warn("Exception \#{e} \#{e.message} with class \#{e.class.name} thrown when rendering CSV")
+          raise e
+        end
+        EOV
+      end
+    end
+end

data/lib/{transliterating_filter.rb → csv_builder/transliterating_filter.rb}

@@ -1,6 +1,7 @@
-class TransliteratingFilter
+#encoding: utf-8
+
+class CsvBuilder::TransliteratingFilter
   # Transliterate into the required encoding if necessary
-  # TODO: make defaults configurable
   def initialize(faster_csv, input_encoding = 'UTF-8', output_encoding = 'LATIN1')
     @faster_csv = faster_csv
 

data/rails/init.rb

@@ -1,3 +1,3 @@
 require 'csv_builder'
 
-ActionView::Template.register_template_handler 'csvbuilder', ActionView::TemplateHandlers::CsvBuilder
+ActionView::Template.register_template_handler 'csvbuilder', CsvBuilder::TemplateHandler

data/spec/controllers/csv_builder_spec.rb

@@ -0,0 +1,68 @@
+#encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class CsvBuilderReportsController < ApplicationController
+  before_filter {|c| c.prepend_view_path(File.expand_path(File.dirname(__FILE__) + '/../templates')) }
+
+  def simple
+    # dummy
+    respond_to do |format|
+      format.html
+      format.csv
+    end
+  end
+
+  def complex
+    respond_to do |format|
+      format.csv do
+        @filename = 'some_complex_filename.csv'
+        @csv_options = { :col_sep => "\t" }
+        @data = TEST_DATA
+      end
+    end
+  end
+
+  def encoding
+    respond_to do |format|
+      format.csv { @output_encoding = 'UTF-16' }
+    end
+  end
+
+end
+ActionController::Routing::Routes.draw { |map| map.connect ':controller/:action' }
+
+
+describe CsvBuilderReportsController do
+  render_views
+
+  describe "Simple layout" do
+    it "still responds to HTML" do
+      get 'simple'
+      response.should be_success
+    end
+
+    it "responds to CSV" do
+      get 'simple', :format => 'csv'
+      response.should be_success
+    end
+  end
+
+  describe "Layout with options" do
+    it "sets output encoding correctly" do
+      get 'encoding', :format => 'csv'
+      correct_output = generate({}, [Iconv.iconv('UTF-16//TRANSLIT//IGNORE', 'UTF-8', 'ąčęėįšųūž')])
+      response.body.to_s.should == correct_output
+    end
+
+    it "passes csv options" do
+      get 'complex', :format => 'csv'
+      response.body.to_s.should == generate({ :col_sep => "\t" })
+    end
+
+    it "sets filename" do
+      get 'complex', :format => 'csv'
+      response.headers['Content-Disposition'].should match(/filename=some_complex_filename.csv/)
+    end
+  end
+end