siret_validator 0.1.0 → 1.0.0

checksums.yaml

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

data/README.md

@@ -1,4 +1,8 @@
-_TODO: add badges_
+![Gem Version](https://badge.fury.io/rb/siret_validator.svg) ![build](https://github.com/CodeursenLiberte/siret_validator/actions/workflows/main.yml/badge.svg)
+
+> [!NOTE]
+>
+> Ce README est aussi [disponible en français](README_fr.md).
 
 # siret_validator
 
@@ -17,13 +21,13 @@ This gem provides a Rails validator for french [SIRET numbers](https://entrepren
 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
+bundle add siret_validator
 ```
 
 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
+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.
@@ -62,7 +66,7 @@ By default, the siret validator may emit two different error messages:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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).
 
@@ -76,4 +80,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/CodeursenLiberte/siret_validator/blob/main/CODE_OF_CONDUCT.md).

data/README_fr.md

@@ -1 +1,82 @@
-_TODO_
+![Gem Version](https://badge.fury.io/rb/siret_validator.svg) ![build](https://github.com/CodeursenLiberte/siret_validator/actions/workflows/main.yml/badge.svg)
+
+> [!NOTE]
+>
+> This README is also [available in english](README.md).
+
+# siret_validator
+
+Cette gem fournit un validateur Rails pour les [numéros SIRET](https://entreprendre.service-public.fr/vosdroits/F32135) français.
+
+## Fonctionnalités
+
+* Validation du format SIRET (14 chiffres),
+* Validation du checksum des SIRET classiques (via la somme de Luhn),
+* Validation du checksum des SIRET de La Poste (via la formule de checksum alternative),
+* Messages d'erreur localisés clairs,
+* Support de messages d'erreur personnalisés.
+
+## Installation
+
+Installez la gem et ajoutez-la au Gemfile de l'application en exécutant :
+
+```bash
+bundle add siret_validator
+```
+
+Si Bundler n'est pas utilisé pour gérer les dépendances, installez la gem en exécutant :
+
+```bash
+gem install siret_validator
+```
+
+Vous pouvez également intégrer la gem directement en copiant le fichier `lib/siret_validator.rb` dans votre répertoire `app/validators`.
+
+## Utilisation
+
+### Avec ActiveRecord
+
+```ruby
+class TaxesFilling < ApplicationRecord
+  validates :company_siret, siret: true
+end
+```
+
+### Avec ActiveModel
+
+```ruby
+class TaxesFilling
+  include ActiveModel::Validations
+  attr_accessor :company_siret
+  validates :company_siret, siret: true
+end
+```
+
+## I18n
+
+Par défaut, le validateur SIRET peut émettre deux messages d'erreur distincts :
+
+* `:wrong_siret_format` – lorsque la valeur n'est pas une chaîne de 14 chiffres.
+
+    _Le message est localisé via la clé i18n personnalisée `:wrong_siret_format`. Les locales française et anglaise sont incluses dans la gem._
+* `:invalid` – lorsque le checksum du SIRET est invalide.
+
+    _Le message est localisé via la clé i18n standard Rails `:invalid`._
+
+## Développement
+
+Après avoir cloné le dépôt, exécutez `bin/setup` pour installer les dépendances. Ensuite, lancez `bundle exec rake test` pour exécuter les tests.
+
+Pour installer cette gem sur votre machine locale, exécutez `bundle exec rake install`. Pour publier une nouvelle version, mettez à jour le numéro de version dans `siret_validator.gemspec`, puis exécutez `bundle exec rake release`. Cela créera un tag Git pour la version, poussera les commits et le tag créé, et publiera le fichier `.gem` sur [rubygems.org](https://rubygems.org).
+
+## Contribuer
+
+Les rapports de bugs et les pull requests sont les bienvenus sur GitHub à l'adresse https://github.com/CodeursenLiberte/siret_validator. Ce projet se veut un espace sûr et accueillant pour la collaboration ; les contributeurs sont tenus de respecter le [code de conduite](https://github.com/CodeursenLiberte/siret_validator/blob/main/CODE_OF_CONDUCT.md).
+
+## Licence
+
+Cette gem est mise à disposition sous [licence MIT](https://opensource.org/licenses/MIT).
+
+## Code de conduite
+
+Toute personne interagissant dans la base de code, les issues, les salons de discussion et les listes de diffusion du projet SiretFormatValidator est tenue de respecter le [code de conduite](https://github.com/CodeursenLiberte/siret_validator/blob/main/CODE_OF_CONDUCT.md).

metadata

@@ -1,28 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: siret_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Pierre de La Morinerie
 bindir: exe
 cert_chain: []
-date: 2025-06-28 00:00:00.000000000 Z
+date: 2026-07-16 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 email:
 - pierre@codeureusesenliberte.fr
 executables: []