csv_validator 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,43 @@
+## Usage
+
+Add to your Gemfile:
+
+```ruby
+gem 'csv_validator'
+```
+
+Run:
+
+```
+bundle install
+```
+
+Then add the following to your model:
+
+```ruby
+attr_accessor :my_csv_file
+
+validates :my_csv_file, :csv => true
+```
+
+This will check to see if it is a properly formed CSV file. 
+
+In this case, csv_validator expects :my_csv_file to be an instance of ActionDispatch::Http::UploadedFile, which is created by default for Rails uploads. 
+
+## Other validation options
+
+There are a handful of other options for more specific validation too. A complete list is below... note that you wouldn't use all simultaneously. 
+
+```ruby
+validates :my_csv_file, :csv => {
+                          :columns => 3, # an exact number of columns
+                          :max_columns => 10, # a maximum number of columns
+                          :min_columns => 1, # a minimum number of columns
+                          :rows => 20, # an exact number of rows
+                          :max_rows => 30, # a maximum number of rows
+                          :min_rows => 2, # a minimum number of rows
+                          :email => 0, # will check to make sure all emails in specified column are valid email addresses
+                          :numericality => 0, # will check to make sure all values in specified column are numerical
+                        }
+```
+

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CsvValidator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/csv_validator.rb

@@ -0,0 +1,116 @@
+require 'active_model'
+require 'active_model/validations'
+require 'csv'
+require 'mail'
+
+class CsvValidator < ActiveModel::EachValidator
+  @@default_options = {}
+  
+  def self.default_options
+    @@default_options
+  end
+  
+  def validate_each(record, attribute, value)
+    options = @@default_options.merge(self.options)
+    
+    unless value
+      record.errors.add(attribute, options[:message] || "must be present")
+      return
+    end
+    
+    begin
+      csv = CSV.read(value.path)
+    rescue CSV::MalformedCSVError
+      record.errors.add(attribute, options[:message] || "is not a valid CSV file")
+      return
+    end
+    
+    if options[:columns]
+      unless csv[0].length == options[:columns]
+        record.errors.add(attribute, options[:message] || "should have #{options[:columns]} columns")
+      end
+    end
+
+    if options[:max_columns]
+      if csv[0].length > options[:max_columns]
+        record.errors.add(attribute, options[:message] || "should have no more than #{options[:max_columns]} columns")
+      end
+    end
+
+    if options[:min_columns]
+      if csv[0].length < options[:min_columns]
+        record.errors.add(attribute, options[:message] || "should have at least #{options[:min_columns]} columns")
+      end
+    end
+
+    if options[:rows]
+      unless csv.length == options[:rows]
+        record.errors.add(attribute, options[:message] || "should have #{options[:rows]} rows")
+      end
+    end
+
+    if options[:min_rows]
+      if csv.length < options[:min_rows]
+        record.errors.add(attribute, options[:message] || "should have at least #{options[:min_rows]} rows")
+      end
+    end
+
+    if options[:max_rows]
+      if csv.length > options[:max_rows]
+        record.errors.add(attribute, options[:message] || "should have no more than #{options[:max_rows]} rows")
+      end
+    end
+
+    if options[:email]
+      emails = column_to_array(csv, options[:email])
+      invalid_emails = []
+      emails.each do |email|
+        begin
+          address = Mail::Address.new email
+          valid = address.address == email && address.domain
+          tree = address.__send__(:tree)        
+          valid &&= (tree.domain.dot_atom_text.elements.size > 1)
+        rescue
+          valid = false
+        end
+        unless valid
+          invalid_emails << email
+        end
+      end
+      
+      if invalid_emails.length > 0
+        record.errors.add(attribute, options[:message] || "contains invalid emails (#{invalid_emails.join(', ')})")
+      end
+    end
+
+    if options[:numericality]
+      numbers = column_to_array(csv, options[:numericality])
+      numbers.each do |number|
+        unless is_numeric?(number)
+          record.errors.add(attribute, options[:message] || "contains non-numeric content in column #{options[:numericality]}")
+          return
+        end
+      end
+    end
+    
+  end
+  
+  private
+  
+  def column_to_array(csv, column_index)
+    column_contents = []
+    csv.each do |column|    
+      column_contents << column[column_index].strip
+    end
+    column_contents
+  end
+  
+  def is_numeric?(string)
+    Float(string)
+    true 
+  rescue 
+    false
+  end
+  
+  
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: csv_validator
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Matt Fordham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: "A CVS validator for Rails 3. See homepage for details: http://github.com/mattfordham/csv_validator."
+email: 
+- matt@revolvercreative.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/csv_validator.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/mattfordham/csv_validator
+licenses: []
+
+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.24
+signing_key: 
+specification_version: 3
+summary: A CVS validator for Rails 3.
+test_files: []
+
+has_rdoc: