Docs and metadata

Author: kemenaran

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
+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

README.md

@@ -1,12 +1,18 @@
-# SiretFormatValidator
+_TODO: add badges_
 
-TODO: Delete this and the text below, and describe your gem
+# siret_validator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/siret_validator`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem provides a Rails validator for french [SIRET numbers](https://entreprendre.service-public.fr/vosdroits/F32135?lang=en).
 
-## Installation
+## 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.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
@@ -20,19 +26,49 @@ If bundler is not being used to manage dependencies, install the gem by executin
 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
 
-TODO: Write usage instructions here
+### 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. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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 `version.rb`, 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).
+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/[USERNAME]/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/[USERNAME]/siret_validator/blob/main/CODE_OF_CONDUCT.md).
+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
 

README_fr.md

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

bin/console

@@ -1,4 +1,4 @@
 en:
   errors:
     messages:
-      wrong_siret_format: must be a number of exactly 14 digits
+      wrong_siret_format: is the wrong length (should be 14 digits)

lib/locale/en.yml

@@ -1,4 +1,4 @@
 fr:
   errors:
     messages:
-      wrong_siret_format: doit être un numéro d’exactement 14 chiffres
+      wrong_siret_format: ne fait pas la bonne longueur (doit comporter 14 chiffres)

lib/locale/fr.yml

@@ -2,21 +2,18 @@
 
 Gem::Specification.new do |spec|
   spec.name = "siret_validator"
-  spec.version = "0.1"
+  spec.version = "0.1.0"
   spec.authors = ["Pierre de La Morinerie"]
-  spec.email = ["kemenaran@gmail.com"]
+  spec.email = ["pierre@codeureusesenliberte.fr"]
 
-  spec.summary = "TODO: Write a short summary, because RubyGems requires one."
-  spec.description = "TODO: Write a longer description or delete this line."
-  spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.summary = "A Rails validator for french SIRET numbers"
+  spec.homepage = "https://github.com/CodeursenLiberte/siret_validator"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1.0"
 
-  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["source_code_uri"] = "https://github.com/CodeursenLiberte/siret_validator"
+  spec.metadata["changelog_uri"] = "https://github.com/CodeursenLiberte/siret_validator/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

sig/siret_validator.rbs

@@ -70,11 +70,11 @@ def test_validate_siret_localized_message
     c = Company.new(siret: "foo")
 
     with_locale(:en) do
-      assert_equal c.tap(&:validate).errors[:siret], ["must be a number of exactly 14 digits"]
+      assert_equal c.tap(&:validate).errors[:siret], ["is the wrong length (should be 14 digits)"]
     end
 
     with_locale(:fr) do
-      assert_equal c.tap(&:validate).errors[:siret], ["doit être un numéro d’exactement 14 chiffres"]
+      assert_equal c.tap(&:validate).errors[:siret], ["ne fait pas la bonne longueur (doit comporter 14 chiffres)"]
     end
   end