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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ian C. Anderson
+
+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 @@
+# Schemy
+
+Schemy analyzes schema.rb to suggest new database indexes, providing a migration file that can be used directly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'schemy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schemy
+
+## 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/lib/schemy.rb

@@ -0,0 +1,7 @@
+require "schemy/version"
+require 'schemy/railtie' if defined?(Rails)
+require 'schemy/analyzer'
+
+module Schemy
+  # Your code goes here...
+end

data/lib/schemy/analyzer.rb

@@ -0,0 +1,79 @@
+class Schemy::Analyzer
+
+  def initialize(schema_path)
+    @schema_path = schema_path
+  end
+
+  def create_migration
+    File.open(migration_file_path, 'w') do |f|
+      f.write(migration_string)
+    end
+  end
+
+  def migration_file_path
+    Rails.root.join 'db', 'migrate', migration_file_base_name + '.rb'
+  end
+
+  def new_indices_count
+    new_indices.count
+  end
+
+  private
+
+  def analyze
+    # load in our implementation of ActiveRecord::Schema
+    require_relative 'schema_checker'
+    # evaluate the schema with our Schema class
+    @results = eval(schema)
+  end
+
+  def migration_class_name
+    "AddIndices#{migration_timestamp}"
+  end
+
+  def migration_file_base_name
+    @migration_file_base_name ||= "#{migration_timestamp}_add_indices_#{migration_timestamp}"
+  end
+
+  def migration_string
+    if new_indices.any?
+      
+<<MIGRATION
+class #{migration_class_name} < ActiveRecord::Migration
+
+  def self.up
+#{new_indices.map{|i| "    #{i.to_s}" }.join "\n"}
+  end
+
+  def self.down
+#{new_indices.map{|i| "    #{i.to_s :down}" }.join "\n"}
+  end
+
+end
+MIGRATION
+
+    end
+  end
+
+  def migration_timestamp
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def new_indices
+    results.new_indices
+  end
+
+  def results
+    return @results if @results
+    analyze
+    @results
+  end
+
+  def schema
+    file = File.open(@schema_path, "r")
+    contents = file.read
+    file.close
+    contents
+  end
+
+end

data/lib/schemy/fake_column.rb

@@ -0,0 +1,11 @@
+class FakeColumn
+  attr_reader :name
+
+  def initialize(name, type)
+    @name = name
+    @type = type
+  end
+  def to_s
+    "#{@name}:#{@type}"
+  end
+end

data/lib/schemy/fake_index.rb

@@ -0,0 +1,45 @@
+require 'digest/md5'
+
+class FakeIndex
+  MAX_INDEX_NAME_LENGTH = 63
+
+  def initialize(table, column_names, options = {})
+    @column_names = column_names
+    @table = table
+  end
+
+  def match_columns? columns
+    columns.map(&:to_s).sort == @column_names.map(&:to_s).sort
+  end
+
+  def to_s(direction = :up)
+    if direction == :up
+      %[add_index '#{table_name}', [#{column_names_quoted}], :name => "#{index_name}"]
+    elsif direction == :down
+      %[remove_index '#{table_name}', :name => "#{index_name}"]
+    end
+  end
+
+  def table_name
+    @table.name
+  end
+
+  def column_names_quoted
+    @column_names.map do |c|
+      "'#{c}'"
+    end.join ','
+  end
+  def column_names_anded
+    @column_names.join '_and_'
+  end
+  def index_name
+    # Postgres only supports index names up to 63 chars
+    name = "index_#{table_name}_on_#{column_names_anded}"
+    if name.length > MAX_INDEX_NAME_LENGTH
+      md5 = Digest::MD5.hexdigest(name)
+      name = "index_#{table_name}_#{md5[0...10]}"
+      name = "index_#{md5[0...20]}" if name.length > MAX_INDEX_NAME_LENGTH
+    end
+    name
+  end
+end

data/lib/schemy/fake_table.rb

@@ -0,0 +1,36 @@
+require_relative 'fake_index'
+
+class FakeTable
+  attr_reader :name
+  attr_reader :columns
+
+  def initialize(table_name)
+    @name = table_name
+    @columns = []
+    @indices = []
+  end
+  def add_index(column_name, options = {})
+    @indices << FakeIndex.new(self, Array(column_name), options)
+  end
+  def method_missing(m, *args, &block)
+    data_types = [:string, :text, :integer, :float, :decimal, :datetime,
+        :timestamp, :time, :date, :binary, :boolean]
+    if data_types.include? m
+      # method names are column data types
+      @columns << FakeColumn.new(args[0], m)
+    else
+      super
+    end
+  end
+  def to_s
+    output = "=" * 30
+    output += "\n#{table_name}:\n"
+    output += @columns.inject(''){ |output, column| output += "#{column}\n" }
+  end
+  def has_index? columns
+    @indices.detect{ |index| index.match_columns? columns }
+  end
+  def has_column? column_name
+    @columns.detect{ |col| col.name.to_sym == column_name.to_sym }
+  end
+end

data/lib/schemy/railtie.rb

@@ -0,0 +1,7 @@
+module Schemy
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/schemy.rake"
+    end
+  end
+end

data/lib/schemy/schema_checker.rb

@@ -0,0 +1,56 @@
+Dir[File.dirname(__FILE__) + '/validators/*.rb'].each do |file|
+  require_relative File.join "validators", File.basename(file)[0...-3]
+end
+
+require_relative 'fake_table'
+require_relative 'fake_column'
+
+module ActiveRecord
+  class Schema
+
+    DEFAULT_VALIDATORS = [AssociationIdIdentifierValidator, ForeignKeyValidator,
+        IdentifierValidator, TypeValidator]
+
+    def self.define(options= {}, &block)
+      schema = new
+      schema.instance_eval &block
+      schema.schemy_results
+    end
+
+    def initialize
+      @tables = []
+    end
+
+    def create_table(table_name, options = {}, &block)
+      @tables << FakeTable.new(table_name)
+      yield @tables.last
+    end
+
+    def add_index(table_name, column_name, options = {})
+      get_table_by_name(table_name).add_index(column_name, options)
+    end
+
+    def to_s
+      @tables.inject(''){ |output, table| output += "#{table}\n" }
+    end
+
+    def schemy_results
+      new_indices = []
+      @tables.each do |table|
+        DEFAULT_VALIDATORS.each do |validator_klass|
+          new_indices += validator_klass.new(table).validate
+        end
+      end
+      Struct.new(:new_indices).new(new_indices)
+    end
+
+    private
+
+    def get_table_by_name(table_name)
+      @tables.detect{ |table| table.name == table_name }
+    end
+
+  end
+
+end
+

data/lib/schemy/validators/association_id_identifier_validator.rb

@@ -0,0 +1,10 @@
+require_relative 'base_validator'
+
+class AssociationIdIdentifierValidator < BaseValidator
+
+  def validate_column column
+    if column == 'association_id' && @table.has_column?('identifier')
+      require_index ['association_id', 'identifier']
+    end
+  end
+end

data/lib/schemy/validators/base_validator.rb

@@ -0,0 +1,33 @@
+class BaseValidator
+
+  attr_reader :table
+
+  def initialize(table)
+    @table = table
+  end
+
+  # returns array of unindexed columns which should be indexed
+  def validate
+    @missing_indices = []
+    @table.columns.each do |column|
+      validate_column column.name.to_s
+    end
+    @missing_indices
+  end
+
+protected
+  def validate_column(column)
+  end
+
+  def require_index(columns)
+    columns = Array columns
+    # will add to @missing_indices if no index is present for the columns
+    unless @table.has_index? columns
+      @missing_indices << index_from_columns(columns)
+    end
+  end
+
+  def index_from_columns columns
+    FakeIndex.new @table, columns
+  end
+end

data/lib/schemy/validators/foreign_key_validator.rb

@@ -0,0 +1,15 @@
+require_relative 'base_validator'
+
+class ForeignKeyValidator < BaseValidator
+
+  def validate_column column
+    if column =~ /_id$/
+      type_column = column[0...-2] + 'type'
+      if table.has_column? type_column
+        require_index [type_column, column]
+      else
+        require_index column
+      end
+    end
+  end
+end

data/lib/schemy/validators/identifier_validator.rb

@@ -0,0 +1,10 @@
+require_relative 'base_validator'
+
+class IdentifierValidator < BaseValidator
+
+  def validate_column column
+    if column == 'identifier'
+      require_index column
+    end
+  end
+end

data/lib/schemy/validators/type_validator.rb

@@ -0,0 +1,10 @@
+require_relative 'base_validator'
+
+class TypeValidator < BaseValidator
+
+  def validate_column column
+    if column == 'type'
+      require_index column
+    end
+  end
+end

data/lib/schemy/version.rb

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

data/lib/tasks/schemy.rake

@@ -0,0 +1,14 @@
+namespace :schemy do
+
+  desc 'Analyze schema.rb for indexing opportunities.'
+  task indexes: :environment do
+    analyzer = Schemy::Analyzer.new(Rails.root.join('db', 'schema.rb'))
+    analyzer.create_migration
+
+    puts "Schemy here."
+    puts "It looks like you need #{analyzer.new_indices_count} new indices."
+    puts "I created a migration for you to add new indices: #{analyzer.migration_file_path}"
+  end
+
+end
+

data/schemy.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/schemy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ian C. Anderson"]
+  gem.email         = ["anderson.ian.c@gmail.com"]
+  gem.description   = %q{Analyzes schema.rb to suggest new database indexes, providing a migration file that can be used directly.}
+  gem.summary       = %q{Analyzes schema.rb to suggest new database indexes.}
+  gem.homepage      = 'http://rubygems.org/gems/schemy'
+
+  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          = "schemy"
+  gem.require_paths = ["lib"]
+  gem.version       = Schemy::VERSION
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: schemy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian C. Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies: []
+description: Analyzes schema.rb to suggest new database indexes, providing a migration
+  file that can be used directly.
+email:
+- anderson.ian.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/schemy.rb
+- lib/schemy/analyzer.rb
+- lib/schemy/fake_column.rb
+- lib/schemy/fake_index.rb
+- lib/schemy/fake_table.rb
+- lib/schemy/railtie.rb
+- lib/schemy/schema_checker.rb
+- lib/schemy/validators/association_id_identifier_validator.rb
+- lib/schemy/validators/base_validator.rb
+- lib/schemy/validators/foreign_key_validator.rb
+- lib/schemy/validators/identifier_validator.rb
+- lib/schemy/validators/type_validator.rb
+- lib/schemy/version.rb
+- lib/tasks/schemy.rake
+- schemy.gemspec
+homepage: http://rubygems.org/gems/schemy
+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: Analyzes schema.rb to suggest new database indexes.
+test_files: []