active_storage_db 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733afb3767f4174510cc6e59a72a5c6e137d17479fc6ec733a977ff81f80fbaf
-  data.tar.gz: dd7ffb266b99e6fbb2a0537b3d198a3e20200bc01dbdb43fe2407cd01161793d
+  metadata.gz: 23bbb0b9bf0759169020c1da8e4a8d5028938ffdb1b13dc4a356783da06eb868
+  data.tar.gz: 1e1e1146a363bba15efe440cd82fbc4926763596746995f8696c24ca9cb9789c
 SHA512:
-  metadata.gz: 4ef2822294d193dd86b6bf865602ec14f13e5868a418e2ad3685d9eaade829b302659634c4effebf495f63c63a96252da50a170ad0b2e3cb831243602e0cfdcd
-  data.tar.gz: 8b4e73f58bfcc0f3a840812757069be9ef9859585a3a9158721ede94885d014a2b507917fdc8e5a5da7e3f17c0ef90df7146958205aa88a07243471f3b44d118
+  metadata.gz: cc1229568804d8a6c1a0912f8ddcf59895d12374a57b460a6f29c8bce1aac7216c936b6b8c255ea41563f39b22c748e34645bac787da24886d9c02bcd367adb3
+  data.tar.gz: b85e8f1b41dfc2e01cfb566efd561a44606959cd1cb6b3a9cf718e4618b396949aad3fa87f8037ba61eda0789425bf9b4cf1031805d370c4702d2c973a5dfe5b

data/README.md

@@ -2,13 +2,13 @@
 
 [![gem version](https://badge.fury.io/rb/active_storage_db.svg)](https://badge.fury.io/rb/active_storage_db)
 [![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/postgres.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/postgres.yml)
-[![specs MySQL](https://github.com/blocknotes/active_storage_db/actions/workflows/mysql.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/mysql.yml)
+[![specs Postgres](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_70.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_postgres_70.yml)
+[![Specs MySQL](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_70.yml/badge.svg)](https://github.com/blocknotes/active_storage_db/actions/workflows/specs_mysql_70.yml)
 
 An Active Storage service upload/download plugin that stores files in a PostgreSQL or MySQL database.
 
 Main features:
-- supports Rails 6.0, 6.1 and 7.0;
+- supports Rails _6.0_, _6.1_ and _7.0_;
 - all service methods implemented;
 - attachment data stored in a binary field (or blob).
 
@@ -30,10 +30,16 @@ db:
 
 ## Misc
 
-Some rake tasks are available:
+Some utility tasks are available:
 
-- `asdb:list`: list the stored attachments
-- `asdb:get`: download an attachment (ex. `bin/rails "asdb:get[ruby-logo.png,/tmp]"`)
+```sh
+# list attachments ordered by blob id desc (with limit 100):
+bin/rails 'asdb:list'
+# search attachments by filename (or part of it)
+bin/rails 'asdb:search[some_filename]'
+# download attachment by blob id (retrieved with list or search tasks) - the second argument is the destination:
+bin/rails 'asdb:download[123,/tmp]'
+```
 
 ## Do you like it? Star it!
 

data/Rakefile

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

data/app/models/active_storage_db/file.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveStorageDB
-  class File < ApplicationRecord
+  class File < ActiveRecord::Base
     validates :ref,
               presence: true,
               allow_blank: false,

data/lib/active_storage/service/db_service.rb

@@ -1,9 +1,24 @@
 # 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'
+
 module ActiveStorage
-  class Service::DBService < Service # rubocop:disable Style/ClassAndModuleChildren
-    def initialize(**_config)
+  # Wraps a DB table as an Active Storage service. See ActiveStorage::Service
+  # for the generic API documentation that applies to all services.
+  class Service::DBService < Service
+    if Rails::VERSION::MAJOR >= 7
+      include ActiveStorage::DBServiceRails70
+    elsif Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR == 1
+      include ActiveStorage::DBServiceRails61
+    else
+      include ActiveStorage::DBServiceRails60
+    end
+
+    def initialize(public: false, **)
       @chunk_size = ENV.fetch('ASDB_CHUNK_SIZE') { 1.megabytes }
+      @public = public
     end
 
     def upload(key, io, checksum: nil, **)
@@ -22,7 +37,9 @@ module ActiveStorage
       else
         instrument :download, key: key do
           record = ::ActiveStorageDB::File.find_by(ref: key)
-          record&.data || raise(ActiveStorage::FileNotFoundError)
+          raise(ActiveStorage::FileNotFoundError) unless record
+
+          record.data
         end
       end
     end
@@ -30,14 +47,17 @@ module ActiveStorage
     def download_chunk(key, range)
       instrument :download_chunk, key: key, range: range do
         chunk_select = "SUBSTRING(data FROM #{range.begin + 1} FOR #{range.size}) AS chunk"
-        ::ActiveStorageDB::File.select(chunk_select).find_by(ref: key)&.chunk ||
-          raise(ActiveStorage::FileNotFoundError)
+        record = ::ActiveStorageDB::File.select(chunk_select).find_by(ref: key)
+        raise(ActiveStorage::FileNotFoundError) unless record
+
+        record.chunk
       end
     end
 
     def delete(key)
       instrument :delete, key: key do
         ::ActiveStorageDB::File.find_by(ref: key)&.destroy
+        # Ignore files already deleted
       end
     end
 
@@ -55,34 +75,6 @@ module ActiveStorage
       end
     end
 
-    def url(key, expires_in:, filename:, disposition:, content_type:)
-      instrument :url, key: key do |payload|
-        content_disposition = content_disposition_with(type: disposition, filename: filename)
-        verified_key_with_expiration = ActiveStorage.verifier.generate(
-          {
-            key: key,
-            disposition: content_disposition,
-            content_type: content_type
-          },
-          expires_in: expires_in,
-          purpose: :blob_key
-        )
-        current_uri = URI.parse(current_host)
-        generated_url = url_helpers.service_url(
-          verified_key_with_expiration,
-          protocol: current_uri.scheme,
-          host: current_uri.host,
-          port: current_uri.port,
-          disposition: content_disposition,
-          content_type: content_type,
-          filename: filename
-        )
-        payload[:url] = generated_url
-
-        generated_url
-      end
-    end
-
     def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
       instrument :url, key: key do |payload|
         verified_token_with_expiration = ActiveStorage.verifier.generate(
@@ -90,15 +82,16 @@ module ActiveStorage
             key: key,
             content_type: content_type,
             content_length: content_length,
-            checksum: checksum
+            checksum: checksum,
+            service_name: respond_to?(:name) ? name : 'db'
           },
           expires_in: expires_in,
           purpose: :blob_token
         )
-        generated_url = url_helpers.update_service_url(verified_token_with_expiration, host: current_host)
-        payload[:url] = generated_url
 
-        generated_url
+        url_helpers.update_service_url(verified_token_with_expiration, url_options).tap do |generated_url|
+          payload[:url] = generated_url
+        end
       end
     end
 
@@ -108,15 +101,29 @@ module ActiveStorage
 
     private
 
-    def current_host
-      if ActiveStorage::Current.respond_to? :url_options
-        opts = ActiveStorage::Current.url_options || {}
-        url = "#{opts[:protocol]}#{opts[:host]}"
-        url += ":#{opts[:port]}" if opts[:port]
-        url || ''
-      else
-        ActiveStorage::Current.host
-      end
+    def generate_url(key, expires_in:, filename:, content_type:, disposition:)
+      content_disposition = content_disposition_with(type: disposition, filename: filename)
+      verified_key_with_expiration = ActiveStorage.verifier.generate(
+        {
+          key: key,
+          disposition: content_disposition,
+          content_type: content_type,
+          service_name: respond_to?(:name) ? name : 'db'
+        },
+        expires_in: expires_in,
+        purpose: :blob_key
+      )
+
+      current_uri = URI.parse(current_host)
+      url_helpers.service_url(
+        verified_key_with_expiration,
+        protocol: current_uri.scheme,
+        host: current_uri.host,
+        port: current_uri.port,
+        disposition: content_disposition,
+        content_type: content_type,
+        filename: filename
+      )
     end
 
     def ensure_integrity_of(key, checksum)

data/lib/active_storage/service/db_service_rails60.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module DBServiceRails60
+    def url(key, expires_in:, filename:, disposition:, content_type:)
+      instrument :url, key: key do |payload|
+        generate_url(key, expires_in: expires_in, filename: filename, content_type: content_type, disposition: disposition).tap do |generated_url|
+          payload[:url] = generated_url
+        end
+      end
+    end
+
+    private
+
+    def current_host
+      url_options[:host]
+    end
+
+    def url_options
+      {
+        host: ActiveStorage::Current.host
+      }
+    end
+  end
+end

data/lib/active_storage/service/db_service_rails61.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module DBServiceRails61
+    private
+
+    def current_host
+      url_options[:host]
+    end
+
+    def private_url(key, expires_in:, filename:, content_type:, disposition:, **)
+      generate_url(
+        key,
+        expires_in: expires_in,
+        filename: filename,
+        content_type: content_type,
+        disposition: disposition
+      )
+    end
+
+    def public_url(key, filename:, content_type: nil, disposition: :attachment, **)
+      generate_url(
+        key,
+        expires_in: nil,
+        filename: filename,
+        content_type: content_type,
+        disposition: disposition
+      )
+    end
+
+    def url_options
+      {
+        host: ActiveStorage::Current.host
+      }
+    end
+  end
+end

data/lib/active_storage/service/db_service_rails70.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module DBServiceRails70
+    def compose(source_keys, destination_key, **)
+      buffer = nil
+      source_keys.each do |source_key|
+        data = ::ActiveStorageDB::File.find_by!(ref: source_key).data
+        if buffer
+          buffer << data
+        else
+          buffer = data
+        end
+      end
+      ::ActiveStorageDB::File.create!(ref: destination_key, data: buffer) if buffer
+    end
+
+    private
+
+    def current_host
+      opts = url_options || {}
+      url = "#{opts[:protocol]}#{opts[:host]}"
+      url + ":#{opts[:port]}" if opts[:port]
+    end
+
+    def private_url(key, expires_in:, filename:, content_type:, disposition:, **)
+      generate_url(
+        key,
+        expires_in: expires_in,
+        filename: filename,
+        content_type: content_type,
+        disposition: disposition
+      )
+    end
+
+    def public_url(key, filename:, content_type: nil, disposition: :attachment, **)
+      generate_url(
+        key,
+        expires_in: nil,
+        filename: filename,
+        content_type: content_type,
+        disposition: disposition
+      )
+    end
+
+    def url_options
+      ActiveStorage::Current.url_options
+    end
+  end
+end

data/lib/active_storage_db/version.rb

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

data/lib/tasks/active_storage_db_tasks.rake

@@ -1,31 +1,64 @@
 # frozen_string_literal: true
 
+module ActiveStorage
+  module Tasks
+    module_function
+
+    def print_blob_header(digits: 0)
+      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}"
+    end
+  end
+end
+
 namespace :asdb do
-  desc 'ActiveStorageDB: list attachments'
+  desc 'ActiveStorageDB: list attachments ordered by blob id desc'
   task list: [:environment] do |_t, _args|
-    ::ActiveStorage::Blob.order(:filename).pluck(:byte_size, :created_at, :filename).each do |size, dt, filename|
-      size_k = (size / 1024).to_s.rjust(7)
-      date = dt.strftime('%Y-%m-%d %H:%M')
-      puts "#{size_k}K  #{date}  #{filename}"
+    query = ::ActiveStorage::Blob.order(id: :desc).limit(100)
+    digits = Math.log(query.maximum(:id), 10).to_i + 1
+
+    ::ActiveStorage::Tasks.print_blob_header(digits: digits)
+    query.each do |blob|
+      ::ActiveStorage::Tasks.print_blob(blob, digits: digits)
     end
   end
 
-  desc 'ActiveStorageDB: download attachment'
-  task :get, [:src, :dst] => [:environment] do |_t, args|
-    src = args[:src]&.strip
-    dst = args[:dst]&.strip
-    abort('Required arguments: source file, destination file') if src.blank? || dst.blank?
-
-    dst = "#{dst}/#{src}" if Dir.exist?(dst)
-    dir = File.dirname(dst)
-    abort("Can't write on: #{dir}") unless File.writable?(dir)
+  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?
 
-    blob = ::ActiveStorage::Blob.order(created_at: :desc).find_by(filename: src)
+    blob = ::ActiveStorage::Blob.find_by(id: blob_id)
     abort('Source file not found') unless blob
 
-    ret = File.binwrite(dst, blob.download)
-    puts "#{ret} bytes written"
-  rescue StandardError => e
-    puts e
+    destination = "#{destination}/#{blob.filename}" if Dir.exist?(destination)
+    dir = File.dirname(destination)
+    abort("Can't write on path: #{dir}") unless File.writable?(dir)
+
+    ret = File.binwrite(destination, blob.download)
+    puts "#{ret} bytes written - #{destination}"
+  end
+
+  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?
+
+    blobs = ::ActiveStorage::Blob.where('filename LIKE ?', "%#{filename}%").order(id: :desc)
+    if blobs.any?
+      digits = Math.log(blobs.first.id, 10).to_i + 1
+      ::ActiveStorage::Tasks.print_blob_header(digits: digits)
+      blobs.each do |blob|
+        ::ActiveStorage::Tasks.print_blob(blob, digits: digits)
+      end
+    else
+      puts 'No results'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_db
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-26 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage
@@ -77,12 +77,14 @@ files:
 - README.md
 - Rakefile
 - app/controllers/active_storage_db/files_controller.rb
-- app/models/active_storage_db/application_record.rb
 - app/models/active_storage_db/file.rb
 - config/initializers/inflections.rb
 - config/routes.rb
 - db/migrate/20200702202022_create_active_storage_db_files.rb
 - lib/active_storage/service/db_service.rb
+- lib/active_storage/service/db_service_rails60.rb
+- lib/active_storage/service/db_service_rails61.rb
+- lib/active_storage/service/db_service_rails70.rb
 - lib/active_storage_db.rb
 - lib/active_storage_db/engine.rb
 - lib/active_storage_db/version.rb

data/app/models/active_storage_db/application_record.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveStorageDB
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end