csv_rails 0.6.1 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abca01f38995c646411bf71c5194c44761f581ab
+  data.tar.gz: 0802df4b50d7487420c7f642154834a087675b98
+SHA512:
+  metadata.gz: 16d5d26847e86645c93d3a5f16885a91409c4a6e14a5b6360908510a0e607771f94cdfde8632d16eb297cebd1e78a9364ab78279c26b1d273d2019a77783350a
+  data.tar.gz: 6de4e32ec224e341b2f867ffe45d9c798e69654bf78e741925f7515f2f0ac401c9dc75ed7b23f78267f09a35d939cc1fdcce8a30a12bab9822032cd9da2d9ef9

data/README.rdoc

@@ -33,6 +33,8 @@ to your Gemfile and then run
 
 == Usage
 
+=== Download
+
 If you want formatted attribute, CsvRails call "#{attribute}_as_csv". For example, you wish formatted created_at then you write like this. 
 
     class User < ActiveRecord::Base
@@ -77,11 +79,13 @@ If you do not use :header option, header is using :fields and I18n transfer.
             groups:
               first:
                 <<: *groupmodel
-          # edge rails
+          # rails 3.2.3 - 3.2.5
           user/groups:
             first:
               <<: *groupmodel
-
+          # rails 3.2.6 or higher
+          groups/first:
+            <<: *groupmodel
 
     # app/controllers/user_controller.rb
     def index
@@ -110,4 +114,61 @@ You also use i18n_scope option
 
     User.where("id < 1").all.to_csv(:i18n_scope => :csv) #=> "なまえ\n"
 
-Copyright (c) 2012 yalab, released under the MIT license
+=== Upload
+
+CSVRails is also have upload concern.
+
+You should include CSVRails::Import into your model.
+
+example
+
+    # app/model/user.rb
+    class User < ActiveRecord::Base
+      attr_accessor :file
+      include CsvRails::Import
+    ....
+
+And render file_field into form
+
+example
+
+    # app/views/users/index.html.erb
+
+    <%= form_for(@user, multipart: true) do |f| %>
+      File: <%= f.file_field :file %>
+      <%= f.submit 'Upload' %>
+    <% end %>
+
+Next implement action
+
+    # app/controllers/users_controller.rb
+
+    def create
+      if params[:format] == 'csv'
+        users = User.csv_import(params[:file])
+        if users.find{|u| u.errors.any? }
+          render :index
+        else
+          redirect_to users_path, notice: 'Upload success'
+        end
+      end
+    end
+
+csv_import is be able to use block.
+
+    User.csv_import(params[:file]) do |user, params, row_number|
+      next false if row_number == 2 # 'next false' in the block, the line is skipped.
+    end
+
+csv_import use transaction, if invalid line is existed then all rows is not imported.
+
+First line used for fields, but you can manually choose it using options
+
+    User.csv_import(params[:file], fields: [:age, :name])
+
+It line first line has 'id', csv_import call where(id: id).first_or_initialize, but you can use other field name
+
+    User.csv_import(params[:file], find_key: :name)
+    #=> It call User.where(name: name).first_or_initialize internal.
+
+Copyright (c) 2012-2013 yalab, released under the MIT license

data/lib/csv_rails.rb

@@ -1,5 +1,6 @@
 require 'csv_rails/array'
 require 'csv_rails/active_model'
+require 'csv_rails/import'
 
 Array.send(:include, CsvRails::Array)
 

data/lib/csv_rails/active_model.rb

@@ -5,7 +5,12 @@ module CsvRails
       def to_csv(opts={})
         fields = opts[:fields] || csv_fields
         header = csv_header(fields, opts.delete(:i18n_scope))
-        all.to_a.to_csv(opts.update(:fields => fields, :header => header))
+        all = if self.respond_to?(:to_a)
+                to_a
+              else
+                send(:all).to_a
+              end
+        all.to_csv(opts.update(:fields => fields, :header => header))
       end
 
       def csv_header(fields, scope=nil)

data/lib/csv_rails/import.rb

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+module CsvRails::Import
+  extend ActiveSupport::Concern
+  module ClassMethods
+    def inverse_human_attriute_name(attribute, options = {})
+      defaults  = options[:defaults] || []
+      parts     = attribute.to_s.split(".")
+      attribute = parts.pop
+      namespace = parts.join("/") unless parts.empty?
+
+      if defaults.blank?
+        if namespace
+          lookup_ancestors.each do |klass|
+            defaults << :"#{self.i18n_scope}.attributes.#{klass.model_name.i18n_key}/#{namespace}"
+          end
+          defaults << :"#{self.i18n_scope}.attributes.#{namespace}"
+        else
+          lookup_ancestors.each do |klass|
+            defaults << :"#{self.i18n_scope}.attributes.#{klass.model_name.i18n_key}"
+          end
+        end
+        defaults << :"attributes"
+      end
+      entry = nil
+      defaults.each do |k|
+        map = I18n.translate(k)
+        if map.is_a?(Hash)
+          entry = map.invert[attribute]
+          break
+        end
+      end
+      entry || attribute.underscore.gsub(/ /, '_')
+    end
+
+    def csv_import(body, opts={})
+      fields = opts.delete(:fields)
+      find_key = opts.has_key?(:find_key) ? opts.delete(:find_key) : :id
+      records = []
+      all_green = true
+      translated = false
+      self.transaction do
+        CSV.parse(body, opts).each.with_index do |row, i|
+          unless fields
+            fields = row
+            next
+          end
+          unless translated
+            fields.map!{|f| inverse_human_attriute_name(f)  }
+            translated = true
+          end
+          attributes = ActiveSupport::HashWithIndifferentAccess.new(Hash[fields.zip(row)])
+          record = if find_key
+                     self.where(:"#{find_key}" => attributes[find_key.to_s]).first_or_initialize
+                   else
+                     self.new
+                   end
+          record.attributes = attributes.select{|k, v| self.attribute_method?(k) }
+          if block_given?
+            val = yield record, attributes, i
+            next if val == false
+          end
+          if all_green && record.valid?
+            record.save!
+          else
+            all_green = false
+          end
+          records << record
+        end
+        raise ActiveRecord::Rollback unless all_green
+      end
+      records
+    end
+
+    def tsv_import(body, opts={}, &block)
+      csv_import(body, opts.merge(col_sep: "\t"), &block)
+    end
+  end
+end

data/lib/csv_rails/version.rb

@@ -1,3 +1,3 @@
 module CsvRails
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/test/csv_rails/active_record_test.rb

@@ -2,6 +2,7 @@
 require 'test_helper'
 class CsvRails::ActiveRecordTest < ActiveSupport::TestCase
   setup do
+    I18n.locale = :en
     @user = User.create(:name => 'yalab', :age => '29', :secret => 'password')
     @group = Group.create(:name => 'ruby')
     @user.groups << @group
@@ -95,6 +96,6 @@ class CsvRails::ActiveRecordTest < ActiveSupport::TestCase
   end
 
   test ".to_csv with row_sep option" do
-    assert_match /\r\n/, User.all.to_csv(:row_sep => "\r\n")
+    assert_match /\r\n/, User.all.to_a.to_csv(:row_sep => "\r\n")
   end
 end

data/test/csv_rails/array_test.rb

@@ -53,12 +53,12 @@ class CsvRails::ArrayTest < ActiveSupport::TestCase
   test ".to_csv only it includes Mongoid instance" do
     post = Post.create(:title => 'this is csv_rails', :body => "line\nline\nline\n")
 
-    assert_equal " type,\"\",タイトル,本文\n#{post._type},#{post._id},#{post.title},\"#{post.body}\"\n", [post].to_csv
+    assert_equal "\"\",タイトル,本文\n#{post._id},#{post.title},\"#{post.body}\"\n", [post].to_csv
   end
 
   test ".to_tsv only it includes Mongoid instance" do
     post = Post.create(:title => 'this is csv_rails', :body => "line\nline\nline\n")
 
-    assert_equal " type\t\"\"\tタイトル\t本文\n#{post._type}\t#{post._id}\t#{post.title}\t\"#{post.body}\"\n", [post].to_tsv
+    assert_equal "\"\"\tタイトル\t本文\n#{post._id}\t#{post.title}\t\"#{post.body}\"\n", [post].to_tsv
   end
 end

data/test/csv_rails/import_test.rb

@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+class CsvRails::ImportTest < ActiveSupport::TestCase
+  setup do
+    I18n.locale = :en
+    @users = [{id: 1, name: 'yoshida', age: 30, secret: 'password'},
+              {id: 2, name: 'yalab',   age: 3,  secret: 'password'}]
+    csv = <<-EOS.gsub(/^\s+/, '')
+      id,name,age,secret
+      #{@users[0].values.join(',')}
+      #{@users[1].values.join(',')}
+    EOS
+    @csv = StringIO.new(csv)
+  end
+
+  test "import IO" do
+    User.csv_import(@csv)
+    @users.each do |params|
+      user = User.find(params[:id])
+      params.each do |k, v|
+        assert_equal v, user[k]
+      end
+    end
+  end
+
+  test "import with block" do
+    name = 'test'
+    User.csv_import(@csv) do |user, params|
+      if params[:id] == '1'
+        user.name = name
+      end
+    end
+    user = User.find(1)
+    assert_equal name, user.name
+  end
+
+  test "import with fields option" do
+    user = {name: 'atsushi', age: 14}
+    csv = <<-EOS.gsub(/^\s*/, '')
+      #{user.values.join(',')}
+    EOS
+    users = User.csv_import(StringIO.new(csv), fields: user.keys)
+    user.each do |k, v|
+      assert_equal v, users.first[k]
+    end
+  end
+
+  test "import skip blank line" do
+    csv = <<-EOS.gsub(/^\s*/, '')
+      name,age
+
+      yoshida,30
+    EOS
+    User.csv_import(csv)
+    assert_equal 1, User.count
+  end
+
+  test "import skip if block returns false" do
+    User.csv_import(@csv) do |user|
+      next false if user.id == 2
+    end
+    assert_nil User.find_by_id(2)
+  end
+
+  test "import is transaction" do
+    User.csv_import(@csv) do |user, attributes, index|
+      raise ActiveRecord::Rollback if index == 2
+    end
+    assert_nil User.find_by_id(1)
+  end
+
+  test "includes invalid attributes" do
+    csv =<<-EOS.gsub(/^\s*/, '')
+      name,age
+      ,30
+      yoshida,12
+    EOS
+    users = User.csv_import(csv)
+    assert_equal 0, User.count
+    assert_equal ["Name can't be blank"], users[0].errors.full_messages
+  end
+
+  test "import can accept not a column" do
+    csv =<<-EOS.gsub(/^\s*/, '')
+      name,age,group_name
+      yoshida,12,human
+    EOS
+    assert_difference("User.count") do
+      User.csv_import(csv) do |user, attributes|
+        assert_equal 'human', attributes[:group_name]
+      end
+    end
+  end
+
+  test "it also use tsv_import" do
+    secret = 'hogehoge'
+    User.tsv_import(@csv.read.gsub(/,/, "\t")) do |user, params, ix|
+      user.secret = secret if user.name == 'yalab'
+    end
+    @users.each do |params|
+      user = User.find_by_id(params[:id])
+      params.each do |k, v|
+        if k == :secret && user.name == 'yalab'
+          v = secret
+        end
+        assert_equal v, user[k]
+      end
+    end
+  end
+
+  test "inverse_human_attriute_name" do
+    I18n.locale = :ja
+    assert_equal :name, User.inverse_human_attriute_name("名前")
+  end
+
+  test "csv download upload" do
+    I18n.locale = :ja
+    user = User.create(name: 'foobar', age: 20)
+    User.csv_import(User.to_csv.gsub('foobar', 'hogehoge'))
+    assert_equal 'hogehoge', user.reload.name
+  end
+
+  test "import can choose key" do
+    csv =<<-EOS.gsub(/^\s*/, '')
+      name,age,group_name
+      yoshida,12,human
+      yoshida,15,human
+    EOS
+    User.csv_import(csv, find_key: :name)
+    assert_equal 1, User.count
+    assert_equal 15, User.find(1).age
+  end
+end

data/test/dummy/app/controllers/groups_controller.rb

@@ -0,0 +1,17 @@
+class GroupsController < ApplicationController
+  def create
+    user_prefix = /^user_/
+    @groups = Group.csv_import(params[:group][:file], find_key: :name) do |group, _params, i|
+      user_params = _params.select{|k, v| k =~ user_prefix }.to_a.inject({}){|hash, (k, v)|
+        hash[k.gsub(user_prefix, '')] = v
+        hash
+      }
+      user_params
+      user = User.where(name: user_params['name']).first_or_initialize
+      user.attributes = user_params
+      group.users << user
+    end
+
+    render text: nil
+  end
+end

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

@@ -9,7 +9,7 @@ class UsersController < ApplicationController
   end
 
   def sjis
-    @users = User.includes(:groups).all
+    @users = User.includes(:groups).to_a
     respond_to do |format|
       format.html
       format.csv { render csv: @users, fields: [:id, :name, :age, :"groups.first.name"], encoding: 'SJIS' }

data/test/dummy/app/helpers/groups_helper.rb

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

data/test/dummy/app/models/group.rb

@@ -1,6 +1,7 @@
 class Group < ActiveRecord::Base
   has_many :memberships
   has_many :users, through: :memberships
+  include CsvRails::Import
 
   def created_at_as_csv
     created_at.strftime("%F")

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

@@ -1,6 +1,8 @@
 class User < ActiveRecord::Base
   has_many :memberships
   has_many :groups, through: :memberships
+  validates :name, presence: :true
+  include CsvRails::Import
 
   def updated_at_as_csv
     self.updated_at.strftime("%F %H:%M")

data/test/dummy/config/database.yml

@@ -1,25 +1,13 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-development:
+default: &default
   adapter: sqlite3
-  database: db/development.sqlite3
   pool: 5
   timeout: 5000
 
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
+development:
+  <<: *default
+  database: db/development.sqlite3
+
 test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
+  <<: *default
+  database: ":memory:"
 
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
-  timeout: 5000