dbchecker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31be9ae06b5b43ee6505de97fd299296978c3411
+  data.tar.gz: 1d41bb6ce48d79e14a9d675fa61e566be36c6b03
+SHA512:
+  metadata.gz: 81afc0e03a2e47a2398060a3a84bf959fbcbcf1827722423f5b514db3d17a4e4f704ad8f57351f84bd09c28b56e08a8dea0bfd9d3f9fb10f8da1177cfd55ec3f
+  data.tar.gz: 8231133864f955e49171b5c4297952e5e4bc162568af9d90af974c927bb00ce02893924f31995468f0c9336e9dae78bd5a51d30bd6c60067af9219122b8a1724

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/dummy/log
+spec/dummy/tmp
+spec/dummy/public

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/README.md

@@ -0,0 +1,93 @@
+# Dbchecker
+
+Dbchecker is a rails gem to help you maintain the consistency of your database.
+
+
+## Installation
+
+Add this line to your rails application's Gemfile:
+
+    gem 'dbchecker'
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+First, you need to have a place to put the definition of the checkers, so create it:
+
+    mkdir db/checks
+
+Now, you can create inside it several files with the checks. The recommended structure is one file/class per model:
+
+**db/checks/user.rb**
+    class UserChecker < Dbchecker::Checker
+      model :user
+
+      check_nil :email, :name
+      check_equal :follower_id, :followed_id
+      check_negative :logged_in_times
+    end
+
+With the `model` directive, you are specifiying the model you are working with.
+There are several checkers, explained below. Each of them return the ids of the affected models, if any.
+
+
+## Checks
+
+### check_nil
+This checks for the presence of `nil` in the specified fields.
+You can pass several fields to `check_nil`.
+
+    check_nil :important_field
+    check_nil :field1, :field2
+
+### check_references
+This checks for the presence of the referenced model.
+You can pass several fields to `check_references`.
+
+For example, if you have a `Profile` model with a `belongs_to :user`, that means that
+in `Profile` you will have a `user_id` field. To check that the reference exists, use:
+
+    check_references :user
+
+Note that here we are no passing the name of the field but the name of the relationship.
+
+### check_negatives
+This checks for negatives in the passed in fields.
+
+    check_negatives :points, :logged_in_times
+
+### check_zero
+This checks for zero in the passed in fields.
+
+    check_zero :warnings_left
+
+### check_equal
+This checks for the equality of two fields (that should be different).
+You have to pass the name of both fields.
+
+    check_equal :follower_id, :followed_id
+
+### check_duplicates
+This checks for duplicates in the table.
+
+    check_duplicates :user_id
+
+
+## Testing
+
+Clone this git repo and then run the tests:
+
+    rake
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :test => :spec #alias
+task :default => :spec

data/TODO.md

@@ -0,0 +1,6 @@
+* Rescue from errors
+* Add more DSL
+  * Counter caches
+* Add more options to DSL, so it's more flexible
+* Make table names and fields smart, using rails helpers instead of manually
+* Comment the code so it's easier for people to contribute

data/dbchecker.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dbchecker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dbchecker"
+  spec.version       = Dbchecker::VERSION
+  spec.authors       = ["Alejandro Andres"]
+  spec.email         = ["alej@redradix.com"]
+  spec.description   = %q{Check your database consistency}
+  spec.summary       = %q{This gem offers a set of tools to check the consistency of your database}
+  spec.homepage      = "http://github.com/redradix/dbchecker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+
+  spec.add_dependency "rails", "~> 3.2.13"
+end

data/lib/dbchecker.rb

@@ -0,0 +1,8 @@
+require 'dbchecker/version'
+
+require 'dbchecker/railtie' if defined? Rails
+require 'dbchecker/dsl'
+require 'dbchecker/checker'
+
+module Dbchecker
+end

data/lib/dbchecker/base.rb

@@ -0,0 +1,14 @@
+module Dbchecker
+  class Checker
+    extend DSL
+
+    class << self
+      attr_accessor :table
+    end
+
+    def self.model(klass)
+      self.table = klass.to_s.classify.constantize
+    end
+
+  end
+end

data/lib/dbchecker/checker.rb

@@ -0,0 +1,14 @@
+module Dbchecker
+  class Checker
+    extend DSL
+
+    class << self
+      attr_accessor :table
+    end
+
+    def self.model(klass)
+      self.table = klass.to_s.classify.constantize
+    end
+
+  end
+end

data/lib/dbchecker/dsl.rb

@@ -0,0 +1,107 @@
+module Dbchecker
+  module DSL
+
+    def check_nil(*fields)
+      raise 'Empty fields' if fields.empty?
+      res = []
+
+      fields.each do |field|
+        bad = table.select(:id).where(field => nil)
+        total = bad.map(&:id)
+
+        unless total.empty?
+          self.log "There are #{total.size} invalid rows in #{table} because #{field} is nil"
+          self.log "IDs: #{total}"
+        end
+        res.push total
+      end
+
+      res
+    end
+
+    def check_references(*fields)
+      raise 'Empty fields' if fields.empty?
+      res = []
+
+      fields.each do |field|
+        field_name = "#{field}_id"
+        references = table.select(:id).all.map{|r| r.id }
+        from = field.to_s.classify.constantize
+        all = from.select(:id).all.map(&:id)
+        total = references - all
+
+        if total.size > 0
+          self.log "There are #{total.size} invalid rows in #{table} because #{field_name} is not existant"
+          self.log "IDs: #{total}"
+        end
+        res.push total
+      end
+
+      res
+    end
+
+    def check_negatives(*fields)
+      raise 'Empty fields' if fields.empty?
+      res = []
+
+      fields.each do |field|
+        total = table.select(:id).where("#{field} < 0")
+        if total.size > 0
+          self.log "There are #{total.size} invalid rows in #{table} because #{field} is negative"
+          self.log "IDs: #{total}"
+        end
+        res.push total
+      end
+
+      res
+    end
+
+    def check_zero(*fields)
+      raise 'Empty fields' if fields.empty?
+      res = []
+
+      fields.each do |field|
+        total = table.select(:id).where("#{field} = 0")
+        if total.size > 0
+          self.log "There are #{total.size} invalid rows in #{table} because #{field} is zero"
+          self.log "IDs: #{total}"
+        end
+        res.push total
+      end
+
+      res
+    end
+
+    def check_equal(*fields)
+      raise 'Empty fields' if fields.empty?
+      raise 'Two fields required' if fields.size != 2
+      first_field, second_field = fields[0], fields[1]
+
+      total = table.select(:id).where("#{first_field} = #{second_field}")
+      if total.size > 0
+        self.log "There are #{total.size} invalid rows in #{table} because #{first_field} and #{second_field} are equal"
+        self.log "IDs: #{total}"
+      end
+
+      total.map(&:id)
+    end
+
+    def check_duplicates(*fields)
+      raise 'Empty fields' if fields.empty?
+      fields_str = fields.join(', ')
+
+      total = table.select(:id).group("#{fields_str}").having("COUNT(id) > ?", 1)
+      unless total.empty?
+        self.log "There are #{total.size} invalid rows in #{table} because #{fields_str} are duplicated"
+        self.log "IDs: #{total}"
+      end
+
+      total.map(&:id)
+    end
+
+    def log(msg)
+      puts msg unless Rails.env.test?
+    end
+
+  end
+end

data/lib/dbchecker/railtie.rb

@@ -0,0 +1,5 @@
+class Tasks < Rails::Railtie
+  rake_tasks do
+    Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+  end
+end

data/lib/dbchecker/version.rb

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

data/lib/tasks/db_check.rake

@@ -0,0 +1,6 @@
+namespace :db do
+  desc "Checks your database for consistency problems"
+  task :check => :environment do
+    Dir[File.join(Rails.root,'db/checks/*.rb')].each { |f| load f }
+  end
+end

data/spec/dsl/check_duplicates_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'check_duplicates' do
+  it 'should error if no arguments' do
+    expect {
+      ProfileSubject.check_duplicates
+    }.to raise_exception(StandardError, 'Empty fields')
+  end
+
+  it 'should accept one argument' do
+    expect {
+      ProfileSubject.check_duplicates :user_id
+    }.not_to raise_exception
+  end
+
+  it 'should accept several arguments' do
+    expect {
+      ProfileSubject.check_duplicates :user_id, :provider_id
+    }.not_to raise_exception
+  end
+
+  it 'should return if duplicates' do
+    create :user
+    create :profile, user_id: User.first.id
+    create :profile, user_id: User.first.id
+    res = ProfileSubject.check_duplicates :user_id
+    res.class.should == Array
+    res.size.should == 1
+  end
+
+  it 'should return empty if all ok' do
+    create :user
+    create :user
+    create :profile, user_id: User.first.id
+    create :profile, user_id: User.last.id
+    res = ProfileSubject.check_duplicates :user_id
+    res.class.should == Array
+    res.size.should == 0
+  end
+
+end

data/spec/dsl/check_equal_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'check_equal' do
+  it 'should error if no arguments' do
+    expect {
+      ProfileSubject.check_equal
+    }.to raise_exception(StandardError, 'Empty fields')
+  end
+
+  it 'should error if one argument' do
+    expect {
+      ProfileSubject.check_equal :number_of_friends
+    }.to raise_exception(StandardError, 'Two fields required')
+  end
+
+  it 'should accept two arguments' do
+    expect {
+      ProfileSubject.check_equal :number_of_friends, :number_of_points
+    }.not_to raise_exception
+  end
+
+  it 'should return if equal' do
+    create :profile, number_of_points: 3, number_of_friends: 3
+    res = ProfileSubject.check_equal :number_of_points, :number_of_friends
+    res.class.should == Array
+    res.size.should == 1
+  end
+
+  it 'should return empty if all ok' do
+    create :profile, number_of_points: 3, number_of_friends: 2
+    res = ProfileSubject.check_equal :number_of_points, :number_of_friends
+    res.class.should == Array
+    res.size.should == 0
+  end
+
+end

data/spec/dsl/check_negatives_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'check_negatives' do
+  it 'should error if no arguments' do
+    expect {
+      ProfileSubject.check_negatives
+    }.to raise_exception(StandardError, 'Empty fields')
+  end
+
+  it 'should accept one argument' do
+    expect {
+      ProfileSubject.check_negatives :number_of_friends
+    }.not_to raise_exception
+  end
+
+  it 'should accept several arguments' do
+    expect {
+      ProfileSubject.check_negatives :number_of_friends, :number_of_points
+    }.not_to raise_exception
+  end
+
+  it 'should return if negative' do
+    create :profile, number_of_points: -1
+    res = ProfileSubject.check_negatives :number_of_points
+    res.class.should == Array
+    res.first.size.should == 1
+  end
+
+  it 'should return empty if all ok' do
+    create :profile, number_of_points: 1
+    res = ProfileSubject.check_negatives :number_of_points
+    res.class.should == Array
+    res.first.size.should == 0
+  end
+
+end