excel_validator 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in excel_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaditi Jain
+
+MIT License
+
+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.md

@@ -0,0 +1,83 @@
+# ExcelValidator
+
+  Validates the format of your imported excel (xls, xlsx) file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+  `gem 'excel_validator'`
+
+And then execute:
+  `$ bundle`
+
+Or install it yourself as:
+  `$ gem install excel_validator`
+
+## Usage
+  **require 'excel_validator'**
+
+  **f = ExcelValidator::ValidateFile.new(file_name, file_path)**
+
+  #returns true if the number of sheets in the file is 5.
+  
+  **f.number_of_sheets_is?(5)**
+  
+  #returns true if the names of the sheets at each position is as specified. If the names are case sensitive , do  f.names_of_sheets_are?({1: 'Banks', 2: 'Countries', 3: 'Metrics'}, true)
+  
+  **f.names_of_sheets_are?({1: 'Banks', 2: 'Countries', 3: 'Metrics'})**
+ 
+
+  #returns true if the first non-empty row of 2nd sheet in the file is 12
+
+  **f.first_row_is?(2, 5)**
+
+  
+  #returns true if the first non-empty row of 2nd sheet in the file is 100
+  
+  **f.last_row_is?(2,100)**
+
+  
+  #returns true if the first non-empty row of 2nd sheet in the file is 'B'
+  
+  **f.first_column_is?(2, 'B')**
+  
+  
+  #returns true if the first non-empty row of 2nd sheet in the file is 'CK'
+  
+  **f.last_column_is?(2, 'CK')**
+
+  
+  #returns true if the 'B' column of 2nd sheet in the file is completely empty
+  
+  **f.column_is_empty?(2, 'B')**
+
+  
+  #returns true if the 12th row of 2nd sheet in the file is completely empty
+  
+  **f.row_is_empty?(2, 12)**
+
+  
+  #returns true if at 2nd sheet in the file Row3, Column C, content is 'Location'. If the content is case sensitive , do  
+  
+  **f.content_of_cell_is?(2, 3, 'C', 'Location', true)**
+
+  
+  #returns true if there are empty sheets present in the file.
+  
+  **f.empty_sheets_present?**
+  
+  
+  #returns true if keyword 'ClassA' is present the 2nd sheet of the file. If the keyword is case sensitive, do f.keyword_present?(2, 'ClassA', true)
+  
+  **f.keyword_present?(2, 'ClassA')**
+
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+task test: :spec

data/excel_validator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'excel_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "excel_validator"
+  spec.version       = ExcelValidator::VERSION
+  spec.authors       = ["Aaditi Jain"]
+  spec.email         = ["aaditi2290@gmail.com"]
+  spec.description   = %q{provides methods to validates the content of excel file}
+  spec.summary       = %q{provides methods to validates the content of excel file}
+  spec.homepage      = "https://github.com/Aaditi/excel_validator.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  
+  spec.add_runtime_dependency "roo", "~> 1.13.2"
+end

data/lib/excel_validator/version.rb

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

data/lib/excel_validator.rb

@@ -0,0 +1,107 @@
+require "excel_validator/version"
+module ExcelValidator
+  class ValidateFile
+    require "roo"   	
+    
+    def initialize(file_name,file_path)
+      case File.extname(file_name)      
+        when ".xls"
+          @file =  Roo::Excel.new(file_path)
+        when ".xlsx"
+          @file = Roo::Excelx.new(file_path)
+        else raise "Not a Excel / Excelx File"
+      end
+  	end 
+
+    #counts the number of sheets in the file.
+    #sheet_number: should be an integer
+  	def number_of_sheets_is?(sheet_number)
+      @file.sheets.count == sheet_number ? true : false  
+  	end
+  	  
+    #checks the names of the sheets in the file
+    #sheets_hash: should be a hash with key, value as position, name respectively. Example: {1: 'Bank', 2: 'Metric', 7: 'Country'}
+  	def names_of_sheets_are?(sheets_hash, case_sensitive = false)  	  
+  	  sheets_hash.each do |key, value|
+        if ( case_sensitive ? (@file.sheets[(key.to_i - 1)] != value) : (@file.sheets[(key.to_i - 1)].to_s.downcase != value.to_s.downcase ))        
+          return false
+        end
+  	  end
+  	  true  	
+    end
+     
+    #checks that the first non_empty row in the sheet is as specified
+    def first_row_is?(sheet_number, row_number)
+      set_default_sheet(sheet_number)
+      @file.first_row == row_number ? true : false
+    end
+ 
+    #checks that the last non_empty row in the sheet is as specified
+    def last_row_is?(sheet_number, row_number)
+      set_default_sheet(sheet_number)
+      @file.last_row == row_number ? true : false
+    end 
+    
+    #checks that the first non_empty column in the sheet is as specified
+    def first_column_is?(sheet_number, column_number)
+      set_default_sheet(sheet_number)
+      @file.first_column_as_letter == column_number ? true : false
+    end
+ 
+    #checks that the last non_empty column in the sheet is as specified
+    def last_column_is?(sheet_number, column_number)
+      set_default_sheet(sheet_number)
+      @file.last_column_as_letter == column_number ? true : false
+    end 
+
+    #checks if the content at the specified row and column is as required
+    def content_of_cell_is?(sheet_number, row, column, content, case_sensitive=false)  
+      set_default_sheet(sheet_number)
+      return ( (case_sensitive) ? (@file.cell(row,column).to_s == content.to_s) : (@file.cell(row,column).to_s.downcase == content.to_s.downcase))
+    end
+
+
+    #checks if the specified column is empty
+    def column_is_empty?(sheet_number, column)
+      set_default_sheet(sheet_number)  
+      @file.first_row.upto @file.last_row do |row|   
+        return false if @file.cell(row,column).nil? != true
+      end
+      true
+    end
+
+    #checks if the specified row is empty
+    def row_is_empty?(sheet_number, row)
+      @file.first_column.upto @file.last_column do |column|
+        return false if @file.cell(row,column).nil? != true
+      end 
+      true       
+    end
+
+    #Returns true if there is an empty sheet in the file
+    def empty_sheets_present?
+      @file.sheets.count.times do |sheet_number|
+        set_default_sheet(sheet_number + 1)
+        @file.first_row ? next : (return true)
+      end   
+      false  
+    end
+
+    #Checks if a keyword is present in the sheet
+    def keyword_present?(sheet_number, keyword, case_sensitive=false )
+      set_default_sheet(sheet_number)
+      @file.first_row.upto @file.last_row do |row|
+        @file.first_column.upto @file.last_column do |column|
+          return true if ( (case_sensitive) ? @file.cell(row, column) == keyword : @file.cell(row, column).to_s.downcase == keyword.to_s.downcase )
+        end
+      end
+      false
+    end
+
+    private
+      def set_default_sheet(sheet_number)
+        @file.default_sheet = @file.sheets[sheet_number - 1]
+      end
+
+  end #class end
+end #module end

data/spec/lib/excel_validator_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe ExcelValidator do    
+  before (:all) do   	 
+    @input_file = ExcelValidator::ValidateFile.new("test_excel.xlsx", "spec/fixtures/test_excel.xlsx")
+  end
+
+  describe '#number_of_sheets_is?' do 
+    it 'should return true if input integer is equal to number sheets in the file' do
+      @input_file.number_of_sheets_is?(3).should eq(true)
+    end 	
+
+    it 'should return false if input integer is not equal to number sheets in the file' do
+      @input_file.number_of_sheets_is?(2).should eq(false)
+   	end 
+  end
+
+  describe '#first_row_is?' do 
+    it 'should return true if start row of the specified sheet is as in the arguments' do
+      @input_file.first_row_is?(1, 2).should eq(true)
+    end 	
+
+    it 'should return false if start row of the specified sheet is not as in the arguments' do
+      @input_file.first_row_is?(1, 6).should eq(false)
+   	end 
+  end
+
+  describe '#last_row_is?' do 
+    it 'should return true if last row of the specified sheet is as in the arguments' do
+      @input_file.last_row_is?(1, 5).should eq(true)
+    end   
+
+    it 'should return false if last row of the specified sheet is not as in the arguments' do
+      @input_file.last_row_is?(1, 2).should eq(false)
+    end     
+  end
+
+  describe '#first_column_is?' do 
+    it 'should return true if start column of the specified sheet is as in the arguments' do
+      @input_file.first_column_is?(1, 'B').should eq(true)
+    end 	
+
+    it 'should return false if start column of the specified sheet is not as in the arguments' do
+      @input_file.first_column_is?(1, 'C').should eq(false)
+   	end 
+  end
+
+  describe '#last_column_is?' do 
+    it 'should return true if last column of the specified sheet is as in the arguments' do
+      @input_file.last_column_is?(1, 'E').should eq(true)
+    end   
+
+    it 'should return false if last column of the specified sheet is not as in the arguments' do
+      @input_file.last_column_is?(1, 'G').should eq(false)
+    end     
+  end  
+
+  describe '#column_is_empty?' do 
+    it 'should return true if specified column in the specified sheet is empty' do
+      @input_file.column_is_empty?(1, 'A').should eq(true)
+    end   
+
+    it 'should return false if specified column in the specified sheet is not empty' do
+      @input_file.column_is_empty?(1, 'B').should eq(false)
+    end     
+  end
+
+  describe '#row_is_empty?' do 
+    it 'should return true if specified row in the specified sheet is empty' do
+      @input_file.row_is_empty?(1, 6).should eq(true)
+    end   
+
+    it 'should return false if specified row in the specified sheet is not empty' do
+      @input_file.row_is_empty?(1, 2).should eq(false)
+    end     
+  end
+
+  describe '#empty_sheets_present?' do 
+    it 'should return true if there are empty sheets present in the file' do
+      @input_file.empty_sheets_present?.should eq(true)
+    end   
+  end
+
+  describe '#keyword_present?' do 
+    it 'should return true if keyword (case insensitve) is present in sheet ' do
+      @input_file.keyword_present?(1,"Name").should eq(true)
+    end   
+
+    it 'should return false if keyword (case insensitve) is not present in sheet ' do
+      @input_file.keyword_present?(1, "Absent").should eq(false)
+    end  
+
+    it 'should return true if keyword(case sensitve) is present in sheet ' do
+      @input_file.keyword_present?(1,"Name", true).should eq(true)
+    end   
+
+    it 'should return false if keyword (case sensitve) is not present in sheet' do
+      @input_file.keyword_present?(1, "name", true).should eq(false)
+    end        
+  end
+
+  describe "#names_of_sheets_are?" do
+    it 'should return true if names of sheets in file are as specified in the input hash(case insensitve)' do
+      @input_file.names_of_sheets_are?({1 => 'users', 2 => 'country'}).should eq(true)
+    end  
+
+    it 'should return false if names of sheets in file are not as specified in the input hash(case insensitve)' do
+      @input_file.names_of_sheets_are?({1 => 'Users', 2 => 'Metric'}).should eq(false)
+    end
+
+    it 'should return true if names of sheets in file are as specified in the input hash(case sensitve)' do
+      @input_file.names_of_sheets_are?({1 => 'Users', 2 => 'Country'}, true).should eq(true)
+    end  
+
+    it 'should return false if names of sheets in file are not as specified in the input hash(case sensitve)' do
+      @input_file.names_of_sheets_are?({1 => 'users', 2 => 'country'}, true).should eq(false)
+    end   
+  end
+
+  describe "#content_of_cell_is?" do
+  	it 'should return true if content of the cell is as specified(case insensitve)' do
+      @input_file.content_of_cell_is?(2, 3, 'B', 'India').should eq(true)
+  	end
+
+  	it 'should return false if content of the cell is not as specified(case insensitve)' do
+      @input_file.content_of_cell_is?(2, 3, 'B', 'Countries').should eq(false)
+  	end  	
+
+    it 'should return true if content of the cell is as specified(case sensitve)' do
+      @input_file.content_of_cell_is?(2, 3, 'B', 'India', true).should eq(true)
+    end
+
+    it 'should return false if content of the cell is not as specified(case sensitve)' do
+      @input_file.content_of_cell_is?(2, 3, 'B', 'india', true).should eq(false)
+    end   
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'excel_validator'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: excel_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaditi Jain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.13.2
+description: provides methods to validates the content of excel file
+email:
+- aaditi2290@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- excel_validator.gemspec
+- lib/excel_validator.rb
+- lib/excel_validator/version.rb
+- spec/fixtures/test_excel.xlsx
+- spec/lib/excel_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Aaditi/excel_validator.git
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: provides methods to validates the content of excel file
+test_files:
+- spec/fixtures/test_excel.xlsx
+- spec/lib/excel_validator_spec.rb
+- spec/spec_helper.rb