shrine-sql 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5e95896227d7a62239867ee5c393272e57ec2db
-  data.tar.gz: 9fc7dde76117e7334d0a8ea72c3c450d3456804a
+  metadata.gz: 52da0b029e5c8f837c30bdcf7970fb542b5af9f6
+  data.tar.gz: e0ffe4c625cbe7e0ead2479556b1e37ff3aa4c76
 SHA512:
-  metadata.gz: 0be11d1b596031bac04bca0a557320975abbef0338b20a9ece8371bf37bbbd07c7d2986ce69295d984c704bf14a2353fd5c39727e4e3fdda0f49de2eaf324071
-  data.tar.gz: 4f2d7b7c03e6d8490849066136ae3c137c53c2dd819e36c8c7eba757a4bbfeeb64dc238ced29326ea7dbf875b85775e13abfdf26ffd7905ef801c3cca1b85886
+  metadata.gz: afea505dc65f6ea8388118bb82a25ebd27ddaff8070ac1b71df4fd85f1d1f9c15ea1f256df845281076b4e7df034e019c459458325405c31d4de4de42d80ec87
+  data.tar.gz: 959729709cbdd3807b96b17cbb2c4327f35717122c1e265ff930c36793bf767c1d3b0f465bd6d694437012dd38013846c0f058e843de6d2f68f04ec74aeba230

data/README.md

@@ -19,8 +19,9 @@ Sequel.migration do
   change do
     create_table :files do
       primary_key :id
-      column :content, :blob # :bytea for PostgreSQL
-      column :metadata, :text # :varchar
+      File :content
+      String :metadata, text: true
+      Time :created_at
     end
   end
 end
@@ -32,6 +33,7 @@ class CreateFiles < ActiveRecord::Migration
     create_table :files do |t|
       t.binary :content
       t.text :metadata
+      t.datetime :created_at
     end
   end
 end
@@ -45,7 +47,7 @@ require "shrine/storage/sql"
 require "sequel"
 
 DB = Sequel.connect("postgres:///my-database")
-Shrine.storages[:store] = Shrine::Storage::Sql.new(database: DB, table: :files)
+Shrine::Storage::Sql.new(database: DB, table: :files)
 ```
 
 You can see [Connecting to a database] on how connect to any database with
@@ -62,7 +64,7 @@ Shrine.plugin :download_endpoint, storages: [:store]
 ```
 ```rb
 Rails.application.routes.draw do
-  mount Shrine::DownloadEndpoint => "/attachments"
+  mount Shrine.download_endpoint => "/attachments"
 end
 ```
 ```rb
@@ -80,6 +82,22 @@ If you're using the SQL storage for both cache and store, moving from cache to
 store will copy the record using SQL instead "reuploading" it, which means the
 file contents won't be read into memory.
 
+## Clearing
+
+You can delete all data from the storage via `Shrine::Storage::Sql#clear!`:
+
+```rb
+sql = Shrine::Storage::Sql.new(database: DB, table: :files)
+sql.clear!
+```
+
+If you're using SQL as temporary storage, you can clear old files by passing
+a block to `#clear!` and querying the `created_at` column:
+
+```rb
+sql.clear! { |dataset| dataset.where{created_at < Time.now - 7*24*60*60} }
+```
+
 ## Contributing
 
 You can run the tests with Rake:

data/lib/shrine/storage/sql.rb

@@ -7,11 +7,11 @@ require "json"
 class Shrine
   module Storage
     class Sql
-      attr_reader :database, :dataset
+      attr_reader :database, :table
 
       def initialize(database:, table:)
         @database = database
-        @dataset = @database[table]
+        @table    = table
       end
 
       def upload(io, id, **options)
@@ -39,9 +39,15 @@ class Shrine
       end
 
       def clear!
+        dataset = self.dataset
+        dataset = yield dataset if block_given?
         dataset.delete
       end
 
+      def dataset
+        database[table]
+      end
+
       protected
 
       def find(id_or_ids)
@@ -59,13 +65,20 @@ class Shrine
         end
       end
 
-      def insert(io, id, shrine_metadata: {})
-        dataset.insert(content: Sequel::SQL::Blob.new(io.read), metadata: shrine_metadata.to_json)
+      def insert(io, id, shrine_metadata: {}, **options)
+        record = {}
+        record[:content]    = Sequel::SQL::Blob.new(io.read)
+        record[:metadata]   = shrine_metadata.to_json
+        record[:created_at] = Sequel::CURRENT_TIMESTAMP if database.schema(table).assoc(:created_at)
+
+        dataset.insert(record)
       end
 
-      def copy(io, id, shrine_metadata: {})
-        record = io.storage.find(io.id).select(:content, :metadata)
-        dataset.insert([:content, :metadata], record)
+      def copy(io, id, shrine_metadata: {}, **options)
+        record_dataset = io.storage.find(io.id).select(:content, :metadata)
+        record_dataset = record_dataset.select_append(Sequel::CURRENT_TIMESTAMP.as(:created_at)) if database.schema(table).assoc(:created_at)
+
+        dataset.insert(record_dataset.columns, record_dataset)
       end
 
       def copyable?(io, id)

data/shrine-sql.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-sql"
-  gem.version       = "2.0.0"
+  gem.version       = "2.1.0"
 
   gem.required_ruby_version = ">= 2.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-sql
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine