importable 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,58 @@
+# Importable #
+
+Import spreadsheets and map data to rails models, easily.
+
+## Synopsis ##
+
+Provides models and a UI for creating and maintaining string pairs. A tiny DSL is included so developers to easily make use of the generated data. The UI allows system administrators to create groups of string pairs that can be maintained by non-technical people.
+
+Add it to your `Gemfile`
+
+    gem 'importable'
+
+Bundle it up
+
+    bundle install
+
+Install the migrations and apply them
+
+    rake importable:install:migrations
+    rake db:migrate
+
+Mount the engine
+
+    mount Importable::Engine => '/import'
+
+You can use the included generator to copy the views if you'd like to customize them
+
+    rails generate importable:views
+
+You can also create map specific views. This is especially useful if you want the form to provide extra info to the mapper. The generator can create these views for you if you pass the name of the mapper.
+
+    rails generate importable:view widgets
+
+Redirection after upload
+
+    TODO
+
+Write an import mapper
+
+    TODO
+
+Use the provided UI to import data
+
+    TODO
+
+Testing import mappers
+
+    TODO
+
+## TODO ##
+
+Moves strings to en.yaml
+DSL to make mappers cleaner
+Make database optional
+Add support for other file types that roo supports
+Set gem versions with ~>
+Back button specs
+Figure out how to allow overriding map specific templates in app/views/importable/spreadsheets/foos rather than app/views/foos/importable/spreadsheets

data/app/controllers/importable/spreadsheets_controller.rb

@@ -1,6 +1,7 @@
 module Importable
-  class SpreadsheetsController < ApplicationController
+  class SpreadsheetsController < ::ApplicationController
     before_filter :require_type_param
+    before_filter :prepend_map_specific_view_path
 
     def new
       @spreadsheet = Spreadsheet.new
@@ -8,6 +9,7 @@ module Importable
 
     def create
       init_spreadsheet!
+      init_import_params!
       set_default_sheet!
 
       if @spreadsheet.valid?
@@ -21,12 +23,7 @@ module Importable
             else
               "#{@spreadsheet.default_sheet} worksheet of #{@type} spreadsheet was successfully imported."
             end
-            return_to = if params[:return_to] == 'index'
-              main_app.send "#{@type.pluralize}_path".to_sym
-            else
-              spreadsheet_path(id: @spreadsheet.id, type: @type)
-            end
-            redirect_to return_to, notice: notice
+            redirect_to return_url, notice: notice
             return
           end
           @spreadsheet.previous_step
@@ -43,6 +40,25 @@ module Importable
 
     private
 
+    def return_url
+      index_path_sym = "#{@type.pluralize}_path".to_sym
+      if params[:return_to] == 'index' and self.respond_to?(index_path_sym)
+        main_app.foos_path
+      elsif params[:return_to] == 'import'
+        send(:new_spreadsheet_path, type: @type)
+      else
+        spreadsheet_path(id: @spreadsheet.id, type: @type)
+      end
+    end
+
+    def import_template
+      class_based_template if template_exists?(class_based_template)
+    end
+
+    def class_based_template
+      File.join('importable/spreadsheets', @type.pluralize, params[:action])
+    end
+
     def init_spreadsheet!
       @spreadsheet = begin
         if params[:current_step] == 'upload_file'
@@ -53,6 +69,10 @@ module Importable
       end
     end
 
+    def init_import_params!
+      @spreadsheet.import_params = params[:import_params] if params[:import_params]
+    end
+
     def set_current_step!
       @spreadsheet.current_step = params[:current_step]
     end
@@ -85,5 +105,9 @@ module Importable
       end
       @type = params[:type]
     end
+    
+    def prepend_map_specific_view_path
+      prepend_view_path File.join(Rails.root, 'app/views', @type.pluralize)
+    end
   end
 end

data/app/models/importable/spreadsheet.rb

@@ -2,20 +2,23 @@ module Importable
   class Spreadsheet < ActiveRecord::Base
     include MultiStep::ImportHelpers
 
+    attr_accessor :import_params
+
     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, :if => :default_sheet_chosen?
+    validates_with Importable::ImportedItemParamsValidator
+    validates_with Importable::ImportedItemsValidator, :if => :imported_items_ready?
 
     def headers
       @headers ||= spreadsheet.row(first_row)
     end
 
     def default_sheet=(sheet)
-      @default_sheet_chosen = true
+      @imported_items_ready = true
       spreadsheet.default_sheet = sheet
     end
 
@@ -23,8 +26,8 @@ module Importable
       spreadsheet.default_sheet
     end
 
-    def default_sheet_chosen?
-      @default_sheet_chosen or (file.current_path and sheets.length == 1)
+    def imported_items_ready?
+      @imported_items_ready or (file.current_path and sheets.length == 1)
     end
 
     def spreadsheet
@@ -36,7 +39,7 @@ module Importable
     end
 
     def mapper
-      mapper_class.new(rows)
+      mapper_class.new(rows, import_params)
     end
 
     def mapper_class
@@ -62,22 +65,26 @@ module Importable
       end
     end
 
-    def self.mapper_files
-      Dir["#{Rails.root}/app/imports/**.rb"]
-    end
+    class << self
 
-    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 mapper_files
+        Dir["#{Rails.root}/app/imports/**.rb"].sort
+      end
+
+      def 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 mapper_type_exists?(type)
+        mapper_types.flat_map do |t|
+          [ t.pluralize, t.singularize ]
+        end.include?(type)
+      end
 
-    def self.mapper_type_exists?(type)
-      self.mapper_types.flat_map do |t|
-        [ t.pluralize, t.singularize ]
-      end.include?(type)
     end
   
     private

data/app/views/importable/spreadsheets/{_actions.erb → _actions.html.erb}

@@ -1,6 +1,6 @@
 <div class="actions">
   <p>
-    <%= hidden_field_tag(:return_to, :index) %>
+    <%= hidden_field_tag :return_to, (params[:return_to] || :import) %>
     <%= submit_tag label %>
     <%= submit_tag "Back", :name => "back_button" unless @spreadsheet.first_step? %>
   </p>

data/app/views/importable/spreadsheets/{_choose_worksheet_step.erb → _choose_worksheet_step.html.erb}

@@ -19,5 +19,6 @@
   <%= hidden_field_tag :spreadsheet_id, @spreadsheet.id %>
   <%= hidden_field_tag :current_step, 'choose_worksheet' %>
 
+  <%= render "extras" %>
   <%= render "actions", :label => 'Continue' %>
 <% end %>

data/app/views/importable/spreadsheets/{_upload_file_step.erb → _upload_file_step.html.erb}

@@ -8,5 +8,6 @@
 
   <%= hidden_field_tag :current_step, 'upload_file' %>
 
+  <%= render "extras" %>
   <%= render "actions", :label => 'Upload' %>
 <% end %>

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

@@ -1,3 +1,3 @@
 <h1><%= @type.humanize %> spreadsheet upload</h1>
 
-<%= render 'form' %>
+<%= render "#{@spreadsheet.current_step}_step" %>

data/lib/generators/importable/views/USAGE

@@ -0,0 +1,31 @@
+Description:
+    Copy the views from importable so you can override them
+
+    Include NAME to create the templates in a subdirectory. These will apply only to the mapper corresponding name.
+
+Example:
+    rails generate importable:views
+
+    This will create:
+        app/views/importable
+        app/views/importable/spreadsheets
+        app/views/importable/spreadsheets/_actions.html.erb
+        app/views/importable/spreadsheets/_choose_worksheet_step.html.erb
+        app/views/importable/spreadsheets/_errors.html.erb
+        app/views/importable/spreadsheets/_extras.html.erb
+        app/views/importable/spreadsheets/_upload_file_step.html.erb
+        app/views/importable/spreadsheets/new.html.erb
+        app/views/importable/spreadsheets/show.html.erb
+
+    rails generate importable:views foos
+
+    This will create:
+        app/views/foos/importable
+        app/views/foos/importable/spreadsheets
+        app/views/foos/importable/spreadsheets/_actions.html.erb
+        app/views/foos/importable/spreadsheets/_choose_worksheet_step.html.erb
+        app/views/foos/importable/spreadsheets/_errors.html.erb
+        app/views/foos/importable/spreadsheets/_extras.html.erb
+        app/views/foos/importable/spreadsheets/_upload_file_step.html.erb
+        app/views/foos/importable/spreadsheets/new.html.erb
+        app/views/foos/importable/spreadsheets/show.html.erb

data/lib/generators/importable/views/views_generator.rb

@@ -0,0 +1,29 @@
+module Importable
+  class ViewsGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../../../../../app/views/importable', __FILE__)
+    argument :name, :type => :string, :default => ''
+
+    def copy_view_files
+
+      files = %w[
+        _actions
+        _choose_worksheet_step
+        _errors
+        _extras
+        _upload_file_step
+        new
+        show
+      ]
+
+      files.each do |file|
+        from_path = "spreadsheets/#{file}.html.erb"
+        path_parts = []
+        path_parts.unshift("importable/spreadsheets/#{file}.html.erb")
+        # include the name as a namespace if it's not blank
+        path_parts.unshift(name) unless name.blank?
+        to_path = File.join('app/views', *path_parts)
+        copy_file from_path, to_path
+      end
+    end
+  end
+end

data/lib/importable.rb

@@ -6,7 +6,8 @@ require "importable/row"
 require "importable/exceptions"
 require "importable/mapper"
 require "importable/uploader"
-require "importable/validator"
+require "importable/imported_items_validator"
+require "importable/imported_item_params_validator"
 require "importable/multi_step/import_helpers"
 
 module Importable

data/lib/importable/imported_item_params_validator.rb

@@ -0,0 +1,26 @@
+module Importable
+  class ImportedItemParamsValidator < ActiveModel::Validator
+    attr_reader :spreadsheet
+
+    def validate(spreadsheet)
+      @spreadsheet = spreadsheet
+      required_params.each do |required|
+        spreadsheet.errors[:base] << required[:message] if import_params[required[:name]].blank?
+      end
+    end
+    
+    private
+
+    def import_params
+      spreadsheet.import_params || {}
+    end
+
+    def required_params
+      mapper_class.required_params
+    end
+
+    def mapper_class
+      spreadsheet.mapper_class
+    end
+  end
+end

data/lib/importable/{validator.rb → imported_items_validator.rb}

@@ -1,5 +1,5 @@
 module Importable
-  class Validator < ActiveModel::Validator
+  class ImportedItemsValidator < ActiveModel::Validator
     def validate(spreadsheet)
       if spreadsheet.file.try(:current_path)
         spreadsheet.mapper.invalid_objects.each do |object, line_number|

data/lib/importable/mapper.rb

@@ -3,7 +3,8 @@ module Importable
     attr_accessor :data
     attr_accessor :invalid_objects
   
-    def initialize(data)
+    def initialize(data, params={})
+      @params = params
       @raw_data = data
       @invalid_objects = []
     
@@ -12,6 +13,20 @@ module Importable
       save_objects!
     end
 
+    class << self
+      def require_param(name, message)
+        @required_params ||= []
+        @required_params << {
+          name: name,
+          message: message
+        }
+      end
+
+      def required_params
+        @required_params || []
+      end
+    end
+
     def map_row(row)
       raise NotImplementedError.new('map_row method must be overriden by mapper')
     end
@@ -39,5 +54,10 @@ module Importable
         @invalid_objects << [object, line_number] unless object.valid?
       end
     end
+
+    def method_missing(sym, *args, &block)
+      return @params[sym] if !!@params[sym]
+      super(sym, *args, &block)
+    end
   end
 end

data/lib/importable/version.rb

@@ -1,3 +1,3 @@
 module Importable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/acceptance/import_spreadsheet_spec.rb

@@ -53,4 +53,16 @@ feature "Import spreadsheet" do
     page.should have_content "Sheet1 worksheet of foo spreadsheet was successfully imported."
     page.should have_content "Foos index"
   end
+
+  scenario "Import redirects back to the import page if requested" do
+    spreadsheet_file = support_file('foo_multi_worksheet.xlsx')
+
+    visit '/importable/foo?return_to=import'
+    attach_file("Choose foo spreadsheet file", spreadsheet_file)
+    click_button "Upload"
+    page.should have_content "Choose worksheet"
+    click_button "Continue"
+    page.should have_content "Sheet1 worksheet of foo spreadsheet was successfully imported."
+    page.should have_content "Foo spreadsheet upload"
+  end
 end

data/spec/controllers/importable/spreadsheets_controller_spec.rb

@@ -3,21 +3,36 @@ require 'spec_helper'
 module Importable
   describe SpreadsheetsController do
     describe "GET new" do
-      it "assigns a new importable spreadsheet as @spreadsheet" do
+      it "should assign a new importable spreadsheet as @spreadsheet" do
         get :new, type: 'foo', :use_route => :importable
         assigns(:spreadsheet).should be_a Spreadsheet
       end
-  
-      it "assigns the spreadsheet type as @type" do
+        
+      it "should assign the spreadsheet's type as @type" do
         get :new, type: 'foo', :use_route => :importable
         assigns(:type).should eq 'foo'
       end
-  
-      it "raises params exception if the mapper type is not valid" do
+        
+      it "should raise a params exception if the mapper type is not valid" do
         expect {
           get :new, type: 'bar', :use_route => :importable
         }.to raise_error(Exceptions::ParamRequiredError, 'bar import mapper does not exist')
       end
+      
+      it "should use the base import template by default" do
+        get :new, type: 'foo', :use_route => :importable
+        response.should render_template("importable/spreadsheets/new")
+      end
+      
+      describe "with rendered views" do
+        render_views
+        it "should use the mapper specific template if it exists" do
+          override_import_templates('moofs') do
+            get :new, type: 'moof', :use_route => :importable
+            response.body.should have_content 'moofs content'
+          end
+        end
+      end
     end
 
     context "spreadsheet uploaded" do
@@ -31,29 +46,34 @@ module Importable
         context "choose worksheet step" do
           before do
             spreadsheet_new # load
-            Spreadsheet.stub!(:new).and_return(spreadsheet_new)
+            Spreadsheet.stubs(:new).returns(spreadsheet_new)
           end
 
           context "#init_spreadsheet!" do
-            it "assigns the new spreadsheet as @spreadsheet" do
+            it "should assign the new spreadsheet as @spreadsheet" do
               post :create, type: 'foo', current_step: 'upload_file', :use_route => :importable
               assigns(:spreadsheet).should eq multi_spreadsheet
             end
+            
+            it "should set import_params on the spreadsheet from params[:import_params]" do
+              post :create, import_params: { moof: 1 }, type: 'foo', current_step: 'upload_file', :use_route => :importable
+              assigns(:spreadsheet).import_params.should eq ({ 'moof' => '1' })
+            end
           end
-  
+            
           context "#set_current_step!" do
-            it "sets the current_step to 'choose_worksheet' on @imported_spreadsheet" do
+            it "should set the current_step to 'choose_worksheet' on @imported_spreadsheet" do
               post :create, type: 'foo', current_step: 'upload_file', :use_route => :importable
               assigns(:spreadsheet).current_step.should eq 'choose_worksheet'
             end
           end
-
+          
           context "#prepare_next_step!" do
             it "should save the @imported_spreadsheet" do
-              spreadsheet_new.should_receive(:save)
+              spreadsheet_new.expects(:save)
               post :create, type: 'foo', current_step: 'upload_file', :use_route => :importable
             end
-
+          
             it "should set the next step to 'choose_worksheet'" do
               post :create, type: 'foo', current_step: 'upload_file', :use_route => :importable
               assigns(:spreadsheet).current_step.should eq 'choose_worksheet'
@@ -63,22 +83,27 @@ module Importable
 
         context "import data" do
           context "#init_spreadsheet!" do
-            it "assigns the existing spreadsheet as @spreadsheet" do
+            it "should assign the existing spreadsheet as @spreadsheet" do
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
               assigns(:spreadsheet).should eq multi_spreadsheet
             end
+          
+            it "should set import_params on the spreadsheet from params[:import_params]" do
+              post :create, import_params: { moof: 1 }, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
+              assigns(:spreadsheet).import_params.should eq ({ 'moof' => '1' })
+            end
           end
-
+          
           context "#set_current_step!" do
-            it "sets the current_step to 'import_data' on @imported_spreadsheet" do
+            it "should set the current_step to 'import_data' on @imported_spreadsheet" do
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
               assigns(:spreadsheet).current_step.should eq 'import_data'
             end
           end
-
+          
           context "#prepare_next_step!" do
             it "should not save the @imported_spreadsheet" do
-              multi_spreadsheet.should_not_receive(:save)
+              multi_spreadsheet.expects(:save).times(0)
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
             end
           
@@ -98,25 +123,25 @@ module Importable
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, default_sheet: 1, :use_route => :importable
               assigns(:spreadsheet).default_sheet.should eq 'Sheet2'
             end
-
+            
             it "should parse the default sheet if specified" do
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, default_sheet: 1, :use_route => :importable
               assigns(:spreadsheet).headers.should eq %w[ q r s t ]
             end
-
+            
             it "should use the first sheet if non are specified" do
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
               assigns(:spreadsheet).default_sheet.should eq 'Sheet1'
             end
-
+            
             it "should redirect with appropriate flash message for a multi workbook spreadsheet" do
-              multi_spreadsheet.stub(:import!).and_return(true)
+              multi_spreadsheet.stubs(:import!).returns(true)
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
               flash[:notice].should eq "Sheet1 worksheet of foo spreadsheet was successfully imported."
             end
-
+            
             it "should redirect with appropriate flash message for a single workbook spreadsheet" do
-              single_spreadsheet.stub(:import!).and_return(true)
+              single_spreadsheet.stubs(:import!).returns(true)
               post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: single_spreadsheet.id, :use_route => :importable
               flash[:notice].should eq "Foo spreadsheet was successfully imported."
             end
@@ -124,40 +149,46 @@ module Importable
             context "existing uploaded spreadsheet" do
               before do
                 multi_spreadsheet # load
-                Spreadsheet.stub!(:find).and_return(multi_spreadsheet)
+                Spreadsheet.stubs(:find).returns(multi_spreadsheet)
               end
 
               it "should call import! on the @spreadsheet" do
-                multi_spreadsheet.should_receive(:import!)
+                multi_spreadsheet.expects(:import!)
                 post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
               end
-
+              
               it "should redirect to the show view if import is successful" do
-                multi_spreadsheet.stub(:import!).and_return(true)
+                multi_spreadsheet.stubs(:import!).returns(true)
                 post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
                 response.should redirect_to("/importable/foo/#{multi_spreadsheet.id}")
               end
 
               it "should redirect to the object type's index view if import is successful and params[:return_to] is set to index" do
-                multi_spreadsheet.stub(:import!).and_return(true)
+                multi_spreadsheet.stubs(:import!).returns(true)
                 post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, return_to: 'index', :use_route => :importable
                 response.should redirect_to("/foos")
               end
 
+              it "should redirect back to the import view if import is successful and params[:return_to] is set to import" do
+                multi_spreadsheet.stubs(:import!).returns(true)
+                post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, return_to: 'import', :use_route => :importable
+                response.should redirect_to("/importable/foo")
+              end
+
               it "should render 'new' if import is unsuccessful" do
-                multi_spreadsheet.stub(:import!).and_return(false)
+                multi_spreadsheet.stubs(:import!).returns(false)
                 post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
                 response.should render_template("spreadsheets/new")
               end
-
+              
               it "should prevent the current step from changing if import is unsuccessful" do
-                multi_spreadsheet.stub(:import!).and_return(false)
+                multi_spreadsheet.stubs(:import!).returns(false)
                 post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
                 assigns(:spreadsheet).current_step.should eq 'choose_worksheet'
               end
-
+              
               it "should render 'new' if the file upload is invalid" do
-                multi_spreadsheet.stub(:valid?).and_return(false)
+                multi_spreadsheet.stubs(:valid?).returns(false)
                 post :create, type: 'foo', current_step: 'choose_worksheet', spreadsheet_id: multi_spreadsheet.id, :use_route => :importable
                 response.should render_template("spreadsheets/new")
               end
@@ -167,7 +198,7 @@ module Importable
       end
 
       describe "GET show" do
-        it "assigns the importable spreadsheet identified by params[:id] as @spreadsheet" do
+        it "should assign the importable spreadsheet identified by params[:id] as @spreadsheet" do
           get :show, type: 'foo', id: multi_spreadsheet.id, :use_route => :importable
           assigns(:spreadsheet).should eq multi_spreadsheet
         end