active_storage_db 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0167f8b1c0fa434977a9fc46cc743c11e67602355eb483cb67c5b47366fc6aa5
-  data.tar.gz: fc760095ce36ad3a77a21bc803461589de2407c759bebb1439bfcb395fd0f51e
+  metadata.gz: ef4de196ae1110b81dfa6adfdd641e82bd009d3d1ed7fd0fbdd497d66cee089f
+  data.tar.gz: f02ae2f4d33d4f054814b0c1fa178af09ec2f6084beb02448af43cf16b45db40
 SHA512:
-  metadata.gz: 2e990c95440f59b89c93bacc4aa994258b468db54c1a73ce6cc4bbf7ae92c497938cf9874bca6dbe7a8ec6b2280b32f466b1b8a7970bef62e2dd6fb88e53d49c
-  data.tar.gz: f8ba1f9b8931a1c1fba1f9a3b59e9747850a201cde129f68af80644d2cefe4e8cea15ee3f6d96fe9eabe361e607872557fe3c24f6162c90d076aa4d3bc9ca5c3
+  metadata.gz: 331e0ccf899fba5d8ed88eacfd95612b074fb403696092b0744a81641dcea1d83f7c723dd430281e3a91224a01657f132ce5cdf9eb06fc04b4e9b6ac98ba6c5d
+  data.tar.gz: 4e657d03432899f4c18bac98201c639c0473150fedd0f83bbfe1ae674000e3765aca3111d823aaf46178a9e4195c44c9ca28297256b1e573bcbe3747cda16f72

data/README.md

@@ -5,8 +5,8 @@
 [![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 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)
+[![Specs Postgres Rails 8.1](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_rails81.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_rails81.yml)
+[![Specs MySQL Rails 8.1](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_rails81.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_rails81.yml)
 
 An Active Storage service upload/download plugin that stores files in a PostgreSQL or MySQL database.
 Experimental support also for MSSQL and SQLite.
@@ -21,8 +21,8 @@ Useful also with platforms like Heroku (due to their ephemeral file system).
 - Add to your Gemfile `gem 'active_storage_db'` (and execute: `bundle`)
 - Install the gem migrations: `bin/rails active_storage_db:install:migrations` (and execute: `bin/rails db:migrate`)
 - Add to your `config/routes.rb`: `mount ActiveStorageDB::Engine => '/active_storage_db'`
-- Change Active Storage service in *config/environments/development.rb* to: `config.active_storage.service = :db`
-- Add to *config/storage.yml*:
+- Change Active Storage service in _config/environments/development.rb_ to: `config.active_storage.service = :db`
+- Add to _config/storage.yml_:
 
 ```yml
 db:

data/app/controllers/active_storage_db/files_controller.rb

@@ -16,19 +16,20 @@ module ActiveStorageDB
 
     def update
       if (token = decode_verified_token)
-        file_uploaded = upload_file(token, body: request.body)
-        head(file_uploaded ? :no_content : unprocessable)
+        file_uploaded = upload_file(token)
+        head(file_uploaded ? :no_content : ActiveStorageDB::UNPROCESSABLE_STATUS)
       else
         head(:not_found)
       end
     rescue ActiveStorage::IntegrityError
-      head(unprocessable)
+      head(ActiveStorageDB::UNPROCESSABLE_STATUS)
     end
 
     private
 
     def acceptable_content?(token)
-      token[:content_type] == request.content_mime_type && token[:content_length] == request.content_length
+      token[:content_type] == request.media_type &&
+        token[:content_length] == request.content_length
     end
 
     def db_service
@@ -53,15 +54,11 @@ module ActiveStorageDB
       send_data(db_service.download(key), options)
     end
 
-    def upload_file(token, body:)
+    def upload_file(token) # rubocop:disable Naming/PredicateMethod
       return false unless acceptable_content?(token)
 
       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/app/models/active_storage_db/file.rb

@@ -4,7 +4,7 @@ module ActiveStorageDB
   class File < ApplicationRecord
     validates :ref,
               presence: true,
-              allow_blank: false,
               uniqueness: { case_sensitive: false }
+    validates :data, presence: true
   end
 end

data/db/migrate/20200702202022_create_active_storage_db_files.rb

@@ -20,7 +20,6 @@ class CreateActiveStorageDBFiles < ActiveRecord::Migration[6.0]
 
   def primary_key_type
     config = Rails.configuration.generators
-    primary_key_type = config.options[config.orm][:primary_key_type]
-    primary_key_type || :primary_key
+    config.options.dig(config.orm, :primary_key_type) || :primary_key
   end
 end

data/lib/active_storage/service/db_service.rb

@@ -18,16 +18,26 @@ module ActiveStorage
     end
     # :nocov:
 
+    MINIMUM_CHUNK_SIZE = 1
+
     def initialize(public: false, **)
-      @chunk_size = ENV.fetch("ASDB_CHUNK_SIZE") { 1.megabytes }
+      @chunk_size = [ENV.fetch("ASDB_CHUNK_SIZE") { 1.megabytes }.to_i, MINIMUM_CHUNK_SIZE].max
+      @max_size = ENV.fetch("ASDB_MAX_FILE_SIZE", nil)&.to_i
       @public = public
     end
 
     def upload(key, io, checksum: nil, **)
       instrument :upload, key: key, checksum: checksum do
-        file = ::ActiveStorageDB::File.create!(ref: key, data: io.read)
-        ensure_integrity_of(key, checksum) if checksum
-        file
+        data = io.read
+        if @max_size && data.bytesize > @max_size
+          raise ArgumentError, "File size exceeds the maximum allowed size of #{@max_size} bytes"
+        end
+
+        if checksum
+          digest = Digest::MD5.base64digest(data)
+          raise ActiveStorage::IntegrityError unless digest == checksum
+        end
+        ::ActiveStorageDB::File.create!(ref: key, data: data)
       end
     end
 
@@ -45,11 +55,13 @@ module ActiveStorage
 
     def download_chunk(key, range)
       instrument :download_chunk, key: key, range: range do
+        # NOTE: from/size are derived from Range#begin and Range#size (always integers),
+        # so string interpolation into SQL is safe here.
         from = range.begin + 1
         size = range.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
+        raise ActiveStorage::FileNotFoundError unless record
 
         record.chunk
       end
@@ -68,7 +80,7 @@ module ActiveStorage
     def delete_prefixed(prefix)
       instrument :delete_prefixed, prefix: prefix do
         comment = "DBService#delete_prefixed"
-        sanitized_prefix = "#{ApplicationRecord.sanitize_sql_like(prefix)}%"
+        sanitized_prefix = "#{ActiveRecord::Base.sanitize_sql_like(prefix)}%"
         ::ActiveStorageDB::File.annotate(comment).where("ref LIKE ?", sanitized_prefix).destroy_all
       end
     end
@@ -76,7 +88,7 @@ module ActiveStorage
     def exist?(key)
       instrument :exist, key: key do |payload|
         comment = "DBService#exist?"
-        result = ::ActiveStorageDB::File.annotate(comment).where(ref: key).exists?
+        result = ::ActiveStorageDB::File.annotate(comment).exists?(ref: key)
         payload[:exist] = result
         result
       end
@@ -90,7 +102,7 @@ module ActiveStorage
             content_type: content_type,
             content_length: content_length,
             checksum: checksum,
-            service_name: respond_to?(:name) ? name : "db"
+            service_name: service_name_for_token
           },
           expires_in: expires_in,
           purpose: :blob_token
@@ -108,12 +120,20 @@ module ActiveStorage
 
     private
 
+    def service_name_for_token
+      name.presence || "db"
+    end
+
     def adapter_sqlite?
-      @adapter_sqlite ||= active_storage_db_adapter_name == "SQLite"
+      return @adapter_sqlite if defined?(@adapter_sqlite)
+
+      @adapter_sqlite = active_storage_db_adapter_name == "SQLite"
     end
 
     def adapter_sqlserver?
-      @adapter_sqlserver ||= active_storage_db_adapter_name == "SQLServer"
+      return @adapter_sqlserver if defined?(@adapter_sqlserver)
+
+      @adapter_sqlserver = active_storage_db_adapter_name == "SQLServer"
     end
 
     def active_storage_db_adapter_name
@@ -131,7 +151,7 @@ module ActiveStorage
           key: key,
           disposition: content_disposition,
           content_type: content_type,
-          service_name: respond_to?(:name) ? name : "db"
+          service_name: service_name_for_token
         },
         expires_in: expires_in,
         purpose: :blob_key
@@ -149,35 +169,38 @@ module ActiveStorage
       )
     end
 
-    def ensure_integrity_of(key, checksum)
-      return if Digest::MD5.base64digest(object_for(key).data) == checksum
-
-      delete(key)
-      raise ActiveStorage::IntegrityError
-    end
-
     def retrieve_file(key)
       file = object_for(key)
-      raise(ActiveStorage::FileNotFoundError) unless file
+      raise ActiveStorage::FileNotFoundError unless file
 
       file.data
     end
 
     def object_for(key, fields: nil)
       comment = "DBService#object_for"
-      as_file = fields ? ::ActiveStorageDB::File.annotate(comment).select(*fields) : ::ActiveStorageDB::File
-      as_file.find_by(ref: key)
+      scope = ::ActiveStorageDB::File.annotate(comment)
+      scope = scope.select(fields) if fields
+      scope.find_by(ref: key)
     end
 
     def stream(key)
-      data_size = adapter_sqlserver? ? "DATALENGTH(data)" : "OCTET_LENGTH(data)"
-      size = object_for(key, fields: "#{data_size} AS size")&.size || raise(ActiveStorage::FileNotFoundError)
+      size = object_for(key, fields: data_size)&.size || raise(ActiveStorage::FileNotFoundError)
       (size / @chunk_size.to_f).ceil.times.each do |i|
         range = (i * @chunk_size)..(((i + 1) * @chunk_size) - 1)
         yield download_chunk(key, range)
       end
     end
 
+    def data_size
+      if adapter_sqlserver?
+        "DATALENGTH(data) AS size"
+      elsif adapter_sqlite?
+        "LENGTH(data) AS size"
+      else
+        "OCTET_LENGTH(data) AS size"
+      end
+    end
+
     def url_helpers
       @url_helpers ||= ::ActiveStorageDB::Engine.routes.url_helpers
     end

data/lib/active_storage/service/db_service_rails70.rb

@@ -6,11 +6,13 @@ module ActiveStorage
       buffer = nil
       comment = "DBService#compose"
       source_keys.each do |source_key|
-        data = ::ActiveStorageDB::File.annotate(comment).find_by!(ref: source_key).data
+        record = ::ActiveStorageDB::File.annotate(comment).select(:data).find_by(ref: source_key)
+        raise ActiveStorage::FileNotFoundError unless record
+
         if buffer
-          buffer << data
+          buffer << record.data
         else
-          buffer = +data
+          buffer = +record.data
         end
       end
       ::ActiveStorageDB::File.create!(ref: destination_key, data: buffer) if buffer

data/lib/active_storage_db/engine.rb

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
 module ActiveStorageDB
+  # :nocov:
+  UNPROCESSABLE_STATUS = if Rails::VERSION::MAJOR > 7 || (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR >= 1)
+                           :unprocessable_content
+                         else
+                           :unprocessable_entity
+                         end
+  # :nocov:
+
   class Engine < ::Rails::Engine
     isolate_namespace ActiveStorageDB
   end

data/lib/active_storage_db/version.rb

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

data/lib/tasks/active_storage_db_tasks.rake

@@ -5,22 +5,38 @@ module ActiveStorage
     module_function
 
     def print_blob_header(digits: 0)
-      puts ['Size'.rjust(8), 'Date'.rjust(18), 'Id'.rjust(digits + 2), '  Filename'].join
+      puts ["Size".rjust(8), "Date".rjust(18), "Id".rjust(digits + 2), "  Filename"].join
     end
 
     def print_blob(blob, digits: 0)
-      size = (blob.byte_size / 1024).to_s.rjust(7)
-      date = blob.created_at.strftime('%Y-%m-%d %H:%M')
-      puts "#{size}K  #{date}  #{blob.id.to_s.rjust(digits)}  #{blob.filename}"
+      size = format_size(blob.byte_size)
+      date = blob.created_at.strftime("%Y-%m-%d %H:%M")
+      puts "#{size}  #{date}  #{blob.id.to_s.rjust(digits)}  #{blob.filename}"
+    end
+
+    def format_size(bytes)
+      if bytes >= 1.gigabyte
+        "#{(bytes / 1.gigabyte.to_f).round(1)}G".rjust(8)
+      elsif bytes >= 1.megabyte
+        "#{(bytes / 1.megabyte.to_f).round(1)}M".rjust(8)
+      elsif bytes >= 1.kilobyte
+        "#{bytes / 1024}K".rjust(8)
+      else
+        "#{bytes}B".rjust(8)
+      end
     end
   end
 end
 
 namespace :asdb do
-  desc 'ActiveStorageDB: list attachments ordered by blob id desc'
-  task list: [:environment] do |_t, _args|
-    query = ActiveStorage::Blob.order(id: :desc).limit(100)
-    digits = query.ids.inject(0) { |ret, id| size = id.to_s.size; [size, ret].max }
+  desc "ActiveStorageDB: list attachments ordered by blob id desc"
+  task :list, [:count] => [:environment] do |_t, args|
+    count = (args[:count] || 100).to_i
+    query = ActiveStorage::Blob.order(id: :desc).limit(count)
+    digits = query.ids.inject(0) { |ret, id|
+      size = id.to_s.size
+      [size, ret].max
+    }
 
     ActiveStorage::Tasks.print_blob_header(digits: digits)
     query.each do |blob|
@@ -28,14 +44,14 @@ namespace :asdb do
     end
   end
 
-  desc 'ActiveStorageDB: download attachment by blob id'
+  desc "ActiveStorageDB: download attachment by blob id"
   task :download, [:blob_id, :destination] => [:environment] do |_t, args|
     blob_id = args[:blob_id]&.strip
     destination = args[:destination]&.strip || Dir.pwd
-    abort('Required arguments: source blob id, destination path') if blob_id.blank? || destination.blank?
+    abort("Required arguments: source blob id, destination path") if blob_id.blank? || destination.blank?
 
     blob = ActiveStorage::Blob.find_by(id: blob_id)
-    abort('Source file not found') unless blob
+    abort("Source file not found") unless blob
 
     destination = "#{destination}/#{blob.filename}" if Dir.exist?(destination)
     dir = File.dirname(destination)
@@ -45,20 +61,23 @@ namespace :asdb do
     puts "#{ret} bytes written - #{destination}"
   end
 
-  desc 'ActiveStorageDB: search attachment by filename (or part of it)'
+  desc "ActiveStorageDB: search attachment by filename (or part of it)"
   task :search, [:filename] => [:environment] do |_t, args|
     filename = args[:filename]&.strip
-    abort('Required arguments: filename') if filename.blank?
+    abort("Required arguments: filename") if filename.blank?
 
-    blobs = ActiveStorage::Blob.where('filename LIKE ?', "%#{filename}%").order(id: :desc)
+    blobs = ActiveStorage::Blob.where("filename LIKE ?", "%#{ActiveRecord::Base.sanitize_sql_like(filename)}%").order(id: :desc)
     if blobs.any?
-      digits = blobs.ids.inject(0) { |ret, id| size = id.to_s.size; [size, ret].max }
+      digits = blobs.ids.inject(0) { |ret, id|
+        size = id.to_s.size
+        [size, ret].max
+      }
       ActiveStorage::Tasks.print_blob_header(digits: digits)
       blobs.each do |blob|
         ActiveStorage::Tasks.print_blob(blob, digits: digits)
       end
     else
-      puts 'No results'
+      puts "No results"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_db
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Mattia Roccoberton