db_validator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5b1e93e6a494c74779345e004eb7f6050fa5fd4e15cb27846d48fa8390a78ef
-  data.tar.gz: 9ab575840ad1cb722db62b40162b527e4793305ed4255b38eb1166ba5e4786fe
+  metadata.gz: 60cba1d36771e30b0bafb5ac354f3d741b3bde0e5f37b267bcff4ebb9dd11bad
+  data.tar.gz: 1baa177ce745a107d5c064844b74cd8731b5cddd8624f2944c464812c9e136b0
 SHA512:
-  metadata.gz: 20cc83d66461dff7faed7ec1eee28b4c5459152d723403c15b23718554e5ae208e965acde7b3ee4bb2ba030e19bdd86c1e4e63bd0072e7e2bfbfdd25048647e9
-  data.tar.gz: b8e9a4175498cf0f96eec2ed624a9c1be35c6092206bfd7117ecad929f59760236d361cbf524cce37fb603feaafa4ed981f5cbf0308cb0b79a2b2adb2c39a5d5
+  metadata.gz: d3e414c08cf3496438f5a61941c579b072dd9a41330133df64bfe48c3e8d205cf3de933f52368622d3cd7cbcea8cea5844982f7fb95bf1eafca59bcb1b6f781a
+  data.tar.gz: 9a2d9de68775b836aec350ded2b88184c534e3dac4649d6b531e5f5575363f30ee60b1a10a9439cfbd2beb083ea2036a095a17d37c5593d9fe4e730bdb7349fe

data/config/initializers/db_validator.rb

@@ -2,7 +2,7 @@
 
 DbValidator.configure do |config|
   config.only_models = %w[Documents Users]
-  config.batch_size = 500
+  config.batch_size = 100
   config.limit = 500
   config.model_limits = {
     "documents" => 500,

data/lib/db_validator/cli.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+require "tty-box"
+require "tty-spinner"
+
+module DbValidator
+  class CLI
+    def initialize
+      @prompt = TTY::Prompt.new
+    end
+
+    def select_models(available_models)
+      system "clear"
+      display_header
+
+      if available_models.empty?
+        @prompt.error("No models found in the application.")
+        exit
+      end
+
+      choices = available_models.map { |model| { name: model, value: model } }
+      choices.unshift({ name: "All Models", value: "all" })
+
+      @prompt.say("\n")
+      selected = @prompt.multi_select(
+        "Select models to validate:",
+        choices,
+        per_page: 10,
+        echo: false,
+        show_help: :always,
+        filter: true,
+        cycle: true
+      )
+
+      if selected.include?("all")
+        available_models
+      else
+        selected
+      end
+    end
+
+    def configure_options
+      options = {}
+
+      @prompt.say("\n")
+      if @prompt.yes?("Would you like to configure additional options?", default: false)
+        limit_input = @prompt.ask("Enter record limit (leave blank for no limit):") do |q|
+          q.validate(/^\d*$/, "Please enter a valid number")
+          q.convert(:int, nil)
+        end
+        options[:limit] = limit_input if limit_input.present?
+
+        batch_size = @prompt.ask("Enter batch size:", default: 1000, convert: :int) do |q|
+          q.validate(/^\d+$/, "Please enter a positive number")
+          q.messages[:valid?] = "Please enter a positive number"
+        end
+        options[:batch_size] = batch_size if batch_size.present?
+
+        options[:format] = @prompt.select("Select report format:", %w[text json], default: "text")
+      end
+
+      options
+    end
+
+    def display_progress(message)
+      spinner = TTY::Spinner.new("[:spinner] #{message}", format: :dots)
+      spinner.auto_spin
+      yield if block_given?
+      spinner.success
+    end
+
+    private
+
+    def display_header
+      title = TTY::Box.frame(
+        "DB Validator",
+        "Interactive Model Validation",
+        padding: 1,
+        align: :center,
+        border: :thick,
+        style: {
+          border: {
+            fg: :cyan
+          }
+        }
+      )
+      puts title
+    end
+  end
+end 

data/lib/db_validator/configuration.rb

@@ -2,7 +2,7 @@
 
 module DbValidator
   class Configuration
-    attr_accessor :only_models, :ignored_models, :ignored_attributes, :batch_size, :report_format, :auto_fix, :limit
+    attr_accessor :only_models, :ignored_models, :ignored_attributes, :batch_size, :report_format, :limit
 
     def initialize
       @only_models = []
@@ -10,7 +10,6 @@ module DbValidator
       @ignored_attributes = {}
       @batch_size = 1000
       @report_format = :text
-      @auto_fix = false
       @limit = nil
     end
 

data/lib/db_validator/reporter.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "tty-box"
+require "tty-spinner"
+
 module DbValidator
   class Reporter
     def initialize
@@ -10,11 +13,11 @@ module DbValidator
       enhanced_errors = record.errors.map do |error|
         field_value = record.send(error.attribute)
         message = error.message
-        
+
         if error.options[:in].present?
           "#{error.attribute} #{message} (allowed values: #{error.options[:in].join(', ')}, actual value: #{field_value.inspect})"
         else
-          "#{error.attribute} #{message} (actual value: #{field_value.inspect})"
+          "#{error.attribute} #{message} (actual value: #{format_value(field_value)})"
         end
       end
 
@@ -36,26 +39,68 @@ module DbValidator
 
     private
 
+    def format_value(value)
+      case value
+      when true, false
+      when Symbol
+        value.to_s
+      when String
+        "\"#{value}\""
+      when nil
+        "nil"
+      else
+        value
+      end
+    end
+
     def generate_text_report
       report = StringIO.new
-      report.puts "DbValidator Report"
-      report.puts "=================="
+      
+      title_box = TTY::Box.frame(
+        width: 50,
+        align: :center,
+        padding: [1, 2],
+        title: { top_left: "DbValidator" },
+        style: {
+          fg: :cyan,
+          border: {
+            fg: :cyan
+          }
+        }
+      ) do
+        "Database Validation Report"
+      end
+      
+      report.puts title_box
       report.puts
 
       if @invalid_records.empty?
-        report.puts "No invalid records found."
+        report.puts "No invalid records found.".colorize(:green)
       else
-        report.puts "Found invalid records:"
+        report.puts "Found #{@invalid_records.count} invalid records across #{@invalid_records.group_by { |r| r[:model] }.keys.count} models".colorize(:yellow)
         report.puts
 
         @invalid_records.group_by { |r| r[:model] }.each do |model, records|
-          report.puts "#{model}: #{records.count} invalid records"
+          report.puts "#{model}: #{records.count} invalid records".colorize(:red)
+          report.puts
+
           records.each do |record|
-            report.puts "  ID: #{record[:id]}"
+            record_obj = record[:model].constantize.find_by(id: record[:id])
+            next unless record_obj
+
+            info = ["ID: #{record[:id]}"]
+            info << "Created: #{record_obj.created_at.strftime('%Y-%m-%d %H:%M:%S')}" if record_obj.respond_to?(:created_at)
+            info << "Updated: #{record_obj.updated_at.strftime('%Y-%m-%d %H:%M:%S')}" if record_obj.respond_to?(:updated_at)
+            info << "Name: #{record_obj.name}" if record_obj.respond_to?(:name)
+            info << "Title: #{record_obj.title}" if record_obj.respond_to?(:title)
+            
+            report.puts "  #{info.join(' | ')}".colorize(:white)
             record[:errors].each do |error|
-              report.puts "    - #{error}"
+              report.puts "    ⚠️  #{error}".colorize(:white)
             end
+            report.puts
           end
+          
           report.puts
         end
       end

data/lib/db_validator/validator.rb

@@ -5,20 +5,26 @@ require "colorize"
 
 module DbValidator
   class Validator
+    attr_reader :reporter
+
     def initialize(options = {})
       @options = options
       @reporter = Reporter.new
-      @fixer = Fixer.new if DbValidator.configuration.auto_fix
+      configure_from_options(options)
     end
 
     def validate_all
       Rails.application.eager_load! if defined?(Rails)
 
       models = find_all_models
-
       models_to_validate = models.select { |model| should_validate_model?(model) }
       total_models = models_to_validate.size
 
+      if models_to_validate.empty?
+        Rails.logger.debug "No models selected for validation.".colorize(:yellow)
+        return @reporter.generate_report
+      end
+
       models_to_validate.each_with_index do |model, index|
         Rails.logger.debug "Validating model #{index + 1}/#{total_models}: #{model.name}".colorize(:cyan)
         validate_model(model)
@@ -29,8 +35,19 @@ module DbValidator
 
     private
 
+    def configure_from_options(options)
+      return unless options.is_a?(Hash)
+
+      if options[:only_models]
+        DbValidator.configuration.only_models = Array(options[:only_models])
+      end
+      
+      DbValidator.configuration.limit = options[:limit] if options[:limit]
+      DbValidator.configuration.batch_size = options[:batch_size] if options[:batch_size]
+      DbValidator.configuration.report_format = options[:report_format] if options[:report_format]
+    end
+
     def find_all_models
-      # Include all classes inheriting from ActiveRecord::Base
       ObjectSpace.each_object(Class).select do |klass|
         klass < ActiveRecord::Base
       end
@@ -42,45 +59,51 @@ module DbValidator
 
       config = DbValidator.configuration
       model_name = model.name.downcase
-      return config.only_models.include?(model_name) if config.only_models.any?
+      
+      if config.only_models.any?
+        return config.only_models.map(&:downcase).include?(model_name)
+      end
 
-      config.ignored_models.exclude?(model_name)
+      !config.ignored_models.map(&:downcase).include?(model_name)
     end
 
     def validate_model(model)
-      limit = DbValidator.configuration.limit
-      total_records = limit || model.count
+      config = DbValidator.configuration
+      batch_size = config.batch_size || 1000
+      limit = config.limit
 
-      if total_records.zero?
-        Rails.logger.debug { "No records to validate for model #{model.name}." }
-        return
-      end
+      scope = model.all
+      scope = scope.limit(limit) if limit
 
-      processed_records = 0
+      total_count = scope.count
+      return if total_count.zero?
 
-      query = model.all
-      query = query.limit(limit) if limit
+      progress_bar = create_progress_bar(model.name, total_count)
 
-      query.find_in_batches(batch_size: DbValidator.configuration.batch_size) do |batch|
-        batch.each do |record|
-          validate_record(record)
-          processed_records += 1
-          if (processed_records % 100).zero? || processed_records == total_records
-            Rails.logger.debug "Validated #{processed_records}/#{total_records} records for model #{model.name}".colorize(:green)
+      begin
+        scope.find_in_batches(batch_size: batch_size) do |batch|
+          batch.each do |record|
+            validate_record(record)
+            progress_bar.increment
           end
         end
       rescue StandardError => e
         Rails.logger.debug "Error validating #{model.name}: #{e.message}".colorize(:red)
       end
-    rescue ActiveRecord::StatementInvalid => e
-      Rails.logger.debug { "Skipping validation for #{model.name}: #{e.message}" }
+    end
+
+    def create_progress_bar(model_name, total)
+      ProgressBar.create(
+        title: "Validating #{model_name}",
+        total: total,
+        format: "%t: |%B| %p%% %e",
+        output: $stderr
+      )
     end
 
     def validate_record(record)
       return if record.valid?
-
       @reporter.add_invalid_record(record)
-      @fixer&.attempt_fix(record)
     end
   end
 end

data/lib/db_validator/version.rb

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

data/lib/db_validator.rb

@@ -5,7 +5,7 @@ require "db_validator/version"
 require "db_validator/configuration"
 require "db_validator/validator"
 require "db_validator/reporter"
-require "db_validator/fixer"
+require "db_validator/cli"
 
 module DbValidator
   class Error < StandardError; end

data/lib/generators/db_validator/templates/initializer.rb

@@ -14,11 +14,8 @@ DbValidator.configure do |config|
   # }
 
   # Set the batch size for processing records (default: 1000)
-  # config.batch_size = 1000
+  # config.batch_size = 100
 
   # Set the report format (:text or :json)
   # config.report_format = :text
-
-  # Enable automatic fixing of simple validation errors
-  # config.auto_fix = false
 end

data/lib/tasks/db_validator_tasks.rake

@@ -3,17 +3,39 @@
 namespace :db_validator do
   desc "Validate all records in the database"
   task validate: :environment do
-    if ENV["models"]
-      models = ENV["models"].split(",").map(&:strip).map(&:downcase)
+    cli = DbValidator::CLI.new
+
+    has_any_args = ENV["models"] || ENV["limit"] || ENV["batch_size"] || ENV["format"]
+
+    if has_any_args
+      models = ENV["models"].split(",").map(&:strip).map(&:downcase).map(&:singularize)
+
       DbValidator.configuration.only_models = models
-    end
+      DbValidator.configuration.limit = ENV["limit"].to_i if ENV["limit"].present?
+      DbValidator.configuration.batch_size = ENV["batch_size"].to_i if ENV["batch_size"].present?
+      DbValidator.configuration.report_format = ENV["format"].to_sym if ENV["format"].present?
+    else
+      cli.display_progress("Loading models") do
+        Rails.application.eager_load!
+      end
+
+      available_models = ActiveRecord::Base.descendants
+        .reject(&:abstract_class?)
+        .select(&:table_exists?)
+        .map { |m| m.name }
+        .sort
 
-    DbValidator.configuration.limit = ENV["limit"].to_i if ENV["limit"]
+      selected_models = cli.select_models(available_models)
+      options = cli.configure_options
 
-    DbValidator.configuration.report_format = ENV["format"].to_sym if ENV["format"]
+      DbValidator.configuration.only_models = selected_models
+      DbValidator.configuration.limit = options[:limit] if options[:limit].present?
+      DbValidator.configuration.batch_size = options[:batch_size] if options[:batch_size].present?
+      DbValidator.configuration.report_format = options[:format].to_sym if options[:format].present?
+    end
 
     validator = DbValidator::Validator.new
     report = validator.validate_all
-    puts report
+    puts "\n#{report}"
   end
 end

data/readme.md

@@ -1,6 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/db_validator.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/db_validator)
+[![RSpec Tests](https://github.com/krzysztoff1/db-validator/actions/workflows/rspec.yml/badge.svg)](https://github.com/krzysztoff1/db-validator/actions/workflows/rspec.yml)
+
 # DbValidator
 
-DbValidator helps identify invalid records in your Rails application that don't meet model validation requirements.
+DbValidator helps identify invalid records in your Rails application that don't meet model validation requirements. It finds records that became invalid after validation rule changes, and validates imported or manually edited data. You can use it to audit records before deploying new validations and catch any data that bypassed validation checks.
 
 ## Installation
 
@@ -16,24 +19,21 @@ Then execute:
 $ bundle install
 ```
 
-Or install it yourself:
-
-```bash
-$ gem install db_validator
-```
-
 ## Usage
 
 ### Rake Task
 
 The simplest way to run validation is using the provided rake task:
 
-#### Validate all models
+#### Validate models in interactive mode
+<img width="798" alt="Screenshot 2024-11-07 at 21 50 57" src="https://github.com/user-attachments/assets/33fbdb8b-b8ec-4284-9313-c1eeaf2eab2d">
 
 ```bash
 $ rake db_validator:validate
 ```
 
+This will start an interactive mode where you can select which models to validate and adjust other options.
+
 #### Validate specific models
 
 ```bash
@@ -52,6 +52,14 @@ $ rake db_validator:validate limit=1000
 $ rake db_validator:validate format=json
 ```
 
+### Interactive Mode
+
+Running the validation task without specifying models will start an interactive mode:
+
+```bash
+$ rake db_validator:validate
+```
+
 ### Ruby Code
 
 You can also run validation from your Ruby code:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Krzysztof Duda
@@ -94,8 +94,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
-description: A comprehensive solution for validating existing database records in
-  Rails applications
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: tty-box
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+description: DbValidator helps identify invalid records in your Rails application
+  that don't meet model validation requirements. It finds records that became invalid
+  after validation rule changes, and validates imported or manually edited data. You
+  can use it to audit records before deploying new validations and catch any data
+  that bypassed validation checks.
 email:
 - duda_krzysztof@outlook.com
 executables: []
@@ -104,8 +149,8 @@ extra_rdoc_files: []
 files:
 - config/initializers/db_validator.rb
 - lib/db_validator.rb
+- lib/db_validator/cli.rb
 - lib/db_validator/configuration.rb
-- lib/db_validator/fixer.rb
 - lib/db_validator/railtie.rb
 - lib/db_validator/reporter.rb
 - lib/db_validator/validator.rb
@@ -114,7 +159,7 @@ files:
 - lib/generators/db_validator/templates/initializer.rb
 - lib/tasks/db_validator_tasks.rake
 - readme.md
-homepage: https://github.com/yourusername/db_validator
+homepage: https://github.com/krzysztoff1/db-validator
 licenses:
 - MIT
 metadata:
@@ -137,5 +182,6 @@ requirements: []
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: Database-wide validation for Rails applications
+summary: DbValidator helps identify invalid records in your Rails application that
+  don't meet model validation requirements
 test_files: []

data/lib/db_validator/fixer.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module DbValidator
-  class Fixer
-    def initialize
-      @fixed_records = 0
-      @failed_fixes = 0
-    end
-
-    def fix_record(record)
-      return false unless record.invalid?
-
-      success = attempt_fix(record)
-      if success
-        @fixed_records += 1
-      else
-        @failed_fixes += 1
-      end
-      success
-    end
-
-    def statistics
-      {
-        fixed_records: @fixed_records,
-        failed_fixes: @failed_fixes
-      }
-    end
-
-    private
-
-    def attempt_fix(record)
-      record.save
-    end
-  end
-end