https://github.com/tsheporamantso/enumerable
Enumerable is an app that takes a defined list of characters, strings, numbers or arrays and performs some enumerable functions on them. The methods are defined in a module and used within a class.
https://github.com/tsheporamantso/enumerable
ruby ruby-gem
Last synced: 7 months ago
JSON representation
Enumerable is an app that takes a defined list of characters, strings, numbers or arrays and performs some enumerable functions on them. The methods are defined in a module and used within a class.
- Host: GitHub
- URL: https://github.com/tsheporamantso/enumerable
- Owner: tsheporamantso
- License: mit
- Created: 2023-06-22T16:04:00.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-06-22T19:30:35.000Z (over 2 years ago)
- Last Synced: 2025-01-19T23:33:56.412Z (9 months ago)
- Topics: ruby, ruby-gem
- Language: Ruby
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Enumerable
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**Enumerable** is an app that takes a defined list of characters, strings, numbers or arrays and performs some enumerable functions on them. The methods are defined in a module and used within a class.
Server
- **All Enumerator**
- **Any Enumerator**
- **Filter Enumerator**
- Not live yet
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Install ruby using [link](https://www.ruby-lang.org/en/documentation/installation/#apt)
### Setup
Clone this repository to your desired folder:
```sh
mkdir folder_name
cd folder_name
git clone git@github.com:tsheporamantso/Enumerable.git
```
-
### Install
Install this project with:
```sh
bundle install
```
-
### Usage
To run the project, execute the following command, start the interactive ruby on the terminal:
```sh
irb -r name_of_file
```
-
### Run tests
To run tests do follow the code below on irb in the terminal:
```sh
# Create our list
list = MyList.new(1, 2, 3, 4)
# Test #all?
puts list.all? { |e| e < 5 } #=> true
puts list.all? { |e| e > 5 } #=> false
# Test #any?
puts list.any? { |e| e == 2 } #=> true
puts list.any? { |e| e == 5 } #=> false
# Test #filter
puts list.filter { |e| e.even? } #=> [2, 4]
```
### Deployment
Not deployed
👤 **Gladwin Tshepo Ramantso**
- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)
👤 **Benson Njuguna Kamau**
- GitHub: [@bennyjoez](https://github.com/bennyjoez)
- Twitter: [@bennyjoezz](https://twitter.com/bennyjoezz)
- LinkedIn: [Benson Njuguna Kamau](https://www.linkedin.com/in/bennyjoez/)
- [ ] **Webpage**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/tsheporamantso/Enumerable/issues).
If you like this project please give a star on [github](https://github.com/tsheporamantso/Enumerable) & follow us on [twitter](https://twitter.com/ramgt001) and also connect on [Linkedin](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/).
I would like to thank:
- [ ] **Microverse and all the staff**
- [ ] **Microverse Communinity**
- [ ] **Thanks to my coding Partners**
- [ ] **Thanks to my Morning-Session-Group and Standup-Team Partners and**
- [ ] **Thanks to Code Reviewers**
This project is [MIT](https://github.com/tsheporamantso/Enumerable/blob/34aad113098b28b8a22b1b4d70cd6403c4df55d1/LICENSE) licensed.