bddgenx 2.4.6 → 2.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9a93bafcbda4d21a1cc0b340565b6dbf269fe635fddbb69ead9c9154ebfef95
-  data.tar.gz: 48421b76147e864c97b4a6e024173ca1f587c23778166ae29f69ac3290aac194
+  metadata.gz: adf58e7c99b89027c56542f9b2dbff2cc71c336ca164eb6a2bc65308546beef3
+  data.tar.gz: 2093d4ac9a62eea83e87eb7faff89a43196f0a4585f885e515c967e52e0688b8
 SHA512:
-  metadata.gz: 98853eae51856f72cc90a007f5949c94e3b9151aaf7e18c0b6163f2f6397685159ef8fbf8c6fe6c37ded30b275cbfc4c5499ef18e0cb06fc5a61d9d9aac32a9c
-  data.tar.gz: 1979c869cbb720f13d498f658986a9eecf3b79e85ac82bd45d0ee52415f70b533925e9a0a601af139ce5855b10f90322d7b9aaadef1f19649593ca906a897a2e
+  metadata.gz: 10e4ffafcb2230a6a88cd3556ab995dfe936c36925c86027fee92d0e8f74f7e7b75c4bf6ea0415ec5a083dd5c63f9043750b350dcfa04176b3740c1123e67fa8
+  data.tar.gz: 3791efeb6c7a684e666bd73cfa03d21d2f8cc0825e6791655aa639f51901395c0595170661ff06b331e801ee2a158ec5193182ce4e6030712133c0c10c0b1176

data/VERSION

@@ -1 +1 @@
-2.4.6
+2.4.9

data/lib/bddgenx/configuration.rb

@@ -1,34 +1,92 @@
-# lib/bddgenx/configuration.rb
+# encoding: utf-8
+#
+# Este arquivo define a classe de configuração global da gem BDDGenX.
+#
+# A classe `Bddgenx::Configuration` permite configurar o modo de operação da ferramenta
+# (ex: estático ou com IA) e define as variáveis de ambiente que armazenam as chaves de API
+# para serviços externos como OpenAI (ChatGPT), Google Gemini e Microsoft Copilot.
+
 module Bddgenx
+  # Classe de configuração principal da gem BDDGenX.
+  # Permite definir o modo de geração BDD e os nomes das variáveis de ambiente
+  # que armazenam as chaves de API para integração com serviços de IA.
   class Configuration
-    # :static, :chatgpt ou :gemini
+    # Modo de execução da gem.
+    # Pode ser:
+    # - :static   → geração local
+    # - :chatgpt  → uso da IA do ChatGPT (OpenAI)
+    # - :gemini   → uso da IA Gemini (Google)
+    # - :copilot  → uso do Microsoft Copilot
+    #
+    # @return [Symbol]
     attr_accessor :mode
 
-    # Nomes das ENV vars para as chaves
-    attr_accessor :openai_api_key_env, :gemini_api_key_env
+    # Nome da variável de ambiente que contém a chave da API da OpenAI
+    # @return [String]
+    attr_accessor :openai_api_key_env
+
+    # Nome da variável de ambiente que contém a chave da API do Google Gemini
+    # @return [String]
+    attr_accessor :gemini_api_key_env
+
+    # Nome da variável de ambiente que contém a chave da API do Microsoft Copilot
+    # @return [String]
+    attr_accessor :microsoft_copilot_api_env
 
+    ##
+    # Inicializa a configuração com valores padrão:
+    # - modo: :static
+    # - ENV keys: 'OPENAI_API_KEY', 'GEMINI_API_KEY', 'MICROSOFT_COPILOT_API_KEY'
     def initialize
       @mode = :static
       @openai_api_key_env = 'OPENAI_API_KEY'
       @gemini_api_key_env = 'GEMINI_API_KEY'
+      @microsoft_copilot_api_env = 'MICROSOFT_COPILOT_API_KEY'
     end
 
-    # Retorna a chave real, carregada do ENV
+    ##
+    # Retorna a chave da API do OpenAI, lida diretamente da ENV.
+    #
+    # @return [String, nil] Chave de API ou nil se não definida
     def openai_api_key
       ENV[@openai_api_key_env]
     end
 
+    ##
+    # Retorna a chave da API do Gemini, lida diretamente da ENV.
+    #
+    # @return [String, nil] Chave de API ou nil se não definida
     def gemini_api_key
       ENV[@gemini_api_key_env]
     end
+
+    ##
+    # Retorna a chave da API do Microsoft Copilot, lida diretamente da ENV.
+    #
+    # @return [String, nil] Chave de API ou nil se não definida
+    def microsoft_copilot_api_key
+      ENV[@microsoft_copilot_api_env]
+    end
   end
 
-  # Singleton de configuração
+  ##
+  # Retorna uma instância singleton da configuração da gem.
+  #
+  # @return [Configuration]
   def self.configuration
     @configuration ||= Configuration.new
   end
 
-  # DSL para configurar
+  ##
+  # Permite configurar a gem usando um bloco DSL.
+  #
+  # Exemplo:
+  #   Bddgenx.configure do |config|
+  #     config.mode = :gemini
+  #     config.gemini_api_key_env = 'MY_GEMINI_KEY'
+  #   end
+  #
+  # @yieldparam config [Configuration] instância de configuração atual
   def self.configure
     yield(configuration)
   end

data/lib/bddgenx/generators/generator.rb

@@ -8,36 +8,6 @@
 
 module Bddgenx
   class Generator
-    # Palavras-chave do Gherkin em Português
-    GHERKIN_KEYS_PT = %w[Dado Quando Então E Mas].freeze
-
-    # Palavras-chave do Gherkin em Inglês
-    GHERKIN_KEYS_EN = %w[Given When Then And But].freeze
-
-    # Mapeamento PT → EN
-    GHERKIN_MAP_PT_EN = GHERKIN_KEYS_PT.zip(GHERKIN_KEYS_EN).to_h
-
-    # Mapeamento EN → PT
-    GHERKIN_MAP_EN_PT = GHERKIN_KEYS_EN.zip(GHERKIN_KEYS_PT).to_h
-
-    # Todas as palavras-chave reconhecidas pelos parsers
-    ALL_KEYS = GHERKIN_KEYS_PT + GHERKIN_KEYS_EN
-
-    ##
-    # Função para extrair o idioma do arquivo .txt
-    # @param txt_file [String] Caminho do arquivo .txt
-    # @return [String] O idioma extraído ou 'pt' como padrão
-    def self.obter_idioma_do_arquivo(txt_file)
-      idioma = nil
-      File.foreach(txt_file) do |line|
-        if line.strip.start_with?('# language:')
-          idioma = line.strip.split(':').last.strip.downcase
-          break
-        end
-      end
-      idioma || 'pt'  # Retorna 'pt' como padrão caso o idioma não seja encontrado
-    end
-
     ##
     # Gera o conteúdo de um arquivo `.feature` baseado na história fornecida.
     # Pode operar em três modos:
@@ -48,9 +18,11 @@ module Bddgenx
     # @param input [String, Hash] Caminho para um `.txt` ou estrutura de história já processada
     # @param override_path [String, nil] Caminho alternativo de saída
     # @return [Array<String, String>] Caminho e conteúdo do `.feature`
+
     def self.gerar_feature(input, override_path = nil)
       modo = ENV['BDD_MODE']&.to_sym || :static
 
+      # Verifique o idioma antes de continuar
       if input.is_a?(String) && input.end_with?('.txt') && [:gemini, :chatgpt].include?(modo)
         # Geração com IA
         raw_txt = File.read(input)
@@ -62,38 +34,38 @@ module Bddgenx
           grupos: []
         }
 
+        # Detecta idioma do arquivo
+        idioma = Utils::detecta_idioma_de_texto(raw_txt)
+        historia[:idioma] = idioma
+
         texto_gerado = if modo == :gemini
                          GeminiCliente.gerar_cenarios(raw_txt)
                        else
-                         ChatGPTCliente.gerar_cenarios(raw_txt)
+                         ChatGptCliente.gerar_cenarios(raw_txt)
                        end
 
         historia[:grupos] << {
           tipo: 'gerado',
           tag: 'ia',
-          passos: GherkinCleaner.limpar(texto_gerado).lines.map(&:strip).reject(&:empty?)
+          passos: Utils.limpar(texto_gerado).lines.map(&:strip).reject(&:empty?)
         }
       else
         # Geração estática
         historia = input.is_a?(String) ? Parser.ler_historia(input) : input
       end
 
-      # Atribui o idioma corretamente antes da geração do conteúdo
-      idioma = historia[:idioma] || obter_idioma_do_arquivo(input) # Uso da função para pegar o idioma do arquivo
+      # Verifique o idioma que está sendo usado
+      idioma = historia[:idioma] || Utils::obter_idioma_do_arquivo(input)
+
+      # Verifique se o idioma está correto
+      puts "Idioma detectado: #{idioma}"
+
       cont = 1
 
       # Cria nome-base do arquivo .feature
-      nome_base = historia[:quero]
-                    .gsub(/[^a-z0-9]/i, '_')
-                    .downcase
-                    .split('_')
-                    .reject(&:empty?)
-                    .first(5)
-                    .join('_')
-
+      nome_base = historia[:quero].gsub(/[^a-z0-9]/i, '_').downcase.split('_').reject(&:empty?).first(5).join('_')
       caminho = override_path || "features/#{nome_base}.feature"
 
-      # Palavras-chave localizadas
       palavras = {
         feature:  idioma == 'en' ? 'Feature'          : 'Funcionalidade',
         contexto: idioma == 'en' ? 'Background'       : 'Contexto',
@@ -103,7 +75,6 @@ module Bddgenx
         regra:    idioma == 'en' ? 'Rule'             : 'Regra'
       }
 
-      # Cabeçalho do arquivo .feature
       conteudo = <<~GHK
         # language: #{idioma}
         #{palavras[:feature]}: #{historia[:quero].sub(/^Quero\s*/i,'')}
@@ -114,9 +85,9 @@ module Bddgenx
 
       # Controle para não repetir passos
       passos_unicos = Set.new
-      pt_map = GHERKIN_MAP_PT_EN
-      en_map = GHERKIN_MAP_EN_PT
-      detect = ALL_KEYS
+      pt_map = Utils::GHERKIN_MAP_PT_EN
+      en_map = Utils::GHERKIN_MAP_EN_PT
+      detect = Utils::ALL_KEYS
 
       historia[:grupos].each do |grupo|
         passos   = grupo[:passos]   || []

data/lib/bddgenx/generators/runner.rb

@@ -1,36 +1,49 @@
 # lib/bddgenx/cli.rb
 # encoding: utf-8
 #
-# Este arquivo define a classe Runner (CLI) da gem bddgenx,
-# responsável por orquestrar todo o fluxo de geração BDD:
-# leitura e validação de histórias, geração de features, steps,
-# exportação de PDFs e controle de modo (static / IA).
+# Este arquivo define a classe Runner (CLI) da gem BDDGenX.
+#
+# A Runner é responsável por orquestrar todo o fluxo de geração BDD:
+# - Leitura e validação de histórias (arquivos `.txt`)
+# - Geração de arquivos `.feature` e steps
+# - Integração com IA (ChatGPT, Gemini, Copilot)
+# - Exportação para PDF
+# - Rastreabilidade via CSV
+#
+# Esta classe é o ponto de entrada da gem em execução via terminal (CLI).
+# O comportamento é configurado com variáveis de ambiente como:
+# - BDDGENX_MODE (static, chatgpt, gemini, copilot)
+# - BDDGENX_LANG (pt, en)
 
 require_relative '../../bddgenx'
 
 module Bddgenx
-  # Classe principal de execução da gem.
-  # Atua como ponto de entrada (CLI) para processar arquivos de entrada
-  # e gerar todos os artefatos BDD relacionados.
+  # Classe principal de execução da gem BDDGenX.
+  # Controla o fluxo de leitura de histórias, geração de artefatos BDD
+  # e exportação de relatórios. Suporta execução via terminal.
   class Runner
 
     ##
-    # Retorna a lista de arquivos de entrada.
-    # Se houver argumentos em ARGV, utiliza-os como nomes de arquivos `.txt`.
-    # Caso contrário, chama prompt interativo.
+    # Retorna a lista de arquivos `.txt` a processar.
+    #
+    # - Se ARGV contiver argumentos, usa esses nomes como arquivos `.txt`
+    # - Caso contrário, entra em modo interativo para seleção manual
     #
-    # @param input_dir [String] Caminho do diretório de entrada
-    # @return [Array<String>] Lista de arquivos `.txt` a processar
+    # @param input_dir [String] Caminho do diretório com arquivos `.txt`
+    # @return [Array<String>] Lista de caminhos de arquivos `.txt`
     def self.choose_files(input_dir)
       ARGV.any? ? selecionar_arquivos_txt(input_dir) : choose_input(input_dir)
     end
 
     ##
-    # Processa argumentos ARGV e converte em caminhos válidos de arquivos `.txt`.
-    # Adiciona extensão `.txt` se ausente e remove arquivos inexistentes.
+    # Processa os argumentos da linha de comando (ARGV) e gera caminhos
+    # completos para arquivos `.txt` no diretório informado.
     #
-    # @param input_dir [String] Diretório onde estão os arquivos
-    # @return [Array<String>] Caminhos válidos para arquivos de entrada
+    # - Se a extensão `.txt` estiver ausente, ela é adicionada.
+    # - Arquivos inexistentes são ignorados com aviso.
+    #
+    # @param input_dir [String] Diretório base onde estão os arquivos `.txt`
+    # @return [Array<String>] Lista de arquivos válidos encontrados
     def self.selecionar_arquivos_txt(input_dir)
       ARGV.map do |arg|
         nome = arg.end_with?('.txt') ? arg : "#{arg}.txt"
@@ -44,15 +57,18 @@ module Bddgenx
     end
 
     ##
-    # Interface interativa para o usuário selecionar arquivos `.txt` a processar.
-    # Exibe uma lista dos arquivos disponíveis e solicita um número ao usuário.
+    # Modo interativo para o usuário escolher o arquivo `.txt` a ser processado.
+    #
+    # Exibe uma lista numerada com os arquivos disponíveis no diretório.
+    # O usuário pode selecionar um específico ou pressionar ENTER para todos.
     #
-    # @param input_dir [String] Diretório de entrada
-    # @return [Array<String>] Lista com o arquivo escolhido ou todos
+    # @param input_dir [String] Caminho do diretório com arquivos `.txt`
+    # @return [Array<String>] Arquivo selecionado ou todos disponíveis
     def self.choose_input(input_dir)
       files = Dir.glob(File.join(input_dir, '*.txt'))
       if files.empty?
-        warn "❌ Não há arquivos .txt no diretório #{input_dir}"; exit 1
+        warn "❌ Não há arquivos .txt no diretório #{input_dir}"
+        exit 1
       end
 
       puts "Selecione o arquivo de história para processar:"
@@ -63,20 +79,24 @@ module Bddgenx
       return files if choice.empty?
       idx = choice.to_i - 1
       unless idx.between?(0, files.size - 1)
-        warn "❌ Escolha inválida."; exit 1
+        warn "❌ Escolha inválida."
+        exit 1
       end
       [files[idx]]
     end
 
     ##
-    # Executa o fluxo completo de geração BDD:
-    # - Define o modo (static / IA)
-    # - Coleta arquivos de entrada
-    # - Valida as histórias
-    # - Gera arquivos `.feature` e `steps`
-    # - Exporta PDFs e faz backup de versões antigas
+    # Executa o fluxo principal de geração dos artefatos BDD.
+    #
+    # Etapas executadas:
+    # - Detecta o modo de execução via ENV['BDDGENX_MODE'] (static/chatgpt/gemini/copilot)
+    # - Carrega e valida histórias de usuário
+    # - Gera arquivos `.feature` e seus respectivos steps
+    # - Executa geração via IA (quando aplicável)
+    # - Exporta arquivos em PDF
+    # - Gera rastreabilidade via CSV
     #
-    # O modo de execução é lido da variável de ambiente `BDDGENX_MODE`.
+    # Exibe no final um resumo das operações executadas.
     #
     # @return [void]
     def self.execute
@@ -90,7 +110,7 @@ module Bddgenx
         exit 1
       end
 
-      # Contadores de geração
+      # Contadores
       total = features = steps = ignored = 0
       skipped_steps = []
       generated_pdfs = []
@@ -101,29 +121,30 @@ module Bddgenx
         puts "\n🔍 #{I18n.t('messages.processing')}: #{arquivo}"
 
         historia = Parser.ler_historia(arquivo)
+        idioma = Utils.obter_idioma_do_arquivo(arquivo) || historia[:idioma]
+        historia[:idioma] = idioma
+
         unless Validator.validar(historia)
           ignored += 1
           puts "❌ #{I18n.t('messages.invalid_story')}: #{arquivo}"
           next
         end
 
-        # Geração via IA (ChatGPT, Gemini, Deepseek)
-        if %w[gemini chatgpt].include?(modo)
+        # IA: geração de cenários com Gemini, ChatGPT ou Copilot
+        if %w[gemini chatgpt copilot].include?(modo)
           puts I18n.t('messages.start_ia', modo: modo.capitalize)
-          idioma = IA::GeminiCliente.detecta_idioma_arquivo(arquivo)
 
           feature_text = Support::Loader.run(I18n.t('messages.ia_waiting'), :default) do
             case modo
-            when 'gemini'
-              IA::GeminiCliente.gerar_cenarios(historia, idioma)
-            when 'chatgpt'
-              IA::ChatGptCliente.gerar_cenarios(historia, idioma)
+            when 'gemini' then IA::GeminiCliente.gerar_cenarios(historia, idioma)
+            when 'chatgpt' then IA::ChatGptCliente.gerar_cenarios(historia, idioma)
+            when 'copilot' then IA::MicrosoftCopilotCliente.gerar_cenarios(historia, idioma)
             end
           end
 
           if feature_text
             feature_path = Generator.path_para_feature(arquivo)
-            feature_content = Bddgenx::GherkinCleaner.limpar(feature_text)
+            feature_content = Utils.limpar(feature_text)
           else
             ignored += 1
             puts I18n.t('messages.feature_fail', arquivo: arquivo)
@@ -137,7 +158,9 @@ module Bddgenx
           end
         end
 
+        # Salva versão antiga se existir
         Backup.salvar_versao_antiga(feature_path)
+
         features += 1 if Generator.salvar_feature(feature_path, feature_content)
 
         if StepsGenerator.gerar_passos(feature_path)
@@ -148,6 +171,8 @@ module Bddgenx
 
         FileUtils.mkdir_p('reports')
         result = PDFExporter.exportar_todos(only_new: true)
+        Tracer.adicionar_entrada(historia, feature_path)
+
         generated_pdfs.concat(result[:generated])
         skipped_pdfs.concat(result[:skipped])
       end

data/lib/bddgenx/generators/steps_generator.rb

@@ -8,15 +8,6 @@
 
 module Bddgenx
   class StepsGenerator
-    # Palavras-chave Gherkin em Português
-    GHERKIN_KEYS_PT = %w[Dado Quando Então E Mas].freeze
-
-    # Palavras-chave Gherkin em Inglês
-    GHERKIN_KEYS_EN = %w[Given When Then And But].freeze
-
-    # Conjunto de todas as palavras-chave reconhecidas
-    ALL_KEYS = GHERKIN_KEYS_PT + GHERKIN_KEYS_EN
-
     ##
     # Transforma uma string em camelCase (sem alterar acentuação).
     #
@@ -38,23 +29,20 @@ module Bddgenx
       raise ArgumentError, I18n.t('errors.invalid_path', path: feature_path.class) unless feature_path.is_a?(String)
 
       linhas = File.readlines(feature_path)
+      lang = Utils::detecta_idioma_de_texto(linhas.join)
+
+      I18n.locale = lang.to_sym rescue :pt
 
-      # Detecta o idioma a partir da linha `# language:`
-      lang = if (m = linhas.find { |l| l =~ /^#\s*language:\s*(\w+)/i })
-               m[/^#\s*language:\s*(\w+)/i, 1].downcase
-             else
-               'pt'
-             end
 
       # Define o locale do I18n conforme idioma detectado
       I18n.locale = lang.to_sym rescue :pt
 
-      pt_para_en = GHERKIN_KEYS_PT.zip(GHERKIN_KEYS_EN).to_h
-      en_para_pt = GHERKIN_KEYS_EN.zip(GHERKIN_KEYS_PT).to_h
+      pt_para_en = Utils::GHERKIN_KEYS_PT.zip(Utils::GHERKIN_KEYS_EN).to_h
+      en_para_pt = Utils::GHERKIN_KEYS_EN.zip(Utils::GHERKIN_KEYS_PT).to_h
 
       # Seleciona apenas as linhas que representam passos
       linhas_passos = linhas.map(&:strip).select do |linha|
-        ALL_KEYS.any? { |chave| linha.start_with?(chave + ' ') }
+        Utils::ALL_KEYS.any? { |chave| linha.start_with?(chave + ' ') }
       end
 
       return false if linhas_passos.empty?

data/lib/bddgenx/ia/chatgtp_cliente.rb

@@ -28,7 +28,7 @@ module Bddgenx
           return fallback_com_gemini(historia, idioma)
         end
 
-        # Palavras-chave Gherkin para português e inglês
+
         keywords_pt = {
           feature: "Funcionalidade",
           scenario: "Cenário",
@@ -104,8 +104,8 @@ module Bddgenx
           texto_ia = json.dig("choices", 0, "message", "content")
 
           if texto_ia
-            texto_limpo = Bddgenx::GherkinCleaner.limpar(texto_ia)
-            Utils::StepCleaner.remover_steps_duplicados(texto_ia, idioma)
+            texto_limpo = Utils.limpar(texto_ia)
+            Utils::remover_steps_duplicados(texto_ia, idioma)
 
             # Ajusta a linha de idioma no arquivo gerado
             texto_limpo.sub!(/^# language: .*/, "# language: #{idioma}")
@@ -137,24 +137,6 @@ module Bddgenx
         warn I18n.t('messages.fallback_gemini')
         GeminiCliente.gerar_cenarios(historia, idioma)
       end
-
-      ##
-      # Detecta o idioma de um arquivo de feature pela linha "# language:".
-      #
-      # @param caminho_arquivo [String] Caminho para o arquivo de feature.
-      # @return [String] Código do idioma detectado ('pt' por padrão).
-      #
-      def self.detecta_idioma_arquivo(caminho_arquivo)
-        return 'pt' unless File.exist?(caminho_arquivo)
-
-        File.foreach(caminho_arquivo) do |linha|
-          if linha =~ /^#\s*language:\s*(\w{2})/i
-            return $1.downcase
-          end
-        end
-
-        'pt'
-      end
     end
   end
 end

data/lib/bddgenx/ia/gemini_cliente.rb

@@ -106,15 +106,15 @@ module Bddgenx
           texto_ia = json["candidates"].first.dig("content", "parts", 0, "text")
           if texto_ia
             # Limpeza e sanitização do texto para manter padrão Gherkin
-            texto_limpo = Bddgenx::GherkinCleaner.limpar(texto_ia)
-            Utils::StepCleaner.remover_steps_duplicados(texto_ia, idioma)
+            texto_limpo = Utils.limpar(texto_ia)
+            Utils.remover_steps_duplicados(texto_ia, idioma)
 
             # Ajuste da diretiva de idioma na saída gerada
             texto_limpo.sub!(/^# language: .*/, "# language: #{idioma}")
             texto_limpo.prepend("# language: #{idioma}\n") unless texto_limpo.start_with?("# language:")
 
             # Garante diretiva de idioma
-            feature_text = Bddgenx::GherkinCleaner.limpar(texto_ia)
+            feature_text = Utils.limpar(texto_ia)
             feature_text.sub!(/^# language: .*/, "") # remove qualquer # language: existente
             feature_text.prepend("# language: #{idioma}\n") # insere a correta
 
@@ -129,24 +129,6 @@ module Bddgenx
           return nil
         end
       end
-
-      ##
-      # Detecta o idioma do arquivo de feature pela linha "# language:".
-      #
-      # @param caminho_arquivo [String] Caminho do arquivo para detecção do idioma.
-      # @return [String] Código do idioma detectado (ex: 'pt'), padrão 'pt'.
-      #
-      def self.detecta_idioma_arquivo(caminho_arquivo)
-        return 'pt' unless File.exist?(caminho_arquivo)
-
-        File.foreach(caminho_arquivo) do |linha|
-          if linha =~ /^#\s*language:\s*(\w{2})/i
-            return $1.downcase
-          end
-        end
-
-        'pt' # idioma padrão caso não encontre
-      end
     end
   end
 end