dwilkie-foreigner 0.4.1 → 0.5.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 [name of plugin creator]
+Copyright (c) 2010 David Wilkie
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,3 +18,4 @@ 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.textile

@@ -0,0 +1,119 @@
+h1. dwilkie Foreigner
+
+dwilkie-foreigner is a fork of "Matt Higgins Foreigner":http://github.com/matthuhiggins/foreigner/
+which supports adding AND enforcing foreign key constraints on Sqlite3 databases.
+
+h2. Some Examples
+
+dwilkie-foreigner allows you to do the following in your migration files
+<pre>
+  create_table :comments do |t|
+    t.references :posts, :foreign_key => true, :null => false
+  end
+</pre>
+Which will generate the following SQL:
+<pre>
+  CREATE TABLE "comments" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+  "post_id" integer NOT NULL,
+  FOREIGN KEY ("post_id") REFERENCES "posts"(id));
+</pre>
+
+Go a different column name?
+<pre>
+  create_table :comments do |t|
+    t.references :article, :null => false
+    t.foreign_key :posts, :column => :article_id
+  end
+</pre>
+Which generates:
+<pre>
+  CREATE TABLE "comments" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+  "article_id" integer NOT NULL,
+  FOREIGN KEY ("article_id") REFERENCES "posts"(id));
+</pre>
+
+Want to specify a dependency (nullify or delete)?
+<pre>
+  create_table :comments do |t|
+    t.references :posts, :foreign_key => {:dependent => :delete}, :null => false
+  end
+</pre>
+Generates:
+<pre>
+  CREATE TABLE "comments" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+  "post_id" integer NOT NULL,
+  FOREIGN KEY ("post_id") REFERENCES "posts"(id) ON DELETE CASCADE);
+</pre>
+Or:
+<pre>
+  create_table :comments do |t|
+    t.references :article, :null => false
+    t.foreign_key :posts, :column => :article_id, :dependent => :nullify
+  end
+</pre>
+Which generates:
+<pre>
+  CREATE TABLE "comments" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+  "article_id" integer NOT NULL,
+  FOREIGN KEY ("article_id") REFERENCES "posts"(id) ON DELETE SET NULL);
+</pre>
+
+h2. Enforcing constraints
+
+SQLite does not enforce database constraints out of the box
+This provides you with the flexibility in choosing whether or not to enforce
+constraints at the DB level or not.
+
+In order to enforce your constraints:
+<pre>
+  script/dbconsole
+  .genfkey --exec
+</pre>
+
+While your in the console run:
+<pre>
+  .schema
+</pre>
+to see your constraints implemented as triggers
+
+h2. schema.rb
+
+All of the constrants are updated in schema.rb
+when you run:
+<pre>
+  rake db:migrate
+  rake db:schema:dump
+</pre>
+This allows you to see the state of your migratons and
+take advantage of using <pre>rake db:schema:load</pre>
+
+h2. Limitations
+
+Since SQLite does not have complete ALTER TABLE support
+you cannot use the following syntax:
+<pre>
+  add_foreign_key
+  remove_foreign_key
+</pre>
+
+Therefore you must add your foreign keys when you define your table,
+which may involve editing existing migration files instead of generating new ones
+
+h2. Installation
+
+Add the following to environment.rb:
+<pre>
+  config.gem "dwilkie-foreigner", :lib => "foreigner", :source => "http://gemcutter.org"
+</pre>
+Then run
+<pre>
+  sudo rake gems:install
+</pre>
+
+h2. See also
+
+Don't need support for other databases?
+Check out "sqlite-foreigner":http://github.com/dwilkie/sqlite-foreigner/tree/master
+
+Copyright (c) 2009 David Wilkie, released under the MIT license
+

data/lib/foreigner.rb

@@ -14,7 +14,7 @@ module ActiveRecord
   end
 
   Base.class_eval do
-    if %w(SQLite).include? connection_pool.spec.config[:adapter].downcase
+    if %w(sqlite3).include? connection_pool.spec.config[:adapter].downcase
       require "foreigner/connection_adapters/#{connection_pool.spec.config[:adapter].downcase}_adapter"
     end
     if %w(mysql postgresql).include? connection_pool.spec.config[:adapter].downcase

data/lib/foreigner/connection_adapters/abstract/schema_definitions.rb

@@ -2,27 +2,28 @@ module Foreigner
   module ConnectionAdapters
     class ForeignKeyDefinition < Struct.new(:from_table, :to_table, :options) #:nodoc:
     end
-    
+
     module SchemaDefinitions
       def self.included(base)
         base::TableDefinition.class_eval do
           include Foreigner::ConnectionAdapters::TableDefinition
         end
-        
+
         base::Table.class_eval do
           include Foreigner::ConnectionAdapters::Table
         end
       end
     end
-  
+
     module TableDefinition
       def self.included(base)
         base.class_eval do
           include InstanceMethods
           alias_method_chain :references, :foreign_keys
+          alias_method_chain :to_sql, :foreign_keys
         end
       end
-    
+
       module InstanceMethods
         def references_with_foreign_keys(*args)
           options = args.extract_options!
@@ -35,13 +36,24 @@ module Foreigner
 
           references_without_foreign_keys(*(args << options))
         end
-    
+
         def foreign_key(to_table, options = {})
           ActiveSupport::Deprecation.warn(
             'adding a foreign key inside create_table is deprecated. ' +
             'to add a foreign key, use add_foreign_key', caller[0,10]
           )
         end
+
+        def to_sql_with_foreign_keys
+          sql = to_sql_without_foreign_keys
+          sql << ', ' << (foreign_keys * ', ') if foreign_keys.present?
+          sql
+        end
+
+        private
+          def foreign_keys
+            @foreign_keys ||= []
+          end
       end
     end
 
@@ -69,7 +81,7 @@ module Foreigner
         def foreign_key(to_table, options = {})
           @base.add_foreign_key(@table_name, to_table, options)
         end
-    
+
         # Remove the given foreign key from the table.
         #
         # ===== Examples
@@ -82,17 +94,17 @@ module Foreigner
         def remove_foreign_key(options = {})
           @base.remove_foreign_key(@table_name, options)
         end
-      
+
         # Adds a :foreign_key option to TableDefinition.references.
         # If :foreign_key is true, a foreign key constraint is added to the table.
         # You can also specify a hash, which is passed as foreign key options.
-        # 
+        #
         # ===== Examples
         # ====== Add goat_id column and a foreign key to the goats table.
         #  t.references(:goat, :foreign_key => true)
         # ====== Add goat_id column and a cascading foreign key to the goats table.
         #  t.references(:goat, :foreign_key => {:dependent => :delete})
-        # 
+        #
         # Note: No foreign key is created if :polymorphic => true is used.
         def references_with_foreign_keys(*args)
           options = args.extract_options!
@@ -110,3 +122,4 @@ module Foreigner
     end
   end
 end
+

data/lib/foreigner/connection_adapters/sql_2003.rb

@@ -4,7 +4,16 @@ module Foreigner
       def supports_foreign_keys?
         true
       end
-    
+
+      def foreign_key_definition(to_table, options = {})
+        column  = options[:column] || "#{to_table.to_s.singularize}_id"
+        dependency = dependency_sql(options[:dependent])
+
+        sql = "FOREIGN KEY (#{quote_column_name(column)}) REFERENCES #{quote_table_name(to_table)}(id)"
+        sql << " #{dependency}" unless dependency.blank?
+        sql
+      end
+
       def add_foreign_key(from_table, to_table, options = {})
         column  = options[:column] || "#{to_table.to_s.singularize}_id"
         foreign_key_name = foreign_key_name(from_table, column, options)
@@ -18,7 +27,7 @@ module Foreigner
           "REFERENCES #{quote_table_name(ActiveRecord::Migrator.proper_table_name(to_table))}(#{primary_key})"
 
         sql << " #{dependency}" unless dependency.blank?
-      
+
         execute(sql)
       end
 
@@ -40,4 +49,5 @@ module Foreigner
         end
     end
   end
-end
+end
+

data/lib/foreigner/connection_adapters/sqlite3_adapter.rb

@@ -0,0 +1,104 @@
+require 'foreigner/connection_adapters/sql_2003'
+
+module Foreigner
+  module ConnectionAdapters
+    module TableDefinition
+      class ForeignKey < Struct.new(:base, :to_table, :options)
+
+        def to_sql
+          base.foreign_key_definition(to_table, options)
+        end
+        alias to_s :to_sql
+      end
+
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+        # Adds a :foreign_key option to TableDefinition.references.
+        # If :foreign_key is true, a foreign key constraint is added to the table.
+        # You can also specify a hash, which is passed as foreign key options.
+        #
+        # ===== Examples
+        # ====== Add goat_id column and a foreign key to the goats table.
+        #  t.references(:goat, :foreign_key => true)
+        # ====== Add goat_id column and a cascading foreign key to the goats table.
+        #  t.references(:goat, :foreign_key => {:dependent => :delete})
+        #
+        # Note: No foreign key is created if :polymorphic => true is used.
+        def references_with_foreign_keys(*args)
+          options = args.extract_options!
+          fk_options = options.delete(:foreign_key)
+
+          if fk_options && !options[:polymorphic]
+            fk_options = {} if fk_options == true
+            args.each { |to_table| foreign_key(to_table, fk_options) }
+          end
+
+          references_without_foreign_keys(*(args << options))
+        end
+
+        # Defines a foreign key for the table. +to_table+ can be a single Symbol, or
+        # an Array of Symbols.
+        #
+        # ===== Examples
+        # ====== Creating a simple foreign key
+        #  t.foreign_key(:people)
+        # ====== Defining the column
+        #  t.foreign_key(:people, :column => :sender_id)
+        # ====== Specify cascading foreign key
+        #  t.foreign_key(:people, :dependent => :delete)
+        def foreign_key(to_table, options = {})
+          if @base.supports_foreign_keys?
+            to_table = to_table.to_s.pluralize if ActiveRecord::Base.pluralize_table_names
+            foreign_keys << ForeignKey.new(@base, to_table, options)
+          end
+        end
+      end
+    end
+
+    module SQLite3Adapter
+      include Foreigner::ConnectionAdapters::Sql2003
+
+      def foreign_keys(table_name)
+        foreign_keys = []
+        create_table_info = select_value %{
+SELECT sql
+FROM sqlite_master
+WHERE sql LIKE '%FOREIGN KEY%'
+AND name = '#{table_name}'
+}
+      unless create_table_info.nil?
+        fk_columns = create_table_info.scan(/FOREIGN KEY\s*\(\"([^\"]+)\"\)/)
+        fk_tables = create_table_info.scan(/REFERENCES\s*\"([^\"]+)\"/)
+        fk_references = create_table_info.scan(/REFERENCES[^\,]+/)
+        if fk_columns.size == fk_tables.size && fk_references.size == fk_columns.size
+          fk_columns.each_with_index do |fk_column, index|
+            if fk_references[index] =~ /ON DELETE CASCADE/
+              fk_references[index] = :delete
+            elsif fk_references[index] =~ /ON DELETE SET NULL/
+              fk_references[index] = :nullify
+            else
+              fk_references[index] = nil
+            end
+            foreign_keys << ForeignKeyDefinition.new(table_name, fk_tables[index][0], :column => fk_column[0], :dependent => fk_references[index])
+          end
+        end
+      end
+      foreign_keys
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    SQLite3Adapter.class_eval do
+      include Foreigner::ConnectionAdapters::SQLite3Adapter
+    end
+  end
+end
+

data/lib/foreigner/schema_dumper.rb

@@ -28,13 +28,12 @@ module Foreigner
 
       private
         def foreign_keys(table_name, stream)
-          debugger
           if (foreign_keys = @connection.foreign_keys(table_name)).any?
             add_foreign_key_statements = foreign_keys.map do |foreign_key|
               statement_parts = [ ('add_foreign_key ' + foreign_key.from_table.inspect) ]
               statement_parts << foreign_key.to_table.inspect
               statement_parts << (':name => ' + foreign_key.options[:name].inspect)
-              
+
               if foreign_key.options[:column] != "#{foreign_key.to_table.singularize}_id"
                 statement_parts << (':column => ' + foreign_key.options[:column].inspect)
               end
@@ -53,8 +52,9 @@ module Foreigner
           end
         end
 
-        # This is a direct copy from
-        # active_record/schema.dumper
+        # This is almost direct copy from
+        # active_record/schema.dumper with the add_foreign_keys method
+        # inserted into the middle
         def foreign_key_table(table, stream)
           columns = @connection.columns(table)
           begin
@@ -119,6 +119,7 @@ module Foreigner
               tbl.puts
             end
 
+            # add the foreign keys
             add_foreign_keys(table, tbl)
 
             tbl.puts "  end"
@@ -142,6 +143,7 @@ module Foreigner
             add_foreign_key_statements = foreign_keys.map do |foreign_key|
               statement_parts = ["  t.foreign_key " + foreign_key.to_table.inspect]
               statement_parts << (':column => ' + foreign_key.options[:column].inspect)
+              statement_parts << (':dependent => ' + foreign_key.options[:dependent].inspect)
               '  ' + statement_parts.join(', ')
             end
 
@@ -150,4 +152,5 @@ module Foreigner
         end
     end
   end
-end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dwilkie-foreigner
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - David Wilkie
@@ -20,17 +20,17 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.textile
 files: 
 - MIT-LICENSE
 - Rakefile
-- README
+- README.textile
 - lib/foreigner.rb
 - lib/foreigner/schema_dumper.rb
 - lib/foreigner/connection_adapters/sql_2003.rb
 - lib/foreigner/connection_adapters/mysql_adapter.rb
 - lib/foreigner/connection_adapters/postgresql_adapter.rb
-- lib/foreigner/connection_adapters/sqlite_adapter.rb
+- lib/foreigner/connection_adapters/sqlite3_adapter.rb
 - lib/foreigner/connection_adapters/abstract/schema_definitions.rb
 - lib/foreigner/connection_adapters/abstract/schema_statements.rb
 - test/helper.rb
@@ -43,7 +43,7 @@ post_install_message:
 rdoc_options: 
 - --line-numbers
 - --main
-- README
+- README.textile
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README

@@ -1,76 +0,0 @@
-Foreigner
-=========
-
-Adds limited SQLite support for Matt Higgins Foreigner.
-
-Allows you to do the following in your migration files
-  t.foreign_key :posts
-
-Which will generate the following SQL:
-  FOREIGN KEY ("post_id") REFERENCES "posts"(id)
-
-To enforce the constraint use the genfkey tool included with SQLite:
-  rake db:migrate
-  sqlite3 db/development.sqlite3
-  .genfkey --exec
-
-For more info see
-http://www.sqlite.org/cvstrac/fileview?f=sqlite/tool/genfkey.README
-
-
-Installation
-------------
-
-Install as a plugin:
-
-  ruby script/plugin install git://github.com/dwilkie/foreigner.git
-
-Install as a gem by adding the following to environment.rb:
-
-  config.gem "dwilkie-foreigner", :lib => "foreigner", :source => "http://gemcutter.org"
-
-
-  sudo rake gems:install
-
-API
----
-  t.foreign_key(options)
-  foreign_keys(table_name)
-
-  Since SQLite does not have complete ALTER TABLE support
-  you cannot use the following for an SQLite database
-
-  add_foreign_key(from_table, to_table, options)
-  remove_foreign_key(from_table, options)
-
-
-Example
--------
-
-The most common use of foreign keys is to reference a table that a model belongs to.
-For example, given the following model:
-
-  class Comment < ActiveRecord::Base
-    belongs_to :post
-  end
-
-  class Post < ActiveRecord::Base
-    has_many :comments, :dependent => :delete_all
-  end
-
-You should add a foreign key in your migration:
-
-  t.foreign_key :posts
-
-If the column is named article_id instead of post_id, use the :column option:
-
-  t.foreign_key(:posts, :column => 'article_id')
-
-schema.rb
----------
-
-Similar to indexes, the foreign keys in your database are automatically dumped to schema.rb.
-This allows you to use foreign keys without fighting Rails!
-
-Copyright (c) 2009 David Wilkie, released under the MIT license
-

data/lib/foreigner/connection_adapters/sqlite_adapter.rb

@@ -1,38 +0,0 @@
-require 'foreigner/connection_adapters/sql_2003'
-
-module Foreigner
-  module ConnectionAdapters
-    module SQLiteAdapter
-      include Foreigner::ConnectionAdapters::Sql2003
-
-      def foreign_keys(table_name)
-        foreign_keys = []
-        create_table_info = select_value %{
-SELECT sql
-FROM sqlite_master
-WHERE sql LIKE '%FOREIGN KEY%'
-AND name = '#{table_name}'
-}
-      if !create_table_info.nil?
-        fk_columns = create_table_info.scan(/FOREIGN KEY\s*\(\"([^\"]+)\"\)/)
-        fk_tables = create_table_info.scan(/REFERENCES\s*\"([^\"]+)\"/)
-        if fk_columns.size == fk_tables.size
-          fk_columns.each_with_index do |fk_column, index|
-            foreign_keys << ForeignKeyDefinition.new(table_name, fk_tables[index][0], :column => fk_column[0])
-          end
-        end
-      end
-      foreign_keys
-      end
-    end
-  end
-end
-
-module ActiveRecord
-  module ConnectionAdapters
-    SQLiteAdapter.class_eval do
-      include Foreigner::ConnectionAdapters::SQLiteAdapter
-    end
-  end
-end
-