active_sanity 0.1.0 → 0.1.1

data/Rakefile

@@ -1,2 +1,16 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task :default => :features
+
+desc "Run features"
+task :features do
+  raise "Failed!" unless system('bundle exec cucumber features')
+end
+
+desc "Clean test rails app"
+task :clean do
+  if system('rm -r test/rails_app')
+    puts "test/rails_app deleted successfully"
+  end
+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, InvalidRecord, Post, User"
     Then I should not see any invalid records
 
   Scenario: Check sanity on database with valid records
@@ -19,8 +19,8 @@ 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)"]} |
+      | User     | 1 | {:username=>["can't be blank", "is too short (minimum is 3 characters)", "can't be blank", "can't be blank", "is too short (minimum is 3 characters)"]} |
       | Post     | 1 | {:category=>["can't be blank"]} |

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, InvalidRecord, Post, User"
     Then the table "invalid_records" should be empty
 
   Scenario: Check sanity on database with valid records
@@ -19,7 +19,7 @@ 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)"]} |
@@ -27,13 +27,13 @@ Feature: Check sanity with db storage
 
   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"]} |
 
-    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"]} |
@@ -41,7 +41,7 @@ Feature: Check sanity with db storage
 
   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)"]} |

data/features/step_definitions/rails_app.rb

@@ -30,21 +30,21 @@ Given /^I have a rails app using 'active_sanity' with db storage$/ do
 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")
+  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 => User.first, :category => Category.first,
-    :title => "How ActiveAdmin changed the world", :body => "Only gods knows how...",
+  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 first author's username is "([^"]*)"$/ do |username|
+  Author.first.update_attribute('username', username)
 end
 
 Given /^the first post category is set$/ do

data/features/support/env.rb

@@ -4,17 +4,20 @@ require 'rubygems'
 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
+    raise unless system("rm -f db/migrate/*create_invalid_records.rb && rake 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 = ['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/checker.rb

@@ -8,30 +8,63 @@ module ActiveSanity
       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
-      end
-      
-      @models ||= ActiveRecord::Base.subclasses 
+      return @models if @models
+
+      load_all_models
+
+      @models ||= direct_active_record_base_descendants
     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
+      ActiveRecord::Base.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?
+        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
@@ -54,22 +87,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_type => type_of(record), :record_id => record.id).first
       invalid_record ||= InvalidRecord.new
       invalid_record.record = record
       invalid_record.validation_errors = record.errors
       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.inspect.sub(/^#<OrderedHash (.*)>$/, '\1')
     end
   end
 end

data/lib/active_sanity/version.rb

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

data/test/rails_template.rb

@@ -1,5 +1,7 @@
 
 # Generate some test models
+
+# 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'
@@ -10,7 +12,17 @@ post_code = <<-CODE
 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"
+# Category
+generate :model, 'category name:string description:text'
+category_code = <<-CODE
+  has_many :posts
+
+  validates_presence_of :name
+CODE
+inject_into_file 'app/models/category.rb', category_code, :after => "class Category < ActiveRecord::Base\n"
+
+# User
+generate :model, "user first_name:string last_name:string username:string type:string"
 user_code = <<-CODE
   has_many :posts, :foreign_key => 'author_id'
 
@@ -19,14 +31,13 @@ user_code = <<-CODE
 CODE
 inject_into_file 'app/models/user.rb', user_code, :after => "class User < ActiveRecord::Base\n"
 
-generate :model, 'category name:string description:text'
-category_code = <<-CODE
-  has_many :posts
+# Author < User
+create_file 'app/models/author.rb', "class Author < User; end"
+# Publisher < User
+create_file 'app/models/publisher.rb', "class Publisher < User; end"
 
-  validates_presence_of :name
-CODE
-inject_into_file 'app/models/category.rb', category_code, :after => "class Category < ActiveRecord::Base\n"
 
+# NotAModel
 create_file 'app/models/not_a_model.rb', "class NotAModel; end"
 
 # Add active_sanity
@@ -34,4 +45,3 @@ append_file 'Gemfile', "gem 'active_sanity', :path => '../../'"
 
 run "bundle"
 rake "db:migrate"
-

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_sanity
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - VersaPay
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-30 00:00:00 -07:00
+date: 2011-09-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency