unit_validator 0.1.0

data/.autotest

@@ -0,0 +1,2 @@
+require 'autotest/growl'
+require 'autotest/fsevent'

data/.gitignore

@@ -0,0 +1,43 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+#
+# For TextMate
+*.tmproj
+tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+*.swp
+.~*

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'roo'
+  gem 'zip'
+  gem 'spreadsheet'
+  gem 'nokogiri'
+  gem 'google-spreadsheet-ruby'
+  gem 'activesupport'
+  gem 'fastercsv'
+  
+  gem 'autotest-fsevent', '>=0.2.2'
+  gem 'autotest-growl', '>=0.2.4'
+  gem 'builder'
+  gem "rspec", ">= 2.0.0.rc"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre3"
+  gem "rcov"
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.1)
+    autotest-fsevent (0.2.3)
+      sys-uname
+    autotest-growl (0.2.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    fastercsv (1.5.3)
+    git (1.2.5)
+    google-spreadsheet-ruby (0.1.2)
+      nokogiri (>= 1.4.3.1)
+      oauth (>= 0.3.6)
+    jeweler (1.5.0.pre3)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.3.1)
+    oauth (0.4.3)
+    rake (0.8.7)
+    rcov (0.9.9)
+    roo (1.9.3)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    ruby-ole (1.2.11)
+    spreadsheet (0.6.4.1)
+      ruby-ole
+    sys-uname (0.8.4)
+    zip (2.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  autotest-fsevent (>= 0.2.2)
+  autotest-growl (>= 0.2.4)
+  builder
+  bundler (~> 1.0.0)
+  fastercsv
+  google-spreadsheet-ruby
+  jeweler (~> 1.5.0.pre3)
+  nokogiri
+  rcov
+  roo
+  rspec (>= 2.0.0.rc)
+  spreadsheet
+  zip

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright© Sprout Technology International Limited
+
+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,93 @@
+# Cloud Factory Validatior (CFValidator)
+
+The CFInputValidator - Cloud Factory Input Validator is a simple gem to **validate** the *spreadsheet data* inputs as per the given rules.
+
+This gem is being developed for Project **Cloud Factory** Copyright© [Sprout Technology International Limited](http://sprout-technology.com)
+
+![Sprout logo](http://sprout-technology.com/images/logo.png) 
+
+## Installation
+	
+In Gemfile
+	source 'http://rubygems.org'
+	gem 'unit_validator'
+	
+	bundle install
+
+OR 
+	gem install unit_validator
+	
+	require 'rubygems'
+	require 'unit_validator'
+
+## Usage
+
+The CFInputValidator checks if the **headers** of the provided spreadsheet matches with the corresponding **rules** *(checked by label)* and gives error message if it doesn't match.
+
+The individual row of the spreadsheet undergoes the validation process and gives the final output as an array of **valid and invalid units**.
+Later the valid and invalid units can be processed separately as required.
+
+You can even check if a **file format** is supported by the gem.
+
+The gem currently supports `validation_format` of `email`, `number`, `url`, `date` and `time` only.
+It also checks if value is present if required is true.
+
+## Example
+
+1. Specify the rules, i.e `:label` `:required` `:validation_format`
+		rules = [{:label => "company name",:required => true, :validation_format => "general"},
+			 	 {:label => "email", :required => false, :validation_format => "email"}]
+
+2. Provide data for validation:
+		inputs = "company name,email\nSprout,info@sproutify.com\nApple,saroj@apple"
+
+	**You can also give the file location as input**
+		inputs = File.read("fixtures/gdoc.csv")
+
+	* Check the file format with `check_extension(path)` method which gives you a 'boolean' value `:check`
+	
+		`file_location = "fixtures/gdoc.xlsxsfdsf"`
+		
+		`CFInputValidator.check_extension(file_location)[:check]`
+
+	* This gem currently supports the following formats and 'must be converted into csv' before validation.
+		* `inputs = File.read("fixtures/gdoc.csv")`
+		* `inputs = Excel.new("fixtures/gdoc.xls").to_csv`
+		* `inputs = Excelx.new("fixtures/gdoc.xlsx").to_csv`
+		* `inputs = Openoffice.new("fixtures/gdoc.ods").to_csv`
+
+3. Create a new constructor of *CF::InputValidator* class passing the above **rules** as argument.
+
+		cloud_validator = CF::InputValidator.new(rules)
+
+4. Call `parse_and_validate(data)` method passing the above inputs as arguments.
+		val = cloud_validator.parse_and_validate(inputs)
+
+5. Now you'll get both valid and invalid data in `:valid_units` and `:invalid_units` arrays respectively.
+	* `val[:valid_units]`
+	* `val[:invalid_units]`
+	
+6. It will give a `.errors` instance variable as error if the *headers* of spreadsheet data doesn't match with the *rules* or vice-versa saying *"Headers doesnot match the column counts"*.
+ 		rules = [{:field_id => "field_1", :label => "company name", :field_type => "text_data", 
+ 		          :value => "Sprout", :required => true, :validation_format => "general"
+ 		         }]
+ 		inputs = "company name,email\nSprout,info@sproutify.com"
+
+		cloud_validator = CF::InputValidator.new(rules)
+    	val = cloud_validator.parse_and_validate(inputs)
+		err = val.errors
+	
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright© Sprout Technology International Limited. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "unit_validator"
+  gem.summary = %Q{Takes the Instruction Input as Rule, parse the CSV files and does the validation}
+  gem.description = %Q{Takes the Instruction Input as Rule, parse the CSV files and applies the validation and returns valid and invalid units}
+  gem.email = "saroj@sprout-technology.com"
+  gem.homepage = "http://github.com/sprout/unit_validator"
+  gem.authors = ["millisami", "zoras"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'roo'
+  gem.add_runtime_dependency 'zip'
+  gem.add_runtime_dependency 'spreadsheet'
+  gem.add_runtime_dependency 'nokogiri'
+  gem.add_runtime_dependency 'google-spreadsheet-ruby'
+  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'builder'
+
+  gem.add_development_dependency "rspec", ">= 2.0.0.rc"
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.0.pre3"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+# custom rcov
+require File.expand_path(File.dirname(__FILE__) + '/lib/tasks/rcov_custom')
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "unit_validator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1,3 @@
+Autotest.add_discovery do
+  "rspec2"
+end

data/fixtures/gdoc.csv

@@ -0,0 +1,10 @@
+company name,email
+"Apple, Inc.",
+Sprout,info@sproutify.com
+,inf o@ab c.com
+
+
+DEF,  info@def.com   
+GHI
+
+

data/lib/cf/input_validator.rb

@@ -0,0 +1,72 @@
+require 'fastercsv'
+require 'roo'
+require 'active_support/core_ext/object/blank'
+require 'generic_spreadsheet'
+require 'validator_helpers'
+
+module CF
+  class InputValidator
+    include ValidatorHelpers
+
+    attr_accessor :errors, :rules
+
+    def initialize(rules)
+      @errors = []
+      @rules = rules
+      @invalid_units, @temp_units, @valid_units = [], [], []
+    end
+
+    def self.check_extension(file_location)
+      @error = []
+      ext = File.extname(file_location).sub(/./,"")  
+      formats = %w[csv xls xlsx ods]
+      check = formats.include?(ext)
+
+      @error << "Invalid file! The specified format is not supported." unless check
+      {:check => check, :error => @error}
+    end
+
+    # returns a hash of arrays with two keys :valid_units and :invalid_units
+    # {:valid_units => @valid_units, :invalid_units => @invalid_units}
+    def parse_and_validate(inputs)
+      csv_contents = FasterCSV.parse(inputs)
+      csv_header = csv_contents[0].map{|a| a.strip unless a.nil? }
+
+      # Initialize rule_labels array and store labels of RULE_HEADERS into it
+      rule_labels = Array.new
+      rules.each do |rule|
+        rule_labels << rule[:label]
+      end
+
+      if rule_labels == csv_header
+        csv_contents[1..-1].each do |item|
+          # Validation.
+          rules.each_with_index do |header, index|
+            next unless item # Escape nil items. This may result while reading csv file with blank line
+
+            unless (item = item.select{|x| !x.blank? }).empty?
+              item[index].strip! if !item[index].nil?
+
+              if required(header[:required], item[index]) and valid(header[:validation_format], item[index])
+                # temporarily store valid units into temp_units array
+                @temp_units << item unless @temp_units.include?(item)
+              else
+                # Note:: While validating input data, collect invalid row(data) and process the others.
+                # Display invalid data to user later
+                @invalid_units << item unless @invalid_units.include?(item)
+              end
+            end
+          end
+
+        end
+      else
+        @errors << "Headers doesnot match the column counts"
+      end
+
+      # calculate valid_units
+      @valid_units = @temp_units - @invalid_units
+
+      {:valid_units => @valid_units, :invalid_units => @invalid_units}
+    end
+  end
+end

data/lib/cf/result_validator.rb

@@ -0,0 +1,52 @@
+module CF
+  class ResultValidator
+    include ValidatorHelpers
+    attr_accessor :errors
+
+    def initialize
+      @errors = []
+    end
+
+    def valid?(rules, result)
+      csv_contents = FasterCSV.parse(result)
+      csv_header = csv_contents[0].map{|a| a.strip unless a.nil? }
+
+      rule_labels = Array.new
+      rules.each do |rule|
+        rule_labels << rule[:label]
+      end
+      
+      bool = false
+      case (rule_labels <=> csv_header)
+      when 1
+        # when input header is less than rule label
+        @errors << "#{rule_labels - csv_header} is/are required"
+      when -1
+        # when input header is more than rule label
+        @errors << "cannot process as the input data consists extra headers"
+      when 0
+        # if rule_labels == csv_header
+        csv_contents[1..-1].each do |item|
+          rules.each_with_index do |header, index|
+            next unless item
+            unless item.compact.empty?
+              item[index].strip! if !item[index].nil?
+              if required(header[:required], item[index]) and valid(header[:validation_format], item[index])
+                bool = true
+              else
+                bool = false
+                if header[:required] && item[index].blank?
+                  @errors << "#{header[:label]} is required"
+                else
+                  @errors << "#{item[index]} is not valid"
+                end
+              end
+            end
+          end
+        end
+      end
+      # finally return boolean for .valid?
+      return bool
+    end
+  end
+end

data/lib/generic_spreadsheet.rb

@@ -0,0 +1,23 @@
+class GenericSpreadsheet
+  
+  # write the current spreadsheet to csv_string
+  def to_csv(filename=nil,sheet=nil)
+    csv_string = write_csv_content(STDOUT,sheet)
+  end
+  
+  def write_csv_content(file=nil,sheet=nil)
+   csv_string = ""
+    if first_row(sheet) # sheet is not empty
+      1.upto(last_row(sheet)) do |row|
+        1.upto(last_column(sheet)) do |col|
+          csv_string += "," if col > 1
+          onecell = cell(row,col,sheet)
+          onecelltype = celltype(row,col,sheet)
+          csv_string += one_cell_output(onecelltype,onecell,empty?(row,col,sheet))
+        end
+        csv_string += "\n"
+      end # sheet not empty
+    end
+    csv_string
+  end  
+end

data/lib/tasks/rcov_custom.rb

@@ -0,0 +1,5 @@
+desc  "Custom rcov"
+RSpec::Core::RakeTask.new(:rcov_custom) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude gems\/,spec\/ -T}
+end

data/lib/validator_helpers.rb

@@ -0,0 +1,56 @@
+module ValidatorHelpers  
+  
+  private
+  
+  def required(rule, value)
+    # returns true unless value is blank when required rule is true
+    (rule && value.blank?) ? false : true
+  end
+  
+  def valid(format, value)
+    case format
+    when "email"
+      regex = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+    when "url" # image_data => url, path
+      regex = /^(http:\/\/|https:\/\/)?(www.)?[a-zA-Z0-9\-\.]+\.([a-zA-Z]{2,3})([.]?[a-zA-Z]{2})?(\/\S*)?$/i
+      msg = "Start with http:// or https://"
+    when "number"
+      regex = /^\d{1,3}(\,?\d{3})*$/
+    when "date"
+      # Check if date (dd.mm.yyyy) is valid date or not
+      #regex = /\d{1,2}(\/|-|\.|\s)\d{1,2}(\/|-|\.|\s)\d{2,4}/
+      test = check_date(value)
+      return test
+    when "time"
+      regex = /^(([0-1]?[0-9])|([2][0-3])):([0-5]?[0-9])(:([0-5]?[0-9]))?$/
+    when "datetime"
+      regex = /^(1[0-2]|0?[1-9])\/(3[01]|[12][0-9]|0?[1-9])\/(?:[0-9]{2})?[0-9]{2}|(([0-1]?[0-9])|([2][0-3])):([0-5]?[0-9])(:([0-5]?[0-9]))?$/
+    when "currency" #=> for USD
+      regex = /^\$?(?:\d+|\d{1,3}(?:,\d{3})*)(?:\.\d{1,2}){0,1}$/
+    # when "boolean"
+    # when "rating"
+    # when "radio"
+    # when "checkbox" => multiple choice
+    when "general"
+      return true
+    else
+      @errors << "Validation format not supported:: #{format}"
+      # puts "error message:: #{@errors.inspect}"
+      return false
+    end
+
+    if !value.blank?
+      !value.match(regex).nil? ? true : false
+    end
+  end
+
+  def check_date(value)
+    begin
+      val = value.scan(/^(\d{1,2})[\/|-|\.|\s](\d{1,2})[\/|-|\.|\s](\d{2,4})$/) # dd.mm.yyyy
+      Date.civil(val[0][2].to_i,val[0][1].to_i,val[0][0].to_i) # civil check julian date in yyyy.mm.dd
+      !val.blank? ? true : false
+    rescue
+      return false
+    end
+  end
+end

data/spec/.rspec

@@ -0,0 +1 @@
+--color