csv_rb 0.5.2

data/lib/csv_rb/template_handler.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require 'stringio'
+
+module ActionView
+  class Template
+    module Handlers
+      class CSVRbBuilder
+
+        def default_format
+          Mime[:csv]
+        end
+
+        def call(template)
+          builder = StringIO.new
+          builder << "require 'csv';"
+          builder << "require 'csv_rb/plain_builder';"
+          builder << "csv ||= CSVRb::PlainBuilder.new;"
+          builder << template.source
+          builder << ";csv = csv.to_str if csv.is_a?(CSVRb::PlainBuilder); csv;"
+          builder.string
+        end
+
+        def handles_encoding?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/csv_rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CSVRb
+  VERSION = '0.5.2'
+end

data/lib/csv_rb.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CSVRb
+end
+
+require 'csv_rb/railtie' if defined?(Rails)

data/lib/tasks/csv_rb_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :csv_rb do
+#   # Task goes here
+# end

data/spec/ci.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+puts "Testing Rails 5"
+exit system('cd spec/dummy && bundle install --without debug && bundle exec rake db:create && bundle exec rake db:migrate && cd ../../ && bundle exec rspec spec')

data/spec/csv_rb_builder_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'csvrb template handler' do
+
+  AB = ActionView::Template::Handlers::CSVRbBuilder
+  VT = Struct.new(:source, :locals)
+
+  let( :handler ) { AB.new }
+
+  let( :template ) do
+    src = <<-RUBY
+      csv << ['TEST', 'STUFF']
+    RUBY
+    VT.new(src, [])
+  end
+
+  context "Rails #{Rails.version}" do
+    # for testing if the author is set
+    # before do
+      # Rails.stub_chain(:application, :config, :csvrb_author).and_return( 'Elmer Fudd' )
+    # end
+
+    it "has csv format" do
+      expect(handler.default_format).to eq(mime_type)
+    end
+
+    it "compiles to an csv spreadsheet" do
+      csv = nil
+      eval( AB.new.call template )
+      expect{ csv = CSV.parse(csv) }.to_not raise_error
+      expect(csv[0][0]).to eq('TEST')
+    end
+
+    #TODO:
+    # Test if author field is set - does roo parse that?
+  end
+end

data/spec/csv_rb_mailer_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe "Mailer", type: :request do
+  before :each do
+    @user = User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+  end
+
+  it "attaches an csv file" do
+    visit "/users/#{@user.id}/send_instructions"
+    last_email = ActionMailer::Base.deliveries.last
+    expect(last_email.to).to eq([@user.email])
+    expect(last_email.attachments.first).to be
+    expect(last_email.attachments.first.content_type).to match(/#{mime_type}/)
+  end
+end

data/spec/csv_rb_renderer_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require'spec_helper'
+
+describe 'csvrb renderer' do
+
+  it "is registered" do
+    ActionController::Renderers::RENDERERS.include?(:csv)
+  end
+
+  it "has mime type" do
+    mime = mime_type
+  	expect(mime).to be
+  	expect(mime.to_sym).to eq(:csv)
+  	expect(mime.to_s).to eq("text/csv")
+  end
+
+end

data/spec/csv_rb_request_spec.rb

@@ -0,0 +1,220 @@
+# encoding: utf-8
+
+class Encoder
+    def initialize(str)
+      @str = str
+    end
+
+    def to_utf8
+      return @str if is_utf8?
+      encoding = find_encoding
+      @str.force_encoding(encoding).encode('utf-8', invalid: :replace, undef: :replace)
+    end
+
+    def find_encoding
+      puts 'utf-8' if is_utf8?
+      return 'utf-8' if is_utf8?
+      puts 'iso-8859-1' if is_iso8859?
+      return 'iso-8859-1' if is_iso8859?
+      puts 'Windows-1252' if is_windows?
+      return 'Windows-1252' if is_windows?
+      raise ArgumentError.new "Invalid Encoding"
+    end
+
+    def is_utf8?
+      is_encoding?(Encoding::UTF_8)
+    end
+
+    def is_iso8859?
+      is_encoding?(Encoding::ISO_8859_1)
+    end
+
+    def is_windows?(str)
+      is_encoding?(Encoding::Windows_1252)
+    end
+
+    def is_encoding?(encoding_check)
+      case @str.encoding
+      when encoding_check
+        @str.valid_encoding?
+      when Encoding::ASCII_8BIT, Encoding::US_ASCII
+        @str.dup.force_encoding(encoding_check).valid_encoding?
+      else
+        false
+      end
+    end
+  end
+
+require 'spec_helper'
+describe 'csv_rb request', :type => :request do
+
+  after(:each) do
+    if File.exists? '/tmp/csvrb_temp.csv'
+      File.unlink '/tmp/csvrb_temp.csv'
+    end
+  end
+
+  it "has a working dummy app" do
+    @user1 = User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+    visit '/'
+    expect(page).to have_content("Hey, you")
+  end
+
+  it "downloads an csv file from default respond_to" do
+    visit '/home.csv'
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/csvrb_temp.csv', 'w') {|f| f.write(page.source) }
+    csv = nil
+    expect{ csv = Roo::CSV.new('/tmp/csvrb_temp.csv') }.to_not raise_error
+    expect(csv.cell(1,1)).to eq('Bad')
+  end
+
+  it "downloads an csv file from respond_to while specifying filename" do
+    visit '/useheader.csv'
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.csv\"")
+  end
+
+  it "downloads an csv file from respond_to while specifying filename in direct format" do
+    visit '/useheader.csv?set_direct=true'
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.csv\"")
+
+    File.open('/tmp/csvrb_temp.csv', 'w') {|f| f.write(page.source) }
+    csv = nil
+    expect{ csv = Roo::CSV.new('/tmp/csvrb_temp.csv') }.to_not raise_error
+    expect(csv.cell(1,1)).to eq('Bad')
+  end
+
+  it "downloads an csv file from render statement with filename" do
+    visit '/another.csv'
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.csv\"")
+  end
+
+  it "downloads an csv file from as_csv model" do
+    User.destroy_all
+    @user1 = User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+    @user2 = User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    visit '/users.csv'
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/csvrb_temp.csv', 'w') {|f| f.write(page.source) }
+    csv = nil
+    expect{ csv = Roo::CSV.new('/tmp/csvrb_temp.csv') }.to_not raise_error
+    expect(csv.cell(1,1)).to eq('Elmer')
+    expect(csv.cell(2,1)).to eq('Bugs')
+  end
+
+  it "downloads an csv file with partial" do
+    visit '/withpartial.csv'
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/csvrb_temp.csv', 'w') {|f| f.write(page.source) }
+    csv = nil
+    expect{ csv = Roo::CSV.new('/tmp/csvrb_temp.csv') }.to_not raise_error
+    expect(csv.cell(1,1,csv.sheets[0])).to eq('Cover')
+    expect(csv.cell(2,1,csv.sheets[1])).to eq("Bad")
+  end
+
+  it "handles nested resources" do
+    User.destroy_all
+    @user = User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    @user.likes.create(:name => 'Carrots')
+    @user.likes.create(:name => 'Celery')
+    visit "/users/#{@user.id}/likes.csv"
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/csvrb_temp.csv', 'w') {|f| f.write(page.source) }
+    csv = nil
+    expect{ csv = Roo::CSV.new('/tmp/csvrb_temp.csv') }.to_not raise_error
+    expect(csv.cell(1,1)).to eq('Bugs')
+    expect(csv.cell(2,1)).to eq('Carrots')
+    expect(csv.cell(3,1)).to eq('Celery')
+  end
+
+  it "handles reference to absolute paths" do
+    User.destroy_all
+    @user = User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    visit "/users/#{@user.id}/render_elsewhere.csv"
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    [[1,false],[3,true],[4,true],[5,false]].reverse.each do |s|
+      visit "/home/render_elsewhere.csv?type=#{s[0]}"
+      expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    end
+  end
+
+  it "uses respond_with" do
+    User.destroy_all
+    @user = User.create name: 'Responder', last_name: 'Bunny', address: '1234 Right Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    expect {
+      visit "/users/#{@user.id}.csv"
+    }.to_not raise_error
+    File.open('/tmp/csvrb_temp.csv', 'w') {|f| f.write(page.source) }
+    csv = nil
+    expect{ csv = Roo::CSV.new('/tmp/csvrb_temp.csv') }.to_not raise_error
+    expect(csv.cell(1,1)).to eq('Bad')
+  end
+
+  it "ignores layout" do
+    User.destroy_all
+    @user = User.create name: 'Responder', last_name: 'Bunny', address: '1234 Right Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    expect {
+      visit "/users/export/#{@user.id}.csv"
+    }.to_not raise_error
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"export_#{@user.id}.csv\"")
+  end
+
+  it "handles missing format with render :csv" do
+    visit '/another'
+
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    expect(page.response_headers['Content-Disposition']).to include("filename=\"filename_test.csv\"")
+    # csv.cell(2,1).should == 'Bad'
+  end
+
+  Capybara.register_driver :mime_all do |app|
+    Capybara::RackTest::Driver.new(app, headers: { 'HTTP_ACCEPT' => '*/*' })
+  end
+
+  def puts_def_formats(title)
+    puts "default formats #{title.ljust(30)}: #{ActionView::Base.default_formats}"
+  end
+
+  it "mime all with render :csv and then :html" do
+    # puts_def_formats 'before'
+    ActionView::Base.default_formats.delete :csv # see notes
+    # puts_def_formats 'in my project'
+    Capybara.current_driver = :mime_all
+    visit '/another'
+    # puts_def_formats 'after render csv with */*'
+    expect{
+      visit '/home/only_html'
+    }.to_not raise_error
+    ActionView::Base.default_formats.push :csv # see notes
+
+    # Output:
+    # default formats before                        : [:html, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip, :csv]
+    # default formats in my project                 : [:html, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip]
+    # default formats after render csv with */*    : [:csv, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip]
+
+    # Failure/Error: visit '/home/only_html'
+    # ActionView::MissingTemplate:
+    #   Missing template home/only_html, application/only_html with {:locale=>[:en], :formats=>[:csv, :text, :js, :css, :ics, :csv, :vcf, :png, :jpeg, :gif, :bmp, :tiff, :mpeg, :xml, :rss, :atom, :yaml, :multipart_form, :url_encoded_form, :json, :pdf, :zip], :variants=>[], :handlers=>[:erb, :builder, :raw, :ruby, :csvrb]}.
+  end
+
+  it "downloads an csv file when there is no action" do
+    User.destroy_all
+    @user1 = User.create name: 'Elmer', last_name: 'Fudd', address: '1234 Somewhere, Over NY 11111', email: 'elmer@fudd.com'
+    @user2 = User.create name: 'Bugs', last_name: 'Bunny', address: '1234 Left Turn, Albuquerque NM 22222', email: 'bugs@bunny.com'
+    visit '/users/noaction.csv'
+    expect(page.response_headers['Content-Type']).to eq(mime_type.to_s + "; charset=utf-8")
+    File.open('/tmp/csvrb_temp.csv', 'w') {|f| f.write(page.source) }
+    csv = nil
+    expect{ csv = Roo::CSV.new('/tmp/csvrb_temp.csv') }.to_not raise_error
+    expect(csv.cell(1,1)).to eq('Elmer')
+    expect(csv.cell(2,1)).to eq('Bugs')
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+#---
+# Excerpted from "Crafting Rails Applications",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material,
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose.
+# Visit http://www.pragmaticprogrammer.com/titles/jvrails for more book information.
+#---
+class HomeController < ApplicationController
+  def index
+    respond_to do |format|
+      format.html
+      format.csv
+    end
+  end
+
+  def only_html; end
+
+  def another
+    render :csv => "index", :filename => "filename_test.csv"
+  end
+
+  def render_elsewhere
+    case params[:type]
+    when '1'
+      render :csv => "home/index", :template => 'users/index'
+    when '2'
+      render :csv => "users/index", :template => 'users/index'
+    when '3'
+      render template: "users/index"
+    when '4'
+      render "users/index"
+    else
+      render :csv => "index"
+    end
+  end
+
+  def render_file_path
+    render :csv => Rails.root.join('app','views','users','index')
+  end
+
+  def withpartial
+  end
+
+  def useheader
+    respond_to do |format|
+      format.csv {
+        if params[:set_direct]
+          response.headers['Content-Disposition'] = "attachment; filename=\"filename_test.csv\""
+        else
+          render csv: "useheader", filename: "filename_test.csv"
+        end
+      }
+    end
+  end
+end

data/spec/dummy/app/controllers/likes_controller.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+class LikesController < ApplicationController
+  # GET /likes
+  # GET /likes.json
+  def index
+    @user = User.find(params[:user_id])
+    @likes = @user.likes
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.csv
+    end
+  end
+
+  def render_elsewhere
+    @user = User.find(params[:user_id])
+    render :csv => "index", :template => 'users/index'
+  end
+end

data/spec/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+class UsersController < ApplicationController
+  respond_to :csv, :html
+  layout Proc.new { |c| return (c.request.format.symbol == :csv ? false : :default )}
+
+  # GET /users
+  # GET /users.json
+  def index
+    @users = User.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.csv
+    end
+  end
+
+  def show
+    @user = User.find(params[:id])
+    respond_with(@user) do |format|
+      format.csv { render "respond_with.csv.csvrb" }
+    end
+  end
+
+  def send_instructions
+    @user = User.find(params[:user_id])
+    @user.send_instructions
+    render plain: "Email sent"
+  end
+
+  def export
+    @user = User.find(params[:id])
+    respond_to do |format|
+      format.csv do
+        render csv: "export", filename: "export_#{@user.id}"
+      end
+    end
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/mailers/notifier.rb

@@ -0,0 +1,14 @@
+class Notifier < ActionMailer::Base
+  default :from => 'noreply@company.com'
+
+  def instructions(user)
+    @user = user
+
+    # normal syntax
+    csv = render_to_string handlers: [:csvrb], template: 'users/send_instructions', layout: false, formats: [:csv]
+    attachments["user_#{user.id}.csv"] = {mime_type: Mime[:csv], content: csv}
+
+    mail :to => user.email, :subject => 'Instructions'
+  end
+
+end

data/spec/dummy/app/models/like.rb

@@ -0,0 +1,3 @@
+class Like < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,24 @@
+class User < ActiveRecord::Base
+  has_many :likes
+
+  def self.to_csv(enum)
+    all.each do |user|
+      enum << user.to_csv
+		end
+  end
+
+  def send_instructions
+    Notifier.instructions(self).deliver
+  end
+
+  def to_csv
+    [
+      self.name,
+      self.last_name,
+      self.address,
+      self.email,
+      self.created_at.to_s,
+      self.updated_at.to_s
+    ]
+  end
+end

data/spec/dummy/app/views/home/_cover_sheet.csv.csvrb

@@ -0,0 +1 @@
+csv << ['Cover', 'Sheet']

data/spec/dummy/app/views/home/index.csv.csvrb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+csv << ['Bad', 'spellers', 'of', 'the', 'world', '...']

data/spec/dummy/app/views/home/index.html.erb

@@ -0,0 +1,4 @@
+<p>Hey, you can download the csv for this page by clicking the link below:</p>
+<p><%= link_to "csv", home_path("csv") %></p>
+<p><%= link_to "Another", '/another.csv' %></p>
+<p><%= link_to "User header", '/useheader.csv' %></p>

data/spec/dummy/app/views/home/only_html.html.erb

@@ -0,0 +1,2 @@
+<h3>HTML</h3>
+<p>Foo, bar</p>

data/spec/dummy/app/views/home/useheader.csv.csvrb

@@ -0,0 +1 @@
+csv << ['Bad', 'spellers', 'of', 'the', 'world', '...']

data/spec/dummy/app/views/home/withpartial.csv.csvrb

@@ -0,0 +1,2 @@
+render :partial => 'cover_sheet', :locals => {:csv => csv}
+csv << ['Bad', 'spellers', 'of', 'the', 'world', '...']

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy 4</title>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/layouts/users.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy 4</title>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/likes/index.csv.csvrb

@@ -0,0 +1,4 @@
+csv << [@user.name]
+@likes.each do |like|
+  csv << [like.name]
+end

data/spec/dummy/app/views/likes/index.html.erb

@@ -0,0 +1,17 @@
+<h1>Listing likes for <%= @user.name %></h1>
+
+<table>
+  <tr>
+    <th>Name</th>
+  </tr>
+
+<% @likes.each do |like| %>
+  <tr>
+    <td><%= like.name %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Like', new_like_path %>

data/spec/dummy/app/views/notifier/instructions.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <h1>Instructions</h1>
+    <p>
+      You have successfully signed up to example.com,
+      your username is: <%= @user.email %>.<br/>
+    </p>
+    <p>Thanks for joining and have a great day!</p>
+  </body>
+  </html>