rails_spreadsheet_reader 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 8cb068a98505cc537d62613ee7c32c50035f15c4
-  data.tar.gz: a716652b67871f0e27523ee725dbbfdccb50b288
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTMwNzIzNDhlOTA5ZDU4NzYxNzQ4OWY3ODhiNWZlZjhhZmI0NDg3ZA==
+  data.tar.gz: !binary |-
+    NTZjOGQwNDdjZDVkYzIyNzkyNGZjM2Y0YTc2Zjg3ZGI4YWI1NzRmNw==
 SHA512:
-  metadata.gz: 6586a01666ce199b41deee31f7c3b98f6beea0f95547b5b512f9263c654086ebb1d02ac4489e8bab343b4f5f221189d7123852a4a136df277e6c68d3a31f575d
-  data.tar.gz: e08e369c5df81a842857f704938cdd7a4ad42a8e86bfc0bd5b37df253ba1bf866b6fbb508bdecebf2d27bb60e0da5a76c77297eba558011a34aef47377d820ae
+  metadata.gz: !binary |-
+    NGNkMjk0NDM5YThjMzE3NWNhMTE1MTIyZjhiOTQ0NTMwZjUwZjM1MmQxZDIw
+    ZGZiNTA3ZGYxMDU5YjFlNTAwMTg2NTcwYTkxNTliN2FkZWM2ODk1YzgzNzM1
+    YTg5Y2M0YzU4MWQxMGY0MWI3ZTRjZmZmNzVkZDEwYzBlMmMyMzA=
+  data.tar.gz: !binary |-
+    MmUzMDAzZTJkZDQ5OWNmNDZmMGIxNDYyYzI1MzUxYWMwYjdkNjExYTBkMTQz
+    ZDRiZTI2YTI5MDI2NjM3YWZhYTk3ZmMwNmNhZDNlZTIzNTFhMTdkNWQzYzVk
+    Y2Q0MWVlNGNkNDcxMzI5NjRlMGJkNWQ3NWQxNTZkODE2ZDQ5YzA=

data/README.md

@@ -19,15 +19,16 @@ Or install it yourself as:
 ## Usage
 
 Run
+
     $ rails g spreadsheet name
 
 to create a spreadsheet reader into app/spreadsheet_reader directory.
 
-Edit the columns, validate_multiple_rows and persist methods depending on your use-case.
+Edit the **self.columns**, **self.validate_multiple_rows** and **self.persist** methods depending on your use-case.
 
 ## Example
 
-TODO: Add example app link
+Example rails app: https://github.com/muZk/spreadsheet_reader_example
 
 ## Contributing
 

data/lib/rails_spreadsheet_reader/base.rb

@@ -106,18 +106,16 @@ module RailsSpreadsheetReader
     # 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.
+    # excel column is unique:
     #
     # Example:
     #
     # def self.validate_multiple_rows(row_collection)
     #   username_list = []
-    #   row_collection.rows.each do |row|
+    #   row_collection.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
@@ -141,7 +139,7 @@ module RailsSpreadsheetReader
     # Example:
     # def self.persist(row_collection)
     #   User.transaction do
-    #     row_collection.rows.each do |row|
+    #     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
@@ -175,20 +173,16 @@ module RailsSpreadsheetReader
     def self.read_spreadsheet(spreadsheet_file)
 
       if columns.empty?
-        raise NotImplementedError
+        raise MethodNotImplementedError
       end
 
       spreadsheet = open_spreadsheet(spreadsheet_file)
       row_collection = RailsSpreadsheetReader::RowCollection.new
 
-      begin
-        validate_rows(spreadsheet, row_collection)
-        validate_multiple_rows(row_collection)
-        persist(row_collection)
-        row_collection
-      rescue
-        row_collection
-      end
+      validate_rows(spreadsheet, row_collection)
+      validate_multiple_rows(row_collection) if row_collection.valid?
+      persist(row_collection) if row_collection.valid?
+      row_collection
 
     end
 
@@ -200,15 +194,14 @@ module RailsSpreadsheetReader
 
     private
 
-    # Calls row.valid? on every row of the spreadsheet. Raises an exception
-    # when row_collection.valid? returns false. It happens when
-    # the current row is an invalid ActiveModel::Model.
+    # 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)
-        raise 'Invalid Row in Excel' unless row_collection.valid?
+        break if row_collection.invalid?
       end
     end
 
@@ -233,4 +226,4 @@ module RailsSpreadsheetReader
 
   end
 
-end
+end

data/lib/rails_spreadsheet_reader/row_collection.rb

@@ -9,16 +9,27 @@ module RailsSpreadsheetReader
     end
 
     def push(row)
-      self.invalid_row = row unless row.valid?
+      self.invalid_row = row if row.invalid?
       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?
     end
 
+    def invalid?
+      !valid?
+    end
+
     def errors
-      self.invalid_row.errors
+      self.invalid_row.errors if invalid?
     end
 
     def set_invalid_row(row, model_with_errors)
@@ -26,6 +37,10 @@ module RailsSpreadsheetReader
       self.invalid_row = row
     end
 
+    def each(&block)
+      self.rows.each(&block)
+    end
+
   end
 
 end

data/lib/rails_spreadsheet_reader/version.rb

@@ -1,3 +1,3 @@
 module RailsSpreadsheetReader
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'
 end

data/spec/base_spec.rb

@@ -1,6 +1,8 @@
 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'
 
 def test_file(filename, ext)
   File.open(File.join TEST_DIR, "#{filename}.#{ext}")
@@ -8,31 +10,31 @@ end
 
 describe RailsSpreadsheetReader::Base do
 
-  it 'Base#columns' do
-    expect { RailsSpreadsheetReader::Base.columns }.to raise_error
+  it 'not implementing columns method should raise an error' do
+    expect { RailsSpreadsheetReader::Base.columns }.to raise_error(RailsSpreadsheetReader::Base::MethodNotImplementedError)
   end
 
-  it 'Base#format' do
-    expect { RailsSpreadsheetReader::Base.format }.to raise_error
+  it 'format method should raise an error if columns method is not valid' do
+    expect { InvalidColumnSpreadsheet.format }.to raise_error(RailsSpreadsheetReader::Base::InvalidTypeError)
   end
 
-  it 'Base#formatted_hash' do
-    expect { RailsSpreadsheetReader::Base.formatted_hash(%w(username email@test.com male)) }.to raise_error
+  it 'formatted_hash should raise an error if columns method is not valid' do
+    expect { InvalidColumnSpreadsheet.formatted_hash(%w(username email@test.com male)) }.to raise_error(RailsSpreadsheetReader::Base::InvalidTypeError)
   end
 
-  it 'Base#valid? should work as desired' do
+  it 'Base.valid? should be true by default' do
     expect(RailsSpreadsheetReader::Base.new.valid?).to eq(true)
   end
 
-  it 'Base#open_spreadsheet' do
+  it 'Base.open_spreadsheet should return a Roo::Base instance' do
     file = test_file 'users', :csv
-    row = RailsSpreadsheetReader::Base.open_spreadsheet file
-    expect(row).not_to eq(false)
+    roo_row = RailsSpreadsheetReader::Base.open_spreadsheet file
+    expect(roo_row.is_a?(Roo::Base)).not_to eq(false)
   end
 
-  it 'Base#read_spreadsheet' do
+  it 'empty columns should raise an error' do
     file = test_file 'users', :csv
-    expect { RailsSpreadsheetReader::Base.read_spreadsheet(file) }.to raise_error
+    expect { EmptyColumnSpreadsheet.read_spreadsheet(file) }.to raise_error(RailsSpreadsheetReader::Base::MethodNotImplementedError)
   end
 
   it '#formatted_hash should work in a derived class which overrides "columns" method' do
@@ -71,12 +73,4 @@ describe RailsSpreadsheetReader::Base do
     expect(row_collection.errors.full_messages).to eq(["Email can't be blank"])
   end
 
-  it '#read_spreadsheet should be invalid because #validate_multiple_rows raises an exception' do
-    file = test_file 'users_invalid', :csv
-    row_collection = UserInvalidSpreadsheet.read_spreadsheet(file)
-    expect(row_collection.valid?).to eq(false)
-    expect(row_collection.invalid_row.row_number).to eq(5)
-    expect(row_collection.errors.full_messages).to eq(['Username is unique'])
-  end
-
 end

data/spec/models/empty_column_spreadsheet.rb

@@ -0,0 +1,7 @@
+class EmptyColumnSpreadsheet < RailsSpreadsheetReader::Base
+
+  def self.columns
+    []
+  end
+
+end

data/spec/models/invalid_column_spreadsheet.rb

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

data/spec/models/user_invalid_spreadsheet.rb

@@ -14,7 +14,7 @@ class UserInvalidSpreadsheet < RailsSpreadsheetReader::Base
       if usernames.has_key?(row.username)
         row_collection.invalid_row = row
         row.errors[:username] = 'is unique'
-        raise 'Validation Error'
+        break
       else
         usernames[row.username] = true
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_spreadsheet_reader
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - muzk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -116,6 +116,8 @@ files:
 - spec/base_spec.rb
 - 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/spec_helper.rb
@@ -129,17 +131,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Provides an easy way to add model-based validations to excel files.
@@ -147,6 +149,8 @@ test_files:
 - spec/base_spec.rb
 - 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/spec_helper.rb