concerns_on_rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0679c4f78651169ae85fbf3f27d0a301d6ca33c148eb3e01c766252145c5be4c'
-  data.tar.gz: cec6963e3ba583e9072b03de751adbd1362dc100b041d5addf8cb37ebacd1d41
+  metadata.gz: 8810e1d51d69ba3de04b06ec9f372aca86611a0ac555b0d0652284680b35d37a
+  data.tar.gz: d6d8d480ffac223059af1942c0161ab7eff86b6af5320852838a2e5c0c9e3611
 SHA512:
-  metadata.gz: c2ffaa1b86bd6c7952857c88e326009a85699bb77364e0b42e6cd8bfa11614917c3cf2fbae94af08bf2262210968878b65c37b22856bb8bac95345d81533fa57
-  data.tar.gz: e387756b366d70efff292dd40b1a8cf34dfeb04321140c2e4e03833c754975afb1686df499fd6ddefc4e83e7c7347851e62c1bc2a8f7d1f9e51d0c7f3cae50ca
+  metadata.gz: fdc35dc31371b5bef4f0897494250778dcb794598136c21db6d33db5b165a0fc95151c2939ee610312249e3a6012738e0041673ce592846515eaa38b0a8dd453
+  data.tar.gz: b9704d4368ba22504f7b2bf6081832fd2e4a6014f74ea9a88abc73ab55dc0e4af07cc89d09cff6442d59357fa0907503eb19900e4165ef241e5183527e1b512f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 <!-- CHANGELOG.md -->
 
+## 1.1.0 (2025-04-17)
+
+### Added
+- SoftDeletable: Add soft delete concern with configurable field, scopes, callbacks, and default_scope support
+
 ## 1.0.0 (2025-04-12)
 
 ### Added

data/README.md

@@ -1,18 +1,19 @@
-# ConcernsOnRails
+# 🧩 ConcernsOnRails
 
-**Note: Hoàng Sa and Trường Sa belong to Việt Nam.** 🇻🇳
+**🇻🇳 Note: Hoàng Sa and Trường Sa belong to Việt Nam.**
 
 A simple collection of reusable Rails concerns to keep your models clean and DRY.
 
-## Features
+## ✨ Features
 
 - ✅ `Sluggable`: Generate friendly slugs from a specified field
-- ✅ `Sortable`: Sort records based on a field using `acts_as_list`, with flexible sorting field and direction
-- ✅ `Publishable`: Easily manage published/unpublished records using a simple `published_at` field
+- 🔢 `Sortable`: Sort records based on a field using `acts_as_list`, with flexible sorting field and direction
+- 📤 `Publishable`: Easily manage published/unpublished records using a simple `published_at` field
+- ❌ `SoftDeletable`: Soft delete records using a configurable timestamp field (e.g., `deleted_at`) with automatic scoping
 
 ---
 
-## Installation
+## 📦 Installation
 
 Add this line to your application's Gemfile:
 
@@ -28,9 +29,9 @@ bundle install
 
 ---
 
-## Usage
+## 🚀 Usage
 
-### 1. Sluggable
+### 1. 📝 Sluggable
 
 Add slugs based on a specified attribute.
 
@@ -49,7 +50,7 @@ If the slug source is changed, the slug will auto-update.
 
 ---
 
-### 2. Sortable
+### 2. 🔢 Sortable
 
 Use for models that need ordering.
 
@@ -76,16 +77,16 @@ end
 ```
 
 Additional features:
-- Automatically sets `acts_as_list` on the configured column
-- Adds default sorting scope to your model
-- Supports custom direction: `:asc` or `:desc`
-- Validates that the sortable field exists in the table schema
-- Compatible with scopes and ActiveRecord queries
-- Can be reconfigured dynamically within the model using `sortable_by`
+- 📌 Automatically sets `acts_as_list` on the configured column
+- 📋 Adds default sorting scope to your model
+- ↕️ Supports custom direction: `:asc` or `:desc`
+- 🔍 Validates that the sortable field exists in the table schema
+- 🧠 Compatible with scopes and ActiveRecord queries
+- 🔄 Can be reconfigured dynamically within the model using `sortable_by`
 
 ---
 
-### 3. Publishable
+### 3. 📤 Publishable
 
 Manage published/unpublished records using a `published_at` field.
 
@@ -108,17 +109,51 @@ article.published? # => false
 ```
 
 Additional features:
-- `published?` returns true if `published_at` is present and in the past
-- `publish!` sets `published_at` to current time
-- `unpublish!` sets `published_at` to `nil`
-- Add scopes: `.published`, `.unpublished`, and a default scope (optional)
-- Ideal for blog posts, articles, or any content that toggles visibility
-- Lightweight and non-invasive
-- Easy to test and override in custom implementations
+- ✅ `published?` returns true if `published_at` is present and in the past
+- 🕒 `publish!` sets `published_at` to current time
+- 🚫 `unpublish!` sets `published_at` to `nil`
+- 🔎 Add scopes: `.published`, `.unpublished`, and a default scope (optional)
+- 📰 Ideal for blog posts, articles, or any content that toggles visibility
+- 🧩 Lightweight and non-invasive
+- 🧪 Easy to test and override in custom implementations
 
 ---
 
-## Development
+### 4. ❌ SoftDeletable
+
+Soft delete records using a timestamp field (default: `deleted_at`).
+
+```ruby
+class User < ApplicationRecord
+  include ConcernsOnRails::SoftDeletable
+
+  soft_deletable_by :deleted_at
+end
+
+user = User.create!(name: "Alice")
+user.soft_delete!
+user.deleted? # => true
+
+User.without_deleted   # => returns only active users
+User.soft_deleted      # => returns soft-deleted users
+User.all               # => returns only non-deleted by default (default_scope applied)
+
+user.restore!
+user.deleted? # => false
+```
+
+Additional features:
+- Default field is `deleted_at`, can be configured
+- Automatically applies `default_scope` to hide soft-deleted records
+- Scopes: `without_deleted`, `soft_deleted`, `active`
+- Methods: `soft_delete!`, `restore!`, `deleted?`, `really_delete!`
+- Callbacks: `before_soft_delete`, `after_soft_delete`, `before_restore`, `after_restore`
+- Touch support when soft deleting or restoring (can be turned off)
+- Aliases for `deleted?`: `soft_deleted?`, `is_soft_deleted?`
+
+---
+
+## 🛠️ Development
 
 To build the gem:
 
@@ -134,13 +169,13 @@ gem install ./concerns_on_rails-1.0.0.gem
 
 ---
 
-## Contributing
+## 🤝 Contributing
 
 Bug reports and pull requests are welcome!
 
 ---
 
-## License
+## 📄 License
 
 This project is licensed under the MIT License.
 
@@ -150,11 +185,11 @@ This project is licensed under the MIT License.
 
 ---
 
-### 📦 Source Code
+### 🔗 Source Code
 
 The source code is available on GitHub:
 
-🔗 [https://github.com/VSN2015/concerns_on_rails](https://github.com/VSN2015/concerns_on_rails)
+[👉 https://github.com/VSN2015/concerns_on_rails](https://github.com/VSN2015/concerns_on_rails)
 
 Feel free to star ⭐️, fork 🍴, or contribute with issues and PRs.
 

data/lib/concerns_on_rails/publishable.rb

@@ -7,7 +7,7 @@ module ConcernsOnRails
     # instance methods
     included do
       # declare class attributes and set default values
-      class_attribute :publishable_field
+      class_attribute :publishable_field, instance_accessor: false
       self.publishable_field ||= :published_at
     end
 

data/lib/concerns_on_rails/sluggable.rb

@@ -8,7 +8,7 @@ module ConcernsOnRails
     # instance methods
     included do
       # declare class attributes and set default values
-      class_attribute :sluggable_field
+      class_attribute :sluggable_field, instance_accessor: false
       self.sluggable_field ||= :name
 
       extend FriendlyId

data/lib/concerns_on_rails/soft_deletable.rb

@@ -0,0 +1,103 @@
+require "active_support/concern"
+
+module ConcernsOnRails
+  module SoftDeletable
+    extend ActiveSupport::Concern
+
+    included do
+      # declare class attributes and set default values
+      class_attribute :soft_delete_field, instance_accessor: false, default: :deleted_at
+      class_attribute :soft_delete_touch, instance_accessor: false, default: true
+      
+      # scopes
+      scope :active, -> { unscope(where: soft_delete_field).where(soft_delete_field => nil) }
+      scope :without_deleted, -> { unscope(where: soft_delete_field).where(soft_delete_field => nil) }
+      scope :soft_deleted, -> { unscope(where: soft_delete_field).where.not(soft_delete_field => nil) }
+      # Optionally, uncomment to hide deleted by default:
+      default_scope { without_deleted }
+
+      # define callbacks
+      define_model_callbacks :soft_delete
+      define_model_callbacks :restore
+    end
+
+    class_methods do
+      # Define soft delete field and options
+      # Example:
+      #   soft_deletable_by :deleted_at, touch: false
+      def soft_deletable_by(field = nil, touch: true)
+        self.soft_delete_field = field || :deleted_at
+        self.soft_delete_touch = touch
+
+        unless column_names.include?(soft_delete_field.to_s)
+          raise ArgumentError, "ConcernsOnRails::SoftDeletable: soft_delete_field '#{soft_delete_field}' does not exist in the database"
+        end
+      end
+    end
+
+    # Soft delete hooks
+    def before_soft_delete; end
+    def after_soft_delete; end
+    def before_restore; end
+    def after_restore; end
+
+    # add soft delete methods
+    def soft_delete!
+      return true if deleted?
+      run_callbacks(:soft_delete) do
+        before_soft_delete
+        if self.class.soft_delete_touch
+          update(self.class.soft_delete_field => Time.zone.now).tap do |result|
+            touch if respond_to?(:touch)
+            after_soft_delete if result
+          end
+        else
+          update_column(self.class.soft_delete_field, Time.zone.now).tap do |result|
+            after_soft_delete if result
+          end
+        end
+      end
+    end
+
+    # really delete the record
+    def really_delete!
+      destroy
+    end
+  
+    def restore!
+      run_callbacks(:restore) do
+        before_restore
+        if self.class.soft_delete_touch
+          update(self.class.soft_delete_field => nil).tap do |result|
+            touch if respond_to?(:touch)
+            after_restore if result
+          end
+        else
+          update_column(self.class.soft_delete_field, nil).tap do |result|
+            after_restore if result
+          end
+        end
+      end
+    end
+  
+    def deleted?
+      self[self.class.soft_delete_field].present?
+    end
+
+    # alias methods
+    # define here to avoid issue: undefined method `deleted?' for module `ConcernsOnRails::SoftDeletable'
+    alias_method :is_soft_deleted?, :deleted?
+    alias_method :soft_deleted?, :deleted?
+
+    # Is really deleted?
+    def is_really_deleted?
+      !self.class.exists?(id)
+    end
+  end
+end
+
+# Usage Example:
+# class MyModel < ApplicationRecord
+#   include ConcernsOnRails::SoftDeletable
+#   soft_deletable_by :deleted_at
+# end

data/lib/concerns_on_rails/sortable.rb

@@ -14,8 +14,8 @@ module ConcernsOnRails
     #   end
     included do
       # declare class attributes
-      class_attribute :sortable_field
-      class_attribute :sortable_direction
+      class_attribute :sortable_field, instance_accessor: false
+      class_attribute :sortable_direction, instance_accessor: false
 
       # set default values
       self.sortable_field ||= :position

data/lib/concerns_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ConcernsOnRails
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/concerns_on_rails.rb

@@ -3,6 +3,7 @@ require "concerns_on_rails/version"
 require "concerns_on_rails/sortable"
 require "concerns_on_rails/publishable"
 require "concerns_on_rails/sluggable"
+require "concerns_on_rails/soft_deletable"
 
 module ConcernsOnRails
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concerns_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ethan Nguyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-12 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,7 @@ files:
 - lib/concerns_on_rails.rb
 - lib/concerns_on_rails/publishable.rb
 - lib/concerns_on_rails/sluggable.rb
+- lib/concerns_on_rails/soft_deletable.rb
 - lib/concerns_on_rails/sortable.rb
 - lib/concerns_on_rails/version.rb
 homepage: https://github.com/VSN2015/concerns_on_rails