concerns_on_rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8810e1d51d69ba3de04b06ec9f372aca86611a0ac555b0d0652284680b35d37a
-  data.tar.gz: d6d8d480ffac223059af1942c0161ab7eff86b6af5320852838a2e5c0c9e3611
+  metadata.gz: 603d571510be78d62d3d71f071b703dbf70bf505e6463e1766e4a99c4c039012
+  data.tar.gz: eefa6a75c74a0ff0db01e129cc85c73af7ae3b16fb38c2ceab757ff5fc1e2656
 SHA512:
-  metadata.gz: fdc35dc31371b5bef4f0897494250778dcb794598136c21db6d33db5b165a0fc95151c2939ee610312249e3a6012738e0041673ce592846515eaa38b0a8dd453
-  data.tar.gz: b9704d4368ba22504f7b2bf6081832fd2e4a6014f74ea9a88abc73ab55dc0e4af07cc89d09cff6442d59357fa0907503eb19900e4165ef241e5183527e1b512f
+  metadata.gz: 01b37a0a698df95131be947ebc0874c970dc1f4cadf591aca2de84b1bc4da8075967cc5d469a45713165d07c763e55c7296b34a621248bffa82e7af127c5b5b0
+  data.tar.gz: e0978b66b4208ef653563602e9b153f10f56867cd2ad821ae8323f12fad8eff9c917127f64ae567a0ffa62945b562c5244aed72e743419e47a22a1de8f121ad1

data/README.md

@@ -127,29 +127,70 @@ Soft delete records using a timestamp field (default: `deleted_at`).
 class User < ApplicationRecord
   include ConcernsOnRails::SoftDeletable
 
-  soft_deletable_by :deleted_at
+  # Optional: customize field and touch behavior
+  soft_deletable_by :deleted_at, touch: true
 end
+```
 
-user = User.create!(name: "Alice")
-user.soft_delete!
-user.deleted? # => true
-
+#### Scopes
+```ruby
 User.without_deleted   # => returns only active users
 User.soft_deleted      # => returns soft-deleted users
+User.active            # => same as without_deleted
 User.all               # => returns only non-deleted by default (default_scope applied)
+```
+
+#### Soft delete and restore
+```ruby
+user.soft_delete!      # Soft delete the user (sets deleted_at)
+user.deleted?          # => true
+user.soft_deleted?     # => true (alias)
+user.is_soft_deleted?  # => true (alias)
 
-user.restore!
-user.deleted? # => false
+user.restore!          # Restore the user (sets deleted_at to nil)
+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)
+#### Permanently delete
+```ruby
+user.really_delete!    # Hard delete the record from DB
+```
+
+#### Soft delete/hard delete all records
+```ruby
+User.destroy_all           # Soft delete all users (sets deleted_at)
+User.really_destroy_all    # Hard delete ALL users (removes from DB)
+```
+
+#### Callbacks (Hooks)
+You can use the following hooks to run logic before/after soft delete or restore:
+```ruby
+class User < ApplicationRecord
+  include ConcernsOnRails::SoftDeletable
+
+  def before_soft_delete
+    # Code to run before soft delete
+  end
+
+  def after_soft_delete
+    # Code to run after soft delete
+  end
+
+  def before_restore
+    # Code to run before restore
+  end
+
+  def after_restore
+    # Code to run after restore
+  end
+end
+```
+
+#### Notes
+- Default field is `deleted_at`, can be changed with `soft_deletable_by :your_field`
+- `touch: false` to skip updating updated_at when soft deleting/restoring
 - Aliases for `deleted?`: `soft_deleted?`, `is_soft_deleted?`
+- All scopes and methods work seamlessly with ActiveRecord
 
 ---
 

data/lib/concerns_on_rails/publishable.rb

@@ -4,28 +4,22 @@ module ConcernsOnRails
   module Publishable
     extend ActiveSupport::Concern
 
-    # instance methods
     included do
-      # declare class attributes and set default values
-      class_attribute :publishable_field, instance_accessor: false
-      self.publishable_field ||= :published_at
+      class_attribute :publishable_field, instance_accessor: false, default: :published_at
+
+      scope :published, -> { where(arel_table[publishable_field].lteq(Time.zone.now)) }
+      scope :unpublished, -> {
+        where(arel_table[publishable_field].eq(nil).or(arel_table[publishable_field].gt(Time.zone.now)))
+      }
     end
 
-    # class methods
     class_methods do
-      # Define publishable field
-      # Example:
-      #   publishable_by :published_at
       def publishable_by(field = nil)
         self.publishable_field = field || :published_at
 
-        # validate publishable_field exists in database
         unless column_names.include?(publishable_field.to_s)
           raise ArgumentError, "ConcernsOnRails::Publishable: publishable_field '#{publishable_field}' does not exist in the database"
         end
-
-        scope :published, -> { where(arel_table[publishable_field].not_eq(nil)) }
-        scope :unpublished, -> { where(arel_table[publishable_field].eq(nil)) }
       end
     end
 
@@ -48,7 +42,9 @@ module ConcernsOnRails
     # Example:
     #   record.published?
     def published?
-      self[self.class.publishable_field].present?
+      value = self[self.class.publishable_field]
+      return false unless value.present?
+      value.respond_to?(:<=) ? value <= Time.zone.now : true
     end
 
     # Check if the record is unpublished

data/lib/concerns_on_rails/sluggable.rb

@@ -51,13 +51,8 @@ module ConcernsOnRails
     # Example:
     #   record.slug_source
     def slug_source
-      if self.class.sluggable_field.present? && respond_to?(self.class.sluggable_field)
-        send(self.class.sluggable_field)
-      elsif respond_to?(:title)
-        title
-      else
-        to_s
-      end
+      field = self.class.sluggable_field
+      respond_to?(field) ? send(field) : to_s
     end
   end
 end

data/lib/concerns_on_rails/soft_deletable.rb

@@ -16,9 +16,6 @@ module ConcernsOnRails
       # 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
@@ -33,6 +30,16 @@ module ConcernsOnRails
           raise ArgumentError, "ConcernsOnRails::SoftDeletable: soft_delete_field '#{soft_delete_field}' does not exist in the database"
         end
       end
+
+      # Override destroy_all to perform soft delete on all records
+      def destroy_all
+        all.each(&:soft_delete!)
+      end
+
+      # Provide really_destroy_all to hard delete all records
+      def really_destroy_all
+        unscoped.delete_all
+      end
     end
 
     # Soft delete hooks
@@ -41,43 +48,34 @@ module ConcernsOnRails
     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
+      before_soft_delete
+      result = if self.class.soft_delete_touch
+        update(self.class.soft_delete_field => Time.zone.now)
+      else
+        update_column(self.class.soft_delete_field, Time.zone.now)
       end
+      after_soft_delete if result
+      result
     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
+      return true unless deleted?
+      before_restore
+      result = if self.class.soft_delete_touch
+        update(self.class.soft_delete_field => nil)
+      else
+        update_column(self.class.soft_delete_field, nil)
       end
+      after_restore if result
+      result
+    end
+
+    # bypasses AR callbacks and validations — use when you want a true hard delete
+    def really_delete!
+      self.class.unscoped.where(self.class.primary_key => id).delete_all
+      freeze
     end
   
     def deleted?
@@ -89,9 +87,8 @@ module ConcernsOnRails
     alias_method :is_soft_deleted?, :deleted?
     alias_method :soft_deleted?, :deleted?
 
-    # Is really deleted?
     def is_really_deleted?
-      !self.class.exists?(id)
+      !self.class.unscoped.exists?(id)
     end
   end
 end

data/lib/concerns_on_rails/sortable.rb

@@ -22,7 +22,12 @@ module ConcernsOnRails
       self.sortable_direction ||= :asc
 
       # we cannot use acts_as_list here
-      default_scope { order(sortable_field => sortable_direction) }
+      default_scope do
+        unless column_names.include?(sortable_field.to_s)
+          raise ArgumentError, "#{name}: '#{sortable_field}' column not found. Call `sortable_by :your_column` to configure the sort field."
+        end
+        order(sortable_field => sortable_direction)
+      end
     end
 
     # class methods
@@ -48,12 +53,7 @@ module ConcernsOnRails
 
         validate_sortable_field!
 
-        # add acts_as_list and default scope
-        # Setup sorting behaviors
         acts_as_list column: sortable_field if use_acts_as_list
-
-        # add default scope: position => asc
-        default_scope { order(sortable_field => sortable_direction) }
       end
 
       private

data/lib/concerns_on_rails/version.rb

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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: concerns_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ethan Nguyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2026-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: acts_as_list
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Reusable Rails concerns like Sortable, Publishable, and Sluggable