active_storage_db 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5455342b089699d34e3f5e4386465431a93258ab9fa6610c8ba91b7c2c2f53f4
-  data.tar.gz: 86790589793eb8d0f6f5f4e781a3f5a161282d6a4f9409936a0ce0b5378ff243
+  metadata.gz: 0167f8b1c0fa434977a9fc46cc743c11e67602355eb483cb67c5b47366fc6aa5
+  data.tar.gz: fc760095ce36ad3a77a21bc803461589de2407c759bebb1439bfcb395fd0f51e
 SHA512:
-  metadata.gz: 2cc59ba9f5dd3510810412b6173b56b6e40f1a43570d1976a07c769c01a5f015d23c779f6ecde67e1d7e8471c4fa39a8dbc848c6ee943a24fc4f88c91d7017c3
-  data.tar.gz: 792e00cf27b413d645475dd500425b7e77b8ce96e82e32e4b5c474c025916dcc5b5593edf2fe13e1db8656ab429b9a60ed8ce6a1e78608af4392ee232a2423b0
+  metadata.gz: 2e990c95440f59b89c93bacc4aa994258b468db54c1a73ce6cc4bbf7ae92c497938cf9874bca6dbe7a8ec6b2280b32f466b1b8a7970bef62e2dd6fb88e53d49c
+  data.tar.gz: f8ba1f9b8931a1c1fba1f9a3b59e9747850a201cde129f68af80644d2cefe4e8cea15ee3f6d96fe9eabe361e607872557fe3c24f6162c90d076aa4d3bc9ca5c3

data/README.md

@@ -5,15 +5,13 @@
 [![maintainability](https://api.codeclimate.com/v1/badges/92e1e703c308744a0f66/maintainability)](https://codeclimate.com/github/blocknotes/active_storage_db/maintainability)
 
 [![linters](https://github.com/blocknotes/active_storage_db/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/linters.yml)
-[![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)
+[![Specs Postgres Rails 8.0](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_rails80.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_rails80.yml)
+[![Specs MySQL Rails 8.0](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_rails80.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_rails80.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);
-- 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).
 
@@ -26,11 +24,36 @@ Useful also with platforms like Heroku (due to their ephemeral file system).
 - Change Active Storage service in *config/environments/development.rb* to: `config.active_storage.service = :db`
 - Add to *config/storage.yml*:
 
-```
+```yml
 db:
   service: DB
 ```
 
+### Customizations
+
+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
+  migrations_paths: config/attachments_migrate
+  # other connection details ...
+```
+
+2. Extend the ActiveStorage base record class providing the `connects_to` options (updating _config/application.rb_ / using an initializer for _ActiveStorageDB_ / overriding the base model like in the [Rails guide](https://guides.rubyonrails.org/engines.html#overriding-models-and-controllers)):
+
+```rb
+# e.g. 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_ migrations to the specified migrations path
+4. Execute the _rails db:migrate_ task
+
 ## Misc
 
 Some utility tasks are available:
@@ -44,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).
 
-## Contributors
-
-- [Mattia Roccoberton](https://blocknot.es/): author
-- 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).

data/Rakefile

@@ -16,8 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-app_ver = ENV.fetch('RAILS', '').tr('.', '')
-APP_RAKEFILE = File.expand_path("spec/dummy#{app_ver}/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 load 'rails/tasks/engine.rake'
 
 load 'rails/tasks/statistics.rake'

data/app/controllers/active_storage_db/files_controller.rb

@@ -17,12 +17,12 @@ module ActiveStorageDB
     def update
       if (token = decode_verified_token)
         file_uploaded = upload_file(token, body: request.body)
-        head(file_uploaded ? :no_content : :unprocessable_entity)
+        head(file_uploaded ? :no_content : unprocessable)
       else
         head(:not_found)
       end
     rescue ActiveStorage::IntegrityError
-      head(:unprocessable_entity)
+      head(unprocessable)
     end
 
     private
@@ -59,5 +59,9 @@ module ActiveStorageDB
       db_service.upload(token[:key], request.body, checksum: token[:checksum])
       true
     end
+
+    def unprocessable
+      Gem::Version.new(Rails.version) >= Gem::Version.new("7.1") ? :unprocessable_content : :unprocessable_entity
+    end
   end
 end

data/lib/active_storage/service/db_service.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'active_storage/service/db_service_rails60'
-require 'active_storage/service/db_service_rails61'
-require 'active_storage/service/db_service_rails70'
+require "active_storage/service/db_service_rails60"
+require "active_storage/service/db_service_rails61"
+require "active_storage/service/db_service_rails70"
 
 module ActiveStorage
   # Wraps a DB table as an Active Storage service. See ActiveStorage::Service
@@ -19,7 +19,7 @@ module ActiveStorage
     # :nocov:
 
     def initialize(public: false, **)
-      @chunk_size = ENV.fetch('ASDB_CHUNK_SIZE') { 1.megabytes }
+      @chunk_size = ENV.fetch("ASDB_CHUNK_SIZE") { 1.megabytes }
       @public = public
     end
 
@@ -47,7 +47,7 @@ module ActiveStorage
       instrument :download_chunk, key: key, range: range do
         from = range.begin + 1
         size = range.size
-        args = adapter_sqlserver? ? "data, #{from}, #{size}" : "data FROM #{from} FOR #{size}"
+        args = adapter_sqlserver? || adapter_sqlite? ? "data, #{from}, #{size}" : "data FROM #{from} FOR #{size}"
         record = object_for(key, fields: "SUBSTRING(#{args}) AS chunk")
         raise(ActiveStorage::FileNotFoundError) unless record
 
@@ -57,22 +57,28 @@ module ActiveStorage
 
     def delete(key)
       instrument :delete, key: key do
-        ::ActiveStorageDB::File.find_by(ref: key)&.destroy
-        # Ignore files already deleted
+        comment = "DBService#delete"
+        record = ::ActiveStorageDB::File.annotate(comment).find_by(ref: key)
+        record&.destroy
+        # NOTE: Ignore files already deleted
+        !record.nil?
       end
     end
 
     def delete_prefixed(prefix)
       instrument :delete_prefixed, prefix: prefix do
-        ::ActiveStorageDB::File.where('ref LIKE ?', "#{ApplicationRecord.sanitize_sql_like(prefix)}%").destroy_all
+        comment = "DBService#delete_prefixed"
+        sanitized_prefix = "#{ApplicationRecord.sanitize_sql_like(prefix)}%"
+        ::ActiveStorageDB::File.annotate(comment).where("ref LIKE ?", sanitized_prefix).destroy_all
       end
     end
 
     def exist?(key)
       instrument :exist, key: key do |payload|
-        answer = ::ActiveStorageDB::File.where(ref: key).exists?
-        payload[:exist] = answer
-        answer
+        comment = "DBService#exist?"
+        result = ::ActiveStorageDB::File.annotate(comment).where(ref: key).exists?
+        payload[:exist] = result
+        result
       end
     end
 
@@ -84,7 +90,7 @@ module ActiveStorage
             content_type: content_type,
             content_length: content_length,
             checksum: checksum,
-            service_name: respond_to?(:name) ? name : 'db'
+            service_name: respond_to?(:name) ? name : "db"
           },
           expires_in: expires_in,
           purpose: :blob_token
@@ -97,13 +103,25 @@ module ActiveStorage
     end
 
     def headers_for_direct_upload(_key, content_type:, **)
-      { 'Content-Type' => content_type }
+      { "Content-Type" => content_type }
     end
 
     private
 
+    def adapter_sqlite?
+      @adapter_sqlite ||= active_storage_db_adapter_name == "SQLite"
+    end
+
     def adapter_sqlserver?
-      @adapter_sqlserver ||= ActiveStorageDB::File.connection.adapter_name == 'SQLServer'
+      @adapter_sqlserver ||= active_storage_db_adapter_name == "SQLServer"
+    end
+
+    def active_storage_db_adapter_name
+      if ActiveStorageDB::File.respond_to?(:lease_connection)
+        ActiveStorageDB::File.lease_connection.adapter_name
+      else
+        ActiveStorageDB::File.connection.adapter_name
+      end
     end
 
     def generate_url(key, expires_in:, filename:, content_type:, disposition:)
@@ -113,7 +131,7 @@ module ActiveStorage
           key: key,
           disposition: content_disposition,
           content_type: content_type,
-          service_name: respond_to?(:name) ? name : 'db'
+          service_name: respond_to?(:name) ? name : "db"
         },
         expires_in: expires_in,
         purpose: :blob_key
@@ -146,15 +164,16 @@ module ActiveStorage
     end
 
     def object_for(key, fields: nil)
-      as_file = fields ? ::ActiveStorageDB::File.select(*fields) : ::ActiveStorageDB::File
+      comment = "DBService#object_for"
+      as_file = fields ? ::ActiveStorageDB::File.annotate(comment).select(*fields) : ::ActiveStorageDB::File
       as_file.find_by(ref: key)
     end
 
     def stream(key)
-      data_size = adapter_sqlserver? ? 'DATALENGTH(data)' : 'OCTET_LENGTH(data)'
+      data_size = adapter_sqlserver? ? "DATALENGTH(data)" : "OCTET_LENGTH(data)"
       size = object_for(key, fields: "#{data_size} AS size")&.size || raise(ActiveStorage::FileNotFoundError)
       (size / @chunk_size.to_f).ceil.times.each do |i|
-        range = (i * @chunk_size..((i + 1) * @chunk_size) - 1)
+        range = (i * @chunk_size)..(((i + 1) * @chunk_size) - 1)
         yield download_chunk(key, range)
       end
     end

data/lib/active_storage/service/db_service_rails70.rb

@@ -4,12 +4,13 @@ module ActiveStorage
   module DBServiceRails70
     def compose(source_keys, destination_key, **)
       buffer = nil
+      comment = "DBService#compose"
       source_keys.each do |source_key|
-        data = ::ActiveStorageDB::File.find_by!(ref: source_key).data
+        data = ::ActiveStorageDB::File.annotate(comment).find_by!(ref: source_key).data
         if buffer
           buffer << data
         else
-          buffer = data
+          buffer = +data
         end
       end
       ::ActiveStorageDB::File.create!(ref: destination_key, data: buffer) if buffer

data/lib/active_storage_db/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveStorageDB
-  VERSION = '1.3.1'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_db
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Mattia Roccoberton
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage
@@ -38,34 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: factory_bot_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
 description: An ActiveStorage service plugin to store files in database.
 email:
 - mat@blocknot.es
@@ -97,7 +68,6 @@ metadata:
   homepage_uri: https://github.com/blocknotes/active_storage_db
   source_code_uri: https://github.com/blocknotes/active_storage_db
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: ActiveStorage DB Service
 test_files: []