rails_spreadsheet_reader 0.1.4 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTllZmRmOTIyYzY2OTRhMjRlMTM2NGNhODYyOWNlMDk3NmRiNWY4Yg==
+    NGQ3ZmFlMDQxYjBjNDExOGEwZGZiMmQ2YjkxNmQ4ZGM5ZmQ3ZWUwZg==
   data.tar.gz: !binary |-
-    NjQwOGJlNmE2ZGZhMWE1NTc2NTEzNDIyNTI2YzUwNGQ5Mjg1ZDEzYg==
+    MDlhNjBkZDZkYThkYjg0ZmE2ZmY4ZDQ5MjZjYjc0ZjJhMGE2ZGY4OQ==
 SHA512:
   metadata.gz: !binary |-
-    NTdjNWQ1MjU1MTQzZTczNjVhNDdlZjdlZmU5NzA2ODc4ODYyZjgzZTFjMDU2
-    ZjRjN2Q5NTFkNWU4MjJjMDQ5NWM1MjBmMTNkNzRiY2IzZjliOGI5NjBjNmNm
-    NWIxZDgwM2ZmNjE0NDA3NGQ0NWZjYzkwNGJkNzAwM2Q2MDJlMjI=
+    YmQ1YjRmNWM2NTdmMWQxZGI0NmRmYmRhMWFmMThkNzdmOGM0M2MwMDkyZDY4
+    ZjVkMzMxZTAyMWNkZjM0NjY5NzY3ZDQwYzJjZjdmYmU2OTIzMzMyOTcyMTc1
+    NmVjZWU1YzVlOTM1NzdhODk3NTFiNGVhZThhOTUzY2RjNjk5Nzc=
   data.tar.gz: !binary |-
-    NDYwMTdmZDc1MmY2YWE4ZDczZGQ3ZDgxZjBhMzg2YzI4MzIwZTVhNDU3NGU3
-    M2U0ZGE1MDFmNmMzY2ZkOWRmYzdlYTgxODVlYzUzNjQzN2VmMzk5M2JhY2Vh
-    Yzk4OTQwMmM1Zjk1NTY3ZGY2ODYyM2ZiMTdkNjVhZTY0MDMzMTM=
+    ZjEwNzYxZDE4MzQ5OWZmYTM3MzNkMjEyYmVlZGEzNzRlOTU2MjMyZjBjYzlh
+    MzkwODMxMGY4OWVmM2ZkZjI0ZWVkZTAyZDUxN2Y1YzVmZGJiZWI3ODNiNmE5
+    NTEyYjRjMTE4YWM0NzMzYTM0OWNmMWEzZGM1ZmQ2NzI5ZDRhYzI=

data/lib/generators/rails/spreadsheet_generator.rb

@@ -7,13 +7,18 @@ module Rails
 
       source_root File.expand_path('../templates', __FILE__)
       argument :name, :type => :string
+      class_option :models, type: :array, aliases: '-m', default: ['Model1', 'Model2']
+      class_option :simple, default: false
+      class_option :attributes, aliases: '-a', default: ['attr1', 'attr2']
 
       def generate_spreadsheet
+        puts 'hola'
         file_prefix = set_filename(name)
         @spreadsheet_name = set_spreadsheet_name(name)
-        template 'spreadsheet.rb', File.join(
-            'app/spreadsheet_reader', "#{file_prefix}_spreadsheet.rb"
-        )
+        @models = @options[:models]
+        @simple = @options[:simple]
+        @attributes = @options[:attributes]
+        template 'spreadsheet.rb', "app/spreadsheet_reader/#{file_prefix}_spreadsheet.rb"
       end
 
       private

data/lib/generators/rails/templates/spreadsheet.rb

@@ -1,68 +1,39 @@
 class <%= @spreadsheet_name %>Spreadsheet < RailsSpreadsheetReader::Base
 
-  # add the columns you want to read:
-  # attr_accessor :attr1, :attr2, :attr3
+  # Add alias names for excel columns
+  # attr_accessor <%= @attributes.map{|a| ":#{a}"}.join(', ') %>
 
-  # add validations to your fields
+  # Add validation for your fields
   # validates_presence_of :attr1
 
-  # map this model attributes to your spreadsheet attributes
-  # you can use a hash { attr1: 0, attr2: 1, attr3: 2, ... }
-  # or a array %w(attr1 attr2 attr3 ...)
-
-  def self.columns
-    # return { attr1: 0, attr2: 1, ... }
+  # Map attributes to your spreadsheet columns (0-based).
+  # You can use a hash { attr1: 0, attr2: 1, attr3: 2, ... }
+  # or an array %w(attr1 attr2 attr3 ...) (which maps each key to their index).
+  def self.headers
+    {<%= @attributes.map.with_index{|a,i| "#{a}: #{i}"}.join(', ') %>}
   end
 
-  # set the row number where the data start, default is 2 (1-based)
+  # Set the row number where the data start, default is 2 (1-based)
   def self.starting_row
     2
   end
 
-  def self.validate_multiple_rows(row_collection)
-    # This method is called when all rows of row_collection are valid. The main
-    # idea of this method is to run validations that have to do with
-    # the set of rows of the excel. For example, you can check here if a
-    # excel column is unique. It have to raise an exception if there was
-    # an error with a certain row.
-    #
-    # Example:
-    #
-    # def self.validate_multiple_rows(row_collection)
-    #   username_list = []
-    #   row_collection.rows.each do |row|
-    #     if username_list.include?(row.username)
-    #       row_collection.invalid_row = row
-    #       row.errors[:username] = 'is unique'
-    #       raise 'Validation Error'
-    #     else
-    #       username_list << row.username
-    #     end
-    #   end
-    # end
-    #
+  # Returns 1 or more ActiveRecord classes where data will be saved
+  def self.models
+    <%= @models.count == 1 ? @models.first : @models.join(', ') %>
   end
 
-  def self.persist(row_collection)
-    # This method is called after the self.validate_multiple_rows method
-    # only if it have not raised an exception. The idea of this method
-    # is to persist the row's data. If there was an error with a certain
-    # row, you have to Rollback the valid transactions, set the
-    # invalid error to the row_collection and set the row errors to the
-    # row object.
-    #
-    # Example:
-    # def self.persist(row_collection)
-    #   User.transaction do
-    #     row_collection.rows.each do |row|
-    #       user = User.new(attr1: row.attr1, attr2: row.attr2, ...)
-    #       unless user.save
-    #         row_collection.set_invalid_row(row, user) # pass the model with errors as second parameter
-    #         rollback # use the rollback helper to rollback the transaction.
-    #       end
-    #     end
-    #   end
-    # end
+  # Map a spreadsheet instance to model parameters
+  <% @models.each do |model| %>
+  def <%= model.downcase %>
+    # Returns { attr1: self.attr1, attr2: self.attr2 }
   end
+  <% end %>
+
+  # Persist
+  #def persist
+    # Create or save your record. By default, it will use your methods
+    # defined above (<%= @models.map{|m| m.downcase}.join(', ') %>)
+  #end
 
 end

data/lib/rails_spreadsheet_reader/base.rb

@@ -7,32 +7,54 @@ module RailsSpreadsheetReader
   class Base
 
     include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
 
     class MethodNotImplementedError < StandardError; end
     class InvalidTypeError < StandardError; end
 
     attr_accessor :row_number
+    attr_accessor :record_with_error
+    attr_accessor :copied_errors
+    attr_accessor :collection
 
-    attr_accessor :models_with_errors
+    BASE_ATTRIBUTES = %w(row_number record_with_error copied_errors collection)
 
-    # Errors should be copied in a validation callback because valid?
-    # method flushes errors.
-    validate :copy_errors_on_validation
+    validate :check_record_with_error
 
-    def copy_errors_on_validation
-      self.models_with_errors ||= []
-      self.models_with_errors.each do |model|
-        model.errors.full_messages.each do |msg|
-          errors.add(:base, msg)
+    def check_record_with_error
+      if record_with_error.present? and record_with_error.errors.any?
+        record_with_error.errors.full_messages.each do |msg|
+          @errors.add(:base, msg)
         end
       end
     end
 
-    # Models are added models_with_errors. They will be copied in to self.errors on
-    # copy_errors_on_validation callback
-    def copy_errors(model)
-      self.models_with_errors ||= []
-      self.models_with_errors << model
+    def self.last_record
+      @last_record ||= nil
+    end
+
+    def self.last_record=(record)
+      @last_record = record
+    end
+
+    def models
+      fail(
+          MethodNotImplementedError,
+          'Please implement this method in your class.'
+      )
+    end
+
+    def persist
+      models = self.class.models.is_a?(Array) ? self.class.models : [self.class.models]
+      models.each do |model|
+        method_name = model.model_name.human.downcase
+        if respond_to?(method_name)
+          instance = model.new(send(model.model_name.human.downcase))
+        else
+          instance = model.new(as_json(except: BASE_ATTRIBUTES))
+        end
+        instance.save!
+      end
     end
 
     # Defines the starting row of the excel where the class should start reading the data.
@@ -48,19 +70,19 @@ module RailsSpreadsheetReader
     # a Array of strings/symbols (representing columns names) or a Hash (which map column names to columns indexes).
     #
     # Array Example
-    #   def self.columns
+    #   def self.headers
     #     [:username, :email, :gender]
     #   end
     #
     # Hash Example
-    #   def self.columns
+    #   def self.headers
     #     { :username => 0, :email => 1, :gender => 2 }
     #   end
     #
     # == Returns:
     # An Array or a Hash defining the columns of the excel.
     #
-    def self.columns
+    def self.headers
       fail(
           MethodNotImplementedError,
           'Please implement this method in your class.'
@@ -73,11 +95,11 @@ module RailsSpreadsheetReader
     # order of the columns.
     #
     # For example, given the following self.columns definition
-    #   def self.columns
+    #   def self.headers
     #     [:username, :email, :gender]
     #   end
     # Or
-    #   def self.columns
+    #   def self.headers
     #     { :username => 0, :email => 1, :gender => 2 }
     #   end
     # Row.formatted([username email@test.cl male]) will return
@@ -111,6 +133,7 @@ module RailsSpreadsheetReader
     #   Array or Hash of values which represents an excel column.
 
     def initialize(arr_or_hash = {})
+      self.copied_errors = ActiveModel::Errors.new(self)
       if arr_or_hash.is_a?(Array)
         super(self.class.formatted_hash(arr_or_hash))
       else
@@ -118,66 +141,39 @@ module RailsSpreadsheetReader
       end
     end
 
-    # This method is called when all rows of row_collection are valid. The main
-    # idea of this method is to run validations that have to do with
-    # the set of rows of the excel. For example, you can check here if a
-    # excel column is unique:
-    #
-    # Example:
-    #
-    # def self.validate_multiple_rows(row_collection)
-    #   username_list = []
-    #   row_collection.each do |row|
-    #     if username_list.include?(row.username)
-    #       row_collection.invalid_row = row
-    #       row.errors[:username] = 'is unique'
-    #     else
-    #       username_list << row.username
-    #     end
-    #   end
-    # end
-    #
-    # == Parameters:
-    # row_collection::
-    #   SpreadsheetReader::RowCollection instance
-    def self.validate_multiple_rows(row_collection)
-
-    end
-
-    # This method is called after the self.validate_multiple_rows method
-    # only if it have not raised an exception. The idea of this method
-    # is to persist the row's data. If there was an error with a certain
-    # row, you have to Rollback the valid transactions, set the
-    # invalid error to the row_collection and set the row errors to the
-    # row object.
-    #
-    # Example:
-    # def self.persist(row_collection)
-    #   User.transaction do
-    #     row_collection.each do |row|
-    #       user = User.new(attr1: row.attr1, attr2: row.attr2, ...)
-    #       unless user.save
-    #         row_collection.set_invalid_row(row, user)  # pass the model with errors as second parameter
-    #         rollback # use the rollback helper to rollback the transaction.
-    #       end
-    #     end
-    #   end
-    # end
+    # Persist all rows of collection if they all are valid
     #
     # == Parameters:
     # row_collection::
     #   SpreadsheetReader::RowCollection instance
-    def self.persist(row_collection)
-
+    def self.persist(collection)
+      if collection.valid?
+        ActiveRecord::Base.transaction do
+          collection.each do |row|
+            # If any of validations fail ActiveRecord::RecordInvalid gets raised.
+            # If any of the before_* callbacks return false the action is cancelled and save! raises ActiveRecord::RecordNotSaved.
+            begin
+              row.persist
+            rescue ActiveRecord::RecordInvalid => e
+              row.record_with_error = e.record
+              collection.invalid_row = row
+              rollback
+            rescue ActiveRecord::RecordNotSaved => e
+              row.model_with_error = e.record
+              collection.invalid_row = row
+              rollback
+            end
+          end
+        end
+      end
     end
 
-    def self.open_spreadsheet(spreadsheet_file)
+    def self.open(spreadsheet_file)
       Roo::Spreadsheet.open(spreadsheet_file)
     end
 
-    # Read and validates the given #spreadsheet_file. First calls
-    # #validate_rows method which run #ActiveModel::Model.valid? on each row.
-    # Then calls #validate_multiple_rows and finally ends with #persist
+    # Read and validates the given #spreadsheet_file. Persistence is triggered
+    # after all validation pass
     #
     # == Parameters:
     # spreadsheet_file::
@@ -185,20 +181,27 @@ module RailsSpreadsheetReader
     # == Returns:
     # row_collection::
     #   SpreadsheetReader::RowCollection instance
-    def self.read_spreadsheet(spreadsheet_file)
+    def self.read(spreadsheet_file)
 
-      if columns.empty?
+      if headers.empty?
         raise MethodNotImplementedError
       end
 
-      spreadsheet = open_spreadsheet(spreadsheet_file)
-      row_collection = RailsSpreadsheetReader::RowCollection.new
+      spreadsheet = open(spreadsheet_file)
+      collection = RailsSpreadsheetReader::RowCollection.new
+
+      # Populate collection
+      (starting_row..spreadsheet.last_row).each do |row_number|
+        parameters = formatted_hash(spreadsheet.row(row_number))
+        parameters[:row_number] = row_number
+        parameters[:collection] = collection
+        collection << self.new(parameters)
+      end
 
-      validate_rows(spreadsheet, row_collection)
-      validate_multiple_rows(row_collection) if row_collection.valid?
-      persist(row_collection) if row_collection.valid?
-      row_collection
+      # Validation and persist
+      persist(collection)
 
+      collection
     end
 
     # Transform an array [a0, a1, a2, ...] to a Hash { a0 => 0, a1 => 1, etc }
@@ -209,22 +212,11 @@ module RailsSpreadsheetReader
 
     private
 
-    # Calls row.valid? on every row of the spreadsheet.
-    # Stops when a row is an invalid ActiveModel::Model.
-    def self.validate_rows(spreadsheet, row_collection)
-      (starting_row..spreadsheet.last_row).each do |number|
-        hash = formatted_hash(spreadsheet.row(number))
-        hash[:row_number] = number
-        row_collection.push self.new(hash)
-        break if row_collection.invalid?
-      end
-    end
-
     # Returns the Hash representation of the defined columns
     def self.format
 
-      if columns.is_a?(Array) or columns.is_a?(Hash)
-        return columns.is_a?(Array) ? array_to_hash(columns) : columns
+      if headers.is_a?(Array) or headers.is_a?(Hash)
+        return headers.is_a?(Array) ? array_to_hash(headers) : headers
       end
 
       fail(

data/lib/rails_spreadsheet_reader/row_collection.rb

@@ -8,20 +8,20 @@ module RailsSpreadsheetReader
       self.rows = []
     end
 
-    def push(row)
-      self.invalid_row = row if row.invalid?
+    def <<(row)
       self.rows << row
     end
 
-    def invalid_row=(row)
-      if row.invalid?
-        @invalid_row = row
-      end
-      # TODO: Throw exception maybe?
-    end
-
     def valid?
-      self.invalid_row.nil?
+      valid = true
+      rows.each do |row|
+        if row.invalid?
+          self.invalid_row = row
+          valid = false
+          break
+        end
+      end
+      valid
     end
 
     def invalid?
@@ -29,18 +29,17 @@ module RailsSpreadsheetReader
     end
 
     def errors
-      self.invalid_row.errors if invalid?
-    end
-
-    def set_invalid_row(row, model_with_errors)
-      row.copy_errors(model_with_errors)
-      self.invalid_row = row
+      invalid? ? self.invalid_row.errors : []
     end
 
     def each(&block)
       self.rows.each(&block)
     end
 
+    def count
+      self.rows.count
+    end
+
   end
 
 end

data/lib/rails_spreadsheet_reader/version.rb

@@ -1,3 +1,3 @@
 module RailsSpreadsheetReader
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/rails_spreadsheet_reader.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'factory_girl', '~> 4.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'generator_spec', '~> 0.9'
 
   spec.add_dependency 'roo', '~> 1.13'
   spec.add_dependency 'rails', '~> 4.2.0'

data/spec/base_spec.rb

@@ -1,8 +1,4 @@
-require 'spec_helper'
-require_relative 'models/invalid_column_spreadsheet'
-require_relative 'models/user_spreadsheet'
-require_relative 'models/user_invalid_spreadsheet'
-require_relative 'models/empty_column_spreadsheet.rb'
+require_relative 'spec_helper'
 
 def test_file(filename, ext)
   File.open(File.join TEST_DIR, "#{filename}.#{ext}")
@@ -11,7 +7,7 @@ end
 describe RailsSpreadsheetReader::Base do
 
   it 'not implementing columns method should raise an error' do
-    expect { RailsSpreadsheetReader::Base.columns }.to raise_error(RailsSpreadsheetReader::Base::MethodNotImplementedError)
+    expect { RailsSpreadsheetReader::Base.headers }.to raise_error(RailsSpreadsheetReader::Base::MethodNotImplementedError)
   end
 
   it 'format method should raise an error if columns method is not valid' do
@@ -28,16 +24,16 @@ describe RailsSpreadsheetReader::Base do
 
   it 'Base.open_spreadsheet should return a Roo::Base instance' do
     file = test_file 'users', :csv
-    roo_row = RailsSpreadsheetReader::Base.open_spreadsheet file
+    roo_row = RailsSpreadsheetReader::Base.open file
     expect(roo_row.is_a?(Roo::Base)).not_to eq(false)
   end
 
-  it 'empty columns should raise an error' do
+  it 'empty headers should raise an error' do
     file = test_file 'users', :csv
-    expect { EmptyColumnSpreadsheet.read_spreadsheet(file) }.to raise_error(RailsSpreadsheetReader::Base::MethodNotImplementedError)
+    expect { EmptyColumnSpreadsheet.read(file) }.to raise_error(RailsSpreadsheetReader::Base::MethodNotImplementedError)
   end
 
-  it '#formatted_hash should work in a derived class which overrides "columns" method' do
+  it '#formatted_hash should work in a derived class which overrides "headers" method' do
     formatted_hash = UserSpreadsheet.formatted_hash %w(username email@test.com male)
     expect(formatted_hash).to eq({ username: 'username', email: 'email@test.com', gender: 'male' })
 
@@ -46,41 +42,96 @@ describe RailsSpreadsheetReader::Base do
   end
 
   it '#new from derived class' do
-    user_spreadsheet = UserSpreadsheet.new(%w(username email@test.com male))
-    expect(user_spreadsheet.username).to eq('username')
-    expect(user_spreadsheet.email).to eq('email@test.com')
-    expect(user_spreadsheet.gender).to eq('male')
-
-    user_spreadsheet = UserSpreadsheet.new({ email: 'email@test.com', gender: 'male', username: 'username' })
-    expect(user_spreadsheet.username).to eq('username')
-    expect(user_spreadsheet.email).to eq('email@test.com')
-    expect(user_spreadsheet.gender).to eq('male')
+    row = UserSpreadsheet.new(%w(username email@test.com male))
+    expect(row.username).to eq('username')
+    expect(row.email).to eq('email@test.com')
+    expect(row.gender).to eq('male')
+
+    row = UserSpreadsheet.new({ email: 'email@test.com', gender: 'male', username: 'username' })
+    expect(row.username).to eq('username')
+    expect(row.email).to eq('email@test.com')
+    expect(row.gender).to eq('male')
   end
 
   it '#valid? should work as desired (derived class)' do
-    valid_user_spreadsheet = UserSpreadsheet.new({ email: 'email@test.com', gender: 'male', username: 'username' })
-    expect(valid_user_spreadsheet.valid?).to eq(true)
+    valid_row = UserSpreadsheet.new({ email: 'email@test.com', gender: 'male', username: 'username' })
+    expect(valid_row.valid?).to eq(true)
 
-    invalid_user_spreadsheet = UserSpreadsheet.new({ gender: 'male', username: 'username' })
-    expect(invalid_user_spreadsheet.valid?).to eq(false)
+    invalid_row = UserSpreadsheet.new({ gender: 'male', username: 'username' })
+    expect(invalid_row.valid?).to eq(false)
   end
 
   it '#read_spreadsheet should be invalid because a row is not valid' do
     file = test_file 'users_invalid', :csv
-    row_collection = UserSpreadsheet.read_spreadsheet(file)
+    row_collection = UserSpreadsheet.read(file)
     expect(row_collection.valid?).to eq(false)
     expect(row_collection.invalid_row.row_number).to eq(2)
     expect(row_collection.errors.full_messages).to eq(["Email can't be blank"])
   end
 
-  it 'copy_errors' do
-    user_spreadsheet = UserSpreadsheet.new
-    user_spreadsheet.errors.add(:username, 'is unique')
-    expect(user_spreadsheet.valid?).to eq(false)
-    expect(user_spreadsheet.invalid?).to eq(true)
-    valid = EmptyColumnSpreadsheet.new
-    valid.copy_errors(user_spreadsheet)
-    expect(valid.valid?).to eq(false)
+  it 'A row with an invalid record should be invalid' do
+    row = UserSpreadsheet.new
+    invalid_record = User.make_invalid
+    row.record_with_error = invalid_record
+    expect(row.valid?).to eq(false)
+    expect(row.invalid?).to eq(true)
+  end
+
+  it 'A row should persist a valid record' do
+    params = User.make_valid.as_json
+    params.delete('id')
+    expect(User.exists?(params)).to eq(false)
+    row = UserSpreadsheet.new(params)
+    row.persist
+    expect(User.exists?(params)).to eq(true)
+  end
+
+  it 'A row should fail when persisting an invalid record' do
+    params = User.make_invalid.as_json
+    params.delete('id')
+    UserSpreadsheet.headers
+    UserSpreadsheet.models
+    row = UserSpreadsheet.new(params)
+    expect { row.persist }.to raise_error(ActiveRecord::RecordInvalid)
+  end
+
+  it 'Should not save records to database when failing' do
+    file = test_file 'student_benefit_invalid', :csv
+    student_count = Student.count
+    benefit_count = Benefit.count
+    result = StudentBenefitSpreadsheet.read(file)
+    expect(result.valid?).to eq(false)
+    expect(student_count).to eq(Student.count)
+    expect(benefit_count).to eq(Benefit.count)
+  end
+
+  it 'Should save multiple records to database' do
+    file = test_file 'student_benefit', :csv
+    student_count = Student.count
+    benefit_count = Benefit.count
+    result = StudentBenefitSpreadsheet.read(file)
+    expect(result.valid?).to eq(true)
+    expect(student_count).to eq(Student.count - result.count)
+    expect(benefit_count).to eq(Benefit.count - result.count)
+  end
+
+  it 'Spreadsheet.models order does matter when persisting' do
+    file = test_file 'employee_enterprise', :csv
+    result = EmployeeEnterpriseSpreadsheet.read(file)
+    expect(result.valid?).to eq(true)
+  end
+
+  it 'Spreadsheet with custom persist works as expected' do
+    file = test_file 'employee_enterprise', :csv
+    result = CustomPersistSpreadsheet.read(file)
+    expect(result.valid?).to eq(true)
+  end
+
+  it 'Custom validator using uniqueness inside the same excel' do
+    file = test_file 'users_invalid', :csv
+    result = UserInvalidSpreadsheet.read(file)
+    expect(result.valid?).to eq(false)
+    expect(result.invalid_row.errors[:username]).to eq(["Username already defined in excel at row 4"])
   end
 
 end

data/spec/db/database.rb

@@ -0,0 +1,74 @@
+require 'sqlite3'
+require 'active_record'
+
+# Connect to an in-memory sqlite3 database
+ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: ':memory:'
+)
+
+# Drop tables
+connection = ActiveRecord::Base.connection
+connection.tables.each do |table|
+  connection.drop_table(table)
+end
+
+# Define a minimal database schema
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string :email
+    t.string :username
+    t.string :name
+    t.string :gender
+  end
+  create_table :students, force: true do |t|
+    t.string :code
+    t.string :name
+  end
+  create_table :benefits, force: true do |t|
+    t.string :code
+    t.string :name
+  end
+  create_table :employees, force: true do |t|
+    t.string :name
+    t.references :enterprise
+  end
+  create_table :enterprises, force: true do |t|
+    t.string :name
+  end
+end
+
+# Define the models
+class User < ActiveRecord::Base
+  validates_presence_of :email, :username
+  validates_uniqueness_of :username, :email
+
+  def self.make_valid
+    User.new(username: 'username', email: 'username@example.com')
+  end
+
+  def self.make_invalid
+    User.new(username: 'username')
+  end
+
+end
+
+class Student < ActiveRecord::Base
+  validates_uniqueness_of :code
+  validates_presence_of :code
+end
+
+class Benefit < ActiveRecord::Base
+  validates_uniqueness_of :code
+  validates_presence_of :code
+end
+
+class Employee < ActiveRecord::Base
+  belongs_to :enterprise
+end
+
+class Enterprise < ActiveRecord::Base
+  has_many :employees
+  validates_presence_of :name
+  validates_uniqueness_of :name
+end

data/spec/files/employee_enterprise.csv

@@ -0,0 +1,8 @@
+EmployeeName,EnterpriseName
+p1,e1
+p2,e2
+p3,e3
+p4,e4
+p5,e5
+p6,e6
+p7,e7

data/spec/files/student_benefit.csv

@@ -0,0 +1,10 @@
+Name,Benefit,Code
+Student1,Benefit1,Code1
+Student2,Benefit2,Code2
+Student3,Benefit3,Code3
+Student4,Benefit4,Code4
+Student5,Benefit5,Code5
+Student6,Benefit6,Code6
+Student7,Benefit7,Code7
+Student8,Benefit8,Code8
+Student9,Benefit9,Code9

data/spec/files/student_benefit_invalid.csv

@@ -0,0 +1,3 @@
+Name,Benefit,Code
+Student1,Benefit1,Code1
+Student2,Benefit2,Code1

data/spec/lib/generators/generator_spec.rb

@@ -0,0 +1,28 @@
+# spec/lib/generators/test/test_generator_spec.rb
+
+require "generator_spec"
+require_relative '../../../lib/generators/rails/spreadsheet_generator'
+
+describe Rails::Generators::SpreadsheetGenerator, type: :generator do
+
+  destination File.expand_path("../../tmp", __FILE__)
+  arguments %w(name -m User)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "creates a test initializer" do
+    expect(destination_root).to have_structure do
+      directory 'app' do
+        directory 'spreadsheet_reader' do
+          file 'name_spreadsheet.rb' do
+            contains 'class NameSpreadsheet'
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/row_collection_spec.rb

@@ -1,46 +1,35 @@
 require 'spec_helper'
-require_relative 'models/invalid_column_spreadsheet'
-require_relative 'models/user_spreadsheet'
-require_relative 'models/user_invalid_spreadsheet'
-require_relative 'models/empty_column_spreadsheet.rb'
+require_relative 'spreadsheets/invalid_column_spreadsheet'
+require_relative 'spreadsheets/user_spreadsheet'
+require_relative 'spreadsheets/user_invalid_spreadsheet'
+require_relative 'spreadsheets/empty_column_spreadsheet.rb'
 
 describe RailsSpreadsheetReader::RowCollection do
 
-  it 'empty properties' do
+  it 'New collection should be empty' do
     collection = RailsSpreadsheetReader::RowCollection.new
     expect(collection.rows).to eq([])
     expect(collection.invalid?).to eq(false)
     expect(collection.valid?).to eq(true)
-    expect(collection.errors).to eq(nil)
+    expect(collection.errors).to eq([])
   end
 
-  it 'push rows' do
+  it 'Pushed rows should be saved into the collection' do
     collection = RailsSpreadsheetReader::RowCollection.new
-    user_spreadsheet = UserSpreadsheet.new
-    collection.push(user_spreadsheet)
+    row = UserSpreadsheet.new
+    collection << row
     expect(collection.rows.count).to eq(1)
+    expect(collection.rows.first).to eq(row)
   end
 
-  it 'push invalid rows' do
-    collection = RailsSpreadsheetReader::RowCollection.new
-    user_spreadsheet = UserSpreadsheet.new
-    user_spreadsheet.make_invalid
-    expect(user_spreadsheet.invalid?).to eq(true)
-    collection.push(user_spreadsheet)
-    expect(collection.valid?).to eq(false)
-    expect(collection.invalid?).to eq(true)
-  end
-
-  it 'set_invalid_row' do
+  it 'A collection with an invalid row should be invalid' do
     collection = RailsSpreadsheetReader::RowCollection.new
     row = UserSpreadsheet.new
-    model = UserSpreadsheet.new
-    model.make_invalid
-    collection.push(row)
-    collection.set_invalid_row(row, model)
+    row.make_invalid
+    expect(row.invalid?).to eq(true)
+    collection << row
     expect(collection.valid?).to eq(false)
     expect(collection.invalid?).to eq(true)
-    expect(collection.invalid_row).to_not eq(nil)
   end
 
 end

data/spec/spec_helper.rb

@@ -18,6 +18,10 @@
 require File.expand_path('../../lib/rails_spreadsheet_reader', __FILE__)
 TEST_DIR =  File.join(File.dirname(__FILE__), 'files')
 
+require_relative 'db/database'
+
+Dir["#{File.dirname(__FILE__)}/spreadsheets/*.rb"].each {|file| require file }
+
 RSpec.configure do |config|
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.

data/spec/spreadsheets/custom_persist_spreadsheet.rb

@@ -0,0 +1,27 @@
+class CustomPersistSpreadsheet < RailsSpreadsheetReader::Base
+
+  attr_accessor :employee_name, :enterprise_name
+  validates_presence_of :employee_name, :enterprise_name
+
+  def self.headers
+    %w(employee_name enterprise_name)
+  end
+
+  def self.models
+    [Enterprise, Employee]
+  end
+
+  def employee
+    { name: employee_name }
+  end
+
+  def enterprise
+    { name: enterprise_name }
+  end
+
+  def persist
+    enterprise = Enterprise.find_or_create_by(name: enterprise_name)
+    Employee.create!(name: enterprise_name, enterprise: enterprise)
+  end
+
+end

data/spec/spreadsheets/employee_enterprise_spreadsheet.rb

@@ -0,0 +1,22 @@
+class EmployeeEnterpriseSpreadsheet < RailsSpreadsheetReader::Base
+
+  attr_accessor :employee_name, :enterprise_name
+  validates_presence_of :employee_name, :enterprise_name
+
+  def self.headers
+    %w(employee_name enterprise_name)
+  end
+
+  def self.models
+    [Enterprise, Employee]
+  end
+
+  def employee
+    { name: employee_name, enterprise: Enterprise.find_by(name: enterprise_name) }
+  end
+
+  def enterprise
+    { name: enterprise_name }
+  end
+
+end

data/spec/{models → spreadsheets}/invalid_column_spreadsheet.rb

@@ -1,6 +1,6 @@
 class InvalidColumnSpreadsheet < RailsSpreadsheetReader::Base
 
-  def self.columns
+  def self.headers
     10
   end
 

data/spec/spreadsheets/student_benefit_spreadsheet.rb

@@ -0,0 +1,23 @@
+class StudentBenefitSpreadsheet < RailsSpreadsheetReader::Base
+
+  attr_accessor :student_name, :benefit_name, :code
+
+  validates_presence_of :student_name, :benefit_name, :code
+
+  def self.headers
+    %w(student_name benefit_name code)
+  end
+
+  def self.models
+    [Student, Benefit]
+  end
+
+  def student
+    { name: student_name, code: code }
+  end
+
+  def benefit
+    { name: benefit_name, code: code }
+  end
+
+end

data/spec/spreadsheets/user_invalid_spreadsheet.rb

@@ -0,0 +1,23 @@
+class UserInvalidSpreadsheet < RailsSpreadsheetReader::Base
+
+  attr_accessor :username, :email, :gender, :birthday
+
+  validates_presence_of :username
+  validate :uniqueness_of_username
+
+  def self.headers
+    { :username => 0, :email => 1, :gender => 2, :birthday => 3 }
+  end
+
+  def uniqueness_of_username
+    if collection.present?
+      detected = collection.rows.find{|r| r.username == self.username and r.row_number < row_number }
+      errors.add(:username, "Username already defined in excel at row #{detected.row_number}") if detected.present?
+    end
+  end
+
+  def to_s
+    {username: username, email: email, gender: gender, birthday: birthday}
+  end
+
+end

data/spec/{models → spreadsheets}/user_spreadsheet.rb

@@ -1,15 +1,19 @@
 class UserSpreadsheet < RailsSpreadsheetReader::Base
 
-  attr_accessor :username, :email, :gender
+  attr_accessor :username, :email, :gender, :name
 
   validates_presence_of :username, :email
 
-  def self.columns
+  def self.headers
     { :username => 0, :email => 1, :gender => 2 }
   end
 
+  def self.models
+    User
+  end
+
   def make_invalid
-    errors[:username] = 'is invalid'
+    self.record_with_error = User.make_invalid
   end
 
 end

data/spec/user_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe User do
+
+  it 'Making an invalid user' do
+    user = User.make_invalid
+    expect(user.valid?).to eq(false)
+  end
+
+  it 'Making a valid user' do
+    user = User.make_valid
+    expect(user.valid?).to eq(true)
+  end
+
+  it 'Creating a user twice should fail' do
+    user1 = User.make_valid
+    user2 = User.make_valid
+    expect(user1.save).to eq(true)
+    expect(user2.save).to eq(false)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_spreadsheet_reader
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - muzk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: roo
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +142,23 @@ files:
 - lib/rails_spreadsheet_reader/version.rb
 - rails_spreadsheet_reader.gemspec
 - spec/base_spec.rb
+- spec/db/database.rb
+- spec/files/employee_enterprise.csv
+- spec/files/student_benefit.csv
+- spec/files/student_benefit_invalid.csv
 - spec/files/users.csv
 - spec/files/users_invalid.csv
-- spec/models/empty_column_spreadsheet.rb
-- spec/models/invalid_column_spreadsheet.rb
-- spec/models/user_invalid_spreadsheet.rb
-- spec/models/user_spreadsheet.rb
+- spec/lib/generators/generator_spec.rb
 - spec/row_collection_spec.rb
 - spec/spec_helper.rb
+- spec/spreadsheets/custom_persist_spreadsheet.rb
+- spec/spreadsheets/employee_enterprise_spreadsheet.rb
+- spec/spreadsheets/empty_column_spreadsheet.rb
+- spec/spreadsheets/invalid_column_spreadsheet.rb
+- spec/spreadsheets/student_benefit_spreadsheet.rb
+- spec/spreadsheets/user_invalid_spreadsheet.rb
+- spec/spreadsheets/user_spreadsheet.rb
+- spec/user_spec.rb
 homepage: https://github.com/HasuSoftware/rails_spreadsheet_reader
 licenses:
 - MIT
@@ -148,11 +185,20 @@ specification_version: 4
 summary: Provides an easy way to add model-based validations to excel files.
 test_files:
 - spec/base_spec.rb
+- spec/db/database.rb
+- spec/files/employee_enterprise.csv
+- spec/files/student_benefit.csv
+- spec/files/student_benefit_invalid.csv
 - spec/files/users.csv
 - spec/files/users_invalid.csv
-- spec/models/empty_column_spreadsheet.rb
-- spec/models/invalid_column_spreadsheet.rb
-- spec/models/user_invalid_spreadsheet.rb
-- spec/models/user_spreadsheet.rb
+- spec/lib/generators/generator_spec.rb
 - spec/row_collection_spec.rb
 - spec/spec_helper.rb
+- spec/spreadsheets/custom_persist_spreadsheet.rb
+- spec/spreadsheets/employee_enterprise_spreadsheet.rb
+- spec/spreadsheets/empty_column_spreadsheet.rb
+- spec/spreadsheets/invalid_column_spreadsheet.rb
+- spec/spreadsheets/student_benefit_spreadsheet.rb
+- spec/spreadsheets/user_invalid_spreadsheet.rb
+- spec/spreadsheets/user_spreadsheet.rb
+- spec/user_spec.rb

data/spec/models/user_invalid_spreadsheet.rb

@@ -1,24 +0,0 @@
-class UserInvalidSpreadsheet < RailsSpreadsheetReader::Base
-
-  attr_accessor :username, :email, :gender
-
-  validates_presence_of :username
-
-  def self.columns
-    { :username => 0, :email => 1, :gender => 2 }
-  end
-
-  def self.validate_multiple_rows(row_collection)
-    usernames = {}
-    row_collection.rows.each do |row|
-      if usernames.has_key?(row.username)
-        row_collection.invalid_row = row
-        row.errors[:username] = 'is unique'
-        break
-      else
-        usernames[row.username] = true
-      end
-    end
-  end
-
-end