rails_doctor 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dmitry Gruzd
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# RailsDoctor
+
+Gem is used to find troubles in rails code, e.g. associations without index
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_doctor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_doctor
+
+## Usage
+
+    doctor = RailsDoctor.new
+    doctor.analize
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/rails_doctor.rb

@@ -0,0 +1,81 @@
+require 'rails_doctor/version'
+class RailsDoctor
+  def initialize
+  end
+
+  def analize
+    indexes
+    true
+  end
+
+  def associations
+    hash = {}
+    models = Dir.glob("#{Rails.root}/app/models/*.rb").map{|model_path| model_path.split('/').last[/.+(?=\.rb)/]}
+    #models = ['patient', 'tooth_formula']
+    models.each do |model_name|
+      table = model_name.pluralize.to_sym
+      hash[table]||=[]
+      model = model_name.split('_').map(&:capitalize).join.constantize
+      next unless model.respond_to?(:reflect_on_all_associations)
+      belongs_to = model.reflect_on_all_associations.select{|s| s.macro == :belongs_to}
+      ids = belongs_to.map{|a| "#{a.name}_id"}
+      hash[table] += ids
+    end
+    hash
+  end
+
+  def indexes
+    hash = {}
+    #puts 'run associations'
+    assoc = associations
+    #puts "get #{assoc.inspect}"
+    #puts 'run migrations'
+    migrate = migrations
+    #puts "get #{migrate.inspect}"
+
+    tables = assoc.keys&migrate.keys
+    tables.each do |table|
+      columns = assoc[table]-migrate[table]
+      unless columns.blank?
+        hash[table] = columns
+        puts "WARNING: in table:#{table} is no indexes in columns #{columns.join(', ')}"
+      end
+    end
+    create_migration(hash)
+    hash
+  end
+
+  def create_migration(hash)
+    return false if hash.blank?
+    puts "###### migrations #######"
+    hash.each do |table, columns|
+      columns.each do |column|
+        puts "add_index #{table.inspect}, #{column.inspect}"
+      end
+    end
+    puts "###### migrations end ###"
+  end
+
+
+  def migrations
+    hash = {}
+    file_list = Dir.glob("#{Rails.root}/db/migrate/*.rb")
+    file_list.each do |file|
+      parse = parse_migration(File.read(file))
+      hash.merge! parse
+    end
+    hash
+  end
+
+  private
+  def parse_migration(text)
+    hash = {}
+    scan = text.scan(/^\s*add_index\s+:?(?<table>\w+),\s*:?(?<column>\w+)/)
+    scan.each do |s|
+      table = s.first.to_sym
+      hash[table]||=[]
+      hash[table] << s.last
+    end
+    hash
+  end
+end

data/lib/rails_doctor/version.rb

@@ -0,0 +1,3 @@
+class RailsDoctor
+  VERSION = "0.0.1"
+end

data/rails_doctor.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_doctor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rails_doctor"
+  gem.version       = RailsDoctor::VERSION
+  gem.authors       = ["Dmitry Gruzd"]
+  gem.email         = ["donotsendhere@gmail.com"]
+  gem.description   = %q{ gem detect problems in your rails project}
+  gem.summary       = %q{ rails_doctor gem that can help you to find errors in different ways e.g. if you forgot to add indexes on association column}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/rails_doctor_spec.rb

@@ -0,0 +1,54 @@
+require 'rails_doctor'
+
+
+describe "Test migration parse" do
+  before(:all) do
+    @doctor = RailsDoctor.new
+  end
+  it 'check simple migration' do
+    migration = <<EOF
+class CreateUsers < ActiveRecord::Migration
+  def change
+    add_index :users, :role_id
+    add_index :users, :other_id
+  end
+end
+EOF
+    @doctor.send(:parse_migration, migration).should == {:users =>['role_id', 'other_id']}
+  end
+
+  it 'check up-down migration' do
+  migration = <<EOF
+class CreateUsers < ActiveRecord::Migration
+  def up
+    add_index :users, :role_id
+    add_index :users, :other_id
+  end
+  def down
+    remove_index :users, :role_id
+    remove_index :users, :other_id
+  end
+end
+EOF
+  @doctor.send(:parse_migration, migration).should == {:users =>['role_id', 'other_id']}
+end
+
+
+  it 'check up-down reverted migration' do
+  migration = <<EOF
+class CreateUsers < ActiveRecord::Migration
+  def down
+    add_index :users, :role_id
+    add_index :users, :other_id
+  end
+  def up
+    remove_index :users, :role_id
+    remove_index :users, :other_id
+  end
+end
+EOF
+  @doctor.send(:parse_migration, migration).should == {}
+end
+
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rails_doctor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dmitry Gruzd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' gem detect problems in your rails project'
+email:
+- donotsendhere@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_doctor.rb
+- lib/rails_doctor/version.rb
+- rails_doctor.gemspec
+- spec/rails_doctor_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: rails_doctor gem that can help you to find errors in different ways e.g.
+  if you forgot to add indexes on association column
+test_files:
+- spec/rails_doctor_spec.rb