Merge pull request #51 from blocknotes/dev/docker-setup-2

Update Docker dev setup

Author: blocknotes

.rspec

@@ -1 +1,2 @@
 --require rails_helper
+--format documentation

Gemfile

@@ -2,19 +2,31 @@
 
 source 'https://rubygems.org'
 
-if ENV["DEVEL"] == "1"
-  gem 'rails', '~> 7.1.0'
+if ENV['DEVEL'] == '1'
+  # for Docker dev
+  rails_ver = ENV.fetch('RAILS_VERSION')
+  gem 'rails', rails_ver
 
-  gem 'activeadmin', '~> 3.3'
+  gem 'activeadmin', ENV.fetch('ACTIVEADMIN_VERSION')
   gem 'activeadmin_quill_editor', path: './'
+
+  if rails_ver.start_with?('7.0')
+    gem 'concurrent-ruby', '1.3.4'
+    gem 'sqlite3', '~> 1.4'
+  else
+    gem 'sqlite3'
+  end
 else
   gemspec
+
+  gem 'sqlite3'
 end
 
+gem 'bigdecimal'
+gem 'mutex_m'
 gem 'puma'
 gem 'sassc'
 gem 'sprockets-rails'
-gem 'sqlite3'
 
 # Testing
 gem 'capybara'

README.md

@@ -105,22 +105,50 @@ the editor will not destroy them, you'll need to implement a purge logic for tha
 
 Project created by [Mattia Roccoberton](http://blocknot.es), thanks also to the good guys that opened issues and pull requests from time to time.
 
-A Docker dev setup is provided if you like to work with it:
+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 console of the dummy app after it has been started:
+# Enter in a Rails console (with the dummy app started):
 make console
-# Enter in a shell of the dummy app after it has been started:
+# Enter in a shell (with the dummy app started):
 make shell
-# Run the linter on the project:
+# Run the linter on the project (with the dummy app started):
 make lint
-# Remove container and image after stopping the app:
+# 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 specific versions
+bin/appraisal rails71-activeadmin rails s
 ```
 
-For more commands please check the [Makefile](Makefile).
+3) With a local setup:
+
+```sh
+# Dev setup (set the required envs)
+source extra/dev_setup.sh
+# Install dependencies
+bundle
+# 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!
 

docker-compose.yml

@@ -4,9 +4,14 @@ services:
     build:
       context: .
       dockerfile: ./extra/Dockerfile
+      # dockerfile: ./extra/Dockerfile_alpine
       args:
-        RUBY_VERSION: 3.3.6
+        # 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'

extra/Dockerfile

@@ -1,5 +1,5 @@
-ARG RUBY_VERSION=3
-FROM ruby:${RUBY_VERSION}
+ARG RUBY_IMAGE=ruby:3
+FROM ${RUBY_IMAGE}
 
 ARG UID
 
@@ -8,19 +8,14 @@ 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
+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
 
-COPY . /app
-
-RUN mkdir -p /home/app
 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 
-RUN chown -R app:app /home/app && chown -R app:app /app
 
 USER ${UID}
-
-WORKDIR /app
-RUN bundle update
+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/dev_setup.sh

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

extra/entrypoint.sh

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

spec/dummy/config/environments/development.rb

@@ -59,4 +59,8 @@
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
   # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  ###
+
+  config.active_support.to_time_preserves_timezone = :zone if Gem::Version.new(Rails.version) >= Gem::Version.new('8.0')
 end