bddgenx 2.0.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ee7808e2b0f0cf6e65b1dbc5ea11689a1522dbc06ec2db6ed35494329920913
-  data.tar.gz: f88f37264c7e26caa90f4b25aef60e194cd5b08d7a97819b4aa623a7e99d6b04
+  metadata.gz: 25401140b3582440879672b4bb6b39e4d8e57ae3ce34aaad5341c2a526ee7a5b
+  data.tar.gz: e18940f3b3408bf0559e9c356bedf519161849e6f75860ccf23910897fc79685
 SHA512:
-  metadata.gz: 1bdc7124701b3fd7eba6e60993e75e31fb19613a1ae53cb7549afeae1c0d4a7f167a3e5c19bf6805ee118ffd6a6c7a6b5d29b0d25e34e894dbfb86c0e45f2879
-  data.tar.gz: eec2871ad622cb5c638163854dbb7dabcb5da57e6bb784732c561c50cc1a4fabc81c3647b82c63509a6bd125e72801db2a69a88415d550af44ccf9f944ed7ac7
+  metadata.gz: 94c61a829d179d956e57e8ccce68c291be166ed0b54ca764ff4905f6381b649636b12b2473379b4d3426c6841cded41dfc952abb651ef8cf4d7bf52bc0546860
+  data.tar.gz: df64d578f90848f168e80da1e945bbe3bd9106810b5ae5c1f68a9678f30c5be19610e540c668d1223dbcd16f8398eb6696814db63e82755fca13a06e68edac30

data/README.md

@@ -3,58 +3,79 @@
 
 ## 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).
+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). Também suporta geração via IA (OpenAI / Gemini) e configuração por ambiente.
+
+---
+
+## Estrutura do Projeto
 
-## Estrutura do projeto
 ```
 bdd-generation/
-├── .github/                     # Workflows do GitHub Actions
+├── .github/                       # Workflows de CI/CD
 │   └── workflows/
-│       └── main.yml
-├── bin/
-│   └── console                  # Execução local (se necessário)
-├── features/                    # Gherkin gerados automaticamente
-│   └── steps/                   # Steps correspondentes
-├── input/                       # Histórias de entrada
+│       └── main.yml               # Workflow de build/test
+├── bin/                           # Scripts CLI e de configuração
+│   ├── bddgenx                    # Executável CLI para gerar BDD (static/chatgpt/gemini)
+│   └── setup.rb                   # Script para preparar o ambiente local (gera .env, input/)
+├── features/                      # Gherkin gerados automaticamente
+│   └── steps/                     # Steps correspondentes aos cenários
+├── input/                         # Arquivos de entrada (.txt com histórias)
 │   ├── historia.txt
 │   ├── historia_en.txt
 │   └── ...
 ├── lib/
-│   └── bddgenx/
-│       ├── ia/                  # Módulo de IA
-│       │   ├── chatgpt_cliente.rb
-│       │   └── gemini_cliente.rb
-│       ├── generators/          # Responsável por geração
-│       │   ├── generator.rb
-│       │   ├── steps_generator.rb
-│       │   └── runner.rb
-│       ├── reports/            # Exportadores, backups e rastreabilidade
-│       │   ├── pdf_exporter.rb
-│       │   ├── backup.rb
-│       │   └── tracer.rb
-│       ├── support/            # Utilitários auxiliares
-│       │   ├── gherkin_cleaner.rb
-│       │   ├── remover_steps_duplicados.rb
-│       │   ├── validator.rb
-│       │   └── font_loader.rb
-│       ├── parser.rb           # Parse do .txt
-│       ├── version.rb          # Versão da gem
-│       └── bddgenx.rb          # Arquivo principal (require central)
-├── reports/                     # Saídas: PDF, backup, rastreabilidade
-│   ├── pdf/
-│   ├── backup/
-│   └── rastreabilidade/
-├── .env                         # Variáveis de ambiente
-├── .gitignore
-├── bddgenx.gemspec
-├── bump_version.sh
+│   ├── bddgenx/
+│   │   ├── generators/            # Lógica de geração de features e execução geral
+│   │   │   ├── generator.rb
+│   │   │   ├── steps_generator.rb
+│   │   │   └── runner.rb
+│   │   │
+│   │   ├── ia/                    # Integração com APIs de IA
+│   │   │   ├── chatgpt_cliente.rb
+│   │   │   └── gemini_cliente.rb
+│   │   │
+│   │   ├── reports/               # Exportação de artefatos QA
+│   │   │   ├── backup.rb
+│   │   │   ├── pdf_exporter.rb
+│   │   │   └── tracer.rb
+│   │   │
+│   │   ├── support/               # Utilitários auxiliares e validadores
+│   │   │   ├── font_loader.rb
+│   │   │   ├── gherkin_cleaner.rb
+│   │   │   ├── remover_steps_duplicados.rb
+│   │   │   └── validator.rb
+│   │   │
+│   │   ├── configuration.rb       # Configuração global da gem (modo, ENV keys)
+│   │   └── version.rb             # Leitura da versão a partir do arquivo VERSION
+│   │
+│   ├── bddgenx.rb                 # Entrada principal da gem (require env)
+│   └── parser.rb                  # Parser de arquivos de entrada
+├── reports/                       # Artefatos gerados
+│   ├── pdf/                       # Features exportadas em PDF
+│   ├── backup/                    # Versões antigas de features
+│   └── rastreabilidade/           # Arquivos de rastreabilidade (se implementado)
+├── spec/                          # Testes unitários RSpec
+│   ├── support/
+│   ├── utils/
+│   ├── ia/
+│   ├── spec_helper.rb
+│   └── version_spec.rb
+├── .env                           # Arquivo com chaves reais (não versionado)
+├── .env.example                   # Modelo para configurar variáveis de ambiente
+├── .gitignore                     # Arquivos/pastas ignoradas pelo Git
+├── bddgenx.gemspec                # Especificação da gem
+├── bump_version.sh               # Script de versionamento automático (semântico)
 ├── Gemfile
 ├── Gemfile.lock
 ├── LICENSE
-├── Rakefile
-├── README.md
-└── VERSION
+├── Rakefile                       # Tarefas automatizadas (static, chatgpt, gemini)
+├── README.md                      # Documentação principal do projeto
+└── VERSION                        # Arquivo contendo a versão atual da gem
+
 ```
+
+---
+
 ## Instalação
 
 Adicione ao seu `Gemfile`:
@@ -63,44 +84,70 @@ Adicione ao seu `Gemfile`:
 gem 'bddgenx'
 ```
 
-Execute:
+Ou instale diretamente:
+
+```bash
+gem install bddgenx
+```
+
+---
+
+## 🔧 Configuração
+
+### 1. Instale dependências
 
 ```bash
 bundle install
 ```
 
-Ou instale diretamente:
+### 2. Configure seu `.env`
 
 ```bash
-gem install bddgenx
+cp .env.example .env
 ```
 
-## Uso no Código
+Edite o `.env`:
 
-```ruby
-require 'bddgenx'
+```env
+OPENAI_API_KEY=sk-...
+GEMINI_API_KEY=ya29-...
+BDDGENX_MODE=chatgpt   # static | chatgpt | gemini
+```
 
-# Gera todas as features e steps a partir dos .txt em input/
-Bddgenx::Runner.execute
+> 🔐 Dica: nunca versionar o `.env` — ele já está no `.gitignore`
+
+---
+
+## 🚀 Uso com Rake
+
+Com os arquivos `.txt` dentro da pasta `input/`, execute:
+
+```bash
+rake bddgenx:static     # geração sem IA
+rake bddgenx:chatgpt    # usando ChatGPT
+rake bddgenx:gemini     # usando Gemini
 ```
 
-## Tarefa Rake (opcional)
+> O modo pode ser sobrescrito via ENV ou `Bddgenx.configure`
 
-Em um projeto Rails ou Ruby com Rake, adicione ao `Rakefile`:
+---
+
+## 📦 Geração manual via Ruby
 
 ```ruby
 require 'bddgenx'
-require 'rake'
 
-namespace :bddgenx do
-  desc 'Gera .feature e steps a partir de histórias em input/'
-  task :gerar do
-    Bddgenx::Runner.execute
-  end
+Bddgenx.configure do |config|
+  config.mode = :chatgpt
+  config.openai_api_key_env = 'OPENAI_API_KEY'
 end
+
+Bddgenx::Runner.execute
 ```
 
-## Formato do Arquivo de Entrada (`.txt`)
+---
+
+## 📝 Formato do Arquivo de Entrada (`.txt`)
 
 ```txt
 # language: pt
@@ -113,19 +160,36 @@ Quando preencho <email> e <senha>
 Então vejo a tela inicial
 
 [EXAMPLES]
-| email            | senha   | resultado               |
-| user@site.com    | 123456  | login realizado         |
-| errado@site.com  | senha   | credenciais inválidas   |
+| email            | senha   |
+| user@site.com    | 123456  |
+| errado@site.com  | senha   |
 ```
 
-## Artefatos de QA
+---
 
-* **Backup**: versões antigas de `.feature` em `reports/backup` com timestamp
-* **PDF**: exporta features em P/B para `reports/pdf` via `PDFExporter`
+## 🧪 Setup Rápido para Novos Usuários
 
-## Integração CI/CD
+```bash
+ruby bin/setup.rb
+```
+
+Esse comando:
+
+- Cria `.env` a partir de `.env.example`
+- Garante que `input/` existe
+
+---
 
-Exemplo de GitHub Actions:
+## 🧾 Artefatos Gerados
+
+- ✅ `.feature` → dentro de `features/`
+- ✅ `steps.rb` → dentro de `features/steps/`
+- 🗂️ Backup automático → `reports/backup/`
+- 📄 PDF das features → `reports/pdf/`
+
+---
+
+## ⚙️ CI/CD Exemplo com GitHub Actions
 
 ```yaml
 jobs:
@@ -135,11 +199,15 @@ jobs:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.x'
+          ruby-version: '3.1'
       - run: bundle install
-      - run: bundle exec ruby -e "require 'bddgenx'; Bddgenx::Runner.execute(only_new: true)"
+      - run: bundle exec rake bddgenx:chatgpt
+        env:
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 ```
 
+---
+
 ## Licença
 
 MIT © 2025 David Nascimento

data/Rakefile

@@ -1,55 +1,49 @@
 # Rakefile
-# Tarefas para geração automática de BDD e relatórios com bddgenx
-
+require_relative 'lib/env'
 require 'rake'
-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
+  desc 'Inicializar projeto'
+  task :setup do
+    Bddgenx::Setup.inicializar_projeto
+  end
 
-    files.each do |file|
-      puts "🔄 Processando história: \#{file}"
-      historia = Bddgenx::Parser.ler_historia(file)
-      next unless Bddgenx::Validator.validar(historia)
+  desc 'Executa a geração BDD usando o modo atual (static, chatgpt, gemini)'
+  task :generate do
+    puts "⚙️  Modo de geração: #{Bddgenx.configuration.mode}"
 
-      feature_path, conteudo = Bddgenx::Generator.gerar_feature(historia)
+    # Evita que ARGV contenha o nome da task (como "bddgenx:static")
+    ARGV.clear
 
-      Bddgenx::Backup.salvar_versao_antiga(feature_path)
-      Bddgenx::Generator.salvar_feature(feature_path, conteudo)
+    Bddgenx::Runner.execute
+  end
 
-      Bddgenx::StepsGenerator.gerar_passos(feature_path)
-      Bddgenx::Tracer.adicionar_entrada(historia, feature_path)
+  desc 'Gera features no modo estático (sem IA)'
+  task :static do
+    Bddgenx.configure do |config|
+      config.mode = :static
     end
-
-    puts "✅ Geração concluída#{' (apenas novos)' if only_new}!"
+    ENV['BDDGENX_MODE'] = 'static'
+    Rake::Task['bddgenx:generate'].invoke
   end
 
-  desc 'Exportar todos os arquivos .feature para PDF'
-  task :pdf do
-    puts '📦 Exportando features para PDF...'
-    result = Bddgenx::PDFExporter.exportar_todos
-    puts "   Gerados: \#{result[:generated].size}, Pulados: \#{result[:skipped].size}"
+  desc 'Gera features usando ChatGPT'
+  task :chatgpt do
+    Bddgenx.configure do |config|
+      config.mode = :chatgpt
+      config.openai_api_key_env = 'OPENAI_API_KEY'
+    end
+    ENV['BDDGENX_MODE'] = 'chatgpt'
+    Rake::Task['bddgenx:generate'].invoke
   end
 
-  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}"
+  desc 'Gera features usando Gemini'
+  task :gemini do
+    Bddgenx.configure do |config|
+      config.mode = :gemini
+      config.gemini_api_key_env = 'GEMINI_API_KEY'
     end
+    ENV['BDDGENX_MODE'] = 'gemini'
+    Rake::Task['bddgenx:generate'].invoke
   end
 end
-
-task default: 'bddgenx:gerar'

data/VERSION

@@ -1 +1 @@
-2.0.5
+2.2.0

data/lib/bddgenx/configuration.rb

@@ -0,0 +1,35 @@
+# lib/bddgenx/configuration.rb
+module Bddgenx
+  class Configuration
+    # :static, :chatgpt ou :gemini
+    attr_accessor :mode
+
+    # Nomes das ENV vars para as chaves
+    attr_accessor :openai_api_key_env, :gemini_api_key_env
+
+    def initialize
+      @mode = :static
+      @openai_api_key_env = 'OPENAI_API_KEY'
+      @gemini_api_key_env = 'GEMINI_API_KEY'
+    end
+
+    # Retorna a chave real, carregada do ENV
+    def openai_api_key
+      ENV[@openai_api_key_env]
+    end
+
+    def gemini_api_key
+      ENV[@gemini_api_key_env]
+    end
+  end
+
+  # Singleton de configuração
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # DSL para configurar
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/bddgenx/ia/chatgtp_cliente.rb

@@ -21,7 +21,7 @@ module Bddgenx
       # @return [String] Cenários gerados em formato Gherkin com palavras-chave no idioma indicado.
       #
       def self.gerar_cenarios(historia, idioma = 'pt')
-        api_key = ENV['OPENAI_API_KEY']
+        api_key = Bddgenx.configuration.openai_api_key  # para ChatGPT
 
         unless api_key
           warn "❌ API Key do ChatGPT não encontrada no .env (OPENAI_API_KEY)"

data/lib/bddgenx/ia/gemini_cliente.rb

@@ -18,7 +18,7 @@ module Bddgenx
       # @return [String, nil] Cenários no formato Gherkin, ou nil em caso de erro.
       #
       def self.gerar_cenarios(historia, idioma = 'pt')
-        api_key = ENV['GEMINI_API_KEY']
+        api_key = Bddgenx.configuration.gemini_api_key  # para Gemini
 
         keywords_pt = {
           feature: "Funcionalidade",

data/lib/{version.rb → bddgenx/version.rb}

@@ -1,7 +1,7 @@
 module Bddgenx
   # Caminho absoluto para o arquivo VERSION, que fica 3 níveis acima deste arquivo:
   # lib/bddgenx/version.rb → lib/bddgenx → lib → raiz do projeto
-  VERSION_FILE = File.expand_path("../../VERSION", __FILE__)
+  VERSION_FILE = File.expand_path("../../../VERSION", __FILE__)
 
   # Lê o conteúdo do arquivo VERSION para definir a constante VERSION
   # Se o arquivo não existir, exibe um aviso e define o valor padrão "0.0.0"

data/lib/env.rb

@@ -15,6 +15,8 @@ require 'dotenv'         # Para carregar variáveis de ambiente de arquivos .env
 require 'unicode'        # Para manipulação avançada de strings Unicode (ex: remoção de acentos)
 require 'bigdecimal'     # Para operações matemáticas precisas com decimais
 
+Dotenv.load
+
 # Configura o caminho base do projeto e carrega as gems definidas no Gemfile (se existir)
 require 'bundler/setup' if File.exist?(File.expand_path('../../Gemfile', __FILE__))
 
@@ -35,12 +37,15 @@ require_relative  'bddgenx/generators/runner'                 # Classe responsá
 
 # Parser do arquivo de entrada e versão da gem
 require_relative  'parser'                                    # Parser para interpretar arquivos de entrada
-require_relative  'version'                                   # Informação da versão da gem
+require_relative 'bddgenx/version'                                   # Informação da versão da gem
 
 # Relatórios e exportação
 require_relative  'bddgenx/reports/pdf_exporter'              # Exporta relatórios em PDF usando Prawn
 require_relative  'bddgenx/reports/backup'                    # Mecanismo de backup dos arquivos gerados
 require_relative  'bddgenx/reports/tracer'                    # Rastreabilidade dos processos
 
+require_relative 'bddgenx/configuration'                      # Configuração das variaveis de IA
+require_relative '../bin/setup'                               # Verifica estrutura do projeto, caso nao exista cria a nova.
+
 # Define variável de ambiente global para indicar que o ambiente BDDGENX está em modo desenvolvimento
 ENV['BDDGENX_ENV'] = 'development'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bddgenx
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.2.0
 platform: ruby
 authors:
 - David Nascimento
@@ -126,6 +126,7 @@ files:
 - lib/bddgenx/assets/fonts/DejaVuSansMono-BoldOblique.ttf
 - lib/bddgenx/assets/fonts/DejaVuSansMono-Oblique.ttf
 - lib/bddgenx/assets/fonts/DejaVuSansMono.ttf
+- lib/bddgenx/configuration.rb
 - lib/bddgenx/generators/generator.rb
 - lib/bddgenx/generators/runner.rb
 - lib/bddgenx/generators/steps_generator.rb
@@ -138,9 +139,9 @@ files:
 - lib/bddgenx/support/gherkin_cleaner.rb
 - lib/bddgenx/support/remover_steps_duplicados.rb
 - lib/bddgenx/support/validator.rb
+- lib/bddgenx/version.rb
 - lib/env.rb
 - lib/parser.rb
-- lib/version.rb
 homepage: https://github.com/David-Nascimento/bdd-generation
 licenses:
 - MIT