importable 0.0.1

data/spec/lib/multi_step/import_helpers_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module MultiStep
+  class FooMultiStepImport
+    include MultiStep::ImportHelpers
+  
+    def sheets
+      # multiple fake sheets
+      [nil, nil]
+    end
+  end
+
+  describe ImportHelpers do
+    let(:foo_multi_step_import) { FooMultiStepImport.new }
+  
+    describe "#steps" do
+      it "should return a list of import steps" do
+        steps = foo_multi_step_import.steps
+        steps[0].should eq 'upload_file'
+        steps[1].should eq 'choose_worksheet'
+        steps[2].should eq 'import_data'
+      end
+    end
+
+    describe "#current_step" do
+      it "should initially return 'upload_file'" do
+        foo_multi_step_import.current_step.should eq 'upload_file'
+      end
+
+      it "should return whatever the current step is set to" do
+        foo_multi_step_import.current_step = 'moof'
+        foo_multi_step_import.current_step.should eq 'moof'
+      end
+    end
+  
+    describe "#first_step?" do
+      it "should return true if current step is 'upload_file'" do
+        foo_multi_step_import.current_step = 'upload_file'
+        foo_multi_step_import.first_step?.should be_true
+        foo_multi_step_import.current_step = 'moof'
+        foo_multi_step_import.first_step?.should be_false
+      end
+    end
+
+    describe "#last_step?" do
+      it "should return true if current step is 'import_data'" do
+        foo_multi_step_import.current_step = 'import_data'
+        foo_multi_step_import.last_step?.should be_true
+        foo_multi_step_import.current_step = 'moof'
+        foo_multi_step_import.last_step?.should be_false
+      end
+    end
+  
+    describe "#next_step" do
+      it "should step through each available step" do
+        foo_multi_step_import.current_step.should eq 'upload_file'
+        foo_multi_step_import.next_step
+        foo_multi_step_import.current_step.should eq 'choose_worksheet'
+        foo_multi_step_import.next_step
+        foo_multi_step_import.current_step.should eq 'import_data'
+      end
+
+      it "should step skip choosing worksheet if there's only one" do
+        foo_multi_step_import.stub(:sheets).and_return(['one fake worksheet'])
+
+        foo_multi_step_import.current_step.should eq 'upload_file'
+        foo_multi_step_import.next_step
+        foo_multi_step_import.current_step.should eq 'import_data'
+      end
+    end
+  
+    describe "#previous_step" do
+      before do
+        # fast forward
+        foo_multi_step_import.current_step = 'import_data'
+      end
+    
+      it "should step through each available step backwards" do
+        foo_multi_step_import.previous_step
+        foo_multi_step_import.current_step.should eq 'choose_worksheet'
+        foo_multi_step_import.previous_step
+        foo_multi_step_import.current_step.should eq 'upload_file'
+      end
+
+      it "should step skip choosing worksheet if there's only one" do
+        foo_multi_step_import.stub(:sheets).and_return(['one fake worksheet'])
+
+        foo_multi_step_import.current_step.should eq 'import_data'
+        foo_multi_step_import.previous_step
+        foo_multi_step_import.current_step.should eq 'upload_file'
+      end
+    end
+  end
+end

data/spec/lib/uploader_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Importable
+  describe Uploader do
+
+    let(:importable_spreadsheet) { Spreadsheet.new }
+
+    before do
+      Importable::Uploader.enable_processing = false
+      @uploader = Importable::Uploader.new(importable_spreadsheet, :file)
+    end
+
+    after do
+      Importable::Uploader.enable_processing = true
+    end
+
+    it "should not allow storing files that are not Excel spreadsheets" do
+      text_file = File.open support_file('text.txt')
+
+      lambda {
+        @uploader.store!(text_file)
+      }.should raise_error(
+        CarrierWave::IntegrityError,
+        'You are not allowed to upload "txt" files, allowed types: ["xls", "xlsx"]'
+      )
+    end
+  end
+end

data/spec/lib/validator_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Importable
+  describe Validator do
+    let(:valid_spreadsheet) do
+      spreadsheet_file = support_file('foo_required_field_valid.xlsx')
+      Spreadsheet.new(file: File.open(spreadsheet_file), object_type: 'foo_required_field')
+    end
+    let(:invalid_spreadsheet) do
+      spreadsheet_file = support_file('foo_required_field_invalid.xlsx')
+      Spreadsheet.new(file: File.open(spreadsheet_file), object_type: 'foo_required_field')
+    end
+
+    it "should be invalid if any underlying objects are invalid" do
+      invalid_spreadsheet.should_not be_valid
+    end
+
+    it "should generate a list of meaningful error messages" do
+      invalid_spreadsheet.valid?
+      messages =  invalid_spreadsheet.errors.messages[:doof]
+      messages[0].should eq "can't be blank (line 3)"
+      messages[1].should eq "can't be blank (line 4)"
+    end
+
+    it "should be valid if all underlying objects are valid" do
+      valid_spreadsheet.should be_valid
+    end
+  end
+end

data/spec/models/spreadsheet_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+module Importable
+  describe Spreadsheet do
+    let(:single_worksheet_importable_spreadsheet) do
+      spreadsheet_file = File.open support_file('foo_single_worksheet.xlsx')
+      Spreadsheet.new(object_type: 'foo', file: spreadsheet_file)
+    end
+
+    let(:multi_worksheet_importable_spreadsheet) do
+      spreadsheet_file = File.open support_file('foo_multi_worksheet.xlsx')
+      Spreadsheet.new(file: spreadsheet_file)
+    end
+
+    let(:older_excel_importable_spreadsheet) do
+      spreadsheet_file = File.open support_file('foo_single_worksheet.xls')
+      Spreadsheet.new(file: spreadsheet_file)
+    end
+
+    it "should be valid with valid attributes" do
+      single_worksheet_importable_spreadsheet.should be_valid
+    end
+
+    it "should be invalid without a file" do
+      spreadsheet = Spreadsheet.new(object_type: 'foo')
+      spreadsheet.should_not be_valid
+    end
+
+    describe "#headers" do
+      it "should return a list of header values" do
+        single_worksheet_importable_spreadsheet.headers.should eq %w[ a b c d ]
+      end
+    end
+
+    describe "#import!" do
+      it "should initialize a mapper to handle the actual importing" do
+        data = single_worksheet_importable_spreadsheet.rows
+        mapper = FooMapper.new(data)
+
+        FooMapper.should_receive(:new).and_return(mapper)
+
+        single_worksheet_importable_spreadsheet.import!
+      end
+    end
+
+    describe "#sheets" do
+      it "should return a list of header values" do
+        multi_worksheet_importable_spreadsheet.sheets.should eq %w[ Sheet1 Sheet2 ]
+      end
+    end
+
+    describe "#spreadsheet" do
+      it "should be an Excel spreadsheet object if the file is an xls file" do
+        older_excel_importable_spreadsheet.spreadsheet.should be_an Excel
+      end
+
+      it "should be an Excelx spreadsheet object if the file is an xlsx file" do
+        multi_worksheet_importable_spreadsheet.spreadsheet.should be_an Excelx
+      end
+    end
+
+    describe "#spreadsheet_class" do
+      it "should be an Excel class object if the file is an xls file" do
+        older_excel_importable_spreadsheet.spreadsheet_class.should eq Excel
+      end
+
+      it "should be an Excelx class object if the file is an xlsx file" do
+        multi_worksheet_importable_spreadsheet.spreadsheet_class.should eq Excelx
+      end
+    end
+
+    describe "#rows" do
+      it "should return the spreadsheet rows as a list of hashes" do
+        rows = single_worksheet_importable_spreadsheet.rows
+
+        rows.each do |row|
+          row.keys.should eq %w[ a b c d ]
+        end
+
+        rows[0].values.should eq [1, 2, 3, 4]
+        rows[1].values.should eq [2, 3, 4, 5]
+        rows[2].values.should eq [3, 4, 5, 6]
+        rows[3].values.should eq [4, 5, 6, 7]
+      end
+    end
+
+    describe "#mapper_class" do
+      it "should return the mapper class for the spreadsheet" do
+        mapper_class = single_worksheet_importable_spreadsheet.mapper_class
+        mapper_class.should eq FooMapper
+      end
+
+      it "should not care if the mappers have pluralization" do
+        spreadsheet_file = File.open support_file('foo_single_worksheet.xlsx')
+        spreadsheet = Spreadsheet.new(object_type: 'singular_widgets', file: spreadsheet_file)
+        spreadsheet.mapper_class.should eq SingularWidgetMapper
+        spreadsheet = Spreadsheet.new(object_type: 'singular_widget', file: spreadsheet_file)
+        spreadsheet.mapper_class.should eq SingularWidgetMapper
+        spreadsheet = Spreadsheet.new(object_type: 'plural_widgets', file: spreadsheet_file)
+        spreadsheet.mapper_class.should eq PluralWidgetsMapper
+        spreadsheet = Spreadsheet.new(object_type: 'plural_widget', file: spreadsheet_file)
+        spreadsheet.mapper_class.should eq PluralWidgetsMapper
+      end
+    end
+
+    describe "#mapper" do
+      it "should return the mapper instance for the spreadsheet" do
+        mapper = single_worksheet_importable_spreadsheet.mapper
+        mapper.should be_a FooMapper
+      end
+    end
+
+    describe "self#mapper_files" do
+      it "should list the available mapper files" do
+        Spreadsheet.mapper_files[0].ends_with?('foo_mapper.rb').should be_true
+        Spreadsheet.mapper_files[1].ends_with?('foo_required_field_mapper.rb').should be_true
+      end
+    end
+
+    describe "self#mapper_types" do
+      it "should list the available mapper types" do
+        Spreadsheet.mapper_types[0].should eq 'foo'
+        Spreadsheet.mapper_types[1].should eq 'foo_required_field'
+      end
+    end
+
+    describe "self#mapper_type_exists?" do
+      it "should return true if the supplied mapper type exists" do
+        Spreadsheet.mapper_type_exists?('foo').should be_true
+        Spreadsheet.mapper_type_exists?('foo_required_field').should be_true
+      end
+
+      it "should return false if the supplied mapper type doesn't exist" do
+        Spreadsheet.mapper_type_exists?('bar').should be_false
+        Spreadsheet.mapper_type_exists?('').should be_false
+        Spreadsheet.mapper_type_exists?(nil).should be_false
+      end
+
+      it "should not care about pluralization" do
+        Spreadsheet.mapper_type_exists?('singular_widget').should be_true
+        Spreadsheet.mapper_type_exists?('singular_widgets').should be_true
+        Spreadsheet.mapper_type_exists?('plural_widget').should be_true
+        Spreadsheet.mapper_type_exists?('plural_widgets').should be_true
+        Spreadsheet.mapper_type_exists?('foos').should be_true
+        Spreadsheet.mapper_type_exists?('foo_required_fields').should be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
+require 'rspec/rails'
+require 'capybara/rspec'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = false
+end
+
+def support_file(name)
+  File.expand_path("spec/support/#{name}")
+end

data/spec/support/text.txt

@@ -0,0 +1 @@
+text