did_csv_builder 0.1.4.beta

data/README

@@ -0,0 +1,58 @@
+= CSV Builder
+
+The CSV Builder Rails plugin provides a simple templating system for serving
+dynamically generated CSV files from your application.
+
+
+== Requirements
+
+CSV Builder requires Rails v2.1.
+
+It also depends upon the FasterCSV gem http://fastercsv.rubyforge.org,
+which you can install with
+
+  $ sudo gem install fastercsv
+	
+
+== 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 <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'
+
+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
+
+You can change the separator character and that is as simple as writing this in your controller's 
+action method:
+
+	csv_builder :sep => ';'
+	
+Actually, all default FasterCSV options can be overriden thanks to the previous statement.
+
+Copyright (c) 2008 Econsultancy.com, released under the MIT license

data/lib/csv_builder.rb

@@ -0,0 +1,12 @@
+require 'action_controller'
+require 'action_view'
+
+require 'fastercsv'
+require 'iconv'
+
+require 'csv_builder/action_controller'
+require 'csv_builder/template_handler/base'
+
+class ActionController::Base
+  include CsvBuilder::ActionController
+end

data/lib/csv_builder/action_controller.rb

@@ -0,0 +1,22 @@
+module CsvBuilder
+  module ActionController
+
+    DEFAULT_CSV_BUILDER_OPTIONS = { :col_sep => ';' }
+
+    def csv_builder(options)
+      @csv_builder_options = options
+    end
+
+    private
+
+    def compute_csv_builder_options
+      options = DEFAULT_CSV_BUILDER_OPTIONS.dup
+      options.merge!(@csv_builder_options || {})
+      options
+    end
+
+  end
+  
+end
+
+

data/lib/csv_builder/template_handler/base.rb

@@ -0,0 +1,154 @@
+module CsvBuilder
+  module TemplateHandler
+    
+    # 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 Base < ActionView::TemplateHandler
+    
+      include ActionView::TemplateHandlers::Compilable
+      
+      def self.line_offset
+        9
+      end
+
+      def compile(template)
+        <<-EOV
+        begin
+
+          unless defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base)
+            @filename ||= "\#{controller.action_name}.csv"
+            controller.response.headers["Content-Type"] ||= 'text/csv'
+            controller.response.headers['Content-Disposition'] = "attachment; filename=\#{@filename}"
+          end
+
+          result = FasterCSV.generate(controller.send(:compute_csv_builder_options)) do |csv|
+            #{template.source}
+          end
+
+          # Transliterate into the required encoding if necessary
+          # TODO: make defaults configurable
+          @input_encoding ||= 'UTF-8'
+          @output_encoding ||= 'LATIN1'
+
+          if @input_encoding == @output_encoding
+            result
+          else
+            # TODO: do some checking to make sure iconv works correctly in
+            # current environment. See ActiveSupport::Inflector#transliterate
+            # definition for details
+            #
+            # Not using the more standard //IGNORE//TRANLIST because it raises
+            # Iconv::IllegalSequence for some inputs
+            c = Iconv.new("\#{@output_encoding}//TRANSLIT//IGNORE", @input_encoding)
+            c.iconv(result)
+          end
+
+        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
+  end
+end
+
+
+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
+
+      attr_reader :csv_builder_options
+
+      def self.line_offset
+        9
+      end
+
+      def compile(template)
+        <<-EOV
+        begin
+
+          unless defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base)
+            @filename ||= "\#{controller.action_name}.csv"
+            controller.response.headers["Content-Type"] ||= 'text/csv'
+            controller.response.headers['Content-Disposition'] = "attachment; filename=\#{@filename}"
+          end
+
+          result = FasterCSV.generate do |csv|
+            #{template.source}
+          end
+
+          # Transliterate into the required encoding if necessary
+          # TODO: make defaults configurable
+          @input_encoding ||= 'UTF-8'
+          @output_encoding ||= 'LATIN1'
+
+          if @input_encoding == @output_encoding
+            result
+          else
+            # TODO: do some checking to make sure iconv works correctly in
+            # current environment. See ActiveSupport::Inflector#transliterate
+            # definition for details
+            #
+            # Not using the more standard //IGNORE//TRANLIST because it raises
+            # Iconv::IllegalSequence for some inputs
+            c = Iconv.new("\#{@output_encoding}//TRANSLIT//IGNORE", @input_encoding)
+            c.iconv(result)
+          end
+
+        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
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: did_csv_builder
+version: !ruby/object:Gem::Version 
+  hash: 31098201
+  prerelease: 6
+  segments: 
+  - 0
+  - 1
+  - 4
+  - beta
+  version: 0.1.4.beta
+platform: ruby
+authors: 
+- Tom Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: CSV template Rails plugin
+email: didier@nocoffee.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/csv_builder.rb
+- lib/csv_builder/action_controller.rb
+- lib/csv_builder/template_handler/base.rb
+- README
+has_rdoc: true
+homepage: https://github.com/did/csv_builder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: CSV template Rails plugin
+test_files: []
+