data_sanity 0.0.5 → 0.0.7

data/data_sanity.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version = DataSanity::VERSION
 
   gem.add_dependency "rails", "=3.0.6"
+  gem.add_dependency "rake", "=0.8.7"
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "sqlite3"

data/lib/data_sanity/inspector.rb

@@ -2,20 +2,25 @@ module DataSanity
   class Inspector
 
     CONSIDERED_RECORDS = 1
-    ALLOWED_VALIDATION = [:all, :random]
-    attr_accessor :all, :random, :models, :records_per_model
+    ALLOWED_VALIDATION = [:all, :random, :criteria]
+    attr_accessor :all, :random, :criteria, :models, :records_per_model
 
     def initialize options = {}
       options[:validate] == :random ? @random = true : @all = true
       @records_per_model = options[:records_per_model] || CONSIDERED_RECORDS
       @models = load_models
+      file_path = "#{Rails.root}/config/data_sanity_criteria.yml"
+      @criteria = File.exists?(file_path) ? (YAML.load File.open(file_path).read) : false
     end
 
     def investigate
       @models.each do |model_string|
         model = model_string.constantize
         validate_all(model) if @all
-        validate_random(model) if @random
+        if @random
+          validate_criteria(model, @criteria[model_string]) and return if @criteria && @criteria[model_string].present?
+          validate_random(model)
+        end
       end
     end
 
@@ -29,12 +34,25 @@ module DataSanity
 
     def validate_random(model)
       no_of_records = model.count
+      return if no_of_records == 0
       @records_per_model.times do
-        instance = model.first(:limit => 1, :offset => rand(no_of_records))
+        instance = model.offset(rand(no_of_records)).first
         populate_if_invalid_record(instance, model)
       end
     end
 
+    def validate_criteria(model, criteria)
+      criteria.each do |attribute, values|
+        values.each do |value|
+          results = model.where(attribute.to_sym => value)
+          count = results.count
+          next if count == 0
+          instance = results.offset(rand(count)).first
+          populate_if_invalid_record(instance, model)
+        end
+      end
+    end
+
     def populate_if_invalid_record(instance, model)
       DataInspector.create(:table_name => model.to_s,
                            :table_primary_key => model.primary_key,

data/lib/data_sanity/tasks.rb

@@ -1,5 +1,5 @@
-namespace :db do
-  namespace :data_sanity do
+namespace :data_sanity do
+  namespace :db do
     desc 'Create data inspector model for data sanity results'
     task :migrate => :environment do
       Dir.chdir("#{Rails.root}") do
@@ -16,4 +16,11 @@ namespace :db do
       end
     end
   end
+
+  desc 'Creating a sample criteria file'
+  task :citeria do
+    Dir.chdir("#{Rails.root}") do
+      system "cp #{File.open('./templates/data_sanity_criteria.yml').read} config/."
+    end
+  end
 end

data/lib/data_sanity/templates/data_sanity_criteria.yml

@@ -0,0 +1,10 @@
+############################################
+# This is a sample criteria.
+# Start with Model Name and
+#<Model Name>:    # Criteria-Rule to be applied
+#  <field name>:  # Anthing mentioned is considered for validations against mentioned below distinct values
+#    - 'Raju'     # Various values field can take
+#    - 'Saju'
+#    - 'Taju'
+#  <age>          # Anthing mentioned is considered for validations against all possible distinct values
+############################################

data/lib/data_sanity/version.rb

@@ -1,3 +1,3 @@
 module DataSanity
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/spec/data_sanity/inspector_spec.rb

@@ -7,21 +7,21 @@ describe "DataSanity::Inspector" do
     it "should set all switch as default options and populate all models of the applications" do
       inspector = DataSanity::Inspector.new
       inspector.all.should be_true
-      inspector.models.should == ["Person"]
+      inspector.models.should == ["Car", "Person"]
     end
 
     it "should set random switch, populate default records_per_model and populate all models of the applications" do
       inspector = DataSanity::Inspector.new :validate => :random
       inspector.random.should be_true
       inspector.records_per_model.should == 1
-      inspector.models.should == ["Person"]
+      inspector.models.should == ["Car", "Person"]
     end
 
     it "should set random switch, populate records_per_model and populate all models of the applications" do
       inspector = DataSanity::Inspector.new :validate => :random, :records_per_model => 5
       inspector.random.should be_true
       inspector.records_per_model.should == 5
-      inspector.models.should == ["Person"]
+      inspector.models.should == ["Car", "Person"]
     end
   end
 
@@ -30,14 +30,14 @@ describe "DataSanity::Inspector" do
       setup_data_inspector
     end
 
-    it "should check for errors on the model and populate fields in DataInspector" do
-      inspector = DataSanity::Inspector.new
-      inspector.investigate
-      DataInspector.count.should == 0
-    end
-
     describe "all" do
 
+      it "should check for models with no data" do
+        inspector = DataSanity::Inspector.new
+        inspector.investigate
+        DataInspector.count.should == 0
+      end
+
       it "should check for errors on the model and populate fields in DataInspector" do
         inspector = DataSanity::Inspector.new
 
@@ -57,10 +57,16 @@ describe "DataSanity::Inspector" do
     end
 
     describe "random" do
+      it "should check for models with no data" do
+        inspector = DataSanity::Inspector.new :validate => :random
+        inspector.investigate
+        DataInspector.count.should == 0
+      end
+
       it "should check for errors on the model and populate fields in DataInspector" do
         inspector = DataSanity::Inspector.new(:validate => :random, :records_per_model => 2)
 
-        Person.new(:name => "Valid-Record").save(:validate => false)
+        Person.new(:name => "InValid-Record").save(:validate => false)
         Person.new(:name => "UnderAge", :age => 1).save(:validate => false)
         Person.new(:age => 20).save(:validate => false)
         Person.new(:age => 1).save(:validate => false)
@@ -68,6 +74,36 @@ describe "DataSanity::Inspector" do
         inspector.investigate
         DataInspector.count.should == 2
       end
+
+      describe "criteria" do
+        before :each do
+          setup_data_sanity_criteria
+        end
+
+        it "should check for models with no data" do
+          inspector = DataSanity::Inspector.new :validate => :random
+          inspector.investigate
+          DataInspector.count.should == 0
+        end
+
+        it "should check for errors on model based on criteria picked from data_sanity_criteria.yml" do
+          inspector = DataSanity::Inspector.new(:validate => :random)
+
+          2.times { Person.new(:name => "Raju").save(:validate => false) }
+          2.times { Person.new(:name => "Saju").save(:validate => false) }
+          2.times { Car.new(:name => "Santro").save(:validate => false) }
+          Person.new(:age => 20).save(:validate => false)
+          car = Car.new(:name => "800", :make => "Maruti", :color => "Black", :person => Person.first).save(:validate => false)
+
+          inspector.investigate
+          DataInspector.count.should == 3
+          DataInspector.all.collect(&:table_name).should == ["Car", "Person", "Person"]
+        end
+
+        after :each do
+          cleanup_data_sanity_criteria
+        end
+      end
     end
 
     after :each do

data/spec/support/helper.rb

@@ -1,7 +1,7 @@
 def clean_data_inspector_migration
   Dir.chdir("#{Rails.root}") do
     system "rake db:rollback"
-    system "rake db:data_sanity:rollback"
+    system "rake data_sanity:db:rollback"
   end
 end
 
@@ -14,7 +14,27 @@ end
 
 def setup_data_inspector
   Dir.chdir("#{Rails.root}") do
-    system "rake db:data_sanity:migrate"
+    system "rake data_sanity:db:migrate"
     system "rake db:migrate"
   end
 end
+
+def setup_data_sanity_criteria
+  Dir.chdir("#{Rails.root}") do
+    system "rake data_sanity:criteria"
+    file = File.open("config/data_sanity_criteria.yml", "w")
+    file << template_yml
+    file.close
+  end
+end
+
+def cleanup_data_sanity_criteria
+  Dir.chdir("#{Rails.root}") do
+    system "rm config/data_sanity_criteria.yml"
+  end
+end
+
+def template_yml
+  "Person:
+  name: ['Raju', 'Saju']"
+end

data/spec/support/sample_app/app/models/car.rb

@@ -0,0 +1,7 @@
+class Car < ActiveRecord::Base
+
+  validates_presence_of :name, :make, :color
+  validates_inclusion_of :color, :in => [:red, :blue, :black, :green, :white, :silver, :golden]
+
+  belongs_to :person
+end

data/spec/support/sample_app/app/models/person.rb

@@ -1,4 +1,6 @@
 class Person < ActiveRecord::Base
   validates_presence_of :name, :age
   validates_numericality_of :age, :greater_than => 18
+
+  has_many :cars
 end

data/spec/support/sample_app/db/migrate/20111205042538_create_cars.rb

@@ -0,0 +1,15 @@
+class CreateCars < ActiveRecord::Migration
+  def self.up
+    create_table :cars do |t|
+      t.string :name
+      t.string :make
+      t.string :color
+      t.integer :person_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :cars
+  end
+end

data/spec/support/sample_app/db/schema.rb

@@ -10,7 +10,16 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20111201095603) do
+ActiveRecord::Schema.define(:version => 20111205042922) do
+
+  create_table "cars", :force => true do |t|
+    t.string   "name"
+    t.string   "make"
+    t.string   "color"
+    t.integer  "person_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 
   create_table "data_inspectors", :force => true do |t|
     t.string   "table_name"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: data_sanity
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Habibullah, Rahul, Jigyasa, Jyotsna, Hephzibah, Garima
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-02 00:00:00 Z
+date: 2011-12-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -33,11 +33,27 @@ dependencies:
         - 6
         version: 3.0.6
   requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rake
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: rspec
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,12 +62,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id002
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
   name: sqlite3
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,7 +76,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id003
+  requirement: *id004
 description: Gem for checking data sanity
 email: 
 - ""
@@ -82,6 +98,7 @@ files:
 - lib/data_sanity/models/data_inspector.rb
 - lib/data_sanity/railtie.rb
 - lib/data_sanity/tasks.rb
+- lib/data_sanity/templates/data_sanity_criteria.yml
 - lib/data_sanity/version.rb
 - spec/data_sanity/inspector_spec.rb
 - spec/data_sanity/models/data_inspector_spec.rb
@@ -92,6 +109,7 @@ files:
 - spec/support/sample_app/README
 - spec/support/sample_app/Rakefile
 - spec/support/sample_app/app/helpers/application_helper.rb
+- spec/support/sample_app/app/models/car.rb
 - spec/support/sample_app/app/models/not_an_active_record_model.rb
 - spec/support/sample_app/app/models/person.rb
 - spec/support/sample_app/app/views/layouts/application.html.erb
@@ -111,6 +129,7 @@ files:
 - spec/support/sample_app/config/locales/en.yml
 - spec/support/sample_app/config/routes.rb
 - spec/support/sample_app/db/migrate/20111130045224_create_people.rb
+- spec/support/sample_app/db/migrate/20111205042538_create_cars.rb
 - spec/support/sample_app/db/schema.rb
 - spec/support/sample_app/db/seeds.rb
 - spec/support/sample_app/lib/tasks/.gitkeep
@@ -129,10 +148,8 @@ files:
 - spec/support/sample_app/public/robots.txt
 - spec/support/sample_app/public/stylesheets/.gitkeep
 - spec/support/sample_app/script/rails
-- spec/support/sample_app/test/fixtures/people.yml
 - spec/support/sample_app/test/performance/browsing_test.rb
 - spec/support/sample_app/test/test_helper.rb
-- spec/support/sample_app/test/unit/person_test.rb
 - spec/support/sample_app/vendor/plugins/.gitkeep
 homepage: ""
 licenses: []
@@ -177,6 +194,7 @@ test_files:
 - spec/support/sample_app/README
 - spec/support/sample_app/Rakefile
 - spec/support/sample_app/app/helpers/application_helper.rb
+- spec/support/sample_app/app/models/car.rb
 - spec/support/sample_app/app/models/not_an_active_record_model.rb
 - spec/support/sample_app/app/models/person.rb
 - spec/support/sample_app/app/views/layouts/application.html.erb
@@ -196,6 +214,7 @@ test_files:
 - spec/support/sample_app/config/locales/en.yml
 - spec/support/sample_app/config/routes.rb
 - spec/support/sample_app/db/migrate/20111130045224_create_people.rb
+- spec/support/sample_app/db/migrate/20111205042538_create_cars.rb
 - spec/support/sample_app/db/schema.rb
 - spec/support/sample_app/db/seeds.rb
 - spec/support/sample_app/lib/tasks/.gitkeep
@@ -214,8 +233,6 @@ test_files:
 - spec/support/sample_app/public/robots.txt
 - spec/support/sample_app/public/stylesheets/.gitkeep
 - spec/support/sample_app/script/rails
-- spec/support/sample_app/test/fixtures/people.yml
 - spec/support/sample_app/test/performance/browsing_test.rb
 - spec/support/sample_app/test/test_helper.rb
-- spec/support/sample_app/test/unit/person_test.rb
 - spec/support/sample_app/vendor/plugins/.gitkeep

data/spec/support/sample_app/test/fixtures/people.yml

@@ -1,9 +0,0 @@
-# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
-
-one:
-  name: MyString
-  age: 1
-
-two:
-  name: MyString
-  age: 1

data/spec/support/sample_app/test/unit/person_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-
-class PersonTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end