bddgenx 0.1.43 → 0.1.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d5aae37397f6f4cbebc64d87ea9046812aa8ca9754f15963f7a943e04c870f
-  data.tar.gz: cad3d2ef7e11724824d2cd3c3a31ffd09725d189f6f20813488fd5164db1ea01
+  metadata.gz: bd3102863b9bbf30f979673c0a24d0b0f256f434af382a3efcaed7f2dc766930
+  data.tar.gz: 8c36dc262f88c01373968fbc251fe543359cb95f716bc28b8e75a755557b4288
 SHA512:
-  metadata.gz: 8f9d4ff065c91d9b4c20e77fa2ef267c13c43d574d5f825afa0eb07f90518ba1994666a95464058152a8f8346a1283a9419311ad4ee3a55ed42ce75ae492a222
-  data.tar.gz: b7f6fc413a78140a23812ab38db086b49c5cb5db1fdd0f51251e5607df6a6c57481c07acee2c95303b9e99ffa1120ae8f165dde5a698dca4c915ab9c7ad0c1cb
+  metadata.gz: 0fe963d729bb3d0d467d37a3cdfdf229e9ac0ee58df5451f72a6a93206f09e830fe1695b06b18682a7ac1bf73143a1b703e91ff7714efc3428d192c378ffd893
+  data.tar.gz: a7cf35c73fa936673078da5a2c47ea9208e913d5f9e86b23bf882a16b6c87b27814a5b617b6a28984f810fa8d66fce8854f89b4b86b2442e80bb362877142240

data/README.md

@@ -1,142 +1,89 @@
-# 🧪 Gerador de BDD Automático em Ruby
-[![Gem Version](https://badge.fury.io/rb/bddgenx.svg)](https://badge.fury.io/rb/bddgenx)
+# Gerador Automático de BDD em Ruby
 
-Este projeto gera arquivos `.feature` (Gherkin) e `steps.rb` automaticamente a partir de arquivos `.txt` com histórias de usuário, seguindo padrões ISTQB, parametrização com `Examples` e integração com pipelines.
+## Visão Geral
 
----
+Ferramenta Ruby para gerar automaticamente arquivos Gherkin (`.feature`) e definições de passos (`steps.rb`) a partir de histórias em texto. Atende aos padrões ISTQB, suporta parametrização com blocos de exemplos e fornece relatórios de QA (rastreabilidade, backups e PDF).
 
-## 📂 Estrutura do Projeto
-```txt
-bddgenx/  
-├── bin/bddgenx              # CLI executável  
-├── input/                   # .txt de histórias de usuário  
-├── features/                # .feature geradas  
-├── features/<nome>/steps/   # step definitions por feature (se existir)  
-├── reports/                 # todos os artefatos de saída  
-│   ├── backup/              # versões antigas de .feature  
-│   ├── output/              # rastreabilidade.csv  
-│   └── pdf/                 # relatórios camelCase  
-├── lib/  
-│   ├── bddgenx/  
-│   │   ├── parser.rb  
-│   │   ├── validator.rb  
-│   │   ├── generator.rb  
-│   │   ├── steps_generator.rb  
-│   │   ├── tracer.rb  
-│   │   ├── backup.rb  
-│   │   └── pdf_exporter.rb  
-│   └── bddgenx.rb           # Runner que orquestra tudo  
-├── Gemfile  
-├── bddgenx.gemspec  
-├── Rakefile 
-├── VERSION
-├── bump_version.sh  
-└── README.md
-```
-## ▶️ Como Executar
+## Instalação
 
-### 🔧 Requisitos
-- Ruby 3.x
-- `bundle install` (caso use gems como `prawn` ou `jira-ruby`)
+Adicione ao seu `Gemfile`:
 
-### 🏁 Comando direto:
+```ruby
+gem 'bddgenx'
+```
+
+Execute:
 
 ```bash
-ruby main.rb
+bundle install
 ```
 
-🧱 Com Rake:
+Ou instale diretamente:
+
 ```bash
-rake bddgen:gerar
+gem install bddgenx
 ```
 
-📥 Como Escrever um .txt de Entrada
-```txt
-# language: pt
-Como um usuario do sistema
-Quero fazer login com sucesso
-Para acessar minha conta
+## Uso no Código
 
-[FAILURE]
-Quando preencho email e senha válidos
-Então vejo a tela inicial
+```ruby
+require 'bddgenx'
 
-[SUCCESS]
-Quando tento logar com "<email>" e "<senha>"
-Então recebo "<resultado>"
+# Gera todas as features e steps a partir dos .txt em input/
+Bddgenx::Runner.execute
 
-[EXAMPLES]
-| email            | senha   | resultado               |
-| user@site.com    | 123456  | login realizado         |
-| errado@site.com  | senha   | credenciais inválidas   |
+# Opcional: gerar apenas novos artefatos
+Bddgenx::Runner.execute(only_new: true)
+
+# Opcional: gerar apenas uma feature específica
+Bddgenx::Runner.execute(feature: 'input/minha_historia.txt')
 ```
-✅ Blocos Suportados
-[CONTEXT] – contexto comum
 
-[SUCCESS] – cenário positivo
+## Tarefa Rake (opcional)
 
-[FAILURE] – cenário negativo
+Em um projeto Rails ou Ruby com Rake, adicione ao `Rakefile`:
 
-[ERROR], [EXCEPTION], [PERFORMANCE], etc.
+```ruby
+require 'bddgenx'
+require 'rake'
 
-[REGRA] ou [RULE] – regras de negócio
+namespace :bddgenx do
+  desc 'Gera .feature e steps a partir de histórias em input/'
+  task :gerar do
+    Bddgenx::Runner.execute
+  end
+end
+```
 
-[EXAMPLES] – tabela de dados para Scenario Outline
+## Formato do Arquivo de Entrada (`.txt`)
 
-🧠 Saída esperada (feature)
-```gherkin
+```txt
 # language: pt
-Funcionalidade: adicionar produtos ao carrinho
-
-  Como um cliente do e-commerce
-  Quero adicionar produtos ao carrinho
-  Para finalizar minha compra com praticidade
+Como um usuário do sistema
+Quero fazer login
+Para acessar minha conta
 
-  Regra: O carrinho não deve permitir produtos fora de estoque
-    E o valor total deve refletir o desconto promocional
+[SUCCESS]
+Quando preencho <email> e <senha>
+Então vejo a tela inicial
 
-  Contexto:
-    Dado que estou logado na plataforma
-    E tenho produtos disponíveis
+[EXAMPLES]
+| email            | senha   | resultado               |
+| user@site.com    | 123456  | login realizado         |
+| errado@site.com  | senha   | credenciais inválidas   |
+```
 
-  @success
-  Cenário: Teste Positivo - adiciono um produto ao carrinho - ele aparece na listagem do carrinho
-    Quando adiciono um produto ao carrinho
-    Então ele aparece na listagem do carrinho
+## Artefatos de QA
 
-  Esquema do Cenário: Gerado a partir de dados de exemplo
-    Quando adiciono "<produto>" com quantidade <quantidade>
-    Então vejo o total <total esperado>
+* **Rastreabilidade**: `reports/output/rastreabilidade.csv` com colunas:
+  `Funcionalidade, Tipo, Tag, Cenário, Passo, Origem`
+* **Backup**: versões antigas de `.feature` em `reports/backup` com timestamp
+* **PDF**: exporta features em P/B para `reports/pdf` via `PDFExporter`
 
-    Exemplos:
-      | produto        | quantidade | total esperado |
-      | Camiseta Azul  | 2          | 100            |
-      | Tênis Branco   | 1          | 250            |
-```
+## Integração CI/CD
 
-🧩 Step Definitions geradas
-```ruby
-Quando('adiciono "<produto>" com quantidade <quantidade>') do |produto, quantidade|
-  pending 'Implementar passo: adiciono "<produto>" com quantidade <quantidade>'
-end
+Exemplo de GitHub Actions:
 
-Então('vejo o total <total esperado>') do |total_esperado|
-  pending 'Implementar passo: vejo o total <total esperado>'
-end
-```
-🧾 Rastreabilidade
-- Gera automaticamente um CSV em output/rastreabilidade.csv com:
-- Nome do cenário
-- Tipo (SUCCESS, FAILURE, etc.)
-- Caminho do .feature
-- Origem do .txt
-
-🔄 Backup
-Toda vez que um .feature existente for sobrescrito, a versão anterior é salva em:
-```
-backup/
-```
-✅ Execução em CI/CD (GitHub Actions)
 ```yaml
 jobs:
   gerar_bdd:
@@ -145,26 +92,11 @@ jobs:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.2'
-      - run: ruby main.rb
+          ruby-version: '3.x'
+      - run: bundle install
+      - run: bundle exec ruby -e "require 'bddgenx'; Bddgenx::Runner.execute(only_new: true)"
 ```
-⚙️ Alternativa: Usar via Rake
-
-Você também pode executar a gem bddgenx com Rake, como em projetos Rails:
-
-Crie um arquivo Rakefile:
-```ruby
-require "bddgenx"
-require "rake"
 
-namespace :bddgenx do
-  desc "Gera arquivos .feature e steps a partir de arquivos .txt"
-  task :gerar do
-    Bddgenx::Runner.execute
-  end
-end
-```
+## Licença
 
-👨‍💻 Autor
-David Nascimento – Projeto de automação BDD com Ruby – 2025
----
+MIT © 2025 David Nascimento

data/Rakefile

@@ -1,54 +1,55 @@
+# Rakefile
+# Tarefas para geração automática de BDD e relatórios com bddgenx
+
 require 'rake'
-require_relative 'lib/bddgenx.rb'
-require_relative 'lib/bddgenx/utils/porter'
-require_relative 'lib/bddgenx/integrations/jira'
-require_relative 'lib/bddgenx/integrations/testlink'
+require 'fileutils'
+require 'bddgenx'
 
 namespace :bddgenx do
+  desc 'Gerar arquivos .feature, steps, rastreabilidade e backups'
+  task :gerar, [:only_new, :input_dir] do |t, args|
+    # Parâmetros: only_new (true/false), input_dir (pasta com .txt)
+    args.with_defaults(only_new: 'false', input_dir: 'input')
+    only_new = args.only_new == 'true'
+    input_dir = args.input_dir
+
+    files = FileList["#{input_dir}/*.txt"]
+    if files.empty?
+      puts "❌ Nenhum arquivo encontrado em \#{input_dir}"
+      next
+    end
+
+    files.each do |file|
+      puts "🔄 Processando história: \#{file}"
+      historia = Bddgenx::Parser.ler_historia(file)
+      next unless Bddgenx::Validator.validar(historia)
+
+      feature_path, conteudo = Bddgenx::Generator.gerar_feature(historia)
+
+      Bddgenx::Backup.salvar_versao_antiga(feature_path)
+      Bddgenx::Generator.salvar_feature(feature_path, conteudo)
 
-  desc "Gerar arquivos .feature, steps, rastreabilidade e backups"
-  task :gerar do
-    arquivos = Bddgenx::CLI.todos_arquivos('input')
-    arquivos.each do |arquivo|
-      puts "🔁 Executando: ruby bddgen.rb"
-      system("ruby lib/bddgen.rb")
+      Bddgenx::StepsGenerator.gerar_passos(feature_path)
+      Bddgenx::Tracer.adicionar_entrada(historia, feature_path)
     end
 
+    puts "✅ Geração concluída#{' (apenas novos)' if only_new}!"
   end
 
-  desc "Exportar todos os arquivos .feature para PDF"
+  desc 'Exportar todos os arquivos .feature para PDF'
   task :pdf do
-    puts "📦 Exportando para PDF..."
-    Bddgenx::PDFExporter.exportar_todos
+    puts '📦 Exportando features para PDF...'
+    result = Bddgenx::PDFExporter.exportar_todos
+    puts "   Gerados: \#{result[:generated].size}, Pulados: \#{result[:skipped].size}"
   end
 
-  desc "Enviar todos os cenários para o Jira"
-  task :jira do
-    jira = Bddgenx::Integrations::Jira.new(
-      username: ENV['JIRA_USER'],
-      api_token: ENV['JIRA_TOKEN'],
-      site: ENV['JIRA_SITE'],
-      project_key: ENV['JIRA_PROJECT']
-    )
-
-    Dir.glob("features/*.feature") do |arquivo|
-      conteudo = File.read(arquivo)
-      titulo = File.basename(arquivo, ".feature").gsub('_', ' ').capitalize
-      jira.enviar_cenario(titulo, conteudo)
-    end
-  end
-
-  desc "Enviar todos os cenários para o TestLink"
-  task :testlink do
-    testlink = Bddgen::Integrations::TestLink.new(
-      ENV['TESTLINK_TOKEN'],
-      ENV['TESTLINK_URL']
-    )
-
-    Dir.glob("features/*.feature") do |arquivo|
-      conteudo = File.readlines(arquivo).reject { |l| l.strip.start_with?("#") || l.strip.empty? }
-      titulo = File.basename(arquivo, ".feature").gsub('_', ' ').capitalize
-      testlink.criar_caso_teste(ENV['TESTLINK_PLAN_ID'].to_i, titulo, conteudo)
+  desc 'Remover diretórios gerados (reports/ e features/)'
+  task :clean do
+    %w[reports features].each do |dir|
+      FileUtils.rm_rf(dir)
+      puts "🗑️  Diretório removido: \#{dir}"
     end
   end
 end
+
+task default: 'bddgenx:gerar'

data/VERSION

@@ -1 +1 @@
-0.1.43
+0.1.44

data/lib/bddgenx/generator.rb

@@ -1,37 +1,82 @@
+# lib/bddgenx/generator.rb
+# encoding: utf-8
+#
+# Este arquivo define a classe Generator, responsável por gerar arquivos
+# .feature a partir de um hash de história ou de um arquivo de história em texto.
+# Suporta Gherkin em Português e Inglês, inclusão de tags, cenários simples
+# e esquemas de cenário com exemplos.
+
 require 'fileutils'
-require_relative 'utils/tipo_param'
 
 module Bddgenx
+  # Gera cenários e arquivos .feature baseados em histórias e grupos de passos.
   class Generator
+    # Palavras-chave Gherkin em Português
+    # @return [Array<String>]
     GHERKIN_KEYS_PT = %w[Dado Quando Então E Mas].freeze
+
+    # Palavras-chave Gherkin em Inglês
+    # @return [Array<String>]
     GHERKIN_KEYS_EN = %w[Given When Then And But].freeze
+
+    # Mapeamento PT -> EN
+    # @return [Hash{String=>String}]
     GHERKIN_MAP_PT_EN = GHERKIN_KEYS_PT.zip(GHERKIN_KEYS_EN).to_h
+
+    # Mapeamento EN -> PT
+    # @return [Hash{String=>String}]
     GHERKIN_MAP_EN_PT = GHERKIN_KEYS_EN.zip(GHERKIN_KEYS_PT).to_h
+
+    # Conjunto de todas as palavras-chave suportadas (PT + EN)
+    # @return [Array<String>]
     ALL_KEYS = GHERKIN_KEYS_PT + GHERKIN_KEYS_EN
 
-    # Divide raw example blocks into a single table
+    # Seleciona apenas as linhas que representam exemplos do cenário
+    #
+    # @param raw [Array<String>] Lista de linhas brutas do bloco de exemplos
+    # @return [Array<String>] Linhas que começam com '|' representando a tabela de exemplos
     def self.dividir_examples(raw)
       raw.select { |l| l.strip.start_with?('|') }
     end
 
-    # Gera .feature a partir de hash ou arquivo de história
-    # Respeita idioma em historia[:idioma]
+    # Gera conteúdo de um arquivo .feature a partir de um hash de história ou caminho para arquivo
+    #
+    # @param input [Hash, String]
+    #   Objeto de história com chaves :idioma, :quero, :como, :para, :grupos
+    #   Ou caminho para um arquivo de história que será lido via Parser.ler_historia
+    # @param override_path [String, nil]
+    #   Caminho de saída alternativo para o arquivo .feature
+    # @raise [ArgumentError] Se Parser.ler_historia lançar erro ao ler arquivo
+    # @return [Array(String, String)] Array com caminho e conteúdo gerado
     def self.gerar_feature(input, override_path = nil)
       historia = input.is_a?(String) ? Parser.ler_historia(input) : input
-      idioma = historia[:idioma] || 'pt'
-      nome_base = historia[:quero].gsub(/[^a-z0-9]/i, '_')
-                                  .downcase.split('_',3)[0,3].join('_')
-      caminho = override_path.is_a?(String) ? override_path : "features/#{nome_base}.feature"
+      idioma   = historia[:idioma] || 'pt'
+
+      # Geração do nome base do arquivo
+      nome_base = historia[:quero]
+                    .gsub(/[^a-z0-9]/i, '_')
+                    .downcase
+                    .split('_', 3)
+                    .first(3)
+                    .join('_')
+
+      caminho = if override_path.is_a?(String)
+                  override_path
+                else
+                  "features/#{nome_base}.feature"
+                end
 
+      # Definição das palavras-chave Gherkin conforme idioma
       palavras = {
-        feature:   idioma=='en' ? 'Feature'           : 'Funcionalidade',
-        contexto:  idioma=='en' ? 'Background'        : 'Contexto',
-        cenario:   idioma=='en' ? 'Scenario'          : 'Cenário',
-        esquema:   idioma=='en' ? 'Scenario Outline'  : 'Esquema do Cenário',
-        exemplos:  idioma=='en' ? 'Examples'          : 'Exemplos',
-        regra:     idioma=='en' ? 'Rule'              : 'Regra'
+        feature:  idioma == 'en' ? 'Feature'          : 'Funcionalidade',
+        contexto: idioma == 'en' ? 'Background'       : 'Contexto',
+        cenario:  idioma == 'en' ? 'Scenario'         : 'Cenário',
+        esquema:  idioma == 'en' ? 'Scenario Outline' : 'Esquema do Cenário',
+        exemplos: idioma == 'en' ? 'Examples'         : 'Exemplos',
+        regra:    idioma == 'en' ? 'Rule'             : 'Regra'
       }
 
+      # Cabeçalho do arquivo .feature
       conteudo = <<~GHK
         # language: #{idioma}
         #{palavras[:feature]}: #{historia[:quero].sub(/^Quero\s*/i,'')}
@@ -41,56 +86,51 @@ module Bddgenx
 
       GHK
 
-      pt_map = GHERKIN_MAP_PT_EN
-      en_map = GHERKIN_MAP_EN_PT
-      detect = ALL_KEYS
+      pt_map  = GHERKIN_MAP_PT_EN
+      en_map  = GHERKIN_MAP_EN_PT
+      detect  = ALL_KEYS
 
-      historia[:grupos].each_with_index do |grupo, idx|
-        passos = grupo[:passos] || []
+      historia[:grupos].each do |grupo|
+        passos   = grupo[:passos]  || []
         exemplos = grupo[:exemplos] || []
         next if passos.empty?
 
-        tag_line = ["@#{grupo[:tipo].downcase}", ("@#{grupo[:tag]}" if grupo[:tag])].compact.join(' ')
+        # Linha de tags para o grupo
+        tag_line = ["@#{grupo[:tipo].downcase}",
+                    ("@#{grupo[:tag]}" if grupo[:tag])]
+                     .compact.join(' ')
 
         if exemplos.any?
-          # Scenario Outline
+          # Cenário com Esquema
           conteudo << "    #{tag_line}\n"
           conteudo << "    #{palavras[:esquema]}: #{historia[:quero]}\n"
 
-          # Renderiza cada passo, mapeando connector mesmo se não for Gherkin padrão
+          # Passos do cenário
           passos.each do |p|
-            line = p.strip
-            parts = line.split(' ', 2)
-            # match connector case-insensitive
+            parts = p.strip.split(' ', 2)
             con_in = detect.find { |k| k.casecmp(parts[0]) == 0 } || parts[0]
-            text = parts[1] || ''
-            out_conn = idioma=='en' ? pt_map[con_in] || con_in : en_map[con_in] || con_in
-            conteudo << "      #{out_conn} #{text}
-"
+            text   = parts[1] || ''
+            out_conn = idioma == 'en' ? pt_map[con_in] || con_in : en_map[con_in] || con_in
+            conteudo << "      #{out_conn} #{text}\n"
           end
 
-          # Monta tabela de exemplos completa
-          # Renderiza o bloco de Examples exatamente como veio no TXT
+          # Bloco de exemplos original
           conteudo << "\n      #{palavras[:exemplos]}:\n"
           exemplos.select { |l| l.strip.start_with?('|') }.each do |line|
-            # Remove aspas apenas das células, mantendo todas as colunas e valores originais
             cleaned = line.strip.gsub(/^"|"$/, '')
             conteudo << "        #{cleaned}\n"
           end
           conteudo << "\n"
         else
-          # Scenario simples
+          # Cenário simples
           conteudo << "    #{tag_line}\n"
           conteudo << "    #{palavras[:cenario]}: #{grupo[:tipo].capitalize}\n"
           passos.each do |p|
-            line = p.strip
-            parts = line.split(' ', 2)
-            # match connector case-insensitive
+            parts = p.strip.split(' ', 2)
             con_in = detect.find { |k| k.casecmp(parts[0]) == 0 } || parts[0]
-            text = parts[1] || ''
-            out_conn = idioma=='en' ? pt_map[con_in] || con_in : en_map[con_in] || con_in
-            conteudo << "      #{out_conn} #{text}
-"
+            text   = parts[1] || ''
+            out_conn = idioma == 'en' ? pt_map[con_in] || con_in : en_map[con_in] || con_in
+            conteudo << "      #{out_conn} #{text}\n"
           end
           conteudo << "\n"
         end
@@ -99,10 +139,15 @@ module Bddgenx
       [caminho, conteudo]
     end
 
+    # Salva o conteúdo gerado em arquivo .feature no disco
+    #
+    # @param caminho [String] Caminho completo para salvar o arquivo
+    # @param conteudo [String] Conteúdo do arquivo .feature
+    # @return [nil]
     def self.salvar_feature(caminho, conteudo)
       FileUtils.mkdir_p(File.dirname(caminho))
       File.write(caminho, conteudo)
       puts "✅ Arquivo .feature gerado: #{caminho}"
     end
   end
-end
+end