whodunit 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b45b1b2f4cfb91e98e2c4656c67305403108af39c5069127d91f0521599bc94
-  data.tar.gz: 56472d61e9f422643eefe7dca84b7f050fa8d91bb4274bb2354a4e01f04d5ee4
+  metadata.gz: 1ce926c88b69914bd703491e1bf11f890f64a4c4f5679929d1b898306ea18fcd
+  data.tar.gz: 3b277cf8bbf1f36e494f90f959941c38b3829f541b5b36b1168b98a276d830f7
 SHA512:
-  metadata.gz: c959a0b51f441b28a855b95a537e5983592ed5eb7eef4cbf5eb42c1d4c120849a27ac4113c784f27defa6703939d6cb02a0c2ccc8bd24f0a0508673351407b97
-  data.tar.gz: a5ca68eebccf5794c9b65521a0c7a232f3178d7aacb6af89c9de3b3bc1365588a6e62a39c52c9821987aaa8735231d289fbc1f28fc7a95be391171d40afbfe31
+  metadata.gz: 68b739ee97b145af1451991f589dfd9353da7ff579592e9f45071c532ed095e2b83e166b30b987bdbd6a22f1f47b421d1dc76fce7818491889376a0249ecdd21
+  data.tar.gz: 3796e3c88a21640063c504d27f3fa34a16f077eac5653826cd7a0a4ad513288dec0aa88383afa633daac57d25719711e2325cc33e01079f00725f76d2d22270d

data/.rubocop.yml

@@ -13,6 +13,7 @@ AllCops:
     - 'coverage/**/*'
     - 'bin/**/*'
     - 'sig/**/*'
+    - 'example/**/*'
 
 # Layout & Formatting
 Layout/LineLength:

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2025-01-21
+
+### Added
+
+- **ApplicationRecord Integration**: `whodunit install` now prompts to automatically add `Whodunit::Stampable` to `ApplicationRecord` for convenient all-model stamping
+- **Enhanced Configuration Template**: Detailed explanations and examples for each configuration option in generated initializer
+- **Post-install Message**: Helpful instructions displayed after gem installation via `bundle add whodunit`
+- **Comprehensive Test Coverage**: Full test suite for ApplicationRecord integration with edge case handling
+
+### Changed
+
+- **Improved CLI Experience**: More user-friendly prompts and messages throughout the installation process
+- **Better Documentation**: Updated README with corrected installation commands and new ApplicationRecord feature
+- **Code Organization**: Extracted ApplicationRecord integration logic into separate module for better maintainability
+
+### Fixed
+
+- **Gemspec Consistency**: Corrected post-install message to show `whodunit install` instead of incorrect Rails generator command
+- **RuboCop Compliance**: Fixed all style issues and reduced complexity across codebase
+
 ## [0.2.0] - 2025-01-20
 
 ### Added

data/README.md

@@ -34,6 +34,23 @@ And then execute:
 
     $ bundle install
 
+### What's Next?
+
+After installation, you have a few options:
+
+1. **Generate Configuration & Setup** (Recommended):
+   ```bash
+   whodunit install
+   ```
+   This will:
+   - Create `config/initializers/whodunit.rb` with all available configuration options
+   - Optionally add `Whodunit::Stampable` to your `ApplicationRecord` for automatic stamping on all models
+   - Provide clear next steps for adding stamp columns to your database
+
+2. **Quick Setup**: Jump directly to adding stamp columns to your models (see Quick Start below)
+
+3. **Learn More**: Check the [Complete Documentation](https://kanutocd.github.io/whodunit) for advanced configuration
+
 ## Quick Start
 
 ### 1. Add Stamp Columns

data/lib/whodunit/generator/application_record_integration.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Whodunit
+  class Generator
+    # Handles ApplicationRecord integration functionality
+    module ApplicationRecordIntegration
+      def self.handle_application_record_integration!
+        application_record_file = "app/models/application_record.rb"
+
+        return unless application_record_exists?(application_record_file)
+
+        content = File.read(application_record_file)
+        return if stampable_already_included?(content)
+
+        return unless user_wants_application_record_integration?
+
+        add_stampable_to_application_record!(application_record_file, content)
+      end
+
+      private_class_method def self.application_record_exists?(file_path)
+        return true if File.exist?(file_path)
+
+        puts "⚠️  ApplicationRecord not found at #{file_path}"
+        false
+      end
+
+      private_class_method def self.stampable_already_included?(content)
+        return false unless content.include?("Whodunit::Stampable")
+
+        puts "✅ Whodunit::Stampable already included in ApplicationRecord"
+        true
+      end
+
+      private_class_method def self.user_wants_application_record_integration?
+        puts ""
+        puts "🤔 Do you want to include Whodunit::Stampable in ApplicationRecord?"
+        puts "   This will automatically enable stamping for ALL your models."
+        puts "   (You can always include it manually in specific models instead)"
+        print "   Add to ApplicationRecord? (Y/n): "
+
+        response = $stdin.gets.chomp.downcase
+        !%w[n no].include?(response)
+      end
+
+      private_class_method def self.add_stampable_to_application_record!(file_path, content)
+        updated_content = try_primary_pattern(content) || try_fallback_pattern(content)
+
+        if updated_content
+          write_updated_application_record!(file_path, updated_content)
+        else
+          show_manual_integration_message
+        end
+      end
+
+      private_class_method def self.try_primary_pattern(content)
+        return unless content.match?(/^(\s*class ApplicationRecord < ActiveRecord::Base\s*)$/)
+
+        content.gsub(
+          /^(\s*class ApplicationRecord < ActiveRecord::Base\s*)$/,
+          "\\1\n  include Whodunit::Stampable"
+        )
+      end
+
+      private_class_method def self.try_fallback_pattern(content)
+        return unless content.match?(/^(\s*class ApplicationRecord.*\n)/)
+
+        content.gsub(
+          /^(\s*class ApplicationRecord.*\n)/,
+          "\\1  include Whodunit::Stampable\n"
+        )
+      end
+
+      private_class_method def self.write_updated_application_record!(file_path, content)
+        File.write(file_path, content)
+        puts "✅ Added Whodunit::Stampable to ApplicationRecord"
+        puts "   All your models will now automatically include stamping!"
+      end
+
+      private_class_method def self.show_manual_integration_message
+        puts "⚠️  Could not automatically modify ApplicationRecord"
+        puts "   Please manually add: include Whodunit::Stampable"
+      end
+    end
+  end
+end

data/lib/whodunit/generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require_relative "generator/application_record_integration"
 
 module Whodunit
   # Generator for creating Whodunit configuration files
@@ -13,18 +14,48 @@ module Whodunit
       # Uncomment and modify the options you want to customize.
 
       # Whodunit.configure do |config|
+      #   # User model configuration
+      #   # Specify which model represents users in your application
       #   config.user_class = 'Account'             # Default: 'User'
+      #                                             # Use 'Account', 'Admin', etc. if your user model has a different name
+      #
+      #   # Column name configuration
+      #   # Customize the names of the tracking columns in your database
       #   config.creator_column = :created_by_id    # Default: :creator_id
+      #                                             # Column that stores who created the record
       #   config.updater_column = :updated_by_id    # Default: :updater_id
+      #                                             # Column that stores who last updated the record
       #   config.deleter_column = :deleted_by_id    # Default: :deleter_id
-      #   config.soft_delete_column = :discarded_at # Default: nil
+      #                                             # Column that stores who deleted the record (soft-delete only)
+      #
+      #   # Soft-delete integration
+      #   # Enable tracking of who deleted records when using soft-delete gems
+      #   config.soft_delete_column = :discarded_at # Default: nil (disabled)
+      #                                             # Set to :deleted_at for Paranoia gem
+      #                                             # Set to :discarded_at for Discard gem
+      #                                             # Set to your custom soft-delete column name
+      #                                             # Set to nil to disable soft-delete tracking
+      #
+      #   # Migration auto-injection
+      #   # Control whether whodunit stamps are automatically added to new migrations
       #   config.auto_inject_whodunit_stamps = false # Default: true
+      #                                               # When true, automatically adds t.whodunit_stamps to create_table migrations
+      #                                               # When false, you must manually add t.whodunit_stamps to your migrations
       #
       #   # Column data type configuration
-      #   config.column_data_type = :integer       # Default: :bigint (applies to all columns)
+      #   # Configure what data types to use for the tracking columns
+      #   config.column_data_type = :integer       # Default: :bigint
+      #                                            # Global default for all stamp columns
+      #                                            # Common options: :bigint, :integer, :string, :uuid
+      #
+      #   # Individual column type overrides
+      #   # Override the data type for specific columns (takes precedence over column_data_type)
       #   config.creator_column_type = :string     # Default: nil (uses column_data_type)
+      #                                            # Useful if your user IDs are strings or UUIDs
       #   config.updater_column_type = :uuid       # Default: nil (uses column_data_type)
+      #                                            # Set to match your user model's primary key type
       #   config.deleter_column_type = :integer    # Default: nil (uses column_data_type)
+      #                                            # Only used when soft_delete_column is configured
       # end
     RUBY
 
@@ -36,6 +67,7 @@ module Whodunit
       ensure_config_directory_exists!(config_dir)
       handle_existing_file!(config_file)
       create_initializer_file!(config_file)
+      ApplicationRecordIntegration.handle_application_record_integration!
       show_success_message(config_file)
     end
 
@@ -76,7 +108,10 @@ module Whodunit
       puts "📝 Next steps:"
       puts "   1. Edit #{config_file} to customize your configuration"
       puts "   2. Uncomment the options you want to change"
-      puts "   3. Restart your Rails server to apply changes"
+      puts "   3. Add stamp columns to your models with migrations:"
+      puts "      rails generate migration AddStampsToUsers"
+      puts "      # Then add: add_whodunit_stamps :users"
+      puts "   4. Restart your Rails server to apply changes"
       puts ""
       puts "📖 For more information, see: https://github.com/kanutocd/whodunit?tab=readme-ov-file#configuration"
     end

data/lib/whodunit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Whodunit
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whodunit
 version: !ruby/object:Gem::Version
-  version: 0.2.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
@@ -217,6 +217,7 @@ files:
 - 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/stampable.rb
@@ -234,7 +235,11 @@ metadata:
   bug_tracker_uri: https://github.com/kanutocd/whodunit/issues
   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