active_validation 4.0.10 → 4.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e68e565089ff76403013cd80554802c6a8c3bcfd
-  data.tar.gz: d320d62d5461c22839062827c0d55c5e99197df1
+  metadata.gz: 13401eb32dc1430b9fdf5bfba438388b30cfe377
+  data.tar.gz: ec4688cf3c3dafb36fa78c9cb3e3d3581d3ffc57
 SHA512:
-  metadata.gz: 9eab1bed6675c4b0e9061300c95a8d5b2823f77c47e127611280dd3a53cacce3bedbcc08cdec403c09573f120e491c4bfb44ac6bf63e8f5781354d7112695d87
-  data.tar.gz: feaa1e2be8a7ec98715f9be51ee673434fc25dd1fd69ffe0a12f991dcc48e11f907f294cac69d820130ca808eaf847c5eaeb1e8967adc5205489a54d24564a34
+  metadata.gz: bb066efd1bb2bb378090cde1da22eb361fdf1a47640870d608c79cfe7807b04dd3eb66013b586c11f0438bd43c81b1a5f32a6e4f1f591333db0b4ad23c2685a8
+  data.tar.gz: 1542bd9f3a210d2c5cdb50b10d35aaed128e05ba83fd43777012111183fecc5216819635edfa439c19a20241780e869550a787a625cc9b2725ef1ed69ec2c048

data/README.md

@@ -34,10 +34,12 @@ Or install it yourself as:
 * [Boolean](#booleanvalidator)
 * [Coordinates](#coordinatesvalidator)
 * [Credit Card](#creditcardvalidator)
+* [Csv](#csvvalidator)
 * [Currency](#currencyvalidator)
 * [CUSIP](#cusipvalidator)
 * [Email](#emailvalidator)
 * [Equality](#equalityvalidator)
+* [FileSize](#filesizevalidator)
 * [Hex](#hexvalidator)
 * [IMEI](#imeivalidator)
 * [IP](#ipvalidator)
@@ -309,6 +311,40 @@ describe Invoice do
 end
 ```
 
+## CsvValidator
+
+Options: :columns :columns_in, :columns_less_than, :columns_less_than_or_equal_to,
+         :columns_greater_than, :columns_greater_than_or_equal_to, :rows, :rows_in, :rows_less_than,
+         :rows_less_than_or_equal_to, :rows_greater_than, :rows_greater_than_or_equal_to
+
+With an ActiveRecord model:
+
+```ruby
+class Product < ActiveRecord::Base
+  attr_accessor :csv, :name
+  validates :csv, csv: { columns: 6, rows_less_than: 20 }
+end
+```
+
+Or any ruby class:
+
+```ruby
+class Product
+  include ActiveModel::Validations
+  attr_accessor :csv, :name
+  validates :csv, csv: { columns_less_than: 6, rows: 20 }
+end
+```
+
+RSpec matcher is also available for your convenience:
+
+```ruby
+describe Product do
+  it { should ensure_valid_csv_format_of(:csv) }
+  it { should_not ensure_valid_csv_format_of(:name) }
+end
+```
+
 ## CurrencyValidator
 
 **Ex:** 123.00 or .1
@@ -394,10 +430,10 @@ end
 **Ex:** user@example.com or user+123@example-site.com
 
 **Rules:**
- * Characters in username: a-z 0-9 -_+.
+ * Characters in username: a-z 0-9 -.+_
  * Must include: @
  * Characters in domain: a-z 0-9 -
- * Must include extension: .co, .org, .museum
+ * Must include extension: .com, .org, .museum
 
 With an ActiveRecord model:
 
@@ -477,6 +513,38 @@ describe Auction do
 end
 ```
 
+## FileSizeValidator
+
+Options: :in, :less_than, :less_than_or_equal_to, :greater_than, :greater_than_or_equal_to
+
+With an ActiveRecord model:
+
+```ruby
+class Product < ActiveRecord::Base
+  attr_accessor :file, :name
+  validates :file, file_size: { in: 5.megabytes..10.megabytes }
+end
+```
+
+Or any ruby class:
+
+```ruby
+class Product
+  include ActiveModel::Validations
+  attr_accessor :file, :name
+  validates :file, file_size: { in: 5.megabytes..10.megabytes }
+end
+```
+
+RSpec matcher is also available for your convenience:
+
+```ruby
+describe Product do
+  it { should ensure_valid_csv_format_of(:file) }
+  it { should_not ensure_valid_csv_format_of(:name) }
+end
+```
+
 ## HexValidator
 
 **Ex:** #a9a9a9 or #999 or aaaaaa or AAA

data/active_validation.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
+  spec.add_runtime_dependency 'actionpack'
   spec.add_runtime_dependency 'activemodel'
   spec.add_runtime_dependency 'activesupport'
 
@@ -27,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'shoulda'
   spec.add_development_dependency 'fasterer'
   spec.add_development_dependency 'reek'

data/config/locales/en.yml

@@ -11,10 +11,30 @@ en:
           latitude: 'is not a valid latitude'
           longitude: 'is not a valid longitude'
         credit_card: 'is not a valid credit card format'
+        csv:
+          columns: 'is not %{count}'
+          columns_in: 'is not between %{min} and %{max}'
+          columns_less_than: 'is not less than %{count}'
+          columns_less_than_or_equal_to: 'is not less than or equal to %{count}'
+          columns_greater_than: 'is not greater than %{count}'
+          columns_greater_than_or_equal_to: 'is not greater than or equal to %{count}'
+          not_valid: 'is not a valid csv'
+          rows: 'is not %{count}'
+          rows_in: 'is not between %{min} and %{max}'
+          rows_less_than: 'is not less than %{count}'
+          rows_less_than_or_equal_to: 'is not less than or equal to %{count}'
+          rows_greater_than: 'is not greater than %{count}'
+          rows_greater_than_or_equal_to: 'is not greater than or equal to %{count}'
         currency: 'is not in valid currency format'
         cusip: 'is not in valid CUSIP format'
         email: 'is not in valid email format'
         equality: 'is not %{operator} %{attr}'
+        file_size:
+          in: 'is not between %{min} and %{max}'
+          less_than: 'is not less than %{count}'
+          less_than_or_equal_to: 'is not less than or equal to %{count}'
+          greater_than: 'is not greater than %{count}'
+          greater_than_or_equal_to: 'is not greater than or equal to %{count}'
         hex: 'is not in valid hex color format'
         imei: 'is not in valid IMEI format'
         ip: 'is not in valid IP format'
@@ -52,6 +72,9 @@ en:
         ensure_valid_credit_card_format_of:
           failure_message_for_should: '%{model} should ensure valid credit card format of attribute %{attr}'
           failure_message_for_should_not: '%{model} should not ensure valid credit card format of attribute %{attr}'
+        ensure_valid_csv_format_of:
+          failure_message_for_should: '%{model} should ensure valid csv format of attribute %{attr}'
+          failure_message_for_should_not: '%{model} should not ensure valid csv format of attribute %{attr}'
         ensure_valid_currency_format_of:
           failure_message_for_should: '%{model} should ensure valid currency format of attribute %{attr}'
           failure_message_for_should_not: '%{model} should not ensure valid currency format of attribute %{attr}'
@@ -64,6 +87,9 @@ en:
         ensure_valid_equality_format_of:
           failure_message_for_should: '%{model} should ensure equality of %{operator} on attribute %{attr}'
           failure_message_for_should_not: '%{model} should not ensure equality of %{operator} on attribute %{attr}'
+        ensure_valid_file_size_format_of:
+          failure_message_for_should: '%{model} should ensure valid file size format of attribute %{attr}'
+          failure_message_for_should_not: '%{model} should not ensure valid file size format of attribute %{attr}'
         ensure_valid_hex_format_of:
           failure_message_for_should: '%{model} should ensure valid hex format of attribute %{attr}'
           failure_message_for_should_not: '%{model} should not ensure valid hex format of attribute %{attr}'

data/lib/active_validation.rb

@@ -1,12 +1,14 @@
+require 'action_dispatch'
 require 'active_model'
 require 'active_support'
 require 'active_support/core_ext/time/zones'
 require 'active_validation/version'
+require 'csv'
 
 ACTIVE_VALIDATION_VALIDATORS ||= %w[
-  alpha alpha_numeric base64 boolean coordinate credit_card currency cusip email equality hex imei
-  ip isbn isin mac_address name password phone sedol slug ssn time_zone tracking_number type url
-  username uuid
+  alpha alpha_numeric base64 boolean coordinate credit_card csv currency cusip email equality
+  file_size hex imei ip isbn isin mac_address name password phone sedol slug ssn time_zone
+  tracking_number type url username uuid
 ].freeze
 
 ACTIVE_VALIDATION_VALIDATORS.each do |file_name|

data/lib/active_validation/validators/boolean_validator.rb

@@ -1,4 +1,5 @@
 class BooleanValidator < ActiveModel::EachValidator
+
   FALSE_VALUES ||= [false, 0, '0', 'f', 'F', 'false', 'FALSE'].freeze
   TRUE_VALUES  ||= [true, 1, '1', 't', 'T', 'true', 'TRUE'].freeze
 

data/lib/active_validation/validators/csv_validator.rb

@@ -0,0 +1,94 @@
+class CsvValidator < ActiveModel::EachValidator
+
+  CHECKS ||= {
+    columns: :==,
+    columns_in: :===,
+    columns_less_than: :<,
+    columns_less_than_or_equal_to: :<=,
+    columns_greater_than: :>,
+    columns_greater_than_or_equal_to: :>=,
+    rows: :==,
+    rows_in: :===,
+    rows_less_than: :<,
+    rows_less_than_or_equal_to: :<=,
+    rows_greater_than: :>,
+    rows_greater_than_or_equal_to: :>=
+  }.freeze
+
+  def validate_each(record, attribute, value)
+    assert_valid_options!
+    values = parse_values(record, attribute, value)
+
+    if values.nil?
+      record.errors.add(attribute, 'not a valid csv')
+      return
+    end
+
+    options.slice(*CHECKS.keys).each do |option, option_value|
+      option_value = option_value.call(record) if option_value.is_a?(Proc)
+
+      next unless values.any? { |val| !valid_size?(val, option, option_value) }
+      error_text = filtered_options(values).merge!(detect_error_options(option_value))
+      error_text = options[:message] ||
+                   I18n.t("active_validation.errors.messages.csv.#{option}", error_text)
+      record.errors[attribute] << (options[:message] || error_text)
+    end
+  end
+
+  private
+
+  def assert_valid_options!
+    unless (CHECKS.keys & options.keys).present?
+      raise ArgumentError,
+            "You must at least pass in one of these options - #{CHECKS.map(&:inspect).join(', ')}"
+    end
+
+    check_options(Numeric, options.slice(*(CHECKS.keys - %i[columns_in rows_in])))
+    check_options(Range, options.slice(:columns_in, :rows_in))
+  end
+
+  def valid_extension?(record, attribute, value)
+    value.path.end_with?('.csv')
+  rescue
+    record.errors[attribute] <<
+      (options[:message] || I18n.t('active_validation.errors.messages.csv.not_valid'))
+    false
+  end
+
+  def parse_values(record, attribute, value)
+    return nil unless valid_extension?(record, attribute, value)
+    [CSV.read(value.path)]
+  rescue CSV::MalformedCSVError
+    record.errors[attribute] <<
+      (options[:message] || I18n.t('active_validation.errors.messages.csv.not_valid'))
+    nil
+  end
+
+  def check_options(klass, options)
+    options.each do |option, value|
+      next if value.is_a?(klass) || value.is_a?(Proc)
+      raise ArgumentError,
+            ":#{option} must be a #{klass.name.to_s.downcase} or a proc"
+    end
+  end
+
+  def valid_size?(value, option, option_value)
+    size = /columns/.match?(option) ? value.first.length : value.length
+
+    return false if size.zero?
+    return option_value.send(CHECKS[option], size) if option_value.is_a?(Range)
+    size.send(CHECKS[option], option_value)
+  end
+
+  def filtered_options(value)
+    filtered = options.except(*CHECKS.keys)
+    filtered[:value] = value
+    filtered
+  end
+
+  def detect_error_options(option_value)
+    return { count: option_value } unless option_value.is_a?(Range)
+    { min: option_value.min, max: option_value.max }
+  end
+
+end

data/lib/active_validation/validators/file_size_validator.rb

@@ -0,0 +1,85 @@
+class FileSizeValidator < ActiveModel::EachValidator
+
+  CHECKS ||= {
+    in: :===,
+    less_than: :<,
+    less_than_or_equal_to: :<=,
+    greater_than: :>,
+    greater_than_or_equal_to: :>=
+  }.freeze
+
+  def validate_each(record, attribute, value)
+    assert_valid_options!
+    values = parse_values(value)
+    return if values.empty?
+
+    options.slice(*CHECKS.keys).each do |option, option_value|
+      option_value = option_value.call(record) if option_value.is_a?(Proc)
+
+      next unless values.any? { |val| !valid_size?(val.size, option, option_value) }
+      error_text = filtered_options(values).merge!(detect_error_options(option_value))
+      error_text = options[:message] ||
+                   I18n.t("active_validation.errors.messages.file_size.#{option}", error_text)
+      record.errors[attribute] << (options[:message] || error_text)
+    end
+  end
+
+  private
+
+  def assert_valid_options!
+    unless (CHECKS.keys & options.keys).present?
+      raise ArgumentError,
+            "You must at least pass in one of these options - #{CHECKS.map(&:inspect).join(', ')}"
+    end
+
+    check_options(Numeric, options.slice(*(CHECKS.keys - %i[in])))
+    check_options(Range, options.slice(:in))
+  end
+
+  def parse_values(value)
+    return [] unless value.present?
+
+    value = JSON.parse(value) if value.is_a?(String)
+    return [] unless value.present?
+
+    value = OpenStruct.new(value) if value.is_a?(Hash)
+    [value].reject(&:blank?)
+  end
+
+  def check_options(klass, options)
+    options.each do |option, value|
+      next if value.is_a?(klass) || value.is_a?(Proc)
+      raise ArgumentError,
+            ":#{option} must be a #{klass.name.to_s.downcase} or a proc"
+    end
+  end
+
+  def valid_size?(size, option, option_value)
+    return false if size.nil?
+    return option_value.send(CHECKS[option], size) if option_value.is_a?(Range)
+    size.send(CHECKS[option], option_value)
+  end
+
+  def filtered_options(value)
+    filtered = options.except(*CHECKS.keys)
+    filtered[:value] = value
+    filtered
+  end
+
+  def detect_error_options(option_value)
+    return { count: human_size(option_value) } unless option_value.is_a?(Range)
+    { min: human_size(option_value.min), max: human_size(option_value.max) }
+  end
+
+  def human_size(size)
+    if defined?(ActiveSupport::NumberHelper)
+      ActiveSupport::NumberHelper.number_to_human_size(size)
+    else
+      opts = { locale: options[:locale], raise: true }
+      format = I18n.t(:'number.human.storage_units.format', opts)
+      unit = I18n.t(:'number.human.storage_units.units.byte', opts.merge(count: size.to_i))
+      format.gsub(/%n/, size.to_i.to_s).gsub(/%u/, unit).html_safe
+    end
+  end
+
+end

data/lib/active_validation/version.rb

@@ -1,3 +1,3 @@
 module ActiveValidation
-  VERSION = '4.0.10'.freeze
+  VERSION = '4.0.11'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: active_validation
 version: !ruby/object:Gem::Version
-  version: 4.0.10
+  version: 4.0.11
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-05-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -184,10 +212,12 @@ files:
 - lib/active_validation/validators/boolean_validator.rb
 - lib/active_validation/validators/coordinate_validator.rb
 - lib/active_validation/validators/credit_card_validator.rb
+- lib/active_validation/validators/csv_validator.rb
 - lib/active_validation/validators/currency_validator.rb
 - lib/active_validation/validators/cusip_validator.rb
 - lib/active_validation/validators/email_validator.rb
 - lib/active_validation/validators/equality_validator.rb
+- lib/active_validation/validators/file_size_validator.rb
 - lib/active_validation/validators/hex_validator.rb
 - lib/active_validation/validators/imei_validator.rb
 - lib/active_validation/validators/ip_validator.rb