README.md
# Primes table generator
[](https://circleci.com/gh/tareksamni/primes)
[](https://codeclimate.com/github/tareksamni/primes/maintainability)
[](https://codeclimate.com/github/tareksamni/primes/test_coverage)
This is a ruby implementation of Coding Challenge which could be found [here][13].
The code in this repo is mainly divided into small/simple classes and each class own its responsibilities, errors, constants, state and behaviour as follows:
+ [`Primes::Generator`][1] is responsible for generating N primes.
+ [`Calculators::Multiplication`][2] is responsible for calculating a 2D array (matrix) of multiplications of a given set of primes. It's easy to integrate other calculators into the system and switch between them.
+ [`Formatters::CLI`][3] is responsible for printing any given 2D array as a table to the `STDOUT`. It's easy to integrate other formatter into the system and switch between them.
For ex. you can code a `json` formatter that saves a json format of the table instead of printing it to the `STDOUT`.
This project is following `TDD` so [specs][4] could be found [here][5].
## Example run
[](https://github.com/tareksamni/primes)
## Setup & Run
This project is using:
+ ruby 2.5.1
+ bundler gem to install all required gems that are listed in [Gemfile][6].
+ rspec gem as the tests framework. Config can be found in [.rspec][7].
+ rubocop gem as a main coding style guide. Config can be found in [.rubocop.yml][8].
+ [Docker][9] to run the application without any dependencies using docker engine.
+ [Codeclimate][12] is used in this project to provide some transparency about the code quality and test coverage.
## Using Docker (Build from source)
[Install Docker Engine][10] on your machine to be able to follow these steps.
run `docker --version` to make sure that docker is installed and running successfully. You should get a message like `Docker version 18.06.1-ce, build e68fc7a`. Now you follow these steps:
+ Build docker image from source
```shell
docker build . -t primes:$(git rev-parse HEAD)
```
+ Run the application on a docker container
```shell
docker run primes:$(git rev-parse HEAD) # default 10
#or
docker run primes:$(git rev-parse HEAD) ./run 15
```
+ Run tests on a docker container
```shell
docker run primes:$(git rev-parse HEAD) rspec
```
## Using Docker (Pull from docker hub)
[Install Docker Engine][10] on your machine to be able to follow these steps.
run `docker --version` to make sure that docker is installed and running successfully. You should get a message like `Docker version 18.06.1-ce, build e68fc7a`. Now you follow these steps:
+ Run the application on a docker container
```shell
# Make sure that the tag is already exisiting on:
# https://hub.docker.com/r/tareksamni/primes/tags/
docker run tareksamni/primes:$(git rev-parse HEAD) # default 10
# or
docker run tareksamni/primes:$(git rev-parse HEAD) ./run 15
```
+ Run tests on a docker container
```shell
docker run tareksamni/primes:$(git rev-parse HEAD) rspec
```
## Without Docker
You need to install the dependencies first, follow these steps to install all required dependencies using [`RVM`][11]:
+ Install RVM
```shell
curl -sSL https://get.rvm.io | bash -s stable
```
+ Install/Use ruby 2.5.1 and create a gemset for this project
```shell
rvm use ruby-2.5.1@primes --create
```
+ Install bundler gem
```shell
gem install bundler
```
+ Install gems listed in Gemfile
```shell
bundle install
```
+ Run application
```shell
./run # default 10
# or
./run 15
```
+ Run tests
```shell
rspec
```
[1]: https://github.com/tareksamni/primes/blob/master/app/primes/generator.rb
[2]: https://github.com/tareksamni/primes/blob/master/app/calculators/multiplication.rb
[3]: https://github.com/tareksamni/primes/blob/master/app/formatters/cli.rb
[4]: http://rspec.info/
[5]: https://github.com/tareksamni/primes/tree/master/spec
[6]: https://github.com/tareksamni/primes/blob/master/Gemfile
[7]: https://github.com/tareksamni/primes/blob/master/.rspec
[8]: https://github.com/tareksamni/primes/blob/master/.rubocop.yml
[9]: https://www.docker.com/
[10]: https://docs.docker.com/docker-for-mac/install/
[11]: https://rvm.io/rvm/install
[12]: http://codeclimate.com/
[13]: https://github.com/tareksamni/primes/blob/master/CHALLENGE.md