Module: FiletypeValidation

Defined in:
lib/filetype_validation.rb,
lib/filetype_validation/version.rb,
lib/filetype_validation/csv_validator.rb,
lib/filetype_validation/base_validator.rb,
lib/filetype_validation/plaintext_validator.rb

Overview

API entry point

Defined Under Namespace

Classes: BaseValidator, CsvValidator, PlaintextValidator

Constant Summary collapse

VERSION = 
'0.1.5'.freeze

Class Method Summary collapse

Class Method Details

.csv?(file, options = {}) ⇒ Boolean

Evaluates whether given file is a csv

Parameters:

  • file (File, String) —

    the file or filepath

  • options (Hash{Symbol => Number}) (defaults to: {}) —

    validation customizations

Returns:

  • (Boolean) —

    true if file is a csv



12
13
14
 
# File 'lib/filetype_validation.rb', line 12

def self.csv?(file, options = {})
  CsvValidator.new(file, options).valid?
end

.plaintext?(file, options = {}) ⇒ Boolean

Evaluates whether given file is plaintext

Parameters:

  • file (File, String) —

    the file or filepath

  • options (Hash{Symbol => Number}) (defaults to: {}) —

    validation customizations

Returns:

  • (Boolean) —

    true if file is plaintext



21
22
23
 
# File 'lib/filetype_validation.rb', line 21

def self.plaintext?(file, options = {})
  PlaintextValidator.new(file, options).valid?
end