Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nitbravoa92/tdd-project

"TDD Project" is a program build in ruby that implements three methods of the Solver class using the Test-Driven Development (TDD) approach.
https://github.com/nitbravoa92/tdd-project

rspec-testing ruby tdd

Last synced: 1 day ago
JSON representation

"TDD Project" is a program build in ruby that implements three methods of the Solver class using the Test-Driven Development (TDD) approach.

Host: GitHub
URL: https://github.com/nitbravoa92/tdd-project
Owner: NitBravoA92
License: mit
Created: 2023-09-07T13:22:37.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-09-08T20:51:09.000Z (over 1 year ago)
Last Synced: 2025-01-13T14:54:11.871Z (9 days ago)
Topics: rspec-testing, ruby, tdd
Language: Ruby
Homepage:
Size: 8.79 KB
Stars: 7
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



  TDD Project | Ruby



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [TDD Project ](#tdd-project-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

---

# TDD Project 

**"TDD Project"** is a program build in ruby that implements three methods of the Solver class using the Test-Driven Development (TDD) approach.The three methods are:

- `factorial(number)`: This method returns the factorial of the given number.

- `reverse(word)`: This method returns the reverse of the given word.

- `fizzbuzz(number)`: This method returns "fizz" if the given number is divisible by 3, "buzz" if the given number is divisible by 5, and "fizzbuzz" if the given number is divisible by both 3 and 5. If the given number is not divisible by 3 or 5, the method returns the given number as a string.

The main goal of this project is learning more about the testing in ruby using RSpec and explore the benefits of using the TDD approach in software development.

---

## 🛠 Built With 

### Tech Stack 

  Ruby

  


    Ruby Official Website

  

  Rspec gem

  

    Official Website

  


---

### Key Features 



  Ruby

  Linters

    

      Rubocop

    

  

  Apply TDD to create unit tests



(back to top)


---

## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:



    A code editor (we recommend Visual Studio Code)





    Git and a GitHub account



### Setup

Clone this repository to your desired folder by using this 👇️ command :

```

git clone https://github.com/NitBravoA92/tdd-project.git

```

### Install

Go to the project directory:

```

 cd tdd-project

```

Before to run the program, verify that you have Ruby installed on your OS running the following command:

```

 ruby -v

```

It should show you the version of ruby installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby from scratch.

[Download and Install Ruby](https://www.ruby-lang.org/en/downloads/)

### Run tests

Run the following command inside the project folder:

```

 rspec spec

```

This should display:

```

 12 examples, 0 failures

```

This means that all 12 designed test cases have passed successfully.

(back to top)


---

## 👥 Authors 

👤 **Nitcelis Bravo**

- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)

- Twitter: [@softwareDevOne](https://twitter.com/softwareDevOne)

- LinkedIn: [Nitcelis Bravo Alcala](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)

(back to top)


---

## 🔭 Future Features 

Upcoming improvements:

- [x] Create unit tests following TDD methodology

(back to top)


---

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/NitBravoA92/tdd-project.git/issues).

(back to top)


---

## ⭐️ Show your support 

If you like this project and know someone who might find it helpful, please share it.

Or give it a **star** ⭐️ if you like this project!

(back to top)


---

## 🙏 Acknowledgments 

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)


---

## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)


---