csv_export 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sergey Pchelincev
+
+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,35 @@
+# CsvExport
+
+Painless csv export in Ruby on Rails
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'csv_export'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv_export
+
+## Usage
+
+  That gem provide `export_to_csv(filename, content, [options = {}])` method in your controller.
+
+- *filename* - String, which define output file's name. NOTE: method doesn't add ".csv" extention automaticly
+- *content* - Items' enumerable. By default expected that item is some kind of array. If item responds to "to_csv_row", gem will use it. Also if item isn't array and doesn't have "to_csv_row" it will wrap item in to the array
+- *options* - Optional argument. Expects it will be some kind of hash. Processed keys:
+    - :separator - sets custom separator(by default is ",")
+    - :headers - sets header row. Expected array with columns' names
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+task :default => :test

data/csv_export.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/csv_export/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sergey Pchelincev"]
+  gem.email         = ["jalkoby91@gmail.com"]
+  gem.description   = %q{Painless csv export in Ruby on Rails}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/jalkoby/csv_export"
+
+  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.name          = "csv_export"
+  gem.require_paths = ["lib"]
+  gem.version       = CsvExport::VERSION
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'actionpack'
+  gem.add_dependency 'fastercsv', '1.5.5'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'debugger' if RUBY_VERSION =~ /1.9/
+end

data/lib/csv_export.rb

@@ -0,0 +1,13 @@
+require 'active_support'
+
+module CsvExport
+
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include CsvExport::Base
+end

data/lib/csv_export/base.rb

@@ -0,0 +1,39 @@
+module CsvExport
+  if RUBY_VERSION =~ /1.8/
+    require 'fastercsv'
+    CSV = FasterCSV
+  else
+    require 'csv'
+  end
+
+  module Base
+
+    private
+
+    def export_to_csv(filename, content, options = {})
+      csv_options = {}
+      csv_options[:col_sep] = options[:separator] || ','
+      headers = options[:headers]
+      csv_options[:headers] = headers.present?
+
+      data = CSV.generate(csv_options) do |csv_data|
+        csv_data << headers if csv_options[:headers]
+
+        content.each do |item|
+          case
+          when item.respond_to?(:to_csv_row)
+            csv_data << item.to_csv_row
+          when item.respond_to?(:to_a)
+            csv_data << item.to_a
+          else
+            csv_data << [item]
+          end
+        end
+      end
+
+      send_data(data, :filename => filename,:type => 'text/csv')
+    end
+
+  end
+
+end

data/lib/csv_export/version.rb

@@ -0,0 +1,3 @@
+module CsvExport
+  VERSION = "0.0.1"
+end

data/test/csv_export_test.rb

@@ -0,0 +1,91 @@
+if RUBY_VERSION =~ /1.8/
+  require 'test/unit'
+end
+
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'action_controller'
+require 'action_dispatch'
+require 'csv_export'
+
+SharedTestRoutes = ActionDispatch::Routing::RouteSet.new
+SharedTestRoutes.draw do
+  get ':controller(/:action)'
+end
+
+class CsvExportTest < ActionController::TestCase
+  include ActionDispatch::TestProcess
+
+  class TestController < ActionController::Base
+    include SharedTestRoutes.url_helpers
+    include SharedTestRoutes.mounted_helpers
+
+    def export_base
+      content = 5.times.map { |i| 3.times.map { |j| i * j } }
+      export_to_csv 'test.csv', content
+    end
+
+    def export_csv_rows
+      content = 2.times.map do
+        item = MiniTest::Mock.new
+        item.expect :to_csv_row, [1, 2, 3]
+        item
+      end
+      export_to_csv 'test.csv', content
+    end
+
+    def export_with_options
+      content = [[ 1, 2, 3]]
+      export_to_csv 'foo', content, :headers => ['One', 'Two', 'Three'], :separator => ";"
+    end
+
+    def export_slim_array
+      content = [2, 3]
+      export_to_csv 'slim', content
+    end
+
+  end
+
+  tests TestController
+
+  setup do
+    @routes = SharedTestRoutes
+  end
+
+  def test_header_response
+    get :export_base
+
+    assert_equal 200, @response.status
+    assert_equal 'text/csv', @response.content_type
+    assert @response.headers['Content-Disposition'].include?('test.csv')
+  end
+
+  def test_base_content
+    get :export_base
+
+    assert_equal 5, @response.body.lines.count
+    assert_equal "0,0,0\n", @response.body.lines.to_a[0]
+    assert_equal "0,4,8\n", @response.body.lines.to_a[-1]
+  end
+
+  def test_using_csv_rows
+    get :export_csv_rows
+
+    assert_equal "1,2,3\n", @response.body.lines.to_a[0]
+  end
+
+  def test_using_options
+    get :export_with_options
+
+    assert_equal "One;Two;Three\n", @response.body.lines.to_a[0]
+    assert_equal "1;2;3\n", @response.body.lines.to_a[1]
+  end
+
+  def test_slim_array_case
+    get :export_slim_array
+
+    assert_equal "2\n", @response.body.lines.to_a[0]
+    assert_equal "3\n", @response.body.lines.to_a[1]
+  end
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: csv_export
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergey Pchelincev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastercsv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Painless csv export in Ruby on Rails
+email:
+- jalkoby91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- csv_export.gemspec
+- lib/csv_export.rb
+- lib/csv_export/base.rb
+- lib/csv_export/version.rb
+- test/csv_export_test.rb
+homepage: https://github.com/jalkoby/csv_export
+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'
+      segments:
+      - 0
+      hash: 3626536889106548116
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3626536889106548116
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/csv_export_test.rb