TDD Project | Ruby

📗 Table of Contents

• 📗 Table of Contents
• TDD Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 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

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
• Twitter: @softwareDevOne
• LinkedIn: Nitcelis Bravo Alcala

(back to top)

---

🔭 Future Features

Upcoming improvements:

• Create unit tests following TDD methodology

(back to top)

---

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(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 licensed.

(back to top)

---