csv_magic 0.2.0

data/.gitignore

@@ -0,0 +1,10 @@
+spec/dummy/tmp
+spec/dummy/log
+spec/dummy/db
+.idea
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+/spec/dummy/log/test.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+branches:
+  only:
+    - master
+before_script:
+  - "sh -c 'cd spec/dummy && RAILS_ENV=test bundle exec rake db:migrate'"
+script: "bundle exec rspec spec"

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in csv_magic.gemspec
+gemspec
+
+group :development do
+	if !ENV["CI"]
+		gem 'ruby-debug-base19', '~> 0.11.26', :platform => :ruby_19
+		gem 'linecache19', '~> 0.5.13', :platform => :ruby_19
+		gem 'ruby-debug19', '~> 0.11.6', :require => 'ruby-debug', :platform => :ruby_19
+		gem 'ruby-debug', :platform => :ruby_18
+	end
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,76 @@
+## Description
+
+This gem adds an import action in every controller you like to be able to handle csv imports.
+It includes the complete workflow:
+
+* CSV file upload
+* Field mapping with review
+* Creating model records
+
+## Requirements
+
+Rails >= 3.1.x and Ruby >= 1.9.x
+
+## Installation
+
+Install as gem:
+
+    $ gem install csv_magic
+
+Or in your apps `Gemfile`:
+
+    gem 'csv_magic', :git => 'git://github.com/magiclabs/csv_magic.git'
+
+## Usage
+
+### Set up a new route to point to the import action (get & post will be needed!):
+
+    # routes.rb
+    resources :myresource do
+      get 'import', :on => :collection
+      post 'import', :on => :collection
+    end
+
+### Include it in your Controller:
+
+    include CSVMagic::ControllerActions
+
+### Set up the fields to map to:
+
+    # your_controller.rb
+    csv_magic_config(
+      :mapping => {
+        "Firstname" => :firstname,
+        "Lastname"  =>  :lastname
+      }
+    )
+
+**See also the implementation in `spec/dummy` app!**
+
+## Customizing
+
+Nearly any part of the gem can be overridden!
+
+### The views
+
+To override the views place a `csv_magic` folder inside your apps `app/views` folder.
+
+* `import.html.erb` => The import view, where the form is placed on
+* `mapper.html.erb` => The mapper view, where the mapping happens
+* `import_errors.html.erb` => The import errors view, where import errors while be shown
+
+### The actions
+
+To override the actions just define the method you want to override inside your controller.
+
+Just have a look into `lib/controller_actions.rb` file to see the methods.
+
+## Thanks
+
+This gem is heavily based on [Andrew Timberlake's map-fields-gem](http://github.com/internuity/map-fields).
+
+Nevertheless we didn't fork it, because the changes are too fundamental.
+
+## License
+
+MIT License. Copyright 2012 [magic labs*](http://magiclabs.de)

data/Rakefile

@@ -0,0 +1,26 @@
+#encoding: UTF-8
+require 'rubygems'
+require 'bundler/gem_tasks'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CSVMagicTest'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/views/csv_magic/import.html.erb

@@ -0,0 +1,10 @@
+<h1><%= t(:import_csv_file) %></h1>
+
+<p><%= t(:please_choose_a_csv_file) %>:</p>
+
+<%= form_tag(url_for(:action => 'import'), :multipart => true) do %>
+  <div class="field">
+    <%= file_field_tag 'file' %>
+    <%= submit_tag t(:import) %>
+  </div>
+<% end %>

data/app/views/csv_magic/import_errors.html.erb

@@ -0,0 +1,8 @@
+<div class="csv_magic_import_errros">
+  <h2><%= t(:import_errors) %>:</h2>
+  <ol>
+    <%- @csv_import_errors.each do |error| -%>
+    <li><%= error.full_messages %></li>
+    <%- end -%>
+  </ol>
+</div>

data/app/views/csv_magic/mapper.html.erb

@@ -0,0 +1,42 @@
+<h1><%= t(:import_csv_file) %></h1>
+
+<p><%= t(:please_map_columns) %></p>
+
+<%= form_tag nil, :id => 'map_fields_form', :method => :post do -%>
+  <%= hidden_field_tag :filename, @mapper.filename %>
+  <div class="map_fields">
+    <table>
+      <thead>
+        <tr>
+          <%- header = @raw_data.first -%>
+          <%- header.size.times do |column_index| -%>
+            <th>
+              <%= select_tag("fields[#{column_index + 1}]", options_for_select(
+                @mapper.map_fields,
+                @mapper.map_fields[header[column_index]]
+              ), :include_blank => true, :class => 'field_options') %>
+            </th>
+          <%- end -%>
+        </tr>
+      </thead>
+      <tbody>
+        <%- @raw_data[0..5].each do |row| -%>
+          <tr>
+            <%- row.each do |column| -%>
+              <td><%= h(column) -%></td>
+            <%- end -%>
+          </tr>
+        <%- end -%>
+      </tbody>
+    </table>
+  </div>
+  <div class="option">
+    <p>
+      <%= check_box_tag 'ignore_first_row', '1', true %>
+      <%= label_tag 'ignore_first_row', t(:ignore_first_row) %>
+    </p>
+  </div>
+  <div class="action">
+    <%= submit_tag t(:import) %>
+  </div>
+<%- end -%>

data/config/locales/de.yml

@@ -0,0 +1,13 @@
+de:
+  csv_magic:
+    csv_file_has_wrong_format: "Fehlerhaft formatierte CSV-Datei: %{error}"
+    errors_while_importing: "Beim Importieren sind Fehler aufgetreten!"
+    file_not_on_server_any_more: 'Datei nicht mehr auf dem Server. Bitte erneut hochladen!'
+    ignore_first_row: 'Erste Zeile auslassen (Titelzeile)'
+    import: 'Importieren'
+    import_csv_file: 'CSV importieren'
+    import_errors: 'Folgende Fehler sind aufgetreten'
+    please_choose_a_csv_file: 'Bitte wählen Sie eine CSV-Datei aus'
+    please_map_columns: 'Bitte Felder zuweisen'
+    please_upload_a_csv_file: 'Bitte eine CSV-Datei hochladen.'
+    successfully_imported_data: 'Die Daten wurden erfolgreich importiert.'

data/csv_magic.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "csv_magic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "csv_magic"
+  s.version     = CSVMagic::VERSION
+  s.authors     = ["Marc Schettke", "Thomas von Deyen"]
+  s.email       = ["mail@magiclabs.de"]
+  s.homepage    = "https://github.com/magiclabs/csv_magic"
+  s.summary     = %q{Adds some CSV magic into your app.}
+  s.description = %q{Provides controller actions, views and field mapping for data from a csv file.}
+  s.rubyforge_project = "csv_magic"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency 'rails', ['~> 3.1.4']
+  s.add_development_dependency 'rspec-rails', ["~> 2.8.0"]
+  s.add_development_dependency 'sqlite3', ["~> 1.3.5"]
+  s.add_development_dependency 'capybara', ['>= 0.4.0']
+end

data/lib/csv_magic/controller_actions.rb

@@ -0,0 +1,87 @@
+module CSVMagic
+  module ControllerActions
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.csv_magic_config
+      base.send(:include, I18nHelpers)
+    end
+    
+    module ClassMethods
+      def csv_magic_config( options = {} )
+        defaults = {
+          :action => :import,
+          :mapping => {},
+          :file_field => :file
+        }
+        options = defaults.merge(options)
+        write_inheritable_attribute(:map_fields_options, options)
+      end
+    end
+
+    def import
+      if request.post?
+        handle_csv_post_request
+      else
+        render_csv_import_form
+      end
+    end
+
+  private
+
+    def create_resource_items_from_csv(resource_class)
+      @csv_import_errors = []
+      reader = Reader.new(params)
+      reader.each do |row|
+        resource = resource_class.new(row)
+        unless resource.save
+          @csv_import_errors.push resource.errors
+        end
+      end
+      reader.remove_file if @csv_import_errors.empty?
+    end
+
+    def resource_class
+      @resource_name ||= self.class.name.gsub(/Controller|Admin/, '').gsub(/:{4}/, '::').singularize
+      @resource_class ||= @resource_name.constantize
+    end
+
+    def render_csv_import_form
+      render 'csv_magic/import'
+    end
+
+    def handle_csv_post_request
+      # already mapped
+      if params[:fields]
+        create_resource_items_from_csv(resource_class)
+        if @csv_import_errors.empty?
+          flash[:notice] = t(:successfully_imported_data)
+          redirect_to :action => :index
+        else
+          flash[:warning] = t(:errors_while_importing)
+          render 'csv_magic/import_errors'
+        end
+      #no mapping yet
+      else
+        @mapper = Importer.new(params, self.class.read_inheritable_attribute(:map_fields_options))
+        @raw_data = @mapper.raw_data
+        render 'csv_magic/mapper'
+      end
+    rescue MissingFileContentsError
+      flash[:warning] = t(:please_upload_a_csv_file)
+      render_csv_import_form
+    rescue ::CSV::MalformedCSVError => e
+      flash[:warning] = t(:csv_file_has_wrong_format) % {:error => e.message}
+      render_csv_import_form
+    rescue ::Errno::ENOENT
+      flash[:warning] = t(:file_not_on_server_any_more)
+      render_csv_import_form
+    rescue Exception => e
+      flash[:warning] = e.message
+      logger.error(e.message)
+      logger.error(e.backtrace.join("\n"))
+      render_csv_import_form
+    end
+
+  end
+end

data/lib/csv_magic/engine.rb

@@ -0,0 +1,5 @@
+module CSVMagic
+  class Engine < Rails::Engine
+
+  end
+end

data/lib/csv_magic/file_handler.rb

@@ -0,0 +1,35 @@
+module CSVMagic
+  class FileHandler
+
+    attr_reader :path, :filename
+
+    def initialize()
+      @path = ::File.join(::Rails.root.to_s, "tmp")
+    end
+
+    def save_temp_file(tempfile)
+      @filename = unique_filename
+      ::FileUtils.copy_file(tempfile.path, file_path)
+      ::File.exists?(file_path)
+    end
+
+    def load_file(filename)
+      @filename = filename
+      ::File.exist?(file_path)
+    end
+
+    def remove_file
+      ::File.delete(file_path)
+    end
+
+    def file_path
+      ::File.join(@path, @filename)
+    end
+
+    def unique_filename
+      t = ::Time.now.strftime("%Y%m%d")
+      "#{t}-#{$$}-#{rand(0x100000000000000).to_s(36)}"
+    end
+
+  end
+end

data/lib/csv_magic/i18n_helpers.rb

@@ -0,0 +1,23 @@
+module CSVMagic
+	module I18nHelpers
+
+		def self.included(controller)
+			if controller.respond_to?(:helper_method)
+				controller.send(:helper_method, [:t])
+			end
+		end
+
+		# This is a proxy to the ::I18n.t method with an csv_magic scope.
+		# 
+		# === NOTE:
+		# 
+		# The keys are scoped into +csv_magic+ namespace.
+		# Even if you pass a scope this is scoped under +csv_magic+.
+		# 
+		def t(key, options={})
+			scope = options[:scope].blank? ? 'csv_magic' : "csv_magic.#{options.delete(:scope)}"
+			::I18n.t(key, {:scope => scope, :default => key.to_s.humanize}.merge(options))
+		end
+
+	end
+end

data/lib/csv_magic/importer.rb

@@ -0,0 +1,27 @@
+module CSVMagic
+  class Importer
+    attr_reader :map_fields, :filename
+
+    def initialize(params, options)
+      @file_handler = FileHandler.new()
+
+      if @file_handler.save_temp_file(params[options[:file_field]])
+        set_attributes_from_valid_file(options)
+      else
+        raise MissingFileContentsError
+      end
+    end
+
+    def raw_data
+      ::CSV.read(@file_handler.file_path, CSVMagic.options)
+    end
+
+  private
+
+    def set_attributes_from_valid_file(options)
+      @filename = @file_handler.filename
+      @map_fields = options[:mapping]
+    end
+
+  end
+end

data/lib/csv_magic/reader.rb

@@ -0,0 +1,38 @@
+module CSVMagic
+  class Reader
+    
+    def initialize(params)
+      @file_handler = FileHandler.new
+      @file_handler.load_file(params[:filename])
+
+      @file_path = @file_handler.file_path
+      @ignore_first_row = params[:ignore_first_row]
+      @mapping = {}
+      params[:fields].each do |k, v|
+        unless v.empty?
+          @mapping[v.downcase.to_sym] = k.to_i - 1
+        end
+      end
+    end
+    
+    def each
+      row_number = 1
+      ::CSV.foreach(@file_path, CSVMagic.options) do |csv_row|
+        unless row_number == 1 && @ignore_first_row
+          row = {}
+          @mapping.each do |k, v|
+            row[k] = csv_row[v]
+          end
+          row.class.send(:define_method, :number) { row_number }
+          yield(row)
+        end
+        row_number += 1
+      end
+    end
+
+    def remove_file
+      @file_handler.remove_file
+    end
+
+  end
+end

data/lib/csv_magic/version.rb

@@ -0,0 +1,3 @@
+module CSVMagic
+  VERSION = "0.2.0"
+end

data/lib/csv_magic.rb

@@ -0,0 +1,39 @@
+require 'csv'
+require "csv_magic/version"
+require 'csv_magic/i18n_helpers'
+require 'csv_magic/controller_actions'
+require 'csv_magic/engine'
+require 'csv_magic/importer'
+require 'csv_magic/reader'
+require 'csv_magic/file_handler'
+
+module CSVMagic
+
+  class InconsistentStateError < StandardError
+  end
+
+  class MissingFileContentsError < StandardError
+  end
+
+  @@options = {
+    :col_sep => ";",
+    :row_sep => :auto,
+    :quote_char => '"',
+    :converters => nil,
+    :unconverted_fields => nil,
+    :headers => false,
+    :return_headers => false,
+    :header_converters => nil,
+    :skip_blanks => false,
+    :force_quotes => false
+  }.freeze
+
+  def self.options
+    @@options
+  end
+
+  def self.options=(options)
+    @@options = options
+  end
+
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# 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__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

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

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

@@ -0,0 +1,24 @@
+class PeopleController < ApplicationController
+
+  include CSVMagic::ControllerActions
+
+  csv_magic_config(
+    :mapping => {
+      "Firstname" => :firstname,
+      "Lastname"  =>  :lastname
+    }
+  )
+
+  # GET /people
+  def index
+    @people = Person.all
+  end
+
+  # DELETE /people/1
+  def destroy
+    @person = Person.find(params[:id])
+    @person.destroy
+    redirect_to(people_url)
+  end
+
+end

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

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

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

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

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+<p id="flash">
+  <%= flash[:notice] %>
+  <%= flash[:warning] %>
+</p>
+
+<%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1,21 @@
+<h1>Listing People</h1>
+
+<table>
+  <tr>
+    <th>Lastname</th>
+    <th>Firstname</th>
+    <th></th>
+  </tr>
+
+<% @people.each do |person| %>
+  <tr>
+    <td><%= person.lastname %></td>
+    <td><%= person.firstname %></td>
+    <td><%= link_to 'Destroy', person, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'Import People!', import_people_path %>

data/spec/dummy/config/application.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "csv_magic"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    # config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)