sequel-soft-destroy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307895206c73cd43079f99c83aa643c391e22f4a
+  data.tar.gz: f43efe87305c17b7ace9e8723ff0dd8858d17cde
+SHA512:
+  metadata.gz: cb2b4aa7829f6a8bd4393c789b5da914821e13a09f75b00c707cbdbce414383651a515d9226132a79f26fea0858731f62a3c4c3adbb5090fd10c8f223e40a73b
+  data.tar.gz: 54785dfdf8ea36aba9de166a8a6185842f0077cc24f6089b7f6fbfcb6153ffee91a52f4934f50c6021b320408d70f81a1c85d359a57b0972b6e37ca2ffef3f9e

data/README.md

@@ -0,0 +1,56 @@
+[![Build Status](https://travis-ci.org/fsaravia/sequel-soft-destroy.svg?branch=master)](https://travis-ci.org/fsaravia/sequel-soft-destroy)
+
+# Sequel SoftDestroy plugin
+
+`Sequel::Plugins::SoftDestroy` is a simple and opinionated Sequel plugin that provides soft delete capabilities.
+
+This gem avoids dealing with Sequel internals and relies on models having a `deleted_at` column. When a model is soft deleted, a timestamp will be added to the `deleted_at` field, which marks it as deleted and also stores the UTC time in which the model was deleted. This is useful if any unique constraints have to be observed in your application.
+
+## Usage
+
+```ruby
+class Foo < Sequel::Model
+  plugin :soft_destroy
+end
+```
+
+When you want to soft delete a model, just call `soft_destroy` on it:
+
+```ruby
+foo = Foo.create(name: "foo")
+
+foo.deleted? #=> false
+
+foo.soft_destroy
+
+foo.deleted? #=> true
+```
+
+This library also provides convenience methods to filter out deleted items:
+
+```ruby
+foo_1 = Foo.create(name: "foo 2")
+foo_2 = Foo.create(name: "foo 1")
+
+foo_1.soft_destroy
+
+Foo[foo_1.id] #=> nil
+
+Foo.filter_deleted.all #=> [foo_2]
+```
+
+If you ever need to recover a deleted mode, just call `recover`:
+
+```ruby
+foo = Foo.create(name: "foo")
+
+foo.deleted? #=> false
+
+foo.soft_destroy
+
+foo.deleted? #=> true
+
+foo.recover
+
+foo.deleted? #=> false
+```

data/lib/sequel/plugins/soft_destroy.rb

@@ -0,0 +1,41 @@
+require "sequel"
+
+module Sequel
+  module Plugins
+    module SoftDestroy
+      DELETED_AT_COLUMN = :deleted_at
+
+      module ClassMethods
+        Sequel::Plugins.def_dataset_methods(self, :filter_deleted)
+
+        def [](*args)
+          model = super
+
+          return if model.nil? || model.deleted?
+
+          model
+        end
+      end
+
+      module DatasetMethods
+        def filter_deleted
+          where(DELETED_AT_COLUMN => nil)
+        end
+      end
+
+      module InstanceMethods
+        def soft_destroy
+          update(DELETED_AT_COLUMN => Time.now.utc)
+        end
+
+        def recover
+          update(DELETED_AT_COLUMN => nil)
+        end
+
+        def deleted?
+          !values[DELETED_AT_COLUMN].nil?
+        end
+      end
+    end
+  end
+end

data/sequel-soft-destroy.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name     = "sequel-soft-destroy"
+  s.author   = "Federico Saravia"
+  s.email    = "fedesaravia@gmail.com"
+  s.version  = "0.0.1"
+  s.summary  = "A simple Sequel plugin that provides soft delete capabilities."
+  s.homepage = "https://github.com/fsaravia/sequel-soft-destroy"
+  s.license  = "MIT"
+  s.files    = Dir[
+                 "README.md",
+                 "lib/**/*.rb",
+                 "*.gemspec",
+                 "test/*.*"
+                ]
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require "sequel"
+require "minitest/autorun"
+
+DB = Sequel.sqlite
+
+DB.create_table(:foos) do
+  primary_key :id
+
+  column :name,       :text
+  column :deleted_at, :integer
+end
+
+class SoftDestroyTest < Minitest::Test
+  def run
+    Sequel::Model.db.transaction(rollback: :always, auto_savepoint: true) do
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: sequel-soft-destroy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Federico Saravia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: fedesaravia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sequel/plugins/soft_destroy.rb
+- sequel-soft-destroy.gemspec
+- test/helper.rb
+homepage: https://github.com/fsaravia/sequel-soft-destroy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A simple Sequel plugin that provides soft delete capabilities.
+test_files: []