schemy 0.0.1 → 0.0.2

data/README.md

@@ -4,21 +4,43 @@ Schemy analyzes schema.rb to suggest new database indexes, providing a migration
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your rails app's Gemfile in the development group:
 
-    gem 'schemy'
+    group :development do
+      gem 'schemy'
+    end
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install schemy
+Within your rails app, run
 
-## Usage
+    bundle exec rake schemy:indexes
+
+## Customization
+
+By default, schemy will index:
+
+- foo**_id** (foreign keys)
+- foo**_id** and foo**_type** (polymorphic associations)
+- **type** (for STI)
+
+To create custom indexing rules, create a file in your rails app called config/schemy.yml.
+
+###Example config/schemy.yml:
+
+    indexed_columns:
+      - identifier
+      - - association_id
+        - identifier
+
+With the above configuration, schemy will create:
 
-TODO: Write usage instructions here
+- an index for any column called identifier
+- a compound index for any table that has **both** association_id and identifier
 
 ## Contributing
 

data/lib/schemy/schema_checker.rb

@@ -8,8 +8,7 @@ require_relative 'fake_column'
 module ActiveRecord
   class Schema
 
-    DEFAULT_VALIDATORS = [AssociationIdIdentifierValidator, ForeignKeyValidator,
-        IdentifierValidator, TypeValidator]
+    DEFAULT_VALIDATORS = [CustomValidator, ForeignKeyValidator, TypeValidator]
 
     def self.define(options= {}, &block)
       schema = new

data/lib/schemy/validators/custom_validator.rb

@@ -0,0 +1,38 @@
+require_relative 'base_validator'
+
+class CustomValidator < BaseValidator
+
+  def validate_column column
+    self.class.configured_column_combinations.each do |config_columns|
+
+      config_columns = Array(config_columns)
+
+      # Only validate this column if it's first in the combination config.
+      # This way we don't create duplicate indices.
+      if column == config_columns.first 
+        # Only require an index if this table has all of the columns in the column combination.
+        return unless config_columns[1..-1].all? { |col| @table.has_column? col }
+        require_index config_columns
+      end
+
+    end
+  end
+
+  def self.config_file_path
+    Rails.root.join 'config', 'schemy.yml'
+  end
+
+  def self.configured_column_combinations
+    @configured_column_combinations ||= load_configured_column_combinations
+  end
+
+  def self.load_configured_column_combinations
+    if File.exists? config_file_path
+      config = YAML.load_file config_file_path
+      config['indexed_columns']
+    else
+      []
+    end
+  end
+
+end

data/lib/schemy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schemy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000 Z
+date: 2012-08-16 00:00:00.000000000Z
 dependencies: []
 description: Analyzes schema.rb to suggest new database indexes, providing a migration
   file that can be used directly.
@@ -31,10 +31,9 @@ files:
 - 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/custom_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
@@ -59,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Analyzes schema.rb to suggest new database indexes.

data/lib/schemy/validators/association_id_identifier_validator.rb

@@ -1,10 +0,0 @@
-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/identifier_validator.rb

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