schema_plus 0.1.2 → 0.1.3

data/spec/references_spec.rb

@@ -4,7 +4,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe 'get_references method' do
 
   before(:all) do
-    @target = ActiveRecord::Migration
+    @target = ActiveRecord::Migration.connection
     @table_name = 'comments'
     @column_name = 'post_id'
     @destination_table = 'posts'

data/spec/support/helpers.rb

@@ -13,4 +13,8 @@ module SchemaPlusHelpers
     ActiveRecord::Base.connection.adapter_name =~ /^sqlite/i
   end
 
+  def suppress_messages
+    ActiveRecord::Migration.suppress_messages { yield }
+  end
+
 end

metadata

@@ -1,129 +1,126 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: schema_plus
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.3
   prerelease: 
-  version: 0.1.2
 platform: ruby
-authors: 
+authors:
 - Ronen Barzel
-- "Micha\xC5\x82 \xC5\x81omnicki"
+- Michał Łomnicki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-04 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &69439930 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: valuable
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *69439930
+- !ruby/object:Gem::Dependency
+  name: valuable
+  requirement: &69439700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *69439700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &69439390 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *69439390
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &69439120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: pg
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *69439120
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: &69438750 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: mysql
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *69438750
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: &69438370 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *69438370
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &69437940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *69437940
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &69437700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: simplecov-gem-adapter
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *69437700
+- !ruby/object:Gem::Dependency
+  name: simplecov-gem-adapter
+  requirement: &69437420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-description: "SchemaPlus is an ActiveRecord extension that provides enhanced capabilities for schema definition and querying, including: enhanced and more DRY index capabilities, support and automation for foreign key constraints, and support for views."
-email: 
+  prerelease: false
+  version_requirements: *69437420
+description: ! 'SchemaPlus is an ActiveRecord extension that provides enhanced capabilities
+  for schema definition and querying, including: enhanced and more DRY index capabilities,
+  support and automation for foreign key constraints, and support for views.'
+email:
 - ronen@barzel.org
 - michal.lomnicki@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -131,8 +128,11 @@ files:
 - README.rdoc
 - Rakefile
 - gemfiles/Gemfile.rails-2.3
+- gemfiles/Gemfile.rails-2.3.lock
 - gemfiles/Gemfile.rails-3.0
+- gemfiles/Gemfile.rails-3.0.lock
 - gemfiles/Gemfile.rails-3.1
+- gemfiles/Gemfile.rails-3.1.lock
 - init.rb
 - lib/schema_plus.rb
 - lib/schema_plus/active_record/base.rb
@@ -145,7 +145,7 @@ files:
 - lib/schema_plus/active_record/connection_adapters/schema_statements.rb
 - lib/schema_plus/active_record/connection_adapters/sqlite3_adapter.rb
 - lib/schema_plus/active_record/connection_adapters/table_definition.rb
-- lib/schema_plus/active_record/migration.rb
+- lib/schema_plus/active_record/foreign_keys.rb
 - lib/schema_plus/active_record/schema.rb
 - lib/schema_plus/active_record/schema_dumper.rb
 - lib/schema_plus/railtie.rb
@@ -165,6 +165,7 @@ files:
 - spec/models/comment.rb
 - spec/models/post.rb
 - spec/models/user.rb
+- spec/rails3_migration_spec.rb
 - spec/references_spec.rb
 - spec/schema/auto_schema.rb
 - spec/schema/core_schema.rb
@@ -177,57 +178,29 @@ files:
 - spec/support/matchers/reference.rb
 - spec/support/reference.rb
 - spec/views_spec.rb
-has_rdoc: true
 homepage: https://github.com/lomba/schema_plus
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: schema_plus
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Enhances ActiveRecord schema mechanism, including more DRY index creation and support for foreign key constraints and views.
-test_files: 
-- spec/column_spec.rb
-- spec/connections/mysql/connection.rb
-- spec/connections/mysql2/connection.rb
-- spec/connections/postgresql/connection.rb
-- spec/connections/sqlite3/connection.rb
-- spec/foreign_key_definition_spec.rb
-- spec/foreign_key_spec.rb
-- spec/index_definition_spec.rb
-- spec/index_spec.rb
-- spec/migration_spec.rb
-- spec/models/comment.rb
-- spec/models/post.rb
-- spec/models/user.rb
-- spec/references_spec.rb
-- spec/schema/auto_schema.rb
-- spec/schema/core_schema.rb
-- spec/schema_dumper_spec.rb
-- spec/schema_spec.rb
-- spec/spec_helper.rb
-- spec/support/helpers.rb
-- spec/support/matchers/automatic_foreign_key_matchers.rb
-- spec/support/matchers/have_index.rb
-- spec/support/matchers/reference.rb
-- spec/support/reference.rb
-- spec/views_spec.rb
+summary: Enhances ActiveRecord schema mechanism, including more DRY index creation
+  and support for foreign key constraints and views.
+test_files: []

data/lib/schema_plus/active_record/migration.rb

@@ -1,220 +0,0 @@
-module SchemaPlus::ActiveRecord
-  # SchemaPlus extends ActiveRecord::Migration with several enhancements.  See documentation at Migration::ClassMethods
-  module Migration
-    def self.included(base) #:nodoc:
-      base.extend(ClassMethods)
-    end
-
-    #
-    # SchemaPlus extends ActiveRecord::Migration with the following enhancements.
-    #
-    module ClassMethods
-
-      # Create a new view, given its name and SQL definition
-      #
-      def create_view(view_name, definition)
-        connection.create_view(view_name, definition)
-      end
-
-      # Drop the named view
-      def drop_view(view_name)
-        connection.drop_view(view_name)
-      end
-
-      # Define a foreign key constraint.  Valid options are :on_update,
-      # :on_delete, and :deferrable, with values as described at
-      # ConnectionAdapters::ForeignKeyDefinition
-      #
-      # (NOTE: Sqlite3 does not support altering a table to add foreign-key
-      # constraints; they must be included in the table specification when
-      # it's created.  If you're using Sqlite3, this method will raise an
-      # error.)
-      def add_foreign_key(table_name, column_names, references_table_name, references_column_names, options = {})
-        connection.add_foreign_key(table_name, column_names, references_table_name, references_column_names, options)
-      end
-
-      # Remove a foreign key constraint
-      #
-      # (NOTE: Sqlite3 does not support altering a table to remove
-      # foreign-key constraints.  If you're using Sqlite3, this method will
-      # raise an error.)
-      def remove_foreign_key(table_name, foreign_key_name)
-        connection.remove_foreign_key(table_name, foreign_key_name)
-      end
-      
-      # Enhances ActiveRecord::Migration#add_column to support indexes and foreign keys, with automatic creation
-      #
-      # == Indexes
-      #
-      # The <tt>:index</tt> option takes a hash of parameters to pass to ActiveRecord::Migration.add_index.  Thus
-      #
-      #    add_column('books', 'isbn', :string, :index => {:name => "ISBN-index", :unique => true })
-      # 
-      # is equivalent to:
-      #
-      #    add_column('books', 'isbn', :string)
-      #    add_index('books', ['isbn'], :name => "ISBN-index", :unique => true)
-      #
-      #
-      # In order to support multi-column indexes, an special parameter <tt>:with</tt> may be specified, which takes another column name or an array of column names to include in the index.  Thus
-      #
-      #    add_column('contacts', 'phone_number', :string, :index => { :with => [:country_code, :area_code], :unique => true })
-      # 
-      # is equivalent to:
-      #
-      #    add_column('contacts', 'phone_number', :string)
-      #    add_index('contacts', ['phone_number', 'country_code', 'area_code'], :unique => true)
-      #
-      #
-      # Some convenient shorthands are available:
-      #
-      #    add_column('books', 'isbn', :index => true) # adds index with no extra options
-      #    add_column('books', 'isbn', :index => :unique) # adds index with :unique => true
-      #
-      # == Foreign Key Constraints
-      #
-      # The +:references+ option takes the name of a table to reference in
-      # a foreign key constraint.  For example:
-      #
-      #    add_column('widgets', 'color', :integer, :references => 'colors')
-      #
-      # is equivalent to
-      #
-      #    add_column('widgets', 'color', :integer)
-      #    add_foreign_key('widgets', 'color', 'colors', 'id')
-      #
-      # The foreign column name defaults to +id+, but a different column
-      # can be specified using <tt>:references => [table_name,column_name]</tt>
-      #
-      # Additional options +:on_update+ and +:on_delete+ can be spcified,
-      # with values as described at ConnectionAdapters::ForeignKeyDefinition.  For example:
-      #
-      #     add_column('comments', 'post', :integer, :references => 'posts', :on_delete => :cascade)
-      #
-      # Global default values for +:on_update+ and +:on_delete+ can be
-      # specified in SchemaPlus.steup via, e.g., <tt>config.foreign_keys.on_update = :cascade</tt>
-      #
-      # == Automatic Foreign Key Constraints
-      #
-      # SchemaPlus supports the convention of naming foreign key columns
-      # with a suffix of +_id+.   That is, if you define a column suffixed
-      # with +_id+, SchemaPlus assumes an implied :references to a table
-      # whose name is the column name prefix, pluralized.  For example,
-      # these are equivalent:
-      #
-      #     add_column('posts', 'author_id', :integer)
-      #     add_column('posts', 'author_id', :integer, :references => 'authors')
-      #
-      # As a special case, if the column is named 'parent_id', SchemaPlus
-      # assumes it's a self reference, for a record that acts as a node of
-      # a tree.  Thus, these are equivalent:
-      #
-      #     add_column('sections', 'parent_id', :integer)
-      #     add_column('sections', 'parent_id', :integer, :references => 'sections')
-      #      
-      # If the implicit +:references+ value isn't what you want (e.g., the
-      # table name isn't pluralized), you can explicitly specify
-      # +:references+ and it will override the implicit value.
-      #
-      # If you don't want a foreign key constraint to be created, specify
-      # <tt>:references => nil</tt>.
-      # To disable automatic foreign key constraint creation globally, set
-      # <tt>config.foreign_keys.auto_create = false</tt> in
-      # SchemaPlus.steup.
-      #
-      # == Automatic Foreign Key Indexes
-      #
-      # Since efficient use of foreign key constraints requires that the
-      # referencing column be indexed, SchemaPlus will automatically create
-      # an index for the column if it created a foreign key.  Thus
-      #
-      #    add_column('widgets', 'color', :integer, :references => 'colors')
-      #
-      # is equivalent to:
-      #
-      #    add_column('widgets', 'color', :integer, :references => 'colors', :index => true)
-      #
-      # If you want to pass options to the index, you can explcitly pass
-      # index options, such as <tt>:index => :unique</tt>. 
-      #
-      # If you don't want an index to be created, specify
-      # <tt>:index => nil</tt>.
-      # To disable automatic foreign key index creation globally, set
-      # <tt>config.foreign_keys.auto_index = false</tt> in
-      # SchemaPlus.steup.  (*Note*: If you're using MySQL, it will
-      # automatically create an index for foreign keys if you don't.)
-      #
-      def add_column(table_name, column_name, type, options = {})
-        super
-        handle_column_options(table_name, column_name, options)
-      end
-
-      # Enhances ActiveRecord::Migration#change_column to support indexes and foreign keys same as add_column.
-      def change_column(table_name, column_name, type, options = {})
-        super
-        remove_foreign_key_if_exists(table_name, column_name)
-        handle_column_options(table_name, column_name, options)
-      end
-      
-      # Determines referenced table and column.
-      # Used in migrations.  
-      #
-      # If auto_create is true:
-      #   get_references('comments', 'post_id') # => ['posts', 'id']
-      #
-      # And if <tt>column_name</tt> is parent_id it references to the same table
-      #   get_references('pages', 'parent_id')  # => ['pages', 'id']
-      #
-      # If :references option is given, it is used (whether or not auto_create is true)
-      #   get_references('widgets', 'main_page_id', :references => 'pages')) 
-      #   # => ['pages', 'id']
-      #
-      # Also the referenced id column may be specified:
-      #   get_references('addresses', 'member_id', :references => ['users', 'uuid'])
-      #   # => ['users', 'uuid']
-      def get_references(table_name, column_name, options = {}, config=nil) #:nodoc:
-        column_name = column_name.to_s
-        if options.has_key?(:references)
-          references = options[:references]
-          references = [references, :id] unless references.nil? || references.is_a?(Array)
-          references
-        elsif (config || SchemaPlus.config).foreign_keys.auto_create? && !ActiveRecord::Schema.defining?
-          if column_name == 'parent_id'
-            [table_name, :id]
-          elsif column_name =~ /^(.*)_id$/
-            determined_table_name = ActiveRecord::Base.pluralize_table_names ? $1.to_s.pluralize : $1
-            [determined_table_name, :id]
-          end
-        end
-      end
-
-      protected
-      def handle_column_options(table_name, column_name, options) #:nodoc:
-        if references = get_references(table_name, column_name, options)
-          if index = options.fetch(:index, SchemaPlus.config.foreign_keys.auto_index? && !ActiveRecord::Schema.defining?)
-            column_index(table_name, column_name, index)
-          end
-          add_foreign_key(table_name, column_name, references.first, references.last,
-                          options.reverse_merge(:on_update => SchemaPlus.config.foreign_keys.on_update,
-                                                :on_delete => SchemaPlus.config.foreign_keys.on_delete))
-        elsif options[:index]
-          column_index(table_name, column_name, options[:index])
-        end
-      end
-
-      def column_index(table_name, column_name, options) #:nodoc:
-        options = {} if options == true
-        options = { :unique => true } if options == :unique
-        column_name = [column_name] + Array.wrap(options.delete(:with)).compact
-        add_index(table_name, column_name, options)
-      end
-
-      def remove_foreign_key_if_exists(table_name, column_name) #:nodoc:
-        foreign_keys = ActiveRecord::Base.connection.foreign_keys(table_name.to_s)
-        fk = foreign_keys.detect { |fk| fk.table_name == table_name.to_s && fk.column_names == Array(column_name).collect(&:to_s) }
-        remove_foreign_key(table_name, fk.name) if fk
-      end
-
-    end
-  end
-end