importable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Mike Bannister
+
+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,3 @@
+= Importable
+
+Import spreadsheets and map data to rails models, easily.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Importable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rspec/rails/tasks/rspec.rake'
+
+Bundler::GemHelper.install_tasks
+
+namespace :db do
+  namespace :test do
+    task :prepare do
+      # Stub out for engine
+    end
+  end
+end
+
+task :default => 'spec'

data/app/assets/javascripts/importable/application.js

@@ -0,0 +1,7 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require_tree .

data/app/assets/javascripts/importable/spreadsheets.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/importable/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/app/assets/stylesheets/importable/spreadsheets.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/importable/application_controller.rb

@@ -0,0 +1,4 @@
+module Importable
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/importable/spreadsheets_controller.rb

@@ -0,0 +1,74 @@
+module Importable
+  class SpreadsheetsController < ApplicationController
+    before_filter :require_type_param
+
+    def new
+      @spreadsheet = Spreadsheet.new
+    end
+
+    def create
+      init_spreadsheet!
+
+      if @spreadsheet.valid?
+        set_current_step!
+        prepare_next_step!
+
+        if @spreadsheet.last_step?
+          if import!
+            notice = "'#{@spreadsheet.default_sheet}' of #{@type} spreadsheet was successfully imported."
+            redirect_to spreadsheet_path(id: @spreadsheet.id, type: @type), notice: notice
+            return
+          end
+          @spreadsheet.previous_step
+        end
+      end
+
+      # if not redirected
+      render action: 'new'
+    end
+
+    def show
+      @spreadsheet = Spreadsheet.find(params[:id])
+    end
+
+    private
+
+    def init_spreadsheet!
+      @spreadsheet = begin
+        if params[:current_step] == 'upload_file'
+          Spreadsheet.new(file: params[:file], object_type: params[:type])
+        else
+          Spreadsheet.find(params[:spreadsheet_id])
+        end
+      end
+    end
+
+    def set_current_step!
+      @spreadsheet.current_step = params[:current_step]
+    end
+
+    def prepare_next_step!
+      if @spreadsheet.persisted? or @spreadsheet.save
+        if params[:back_button]
+          @spreadsheet.previous_step
+        else
+          @spreadsheet.next_step
+        end
+        params[:current_step] = @spreadsheet.current_step
+      end
+    end
+
+    def import!
+      default_sheet = @spreadsheet.sheets[params[:default_sheet].to_i]
+      @spreadsheet.default_sheet = default_sheet
+      @spreadsheet.import!
+    end
+
+    def require_type_param
+      unless Spreadsheet.mapper_type_exists?(params[:type])
+        raise Exceptions::ParamRequiredError.new("#{params[:type]} import mapper does not exist")
+      end
+      @type = params[:type]
+    end
+  end
+end

data/app/models/importable/spreadsheet.rb

@@ -0,0 +1,88 @@
+module Importable
+  class Spreadsheet < ActiveRecord::Base
+    include MultiStep::ImportHelpers
+
+    delegate :first_row, :last_row, :sheets, :row, :to => :spreadsheet
+    delegate :invalid_objects, :to => :mapper
+
+    mount_uploader :file, Importable::Uploader
+
+    validates_presence_of :file
+    validates_with Importable::Validator
+
+    def headers
+      @headers ||= spreadsheet.row(first_row)
+    end
+
+    def default_sheet=(sheet)
+      spreadsheet.default_sheet = sheet
+    end
+
+    def default_sheet
+      spreadsheet.default_sheet
+    end
+
+    def spreadsheet
+      @spreadsheet ||= spreadsheet_class.new(file.current_path)
+    end
+
+    def import!
+      mapper.valid?
+    end
+
+    def mapper
+      mapper_class.new(rows)
+    end
+
+    def mapper_class
+      singular_mapper_class || plural_mapper_class
+    end
+
+    def spreadsheet_class
+      extension = file.current_path.split('.').last
+      return Excel if extension == 'xls'
+      return Excelx if extension == 'xlsx'
+    end
+
+    def rows
+      @rows ||= begin
+        (first_row + 1).upto(last_row).map do |index|
+          data = {}
+          raw_data = row(index)
+          headers.zip(raw_data) do |key, val|
+            data[key] = val
+          end
+          data
+        end
+      end
+    end
+
+    def self.mapper_files
+      Dir["#{Rails.root}/app/imports/**.rb"]
+    end
+
+    def self.mapper_types
+      mapper_files.map do |mapper_file|
+        file_name = File.basename(mapper_file, '.rb')
+        mapper_name = file_name.slice(0..-8) if file_name.ends_with?('_mapper')
+        mapper_name.try(:singularize)
+      end.compact
+    end
+
+    def self.mapper_type_exists?(type)
+      self.mapper_types.flat_map do |t|
+        [ t.pluralize, t.singularize ]
+      end.include?(type)
+    end
+  
+    private
+  
+    def singular_mapper_class
+      "#{object_type.singularize}_mapper".camelize.constantize rescue nil
+    end
+
+    def plural_mapper_class
+      "#{object_type.pluralize}_mapper".camelize.constantize rescue nil
+    end
+  end
+end

data/app/views/importable/spreadsheets/_actions.erb

@@ -0,0 +1,6 @@
+<div class="actions">
+  <p>
+    <%= submit_tag label %>
+    <%= submit_tag "Back", :name => "back_button" unless @spreadsheet.first_step? %>
+  </p>
+</div>

data/app/views/importable/spreadsheets/_choose_worksheet_step.erb

@@ -0,0 +1,23 @@
+<%= form_tag spreadsheets_path(type: @type) do %>
+  <%= render "errors" %>
+
+  <h2>Choose worksheet</h2>
+
+  <% @spreadsheet.sheets.each_with_index do |sheet, index| %>
+    <table>
+      <tr>
+        <td>
+          <%= radio_button_tag 'default_sheet', index, index.zero? %>
+        </td>
+        <td>
+          <%= label_tag "default_sheet_#{index}", sheet.humanize %>
+        </td>
+      </tr>
+    </table>    
+  <% end %>
+
+  <%= hidden_field_tag :spreadsheet_id, @spreadsheet.id %>
+  <%= hidden_field_tag :current_step, 'choose_worksheet' %>
+
+  <%= render "actions", :label => 'Continue' %>
+<% end %>

data/app/views/importable/spreadsheets/_errors.erb

@@ -0,0 +1,11 @@
+<% if @spreadsheet.errors.any? %>
+  <div id="error_explanation">
+    <h2><%= pluralize(@spreadsheet.errors.count, "error") %> prohibited this importable_spreadsheet from being saved:</h2>
+
+    <ul>
+    <% @spreadsheet.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
+  </div>
+<% end %>

data/app/views/importable/spreadsheets/_form.html.erb

@@ -0,0 +1 @@
+<%= render "#{@spreadsheet.current_step}_step" %>

data/app/views/importable/spreadsheets/_upload_file_step.erb

@@ -0,0 +1,12 @@
+<%= form_tag spreadsheets_path(type: @type), enctype: 'multipart/form-data' do %>
+  <%= render "errors" %>
+
+  <h2>File upload</h2>
+
+  <p><%= label_tag :file, "Choose #{@type.humanize.downcase} spreadsheet file" %></p>
+  <p><%= file_field_tag :file %></p>
+
+  <%= hidden_field_tag :current_step, 'upload_file' %>
+
+  <%= render "actions", :label => 'Upload' %>
+<% end %>

data/app/views/importable/spreadsheets/new.html.erb

@@ -0,0 +1,3 @@
+<h1><%= @type.humanize %> spreadsheet upload</h1>
+
+<%= render 'form' %>

data/app/views/importable/spreadsheets/show.html.erb

@@ -0,0 +1,3 @@
+<p>
+  <%= link_to "Import more #{params[:type].pluralize}", new_spreadsheet_path(type: params[:type]) %>
+</p>

data/config/routes.rb

@@ -0,0 +1,16 @@
+Importable::Engine.routes.draw do
+  match "/:type",
+        to: 'spreadsheets#new',
+        as: 'new_spreadsheet',
+        via: 'get'
+
+  match "/:type",
+        to: 'spreadsheets#create',
+        as: 'spreadsheets',
+        via: 'post'
+
+  match "/:type/:id",
+        to: 'spreadsheets#show',
+        as: 'spreadsheet',
+        via: 'get'
+end

data/db/migrate/20110915001957_create_importable_spreadsheets.rb

@@ -0,0 +1,10 @@
+class CreateImportableSpreadsheets < ActiveRecord::Migration
+  def change
+    create_table :importable_spreadsheets do |t|
+      t.string :file
+      t.string :object_type
+
+      t.timestamps
+    end
+  end
+end

data/lib/importable/engine.rb

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

data/lib/importable/exceptions.rb

@@ -0,0 +1,3 @@
+module Importable::Exceptions
+  class ParamRequiredError < StandardError; end
+end

data/lib/importable/mapper.rb

@@ -0,0 +1,40 @@
+module Importable
+  class Mapper
+    attr_accessor :data
+    attr_accessor :invalid_objects
+  
+    def initialize(data)
+      @raw_data = data
+      @invalid_objects = []
+    
+      map_to_objects!
+      validate_objects!
+      save_objects!
+    end
+
+    def map_row
+      raise NotImplementedError.new('map_row method must be overriden by mapper')
+    end
+
+    def valid?
+      @invalid_objects.empty?
+    end
+
+    def map_to_objects!
+      @data = @raw_data.flat_map { |row| map_row(row) }
+    end
+  
+    def save_objects!
+      if valid?
+        @data.each { |object| object.save! if object.new_record? } 
+      end
+    end
+
+    def validate_objects!
+      @data.each_with_index do |object, index|
+        line_number = (index + 2)
+        @invalid_objects << [object, line_number] unless object.valid?
+      end
+    end
+  end
+end

data/lib/importable/multi_step/import_helpers.rb

@@ -0,0 +1,39 @@
+module MultiStep
+  module ImportHelpers
+    attr_writer :current_step
+
+    def steps
+      %w[ upload_file choose_worksheet import_data ]
+    end
+
+    def current_step
+      @current_step || steps.first
+    end
+
+    def next_step
+      distance = 1
+      # skip choose worksheet step if there's only 1 worksheet
+      if self.current_step == 'upload_file' and self.sheets.length <= 1
+        distance = 2
+      end
+      self.current_step = steps[steps.index(current_step) + distance]
+    end
+
+    def previous_step
+      distance = 1
+      # skip choose worksheet step if there's only 1 worksheet
+      if self.current_step == 'import_data' and self.sheets.length <= 1
+        distance = 2
+      end
+      self.current_step = steps[steps.index(current_step) - distance]
+    end
+
+    def first_step?
+      current_step == steps.first
+    end
+
+    def last_step?
+      current_step == steps.last
+    end
+  end
+end

data/lib/importable/uploader.rb

@@ -0,0 +1,13 @@
+module Importable
+  class Uploader < CarrierWave::Uploader::Base
+    storage :file
+
+    def extension_white_list
+      %w(xls xlsx)
+    end
+
+    def store_dir
+      "#{Rails.root}/uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.object_type}/#{model.id}"
+    end
+  end
+end

data/lib/importable/validator.rb

@@ -0,0 +1,16 @@
+module Importable
+  class Validator < ActiveModel::Validator
+    def validate(spreadsheet)
+      if spreadsheet.file.try(:current_path)
+        spreadsheet.mapper.invalid_objects.each do |object, line_number|
+          object.errors.messages.each do |error|
+            field, errors = *error
+            errors.each do |message|
+              spreadsheet.errors[field] << "#{message} (line #{line_number})"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/importable/version.rb

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

data/lib/importable.rb

@@ -0,0 +1,12 @@
+require 'carrierwave'
+require 'roo'
+
+require "importable/engine"
+require "importable/exceptions"
+require "importable/mapper"
+require "importable/uploader"
+require "importable/validator"
+require "importable/multi_step/import_helpers"
+
+module Importable
+end

data/spec/acceptance/import_spreadsheet_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+feature "Import spreadsheet" do
+  scenario "Import spreadsheet with a single worksheet" do
+    spreadsheet_file = support_file('foo_single_worksheet.xlsx')
+
+    visit '/importable/foo'
+    attach_file("Choose foo spreadsheet file", spreadsheet_file)
+    click_button "Upload"
+    page.should have_content "'Sheet1' of foo spreadsheet was successfully imported."
+  end
+
+  scenario "Import spreadsheet with multiple worksheets" do
+    spreadsheet_file = support_file('foo_multi_worksheet.xlsx')
+
+    visit '/importable/foo'
+    attach_file("Choose foo spreadsheet file", spreadsheet_file)
+    click_button "Upload"
+    page.should have_content "Choose worksheet"
+    choose "Sheet2"
+    click_button "Continue"
+    page.should have_content "'Sheet2' of foo spreadsheet was successfully imported."
+  end
+  
+  scenario "Import invalid spreadsheet" do
+    spreadsheet_file = support_file('foo_required_field_invalid.xlsx')
+
+    visit '/importable/foo_required_field'
+    attach_file("Choose foo required field spreadsheet file", spreadsheet_file)
+    click_button "Upload"
+    page.should have_content "Doof can't be blank (line 3)"
+  end
+end