suggest-db-indices 0.0.3 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Suggest-Db-Indices
 
-A gem for your rails project that suggests indices for you to add in your database. Currently it suggests adding indices to unindexed foreign keys.
+A gem for your rails project that suggests indices for you to add in your database. It looks for unindexed foreign keys, and what columns actually get queried.
 
 ## Installation
 
@@ -12,24 +12,10 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install suggest-db-indices
-
 ## Usage
 
-1. rails console
-2. require 'suggest_db_indices'
-3. SuggestDbIndices.go!
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+    bundle exec rake suggest_db_indices
 
-## Possible future features
-1. I have built some things for analyzing the rails log files and looking at columns used in the queries that get run. I need to come up with a good way to use these results.
-2. Next to each add index statement, there should be a justification.
+## Changes
+0.1.0 (July 8, 2012) - Added the rake task.
+0.0.3 (July 4, 2012) - Added justification for each index added, made log file handling more robust

data/lib/{suggest_db_indices.rb → suggest-db-indices.rb}

@@ -1,6 +1,8 @@
 require 'tempfile'
+require 'rails'
 require 'rails/generators'
 
 require File.join File.dirname(__FILE__), '/suggest_db_indices/version'
-require File.join File.dirname(__FILE__), '/suggest_db_indices/clojurian_imperialism'
+require File.join File.dirname(__FILE__), '/suggest_db_indices/clojure'
 require File.join File.dirname(__FILE__), '/suggest_db_indices/core'
+require File.join File.dirname(__FILE__), '/suggest_db_indices/railtie'

data/lib/suggest_db_indices/clojure.rb

@@ -0,0 +1,23 @@
+module SuggestDbIndices
+  # Learnings from Clojure for make great benefit ruby
+  module Clojure
+    class << self
+      # Get multiple keys, e.g.,
+      # h = {:b => {:a => 5}}
+      # Clojure.get_in(h, [:b, :a]) # => 5
+      # Clojure.get_in(h, [:b, :a, :c]) # => nil
+      # Clojure.get_in(h, [:b, :a, :c], 1) # => 1
+      def get_in enumerable, keys, default = nil
+        current = enumerable
+        while key = keys.shift
+          unless current.is_a? Enumerable
+            current = nil
+            break
+          end
+          current = current[key]
+        end
+        current || default
+      end
+    end
+  end
+end

data/lib/suggest_db_indices/core.rb

@@ -176,7 +176,7 @@ module SuggestDbIndices
               if non_pk_columns_by_table[current_table] && non_pk_columns_by_table[current_table].include?(column_candidate)
                 # We only care about the identifiers that match up to a table and column.
                 # This is a ghetto way to to avoid having to parse SQL (extremely difficult)
-                if queried_columns_by_table.get_in([current_table, column_candidate])
+                if Clojure.get_in queried_columns_by_table, [current_table, column_candidate]
                   queried_columns_by_table[current_table][column_candidate] += 1
                 else
                   queried_columns_by_table[current_table] = {column_candidate => 1}

data/lib/suggest_db_indices/railtie.rb

@@ -0,0 +1,7 @@
+module SuggestDbIndices
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.join File.dirname(__FILE__), '../tasks/suggest_db_indices.rake'
+    end
+  end
+end

data/lib/suggest_db_indices/version.rb

@@ -1,3 +1,3 @@
 module SuggestDbIndices
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/tasks/suggest_db_indices.rake

@@ -0,0 +1,4 @@
+desc "Generate a migration that adds missing indices"
+task :suggest_db_indices => :environment do
+  SuggestDbIndices.go!
+end

data/suggest_db_indices.gemspec

@@ -4,8 +4,8 @@ require File.join File.dirname(__FILE__), 'lib/suggest_db_indices/version'
 Gem::Specification.new do |gem|
   gem.authors = ["Isak Sky"]
   gem.email = ["isak.sky@gmail.com"]
-  gem.description = %q{A gem for your rails project that suggests indices for you to add in your database. Currently it suggests adding indices to unindexed foreign key columns.}
-  gem.summary = %q{A gem for your rails project that suggests indices for you to add in your database.}
+  gem.description = "A gem for rails projects that suggests indices to add to the database."
+  gem.summary = "A gem for rails projects that suggests indices to add to the database."
   gem.homepage = "https://github.com/isaksky/suggest-db-indices"
   gem.license = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suggest-db-indices
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-04 00:00:00.000000000 Z
+date: 2012-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2161081920 !ruby/object:Gem::Requirement
+  requirement: &2162432420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2161081920
+  version_requirements: *2162432420
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &2161081300 !ruby/object:Gem::Requirement
+  requirement: &2162431840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161081300
+  version_requirements: *2162431840
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2161080600 !ruby/object:Gem::Requirement
+  requirement: &2162431160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,9 +43,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161080600
-description: A gem for your rails project that suggests indices for you to add in
-  your database. Currently it suggests adding indices to unindexed foreign key columns.
+  version_requirements: *2162431160
+description: A gem for rails projects that suggests indices to add to the database.
 email:
 - isak.sky@gmail.com
 executables: []
@@ -57,10 +56,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/suggest_db_indices.rb
-- lib/suggest_db_indices/clojurian_imperialism.rb
+- lib/suggest-db-indices.rb
+- lib/suggest_db_indices/clojure.rb
 - lib/suggest_db_indices/core.rb
+- lib/suggest_db_indices/railtie.rb
 - lib/suggest_db_indices/version.rb
+- lib/tasks/suggest_db_indices.rake
 - suggest_db_indices.gemspec
 homepage: https://github.com/isaksky/suggest-db-indices
 licenses:
@@ -86,6 +87,5 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: A gem for your rails project that suggests indices for you to add in your
-  database.
+summary: A gem for rails projects that suggests indices to add to the database.
 test_files: []

data/lib/suggest_db_indices/clojurian_imperialism.rb

@@ -1,16 +0,0 @@
-# Learnings from Clojure for make great benefit ruby
-
-module Enumerable
-  # E.g., {:foo => {:bar => 5}}.get_in(:foo, :bar) #=> 5
-  def get_in keys, default = nil
-    v = self[keys.first]
-    rest = keys.drop 1
-    if rest.any?
-      v.get_in rest, default
-    else
-      v ? v : default
-    end
-  rescue NoMethodError => ex
-    default
-  end
-end