Este é um projeto de aplicação de votação desenvolvido para o curso de Desenvolvimento Backend Ruby da Softex. A aplicação permite gerenciar a votação de candidatos, incluindo validação de CPF, registro de votos e exibição de resultados.
- Validação de CPF: Verifica se um CPF é válido e se já foi utilizado para votar.
- Registro de Votos: Permite ao usuário votar em um candidato e armazena o voto.
- Visualização de Resultados: Exibe um gráfico dos resultados da votação.
- Interface do Usuário: Utiliza várias views para interagir com o usuário, incluindo mensagens de confirmação e resultados.
candidate.rb: Define a classe Candidate, que representa um candidato com nome, cor e caractere associado.color.rb: Define a classe Color, que representa uma cor RGB e calcula a intensidade da cor para definir a cor de primeiro plano.cpf.rb: Define a classe CPF, que representa e valida um CPF.
bloom_filter_service.rb: Implementa o serviço de Bloom Filter para verificar se um CPF já votou.cpf_validation_service.rb: Valida um CPF usando o serviço de Bloom Filter.voting_storage_service.rb: Armazena os votos registrados e gerencia o armazenamento de votos.
component/banner.rb: Define a classe Banner, que exibe um banner no terminal.component/confirmation_dialog.rb: Define a classe ConfirmationDialog, que exibe uma caixa de diálogo de confirmação para o usuário.cpf_validation_view.rb: Define a classe CPFValidationView, que solicita e valida o CPF do usuário.exit_view.rb: Define a classe ExitView, que pergunta ao usuário se deseja votar novamente.result_view.rb: Define a classe ResultView, que exibe os resultados da votação.voting_storage_view.rb: Define a classe VotingStorageView, que confirma que o voto foi registrado com sucesso.voting_view.rb: Define a classe VotingView, que exibe os candidatos e confirma o voto do usuário.main.rb: O arquivo principal que configura e executa a aplicação de votação, inicializando os serviços e views necessários.
- Ruby 2.5 ou superior
Clone o repositório e navegue até o diretório do projeto:
git clone https://github.com/victorFlorentino12/Projeto_ruby_softex
cd Projeto_ruby_softexInstale as dependências
gem install murmurhash3
gem install cityhash
gem install ruby-xxhashPara executar a aplicação, execute o arquivo main.rb:
ruby main.rbO fluxo da aplicação será iniciado, incluindo a validação do CPF, escolha do candidato, registro do voto e exibição dos resultados finais.
Cada classe e método possui comentários de documentação que descrevem sua funcionalidade. Veja os arquivos .rb para detalhes sobre a implementação de cada componente.
classDiagram
%% Definição das classes
class Candidate {
+String name
+Color color
+String char
+name_with_background(size: Integer): String
+name_with_color(size: Integer): String
}
class Color {
+Integer r
+Integer g
+Integer b
+foreground_a: Array<Integer>
+to_a(): Array<Integer>
}
class CPF {
-String cpf
+to_s(): String
+to_a(): Array<String>
+valid?(): Boolean
}
class BloomFilterService {
-Array<HashFunction> k
-Array<Integer> bloom_filters
+push(data: String): void
+include?(data: String): Boolean
-apply_all_hashfunction(data: String): Array<Integer>
}
class CPFValidationService {
-BloomFilterService bloom_filter
+validate(cpf_raw: String): Symbol
}
class VotingStorageService {
-BloomFilterService bloom_filter
-Hash<String, Integer> votes
+record_vote(cpf: CPF, candidate_number: String): void
}
class VotingService {
+Hash<String, Candidate> CANDIDATES
+select_candidate(option: String): Candidate
-validate_candidate_option(option: String): String
}
class Banner {
+display(): void
}
class ConfirmationDialog {
-String prompt_message
-String invalid_option_message
+execute(): Boolean
+set_prompt_message(prompt_message: String): void
}
class ResultView {
-VotingStorageService voting_storage
-Integer size
+start(): void
-bar_size(key: String, total: Integer): Integer
}
class VotingView {
-ConfirmationDialog dialog
-Banner banner
-VotingService service
+start(): String
-display_candidate_list(): void
-display_candidate(number: String, candidate: Candidate): void
-confirm_vote(candidate: Candidate): Boolean
}
class VotingStorageView {
-VotingStorageService voting_storage
-Banner banner
+start(): void
}
class CPFValidationView {
-CPFValidationService validation_service
-Banner banner
-Hash<Symbol, Function> actions
+start(): CPF
-show_invalid_cpf_error(cpf: String): void
-show_already_voted_error(cpf: String): void
}
class ExitView {
-ConfirmationDialog dialog
-Banner banner
+start(): Boolean
}
class VotingApplication {
-BloomFilterService bloom_filter_service
-VotingStorageService voting_storage_service
-CPFValidationService cpf_validation_service
-CPFValidationView cpf_validation_view
-VotingStorageView voting_storage_view
-VotingView voting_view
-ExitView exit_view
-ResultView result_view
+run(): void
}
%% Relacionamentos entre classes
Candidate "1" -- "1" Color : has
CPFValidationService "1" -- "1" BloomFilterService : uses
VotingStorageService "1" -- "1" BloomFilterService : uses
VotingView "1" -- "1" ConfirmationDialog : uses
VotingView "1" -- "1" Banner : uses
VotingView "1" -- "1" VotingService : uses
ResultView "1" -- "1" VotingStorageService : uses
VotingStorageView "1" -- "1" VotingStorageService : uses
CPFValidationView "1" -- "1" CPFValidationService : uses
CPFValidationView "1" -- "1" Banner : uses
ExitView "1" -- "1" ConfirmationDialog : uses
ExitView "1" -- "1" Banner : uses
VotingApplication "1" -- "1" BloomFilterService : uses
VotingApplication "1" -- "1" VotingStorageService : uses
VotingApplication "1" -- "1" CPFValidationService : uses
VotingApplication "1" -- "1" CPFValidationView : uses
VotingApplication "1" -- "1" VotingStorageView : uses
VotingApplication "1" -- "1" VotingView : uses
VotingApplication "1" -- "1" ExitView : uses
VotingApplication "1" -- "1" ResultView : uses
Este projeto está licenciado sob a Licença MIT. Veja o arquivo LICENSE para mais detalhes.