Merge pull request #51 from blocknotes/feat/sqlite-support

feat: SQLite support

Author: blocknotes

.github/workflows/specs_sqlite_72.yml

@@ -0,0 +1,56 @@
+---
+name: Specs Rails 7.2 SQLite
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ['3.3']
+        gemfile: ['rails_7_2_sqlite']
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      DB_TEST: sqlite
+      RAILS: '7.0'
+
+    steps:
+      - name: Install lib VIPS
+        run: sudo apt-get install -y libvips-dev
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Database setup
+        run: bundle exec rails db:create db:migrate
+
+      - name: Run tests
+        run: bundle exec rspec --profile
+
+      - name: Code Climate test coverage
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageLocations: |
+            ${{github.workspace}}/coverage/lcov/active_storage_db.lcov:lcov
+
+    #  - name: Upload coverage results
+    #    uses: actions/upload-artifact@main
+    #    if: always()
+    #    with:
+    #      name: coverage-report
+    #      path: coverage/index.html

Appraisals

@@ -41,3 +41,18 @@ appraise 'rails-7_0-mssql' do
   gem 'rails', '~> 7.0.0'
   gem 'tiny_tds'
 end
+
+appraise 'rails-6_1-sqlite' do
+  gem 'sqlite3', '~> 1.4'
+  gem 'rails', '~> 6.1.0'
+end
+
+appraise 'rails-7_1-sqlite' do
+  gem 'sqlite3', '~> 1.4'
+  gem 'rails', '~> 7.1.0'
+end
+
+appraise 'rails-7_2-sqlite' do
+  gem 'sqlite3', '~> 1.4'
+  gem 'rails', '~> 7.2.0'
+end

README.md

@@ -8,7 +8,7 @@
 [![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.
+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);
@@ -31,29 +31,29 @@ db:
   service: DB
 ```
 
-If there is a need to support a separate database connection for storing the `ActiveStorageDB` files:
+### Customizations
 
-1. Add a separate database configuration for the environment (this one is just an example)
+To setup a separate database connection for the `ActiveStorageDB` migrations and files data:
+
+1. Add a different database configuration per environment to `config/database.yml`, e.g:
 
 ```yml
 attachments:
   database: attachments
-  pool: 5
-  username: root
   migrations_paths: config/attachments_migrate
+  # other connection details ...
 ```
 
-2. Create a separate initializer file in `config/initializera/active_storage_db.rb` to set the database:
+2. Extend the ActiveStorage base record class providing the `connects_to` options, e.g `app/overrides/models/active_storage_db/application_record_override.rb` (or add an initializer for _ActiveStorageDB_):
 
 ```rb
-# app/overrides/models/active_storage_db/application_record_override.rb
 ActiveStorageDB::ApplicationRecord.class_eval do
   connects_to database: { reading: :attachments, writing: :attachments }
 end
 ```
 
-3. Move the `ActiveStorageDB` related migrations to a configured storage migrations path
-4. Create the database and execute the migrations
+3. Move the _ActiveStorageDB_ migrations to the specified migrations path
+4. Execute the _rails db:migrate_ task
 
 ## Misc
 
@@ -74,9 +74,9 @@ If you use this component just star it. A developer is more motivated to improve
 
 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
+## Development
 
-- [Mattia Roccoberton](https://blocknot.es/): author
+- Author: [Mattia Roccoberton](https://blocknot.es/)
 - Inspired by [activestorage-database-service](https://github.com/TitovDigital/activestorage-database-service) project
 
 ## License

gemfiles/rails_6_1_sqlite.gemfile

@@ -0,0 +1,24 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "image_processing", ">= 1.2"
+gem "webrick"
+gem "simplecov"
+gem "simplecov-lcov"
+gem "capybara"
+gem "rspec_junit_formatter"
+gem "rspec-rails"
+gem "selenium-webdriver"
+gem "brakeman"
+gem "fasterer"
+gem "rubocop"
+gem "rubocop-packaging"
+gem "rubocop-performance"
+gem "rubocop-rails"
+gem "rubocop-rspec"
+gem "pry-rails"
+gem "sqlite3", "~> 1.4"
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"