capybara-autodoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2990a2002180ade8c3f257a54fe1aa4fd65f558becf4e13c2f882f0d4daed422
+  data.tar.gz: a40083c93bdee457db62fa2e88ff1f9a4df783fbad7facf92c64eb4420424625
+SHA512:
+  metadata.gz: 288ca9cf1f385e2f842b7cca2716a46cb44dafa67355ad5f19b6abc477268901d41db74eb14f6d824f13f8bc1dca9b269df6c7348652f2592a0f7a29aad8a233
+  data.tar.gz: 9da3ce9576d594b449d8db7ce1152359dc59d87a5d83b1cca7c7d6c76d00c169e462172ba932a3e56ed92fe85acbc55131a74809c63b9137341f19ab43831d24

data/bin/capybara-autodoc

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+FileUtils.mkdir_p("spec/support/autodoc")
+template_dirname =  File.dirname(__dir__) + "/lib/templates/."
+
+FileUtils.cp_r(template_dirname, "spec/support/autodoc")
+
+support_dirname =  File.dirname(__dir__) + "/lib/support/."
+FileUtils.cp_r(support_dirname, "spec/support")

data/lib/capybara-autodoc.rb

@@ -0,0 +1,88 @@
+require 'capybara/email/rspec'
+require "slim"
+
+class Capybara::Autodoc
+  @scenarios = []
+
+  def self.start_scenario(title, example)
+    scenario = Scenario.new(title, example)
+    @scenarios << scenario
+    scenario
+  end
+
+  def self.render
+    return if @scenarios.empty?
+
+    `mkdir -p tmp/capybara/autodoc`
+
+    @scenarios.each do |scenario|
+      Rails.root.join("tmp/capybara/autodoc/scenario_#{scenario.index}.html").write(
+        Slim::Template.new(Rails.root.join("spec/support/autodoc/layout.html.slim")).render(scenario) do
+          Slim::Template.new(Rails.root.join("spec/support/autodoc/scenario.html.slim")).render(scenario).html_safe # rubocop:disable Rails/OutputSafety
+        end
+      )
+    end
+
+    Rails.root.join("tmp/capybara/autodoc/index.html").write(
+      Slim::Template.new(Rails.root.join("spec/support/autodoc/layout.html.slim")).render(self) do
+        Slim::Template.new(Rails.root.join("spec/support/autodoc/index.html.slim")).render(self).html_safe # rubocop:disable Rails/OutputSafety
+      end
+    )
+
+    if @scenarios.any?
+      puts "The autodoc is available at file://#{Rails.root.join('tmp/capybara/autodoc/index.html')}"
+    end
+  end
+
+  class Scenario
+    def initialize(title, example)
+      @title = title
+      @index = Digest::SHA1.hexdigest(title)[0..8]
+      @example = example
+      @sections = []
+      @current_section = nil
+    end
+
+    attr_reader :title, :index
+
+    def start_section(title)
+      @current_section = Section.new(title)
+      @sections << @current_section
+    end
+
+    def add_text(description)
+      @current_section.steps << { text: description }
+    end
+
+    def add_screenshot(page_or_email, text: nil, wait_for: nil)
+      if wait_for
+        @example.expect(page_or_email).to(@example.have_content(wait_for))
+      end
+
+      filename = "scenario_#{@index}_section_#{@sections.count}_step_#{@current_section.steps.count}.png"
+      `mkdir -p tmp/capybara/autodoc`
+
+      path = Rails.root.join("tmp/capybara/autodoc/#{filename}")
+
+      if page_or_email.is_a?(Capybara::Node::Email)
+        Capybara.current_session.driver.visit "file://#{page_or_email.save_page}"
+        Capybara.current_session.driver.save_screenshot(path)
+      else
+        page_or_email.driver.save_screenshot(path)
+      end
+
+      img_src = ENV["UPLOAD_TO_GH_PAGES"] ? "/rdv-service-public/#{filename}" : path
+
+      @current_section.steps << { text: text, img_src: img_src }
+    end
+  end
+
+  class Section
+    def initialize(title)
+      @title = title
+      @steps = []
+    end
+
+    attr_accessor :title, :steps
+  end
+end

data/lib/support/autodoc.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+ config.after(:suite) { Capybara::Autodoc.render }
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: capybara-autodoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Mours
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-email
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: victor.mours@beta.gouv.fr
+executables:
+- capybara-autodoc
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/capybara-autodoc
+- lib/capybara-autodoc.rb
+- lib/support/autodoc.rb
+homepage: https://github.com/betagouv/capybara-autodoc
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Turn your integration specs into always up-to-date documentation for your
+  team
+test_files: []