Introducing Docker to Grape

[ericproulx]

Hi,

I've been using Docker for a while now and I thought it would be a great addition to include a Dockerfile to Grape. Also, docker-compose always been my go to for running containers even though its for multiple containers. It's just easier to configure than running docker commands with arguments.

Dockerfile

• As an ARG called RUBY_VERSION for building an image on different ruby-version
• Setting BUNDLE_PATH to /usr/local/bundle/gems
• Setting LIB_PATH to /var/grape. Code from the host will be copied in that folder
• Add basic packages for development
• Install latest version of rubygems and bundle
• Starts with an entrypoint

Entrypoint

• echoes version of ruby, rubygems and bundle.
• check gems sanity with bundle
• update gems to latest version
• execute bundle exec :your_command

Docker-compose

• Default RUBY_VERSION to 3.
• Add gems volume

Basic CLI

• Basic command docker-compose run --rm --build grape <your_command>. You may replace <your_command> by anything that runs under bundle exec
• --rm will remove automatically the container
• --build will automatically build or rebuild the image (useful when changing RUBY_VERSION)

CLI

• Running all specs docker-compose run --rm --build grape rspec
• Running rspec on a specific file docker-compose run --rm --build grape rspec spec/:file_path
• Running task docker-compose run --rm --build grape rake <task_name>
• Running rubocop docker-compose run --rm --build grape rubocop
• Running all specs on a specific ruby version (e.g 2.7.7) RUBY_VERSION=2.7.7 docker-compose run --rm --build grape rspec
• Running specs on a specific gemfile (e.g rails_7.gemfile) docker-compose run -e GEMFILE=rails_7 --rm --build grape rspec

Running the container will automatically install the missings gems and run your command.

[dblock]

Let's add something to the README about using this and a CHANGELOG entry?

Should there be a workflow that brings up the container in CI?

[duffn]

This is nice to show people how to use Docker with grape but if it goes in the repo, feels like it belongs in something like an “examples” directory.

[ericproulx]

This is nice to show people how to use Docker with grape but if it goes in the repo, feels like it belongs in something like an “examples” directory.

@duffn I've added examples in the CONTRIBUTING.md

[dblock]

Nit below.

[dblock]

Can I have other maintainers say whether they would like this merged or not?

Should we require/add a CI to ensure the Dockerfile works?

[dm1try]

I've checked locally, looks good to me)

[ericproulx]

rubocop offenses fixed in #2319

[dblock]

Thanks. Rebase?

I just merged it. We can fix any failures on main.