lazy_susan 0.7.0

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 lazy_susan.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2012 Mark Tabler
+
+
+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,29 @@
+# LazySusan
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lazy_susan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_susan
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

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

data/lazy_susan.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lazy_susan/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Tabler\n"]
+  gem.email         = ["mark.tabler@fallingmanstudios.net"]
+  gem.description   = %q{An Automatic Index Migration Generator}
+  gem.summary       = %q{LazySusan generates index migrations where they are needed; which is to say any column detected as a primary or foreign key that does not already have an index.}
+
+  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.name          = "lazy_susan"
+  gem.require_paths = ["lib", "lib/generators"]
+  gem.version       = LazySusan::VERSION
+end

data/lib/generators/lazy_susan_generator.rb

@@ -0,0 +1,97 @@
+class LazySusanGenerator < Rails::Generators::Base
+  DATABASE = ActiveRecord::Base.connection  
+  def generate_lazy_susan
+    results = {}
+    DATABASE.tables.each do |table_name|   
+      missing_indexes = gather_missing_indexes(table_name)
+      results[table_name] = missing_indexes if missing_indexes.any?
+    end
+    if results.keys.any?
+      generate_migration(results)
+    else
+      puts "No missing indexes found."
+    end    
+  end
+
+  private
+
+  def gather_missing_indexes(table_name)
+    results = []
+    results += columns_to_index(table_name)
+    results += joins_to_index(table_name)
+    results
+  end
+
+  def columns_to_index(table_name)
+    results = []
+    columns_to_check = columns_needing_indexes(table_name)
+    columns_to_check.each do |column_name|
+      results << column_name unless DATABASE.index_exists?(table_name, column_name)
+    end
+    results
+  end
+
+  def joins_to_index(table_name)
+    results = []
+    joins_to_check = joins_needing_indexes(table_name)
+    joins_to_check.each do |join|
+      results << join unless DATABASE.index_exists?(table_name, join)
+      results << join.reverse unless DATABASE.index_exists?(table_name, join.reverse)
+    end
+    results
+  end
+
+# Every column name that ends in _id, or is "id", should be indexed.
+def columns_needing_indexes(table_name)
+  results = []
+  DATABASE.columns(table_name).each do |column|
+    results << column.name.to_sym if column.name.last(3) == "_id"
+    results << column.name.to_sym if column.name == "id"
+  end
+  results
+end
+
+# If a table has two column names ending in _id, it's probably a join
+# and should be indexed for join lookups in either direction.
+def joins_needing_indexes(table_name)
+  results = columns_needing_indexes(table_name).reject { |name| name == :id }
+  results.size == 2 ? [results.map(&:to_sym)] : []
+end
+
+def generate_migration(missing_indexes)
+  puts "Generating missing index migration."
+  puts timestamped_migration_filename(missing_indexes)
+  migration_file = File.open("#{Rails.root}/db/migrate/#{timestamped_migration_filename(missing_indexes)}", "w") do |f|
+    f.puts header_boilerplate(missing_indexes)
+    f.puts migration_lines(missing_indexes)
+    f.puts footer_boilerplate
+  end
+end
+
+def timestamped_migration_filename(missing_indexes)
+  Time.now.utc.strftime("%Y%m%d%H%M%S") + "_lazy_susan_for_#{missing_indexes.first.first}.rb"
+end
+
+def header_boilerplate(missing_indexes)
+  "class LazySusanFor#{missing_indexes.first.first.classify.pluralize} < ActiveRecord::Migration
+  def change"
+  end
+
+  def footer_boilerplate
+    "  end\nend"
+  end
+
+  def migration_lines(missing_indexes)
+    results = ""
+    missing_indexes.each do |table_name, indexes|
+      indexes.each do |index|
+        if index.class == Array
+          results << "    add_index :#{table_name}, #{index}\n"
+        else
+          results << "    add_index :#{table_name}, :#{index}\n"
+        end
+      end
+    end
+    results
+  end
+end

data/lib/lazy_susan.rb

@@ -0,0 +1,5 @@
+require "lazy_susan/version"
+
+module LazySusan
+  # Your code goes here...
+end

data/lib/lazy_susan/version.rb

@@ -0,0 +1,3 @@
+module LazySusan
+  VERSION = "0.7.0"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: lazy_susan
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+  prerelease: 
+platform: ruby
+authors:
+- ! 'Mark Tabler
+
+'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 Z
+dependencies: []
+description: An Automatic Index Migration Generator
+email:
+- mark.tabler@fallingmanstudios.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lazy_susan.gemspec
+- lib/generators/lazy_susan_generator.rb
+- lib/lazy_susan.rb
+- lib/lazy_susan/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/generators
+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.19
+signing_key: 
+specification_version: 3
+summary: LazySusan generates index migrations where they are needed; which is to say
+  any column detected as a primary or foreign key that does not already have an index.
+test_files: []