active_sanity 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8248c888df98cac5aaf92207bc779e65d8f5ce6b
-  data.tar.gz: f6d28662717362e4ff29c15928764d377bd4568c
+  metadata.gz: 5cf8143fcceaa8ee3dd6fe9ceff8f66844b62f47
+  data.tar.gz: e07b90a22a9591f456786e02a816d683b876f70c
 SHA512:
-  metadata.gz: eacaaa0e54fb59f9c86b61a24a38d0afe33a5a1412c187bb137e5853f4ef3a8238e0c4cb66ede65faf2ee2128f267870899e6da4bc0fc20325a65aeb9b9aa83b
-  data.tar.gz: e1ee326e7b619d50fb1453c4b585baf186ebb253c8d78d5b04bc11459d9183b35b3e3331d6c2eb1109d7c24135b485e1f9db10ec2b0cd3e104245ce44d9b2dba
+  metadata.gz: 1072acfdf533b9ae67c1d6d146978e2c472a356c3d2f4acb6f23d3bc72dadb21196c0675a4f63cae9871f78c05c5c763d3f59d1b9d908e0e7960012817f882cd
+  data.tar.gz: 57c275494f381403304da75d3a3193d5e544481c4e2141d56ff959d5fc23ad0adc2b623f51e36300b062dcbfdbf8566a6a306fed49c0bd40836610560eb804f7

data/.gitignore

@@ -5,3 +5,4 @@
 Gemfile.lock
 pkg/*
 test/rails_app
+active_sanity.ignore.yml

data/Gemfile

@@ -2,3 +2,5 @@ source 'http://rubygems.org'
 
 # Specify your gem's dependencies in active_sanity.gemspec
 gemspec
+
+gem 'sqlite3'

data/README.md

@@ -1,13 +1,13 @@
 # Active Sanity
 
-[![Build Status](https://secure.travis-ci.org/versapay/active_sanity.png)](http://travis-ci.org/versapay/active_sanity)
+[![Build Status](https://secure.travis-ci.org/pcreux/active_sanity.png)](http://travis-ci.org/pcreux/active_sanity)
 
 Perform a sanity check on your database through active record
 validation.
 
 ## Requirements
 
-* ActiveSanity ~0.3 requires Rails ~4.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
 
@@ -29,7 +29,7 @@ Just run:
     rake 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:
@@ -39,7 +39,7 @@ 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"] }
 
-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'):
+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
@@ -47,6 +47,12 @@ By default, the number of records fetched from the database for validation is se
       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
+
+    models:
+      - '<name of class to ignore>'
+      - '<name of class to ignore>'
+
 
 ## Contribute & Dev environment
 

data/active_sanity.gemspec

@@ -6,13 +6,13 @@ Gem::Specification.new do |s|
   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.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/versapay/active_sanity'
+  s.homepage    = 'https://github.com/pcreux/active_sanity'
 
-  s.add_dependency 'rails', '>=4.0'
+  s.add_dependency 'rails', '< 5.0'
 
   s.required_ruby_version = '>= 1.9.3'
 

data/features/check_sanity.feature

@@ -24,3 +24,10 @@ Feature: 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"]} |
+
+  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/step_definitions/rails_app.rb

@@ -1,7 +1,7 @@
 def setup_rails_app
   return if File.directory?('test/rails_app')
 
-  unless system 'bundle exec rails new test/rails_app -m test/rails_template.rb && cd ./test/rails_app && RAILS_ENV=test rake db:migrate'
+  unless system 'bundle exec rails new test/rails_app -m test/rails_template.rb && cd ./test/rails_app && RAILS_ENV=test bundle exec rake db:migrate'
     system('rm -fr test/rails_app')
     fail 'Failed to generate test/rails_app'
   end
@@ -23,7 +23,7 @@ end
 Given /^I have a rails app using 'active_sanity' with db storage$/ do
   setup_rails_app
 
-  fail unless system('cd ./test/rails_app && rails generate active_sanity && RAILS_ENV=test 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'
 
@@ -46,6 +46,10 @@ Given /^the first author's username is empty and the first post category_id is n
   Post.first.update_attribute(:category_id, nil)
 end
 
+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
@@ -59,7 +63,7 @@ Given /^the first post title is empty$/ do
 end
 
 When /^I run "([^"]*)"$/ do |command|
-  puts @output = `cd ./test/rails_app && export RAILS_ENV=test && bundle exec #{command} --trace; echo "RETURN:$?"`
+  puts @output = `cd ./test/rails_app && RAILS_ENV=test bundle exec #{command} --trace; echo "RETURN:$?"`
   fail unless @output['RETURN:0']
 end
 

data/lib/active_sanity/checker.rb

@@ -31,6 +31,12 @@ module ActiveSanity
 
       @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
     end
 
     protected
@@ -54,7 +60,8 @@ module ActiveSanity
     #
     # Should return: [Account, User]
     def direct_active_record_base_descendants
-      ActiveRecord::Base.descendants.select(&:descends_from_active_record?).sort_by(&:name)
+      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.

data/lib/active_sanity/version.rb

@@ -1,3 +1,3 @@
 module ActiveSanity
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/generators/active_sanity/active_sanity_generator.rb

@@ -19,8 +19,18 @@ module ActiveSanity
       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 → create_invalid_records.rb.erb}

@@ -1,11 +1,10 @@
-class CreateInvalidRecords < ActiveRecord::Migration
+class CreateInvalidRecords < ActiveRecord::Migration<%= rails_version %>
   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

data/test/rails_template.rb

@@ -1,6 +1,7 @@
-
 # Generate some test models
 
+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
@@ -10,7 +11,7 @@ post_code = <<-CODE
 
   validates :author, :category, :title, :published_at, presence: true
 CODE
-inject_into_file 'app/models/post.rb', post_code, after: "class Post < 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'
@@ -19,7 +20,7 @@ category_code = <<-CODE
 
   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"
 
 # User
 generate :model, 'user first_name:string last_name:string username:string type:string'
@@ -29,7 +30,7 @@ user_code = <<-CODE
   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 < ActiveRecord::Base\n"
+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'
@@ -52,4 +53,4 @@ CODE
 inject_into_file 'config/application.rb', custom_batch_size_code, after: " < Rails::Application\n"
 
 run 'bundle'
-rake 'db:migrate'
+rake 'db:drop db:create db:migrate'

metadata

@@ -1,30 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: active_sanity
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
-- VersaPay
 - Philippe Creux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +69,7 @@ dependencies:
 description: Performs a Sanity Check of your database by logging all invalid Active
   Records
 email:
-- philippe.creux@versapay.com
+- pcreux@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -82,6 +81,7 @@ files:
 - 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
@@ -93,9 +93,9 @@ 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
-homepage: https://github.com/versapay/active_sanity
+homepage: https://github.com/pcreux/active_sanity
 licenses: []
 metadata: {}
 post_install_message: 
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Checks Sanity of Active Record records