stipa 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c13ca91809cf6a4b578b9336b9588f4f544055dab765021a54c822f55281291d
-  data.tar.gz: ac20150e5e8528532aebe21cf8f1b6354101cf6a92deeb1fe760cd813ef28841
+  metadata.gz: 007f691ff0ffe9eda4e751fe7d5839c71eaf1de64fbad49544c0e5e8cfc754df
+  data.tar.gz: e5f289efe22da0ec25c7e43c7a622d538de4a87f226b3e282d23b7f68c7bde06
 SHA512:
-  metadata.gz: 84e7a0fd600288d87b0ae3c69510028d39d89f4ce2da788624682b39a608b10b2c43fb071cfbbc59f95199c35376cb9acbf32e13d1cf12651fb40d2c39a0cbe0
-  data.tar.gz: 2097c4e81b7fc64049a4bb073c7f0ddb704c2e0916d2f0254214cfffbe904ad16b10b40ddaa1ecc0d16ed5a02b9cf8576b6fc6da511e96894c2ef2cc87b02b74
+  metadata.gz: d750ef8b7affa8b8446a6af38b5be1b11fec7526a7132c78f6857c8da99005c30d2811b378e77fe40b5168108b48e1bbe988362abc186f7eabc762b1887e0af5
+  data.tar.gz: 2f5994e2de25d2d2c0f5cd7c1f2561e3f0e1b597891585afb97d5f955edf5002f2eead41020564d0c8f6039a76e066ba60a513d0769db4c9ae2ae10b7d98a6b9

data/README.md

@@ -430,13 +430,19 @@ result[:records]     # => [#<User>, ...]
 result[:total]       # => 150
 result[:total_pages] # => 15
 
-# Soft delete
+# Soft delete (requires a `deleted_at` column)
 user.soft_delete
 user.deleted?       # => true
-User.all            # => excludes soft-deleted
-User.with_deleted   # => includes all
-User.only_deleted   # => soft-deleted only
 user.restore
+
+# Scopes
+User.dataset.deleted       # => WHERE (deleted_at IS NOT NULL)
+User.dataset.not_deleted   # => WHERE (deleted_at IS NULL)
+
+# To exclude soft-deleted records by default, override dataset:
+#   def self.dataset
+#     super.not_deleted
+#   end
 ```
 
 ---

data/lib/stipa/model/soft_delete.rb

@@ -1,5 +1,35 @@
 module Stipa
   module Model
+    # Soft delete support for Sequel models.
+    #
+    # Provides `soft_delete`, `restore`, and `deleted?` instance methods,
+    # plus `deleted` and `not_deleted` dataset scopes.
+    #
+    # Your table must have a nullable `deleted_at` timestamp column.
+    #
+    #   # db/migrate/001_create_posts.rb
+    #   create_table :posts do
+    #     primary_key :id
+    #     DateTime :deleted_at
+    #     # ...
+    #   end
+    #
+    # ==== Opt into the default scope
+    #
+    # By default, soft-deleted rows are NOT filtered from queries.
+    # To exclude them automatically, override `dataset` in your model:
+    #
+    #   class Post < ApplicationModel
+    #     def self.dataset
+    #       super.not_deleted
+    #     end
+    #   end
+    #
+    #   Post.where(title: "foo")  # => WHERE (deleted_at IS NULL) AND (title = 'foo')
+    #
+    # Without the override, include records as usual:
+    #
+    #   Post.where(title: "foo")  # => WHERE (title = 'foo')
     module SoftDelete
       def self.included(base)
         base.instance_eval do
@@ -12,21 +42,25 @@ module Stipa
               where(deleted_at: nil)
             end
           end
-
-          def self.dataset
-            super.not_deleted
-          end
         end
       end
 
+      # Mark the record as soft-deleted.
+      #
+      #   post.soft_delete        # sets deleted_at = now
+      #   post.soft_delete        # no-op (already deleted)
       def soft_delete
         update(deleted_at: Time.now.utc)
       end
 
+      # Restore a soft-deleted record.
+      #
+      #   post.restore            # sets deleted_at = nil
       def restore
         update(deleted_at: nil)
       end
 
+      # Returns +true+ if the record has been soft-deleted.
       def deleted?
         !deleted_at.nil?
       end

data/lib/stipa/version.rb

@@ -1,3 +1,3 @@
 module Stipa
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stipa
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Jānis Harbs