/ruby-rspec-docker-container

A simple Docker environment for running rspec tests

Primary LanguageRuby

Description

This template repository includes a basic setup for using Docker to run RSpec tests, Pry, and Ruby scripts using Ruby 2.6.5.

To use Docker, you will first need to install it. Once it's installed, Docker should be open so you can actually run Docker commands in the terminal.

Running IRB

You don't need this setup for running IRB (Ruby REPL) by itself. To use IRB on its own, do the following (after Docker is installed and open):

$ docker pull ruby:2.6.5

This pulls down the image of Ruby we use at Epicodus. You only need to do this once.

Once you have it on your machine, you can run IRB with the following command:

$ docker run -it ruby:2.6.5 irb

We recommend creating an alias (called something like dirb for Docker IRB) to make the command easier to use.

You can exit IRB as normal by typing exit.

Using This Repository for Docker

This repository is a template repository. To use it, start by creating a new repository with ruby-rspec-docker-container as a template. Clone that repository down to your desktop.

The repository contains a simple project that tests a simple title_case method. To run tests on the current code, simply run the command docker-compose up in the root directory of this project.

To run tests on your own code, replace the lib and spec directories with your own source code (for lib) and tests (for spec).

We recommend creating an alias for the following commands. The alias should look something like this:

dspec ()
{
  docker-compose down
  docker-compose up --build
  docker-compose run --rm app
}

With this alias, the dspec command will automatically run RSpec tests. You can use binding.pry as needed.

Running Scripts

Running scripts is optional at Epicodus. However, if you want to experiment with it, follow these steps:

  • The script must be located in lib and be called script.rb.

  • Run the following command: docker-compose run --rm app ruby lib/script.rb.

Once again, we recommend aliasing this command if you plan to run scripts often. If you prefer to name your script something else, you just need to update the command to use the correct path and file name.