csv_mapper 0.0.2

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in csv_mapper.gemspec
+gemspec
+
+group(:development, :test) do
+  gem 'ruby-debug'
+  gem 'rails', '3.0.9'
+  gem 'sqlite3'
+end
+
+group(:test) do
+  gem 'rspec-rails', '>= 2.0.0.beta'
+  gem 'capybara', '>= 0.4.0'
+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.rdoc

@@ -0,0 +1,54 @@
+== 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-Upload, auto-matching and review, importing data into model.
+
+== Requirements
+
+Rails 3 & Ruby 1.8.7
+
+In principle it will also work with Ruby 1.9, whereas changes has to be made as FasterCSV is already integrated named as CSV.
+
+== Installation
+
+Gemfile:
+
+    gem 'csv_mapper', :git => git://github.com/masche842/csv_mapper.git
+
+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:
+
+    require 'csv_mapper'
+    include CsvMapper::ControllerActions
+
+Set up the fields to map to:
+
+    csv_mapper_config(
+      :mapping => {
+        "Firstname" => :firstname,
+        "Lastname"  =>  :lastname
+      }
+    )
+
+See also the implementation in spec/dummy!
+
+== Usage
+
+call /myresources/import!
+
+== Thanks
+
+This gem is heavily based on Andrew Timberlake's map-fields-gem (http://github.com/internuity/map-fields).
+Nevertheless I didn't fork it, because the changes are fundamental.
+
+== License
+
+MIT License. Copyright 2011 magiclabs* (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    = 'CsvMapperTest'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

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

@@ -0,0 +1,11 @@
+<h1>CSV importieren</h1>
+
+<p>Bitte csv-Datei auswählen</p>
+
+<%= form_for :guest, :html  => {:multipart  => true} do |f| %>
+  <div class="field">
+    <%= file_field_tag 'file' %>
+    <%= f.submit 'Import' %>
+  </div>
+
+<% end %>

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

@@ -0,0 +1,40 @@
+<h1>CSV importieren</h1>
+
+<p>Bitte Felder mappen</p>
+
+<%= form_tag nil, :id => 'map_fields_form', :method => :post do -%>
+  <%= hidden_field_tag :filename, @mapper.filename %>
+  <div class="map_fields">
+    <table cellspacing="0">
+      <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.each do |row| -%>
+          <tr>
+            <%- row.each do |column| -%>
+              <td><%= h(column) -%></td>
+            <%- end -%>
+          </tr>
+        <%- end -%>
+      </tbody>
+    </table>
+  </div>
+  <div class="option">
+    <%= check_box_tag 'ignore_first_row', '1', true, :id => 'ignore_first_row_option' %>
+    <label for="ignore_first_row_option">Ignore the first row (headings)</label>
+  </div>
+  <div class="action">
+    <%= submit_tag 'Import' %>
+  </div>
+<%- end -%>

data/csv_mapper.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "csv_mapper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "csv_mapper"
+  s.version     = CsvMapper::VERSION
+  s.authors     = ["Marc"]
+  s.email       = ["marc@magiclabs.de"]
+  s.homepage    = "http://magiclabs.de"
+  s.summary     = %q{Provides a controller action and views for uploading, mapping and importing data from a csv}
+
+  s.rubyforge_project = "csv_mapper"
+
+  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("fastercsv")
+end

data/lib/csv_mapper.rb

@@ -0,0 +1,37 @@
+require "csv_mapper/version"
+require 'csv_mapper/controller_actions'
+require 'csv_mapper/engine'
+require 'csv_mapper/importer'
+require 'csv_mapper/reader'
+require 'csv_mapper/file_handler'
+
+module CsvMapper
+
+  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/lib/csv_mapper/controller_actions.rb

@@ -0,0 +1,73 @@
+require 'fastercsv'
+
+module CsvMapper
+  module ControllerActions
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.csv_mapper_config
+    end
+    
+    module ClassMethods
+      def csv_mapper_config( options = {} )
+        defaults = {
+          :action => :import,
+          :mapping => {},
+          :file_field => :file
+        }
+        options = defaults.merge(options)
+        write_inheritable_attribute(:map_fields_options, options)
+      end
+    end
+
+    def import
+      resource_name = self.class.name.gsub(/Controller/, '').singularize
+      resource_class = resource_name.constantize
+      if request.post?
+        # already mapped
+        if params[:fields]
+          create_resource_items_from_csv(resource_class)
+          if @csv_import_errors.empty?
+            flash[:notice] = 'Daten erfolgreich importiert!'
+            redirect_to :action => :index
+          else
+            flash[:warning] = @csv_import_errors
+            redirect_to :back
+          end
+        #no mapping yet
+        else
+          @mapper = CsvMapper::Importer.new(params, self.class.read_inheritable_attribute(:map_fields_options))
+          @raw_data = @mapper.raw_data
+          render 'controller_actions/mapper'
+        end
+      else
+        render 'controller_actions/import'
+      end
+    rescue CsvMapper::InconsistentStateError
+      flash[:warning] = 'unbekannter Fehler.'
+    rescue CsvMapper::MissingFileContentsError
+      flash[:warning] = 'Bitte eine CSV-Datei hochladen.'
+      render 'controller_actions/import'
+    rescue FasterCSV::MalformedCSVError => e
+      flash[:warning] = 'Fehlerhaft formatierte CSV-Datei: ' + e
+      render 'controller_actions/import'
+    rescue Errno::ENOENT
+      flash[:warning] = 'Datei nicht mehr auf dem Server. Bitte erneut hochladen!'
+      render 'controller_actions/import'
+    end
+
+private
+    def create_resource_items_from_csv(resource_class)
+      @csv_import_errors = []
+      reader = CsvMapper::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
+    
+  end
+end

data/lib/csv_mapper/engine.rb

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

data/lib/csv_mapper/file_handler.rb

@@ -0,0 +1,33 @@
+class CsvMapper::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

data/lib/csv_mapper/importer.rb

@@ -0,0 +1,28 @@
+require 'fastercsv'
+
+class CsvMapper::Importer
+  attr_reader :map_fields, :filename
+
+
+  def initialize(params, options)
+    @file_handler = CsvMapper::FileHandler.new()
+
+    if @file_handler.save_temp_file(params[options[:file_field]])
+      set_attributes_from_valid_file(options)
+    else
+      raise CsvMapper::MissingFileContentsError
+    end
+  end
+
+  def raw_data
+    FasterCSV.read(@file_handler.file_path, CsvMapper.options)
+  end
+
+private
+
+  def set_attributes_from_valid_file(options)
+    @filename = @file_handler.filename
+    @map_fields = options[:mapping]
+  end
+
+end

data/lib/csv_mapper/reader.rb

@@ -0,0 +1,38 @@
+require 'fastercsv'
+
+class CsvMapper::Reader
+  
+  def initialize(params)
+    @file_handler = CsvMapper::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
+    FasterCSV.foreach(@file_path, CsvMapper.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

data/lib/csv_mapper/version.rb

@@ -0,0 +1,3 @@
+module CsvMapper
+  VERSION = "0.0.2"
+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