active_sanity 0.1.0 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0558af4db68be1d5ad7994453fee0a5abdfd3a79fd0e01417fa25afa7dc6ad98'
+  data.tar.gz: 7422349844512998be28691efc24d2211554a819f395cc39b0540d4edeedf398
+SHA512:
+  metadata.gz: 4f825526ec0ee8c0a52ad40beef09c86cb5f64f7a8e61f2ed4beb01e1f22e56a97a77dfc4b7cf3368e147181f33b3829ad631bf9631d6b16fab12805ae11e493
+  data.tar.gz: bee1b677fd834b29b3b8edc1c573372b6de0a3db0b8edf2cf86a88c0ecdc7b89fbb0d576c17525c04fea54de13f8671e009c9f16472b846b1b6b6aa3e403fa1d

data/.circleci/config.yml

@@ -0,0 +1,18 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: cucumber
+          command: RAILS_ENV=test bundle exec cucumber

data/.gitignore

@@ -1,5 +1,8 @@
 *.gem
 .bundle
+.ruby-gemset
+.ruby-version
 Gemfile.lock
 pkg/*
 test/rails_app
+active_sanity.ignore.yml

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  Include:
+    - 'Gemfile'
+    - 'Rakefile'
+    - '*.gemspec'
+    - 'lib/**/*'
+    - 'test/**/*'
+  Exclude:
+    - 'features/**/*'
+    - 'test/rails_app/**/*'
+  RunRailsCops: false
+Metrics/LineLength:
+  Enabled: false
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Style/Documentation:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false
+Style/CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
+  PreferredMethods:
+    map: 'collect'
+    map!: 'collect!'
+    reduce: 'inject'
+    detect: 'find'
+    select: 'find_all'

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+## 0.3.0
+
+* Add Rails ~4 compatibility.
+* Does not rerun validations for the 'InvalidRecord' model on the second pass.
+* batch size for fetched records is now configurable by setting ActiveSanity::Checker.batch_size after the gem has been loaded ie in 'config\application.rb' (or 'config\environments\test.rb') inside an 'after_initialize' block
+
+## 0.2.0
+
+* Add Rails ~3.1 compatibility. Pull Request [#6][] by [@skateinmars][].
+
+## 0.1.1
+
+* Fix bug where records stored with STI would be duplicated in the
+  database. Issue [#1][]. [@vraravam][]
+
+## 0.1.0
+
+Initial release.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#1]: https://github.com/versapay/active_sanity/issues/1
+[#6]: https://github.com/versapay/active_sanity/issues/6
+[@skateinmars]: https://github.com/skateinmars
+[@vraravam]: https://github.com/vraravam

data/Gemfile

@@ -1,4 +1,7 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in active_sanity.gemspec
 gemspec
+
+gem 'sqlite3'
+gem 'bootsnap', require: false

data/README.md

@@ -1,8 +1,17 @@
 # Active Sanity
 
+[![Build Status](https://circleci.com/gh/pcreux/active_sanity.svg?style=svg)](https://circleci.com/gh/pcreux/active_sanity)
+
 Perform a sanity check on your database through active record
 validation.
 
+## Requirements
+
+* ActiveSanity ~0.5 Rails ~5.0 or ~6.0
+* ActiveSanity ~0.3 and ~0.4 requires Rails ~4.0
+* ActiveSanity ~0.2 requires Rails ~3.1
+* ActiveSanity ~0.1 requires Rails ~3.0
+
 ## Install
 
 Add the following line to your Gemfile
@@ -11,17 +20,17 @@ Add the following line to your Gemfile
 
 If you wish to store invalid records in your database run:
 
-    $ rails generate active_sanity
-    $ rake db:migrate
+    $ bin/rails generate active_sanity
+    $ bin/rails db:migrate
 
 ## Usage
 
 Just run:
 
-    rake db:check_sanity
+    bin/rails db:check_sanity
 
 ActiveSanity will iterate over every records of all your models to check
-weither they're valid or not. It will save invalid records in the table
+whether they're valid or not. It will save invalid records in the table
 invalid_records if it exists and output all invalid records.
 
 The output might look like the following:
@@ -31,13 +40,20 @@ The output might look like the following:
     Flight      | 123 | { "arrival_time" => ["can't be nil"], "departure_time" => ["is invalid"] }
     Flight      | 323 | { "arrival_time" => ["can't be nil"] }
 
-## Known issues
+By default, the number of records fetched from the database for validation is set to 500. If this causes any issues in your domain/codebase, you can configure it this way in `config\application.rb` (or `config\environments\test.rb`):
+
+    class Application < Rails::Application
+      config.after_initialize do
+        ActiveSanity::Checker.batch_size = 439
+      end
+    end
+
+If you want to ignore certain models from being verified, you can create a file named `active_sanity.ignore.yml` at the root of your project with the following structure
 
-There is a bug in Rails 3.0.5 with the unserialization of OrderedHash
-storing arrays: only the last error of a given attribute gets retrieved
-from the database.
+    models:
+      - '<name of class to ignore>'
+      - '<name of class to ignore>'
 
-See https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/6646-orderedhash-serialization-does-not-work-when-storing-arrays 
 
 ## Contribute & Dev environment
 
@@ -47,7 +63,7 @@ This gem is quite simple so I experiment using features only. To run the
 acceptance test suite, just run:
 
     bundle install
-    cucumber features
+    RAILS_ENV=test bundle exec cucumber features
 
 Using features only was kinda handsome until I had to deal with two
 different database schema (with / without the table invalid_records) in

data/Rakefile

@@ -1,2 +1,14 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task default: :features
+
+desc 'Run features'
+task :features do
+  fail 'Failed!' unless system('export RAILS_ENV=test && bundle exec cucumber features')
+end
+
+desc 'Clean test rails app'
+task :clean do
+  puts 'test/rails_app deleted successfully' if system('rm -r test/rails_app')
+end

data/active_sanity.gemspec

@@ -1,26 +1,26 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "active_sanity/version"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'active_sanity/version'
 
 Gem::Specification.new do |s|
-  s.name        = "active_sanity"
+  s.name        = 'active_sanity'
   s.version     = ActiveSanity::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["VersaPay", "Philippe Creux"]
-  s.email       = ["philippe.creux@versapay.com"]
-  s.homepage    = ""
-  s.summary     = %q{Checks Sanity of Active Record records}
-  s.description = %q{Performs a Sanity Check of your database by logging all invalid Active Records}
-  s.homepage    = "https://github.com/versapay/active_sanity"
+  s.authors     = ['Philippe Creux']
+  s.email       = ['pcreux@gmail.com']
+  s.summary     = 'Checks Sanity of Active Record records'
+  s.description = 'Performs a Sanity Check of your database by logging all invalid Active Records'
+  s.homepage    = 'https://github.com/pcreux/active_sanity'
 
-  s.add_dependency "rails", ">=3.0.0"
+  s.add_dependency 'rails', '>=5.0'
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "cucumber"
-  s.add_development_dependency "sqlite3"
+  s.add_development_dependency 'rails', '~>6.0'
+  s.add_development_dependency 'rspec', '~>3.1'
+  s.add_development_dependency 'cucumber', '~>1.3'
+  s.add_development_dependency 'sqlite3', '~>1.3'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 end

data/features/check_sanity.feature

@@ -9,7 +9,7 @@ Feature: Check sanity
 
   Scenario: Check sanity on empty database
     When I run "rake db:check_sanity"
-    Then I should see "Checking the following models: InvalidRecord, Category, Post, User"
+    Then I should see "Checking the following models: Category, Post, User"
     Then I should not see any invalid records
 
   Scenario: Check sanity on database with valid records
@@ -19,8 +19,15 @@ Feature: Check sanity
 
   Scenario: Check sanity on database with invalid records
     Given the database contains a few valid records
-    And the first user's username is empty and the first post category_id is nil
+    And the first author's username is empty and the first post category_id is nil
     When I run "rake db:check_sanity"
     Then I should see the following invalid records:
       | User     | 1 | {:username=>["can't be blank", "is too short (minimum is 3 characters)"]} |
-      | Post     | 1 | {:category=>["can't be blank"]} |
+      | Post     | 1 | {:category=>["must exist", "can't be blank"]} |
+
+  Scenario: Check sanity on database with invalid records with ignored classes
+    Given the database contains a few valid records
+    And the first author's username is empty and the first post category_id is nil
+    And the User class is ignored
+    When I run "rake db:check_sanity"
+    Then I should see "Checking the following models: Category, Post"

data/features/check_sanity_with_db_storage.feature

@@ -9,7 +9,7 @@ Feature: Check sanity with db storage
 
   Scenario: Check sanity on empty database
     When I run "rake db:check_sanity"
-    Then I should see "Checking the following models: InvalidRecord, Category, Post, User"
+    Then I should see "Checking the following models: Category, Post, User"
     Then the table "invalid_records" should be empty
 
   Scenario: Check sanity on database with valid records
@@ -19,37 +19,37 @@ Feature: Check sanity with db storage
 
   Scenario: Check sanity on database with invalid records
     Given the database contains a few valid records
-    And the first user's username is empty and the first post category_id is nil
+    And the first author's username is empty and the first post category_id is nil
     When I run "rake db:check_sanity"
     Then the table "invalid_records" should contain:
-      | User     | 1 | {:username=>["is too short (minimum is 3 characters)"]} |
-      | Post     | 1 | {:category=>["can't be blank"]} |
+      | User     | 1 | {:username=>["can't be blank", "is too short (minimum is 3 characters)"]} |
+      | Post     | 1 | {:category=>["must exist", "can't be blank"]} |
 
   Scenario: Check sanity on database with invalid records now valid
     Given the database contains a few valid records
-    And the first user's username is empty and the first post category_id is nil
+    And the first author's username is empty and the first post category_id is nil
     When I run "rake db:check_sanity"
     Then the table "invalid_records" should contain:
-      | User     | 1 | {:username=>["is too short (minimum is 3 characters)"]} |
-      | Post     | 1 | {:category=>["can't be blank"]} |
+      | User     | 1 | {:username=>["can't be blank", "is too short (minimum is 3 characters)"]} |
+      | Post     | 1 | {:category=>["must exist", "can't be blank"]} |
 
-    Given the first user's username is "Greg"
+    Given the first author's username is "Greg"
     When I run "rake db:check_sanity"
     Then the table "invalid_records" should contain:
-      | Post     | 1 | {:category=>["can't be blank"]} |
+      | Post     | 1 | {:category=>["must exist", "can't be blank"]} |
     Then the table "invalid_records" should not contain errors for "User" "1"
 
   Scenario: Check sanity on database with invalid records that were invalid for different reasons earlier
     Given the database contains a few valid records
-    And the first user's username is empty and the first post category_id is nil
+    And the first author's username is empty and the first post category_id is nil
     When I run "rake db:check_sanity"
     Then the table "invalid_records" should contain:
-      | User     | 1 | {:username=>["is too short (minimum is 3 characters)"]} |
-      | Post     | 1 | {:category=>["can't be blank"]} |
+      | User     | 1 | {:username=>["can't be blank", "is too short (minimum is 3 characters)"]} |
+      | Post     | 1 | {:category=>["must exist", "can't be blank"]} |
 
     Given the first post category is set
     And the first post title is empty
     When I run "rake db:check_sanity"
     Then the table "invalid_records" should contain:
-      | User     | 1 | {:username=>["is too short (minimum is 3 characters)"]} |
+      | User     | 1 | {:username=>["can't be blank", "is too short (minimum is 3 characters)"]} |
       | Post     | 1 | {:title=>["can't be blank"]} |

data/features/step_definitions/rails_app.rb

@@ -1,50 +1,66 @@
-def setup_rails_app
-  return if File.directory?("test/rails_app")
+SystemCommandFailed = Class.new(StandardError)
 
-  unless system "bundle exec rails new test/rails_app -m test/rails_template.rb"
-    system("rm -fr test/rails_app")
-    raise "Failed to generate test/rails_app"
-  end
+def system!(cmd)
+  system(cmd) || raise(SystemCommandFailed, cmd)
+end
+
+def setup_rails_app
+  return if File.directory?('test/rails_app')
+
+  system! 'bundle exec rails new test/rails_app --skip-sprockets --skip-spring --skip-javascript --skip-turbolinks'
+  system! 'cd ./test/rails_app && bundle'
+  system! 'cd ./test/rails_app && bin/rails app:template LOCATION=../rails_template.rb'
+  system!' cd ./test/rails_app && RAILS_ENV=test bin/rails db:migrate'
+rescue SystemCommandFailed => e
+  system!('rm -fr test/rails_app')
+  raise e
 end
 
 Given /^I have a rails app using 'active_sanity'$/ do
-  Dir["./test/rails_app/db/migrate/*create_invalid_records.rb"].each do |migration|
-    raise unless system("rm #{migration}")
+  Dir['./test/rails_app/db/migrate/*create_invalid_records.rb'].each do |migration|
+    fail unless system("rm #{migration}")
   end
 
   setup_rails_app
 
   require './test/rails_app/config/environment'
+
+  # Reset connection
+  ActiveRecord::Base.connection.reconnect!
 end
 
 Given /^I have a rails app using 'active_sanity' with db storage$/ do
   setup_rails_app
 
-  raise unless system("cd ./test/rails_app && rails generate active_sanity && rake db:migrate")
+  fail unless system('cd ./test/rails_app && bundle exec rails generate active_sanity && RAILS_ENV=test bundle exec rake db:migrate')
 
   require './test/rails_app/config/environment'
 
   # Reset connection
   ActiveRecord::Base.connection.reconnect!
-  InvalidRecord.table_exists?
+  InvalidRecord.table_exists?.should be true # Looks up if table exists.
 end
 
 Given /^the database contains a few valid records$/ do
-  User.create!(:first_name => "Greg", :last_name => "Bell", :username => "gregbell")
-  User.create!(:first_name => "Sam",  :last_name => "Vincent", :username => "samvincent")
-  Category.create!(:name => "Uncategorized")
-  Post.create!(:author => User.first, :category => Category.first,
-    :title => "How ActiveAdmin changed the world", :body => "Only gods knows how...",
-    :published_at => 4.years.from_now)
+  Author.create!(first_name: 'Greg', last_name: 'Bell', username: 'gregbell')
+  Publisher.create!(first_name: 'Sam',  last_name: 'Vincent', username: 'samvincent')
+  Category.create!(name: 'Uncategorized')
+  Post.create!(author: Author.first!, category: Category.first!,
+    title: 'How ActiveAdmin changed the world', body: 'Lot of love.',
+    published_at: 4.years.from_now)
 end
 
-Given /^the first user's username is empty and the first post category_id is nil$/ do
-  User.first.update_attribute(:username, "")
+Given /^the first author's username is empty and the first post category_id is nil$/ do
+  Author.first.update_attribute(:username, '')
   Post.first.update_attribute(:category_id, nil)
 end
 
-Given /^the first user's username is "([^"]*)"$/ do |username|
-  User.first.update_attribute('username', username)
+Given /^the User class is ignored$/ do
+  system("echo 'models: User' > active_sanity.ignore.yml")
+end
+
+Given /^the first author's username is "([^"]*)"$/ do |username|
+  Author.first.update_attribute('username', username)
 end
 
 Given /^the first post category is set$/ do
@@ -55,13 +71,11 @@ Given /^the first post title is empty$/ do
   Post.first.update_attribute('title', '')
 end
 
-
 When /^I run "([^"]*)"$/ do |command|
-  puts @output = `cd ./test/rails_app && #{command}; echo "RETURN:$?"`
-  raise unless @output['RETURN:0']
+  puts @output = `cd ./test/rails_app && RAILS_ENV=test bundle exec #{command} --trace; echo "RETURN:$?"`
+  fail unless @output['RETURN:0']
 end
 
-
 Then /^I should see the following invalid records:$/ do |table|
   table.raw.each do |model, id, errors|
     @output.should =~ /#{model}\s+\|\s+#{id}\s+\|\s+#{Regexp.escape errors}/
@@ -82,30 +96,15 @@ end
 
 Then /^the table "([^"]*)" should contain:$/ do |_, table|
   table.raw.each do |model, id, errors|
-    invalid_record = InvalidRecord.where(:record_type => model, :record_id => id).first
+    invalid_record = InvalidRecord.where(record_type: model, record_id: id).first
     invalid_record.should be_an_instance_of(InvalidRecord)
     errors = eval(errors)
     errors.each do |k, v|
-      begin
-        invalid_record.validation_errors[k].should == v
-      rescue RSpec::Expectations::ExpectationNotMetError => e
-        # A bug in serialization of ordered hash get rid of the array of
-        # errors. The following is stored in the db:
-        # --- !omap 
-        #   - :username: can't be blank
-        #   - :username: is too short (minimum is 3 characters)
-        #
-        #   https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/6646-orderedhash-serialization-does-not-work-when-storing-arrays
-        #
-        # You actually get the last error on an attribute only
-        # 
-        invalid_record.validation_errors[k].should == v.last
-      end
+      invalid_record.validation_errors[k].should == v
     end
   end
 end
 
 Then /^the table "([^"]*)" should not contain errors for "([^"]*)" "([^"]*)"$/ do |_, model, id|
-    InvalidRecord.where(:record_type => model, :record_id => id).first.should be_nil
+  InvalidRecord.where(record_type: model, record_id: id).first.should be_nil
 end
-

data/features/support/env.rb

@@ -1,20 +1,23 @@
 ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../Gemfile', __FILE__)
 
 require 'rubygems'
-require "bundler"
+require 'bundler'
 Bundler.setup
 
-system("rm ./test/rails_app/db/migrate/*create_invalid_records.rb")
-
-raise unless File.directory?("test/rails_app") && system("cd test/rails_app && rake db:drop db:create db:migrate")
+if File.directory?('test/rails_app')
+  Dir.chdir('test/rails_app') do
+    fail unless system('rm -f db/migrate/*create_invalid_records.rb && RAILS_ENV=test bin/rails db:drop db:create db:migrate')
+  end
+end
 
 After do
   # Reset DB!
-  User.delete_all
-  Category.delete_all
-  Post.delete_all
-  InvalidRecord.delete_all if InvalidRecord.table_exists?
-  %w(users categories posts invalid_records).each do |table|
-    ActiveRecord::Base.connection.execute("DELETE FROM sqlite_sequence WHERE name='#{table}'")
+  tables = %w(categories invalid_records posts users)
+  conn = ActiveRecord::Base.connection
+  tables.each do |table|
+    if conn.table_exists?(table)
+      conn.execute("DELETE FROM '#{table}'")
+      conn.execute("DELETE FROM sqlite_sequence WHERE name='#{table}'")
+    end
   end
 end

data/lib/active_sanity.rb

@@ -1,4 +1,3 @@
 require File.dirname(__FILE__) + '/active_sanity/checker'
 require File.dirname(__FILE__) + '/active_sanity/invalid_record'
 require File.dirname(__FILE__) + '/active_sanity/railtie'
-

data/lib/active_sanity/checker.rb

@@ -1,44 +1,91 @@
 module ActiveSanity
   class Checker
+    class << self
+      attr_accessor :batch_size
+    end
+
+    def initialize
+      Checker.batch_size ||= 500
+    end
+
     def self.check!
       new.check!
     end
 
     def check!
-      puts "Sanity Check"
+      puts 'Sanity Check'
       puts "Checking the following models: #{models.join(', ')}"
 
+      # TODO: Wouldnt this list already be checked by the next all records call if those records do exist?
+      # This will validate and destroy the records that either dont exist currently, or are now valid. But the ones are continue to be invalid - these will
+      # have been run through the validation process twice
       check_previously_invalid_records
       check_all_records
     end
 
+    # @return [Array] of [ActiveRecord::Base] direct descendants
     def models
-      # Ensure ActiveRecord::Base is aware of all models under
-      # app/models
-      Dir["#{Rails.root}/app/models/**/*.rb"].each do |file_path|
-        require file_path rescue nil
+      return @models if @models
+
+      load_all_models
+
+      @models ||= direct_active_record_base_descendants
+      @models -= [InvalidRecord]
+      if File.exist?('active_sanity.ignore.yml')
+        yaml_contents = YAML.load_file('active_sanity.ignore.yml')
+        model_names_to_ignore = Array(yaml_contents['models'] || []).uniq
+        @models = @models.reject { |model| model_names_to_ignore.include?(model.name) }
       end
-      
-      @models ||= ActiveRecord::Base.subclasses 
+      @models
     end
 
     protected
 
+    # Require all files under /app/models.
+    # All models under /lib are required when the rails app loads.
+    def load_all_models
+      Dir["#{Rails.root}/app/models/**/*.rb"].each { |file_path| require file_path rescue nil }
+    end
+
+    # @return [Array] of direct ActiveRecord::Base descendants.
+    # Example:
+    # The following tree:
+    #   ActiveRecord::Base
+    #   |
+    #   |- User
+    #   |- Account
+    #   |  |
+    #   |  |- PersonalAccount
+    #   |  |- BusinessAccount
+    #
+    # Should return: [Account, User]
+    def direct_active_record_base_descendants
+      parent_class = defined?(ApplicationRecord) ? ApplicationRecord : ActiveRecord::Base
+      parent_class.descendants.select(&:descends_from_active_record?).sort_by(&:name)
+    end
+
+    # Remove records that are now valid from the list of invalid records.
     def check_previously_invalid_records
       return unless InvalidRecord.table_exists?
 
-      InvalidRecord.find_each do |invalid_record|
-        invalid_record.destroy if invalid_record.record.valid?
+      InvalidRecord.find_each(batch_size: Checker.batch_size) do |invalid_record|
+        begin
+          invalid_record.destroy if invalid_record.record.valid?
+        rescue
+          # Record does not exists.
+          invalid_record.delete
+        end
       end
     end
 
+    # Go over every single record. When the record is not valid
+    # log it to STDOUT and into the invalid_records table if it exists.
     def check_all_records
       models.each do |model|
         begin
-          model.find_each do |record|
-            unless record.valid?
-              invalid_record!(record)
-            end
+          # TODO: Can we filter based on those records that are already present in the 'invalid_records' table - especially since they have been re-verified in the method before?
+          model.find_each(batch_size: Checker.batch_size) do |record|
+            invalid_record!(record) unless record.valid?
           end
         rescue => e
           # Rescue from exceptions (table does not exists,
@@ -54,22 +101,30 @@ module ActiveSanity
       store_invalid_record(record)
     end
 
+    # Say that the record is invalid. Example:
+    #
+    # Account | 10 | :name => "Can't be blank"
     def log_invalid_record(record)
-      puts record.class.to_s + " | " + record.id.to_s + " | " + pretty_errors(record)
+      puts "#{type_of(record)} | #{record.id} | #{pretty_errors(record)}"
     end
-    
+
+    # Store invalid record in InvalidRecord table if it exists
     def store_invalid_record(record)
       return unless InvalidRecord.table_exists?
 
-      invalid_record = InvalidRecord.where(:record_type => record.type, :record_id => record.id).first
+      invalid_record = InvalidRecord.where(record: record).first
       invalid_record ||= InvalidRecord.new
       invalid_record.record = record
-      invalid_record.validation_errors = record.errors
+      invalid_record.validation_errors = record.errors.messages
       invalid_record.save!
     end
 
+    def type_of(record)
+      record.class.base_class
+    end
+
     def pretty_errors(record)
-      record.errors.inspect.sub(/^#<OrderedHash /, '').sub(/>$/, '')
+      record.errors.messages.inspect.sub(/^#<OrderedHash (.*)>$/, '\1')
     end
   end
 end

data/lib/active_sanity/invalid_record.rb

@@ -1,6 +1,7 @@
 class InvalidRecord < ActiveRecord::Base
-  belongs_to :record, :polymorphic => true
+  belongs_to :record, polymorphic: true
   serialize :validation_errors
 
-  validates_presence_of :record, :validation_errors
+  validates :record, :validation_errors, presence: true
+  validates :record_id, presence: true, uniqueness: { scope: :record_type }
 end

data/lib/active_sanity/railtie.rb

@@ -8,4 +8,3 @@ module ActiveSanity
     end
   end
 end
-

data/lib/active_sanity/tasks.rb

@@ -1,7 +1,6 @@
 namespace :db do
-  desc "Check records sanity"
-  task :check_sanity => :environment do
+  desc 'Check records sanity'
+  task check_sanity: :environment do
     ActiveSanity::Checker.check!
   end
 end
-

data/lib/active_sanity/version.rb

@@ -1,3 +1,3 @@
 module ActiveSanity
-  VERSION = "0.1.0"
+  VERSION = '0.5.0'
 end

data/lib/generators/active_sanity/active_sanity_generator.rb

@@ -6,21 +6,31 @@ module ActiveSanity
       include Rails::Generators::Migration
 
       def self.source_root
-         @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
       end
 
       def self.next_migration_number(dirname) #:nodoc:
         next_migration_number = current_migration_number(dirname) + 1
         if ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+          [Time.now.utc.strftime('%Y%m%d%H%M%S'), '%.14d' % next_migration_number].max
         else
-          "%.3d" % next_migration_number
+          '%.3d' % next_migration_number
         end
       end
 
       def create_migration_file
-          migration_template 'create_invalid_records.rb', 'db/migrate/create_invalid_records.rb'
+        migration_template 'create_invalid_records.rb.erb', 'db/migrate/create_invalid_records.rb'
       end
+
+      # Used by migration file
+      def rails_version
+        if Rails.version >= "5"
+          "[#{Rails.version.gsub(/\.\d+$/, '')}]" # 5.0
+        else
+          nil
+        end
+      end
+
     end
   end
 end

data/lib/generators/active_sanity/templates/create_invalid_records.rb.erb

@@ -0,0 +1,13 @@
+class CreateInvalidRecords < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def up
+    create_table :invalid_records do |t|
+      t.references :record, polymorphic: true, null: false
+      t.text :validation_errors
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :invalid_records
+  end
+end

data/test/rails_template.rb

@@ -1,37 +1,56 @@
-
 # Generate some test models
-generate :model, "post title:string body:text published_at:datetime author_id:integer category_id:integer"
+
+BASE_MODEL_CLASS = Rails.version >= "5." ? "ApplicationRecord" : "ActiveRecord::Base"
+
+# Post
+generate :model, 'post title:string body:text published_at:datetime author_id:integer category_id:integer'
 post_code = <<-CODE
   belongs_to :author, :class_name => 'User'
   belongs_to :category
   accepts_nested_attributes_for :author
 
-  validates_presence_of :author, :category, :title, :published_at
-CODE
-inject_into_file 'app/models/post.rb', post_code, :after => "class Post < ActiveRecord::Base\n"
-
-generate :model, "user first_name:string last_name:string username:string"
-user_code = <<-CODE
-  has_many :posts, :foreign_key => 'author_id'
-
-  validates_presence_of :first_name, :last_name, :username
-  validates_length_of :username, :minimum => 3
+  validates :author, :category, :title, :published_at, presence: true
 CODE
-inject_into_file 'app/models/user.rb', user_code, :after => "class User < ActiveRecord::Base\n"
+inject_into_file 'app/models/post.rb', post_code, after: "class Post < #{BASE_MODEL_CLASS}\n"
 
+# Category
 generate :model, 'category name:string description:text'
 category_code = <<-CODE
   has_many :posts
 
-  validates_presence_of :name
+  validates :name, presence: true
 CODE
-inject_into_file 'app/models/category.rb', category_code, :after => "class Category < ActiveRecord::Base\n"
+inject_into_file 'app/models/category.rb', category_code, after: "class Category < #{BASE_MODEL_CLASS}\n"
 
-create_file 'app/models/not_a_model.rb', "class NotAModel; end"
+# User
+generate :model, 'user first_name:string last_name:string username:string type:string'
+user_code = <<-CODE
+  has_many :posts, :foreign_key => 'author_id'
+
+  validates :first_name, :last_name, :username, presence: true
+  validates :username, length: { minimum: 3 }
+CODE
+inject_into_file 'app/models/user.rb', user_code, after: "class User < #{BASE_MODEL_CLASS}\n"
+
+# Author < User
+create_file 'app/models/author.rb', 'class Author < User; end'
+# Publisher < User
+create_file 'app/models/publisher.rb', 'class Publisher < User; end'
+
+# NotAModel
+create_file 'app/models/not_a_model.rb', 'class NotAModel; end'
 
 # Add active_sanity
 append_file 'Gemfile', "gem 'active_sanity', :path => '../../'"
 
-run "bundle"
-rake "db:migrate"
+# Configure for custom batch_size
+custom_batch_size_code = <<-CODE
+  config.after_initialize do
+    ActiveSanity::Checker.batch_size = 439
+  end
+CODE
+
+inject_into_file 'config/application.rb', custom_batch_size_code, after: " < Rails::Application\n"
 
+run 'bundle'
+rake 'db:drop db:create db:migrate'

metadata

@@ -1,97 +1,102 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: active_sanity
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.5.0
 platform: ruby
-authors: 
-- VersaPay
+authors:
 - Philippe Creux
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-30 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: cucumber
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id004
-description: Performs a Sanity Check of your database by logging all invalid Active Records
-email: 
-- philippe.creux@versapay.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Performs a Sanity Check of your database by logging all invalid Active
+  Records
+email:
+- pcreux@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - active_sanity.gemspec
+- commits.csv
 - features/check_sanity.feature
 - features/check_sanity_with_db_storage.feature
 - features/step_definitions/rails_app.rb
@@ -103,43 +108,31 @@ files:
 - lib/active_sanity/tasks.rb
 - lib/active_sanity/version.rb
 - lib/generators/active_sanity/active_sanity_generator.rb
-- lib/generators/active_sanity/templates/create_invalid_records.rb
+- lib/generators/active_sanity/templates/create_invalid_records.rb.erb
 - test/rails_template.rb
-has_rdoc: true
-homepage: https://github.com/versapay/active_sanity
+homepage: https://github.com/pcreux/active_sanity
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Checks Sanity of Active Record records
-test_files: 
+test_files:
 - features/check_sanity.feature
 - features/check_sanity_with_db_storage.feature
 - features/step_definitions/rails_app.rb

data/lib/generators/active_sanity/templates/create_invalid_records.rb

@@ -1,15 +0,0 @@
-class CreateInvalidRecords < ActiveRecord::Migration
-  def self.up
-    create_table :invalid_records do |t|
-      t.references :record, :polymorphic => true, :null => false
-      t.text :validation_errors
-      t.timestamps
-    end
-    add_index :invalid_records, [:record_type, :record_id]
-  end
-
-  def self.down
-    drop_table :invalid_records
-  end
-end
-