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

Dev: improve Docker setup

Author: blocknotes

.dockerignore

@@ -0,0 +1,15 @@
+/Makefile
+/LICENSE.txt
+/Gemfile.lock
+/extra/init.sh
+
+/app
+/bin
+/coverage
+/gemfiles
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log
+/spec/dummy/tmp
+/spec/dummy/**/*_spec.rb
+
+/**/*.md

.env

@@ -29,6 +29,9 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
+      - name: Database setup
+        run: bin/rails db:reset db:test:prepare
+
       - name: Run tests
         run: bundle exec rspec --profile
 

.github/workflows/specs_rails70.yml

@@ -29,6 +29,9 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
+      - name: Database setup
+        run: bin/rails db:reset db:test:prepare
+
       - name: Run tests
         run: bundle exec rspec --profile
 

.github/workflows/specs_rails71.yml

@@ -29,6 +29,9 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
+      - name: Database setup
+        run: bin/rails db:reset db:test:prepare
+
       - name: Run tests
         run: bundle exec rspec --profile
 

.github/workflows/specs_rails72.yml

@@ -29,6 +29,9 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
+      - name: Database setup
+        run: bin/rails db:reset db:test:prepare
+
       - name: Run tests
         run: bundle exec rspec --profile
 

.github/workflows/specs_rails80.yml

@@ -3,10 +3,21 @@
 source 'https://rubygems.org'
 
 if ENV['DEVEL'] == '1'
-  rails_ver = ENV.fetch('RAILS_VERSION')
-  gem 'rails', rails_ver
+  rails_ver = ENV.fetch('RAILS_VERSION', '')
+  activeadmin_ver = ENV.fetch('ACTIVEADMIN_VERSION', '')
+
+  if rails_ver.empty?
+    gem 'rails'
+  else
+    gem 'rails', "~> #{rails_ver}"
+  end
+
+  if activeadmin_ver.empty?
+    gem 'activeadmin'
+  else
+    gem 'activeadmin', "~> #{activeadmin_ver}"
+  end
 
-  gem 'activeadmin', ENV.fetch('ACTIVEADMIN_VERSION')
   gem 'activeadmin_dynamic_fields', path: './'
   gem 'appraisal', '~> 2.4'
 

Gemfile

@@ -1,38 +1,33 @@
+include extra/.env
+
 help:
-	@echo "Main targets: up / down / console / shell"
+	@echo "Main targets: build / specs / up / server / specs / shell"
 
 # Docker commands
-down:
-	docker compose down
-
-up:
-	docker compose up
 
-attach:
-	docker compose attach app
+build:
+	@rm -f Gemfile.lock
+	@docker compose -f extra/docker-compose.yml build
 
-up_attach:
-	docker compose up -d && docker compose attach app
+up: build
+	@docker compose -f extra/docker-compose.yml up
 
 cleanup:
-	docker container rm -f activeadmin_dynamic_fields_app && docker image rm -f activeadmin_dynamic_fields-app
+	@docker compose -f extra/docker-compose.yml down --volumes --rmi local --remove-orphans
 
-# Rails specific commands
-console:
-	docker compose exec -e "PAGER=more" app bin/rails console
+# App commands
 
-routes:
-	docker compose exec app bin/rails routes
+server:
+	@docker compose -f extra/docker-compose.yml exec app bin/rails s -b 0.0.0.0 -p ${SERVER_PORT}
 
 specs:
-	docker compose exec app bin/rspec --fail-fast
+	@docker compose -f extra/docker-compose.yml exec app bin/rspec --fail-fast
+
+lint:
+	@docker compose -f extra/docker-compose.yml exec app bin/rubocop
 
-# Other commands
-bundle:
-	docker compose exec app bundle
+appraisal_update:
+	@docker compose -f extra/docker-compose.yml exec app bin/appraisal update
 
 shell:
-	docker compose exec -e "PAGER=more" app bash
-
-lint:
-	docker compose exec app bin/rubocop
+	@docker compose -f extra/docker-compose.yml exec app bash

Makefile

@@ -239,50 +239,7 @@ The link url is loaded via AJAX before opening the dialog.
 
 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
-```
+For development information please check [this document](extra/development.md).
 
 ## Do you like it? Star it!
 

README.md

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
 require 'bundler/gem_tasks'
 
 begin