build: Improve dev setup

Author: blocknotes

.gitignore

@@ -8,6 +8,7 @@
 /_misc/
 /coverage/
 /spec/dummy/db/*.sqlite3*
+/spec/dummy/db/schema-dev.rb
 /spec/dummy/log/
 /spec/dummy/storage/
 /spec/dummy/tmp/

Gemfile

@@ -2,27 +2,35 @@
 
 source 'https://rubygems.org'
 
+def eval_version(dependency, version)
+  return [dependency] if version.empty?
+
+  version.count('.') < 2 ? [dependency, "~> #{version}.0"] : [dependency, version]
+end
+
 if ENV['DEVEL'] == '1'
   gem 'activeadmin_quill_editor', path: './'
 else
   gemspec
 end
 
 ruby_ver = ENV.fetch('RUBY_VERSION', '')
-rails_ver = ENV.fetch('RAILS_VERSION', '')
-activeadmin_ver = ENV.fetch('ACTIVEADMIN_VERSION', '')
 
-rails = rails_ver.empty? ? ['rails'] : ['rails', "~> #{rails_ver}"]
+rails_ver = ENV.fetch('RAILS_VERSION', '')
+rails = eval_version('rails', rails_ver)
 gem(*rails)
 
-activeadmin = activeadmin_ver.empty? ? ['activeadmin'] : ['activeadmin', "~> #{activeadmin_ver}"]
-gem(*activeadmin)
+active_admin_ver = ENV.fetch('ACTIVEADMIN_VERSION', '')
+active_admin = eval_version('activeadmin', active_admin_ver)
+gem(*active_admin)
 
-ruby32 = Gem::Version.new(ruby_ver) >= Gem::Version.new('3.2')
-rails72 = Gem::Version.new(rails_ver) >= Gem::Version.new('7.2')
-sqlite3 = ruby32 || rails72 ? ['sqlite3'] : ['sqlite3', '~> 1.4']
+ruby32 = ruby_ver.empty? || Gem::Version.new(ruby_ver) >= Gem::Version.new('3.2')
+rails72 = rails_ver.empty? || Gem::Version.new(rails_ver) >= Gem::Version.new('7.2')
+sqlite3 = ruby32 && rails72 ? ['sqlite3'] : ['sqlite3', '~> 1.4']
 gem(*sqlite3)
 
+gem 'zeitwerk', '~> 2.6.18' unless ruby32
+
 # NOTE: to avoid error: uninitialized constant ActiveSupport::LoggerThreadSafeLevel::Logger
 gem 'concurrent-ruby', '1.3.4'
 

Makefile

@@ -1,7 +1,14 @@
 include extra/.env
 
 help:
-	@echo "Main targets: build / specs / up / server / specs / shell"
+	@echo -e "${COMPOSE_PROJECT_NAME} - Main project commands:\n\
+		make up   	# starts the dev services (optional env vars: RUBY / RAILS / ACTIVEADMIN)\n\
+		make specs	# run the tests (after up)\n\
+		make lint 	# run the linters (after up)\n\
+		make server	# run the server (after up)\n\
+		make shell	# open a shell (after up)\n\
+		make down 	# cleanup (after up)\n\
+	Example: RUBY=3.2 RAILS=7.1 ACTIVEADMIN=3.2.0 make up"
 
 # System commands
 
@@ -10,7 +17,7 @@ build:
 	@docker compose -f extra/docker-compose.yml build
 
 db_reset:
-	@docker compose -f extra/docker-compose.yml run --rm app bin/rails db:reset db:test:prepare
+	@docker compose -f extra/docker-compose.yml run --rm app bin/rails db:create db:migrate db:test:prepare
 
 up: build db_reset
 	@docker compose -f extra/docker-compose.yml up
@@ -23,13 +30,16 @@ down:
 
 # App commands
 
-console:
+seed:
+	@docker compose -f extra/docker-compose.yml exec app bin/rails db:seed
+
+console: seed
 	@docker compose -f extra/docker-compose.yml exec app bin/rails console
 
 lint:
 	@docker compose -f extra/docker-compose.yml exec app bin/rubocop
 
-server:
+server: seed
 	@docker compose -f extra/docker-compose.yml exec app bin/rails server -b 0.0.0.0 -p ${SERVER_PORT}
 
 specs:

extra/Dockerfile

@@ -26,6 +26,6 @@ ENV ACTIVEADMIN_VERSION=$ACTIVEADMIN_VERSION
 WORKDIR /app
 COPY . /app
 RUN bundle install
-RUN mkdir -p /app/spec/dummy/db && chown -R app:app /app/spec/dummy/db /usr/local/bundle
+RUN chown -R app:app /usr/local/bundle
 
 RUN ln -s /app/extra/.bashrc /home/app/.bashrc

extra/dev_setup.sh

@@ -4,5 +4,3 @@ export DEVEL=1
 
 export RAILS_VERSION=7.2.2.1
 export ACTIVEADMIN_VERSION=3.3.0
-
-export RAILS_ENV=development

extra/development.md

@@ -1,29 +1,21 @@
 ## Development
 
-Overcommit can be used to ensure that Conventional commits are good.
-
 ### Dev setup
 
-There 2 ways to interact with this project:
+There are 2 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:
-RUBY=3.2 RAILS=7.1.0 ACTIVEADMIN=3.2.0 make up
-# For more commands please check the Makefile
+make up         # starts the dev services (optional env vars: RUBY / RAILS / ACTIVEADMIN)
+make specs      # run the tests (after up)
+make lint       # run the linters (after up)
+make server     # run the server (after up)
+make shell      # open a shell (after up)
+make down       # cleanup (after up)
+
+# Example using specific versions:
+RUBY=3.2 RAILS=7.1 ACTIVEADMIN=3.2.0 make up
 ```
 
 2) With a local setup:

extra/docker-compose.yml

@@ -4,10 +4,10 @@ services:
       context: ..
       dockerfile: extra/Dockerfile
       args:
-        ACTIVEADMIN_VERSION: ${ACTIVEADMIN:-}
         BUNDLER_VERSION: ${BUNDLER_VERSION}
-        RAILS_VERSION: ${RAILS:-}
         RUBY_IMAGE: ruby:${RUBY:-3.4}-slim
+        RAILS_VERSION: ${RAILS:-}
+        ACTIVEADMIN_VERSION: ${ACTIVEADMIN:-}
         UID: ${UID}
     user: ${UID}:${GID}
     ports:

spec/dummy/config/database.yml

@@ -6,7 +6,7 @@ default: &default
 development:
   <<: *default
   database: db/development.sqlite3
-  schema_dump: schema_development.rb
+  schema_dump: schema-dev.rb
 
 test:
   <<: *default