csv_import 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+log
+spec/fake/public
+spec/fake/tmp

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 jarrett (https://github.com/jarrett)
+Copyright (c) 2010-2011 mobalean LLC
+
+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,43 @@
+# CsvImport
+
+This Rails plugin provides a controller method called each_csv_row and
+an accompanying helper called csv_form.
+
+By default, when each_csv_row is called, any exceptions raised in the
+block will be rescued. The rows that triggered the exceptions will
+then be displayed in a table as part of the output from csv_form.
+
+You can turn off rescuing by calling each_csv_row(false).
+
+Note that we have adapted this version to our needs for [Doorkeeper](http://www.doorkeeperhq.com/), and we welcome any additions to make it more generic.
+
+[ドアキーパー](http://www.doorkeeper.jp/)でも利用するので、日本語対応もできます！
+
+## Compatibility
+
+* Ruby 1.9
+* Rails 3
+
+## Usage
+
+    # app/controllers/members_controller.rb
+
+    class MembersController < ActionController::Base
+      include CsvImport
+
+      def create
+        each_csv_row do |row|
+          Member.create!(row)
+        end
+      end
+    end
+
+    # app/views/members/index.html.erb
+
+    <h1>Import Members</h1>
+
+    <%= csv_form members_path do %>
+
+      <!-- whatever you put in the optional
+      block will appear at the end of the form -->
+    <% end %>

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/app/helpers/csv_helper.rb

@@ -0,0 +1,12 @@
+require 'haml'
+module CsvHelper
+  # The optional block allows you to pass in extra HTML that will be inserted after the CSV form fields but before the submit button.
+  def csv_form(url_for_options = {}, &block)
+    if block_given?
+      other_html = capture(&block)
+    else
+      other_html = nil
+    end
+    render :partial => 'csv_import/csv', :locals => {:url_for_options => url_for_options, :other_html => other_html}
+  end
+end

data/app/views/csv_import/_csv.html.haml

@@ -0,0 +1,34 @@
+= form_tag url_for_options, {:multipart => true} do
+  %p
+    = I18n.t :upload_label, :scope => :csv_import
+    = file_field_tag 'csv'
+  %p
+    = check_box_tag :csv_ignore_unknown_columns, true, false
+    %label{:for => 'csv_ignore_unknown_columns'}= I18n.t :ignore_unknown_columns_label, :scope => :csv_import
+  %div.columns= other_html
+  %p= submit_tag I18n.t(:submit_button, :scope => :csv_import), :class => 'button'
+
+- if @rows_imported && ! @imported
+  %h2= I18n.t :import_faild, :scope => 'csv_import.errors'
+  - if @bad_csv
+    %p= I18n.t :bad_csv, :scope => 'csv_import.errors'
+  - else
+    %p= I18n.t :bad_rows, :scope => 'csv_import.errors', :bad_rows_length => @bad_rows.length, :rows_imported => @rows_imported
+    %p= I18n.t :exist_bad_rows, :scope => 'csv_import.errors'
+    - if @unknown_headers.any?
+      %h3= I18n.t :unknown_columns, :scope => 'csv_import.errors'
+      %p
+        = I18n.t :following_unknown_columns, :scope => 'csv_import.errors'
+        = @unknown_headers.map{|header| ""#{h(header)}""}.join(", ").html_safe
+
+    - if @bad_rows.any?
+      %h3= I18n.t :bad_rows_in_uploaded_csv, :scope => 'csv_import.errors'
+      - @headers = @bad_rows.first.headers
+      %table
+        %tr
+          - @headers.each do |field_name|
+            %th= field_name
+        - @bad_rows.each_with_index do |row, row_number|
+          %tr{:class => cycle('even', 'odd')}
+            - @headers.each do |field_name|
+              %td= row[field_name].to_s

data/config/locales/en.yml

@@ -0,0 +1,14 @@
+en:
+  csv_import:
+    upload_label: 'Upload CSV file:'
+    ignore_unknown_columns_label: 'Ignore all unknown columns in uploaded CSV'
+    submit_button: 'Import'
+
+    errors:
+      import_faild: 'Import Failed'
+      bad_csv: 'The uploaded file contained severe errors and could not be processed. Please make sure it is formatted correctly and contains headers.'
+      bad_rows: '%{bad_rows_length} rows failed to import. %{rows_imported} rows would have been imported successfully.'
+      exist_bad_rows: 'Anytime there are bad rows, the entire import gets cancelled. This is so that you can make corrections and re-run the import without manually rolling back the previous attempt.'
+      unknown_columns: 'Unknown columns in CSV'
+      following_unknown_columns: 'The following columns are not known: '
+      bad_rows_in_uploaded_csv: 'Bad rows in uploaded CSV'

data/config/locales/ja.yml

@@ -0,0 +1,14 @@
+ja:
+  csv_import:
+    upload_label: 'CSVファイルのアップロード：'
+    ignore_unknown_columns_label: 'アップロードされたCSVファイルに、不明な欄があった場合、無視する'
+    submit_button: 'インポート'
+
+    errors:
+      import_faild: 'インポートに失敗しました'
+      bad_csv: 'CSVファイルにエラーがあったため、アップロードに失敗しました。CSVのフォーマット、値などをご確認のうえ、再度アップロードお願いいたします。'
+      bad_rows: '%{bad_rows_length}列のインポートに失敗し、%{rows_imported}列のインポートに成功しました。'
+      exist_bad_rows: 'インポートに失敗した場合、全てのインポートはキャンセルされます。CSVファイルの修正後、再度アップロードしてください。'
+      unknown_columns: '不明な欄'
+      following_unknown_columns: '次の欄は不明です: '
+      bad_rows_in_uploaded_csv: '不正な列'

data/csv_import.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "csv_import/version"
+
+Gem::Specification.new do |s|
+  s.name        = "csv_import"
+  s.version     = CsvImport::VERSION
+  s.authors     = ["Paul McMahon"]
+  s.email       = ["paul@mobalean.com"]
+  s.homepage    = "http://www.mobalean.com"
+  s.summary     = %q{Easy CSV importing in Rails}
+  s.description = %q{Use this Rails 3 plugin to easily import data via csv files}
+
+  s.rubyforge_project = "csv_import"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rails', '~> 3.0'
+  s.add_dependency 'haml', '~> 3.1'
+
+  s.add_development_dependency 'rspec', '~> 2.5.0'
+  s.add_development_dependency 'steak'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'launchy'
+end

data/lib/csv_import.rb

@@ -0,0 +1,55 @@
+require 'csv'
+require 'rails'
+
+# Include this in a controller
+module CsvImport
+  class Engine < Rails::Engine
+  end
+  DEFAULT_PARSE_OPTS = { :headers => true, :header_converters => :symbol }
+
+  private
+
+  def each_csv_row(opts = {})
+    @rows_imported = 0
+    @bad_csv = false
+    @bad_rows = []
+    @unknown_headers = Set.new
+    @imported = false
+
+    if request.post?
+      ActiveRecord::Base.transaction do
+        ::Rails.logger.info("starting csv import")
+        valid_headers = opts.delete(:valid_headers)
+
+        begin
+          CSV.parse(params[:csv].read.force_encoding("UTF-8"), DEFAULT_PARSE_OPTS.merge(opts)) do |row|
+            begin
+              row_data = row.to_hash
+              if valid_headers
+                row_data.delete_if {|header, value| ! valid_headers.include?(header) }
+                @unknown_headers.merge(row.headers - row_data.keys)
+              end
+              obj = yield row_data
+              obj.save! if obj && (obj.new_record? || obj.changed?)
+              @rows_imported += 1
+            rescue ActiveRecord::ActiveRecordError, ActiveRecord::UnknownAttributeError => e
+              row[:error] = e
+              @bad_rows << row
+            end
+          end
+
+          if @bad_rows.empty? && (@unknown_headers.empty? || params[:csv_ignore_unknown_columns])
+            @imported = true
+          end
+        rescue => e
+          @bad_csv = true
+        end
+
+        unless @imported
+          ::Rails.logger.info("rolling back csv import, contained errors")
+          raise ActiveRecord::Rollback
+        end
+      end
+    end
+  end
+end

data/lib/csv_import/version.rb

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

data/spec/csv_import_spec.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+require "spec_helper"
+
+feature "import csv" do
+  scenario "with only ascii" do
+    visit members_path
+    attach_file 'csv', File.join(File.dirname(__FILE__), 'fixtures/ascii.csv')
+    click_button "Import"
+    page.find("td:first").text.should == "Paul McMahon"
+    page.find("td:last").text.should == "paul@mobalean.com"
+  end
+
+  scenario "with only utf-8" do
+    visit members_path
+    attach_file 'csv', File.join(File.dirname(__FILE__), 'fixtures/utf-8.csv')
+    click_button "Import"
+    page.find("td:first").text.should == "ポール"
+    page.find("td:last").text.should == "paul@mobalean.com"
+  end
+end

data/spec/fake/app.rb

@@ -0,0 +1,27 @@
+require 'rails'
+require 'active_record'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+app = Class.new(Rails::Application)
+app.config.root = File.dirname(__FILE__)
+app.config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+app.config.session_store :cookie_store, :key => "_myapp_session"
+app.config.active_support.deprecation = :log
+app.config.action_dispatch.show_exceptions = false
+
+app.initialize!
+
+app.routes.draw do
+  resources :members
+end
+Class.new(ActiveRecord::Migration) do
+  def self.up
+    create_table(:members) {|t| t.string :email; t.string :name }
+    add_index :members, :email, :unique => true
+  end
+end.up
+

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

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/fake/app/controllers/members_controller.rb

@@ -0,0 +1,15 @@
+class MembersController < ApplicationController
+  include CsvImport
+  def index
+    @members = Member.all
+  end
+  def create
+    each_csv_row do |row|
+      email = row[:email].to_s.strip
+      Member.find_or_create_by_email(email).tap do |member|
+        member.update_attributes!(row)
+      end
+    end
+    redirect_to action: :index
+  end
+end

data/spec/fake/app/models/member.rb

@@ -0,0 +1,2 @@
+class Member < ActiveRecord::Base
+end

data/spec/fake/app/views/members/index.html.haml

@@ -0,0 +1,9 @@
+= csv_form members_path
+%table
+  %tr
+    %th Name
+    %th Email
+  - @members.each do |member|
+    %tr
+      %td= member.name
+      %td= member.email

data/spec/fixtures/ascii.csv

@@ -0,0 +1,2 @@
+name,email
+Paul McMahon,paul@mobalean.com

data/spec/fixtures/utf-8.csv

@@ -0,0 +1,2 @@
+name,email
+ポール,paul@mobalean.com

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'csv_import'
+require File.expand_path(File.dirname(__FILE__) + "/fake/app")
+
+require "steak"
+require 'capybara/rspec'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+require 'rspec/rails'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: csv_import
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul McMahon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2156048980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156048980
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &2156045560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156045560
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156044420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156044420
+- !ruby/object:Gem::Dependency
+  name: steak
+  requirement: &2156043400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156043400
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2156042300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156042300
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: &2156041660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156041660
+description: Use this Rails 3 plugin to easily import data via csv files
+email:
+- paul@mobalean.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/csv_helper.rb
+- app/views/csv_import/_csv.html.haml
+- config/locales/en.yml
+- config/locales/ja.yml
+- csv_import.gemspec
+- lib/csv_import.rb
+- lib/csv_import/version.rb
+- spec/csv_import_spec.rb
+- spec/fake/app.rb
+- spec/fake/app/controllers/application_controller.rb
+- spec/fake/app/controllers/members_controller.rb
+- spec/fake/app/models/member.rb
+- spec/fake/app/views/members/index.html.haml
+- spec/fixtures/ascii.csv
+- spec/fixtures/utf-8.csv
+- spec/spec_helper.rb
+homepage: http://www.mobalean.com
+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: csv_import
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Easy CSV importing in Rails
+test_files:
+- spec/csv_import_spec.rb
+- spec/fake/app.rb
+- spec/fake/app/controllers/application_controller.rb
+- spec/fake/app/controllers/members_controller.rb
+- spec/fake/app/models/member.rb
+- spec/fake/app/views/members/index.html.haml
+- spec/fixtures/ascii.csv
+- spec/fixtures/utf-8.csv
+- spec/spec_helper.rb