siret_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a68aa516af558d7018754758c1fa42e34851f257362913fd162423dc1df8dab
+  data.tar.gz: e78fb114111d6e73919bf4d73428aab73d97ddcbfe32736cd0c0961a43533e72
+SHA512:
+  metadata.gz: 0e7b91c593d9f15bc53d05b6a9bcef334c30847300bca8a2ce0b84572192b39da84bfead4ced2527c5d8416f7bcdfce1c6f728a38fd6502f9ea4654ccbee9763
+  data.tar.gz: 45e7479d00d9ca6c8082be1ac80938864185e8d31d51240c68a5399412c1b332545010eadf60d7cae021ab3e5923304d54f8575ef002e995ec99ae7cba9d405b

data/.rubocop.yml

@@ -0,0 +1,22 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountAsOne: ['array', 'hash', 'heredoc', 'method_call']

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+bonjour@codeureusesenliberte.fr.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Pierre de La Morinerie
+
+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,79 @@
+_TODO: add badges_
+
+# siret_validator
+
+This gem provides a Rails validator for french [SIRET numbers](https://entreprendre.service-public.fr/vosdroits/F32135?lang=en).
+
+## 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:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+Alternatively, you can vendor the gem by just copy-pasting the `lib/siret_validator.rb` file into your `app/validators` directory.
+
+## Usage
+
+### With ActiveRecord
+
+```ruby
+class TaxesFilling < ApplicationRecord
+  validates :company_siret, siret: true
+end
+```
+
+### With ActiveModel
+
+```ruby
+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](https://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](https://github.com/CodeursenLiberte/siret_validator/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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](https://github.com/[USERNAME]/siret_validator/blob/main/CODE_OF_CONDUCT.md).

data/README_fr.md

@@ -0,0 +1 @@
+_TODO_

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/locale/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      wrong_siret_format: is the wrong length (should be 14 digits)

data/lib/locale/fr.yml

@@ -0,0 +1,4 @@
+fr:
+  errors:
+    messages:
+      wrong_siret_format: ne fait pas la bonne longueur (doit comporter 14 chiffres)

data/lib/siret_validator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "active_model"
+require "active_support/i18n"
+I18n.load_path += Dir["#{File.dirname(__FILE__)}/locale/*.yml"]
+
+module ActiveModel
+  module Validations
+    class SiretValidator < ActiveModel::EachValidator
+      LA_POSTE_SIREN = "356000000"
+      LA_POSTE_SIRET_SIEGE = "35600000000048"
+
+      def validate_each(record, attribute, value)
+        if !valid_format?(value)
+          record.errors.add(attribute, :wrong_siret_format, **options)
+        elsif !valid_checksum?(value)
+          record.errors.add(attribute, :invalid, **options)
+        end
+      end
+
+      private
+
+      def valid_format?(value)
+        value&.match?(/^\d{14}$/)
+      end
+
+      def valid_checksum?(value)
+        if siret_attached_to_la_poste?(value)
+          valid_la_poste_checksum?(value)
+        else
+          valid_luhn?(value)
+        end
+      end
+
+      def siret_attached_to_la_poste?(value)
+        value[0..8] == LA_POSTE_SIREN
+      end
+
+      def valid_luhn?(value)
+        (luhn_checksum(value) % 10 == 0)
+      end
+
+      def luhn_checksum(value)
+        value.reverse.each_char.map(&:to_i).map.with_index do |digit, index|
+          t = index.even? ? digit : digit * 2
+          t < 10 ? t : t - 9
+        end.sum
+      end
+
+      def valid_la_poste_checksum?(value)
+        value == LA_POSTE_SIRET_SIEGE || (la_poste_checksum(value) % 5 == 0)
+      end
+
+      def la_poste_checksum(value)
+        value.each_char.map(&:to_i).sum
+      end
+    end
+
+    module HelperMethods
+      # Validates whether the value of the specified attribute is a valid SIRET number.
+      #
+      # A SIRET number is valid if:
+      # * It is made of exactly 14 digits (otherwise a `:wrong_siret_format` error is added).
+      # * Its checksum is valid (otherwise an `:invalid` error is added).
+      #
+      #   class TaxesFilling
+      #     include ActiveModel::Validations
+      #     attr_accessor :company_siret
+      #     validates_siret_of :company_siret
+      #   end
+      #
+      # Configuration options:
+      # * <tt>:message</tt> - A custom error message.
+      #
+      # There is also a list of default options supported by every validator:
+      # +:if+, +:unless+, +:on+, +:allow_nil+, +:allow_blank+, and +:strict+.
+      # See ActiveModel::Validations::ClassMethods#validates for more information.
+      def validates_siret_of(*attr_names)
+        validates_with SiretValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: siret_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre de La Morinerie
+bindir: exe
+cert_chain: []
+date: 2025-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+email:
+- pierre@codeureusesenliberte.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- README_fr.md
+- Rakefile
+- lib/locale/en.yml
+- lib/locale/fr.yml
+- lib/siret_validator.rb
+homepage: https://github.com/CodeursenLiberte/siret_validator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CodeursenLiberte/siret_validator
+  source_code_uri: https://github.com/CodeursenLiberte/siret_validator
+  changelog_uri: https://github.com/CodeursenLiberte/siret_validator/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Rails validator for french SIRET numbers
+test_files: []