mreinsch-csv_builder 0.1.3

data/CHANGELOG.rdoc

@@ -0,0 +1,10 @@
+== 1.1.3 release 2009-06-27
+
+* Merged some patches, created this changelog (Michael Reinsch)
+  * Added gem spec (Jan De Poorter)
+  * Set the correct response headers to work with IE, made the existing ones a little more robust (Jose Fernandez)
+
+== 1.0 released 2008
+
+* The original csv_builder plugin, released by Econsultancy.com
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Econsultancy.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,60 @@
+= 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
+	
+Encoding conversions are done with Iconv, so make sure you have it on your
+development/production machine.
+
+== 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 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 set <tt>@csv_options</tt> instance variable to define options for
+FasterCSV generator. For example:
+
+  @csv_options = { :force_quotes => true, :col_sep => ';' }
+
+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
+
+
+Copyright (c) 2008 Econsultancy.com and 2009 Vidmantas Kabošis, released under
+the MIT license.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for the csv_builder plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CSV Builder'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('CHANGELOG.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/csv_builder.rb

@@ -0,0 +1,86 @@
+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
+
+          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
+
+          result = FasterCSV.generate(@csv_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

data/rails/init.rb

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

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: mreinsch-csv_builder
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Econsultancy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: CSV template Rails plugin
+email: code@econsultancy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README.rdoc
+- CHANGELOG.rdoc
+- Rakefile
+- rails/init.rb
+- lib/csv_builder.rb
+has_rdoc: true
+homepage: http://github.com/mreinsch/csv_builder
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: CSV template Rails plugin
+test_files: []
+