whodunit 0.1.0 → 0.2.1

data/lib/whodunit.rb

@@ -3,10 +3,10 @@
 require "active_support/all"
 require_relative "whodunit/version"
 require_relative "whodunit/current"
-require_relative "whodunit/soft_delete_detector"
 require_relative "whodunit/stampable"
 require_relative "whodunit/migration_helpers"
 require_relative "whodunit/controller_methods"
+require_relative "whodunit/table_definition_extension"
 require_relative "whodunit/railtie"
 
 # Lightweight creator/updater/deleter tracking for ActiveRecord models.
@@ -55,9 +55,15 @@ module Whodunit
   # @return [Symbol] the deleter column name
   mattr_accessor :deleter_column, default: :deleter_id
 
-  # Whether to automatically detect soft-delete implementations (default: true)
-  # @return [Boolean] auto-detection setting
-  mattr_accessor :auto_detect_soft_delete, default: true
+  # The column name used for soft-delete timestamps (default: nil)
+  # Set to a column name to enable soft-delete support (e.g., :deleted_at, :discarded_at)
+  # Set to nil to disable soft-delete support entirely
+  # @return [Symbol, nil] the soft-delete column name
+  mattr_accessor :soft_delete_column, default: nil
+
+  # Whether to automatically add whodunit_stamps to create_table migrations (default: true)
+  # @return [Boolean] auto-injection setting
+  mattr_accessor :auto_inject_whodunit_stamps, default: true
 
   # @!group Data Type Configuration
 
@@ -88,8 +94,10 @@ module Whodunit
   #
   # @yield [self] configuration block
   # @return [void]
+  # @raise [Whodunit::Error] if both creator_column and updater_column are set to nil
   def self.configure
     yield self
+    validate_column_configuration!
   end
 
   # Get the user class name as a string
@@ -118,4 +126,38 @@ module Whodunit
   def self.deleter_data_type
     deleter_column_type || column_data_type
   end
+
+  # Check if soft-delete is enabled
+  # @return [Boolean] true if soft-delete is configured (soft_delete_column is not nil)
+  def self.soft_delete_enabled?
+    !soft_delete_column.nil?
+  end
+
+  # Check if creator column is enabled
+  # @return [Boolean] true if creator_column is not nil
+  def self.creator_enabled?
+    !creator_column.nil?
+  end
+
+  # Check if updater column is enabled
+  # @return [Boolean] true if updater_column is not nil
+  def self.updater_enabled?
+    !updater_column.nil?
+  end
+
+  # Check if deleter column is enabled
+  # @return [Boolean] true if deleter_column is not nil
+  def self.deleter_enabled?
+    !deleter_column.nil?
+  end
+
+  # Validate that column configuration is valid
+  # @raise [Whodunit::Error] if both creator_column and updater_column are nil
+  def self.validate_column_configuration!
+    return if creator_enabled? || updater_enabled?
+
+    raise Whodunit::Error,
+          "At least one of creator_column or updater_column must be configured (not nil). " \
+          "Setting both to nil would disable all stamping functionality."
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whodunit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ken C. Demanawa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-20 00:00:00.000000000 Z
+date: 2025-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -193,11 +193,11 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.37
 description: A lightweight Rails gem that provides simple auditing by tracking who
-  created, updated, and deleted ActiveRecord models. Features smart soft-delete detection
-  and zero performance overhead.
+  created, updated, and deleted ActiveRecord models.
 email:
 - kenneth.c.demanawa@gmail.com
-executables: []
+executables:
+- whodunit
 extensions: []
 extra_rdoc_files: []
 files:
@@ -209,16 +209,19 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- exe/whodunit
 - gemfiles/rails_7_2.gemfile
 - gemfiles/rails_8_2.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/whodunit.rb
 - lib/whodunit/controller_methods.rb
 - lib/whodunit/current.rb
+- lib/whodunit/generator.rb
+- lib/whodunit/generator/application_record_integration.rb
 - lib/whodunit/migration_helpers.rb
 - lib/whodunit/railtie.rb
-- lib/whodunit/soft_delete_detector.rb
 - lib/whodunit/stampable.rb
+- lib/whodunit/table_definition_extension.rb
 - lib/whodunit/version.rb
 - sig/whodunit.rbs
 homepage: https://github.com/kanutocd/whodunit
@@ -230,17 +233,21 @@ metadata:
   source_code_uri: https://github.com/kanutocd/whodunit.git
   changelog_uri: https://github.com/kanutocd/whodunit/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/kanutocd/whodunit/issues
-  documentation_uri: https://github.com/kanutocd/whodunit/blob/main/README.md
+  documentation_uri: https://kanutocd.github.io/whodunit
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: "\U0001F389 Thanks for installing Whodunit!\n\nWhat's next?\n\n1.
+  Generate configuration (recommended):\n   whodunit install\n\n2. Add stamp columns
+  to your models:\n   rails generate migration AddStampsToUsers\n   # Then add: add_whodunit_stamps
+  :users\n\n3. Include Whodunit::Stampable in your models:\n   class User < ApplicationRecord\n
+  \    include Whodunit::Stampable\n   end\n\n\U0001F4D6 Complete documentation: https://kanutocd.github.io/whodunit\n"
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/whodunit/soft_delete_detector.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-module Whodunit
-  # Smart detection of soft-delete implementations.
-  #
-  # This class provides multi-layered detection for various soft-delete implementations
-  # including popular gems like Discard and Paranoia, as well as custom implementations.
-  #
-  # @example Check if a model has soft-delete enabled
-  #   class Post < ApplicationRecord
-  #     # has deleted_at column
-  #   end
-  #
-  #   Whodunit::SoftDeleteDetector.enabled_for?(Post)  # => true
-  #
-  # @example With Discard gem
-  #   class Post < ApplicationRecord
-  #     include Discard::Model
-  #   end
-  #
-  #   Whodunit::SoftDeleteDetector.enabled_for?(Post)  # => true
-  #
-  # @since 0.1.0
-  class SoftDeleteDetector
-    # Main detection method that checks if soft-delete is enabled for a model.
-    #
-    # Uses multiple detection strategies:
-    # 1. Gem-based detection (Discard, Paranoia, etc.)
-    # 2. Column pattern detection (deleted_at, discarded_at, etc.)
-    # 3. Method-based detection (respond_to? soft-delete methods)
-    #
-    # @param model [Class] the ActiveRecord model class to check
-    # @return [Boolean] true if soft-delete is detected, false otherwise
-    # @example
-    #   Whodunit::SoftDeleteDetector.enabled_for?(Post)  # => true
-    #   Whodunit::SoftDeleteDetector.enabled_for?(User)  # => false
-    def self.enabled_for?(model)
-      return false unless model.respond_to?(:columns)
-
-      gem_based_detection?(model) ||
-        column_pattern_detection(model) ||
-        method_based_detection(model)
-    end
-
-    # Detect popular soft-delete gems.
-    #
-    # Detects the following gems:
-    # - Discard (checks for Discard module inclusion)
-    # - Paranoia (checks for paranoid? method and Paranoid ancestors)
-    # - ActsAsParanoid (checks for acts_as_paranoid method)
-    #
-    # @param model [Class] the ActiveRecord model class to check
-    # @return [Boolean] true if a gem-based soft-delete is detected
-    # @api private
-    def self.gem_based_detection?(model)
-      # Discard gem
-      return true if model.included_modules.any? { |mod| mod.to_s.include?("Discard") }
-
-      # Paranoia gem
-      return true if model.respond_to?(:paranoid?) ||
-                     model.respond_to?(:acts_as_paranoid) ||
-                     model.ancestors.any? { |a| a.to_s.include?("Paranoid") }
-
-      # ActsAsParanoid (older version)
-      return true if model.respond_to?(:acts_as_paranoid)
-
-      false
-    end
-
-    # Detect soft-delete by column patterns.
-    #
-    # Looks for common soft-delete column names:
-    # - deleted_at, destroyed_at, discarded_at, archived_at
-    # - soft_deleted_at, soft_destroyed_at, removed_at
-    #
-    # Only considers timestamp columns (datetime, timestamp, date).
-    #
-    # @param model [Class] the ActiveRecord model class to check
-    # @return [Boolean] true if soft-delete columns are found
-    # @api private
-    def self.column_pattern_detection(model)
-      soft_delete_columns = %w[
-        deleted_at destroyed_at discarded_at archived_at
-        soft_deleted_at soft_destroyed_at removed_at
-      ]
-
-      model.columns.any? do |column|
-        soft_delete_columns.include?(column.name) &&
-          timestamp_column?(column)
-      end
-    end
-
-    # Detect soft-delete by method presence.
-    #
-    # Checks if the model responds to common soft-delete method names.
-    # This catches custom implementations that follow standard naming conventions.
-    #
-    # @param model [Class] the ActiveRecord model class to check
-    # @return [Boolean] true if soft-delete methods are found
-    # @api private
-    def self.method_based_detection(model)
-      soft_delete_methods = %w[
-        deleted_at destroyed_at discarded_at archived_at
-        soft_deleted_at soft_destroyed_at removed_at
-      ]
-
-      soft_delete_methods.any? { |method| model.respond_to?(method) }
-    end
-
-    # Check if a column is a timestamp type.
-    #
-    # @param column [Object] the column object (responds to #type)
-    # @return [Boolean] true if the column is a timestamp type
-    # @api private
-    def self.timestamp_column?(column)
-      %i[datetime timestamp date].include?(column.type)
-    end
-  end
-end