RuboCop (Ruby)

rubocop-aaa est un cop RuboCop personnalisé qui impose le motif Arrange-Act-Assert dans le code de test Ruby.

Installation

# Gemfile
group :development, :test do
  gem 'rubocop-aaa', require: false
end

bundle install

Activer le cop

# .rubocop.yml
require:
  - rubocop-aaa

AAA/Pattern:
  Enabled: true
  Include:
    - 'spec/**/*.rb'
    - 'test/**/*.rb'

Cop : AAA/Pattern

Configuration

AAA/Pattern:
  TestFunctions:
    - it
    - test
    - specify
    - example
  Labels:
    arrange: [arrange]
    act:     [act]
    assert:  [assert]
  CaseSensitive: false
  AllowEmptySection: true

Exemples

Given / When / Then

AAA/Pattern:
  Labels:
    arrange: [given]
    act:     [when]
    assert:  [then]

Français

AAA/Pattern:
  Labels:
    arrange: [préparation, préparer]
    act:     [exécuter]
    assert:  [vérifier, assertion]

Ce qui est détecté

# Offense : "arrange" manquant
it 'bad' do
  # act
  x = do_thing
  # assert
  expect(x).to eq(1)
end

# Offense : ordre incorrect
it 'also bad' do
  # act
  x = do_thing
  # arrange
  y = 1
  # assert
  expect(x).to eq(y)
end

Auto-correction

Quand les trois commentaires de section manquent tous, rubocop -a (ou --autocorrect) insère un modèle # arrange / # act / # assert en haut du bloc. Il ne reste plus qu'à déplacer chaque commentaire au-dessus du code qui lui correspond.

Les autres cas (un ou deux manquants, ordre incorrect, section vide) ne sont pas auto-corrigés — l'emplacement correct dépend de l'intention du test, et le message d'offense indique précisément « quoi » ajouter et « où ».