Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fherrerao/acme_exercise

Exercise Acme is a console application that, given a .txt file with the employees and their respective hours, should return the names of the employees and the number of times they have been in the office.
https://github.com/fherrerao/acme_exercise

kanban ruby

Last synced: 4 days ago
JSON representation

Exercise Acme is a console application that, given a .txt file with the employees and their respective hours, should return the names of the employees and the number of times they have been in the office.

Awesome Lists containing this project

README 

        

![](https://img.shields.io/static/v1?label=BY&message=fherrerao&color=purple)



# Acme app

![Rails](https://img.shields.io/badge/ruby-%23CC0000.svg?style=for-the-badge&logo=ruby&logoColor=white)



[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./MIT.md)

![ruby version](https://img.shields.io/badge/Ruby-3.1.2-orange)



## Preview

![Screenshot from 2022-10-03 16-04-40](https://user-images.githubusercontent.com/91301423/193682688-25a72de1-271c-44da-ab41-3a9795d6a3a9.png)






## Table of Contents



- [Description](#description)

- [Built With](#built-with)

- [Getting Started](#getting-started)

  - [Clone Repo](#clone-repo)

  - [Prerequisites](#prerequisites)  

- [Setup](#setup)

  - [System Dependencies](#system-dependencies)  

- [Usage](#usage)

  - [Run script](#run-script)

  - [Testing RSpec](#testing-rspec)

- [How To Contribute?](#how-to-contribute)

- [Collaborators](#collaborators)

- [Show Your Support](#how-your-support)

- [Acknowledgments](#acknowledgments)

- [License](#license)




## Description

> Exercise Acme is a console application that, given a .txt file with the employees and their respective hours, should return the names of the employees and the number of times they have been in the office.




## Solution

> It was built with the `Ruby` language, using the `Singleton` design pattern, a single instance of the Employee class was created. The first step was to create a [Kanban](https://github.com/users/fherrerao/projects/2) board with all tasks needed to complete the project. The solution used was to separate the data of each line to obtain the day, the start time, and the end time of each employee and create an array of objects to iterate it and manage the data obtaining the hours that two employees coincided in the office. 




## Built With



- Major languages: Ruby.

- Tools & Methods: RSpec, Rubocop.




## Getting Started



We'll need to prepare your computer to handle Ruby an approach you can find in the official [site](https://www.ruby-lang.org/en/documentation/installation/) of Ruby.






## Clone Repo



First clone this repo by running this command in your terminal:

~~~ bash

git clone https://github.com/fherrerao/acme_exercise.git

# wait a couple seconds for it to download

# ...

# ...

# then move into the new directory

cd acme_exercise

~~~






## Prerequisites



The following technologies must be installed before hand in your local machine:



 - Ruby (ruby --version). Should be 3.1.2 or newer. 



The commands in parenthesis `()` can be used to verify if they are installed and their corresponding versions.



Refer to this [site](https://www.ruby-lang.org/en/documentation/installation/) for more detailed instructions on how to install this technology.






## Setup



We're getting there... trust me ;)



## System Dependencies



Execute this command to automatically install all the dependencies needed to view and work on this project:



~~~ bash

bundle install

~~~



The full list of dependencies can be found within the [Gemfile](Gemfile).



This also installs PostgreSQL, which you'll need for the next step.




## Usage

If you got to this point, congratulations! You now have spent 2 hours in order to toy with my app. I appreciate your effort :P



## Run Script

Please open a new terminal.



The following command should start the app



~~~ bash

ruby main.rb

~~~



`Note:` Be sure to be in the acme_exercise directory

~~~ bash

cd acme_exercise

~~~




## Testing RSpec

If you haven't installed the dependencies yet, please run the following command:



~~~ bash

bundle install

~~~



RSpec tests belong in another folder, which is [/spec](/spec/), all thanks to the ruby **magic** called `naming conventions`.

Anyway, to run tests located in the spec folder run:

~~~ bash

bundle exec rspec spec

~~~




## How To Contribute?



Always remember to commit your contributions on a different branch. You can create a new one by running `git checkout -b `.



Visit [linters folder](.github/workflows/linters.yml) to learn how to setup linters.



Then check linters locally before pushing by running:

~~~ bash

# ...

# ...

rubocop --color -A

~~~



Finally, once your changes have no linter errors and all tests are passing, try to merge your branch into  `development` by running:

~~~ bash

git checkout development

git merge 

~~~

Continue by solving any merge conflicts that may arise, test the functionality of the app once more, and you're changes are ready to be pushed with `git push origin `




# That's all folks!



## Collaborators






👤 **Fernando Herrera**



Platform | Badge |

 --- | --- |

 **GitHub**  | [@fherrerao](https://github.com/fherrerao)

 **Twitter** | [Fernando Herrera](https://www.linkedin.com/in/fherrerao/)

 **LinkedIn** | [Fernando Herrera](https://twitter.com/fherrera0206)





 

## Show your support



Give a ⭐️ if you like this project!




## Acknowledgments



- The ideas and inspiration from this project are coming from:  [Ioet](https://www.ioet.com/)






## 📝 License



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