build: Docker dev setup

Author: blocknotes

.env

@@ -0,0 +1,2 @@
+UID=1000
+GID=1000

Gemfile

@@ -2,7 +2,22 @@
 
 source 'https://rubygems.org'
 
-gemspec
+if ENV['DEVEL'] == '1'
+  rails_ver = ENV.fetch('RAILS_VERSION')
+  gem 'rails', rails_ver
+
+  gem 'activeadmin', ENV.fetch('ACTIVEADMIN_VERSION')
+  gem 'activeadmin_dynamic_fields', path: './'
+
+  if rails_ver.start_with?('7.0')
+    gem 'concurrent-ruby', '1.3.4'
+    gem 'sqlite3', '~> 1.4'
+  else
+    gem 'sqlite3'
+  end
+else
+  gemspec
+end
 
 gem 'bigdecimal'
 gem 'mutex_m'

Makefile

@@ -0,0 +1,38 @@
+help:
+	@echo "Main targets: up / down / console / shell"
+
+# Docker commands
+down:
+	docker compose down
+
+up:
+	docker compose up
+
+attach:
+	docker compose attach app
+
+up_attach:
+	docker compose up -d && docker compose attach app
+
+cleanup:
+	docker container rm -f activeadmin_dynamic_fields_app && docker image rm -f activeadmin_dynamic_fields-app
+
+# Rails specific commands
+console:
+	docker compose exec -e "PAGER=more" app bin/rails console
+
+routes:
+	docker compose exec app bin/rails routes
+
+specs:
+	docker compose exec app bin/rspec --fail-fast
+
+# Other commands
+bundle:
+	docker compose exec app bundle
+
+shell:
+	docker compose exec -e "PAGER=more" app bash
+
+lint:
+	docker compose exec app bin/rubocop

README.md

@@ -234,17 +234,61 @@ end
 
 The link url is loaded via AJAX before opening the dialog.
 
+## Development
+
+Project created by [Mattia Roccoberton](http://blocknot.es), thanks also to the good guys that opened issues and pull requests from time to time.
+
+There 3 ways to interact with this project:
+
+1) Using Docker:
+
+```sh
+# Run rails server on the dummy app (=> http://localhost:3000 to access to ActiveAdmin):
+make up
+# Enter in a Rails console (with the dummy app started):
+make console
+# Enter in a shell (with the dummy app started):
+make shell
+# Run the linter on the project (with the dummy app started):
+make lint
+# Run the test suite (with the dummy app started):
+make specs
+# Remove container and image:
+make cleanup
+# To try different versions of Ruby/Rails/ActiveAdmin edit docker-compose.yml
+# For more commands please check the Makefile
+```
+
+2) Using Appraisal:
+
+```sh
+export RAILS_ENV=development
+# Install dependencies:
+bin/appraisal
+# Run server (or any command):
+bin/appraisal rails s
+# Or with a specific configuration:
+bin/appraisal rails80-activeadmin rails s
+```
+
+3) With a local setup:
+
+```sh
+# Dev setup (set the required envs):
+source extra/dev_setup.sh
+# Install dependencies:
+bundle update
+# Run server (or any command):
+bin/rails s
+# To try different versions of Rails/ActiveAdmin edit extra/dev_setup.sh
+```
+
 ## Do you like it? Star it!
 
 If you use this component just star it. A developer is more motivated to improve a project when there is some interest. My other [Active Admin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source).
 
 Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
 
-## Contributors
-
-- [Mattia Roccoberton](http://blocknot.es): author
-- The good guys that opened issues and pull requests from time to time
-
 ## License
 
 The gem is available as open-source under the terms of the [MIT](LICENSE.txt).

docker-compose.yml

@@ -0,0 +1,25 @@
+services:
+  app:
+    container_name: 'activeadmin_dynamic_fields_app'
+    build:
+      context: .
+      dockerfile: ./extra/Dockerfile
+      # dockerfile: ./extra/Dockerfile_alpine
+      args:
+        # Debian-based Ruby image:
+        RUBY_IMAGE: ruby:3.4-slim
+        UID: ${UID}
+    environment:
+      ACTIVEADMIN_VERSION: ~> 3.3
+      RAILS_VERSION: ~> 8.0
+    user: "${UID}:${GID}"
+    ports:
+      - '3000:3000'
+    working_dir: '/app'
+    volumes:
+      - '.:/app'
+    stdin_open: true
+    tty: true
+    entrypoint:
+      - /bin/sh
+      - ./extra/entrypoint.sh

extra/Dockerfile

@@ -0,0 +1,21 @@
+ARG RUBY_IMAGE=ruby:3
+FROM ${RUBY_IMAGE}
+
+ARG UID
+
+ENV DEVEL=1
+ENV LANG=C.UTF-8
+ENV RAILS_ENV=development
+
+RUN apt-get update -qq
+RUN DEBIAN_FRONTEND=noninteractive apt-get install -yqq --no-install-recommends build-essential chromium libyaml-dev nano
+
+RUN gem install bundler
+RUN echo 'gem: --no-document' > /etc/gemrc
+
+RUN useradd -u ${UID} --shell /bin/bash app 
+RUN mkdir -p /home/app && chown -R app:app /home/app
+RUN chown -R app /usr/local/bundle 
+
+USER ${UID}
+COPY . /app

extra/Dockerfile_alpine

@@ -0,0 +1,18 @@
+FROM ruby:3.3-alpine
+
+ARG UID
+
+ENV DEVEL=1
+ENV LANG=C.UTF-8
+ENV RAILS_ENV=development
+
+RUN apk update && apk add --no-cache build-base chromium tzdata yaml-dev
+
+RUN gem install bundler
+RUN echo 'gem: --no-document' > /etc/gemrc
+
+RUN adduser -u ${UID} -D app 
+RUN mkdir -p /home/app && chown -R app:app /home/app
+RUN chown -R app /usr/local/bundle 
+
+COPY . /app

extra/README.md

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+export DEVEL=1
+
+export RAILS_VERSION=8.0.2
+export ACTIVEADMIN_VERSION=3.3.0
+
+export RAILS_ENV=development

extra/dev_setup.sh

@@ -0,0 +1,8 @@
+echo "> Install dependencies"
+rm -f Gemfile.lock && bundle install
+
+echo "> Run pending migrations"
+cd spec/dummy && bundle exec rails db:migrate
+
+echo "> Start Rails server"
+cd /app && rm -f spec/dummy/tmp/pids/server.pid && bundle exec rails s -b 0.0.0.0