data_sanity 0.0.3

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.idea/**
+.rvmrc
+tags

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in data_sanity.gemspec
+gemspec
+
+group :test do
+  gem "database_cleaner"
+end

data/README

@@ -0,0 +1,14 @@
+# Data Sanity Inspector
+It is a gem with following options to check sanity of database
+  All data in all models
+  Random data in all models :
+    * specify n number of random records,
+    * specify criteria
+
+#OUTPUT
+It would output result in a table with following details
+  +----+------------+-------------+-------------------+-----------------------+
+  | id | table_name | primary_key	| primary_key_value | errors                |
+  +----+------------+-------------+-------------------+-----------------------+
+  | 1	 |  Person	  | person_id	| 128	            | “Fmno can’t be blank” |
+  +----+------------+-------------+-------------------+-----------------------+

data/README.md

@@ -0,0 +1,14 @@
+# Data Sanity Inspector
+    It is a gem with following options to check sanity of database
+        # All data in all models
+        # Random data in all models :
+            * specify n number of random records,
+            * specify criteria
+
+# It would output result in a table with following details
+
++----+------------+-------------+-------------------+-----------------------+
+| id | table_name | primary_key	| primary_key_value | errors                |
++----+------------+-------------+-------------------+-----------------------+
+| 1	 |  Person	  | person_id	| 128	            | “Fmno can’t be blank” |
++----+------------+-------------+-------------------+-----------------------+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/data_sanity.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/data_sanity/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Habibullah, Rahul, Jigyasa, Jyotsna, Hephzibah, Garima"]
+  gem.email = [""]
+  gem.description = %q{Gem for checking data sanity}
+  gem.summary = %q{Gem for checking data sanity}
+  gem.homepage = ""
+
+  gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name = "data_sanity"
+  gem.require_paths = ["lib"]
+  gem.version = DataSanity::VERSION
+
+  gem.add_dependency "rails", "=3.0.6"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/data_sanity/inspector.rb

@@ -0,0 +1,34 @@
+module DataSanity
+  class Inspector
+
+    ALLOWED_VALIDATION = [:all, :random]
+
+    attr_accessor :all, :random, :models
+
+    def initialize options = {}
+      options[:validate] == :random ? @random = true : @all = true
+      @models = load_models
+    end
+
+    def investigate
+      @models.each do |model_string|
+        model = model_string.constantize
+        model.all.each do |instance|
+          unless instance.valid?
+            DataInspector.create(:table_name => model_string,
+                                 :table_primary_key => model.primary_key,
+                                 :primary_key_value => instance.send(model.primary_key),
+                                 :validation_errors => instance.errors.full_messages.to_yaml)
+          end
+        end
+      end
+    end
+
+    private
+
+    def load_models
+      Dir["#{Rails.root}/app/models/**/*.rb"].each { |file_path| require file_path rescue nil }
+      ActiveRecord::Base.descendants.select(&:descends_from_active_record?).collect(&:name)
+    end
+  end
+end

data/lib/data_sanity/railtie.rb

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

data/lib/data_sanity/tasks.rb

@@ -0,0 +1,17 @@
+namespace :db do
+  namespace :data_sanity do
+    desc 'Create data inspector model for data sanity results'
+    task :migrate => :environment do
+      Dir.chdir("#{Rails.root}") do
+        system "rails g model DataInspector table_name:string table_primary_key:string primary_key_value:string validation_errors:text"
+      end
+    end
+
+    desc 'Destroy data inspector model for data sanity results'
+    task :rollback do
+      Dir.chdir("#{Rails.root}") do
+        system "rails destroy model DataInspector"
+      end
+    end
+  end
+end

data/lib/data_sanity/version.rb

@@ -0,0 +1,3 @@
+module DataSanity
+  VERSION = "0.0.3"
+end

data/lib/data_sanity.rb

@@ -0,0 +1,5 @@
+require "rails"
+
+require File.dirname(__FILE__) + "/data_sanity/inspector"
+require File.dirname(__FILE__) + "/data_sanity/railtie"
+require File.dirname(__FILE__) + "/data_sanity/version"

data/spec/data_sanity/inspector_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+
+describe "DataSanity::Inspector" do
+
+  describe "initialize" 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"]
+    end
+  end
+
+  describe "investigate" do
+    before :each 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
+
+    it "should check for errors on the model and populate fields in DataInspector" do
+      inspector = DataSanity::Inspector.new
+
+      Person.new(:name => "Valid-Record", :age => 20).save(:validate => false)
+      Person.new(:age => 1).save(:validate => false)
+
+      inspector.investigate
+      DataInspector.count.should == 1
+
+      first_person = Person.find_by_age(1)
+      first_person.valid?
+      DataInspector.first.table_name.should == "Person"
+      DataInspector.first.table_primary_key.should == "id"
+      DataInspector.first.primary_key_value.should == first_person.id.to_s
+      YAML.load(DataInspector.first.validation_errors).should == first_person.errors.full_messages
+    end
+
+    after :each do
+      clean_data_inspector_migration
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'data_sanity'
+require 'support/helper'
+require 'database_cleaner'
+
+require 'support/sample_app/config/environment'
+
+setup_sample_app
+
+RSpec::configure do |config|
+  config.color_enabled = true
+  config.run_all_when_everything_filtered = true
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+

data/spec/support/helper.rb

@@ -0,0 +1,21 @@
+def clean_data_inspector_migration
+  Dir.chdir("#{Rails.root}") do
+    system "rake db:rollback"
+    system "rake db:data_sanity:rollback"
+  end
+end
+
+def setup_sample_app
+  Dir.chdir("#{Rails.root}") do
+    system "bundle"
+    system "rake db:reset"
+  end
+end
+
+def setup_data_inspector
+  Dir.chdir("#{Rails.root}") do
+    system "rake db:data_sanity:migrate"
+    system "rake db:migrate"
+  end
+  require "#{Rails.root}/app/models/data_inspector"
+end

data/spec/support/sample_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/spec/support/sample_app/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.6'
+gem 'sqlite3'
+gem 'data_sanity', :path => "~/data_sanity"

data/spec/support/sample_app/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.com/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for
+  images, stylesheets, and javascripts. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/support/sample_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+SampleApp::Application.load_tasks

data/spec/support/sample_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

@@ -0,0 +1,3 @@
+class NotAnActiveRecordModel
+  
+end

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

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

data/spec/support/sample_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SampleApp</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/support/sample_app/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module SampleApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/support/sample_app/config/boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/support/sample_app/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/sample_development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/sample_test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/sample_production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/support/sample_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+SampleApp::Application.initialize!