betagouv-cucumber-steps 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d25b49caf9af571492d08dbcecbd139f9af1f36810670b9b08784df0e78fd771
-  data.tar.gz: 7fbb8d38d7fa338732b3c61232c67f9aadb3277a8317cc1261019e0c8f78da56
+  metadata.gz: ac48905d0b5c9b447895d58d165a7bd8b3f0a71bc6a92df2dcf91cd601f99711
+  data.tar.gz: 296aba285ee3e81a8895d18123c7d57d32f60b489aed9fbe128065dd18daad86
 SHA512:
-  metadata.gz: 4dd9572c4a3d7656b6c4639bb2d2ab3bdf3fb365b57c23efe2ca82cf0a4e3adaf19ba1f0f717afe1172029b6e3a3a7ed649f56487aa86bf38f33e358288d9591
-  data.tar.gz: cf1b729b5e9c001674c48d3bf78a05f4e68e7a1b553b688a63c1251415a76f16836ad485494f45ba577c9de98da8c7990b38d66360cfb03d5b376312c0775a05
+  metadata.gz: f9980b077f998acf2bb3907e973044af516e9aba615daac45d23dab5ce36368b2fde867b913d5578a6aece172f9d9472c9883ab6b89f4e8601eb8a977fadfa30
+  data.tar.gz: 9a985477efe543f91d8add119559c8dd866e88c4809e112e77ae93426ecf61bb9c2a763cd58f9a07fec2311f1ce197f1fb83e720bdc6ed1aac6522bf487c8c01

data/.rubocop.yml

@@ -1,3 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - ./lib/rubocop/cop/cucumber/step_naming
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-capybara
+
 AllCops:
   TargetRubyVersion: 3.1
 
@@ -6,3 +16,6 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Cucumber/StepNaming:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-08-18 21:58:35 UTC using RuboCop version 1.78.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+# Configuration parameters: AsciiConstants.
+Naming/AsciiIdentifiers:
+  Exclude:
+    - 'test/support/env.rb'

data/README.md

@@ -5,7 +5,19 @@ Cucumber](https://cucumber.io/docs/gherkin/reference#steps)
 génériques, surcouche française des matchers Capybara qui vous permet
 de contruire votre propre librairie d'actions pour vos tests Cucumber.
 
-Par exemple :
+Cette gem est fraîchement extraite de plusieurs projets Beta
+([APLyPro](https://github.com/betagouv/aplypro/blob/main/features/step_definitions/web_steps.rb),
+[Datapass](https://github.com/etalab/data_pass/blob/develop/features/step_definitions/web_steps.rb),
+[Auto-audit](https://github.com/betagouv/auto-audit/blob/main/features/step_definitions/web_steps.rb))
+et s'attend à une utilisation du DSFR.
+
+## Aperçu
+
+La librairie propose une [batterie
+d'actions](./lib/betagouv/cucumber/steps.rb), qui vous permet de
+composer vos tests.
+
+### Exemple bête mais pas méchant
 
 ```ruby
 Alors("la page contient {string}") do |content|
@@ -29,6 +41,26 @@ Scénario: la page d'accueil contient le nom du produit
   Alors la page contient "foobar"
 ```
 
+### Exemple avancé : composition d'une étape à vous (métier)
+
+```ruby
+Quand("je rajoute un utilisateur {string}") do |nom|
+  steps %(
+    Quand je me rends sur la page d'accueil
+    Et que je clique sur "Rajoutez un utilisateur" dans le menu principal
+    Et que je remplis "Nom" avec "#{nom}"
+    Et que je clique sur "Enregistrer"
+  )
+end
+```
+
+```feature
+Fonctionnalité: Gestion des utilisateurs
+  Scénario: Je peux rajouter un utilisateur
+    Quand je rajoute un utilisateur "Marie Curie" # et paf
+    Alors la page contient "Marie Curie a bien été rajouté(e)"
+```
+
 ## Installation
 
 ```ruby
@@ -49,9 +81,6 @@ steps](./lib/betagouv/cucumber/steps.rb).
 
 ## Debug / Contribution
 
-Cette gem est fraîchement extraite de plusieurs projets Beta et
-nécessite probablement plus de travail.
-
 Si un step ne fonctionne pas vous pouvez :
 
 * utilisez le step `Alors debugger` pour debugger votre page en live

data/Rakefile

@@ -2,11 +2,24 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "cucumber/rake/task"
 
 RSpec::Core::RakeTask.new(:spec)
 
+Cucumber::Rake::Task.new(:cucumber) do |task|
+  task.cucumber_opts = [
+    "--require",
+    "test/support",
+    "test/features/",
+    "--publish-quiet"
+  ]
+end
+
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
+desc "Run all tests"
+task test: %i[spec cucumber]
+
 task default: %i[spec rubocop]

data/lib/betagouv/cucumber/debug_steps.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# rubocop:disable Cucumber/StepNaming
+Quand("debugger") do
+  debugger # rubocop:disable Lint/Debugger
+end
+
+Quand("print the page") do
+  log page.body
+end
+# rubocop:enable Cucumber/StepNaming

data/lib/betagouv/cucumber/steps/version.rb

@@ -3,7 +3,7 @@
 module Betagouv
   module Cucumber
     module Steps
-      VERSION = "0.0.1"
+      VERSION = "0.1.0"
     end
   end
 end

data/lib/betagouv/cucumber/steps.rb

@@ -2,176 +2,5 @@
 
 require_relative "steps/version"
 
-Quand("je me rends sur la page d'accueil") do
-  visit "/"
-end
-
-Alors("la page contient {string}") do |content|
-  expect(page).to have_content(content)
-end
-
-Alors("l'en-tête contient {string}") do |content|
-  within(".fr-header") do
-    step(%(la page contient "#{content}"))
-  end
-end
-
-Quand("print the page") do
-  log page.body
-end
-
-Quand("je clique sur {string}") do |label|
-  click_link_or_button label
-end
-
-Quand("je clique sur le premier lien ou bouton {string}") do |label|
-  click_link_or_button(label, match: :first)
-end
-
-Alors("la page contient un bouton {string}") do |label|
-  expect(page).to have_button(label)
-end
-
-Alors("la page ne contient pas de bouton {string}") do |title|
-  expect(page).not_to have_button(title)
-end
-
-Alors("la page contient un bouton {string} désactivé") do |content|
-  expect(page).to have_button(content, disabled: true)
-end
-
-Alors("la page ne contient pas {string}") do |content|
-  expect(page).to have_no_content(content)
-end
-
-Alors("la page contient un lien {string}") do |text|
-  expect(page).to have_link(text)
-end
-
-Alors("le titre de la page contient {string}") do |text|
-  expect(page.title.gsub("  ", " ")).to include text
-end
-
-Alors("il y a un titre de premier niveau contenant {string}") do |text|
-  # le titre est soit le premier h1 ou la légende du premier tableau
-  element = page.first("h1") || page.first("table caption")
-
-  expect(element.text).to include(text)
-end
-
-Alors("la page est titrée {string}") do |text|
-  steps %(
-    Alors il y a un titre de premier niveau contenant "#{text}"
-    Et le titre de la page contient "#{text}"
-  )
-end
-
-Quand("je remplis {string} avec {string}") do |label, value|
-  fill_in label, with: value
-end
-
-Quand("je remplis le champ {string} avec {string} dans les champs de {string}") do |label, value, fieldset_legend|
-  within_fieldset(fieldset_legend) do
-    fill_in label, with: value
-  end
-end
-
-Quand("je coche {string}") do |label|
-  check label
-end
-
-Quand("je décoche {string}") do |label|
-  uncheck label
-end
-
-Quand('je coche toutes les cases') do
-  page
-    .all('input[type="checkbox"]')
-    .map { |node| node.sibling("label").text }
-    .each { |label| step(%(je coche "#{label}")) }
-end
-
-
-Quand("je clique sur {string} dans la rangée {string}") do |link, row|
-  within("tr", text: row) do
-    click_link_or_button(link)
-  end
-end
-
-Alors("la rangée {string} contient {string}") do |row, content|
-  within("tr", text: row) do
-    expect(page).to have_content(content)
-  end
-end
-
-Quand("je clique sur {string} dans la dernière rangée") do |link|
-  within(all("tr").last) do
-    click_link_or_button(link)
-  end
-end
-
-Quand("je clique sur {string} dans la classe {string}") do |link, title|
-  within("section", text: title) do
-    click_link_or_button(link)
-  end
-end
-
-Quand("je remplis le champ {string} dans la rangée {string} avec {string}") do |locator, row, value|
-  within("tr", text: row) do
-    fill_in locator, with: value
-  end
-end
-
-Quand("je sélectionne {string} pour {string}") do |option, name|
-  select option, from: name
-end
-
-Quand("je choisis {string}") do |option|
-  choose option
-end
-
-Quand("je choisis {string} pour {string}") do |option, fieldset|
-  within("fieldset", text: fieldset) do
-    choose option
-  end
-end
-
-Quand("j'attache le fichier {string} pour le champ {string}") do |path, field|
-  attach_file(field, path)
-end
-
-Alors("je peux voir dans le tableau {string}") do |caption, table|
-  expect(page).to have_table(caption, with_rows: table.rows)
-end
-
-Alors("je peux voir dans le tableau {string} dans cet ordre :") do |caption, table_data|
-  within_table(caption) do
-    table_data.rows.each_with_index do |row, row_number|
-      row.each_with_index do |cel, cel_number|
-        expect(find("tr[#{row_number + 1}]/td[#{cel_number + 1}]")).to have_text(cel)
-      end
-    end
-  end
-end
-
-Alors("debugger") do
-  debugger # rubocop:disable Lint/Debugger
-end
-
-Quand("je rafraîchis la page") do
-  visit current_path
-end
-
-Alors("le fil d'Ariane affiche {string}") do |path|
-  components = path.split(" > ")
-
-  breadcrumbs = page.all("nav.fr-breadcrumb li").map(&:text)
-
-  expect(breadcrumbs).to eq components
-end
-
-Quand("je clique sur {string} dans le menu principal") do |item|
-  within("nav#main-nav") do
-    click_link_or_button(item)
-  end
-end
+require_relative "debug_steps"
+require_relative "web_steps"

data/lib/betagouv/cucumber/web_steps.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+Quand("je me rends sur la page d'accueil") do
+  visit "/"
+end
+
+Alors("la page contient {string}") do |content|
+  expect(page).to have_content(content)
+end
+
+Alors("l'en-tête contient {string}") do |content|
+  within(".fr-header") do
+    step(%(la page contient "#{content}"))
+  end
+end
+
+Quand("je clique sur {string}") do |label|
+  click_link_or_button label
+end
+
+Quand("je clique sur le premier lien ou bouton {string}") do |label|
+  click_link_or_button(label, match: :first)
+end
+
+Alors("la page contient un bouton {string}") do |label|
+  expect(page).to have_button(label)
+end
+
+Alors("la page ne contient pas de bouton {string}") do |title|
+  expect(page).not_to have_button(title)
+end
+
+Alors("la page contient un bouton {string} désactivé") do |content|
+  expect(page).to have_button(content, disabled: true)
+end
+
+Alors("la page ne contient pas {string}") do |content|
+  expect(page).to have_no_content(content)
+end
+
+Alors("la page contient un lien {string}") do |text|
+  expect(page).to have_link(text)
+end
+
+Alors("le titre de la page contient {string}") do |text|
+  expect(page.title.gsub("  ", " ")).to include text
+end
+
+Alors("il y a un titre de premier niveau contenant {string}") do |text|
+  # le titre est soit le premier h1 ou la légende du premier tableau
+  element = page.first("h1") || page.first("table caption")
+
+  expect(element.text).to include(text)
+end
+
+Alors("la page est titrée {string}") do |text|
+  steps %(
+    Alors il y a un titre de premier niveau contenant "#{text}"
+    Et le titre de la page contient "#{text}"
+  )
+end
+
+Quand("je remplis {string} avec {string}") do |label, value|
+  fill_in label, with: value
+end
+
+Quand("je remplis le champ {string} avec {string} dans les champs de {string}") do |label, value, fieldset_legend|
+  within_fieldset(fieldset_legend) do
+    fill_in label, with: value
+  end
+end
+
+Quand("je coche {string}") do |label|
+  check label
+end
+
+Quand("je décoche {string}") do |label|
+  uncheck label
+end
+
+Quand("je coche toutes les cases") do
+  page
+    .all('input[type="checkbox"]')
+    .map { |node| node.sibling("label").text }
+    .each { |label| step(%(je coche "#{label}")) }
+end
+
+Quand("je clique sur {string} dans la rangée {string}") do |link, row|
+  within("tr", text: row) do
+    click_link_or_button(link)
+  end
+end
+
+Alors("la rangée {string} contient {string}") do |row, content|
+  within("tr", text: row) do
+    expect(page).to have_content(content)
+  end
+end
+
+Quand("je clique sur {string} dans la dernière rangée") do |link|
+  within(all("tr").last) do
+    click_link_or_button(link)
+  end
+end
+
+Quand("je remplis le champ {string} dans la rangée {string} avec {string}") do |locator, row, value|
+  within("tr", text: row) do
+    fill_in locator, with: value
+  end
+end
+
+Quand("je sélectionne {string} pour {string}") do |option, name|
+  select option, from: name
+end
+
+Quand("je choisis {string}") do |option|
+  choose option
+end
+
+Quand("je choisis {string} pour {string}") do |option, fieldset|
+  within("fieldset", text: fieldset) do
+    choose option
+  end
+end
+
+Quand("j'attache le fichier {string} pour le champ {string}") do |path, field|
+  attach_file(field, path)
+end
+
+Alors("le tableau {string} contient :") do |caption, table|
+  expect(page).to have_table(caption, with_rows: table.rows)
+end
+
+Alors("la colonne {string} du tableau {string} contient dans l'ordre :") do |column_name, caption, table_data|
+  within_table(caption) do
+    headers = all("thead th").map(&:text)
+    column_index = headers.index(column_name)
+
+    column_texts = all("tbody tr").map do |row|
+      row.all("th, td")[column_index].text
+    end
+
+    expect(column_texts).to eq(table_data.raw.flatten)
+  end
+end
+
+Quand("je rafraîchis la page") do
+  visit current_path
+end
+
+Alors("le fil d'Ariane affiche {string}") do |path|
+  components = path.split(" > ")
+
+  breadcrumbs = page.all("nav.fr-breadcrumb li").map(&:text)
+
+  expect(breadcrumbs).to eq components
+end
+
+Quand("je clique sur {string} dans le menu principal") do |item|
+  within("nav#main-nav") do
+    click_link_or_button(item)
+  end
+end

data/lib/rubocop/cop/cucumber/step_naming.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Cucumber
+      # this cop ensures we write constitent steps: active voice for
+      # the actions, and passive voice for the expectations.
+      #
+      # ---
+      # Actions :
+      #
+      # bad :
+      # Quand le bouton Enregistrer est cliqué
+
+      # good :
+      # Quand je clique sur le bouton Enregistrer
+      #
+      # ---
+      # Exceptations :
+      #
+      # bad :
+      # Alors je peux voir dans le tableau X que la colonne Y contient dans cet ordre
+      #
+      # good :
+      # Alors la colonne X dans le tableau Y contient dans cet ordre :
+      #
+      class StepNaming < Base
+        MSG_QUAND_SHOULD_START_WITH_JE = '"Quand" steps should start with "je"'
+        MSG_ALORS_SHOULD_NOT_START_WITH_JE = '"Alors" steps should not start with "je"'
+
+        def on_send(node)
+          return unless step_definition?(node)
+
+          step_type = node.method_name.to_s
+          step_text = extract_step_text(node)
+
+          return unless step_text
+
+          case step_type
+          when "Quand"
+            check_quand_step(node, step_text)
+          when "Alors"
+            check_alors_step(node, step_text)
+          end
+        end
+
+        private
+
+        def step_definition?(node)
+          %w[Quand Alors].include?(node.method_name.to_s) && node.arguments.any?
+        end
+
+        def extract_step_text(node)
+          first_arg = node.arguments.first
+          return unless first_arg&.str_type?
+
+          first_arg.str_content
+        end
+
+        def check_quand_step(node, step_text)
+          return if step_text.start_with?("je ") || step_text.start_with?("j'")
+
+          add_offense(node, message: MSG_QUAND_SHOULD_START_WITH_JE)
+        end
+
+        def check_alors_step(node, step_text)
+          return unless step_text.start_with?("je ") || step_text.start_with?("j'")
+
+          add_offense(node, message: MSG_ALORS_SHOULD_NOT_START_WITH_JE)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: betagouv-cucumber-steps
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Stéphane Maniaci
 bindir: exe
 cert_chain: []
-date: 2025-07-10 00:00:00.000000000 Z
+date: 2025-08-20 00:00:00.000000000 Z
 dependencies: []
 description: These helpers provide a (French) human syntax to drive a browser
 email:
@@ -18,11 +18,15 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/betagouv/cucumber/debug_steps.rb
 - lib/betagouv/cucumber/steps.rb
 - lib/betagouv/cucumber/steps/version.rb
+- lib/betagouv/cucumber/web_steps.rb
+- lib/rubocop/cop/cucumber/step_naming.rb
 - sig/betagouv/cucumber/steps.rbs
 homepage: https://github.com/betagouv/cucumber-steps
 licenses: