FiletypeValidation

FiletypeValidation provides an easy to use API for validating files.

Installation

Add this line to your application's Gemfile:

gem 'filetype_validation'

And then execute:

$ bundle

Or install it yourself as:

$ gem install filetype_validation

Usage

The gem currently supports csv file validation:

FiletypeValidation.csv?(file, options)

In this call, file is either a String representing the file path or the file itself and options is a Hash that enables the user to customize their call. The options parameter currently supports these customizations:

  • :max_lines This specifies how many lines of the file the validator will use to decide whether the file is a csv. The default value is 25.

  • :headers This expects either true or false to denote whether the csv file's header will be included in the validation.

  • :skip_extension_check If true, the gem will exclude the check for a '.csv' extension on the filepath

The gem also supports plaintext file validation:

FiletypeValidation.plaintext?(file, options)

In this call, file is either a String representing the file path or the file itself and options is a Hash that enables the user to customize their call. The options parameter currently supports these customizations:

  • :bytes_to_read This specifies how many bytes of the start of the given file the gem will use to determine whether or not it's plaintext.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/optoro/filetype_validation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.