solid_storage 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8f89a01c7211be77a1c7dcb74fe3480c419161a94da0361cbfbd41744e5cdfd
-  data.tar.gz: 479ad5ec90754640e64e0f42d75ca8368bb2b6f5c84af394354a1fef7ce8a655
+  metadata.gz: 6f29e810e3124c7c0a9ddded239f3c6bceceb2d17250b88be373d1e4d65f3651
+  data.tar.gz: d3c128af2302982769861e8209e39971847e80a59c1a0fa9424ff54335c7bada
 SHA512:
-  metadata.gz: adc433251f4bdf44454cdc0b541977f909786969beef04c056d96ec6da171852c1c2f695b68a56750f5416273ff83161619c73742aebfa44859769c639875cf0
-  data.tar.gz: 00cab3fcf0359e82363a7f6251f116bd98c4b3699f8ba183982c8739333a1c1ca73cd392dffa8fea5aa361a82dc9d73fe93ae498ea2ac4f71bdd8e9c469f82f6
+  metadata.gz: d3b8b123763db97b19569e26e5e1d28762996e401376d8d04e2fa1f85792c691cc5253a9b68ef3a8ca685432ae0418b80d7f3c69771315c00ce12c85f33cdc63
+  data.tar.gz: a444670a5d38d8c62ae2cd000a290ddebd515341f95aceff6039b030ecf896161d211572e0122d66cbd183944289124c46b720b909ac618e75ed921a974ff533

data/README.md

@@ -1,7 +1,19 @@
 # Solid Storage
 
-Active Storage service adapter that stores blobs in the database and serves
-them using X-Sendfile.
+Solid Storage is an Active Storage service adapter that stores blobs in the
+database and serves them using X-Sendfile and adheres to the Active Storage
+service contract.
+
+## Why?
+
+S3, Azure, R2, GCS all cost money. When starting out and trying to keep costs
+low, storing files in the database is just fine. So why not just use the disk
+adapter? The disk adapter only works if you are on a single server, and if you
+are on a single server, the disk adapter can be cumbersome to backup. With
+data in the database, it is easy to backup by incorporating into your current
+database backup process. Having your files easily backup-able will also make
+your app more portable. Solid Storage also uses X-Sendfile just like the disk
+adapter so you get all the upside of the disk adapter.
 
 ## Installation
 
@@ -10,5 +22,51 @@ them using X-Sendfile.
 
 This will configure Solid Storage as an Active Storage adapter by overwritting `config/storage.yml`, create `db/storage_schema.rb`, and set the production adapter to `:solid_storage`.
 
+You will then have to add the configuration for the storage database in `config/database.yml`. If you're using SQLite, it'll look like this:
+
+```yaml
+production:
+  primary:
+    <<: *default
+    database: storage/production.sqlite3
+  storage:
+    <<: *default
+    database: storage/production_strorage.sqlite3
+    migrations_paths: db/storage_migrate
+```
+
+...or if you're using MySQL/PostgreSQL/Trilogy:
+
+```yaml
+production:
+  primary: &primary_production
+    <<: *default
+    database: app_production
+    username: app
+    password: <%= ENV["APP_DATABASE_PASSWORD"] %>
+  cable:
+    <<: *primary_production
+    database: app_production_storage
+    migrations_paths: db/storage_migrate
+```
+
+Then run `db:prepare` in production to ensure the database is created and the schema is loaded.
+
+It's also recommended to move Active Storage models into the `storage` database
+as well by adding an initializer:
+```ruby
+ActiveSupport.on_load(:active_storage_record) do
+  connects_to(database: { writing: :storage })
+end
+```
+
+## Configuration
+
+Options are set with `config.solid_storage`.
+
+The options are:
+
+- `connects_to` - set the Active Record database configuration for the Solid Storage models. All options available in Active Record can be used here.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/solid_storage/files_controller.rb

@@ -5,7 +5,9 @@ class SolidStorage::FilesController < ActiveStorage::DiskController
 
   def show
     if key = decode_verified_key
-      @file = named_disk_service(key[:service_name]).find(key[:key])
+      service = named_disk_service(key[:service_name])
+      @file = service.find(key[:key])
+      response.headers["Cache-Control"] = service.cache_control if service.cache_control
       serve_file @file.tempfile, content_type: key[:content_type],
         disposition: key[:disposition]
     else

data/lib/active_storage/service/solid_storage_service.rb

@@ -2,10 +2,13 @@ require "active_storage/service"
 
 module ActiveStorage
   class Service::SolidStorageService < ::ActiveStorage::Service
-    def initialize(public: false, **options)
+    def initialize(public: false, cache_control: nil, **options)
       @public = public
+      @cache_control = cache_control
     end
 
+    attr_reader :cache_control
+
     def find(key)
       SolidStorage::File.find_by!(key:)
     end

data/lib/solid_storage/engine.rb

@@ -1,5 +1,13 @@
 module SolidStorage
   class Engine < ::Rails::Engine
     isolate_namespace SolidStorage
+
+    config.solid_storage = ActiveSupport::OrderedOptions.new
+
+    initializer "solid_storage.config" do
+      config.solid_storage.each do |name, value|
+        SolidStorage.public_send(:"#{name}=", value)
+      end
+    end
   end
 end

data/lib/solid_storage/version.rb

@@ -1,3 +1,3 @@
 module SolidStorage
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: solid_storage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Nick Pezza
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -82,7 +81,6 @@ metadata:
   homepage_uri: http://github.com/npezza93/solid_storage
   source_code_uri: http://github.com/npezza93/solid_storage
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Database-backed Active Storage adapter.
 test_files: []