csv_streamer 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,41 @@
+* Added dependencies and simplified contributor setup
+
+== 2.0.1 release 2011-04-22
+* Remove cruft from test app
+* Exclude spec from release
+
+== 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
+
+== 1.1.6 release 2009-12-18
+
+* Generate csv before setting headers so that errors are displayed in-browser instead of downloaded (Gabe da Silveira)
+* Tweak README for gemcutter download. (Gabe da Silveira)
+
+== 1.1.5 release 2009-12-18
+
+* Do transliteration before exporting to CSV, not after (Tom Stuart)
+* Released on gemcutter (Gabe da Silveira)
+
+== 1.1.4 release 2009-07-27
+
+* Merged some patches:
+  * 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)
+* Created changelog, updated docs (Michael Reinsch)
+
+== 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.md

@@ -0,0 +1,105 @@
+#Fawce's notes on forking: 
+I'm forking the project to add support for streaming responses. Many of the csv files I'm generating are quite large, and need to be streamed rather than return in a single shot. I'm basing my stream handling on [an example from David's Computer Stuff Journal](http://journal.dedasys.com/2006/06/08/streaming-programmatically-generated-content-from-rails)
+
+========
+**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, and the current version is not backwards compatible, but I will maintain a 2.3.x branch as well
+if anyone has patches.
+
+# 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.  You will need Bundler installed and then
+you can run:
+
+    cd spec/rails_app && bundle install && cd ../..
+
+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

@@ -0,0 +1,47 @@
+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|
+  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
+
+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"]
+
+  gem.files.exclude 'spec'
+
+  gem.add_dependency 'actionpack', '>=3.0.0'
+
+  gem.add_development_dependency 'rails', '>= 3.0.0'
+  gem.add_development_dependency 'rspec', '~> 2.5'
+  gem.add_development_dependency 'rspec-rails', '~> 2.5'
+  gem.add_development_dependency 'jeweler'
+  gem.add_development_dependency 'rack'
+  gem.add_development_dependency 'sqlite3'
+
+  gem.requirements << 'iconv'
+  gem.requirements << 'Ruby 1.9.x or FasterCSV'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+2.0.1

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::StreamingTemplateHandler
+  end
+end

data/lib/csv_builder/template_handler.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+module CsvBuilder # :nodoc:
+  
+  class Yielder
+    def initialize(stream_proc)
+      @stream_proc = stream_proc
+    end
+    
+    def pos
+      return 0
+    end
+    
+    def eof?
+      return true
+    end
+    
+    def rewind
+    end
+    
+    def read(arg1)
+      return "\n"
+    end
+    
+    def <<(data)
+      @stream_proc.call data
+    end
+    
+  end
+  
+  class Streamer
+    def initialize(template_proc)
+      @template_proc = template_proc
+    end
+    
+    def each
+      # The ruby csv class will try to infer a separator to use, if the csv options
+      # do not set it. ruby's csv calls pos, eof?, read, and rewind to check the first line
+      # of the io to infer a separator. Rails' output object does not support these methods
+      # so we provide a mock implementation to satisfy csv.
+      #
+      # See code at https://github.com/ruby/ruby/blob/trunk/lib/csv.rb#L2021 - note that @io points
+      # to the output variable defined by this block.
+      # output.class.send(:define_method, "pos") {return 0 }
+      # output.class.send(:define_method, "eof?") { return true }
+      # output.class.send(:define_method, "rewind") {}
+      # read needs to return a newline, otherwise csv loops indefinitely looking for the end of the first line.
+      # output.class.send(:define_method, "read") {|arg1| return "\\n" }
+      # output = ""                                      
+      # The ruby csv write method requires output to support << for writing. Here we just 
+      # delegate the method call to output's write method.
+      # output.class.send(:define_method, "<<") {|arg1| yield arg1}
+      
+      yielder = CsvBuilder::Yielder.new(Proc.new{|data| yield data})
+      csv_stream = CsvBuilder::CSV_LIB.new(yielder, @csv_options || {}) 
+      csv = CsvBuilder::TransliteratingFilter.new(csv_stream, @input_encoding || 'UTF-8', @output_encoding || 'LATIN1')
+      @template_proc.call(csv)
+    end
+end
+    # 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 StreamingTemplateHandler < ActionView::Template::Handler
+      include ActionView::Template::Handlers::Compilable
+
+      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
+              response.headers['Pragma'] = 'public'
+              response.headers["Content-type"] = "text/plain"
+              response.headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'
+              response.headers['Content-Disposition'] = "attachment; filename=\#{@filename}"
+              response.headers['Expires'] = "0"
+            else
+              response.headers["Content-Type"] ||= 'text/csv'
+              response.headers["Content-Disposition"] = "attachment; filename=\#{@filename}"
+              response.headers["Content-Transfer-Encoding"] = "binary"
+            end
+          end
+          
+          if @streaming
+            template = Proc.new {|csv|
+              #{template.source}
+            }
+            CsvBuilder::Streamer.new(template)
+          else 
+            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
+            output
+          end
+        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/csv_builder/transliterating_filter.rb

@@ -0,0 +1,23 @@
+#encoding: utf-8
+
+class CsvBuilder::TransliteratingFilter
+  # Transliterate into the required encoding if necessary
+  def initialize(faster_csv, input_encoding = 'UTF-8', output_encoding = 'LATIN1')
+    @faster_csv = faster_csv
+
+    # 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//TRANSLIT because it raises
+    # Iconv::IllegalSequence for some inputs
+    @iconv = Iconv.new("#{output_encoding}//TRANSLIT//IGNORE", input_encoding) if input_encoding != output_encoding
+  end
+
+  # Transliterate before passing to FasterCSV so that the right characters (e.g. quotes) get escaped
+  def <<(row)
+    @faster_csv << if @iconv then row.map { |value| @iconv.iconv(value.to_s) } else row end
+  end
+
+  alias :add_row :<<
+end

data/lib/csv_builder.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module CsvBuilder
+  if RUBY_VERSION.to_f >= 1.9
+    require 'csv'
+    CSV_LIB = CSV
+  else
+    require 'fastercsv'
+    CSV_LIB = FasterCSV
+  end
+end
+
+require 'action_view'
+require 'iconv'
+require 'csv_builder/transliterating_filter'
+require 'csv_builder/template_handler'
+require 'csv_builder/railtie'

data/rails/init.rb

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: csv_streamer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Econsultancy
+- Vidmantas Kabosis
+- Gabe da Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2157673820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157673820
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2157673320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157673320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157672840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *2157672840
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &2157672340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *2157672340
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2157671860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157671860
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2157671360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157671360
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2157670860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157670860
+description: CSV template handler for Rails.  Enables :format => 'csv' in controllers,
+  with templates of the form report.csv.csvbuilder.
+email: gabe@websaviour.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/csv_builder.rb
+- lib/csv_builder/railtie.rb
+- lib/csv_builder/template_handler.rb
+- lib/csv_builder/transliterating_filter.rb
+- rails/init.rb
+homepage: http://github.com/dasil003/csv_builder
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- iconv
+- Ruby 1.9.x or FasterCSV
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: CSV template handler for Rails
+test_files: []