0.0
The project is in a healthy, maintained state
A Rails validator for french SIRET numbers
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

 Project Readme

Gem Version build

siret_validator

This gem provides a Rails validator for french SIRET numbers.

Features

  • Validate the SIRET format (14 digits),
  • Validate the checksum of regular SIRETs (with luhn sum),
  • Validate the checksum of La Poste SIRETs (with the alternative checksum formula),
  • Clear localized error messages,
  • Ad-hoc error messages support.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add siret_validator

If bundler is not being used to manage dependencies, install the gem by executing:

gem install siret_validator

Alternatively, you can vendor the gem by just copy-pasting the lib/siret_validator.rb file into your app/validators directory.

Usage

With ActiveRecord

class TaxesFilling < ApplicationRecord
  validates :company_siret, siret: true
end

With ActiveModel

class TaxesFilling
  include ActiveModel::Validations

  attr_accessor :company_siret
  validates :company_siret, siret: true
end

I18n

By default, the siret validator may emit two different error messages:

  • :wrong_siret_format – when the value is not an 14-digits string.

    The message is localized using a custom :wrong_siret_format i18n key. French and English locales are bundled with the gem.

  • :invalid – when the SIRET checksum is invalid.

    The message is localized using the standard Rails :invalid i18n key.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests.

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

Contributing

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

License

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

Code of Conduct

Everyone interacting in the SiretFormatValidator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.