schema_plus 0.4.1 → 1.0.0

data/lib/schema_plus/active_record/connection_adapters/sqlite3_adapter.rb

@@ -16,6 +16,30 @@ module SchemaPlus
 
         # :enddoc:
 
+        def self.included(base)
+          base.class_eval do
+            alias_method_chain :indexes, :schema_plus
+            alias_method_chain :rename_table, :schema_plus
+          end
+        end
+
+        def indexes_with_schema_plus(table_name, name = nil)
+          indexes = indexes_without_schema_plus(table_name, name)
+          exec_query("SELECT name, sql FROM sqlite_master WHERE type = 'index'").map do |row|
+            if (desc_columns = row['sql'].scan(/['"`]?(\w+)['"`]? DESC\b/).flatten).any?
+              index = indexes.detect{ |i| i.name == row['name'] }
+              index.orders = Hash[index.columns.map {|column| [column, desc_columns.include?(column) ? :desc : :asc]}]
+            end
+          end
+          indexes
+        end
+
+        def rename_table_with_schema_plus(oldname, newname) #:nodoc:
+          rename_table_without_schema_plus(oldname, newname)
+          rename_indexes_and_foreign_keys(oldname, newname)
+        end
+
+
         def add_foreign_key(table_name, column_names, references_table_name, references_column_names, options = {})
           raise NotImplementedError, "Sqlite3 does not support altering a table to add foreign key constraints (table #{table_name.inspect} column #{column_names.inspect})"
         end
@@ -54,7 +78,8 @@ module SchemaPlus
           SQL
 
           re = %r[
-            \bFOREIGN\s+KEY\s* \(\s*[`"](.+?)[`"]\s*\)
+            \b(CONSTRAINT\s+(\S+)\s+)?
+            FOREIGN\s+KEY\s* \(\s*[`"](.+?)[`"]\s*\)
             \s*REFERENCES\s*[`"](.+?)[`"]\s*\((.+?)\)
             (\s+ON\s+UPDATE\s+(.+?))?
             (\s*ON\s+DELETE\s+(.+?))?
@@ -64,13 +89,13 @@ module SchemaPlus
           foreign_keys = []
           results.each do |row|
             table_name = row["name"]
-            row["sql"].scan(re).each do |column_names, references_table_name, references_column_names, d1, on_update, d2, on_delete|
+            row["sql"].scan(re).each do |d0, name, column_names, references_table_name, references_column_names, d1, on_update, d2, on_delete|
               column_names = column_names.gsub('`', '').split(', ')
 
               references_column_names = references_column_names.gsub('`"', '').split(', ')
               on_update = on_update ? on_update.downcase.gsub(' ', '_').to_sym : :no_action
               on_delete = on_delete ? on_delete.downcase.gsub(' ', '_').to_sym : :no_action
-              foreign_keys << ForeignKeyDefinition.new(nil,
+              foreign_keys << ForeignKeyDefinition.new(name,
                                                        table_name, column_names,
                                                        references_table_name, references_column_names,
                                                        on_update, on_delete)

data/lib/schema_plus/active_record/connection_adapters/table_definition.rb

@@ -44,7 +44,7 @@ module SchemaPlus::ActiveRecord::ConnectionAdapters
   #    end
   #
   #    create_table :posts do |t|  # Dryest
-  #       t.integer :author_id, :references => :authors
+  #       t.integer :author_id, :foreign_key => true
   #    end
   #
   # <b>NOTE:</b> In the standard configuration, SchemaPlus automatically
@@ -144,5 +144,31 @@ module SchemaPlus::ActiveRecord::ConnectionAdapters
       foreign_key(*args)
     end
 
+    # This is a deliberately empty stub.  The reason for it is that
+    # ColumnOptionsHandler is used for changes as well as for table
+    # definitions, and in the case of changes, previously existing foreign
+    # keys sometimes need to be removed.  but in the case here, that of
+    # table definitions, the only reason a foreign key would exist is
+    # because we're redefining a table that already exists (via :force =>
+    # true).  in which case the foreign key will get dropped when the
+    # drop_table gets emitted, so no need to do it immediately.  (and for
+    # sqlite3, attempting to do it immediately would raise an error).
+    def remove_foreign_key(_, *args) #:nodoc:
+    end
+
+    # This is a deliberately empty stub.  In fact, verifying that it won't
+    # ever be called.  The reason for it is that ColumnOptionsHandler will
+    # remove a previous index when changing a column.  But we don't do
+    # column changes within table definitions.
+    def remove_index(_, options) raise "InternalError: remove_index called in a table definition" ; end
+
+    # Determines if an indexes is queued to be created.  Called from
+    # ColumnOptionsHandler as part of checking whether to auto-create an index
+    def index_exists?(_, column_name, options={})
+      @indexes.find{|index| index.table == self.name && index.columns == Array.wrap(column_name) && options.all?{|k, v| index.send(k) == v}}
+    end
+
+
+
   end
 end

data/lib/schema_plus/active_record/db_default.rb

@@ -0,0 +1,19 @@
+require 'singleton'
+
+module SchemaPlus
+  module ActiveRecord
+    class DbDefault 
+      include Singleton
+      def to_s
+        'DEFAULT'
+      end
+      def id
+        self
+      end
+      def quoted_id
+        self
+      end
+    end
+    DB_DEFAULT = DbDefault.instance
+  end
+end

data/lib/schema_plus/active_record/foreign_keys.rb

@@ -33,20 +33,35 @@ module SchemaPlus::ActiveRecord
     #
     # == Foreign Key Constraints
     #
-    # The +:references+ option takes the name of a table to reference in
-    # a foreign key constraint.  For example:
+    # The +:foreign_key+ option controls creation of foreign key
+    # constraints.  Specifying +true+ or an empty hash defines a foreign
+    # key with default values.  In particular, the foreign table name
+    # defaults to the column name, with trailing +_id+ removed, pluralized;
+    # And the foreign column name defaults to +:id+
     #
-    #    add_column('widgets', 'color', :integer, :references => 'colors')
+    #    add_column('widgets', 'color', :integer, :foreign_key => true)
+    #
+    # is equivalent to
+    #
+    #    add_column('widgets', 'color_id', :integer)
+    #    add_foreign_key('widgets', 'color_id', 'colors', 'id')
+    #
+    # 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, :foreign_key => true)
     #
     # is equivalent to
     #
-    #    add_column('widgets', 'color', :integer)
-    #    add_foreign_key('widgets', 'color', 'colors', 'id')
+    #    add_column('sections', 'parent_id', :integer)
+    #    add_foreign_key('sections', 'parent_id', 'sections', 'id')
     #
-    # The foreign column name defaults to +id+, but a different column
-    # can be specified using <tt>:references => [table_name,column_name]</tt>
+    # A different foreign table name can be specified using
+    # <tt>:foreign_key => { :references => table_name }</tt>, and
+    # a different column name can also be specified using <tt>:foreign_key => { :references => [table_name,column_name] }</tt>
     #
-    # Additional options +:on_update+ and +:on_delete+ can be spcified,
+    # Additional options +:on_update+ and +:on_delete+ can be specified,
     # with values as described at ConnectionAdapters::ForeignKeyDefinition.  For example:
     #
     #     add_column('comments', 'post', :integer, :references => 'posts', :on_delete => :cascade)
@@ -54,34 +69,35 @@ module SchemaPlus::ActiveRecord
     # 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>
     #
+    # The constraint will have an automatic default name, but you can
+    # specify a constraint name using <tt>:foreign_key => { :name => "my_name" }</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:
+    # with +_id+, SchemaPlus assumes that you want a foreign key constraint
+    # with default paramters.  Thus, these two 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.
+    #     add_column('posts', 'author_id', :integer, :foreign_key => true)
     #
     # If you don't want a foreign key constraint to be created, specify
-    # <tt>:references => nil</tt>.
+    # <tt>:foreign_key => false</tt>.
     # To disable automatic foreign key constraint creation globally, set
     # <tt>config.foreign_keys.auto_create = false</tt> in
     # SchemaPlus.steup.
     #
+    # == Shortcut options
+    #
+    # As a shortcut (and for backwards compatibility), the options
+    # +:references+, +:on_update+, and +:on_delete+ can provided to
+    # +add_column+ directly instead of within a +:foreign_key+ hash.
+    #
+    # The presence of option +:references+ implies the foreign
+    # key should be created, while <tt>:references => nil</tt> is a
+    # shortcut for <tt>:foreign_key => false</tt>
+    #
     # == Automatic Foreign Key Indexes
     #
     # Since efficient use of foreign key constraints requires that the
@@ -112,16 +128,8 @@ module SchemaPlus::ActiveRecord
     # 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)
       schema_plus_handle_column_options(table_name, column_name, options)
     end
 
-    protected
-    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

data/lib/schema_plus/active_record/schema_dumper.rb

@@ -64,7 +64,10 @@ module SchemaPlus
             @inline_fks[table] = @connection.foreign_keys(table)
             dependencies = @inline_fks[table].collect(&:references_table_name)
           end
-          @dump_dependencies[table] = dependencies.sort.uniq - ::ActiveRecord::SchemaDumper.ignore_tables
+          # select against @table_dumps keys to respect filtering based on
+          # SchemaDumper.ignore_tables (which was taken into account
+          # increate @table_dumps)
+          @dump_dependencies[table] = dependencies.sort.uniq.select {|name| @table_dumps.has_key? name}
         end
 
         # Normally we dump foreign key constraints inline in the table
@@ -101,7 +104,7 @@ module SchemaPlus
         stream_string = stream.string
         @connection.columns(table).each do |column|
           if !column.default_expr.nil?
-            stream_string.gsub!("\"#{column.name}\"", "\"#{column.name}\", :default => { :expr => \"#{column.default_expr}\" }")
+            stream_string.gsub!("\"#{column.name}\"", "\"#{column.name}\", :default => { :expr => #{column.default_expr.inspect} }")
           end
         end
         @table_dumps[table] = stream_string
@@ -123,6 +126,7 @@ module SchemaPlus
             dump << ", :conditions => #{index.conditions.inspect}" unless index.conditions.blank?
             index_lengths = index.lengths.compact if index.lengths.is_a?(Array)
             dump << ", :length => #{Hash[*index.columns.zip(index.lengths).flatten].inspect}" if index_lengths.present?
+            dump << ", :order => {" + index.columns.map{|column| column.inspect + " => " + (index.orders[column] || :asc).inspect}.join(", ") + "}" if index.orders
           else
             dump << " :name => #{index.name.inspect}"
             dump << ", :kind => \"#{index.kind}\"" unless index.kind.blank?
@@ -133,7 +137,7 @@ module SchemaPlus
       end
 
       def dump_foreign_keys(foreign_keys, opts={}) #:nodoc:
-        foreign_keys.collect{ |foreign_key| "  " + foreign_key.to_dump(:inline => opts[:inline]) }.join
+        foreign_keys.collect{ |foreign_key| "  " + foreign_key.to_dump(:inline => opts[:inline]) }.sort.join
       end
     end
   end

data/lib/schema_plus/version.rb

@@ -1,3 +1,3 @@
 module SchemaPlus
-  VERSION = "0.4.1"
+  VERSION = "1.0.0"
 end

data/runspecs

@@ -4,8 +4,8 @@ require 'optparse'
 require 'ostruct'
 require 'tempfile'
 
-RUBY_VERSIONS = %W[1.8.7 1.9.2 1.9.3]
-RAILS_VERSIONS = %W[2.3 3.0 3.1 3.2]
+RUBY_VERSIONS = %W[1.9.2 1.9.3]
+RAILS_VERSIONS = %W[3.2]
 DB_ADAPTERS = %W[postgresql mysql mysql2 sqlite3]
 
 o = OpenStruct.new
@@ -58,13 +58,9 @@ end.parse!
 Combo = Struct.new(:ruby, :rails, :db_adapter)
 
 
-if o.update or o.install
-    o.db_adapters = [nil]
-end
-
 combos = o.ruby_versions.product(o.rails_versions, o.db_adapters).map{|product| Combo.new(*product)}.select {|combo|
     case
-    when combo.rails >= "3.2" && combo.ruby <= "1.8.7" then false
+    when combo.rails >= "3.2" && combo.ruby <= "1.8.7" then false  # no longer happens, just keeping it as an example
     else true
     end
 }
@@ -86,7 +82,7 @@ combos.each_with_index do |combo, n|
               "bundle exec rake #{db_adapter}:spec"
           end
 
-    command = %Q{BUNDLE_GEMFILE="#{File.join(GEMFILES_DIR, "Gemfile.rails-#{rails}")}" rvm #{ruby} do #{cmd}}
+    command = %Q{BUNDLE_GEMFILE="#{File.join(GEMFILES_DIR, "rails-#{rails}", "Gemfile.#{db_adapter}")}" rvm #{ruby} do #{cmd}}
 
     puts "\n\n*** ruby version #{ruby} - rails version #{rails} - db adapter: #{db_adapter}  [#{n+1} of #{combos.size}]\n\n#{command}"
 
@@ -99,3 +95,4 @@ combos.each_with_index do |combo, n|
     end
 end
 puts errs.any? ?  "\n*** #{errs.size} failures:\n\t#{errs.join("\n\t")}" : "\n*** #{combos.size > 1 ? 'all versions' : 'spec'} succeeded ***" unless o.dry_run
+exit !errs.any?

data/schema_plus.gemspec

@@ -20,14 +20,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency("rails")
+  s.add_dependency("rails", ">= 3.2")
   s.add_dependency("valuable")
 
-  s.add_development_dependency("rake", "~> 0.8.7")
+  s.add_development_dependency("rake")
   s.add_development_dependency("rspec")
-  s.add_development_dependency("pg")
-  s.add_development_dependency("mysql")
-  s.add_development_dependency("sqlite3")
   s.add_development_dependency("simplecov")
   s.add_development_dependency("simplecov-gem-adapter")
 end

data/spec/column_definition_spec.rb

@@ -3,7 +3,24 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Column definition" do
   before(:all) do
-    load_core_schema
+    define_schema(:auto_create => false) do
+      create_table :users, :force => true do |t|
+        t.string :login
+        t.datetime :deleted_at
+      end
+
+      create_table :posts, :force => true do |t|
+        t.text :body
+        t.integer :user_id
+        t.integer :author_id
+      end
+
+      create_table :comments, :force => true do |t|
+        t.text :body
+        t.integer :post_id
+        t.foreign_key :post_id, :posts, :id
+      end
+    end
   end
 
   let(:connection) { ActiveRecord::Base.connection }

data/spec/column_spec.rb

@@ -1,8 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-require 'models/user'
-
 describe "Column" do
+
+  before(:all) do
+      class User < ::ActiveRecord::Base ; end
+  end
+    
   let(:migration) { ::ActiveRecord::Migration }
 
   context "regarding indexes" do
@@ -82,6 +85,40 @@ describe "Column" do
 
   end
 
+  context "using DB_DEFAULT" do
+
+    before(:each) do
+      create_table(User, :alpha => { :default => "gabba" }, :beta => {})
+    end
+
+    if SchemaPlusHelpers.sqlite3?
+      it "creating a record should raise an error" do
+        expect { User.create!(:alpha => ActiveRecord::DB_DEFAULT, :beta => "hello") }.to raise_error ActiveRecord::StatementInvalid
+      end
+      it "updating a record should raise an error" do
+        u = User.create!(:alpha => "hey", :beta => "hello")
+        expect { u.update_attributes(:alpha => ActiveRecord::DB_DEFAULT, :beta => "goodbye") }.to raise_error ActiveRecord::StatementInvalid
+      end
+    else
+
+      it "creating a record should respect default expression" do
+        User.create!(:alpha => ActiveRecord::DB_DEFAULT, :beta => "hello")
+        User.last.alpha.should == "gabba"
+        User.last.beta.should == "hello"
+      end
+
+      it "updating a record should respect default expression" do
+        u = User.create!(:alpha => "hey", :beta => "hello")
+        u.reload
+        u.alpha.should == "hey"
+        u.beta.should == "hello"
+        u.update_attributes(:alpha => ActiveRecord::DB_DEFAULT, :beta => "goodbye")
+        u.reload
+        u.alpha.should == "gabba"
+        u.beta.should == "goodbye"
+      end
+    end
+  end
 
   protected
 

data/spec/connection_spec.rb

@@ -5,6 +5,6 @@ describe "Connection" do
   it "should re-open without failure" do
     expect {
       ActiveRecord::Base.establish_connection "schema_plus"
-    }.should_not raise_error
+    }.to_not raise_error
   end
 end

data/spec/connections/mysql/connection.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.logger = Logger.new(File.open("mysql.log", "w"))
 ActiveRecord::Base.configurations = {
   'schema_plus' => {
     :adapter => 'mysql',
-    :database => 'schema_plus_unittest',
+    :database => 'schema_plus_test',
     :username => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
     :encoding => 'utf8',
     :min_messages => 'warning'

data/spec/connections/mysql2/connection.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.logger = Logger.new(File.open("mysql2.log", "w"))
 ActiveRecord::Base.configurations = {
   'schema_plus' => {
     :adapter => 'mysql2',
-    :database => 'schema_plus_unittest',
+    :database => 'schema_plus_test',
     :username => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
     :encoding => 'utf8',
     :min_messages => 'warning'

data/spec/connections/postgresql/connection.rb

@@ -7,7 +7,7 @@ ActiveRecord::Base.configurations = {
   'schema_plus' => {
     :adapter => 'postgresql',
     :username => ENV['POSTGRES_DB_USER'],
-    :database => 'schema_plus_unittest',
+    :database => 'schema_plus_test',
     :min_messages => 'warning'
   }