lol_dba 1.1.1 → 1.2.0

data/Gemfile

@@ -6,4 +6,6 @@ gem 'railties'
 gem 'rspec'
 gem 'simplecov', :require => false
 gem 'simplecov-html'
-gem 'sqlite3'
+gem 'sqlite3'
+
+gemspec

data/README.md

@@ -1,9 +1,6 @@
 #Lol DBA
 
-Lol DBA is a small package of 2 rake tasks that scan your application models and displays a list of columns that _probably_ should be indexed.
-
-*Note:* there should be mode fields depending on your application design and custom queries.
-
+lol_dba is a small package of rake tasks that scan your application models and displays a list of columns that probably should be indexed. Also, it can generate .sql migration scripts. Most of the code come from rails_indexes and migration_sql_generator.
 
 Installation
 ------------
@@ -21,13 +18,17 @@ Usage
 
 Display a migration for adding/removing all necessary indexes based on associations:
 
-    rake db:index_migration
+    rake db:find_indexes
 
 Display a migration for adding/removing all necessary indexes based on AR::Base#find calls (including: `find`, `find_by`, `find_all_by`, `find_by_x_and_y`, `find_all_by_x_and_y`):
 
     rake db:find_query_indexes
 
-*Notice:* At now moment it does not support Arel(the new Rails 3 Active Record Query Interface) calls (including: where, joins, includes, from, select...), but still usefull for indexes based on association
+Generate .sql files for all your migrations inside db/migrate_sql folder:
+
+    rake db:migrate_sql
+
+*Notice:* At now moment it does not support Arel(the new Rails 3 Active Record Query Interface) calls (including: where, joins, includes, from, select...), but still usefull for indexes based on association.
 
 Note that add index in big database may take a long time.
 
@@ -39,19 +40,8 @@ Compatible with Ruby 1.9 and Rails 3.x. I think.
 Upcoming features/enhancements
 ------------------------------
 
-  * Support Arel(the new Rails 3 Active Record Query Interface) call for `find_query_indexes` action
-
-
-Differences from the original [rails_indexes](https://github.com/eladmeidar/rails_indexes) and [the fork I used as starting point](https://github.com/warpc/rails_indexes)
--------------------------------------------
-
-  * Compatible with Ruby 1.9 and Rails 3.x
-  * Installing as Gem
-  * Analize `has_many :through` associations
-  * Working STI analize
-  * Good test coverage with RSpec
-  * Do not suggest add index for primary key (about reason read below)
-
+  * support Arel(the new Rails 3 Active Record Query Interface) call for `find_query_indexes` action
+  * support for `change` migrations
 
 About primary_key
 -----------------
@@ -59,7 +49,6 @@ About primary_key
 
 For this reason, no longer displays a gem suggestions about adding indexes to primary keys.
 
-
 Tests
 -----
 
@@ -73,13 +62,15 @@ Feedback
 
 All feedback, bug reports and thoughts on this gratefully received.
 
-Author:
+Contributors
 ------
-[Diego Plentz](http://plentz.org)
 
-Thanks:
-[Elad Meidar](http://blog.eizesus.com)
-[Eric Davis](http://littlestreamsoftware.com)
+* [Diego Plentz](http://plentz.org)
+* [Elad Meidar](http://blog.eizesus.com)
+* [Eric Davis](http://littlestreamsoftware.com)
+* [Jay Fields](http://jayfields.com/)
+* [Muness Alrubaie](http://muness.blogspot.com/)
+* [Vladimir Sharshov](https://github.com/warpc)
 
 License
 -------

data/lib/lol_dba.rb

@@ -1,5 +1,7 @@
 module LolDba
 
+  require "lol_dba/writer"
+  require "lol_dba/migration"
   require "lol_dba/railtie.rb" if defined?(Rails)
 
   def self.form_migration_content(migration_name, add_index_array, del_index_array)

data/lib/lol_dba/migration.rb

@@ -0,0 +1,40 @@
+module LolDba
+  class Migration
+    attr_accessor :full_name
+
+    def initialize(migration_file)
+      self.full_name = File.basename(migration_file, ".rb")
+      require Rails.root + "db/migrate/#{full_name}.rb"
+    end
+
+    def number
+      /^(\d+)_(.*)$/.match(full_name)[1]
+    end
+
+    def name
+      /^(\d+)_(.*)$/.match(full_name)[2]
+    end
+
+    def to_s
+      full_name
+    end
+
+    def migration_class
+      name.camelize.constantize
+    end
+
+    def up
+      migration_class.up
+      connection.execute("INSERT INTO schema_migrations (version) VALUES (#{number})")
+    end
+
+    def down
+      migration_class.down
+      connection.execute("DELETE FROM schema_migrations WHERE version = #{number}")
+    end
+
+    def connection
+      ActiveRecord::Base.connection
+    end
+  end
+end

data/lib/lol_dba/sql_generator.rb

@@ -0,0 +1,62 @@
+module LolDba
+  class SqlGenerator
+    class << self
+    
+      def connection
+        ActiveRecord::Base.connection
+      end
+
+      def methods_to_modify
+        [:execute, :do_execute, :rename_column, :change_column, :column_for, :tables, :indexes, :select_all] & connection.class.methods
+      end
+    
+      def redefine_execute_methods
+        save_original_methods
+        connection.class.send(:define_method, :execute) {|*args| Writer.write(args.first) }
+        connection.class.send(:define_method, :do_execute) {|*args| Writer.write(args.first) }
+        connection.class.send(:define_method, :column_for) {|*args| args.last }
+        connection.class.send(:define_method, :change_column) {|*args| [] }
+        connection.class.send(:define_method, :rename_column) {|*args| [] }
+        connection.class.send(:define_method, :tables) {|*args| [] }
+        connection.class.send(:define_method, :select_all) {|*args| [] }
+        connection.class.send(:define_method, :indexes) {|*args| [] }
+      end
+
+      def save_original_methods
+        methods_to_modify.each do |method_name|
+          connection.class.send(:alias_method, "orig_#{method_name}".to_sym, method_name)
+        end
+      end
+        
+      def reset_methods
+        methods_to_modify.each do |method_name|
+          connection.class.send(:alias_method, method_name, "orig_#{method_name}".to_sym)
+        end
+      end
+    
+      def generate_instead_of_executing(&block)
+        LolDba::Writer.reset
+        redefine_execute_methods
+        yield
+        reset_methods
+      end
+    
+      def migrations
+        Dir.glob(File.join(Rails.root, "db", "migrate", '*.rb'))
+      end
+        
+      def generate
+        generate_instead_of_executing { migrations.each{|file| up_and_down(file) } }
+      end
+    
+      def up_and_down(file)
+        #TODO support to migrations with change
+        migration = LolDba::Migration.new(file)
+        LolDba::Writer.file_name = "#{migration}.sql"
+        migration.up
+        #MigrationSqlGenerator::Writer.file_name = "#{migration}_down.sql"
+        #migration.down
+      end
+    end
+  end
+end

data/lib/lol_dba/version.rb

@@ -1,3 +1,3 @@
 module LolDba
-  VERSION = "1.1.1" unless defined? LolDba::VERSION
+  VERSION = "1.2.0" unless defined? LolDba::VERSION
 end

data/lib/lol_dba/writer.rb

@@ -0,0 +1,24 @@
+module LolDba
+  class Writer
+    class << self
+      attr_accessor :file_name
+    
+      def reset
+        FileUtils.rm_rf output_dir
+        Dir.mkdir output_dir
+      end
+  
+      def output_dir
+        File.join(Rails.root, "db", "migrate_sql")
+      end
+  
+      def path
+        File.join(output_dir, file_name)
+      end
+  
+      def write(string)
+        File.open(path, 'a') { |file| file << string; file << ";\n" }
+      end
+    end
+  end
+end

data/lib/tasks/lol_dba.rake

@@ -1,12 +1,18 @@
 require 'lol_dba'
+require 'lol_dba/sql_generator'
 
 namespace :db do
-  desc "Collect indexes based on AR::Base.find calls."
+  desc "Display a migration for adding/removing all necessary indexes based on associations"
+  task :find_indexes => :environment do
+    LolDba.simple_migration
+  end
+  desc "Display a migration for adding/removing all necessary indexes based on AR::Base#find calls"
   task :find_query_indexes => :environment do
     LolDba.ar_find_indexes
   end
-  desc "Collect indexes based on associations"
-  task :index_migration => :environment do
-    LolDba.simple_migration
+  desc "Generate .sql files for all your migrations inside db/migrate_sql folder"
+  task :migrate_sql => :environment do
+    LolDba::SqlGenerator.generate
   end
+  
 end

data/lol_dba.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 require 'lol_dba/version.rb'
 
@@ -6,20 +5,20 @@ Gem::Specification.new do |s|
   s.name = "lol_dba"
   s.version = LolDba::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors =  ["Diego Plentz", "Elad Meidar", "Vladimir Sharshov"]
-  s.email =  ["diego@plentz.org", "elad@eizesus.com", "vsharshov@gmail.com"]
+
+  s.authors =  ["Diego Plentz", "Elad Meidar", "Eric Davis", "Muness Alrubaie", "Vladimir Sharshov"]
+  s.email =  ["diego@plentz.org", "elad@eizesus.com", "", "vsharshov@gmail.com"]
   s.homepage = "https://github.com/plentz/lol_dba"
-  s.summary = "A rake task to track down missing database indexes. does not assume that all foreign keys end with the convention of _id"
-  s.description = "LOL DBA is a small package of 2 rake tasks that scan your application models and displays a list of columns that probably should be indexed."
+  s.summary = "A small package of rake tasks to track down missing database indexes and generate sql migration scripts"
+  s.description = "lol_dba is a small package of rake tasks that scan your application models and displays a list of columns that probably should be indexed. Also, it can generate .sql migration scripts."
 
-  #s.rubyforge_project = "lol_dba"
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.require_paths = ["lib"]
+  s.require_paths = ["lib", "lib/lol_dba"]
 
-  s.add_dependency 'activerecord', '>=2.3.0'
-  s.add_dependency 'actionpack'
-  s.add_dependency 'railties'
+  s.add_dependency 'activerecord', '>= 3.0'
+  s.add_dependency 'actionpack', '>= 3.0'
+  s.add_dependency 'railties', '>= 3.0'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rspec'
 end

metadata

@@ -1,54 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: lol_dba
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
 - Diego Plentz
 - Elad Meidar
+- Eric Davis
+- Muness Alrubaie
 - Vladimir Sharshov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70320988946760 !ruby/object:Gem::Requirement
+  requirement: &70236560955460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320988946760
+  version_requirements: *70236560955460
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70320988946340 !ruby/object:Gem::Requirement
+  requirement: &70236560954840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320988946340
+  version_requirements: *70236560954840
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70320975804080 !ruby/object:Gem::Requirement
+  requirement: &70236560954140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320975804080
+  version_requirements: *70236560954140
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70320975801440 !ruby/object:Gem::Requirement
+  requirement: &70236560953260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +58,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320975801440
+  version_requirements: *70236560953260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70320975799940 !ruby/object:Gem::Requirement
+  requirement: &70236560952340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,12 +69,14 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320975799940
-description: LOL DBA is a small package of 2 rake tasks that scan your application
-  models and displays a list of columns that probably should be indexed.
+  version_requirements: *70236560952340
+description: lol_dba is a small package of rake tasks that scan your application models
+  and displays a list of columns that probably should be indexed. Also, it can generate
+  .sql migration scripts.
 email:
 - diego@plentz.org
 - elad@eizesus.com
+- ''
 - vsharshov@gmail.com
 executables: []
 extensions: []
@@ -85,8 +89,11 @@ files:
 - README.md
 - Rakefile
 - lib/lol_dba.rb
+- lib/lol_dba/migration.rb
 - lib/lol_dba/railtie.rb
+- lib/lol_dba/sql_generator.rb
 - lib/lol_dba/version.rb
+- lib/lol_dba/writer.rb
 - lib/tasks/lol_dba.rake
 - lol_dba.gemspec
 - spec/ar_find_index_spec.rb
@@ -116,6 +123,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/lol_dba
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,8 +141,8 @@ rubyforge_project:
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: A rake task to track down missing database indexes. does not assume that
-  all foreign keys end with the convention of _id
+summary: A small package of rake tasks to track down missing database indexes and
+  generate sql migration scripts
 test_files:
 - spec/ar_find_index_spec.rb
 - spec/associations_index_spec.rb