active_sanity 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+test/rails_app

data/Gemfile

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

data/README.md

@@ -0,0 +1,55 @@
+# Active Sanity
+
+Perform a sanity check on your database through active record
+validation.
+
+## Install
+
+Add the following line to your Gemfile
+
+    gem 'active_sanity'
+
+If you wish to store invalid records in your database run:
+
+    $ rails generate active_sanity
+    $ rake db:migrate
+
+## Usage
+
+Just run:
+
+    rake db:sanity_check
+
+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
+invalid_records if it exists and output all invalid records.
+
+The output might look like the following:
+
+    model       | id  | errors
+    User        |   1 | { "email" => ["is invalid"] }
+    Flight      | 123 | { "arrival_time" => ["can't be nil"], "departure_time" => ["is invalid"] }
+    Flight      | 323 | { "arrival_time" => ["can't be nil"] }
+
+## Known issues
+
+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.
+
+See https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/6646-orderedhash-serialization-does-not-work-when-storing-arrays 
+
+## Contribute & Dev environment
+
+Usual fork & pull request.
+
+This gem is quite simple so I experiment using features only. To run the
+acceptance test suite, just run:
+
+    bundle install
+    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
+the same test suite. I guess that the same complexity would arise using
+any other testing framework.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/active_sanity.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_sanity/version"
+
+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.homepage    = ""
+  s.summary     = %q{Active Record databases Sanity Check }
+  s.description = %q{Performs a sanity check on your database through active record validations.}
+
+  s.add_dependency "rails", ">=3.0.0"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "sqlite3"
+
+  s.rubyforge_project = "active_sanity"
+
+  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"]
+end

data/features/check_sanity.feature

@@ -0,0 +1,26 @@
+Feature: Check sanity
+
+  As a developer
+  In order to ensure that existing records are valid
+  I want to run 'rake db:check_sanity' and see which records are invalid
+
+  Background:
+    Given I have a rails app using 'active_sanity'
+
+  Scenario: Check sanity on empty database
+    When I run "rake db:check_sanity"
+    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
+    Given the database contains a few valid records
+    When I run "rake db:check_sanity"
+    Then I should not see any invalid records
+
+  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
+    When I run "rake db:check_sanity --trace"
+    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"]} |

data/features/check_sanity_with_db_storage.feature

@@ -0,0 +1,55 @@
+Feature: Check sanity with db storage
+
+  As a developer
+  In order to ensure that existing records are valid
+  I want to run 'rake db:check_sanity' to log invalid records in the db
+
+  Background:
+    Given I have a rails app using 'active_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: Category, Post, User"
+    Then the table "invalid_records" should be empty
+
+  Scenario: Check sanity on database with valid records
+    Given the database contains a few valid records
+    When I run "rake db:check_sanity"
+    Then the table "invalid_records" should be empty
+
+  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
+    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"]} |
+
+  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
+    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"
+    When I run "rake db:check_sanity"
+    Then the table "invalid_records" should contain:
+      | Post     | 1 | {:category=>["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
+    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 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)"]} |
+      | Post     | 1 | {:title=>["can't be blank"]} |

data/features/step_definitions/rails_app.rb

@@ -0,0 +1,111 @@
+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"
+    system("rm -fr test/rails_app")
+    raise "Failed to generate test/rails_app"
+  end
+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}")
+  end
+
+  setup_rails_app
+
+  require './test/rails_app/config/environment'
+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")
+
+  require './test/rails_app/config/environment'
+
+  # Reset connection
+  ActiveRecord::Base.connection.reconnect!
+  InvalidRecord.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)
+end
+
+Given /^the first user's username is empty and the first post category_id is nil$/ do
+  User.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)
+end
+
+Given /^the first post category is set$/ do
+  Post.first.update_attribute('category_id', Category.first.id)
+end
+
+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']
+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}/
+  end
+end
+
+Then /^I should see "([^"]*)"$/ do |output|
+  @output.should include(output)
+end
+
+Then /^I should not see any invalid records$/ do
+  @output.should_not include('|')
+end
+
+Then /^the table "([^"]*)" should be empty$/ do |_|
+  InvalidRecord.count.should == 0
+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.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
+    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
+end
+

data/features/support/env.rb

@@ -0,0 +1,20 @@
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../Gemfile', __FILE__)
+
+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")
+
+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}'")
+  end
+end

data/lib/active_sanity.rb

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,66 @@
+module ActiveSanity
+  class Checker
+    def self.check!
+      new.check!
+    end
+
+    def check!
+      puts "Sanity Check"
+      puts "Checking the following models: #{models.join(', ')}"
+
+      check_previously_invalid_records
+      check_all_records
+    end
+
+    def models
+      @models ||= Dir["#{Rails.root}/app/models/**/*.rb"].map do |file_path|
+        basename  = File.basename(file_path, File.extname(file_path))
+        klass     = basename.camelize.constantize
+        klass.new.is_a?(ActiveRecord::Base) ? klass : nil
+      end.compact
+    end
+
+    protected
+
+    def check_previously_invalid_records
+      return unless InvalidRecord.table_exists?
+
+      InvalidRecord.find_each do |invalid_record|
+        invalid_record.destroy if invalid_record.record.valid?
+      end
+    end
+
+    def check_all_records
+      models.each do |model|
+        model.find_each do |record|
+          unless record.valid?
+            invalid_record!(record)
+          end
+        end
+      end
+    end
+
+    def invalid_record!(record)
+      log_invalid_record(record)
+      store_invalid_record(record)
+    end
+
+    def log_invalid_record(record)
+      puts record.class.to_s + " | " + record.id.to_s + " | " + pretty_errors(record)
+    end
+    
+    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.new
+      invalid_record.record = record
+      invalid_record.validation_errors = record.errors
+      invalid_record.save!
+    end
+
+    def pretty_errors(record)
+      record.errors.inspect.sub(/^#<OrderedHash /, '').sub(/>$/, '')
+    end
+  end
+end

data/lib/active_sanity/invalid_record.rb

@@ -0,0 +1,6 @@
+class InvalidRecord < ActiveRecord::Base
+  belongs_to :record, :polymorphic => true
+  serialize :validation_errors
+
+  validates_presence_of :record, :validation_errors
+end

data/lib/active_sanity/railtie.rb

@@ -0,0 +1,11 @@
+require 'active_sanity'
+require 'rails'
+
+module ActiveSanity
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'active_sanity/tasks.rb'
+    end
+  end
+end
+

data/lib/active_sanity/tasks.rb

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

data/lib/active_sanity/version.rb

@@ -0,0 +1,3 @@
+module ActiveSanity
+  VERSION = "0.0.1"
+end

data/lib/generators/active_sanity/active_sanity_generator.rb

@@ -0,0 +1,26 @@
+module ActiveSanity
+  module Generators
+    class ActiveSanityGenerator < Rails::Generators::Base
+      desc "Generate migration to create table 'invalid_records'"
+
+      include Rails::Generators::Migration
+
+      def self.source_root
+         @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
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def create_migration_file
+          migration_template 'create_invalid_records.rb', 'db/migrate/create_invalid_records.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+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
+

data/test/rails_template.rb

@@ -0,0 +1,37 @@
+
+# Generate some test models
+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
+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
+
+  validates_presence_of :name
+CODE
+inject_into_file 'app/models/category.rb', category_code, :after => "class Category < ActiveRecord::Base\n"
+
+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"
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: active_sanity
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- VersaPay
+- Philippe Creux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "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"
+  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"
+  type: :development
+  version_requirements: *id004
+description: Performs a sanity check on your database through active record validations.
+email: 
+- philippe.creux@versapay.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- active_sanity.gemspec
+- features/check_sanity.feature
+- features/check_sanity_with_db_storage.feature
+- features/step_definitions/rails_app.rb
+- features/support/env.rb
+- lib/active_sanity.rb
+- lib/active_sanity/checker.rb
+- lib/active_sanity/invalid_record.rb
+- lib/active_sanity/railtie.rb
+- 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
+- test/rails_template.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: active_sanity
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Active Record databases Sanity Check
+test_files: 
+- features/check_sanity.feature
+- features/check_sanity_with_db_storage.feature
+- features/step_definitions/rails_app.rb
+- features/support/env.rb
+- test/rails_template.rb