rendered_csv 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sublime*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rendered_csv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David van Geest
+
+MIT License
+
+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,52 @@
+# RenderedCsv
+
+RenderedCsv provides a `render_csv` method to your Rails 3.0+ controllers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rendered_csv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rendered_csv
+
+## Usage
+
+In your controllers, simply call `render_csv` instead of `render`.  This will setup the appropriate headers and render your CSV file.
+
+`render_csv` has two optional parameters, `filename` and `template`.  If not specified, `filename` defaults to the name of the current action.
+
+This example would respond with a file named `widgets.csv`, rendering the `index` template in the process:
+
+    class WidgetsController < ApplicationController
+      def index
+        @widgets = Widget.all
+        respond_to do |format|
+          format.csv do
+            render_csv('widgets')
+          end
+        end
+      end
+    end
+
+You could render a different template: `render_csv('widgets', 'other_index')`
+
+Or you could just use the defaults to get `index.csv` from the `index` template: `render_csv`
+
+## Acknowledgements
+
+The meat of this gem was taken from [Clinton R. Nixon's](http://stackoverflow.com/users/6262/clinton-r-nixon) answer to this [StackOverflow question](http://stackoverflow.com/questions/94502/in-rails-how-to-return-records-as-a-csv-file).  I just wanted to stop copy-pasting the code from project to project.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/rendered_csv.rb

@@ -0,0 +1,3 @@
+require "rendered_csv/version"
+require "rendered_csv/controller"
+require 'rendered_csv/railtie' if defined?(Rails)

data/lib/rendered_csv/controller.rb

@@ -0,0 +1,30 @@
+require 'active_support'
+
+module RenderedCsv
+  module Controller
+    extend ActiveSupport::Concern
+
+    def render_csv(filename = nil, template = nil)
+      filename ||= params[:action]
+      filename += '.csv'
+
+      if request.env['HTTP_USER_AGENT'] =~ /msie/i
+        headers['Pragma'] = 'public'
+        headers["Content-Type"] = "text/plain"
+        headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'
+        headers['Content-Disposition'] = "attachment; filename=\"#{filename}\""
+        headers['Expires'] = "0"
+      else
+        headers["Content-Type"] ||= 'text/csv'
+        headers["Content-Disposition"] = "attachment; filename=\"#{filename}\""
+      end
+
+      if template.nil?
+        render :layout => false
+      else
+        render template, :layout => false
+      end
+    end
+
+  end
+end

data/lib/rendered_csv/railtie.rb

@@ -0,0 +1,9 @@
+module RenderedCsv
+  class Railtie < Rails::Railtie
+    initializer "rendered_csv.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include RenderedCsv::Controller # ActiveSupport::Concern
+      end
+    end
+  end
+end

data/lib/rendered_csv/version.rb

@@ -0,0 +1,3 @@
+module RenderedCsv
+  VERSION = "0.1.0"
+end

data/rendered_csv.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rendered_csv/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rendered_csv"
+  gem.version       = RenderedCsv::VERSION
+  gem.authors       = ["SpinDance, Inc."]
+  gem.email         = ["rubygems@spindance.com"]
+  gem.description   = %q{Adds a render_csv to your Rails 3.0+ controllers}
+  gem.summary       = %q{Takes care of setting headers, naming your CSV file, and rendering a desired template}
+  gem.homepage      = "https://github.com/spindance/rendered_csv"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rails', '>= 3.0.0'
+  gem.add_development_dependency 'mocha', '~> 0.13.1'
+end

data/spec/lib/rendered_csv/controller_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+require 'rendered_csv/controller'
+
+describe RenderedCsv::Controller do
+  before do
+    @controller = Object.new
+    @controller.extend(RenderedCsv::Controller)
+  end
+
+  describe 'when asked to render a CSV file' do
+    before do
+      @request = mock()
+      @env = mock()
+      @request.stubs(:env).returns(@env)
+      @env.stubs('[]')
+      @controller.stubs(:request).returns(@request)
+
+      @headers = mock()
+      @headers.stubs('[]')
+      @headers.stubs('[]=')
+      @controller.stubs(:headers).returns(@headers)
+    end
+    describe 'with a template' do
+      it 'should render the correct template' do
+        @controller.expects(:render).with('index', {:layout => false})
+        @controller.render_csv('widgets', 'index')
+      end
+    end
+    describe 'without a template' do
+      it 'should render' do
+        @controller.expects(:render).with({:layout => false})
+        @controller.render_csv('widgets')
+      end
+    end
+  end
+
+  describe 'when asked to render a CSV file' do
+    before do
+      @request = mock()
+      @env = mock()
+      @request.stubs(:env).returns(@env)
+      @env.stubs('[]')
+      @controller.stubs(:request).returns(@request)
+
+      @headers = mock()
+      @headers.stubs('[]')
+      @headers.stubs('[]=')
+      @controller.stubs(:headers).returns(@headers)
+
+      @controller.stubs(:render)
+    end
+    describe 'with a filename' do
+      it 'should set the filename in the header' do
+        @headers.expects('[]=').with("Content-Disposition", "attachment; filename=\"widgets.csv\"")
+        @controller.render_csv('widgets')
+      end
+    end
+    describe 'without a filename' do
+      it 'should set the filename in the header' do
+        @controller.expects(:params).returns({:action => 'index'})
+        @headers.expects('[]=').with("Content-Disposition", "attachment; filename=\"index.csv\"")
+        @controller.render_csv
+      end
+    end
+  end
+
+  describe 'when asked to render a CSV file' do
+    before do
+      @controller.stubs(:params).returns({:action => 'index'})
+
+      @request = mock()
+      @env = mock()
+      @request.stubs(:env).returns(@env)
+      @env.stubs('[]')
+      @controller.stubs(:request).returns(@request)
+
+      @headers = mock()
+      @headers.stubs('[]')
+      @headers.stubs('[]=').with("Content-Disposition", "attachment; filename=\"index.csv\"")
+      @controller.stubs(:headers).returns(@headers)
+
+      @controller.stubs(:render)
+    end
+    describe 'with Content-Type already set' do
+      it 'should not set the Content-Type in the header' do
+        @headers.expects('[]').with("Content-Type").returns('application/csv')
+        @controller.render_csv
+      end
+    end
+    describe 'with Content-Type not set' do
+      it 'should set the Content-Type in the header' do
+        @headers.expects('[]=').with("Content-Type", 'text/csv')
+        @controller.render_csv
+      end
+    end
+  end
+
+  describe 'when asked to render a CSV file' do
+    before do
+      @controller.stubs(:params).returns({:action => 'index'})
+
+      @request = mock()
+      @env = mock()
+      @request.stubs(:env).returns(@env)
+      @controller.stubs(:request).returns(@request)
+
+      @headers = mock()
+      @controller.stubs(:headers).returns(@headers)
+
+      @controller.stubs(:render)
+    end
+    describe 'for IE browser' do
+      before do
+        @env.stubs('[]').with('HTTP_USER_AGENT').returns('msie')
+      end
+      it 'should set the correct headers' do
+        @headers.expects('[]=').with("Pragma", 'public')
+        @headers.expects('[]=').with("Content-Type", "text/plain")
+        @headers.expects('[]=').with("Cache-Control", 'no-cache, must-revalidate, post-check=0, pre-check=0')
+        @headers.expects('[]=').with("Content-Disposition", "attachment; filename=\"index.csv\"")
+        @headers.expects('[]=').with("Expires", '0')
+        @controller.render_csv
+      end
+    end
+    describe 'for non-IE browser' do
+      before do
+        @env.stubs('[]').with('HTTP_USER_AGENT').returns('mozilla')
+        @headers.stubs('[]').returns(nil)
+      end
+      it 'should set the correct headers' do
+        @headers.expects('[]=').with("Content-Type", "text/csv")
+        @headers.expects('[]=').with("Content-Disposition", "attachment; filename=\"index.csv\"")
+        @controller.render_csv
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require "mocha/setup"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rendered_csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- SpinDance, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: Adds a render_csv to your Rails 3.0+ controllers
+email:
+- rubygems@spindance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rendered_csv.rb
+- lib/rendered_csv/controller.rb
+- lib/rendered_csv/railtie.rb
+- lib/rendered_csv/version.rb
+- rendered_csv.gemspec
+- spec/lib/rendered_csv/controller_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spindance/rendered_csv
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Takes care of setting headers, naming your CSV file, and rendering a desired
+  template
+test_files:
+- spec/lib/rendered_csv/controller_spec.rb
+- spec/spec_helper.rb