Merge pull request #57 from blocknotes/dev/docker-setup

Docker dev setup

Author: blocknotes

.rubocop.yml

@@ -44,3 +44,11 @@ RSpec/NestedGroups:
 Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/active_storage/service/db_service.rb'
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - spec/dummy/db/**/schema*.rb
+
+Style/NumericLiterals:
+  Exclude:
+    - spec/dummy/db/**/schema*.rb

Gemfile

@@ -3,27 +3,43 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-gemspec
+if ENV['DEVEL'] == '1'
+  rails_ver = ENV.fetch('RAILS_VERSION')
+  gem 'rails', rails_ver
+
+  gem 'activeadmin', ENV.fetch('ACTIVEADMIN_VERSION')
+  gem 'active_storage_db', path: './'
+  gem 'appraisal', '~> 2.4'
+  gem 'factory_bot_rails', '~> 6.1'
+
+  if rails_ver.start_with?('7.0')
+    gem 'concurrent-ruby', '1.3.4'
+  end
+else
+  gemspec
+end
 
 if ENV['DB_TEST'] == 'mssql'
   gem 'activerecord-sqlserver-adapter', '7.0.3.0'
   gem 'tiny_tds'
 end
 gem 'mysql2' if ENV['DB_TEST'] == 'mysql'
 gem 'pg' if ['postgres', 'postgresql'].include? ENV['DB_TEST']
+gem 'sqlite3' if ENV['DB_TEST'] == 'sqlite'
 
+gem 'bigdecimal'
 gem 'image_processing', '>= 1.2'
-
-gem 'webrick'
-
-gem 'simplecov'
-gem 'simplecov-lcov'
+gem 'mutex_m'
+gem 'puma'
+gem 'sprockets-rails'
 
 # Testing
 gem 'capybara'
 gem 'rspec_junit_formatter'
 gem 'rspec-rails'
 gem 'selenium-webdriver'
+gem 'simplecov'
+gem 'simplecov-lcov'
 
 # Linters
 gem 'brakeman'

Makefile

@@ -0,0 +1,41 @@
+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 active_storage_db_app && docker image rm -f active_storage_db-app
+
+# Rails specific commands
+db_reset:
+	docker compose exec app bin/rails db_reset
+
+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

@@ -8,12 +8,10 @@
 [![specs Postgres](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_71.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_71.yml)
 [![specs MySQL](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_71.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_71.yml)
 
-An Active Storage service upload/download plugin that stores files in a PostgreSQL or MySQL database. Experimental support also for MSSQL and SQLite.
+An Active Storage service upload/download plugin that stores files in a PostgreSQL or MySQL database.
+Experimental support also for MSSQL and SQLite.
 
-Main features:
-- attachment data stored in a binary field (or blob);
-- all service methods implemented;
-- supports Rails _6_ and _7_.
+Attachment data get stored in a binary field (or blob).
 
 Useful also with platforms like Heroku (due to their ephemeral file system).
 
@@ -69,17 +67,18 @@ bin/rails 'asdb:search[some_filename]'
 bin/rails 'asdb:download[123,/tmp]'
 ```
 
+## 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.
+
+For development information please check [this document](extra/development.md).
+
 ## 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.
 
 Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
 
-## Development
-
-- Author: [Mattia Roccoberton](https://blocknot.es/)
-- Inspired by [activestorage-database-service](https://github.com/TitovDigital/activestorage-database-service) project
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

docker-compose.yml

@@ -0,0 +1,25 @@
+services:
+  app:
+    container_name: 'active_storage_db_app'
+    build:
+      context: .
+      dockerfile: ./extra/Dockerfile
+      args:
+        # Debian-based Ruby image:
+        RUBY_IMAGE: ruby:3.4-slim
+        UID: ${UID}
+    environment:
+      ACTIVEADMIN_VERSION: ~> 3.3
+      DB_TEST: sqlite
+      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 libvips42 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/README.md

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

extra/dev_setup.sh

@@ -0,0 +1,95 @@
+# Development
+
+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
+# Prepare the app
+bin/rails db:reset
+# Run server (or any command):
+bin/rails s
+# To try different versions of Rails/ActiveAdmin edit extra/dev_setup.sh
+```
+
+Sample code to attach a file:
+
+```ruby
+# Create a test post in the dummy app
+post = Post.create!(title: "test1")
+post.some_file.attach(io: Rails.root.join("../../README.md").open, filename: "README.md")
+```
+
+## Releases
+
+```sh
+# Update lib/active_storage_db/version.rb with the new version
+# Update the gemfiles:
+bin/appraisal
+```
+
+## Old dev setup
+
+Local tests:
+
+```sh
+# Running tests on Rails 6.1:
+DB_TEST=postgres bin/appraisal rails-6_1-postgres rails db:test:prepare
+DB_TEST=postgres bin/appraisal rails-6_1-postgres rspec
+
+# Running tests on Rails 7.0:
+DB_TEST=postgres bin/appraisal rails-7_0-postgres rails db:test:prepare
+DB_TEST=postgres bin/appraisal rails-7_0-postgres rspec
+
+# Running tests on Rails 7.1:
+DB_TEST=postgres bin/appraisal rails-7_1-postgres rails db:test:prepare
+DB_TEST=postgres bin/appraisal rails-7_1-postgres rspec
+
+# Eventually recreate the DB:
+DB_TEST=postgres bin/appraisal rails-7_0-postgres rails db:drop db:create db:migrate
+```
+
+Using docker:
+
+```sh
+# Run a specific test configuration
+docker compose up --abort-on-container-exit -- tests_30_mysql
+docker compose up --abort-on-container-exit -- tests_30_postgres
+# Cleanup (also removing local images):
+docker compose down --rmi local
+```

extra/development.md

@@ -1,3 +1,8 @@
-#!/bin/sh
-set -e
-exec "$@"
+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