authorails 1.0.0

data/plugins/redhillonrails_core/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 RedHill Consulting, Pty. Ltd.
+
+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/plugins/redhillonrails_core/README

@@ -0,0 +1,152 @@
+= RedHill on Rails Core
+
+RedHill on Rails Core is a plugin that features to support other RedHill on Rails plugins.  Those features include:
+
+* Creating and dropping views;
+* Creating and removing foreign-keys;
+* Obtaining indexes directly from a model class; and
+* Determining when <code>Schema.define()</code> is running.
+
+=== View Support
+
+The plugin provides a mechanism for creating and dropping views as well as
+preserving views when performing a schema dump:
+
+  create_view :normal_customers, "SELECT * FROM customers WHERE status = 'normal'"
+  drop_view :normal_customers
+
+=== Foreign Key Support
+
+The plugin provides two mechanisms for adding foreign keys as well as
+preserving foreign keys when performing a schema dump. (Using SQL-92 syntax and
+as such should be compatible with most databases that support foreign-key
+constraints.)
+
+The first mechanism for creating foreign-keys allows you to add a foreign key
+when defining a table. For example:
+
+  create_table :orders do |t|
+    ...
+    t.foreign_key :customer_id, :customers, :id
+  end
+
+You also have the option of specifying what to do on delete/update using
+<code>:on_delete</code>/<code>:on_update</code>, respectively to one of: <code>:cascade</code>; <code>:restrict</code>; and <code>:set_null</code>:
+
+  create_table :orders do |t|
+    ...
+    t.foreign_key :customer_id, :customers, :id, :on_delete => :set_null, :on_update => :cascade
+  end
+
+The second method allows you to create arbitrary foreign-keys at any time:
+
+  add_foreign_key(:orders, :customer_id, :customers, :id, :on_delete => :set_null, :on_update => :cascade)
+
+In either case, if your database supports deferred foreign keys (for example PostgreSQL) you can specify this as well:
+
+  t.foreign_key :customer_id, :customers, :id, :deferrable => true
+  add_foreign_key(:orders, :customer_id, :customers, :id, :deferrable => true)
+
+By default, the foreign key will be assigned a name by the underlying database. However, if this doesn't suit
+your needs, you can override the default assignment using the <code>:name</code> option:
+
+  add_foreign_key(:orders, :customer_id, :customers, :id, :on_delete => :set_null, :on_update => :cascade, <strong>:name => :orders_customer_id_foreign_key<strong>)
+
+You can also query the foreign keys for a model yourself by calling <code>foreign_keys()</code>:
+
+  Order.foreign_keys
+
+Or for an arbitrary table by calling <code>foreign_keys(table_name)</code> on a database adapter.
+
+Either method returns an array of the following meta-data:
+
+* +name+ - The name of the foreign key constraint;
+* +table_name+ - The table for which the foreign-key was generated;
+* +column_names+ - The column names in the table;
+* +references_table_name+ - The table referenced by the foreign-key; and
+* +references_column_names+ - The columns names in the referenced table.
+
+If you need to drop a foreign-key, use:
+
+  remove_foreign_key :orders, :orders_ordered_by_id_fkey
+
+The plugin also ensures that all foreign keys are output when performing a
+schema dump. This happens automatically when running <code>rake migrate</code> or
+<code>rake db:schema:dump</code>. This has particular implications when running
+unit tests that contain fixtures. To ensure the test data is correctly reset after
+each test, you should list your fixtures in order of parent->child. For example:
+
+  fixtures :customers, :products, :orders, :order_lines
+
+Rails will then set-up and tear-down the fixtures in the correct sequence.
+
+Some databases (PostgreSQL and MySQL for example) allow you to set a comment for a
+table. You can do this for existing tables by using:
+
+  set_table_comment :orders, "All pending and processed orders"
+
+or even at the time of creation:
+
+  create_table :orders, :comment => "All pending and processed orders" do |t|
+    ...
+  end
+
+You can clear table comments using:
+
+  clear_table_comment :orders
+
+There is also a rake tasks to show all database tables and their comments:
+
+  rake db:comments
+
+The plugin fully supports and understands the following active-record
+configuration properties:
+
+* <code>config.active_record.pluralize_table_names</code>
+* <code>config.active_record.table_name_prefix</code>
+* <code>config.active_record.table_name_suffix</code>
+
+=== Model Indexes
+
+ActiveRecord::Base already provides a method on connection for obtaining the
+indexes for a given table. This plugin now makes it possible to obtain the
+indexes for a given model--<code>ActiveRecord::Base</code>--class. For example:
+
+  Invoice.indexes
+
+Would return all the indexes for the +invoices+ table.
+
+=== Schema Defining
+
+The plugin also adds a method--<code>defining?()</code>--to
+<code>ActiveRecord::Schema</code> to indicate when <code>define()</code> is running. This is necessary
+as some migration plugins must change their behaviour accordingly.
+
+=== Case-insensitive Indexes
+
+For PostgreSQL, you can add an option <code>:case_sensitive => false</code> to <code>add_index</code>
+which will generate an expression index of the form:
+
+  LOWER(column_name)
+
+This means finder queries of the form:
+
+  WHERE LOWER(column_name) = LOWER(?)
+
+are able to use the indexes rather require, in the worst case, full-table scans.
+
+Note also that this ties in well with Rails built-in support for case-insensitive searching:
+
+  validates_uniqueness_of :name, :case_sensitive => false
+
+=== See Also
+
+* Foreign Key Associations (foreign_key_associations)
+* Foreign Key Migrations (foreign_key_migrations)
+* Row Version Migrations (row_version_migrations)
+* Schema Validations (schema_validations)
+
+=== License
+
+This plugin is copyright 2006 by RedHill Consulting, Pty. Ltd. and is released
+under the MIT license.

data/plugins/redhillonrails_core/init.rb

@@ -0,0 +1 @@
+require 'redhillonrails_core' unless defined?(RedHillConsulting::Core)

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/base.rb

@@ -0,0 +1,54 @@
+module RedHillConsulting::Core::ActiveRecord
+  module Base
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def self.extended(base)
+        class << base
+          alias_method_chain :columns, :redhillonrails_core
+          alias_method_chain :abstract_class?, :redhillonrails_core
+        end
+      end
+
+      def base_class?
+        self == base_class
+      end
+
+      def abstract_class_with_redhillonrails_core?
+        abstract_class_without_redhillonrails_core? || !(name =~ /^Abstract/).nil?
+      end
+
+      def columns_with_redhillonrails_core
+        unless @columns
+          columns_without_redhillonrails_core
+          cols = columns_hash
+          indexes.each do |index|
+            column_name = index.columns.reverse.detect { |name| name !~ /_id$/ } || index.columns.last
+            column = cols[column_name]
+            column.case_sensitive = index.case_sensitive?
+            column.unique_scope = index.columns.reject { |name| name == column_name } if index.unique
+          end
+        end
+        @columns
+      end
+
+      def pluralized_table_name(table_name)
+        ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
+      end
+
+      def indexes
+        @indexes ||= connection.indexes(table_name, "#{name} Indexes")
+      end
+
+      def foreign_keys
+        @foreign_keys ||= connection.foreign_keys(table_name, "#{name} Foreign Keys")
+      end
+
+      def reverse_foreign_keys
+        connection.reverse_foreign_keys(table_name, "#{name} Reverse Foreign Keys")
+      end
+    end
+  end
+end

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,46 @@
+module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
+  module AbstractAdapter
+    def self.included(base)
+      base.module_eval do
+        alias_method_chain :drop_table, :redhillonrails_core
+      end
+    end
+    
+    def create_view(view_name, definition)
+      execute "CREATE VIEW #{view_name} AS #{definition}"
+    end
+    
+    def drop_view(view_name)
+      execute "DROP VIEW #{view_name}"
+    end
+    
+    def views(name = nil)
+      []
+    end
+    
+    def view_definition(view_name, name = nil)
+    end
+
+    def foreign_keys(table_name, name = nil)
+      []
+    end
+
+    def reverse_foreign_keys(table_name, name = nil)
+      []
+    end
+
+    def add_foreign_key(table_name, column_names, references_table_name, references_column_names, options = {})
+      foreign_key = ForeignKeyDefinition.new(options[:name], table_name, column_names, ActiveRecord::Migrator.proper_table_name(references_table_name), references_column_names, options[:on_update], options[:on_delete], options[:deferrable])
+      execute "ALTER TABLE #{table_name} ADD #{foreign_key}"
+    end
+
+    def remove_foreign_key(table_name, foreign_key_name)
+      execute "ALTER TABLE #{table_name} DROP CONSTRAINT #{foreign_key_name}"
+    end
+
+    def drop_table_with_redhillonrails_core(name, options = {})
+      reverse_foreign_keys(name).each { |foreign_key| remove_foreign_key(foreign_key.table_name, foreign_key.name) }
+      drop_table_without_redhillonrails_core(name, options)
+    end
+  end
+end

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/connection_adapters/column.rb

@@ -0,0 +1,21 @@
+module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
+  module Column
+    attr_accessor :unique_scope
+    attr_accessor :case_sensitive
+    alias case_sensitive? case_sensitive
+
+    def unique?
+      !unique_scope.nil?
+    end
+
+    def required_on
+      if null
+        nil
+      elsif default.nil?
+        :save
+      else
+        :update
+      end
+    end
+  end
+end

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/connection_adapters/foreign_key_definition.rb

@@ -0,0 +1,26 @@
+module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
+  class ForeignKeyDefinition < Struct.new(:name, :table_name, :column_names, :references_table_name, :references_column_names, :on_update, :on_delete, :deferrable)
+    ACTIONS = { :cascade => "CASCADE", :restrict => "RESTRICT", :set_null => "SET NULL", :set_default => "SET DEFAULT", :no_action => "NO ACTION" }.freeze
+
+    def to_dump
+      dump = "add_foreign_key"
+      dump << " #{table_name.inspect}, [#{Array(column_names).collect{ |name| name.inspect }.join(', ')}]"
+      dump << ", #{references_table_name.inspect}, [#{Array(references_column_names).collect{ |name| name.inspect }.join(', ')}]"
+      dump << ", :on_update => :#{on_update}" if on_update
+      dump << ", :on_delete => :#{on_delete}" if on_delete
+      dump << ", :deferrable => #{deferrable}" if deferrable
+      dump << ", :name => #{name.inspect}" if name
+      dump
+    end
+
+    def to_sql
+      sql = name ? "CONSTRAINT #{name} " : ""
+      sql << "FOREIGN KEY (#{Array(column_names).join(", ")}) REFERENCES #{references_table_name} (#{Array(references_column_names).join(", ")})"
+      sql << " ON UPDATE #{ACTIONS[on_update]}" if on_update
+      sql << " ON DELETE #{ACTIONS[on_delete]}" if on_delete
+      sql << " DEFERRABLE" if deferrable
+      sql
+    end
+    alias :to_s :to_sql
+  end
+end

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/connection_adapters/index_definition.rb

@@ -0,0 +1,11 @@
+module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
+  module IndexDefinition
+    def case_sensitive?
+      @case_sensitive.nil? ? true : @case_sensitive
+    end
+
+    def case_sensitive=(case_sensitive)
+      @case_sensitive = case_sensitive
+    end
+  end
+end

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,94 @@
+module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
+  module MysqlAdapter
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :remove_column, :redhillonrails_core
+      end
+    end
+
+    def set_table_comment(table_name, comment)
+      execute "ALTER TABLE #{table_name} COMMENT='#{quote_string(comment)}'"
+    end
+    
+    def clear_table_comment(table_name)
+      execute "ALTER TABLE #{table_name} COMMENT=''"
+    end
+
+    def remove_foreign_key(table_name, foreign_key_name)
+      execute "ALTER TABLE #{table_name} DROP FOREIGN KEY #{foreign_key_name}"
+    end
+
+    def remove_column_with_redhillonrails_core(table_name, column_name)
+      foreign_keys(table_name).select { |foreign_key| foreign_key.column_names.include?(column_name.to_s) }.each do |foreign_key|
+        remove_foreign_key(table_name, foreign_key.name)
+      end
+      remove_column_without_redhillonrails_core(table_name, column_name)
+    end
+
+    def foreign_keys(table_name, name = nil)
+      results = execute("SHOW CREATE TABLE `#{table_name}`", name)
+
+      foreign_keys = []
+
+      results.each do |row|
+        row[1].each do |line|
+          if line =~ /^  CONSTRAINT [`"](.+?)[`"] FOREIGN KEY \([`"](.+?)[`"]\) REFERENCES [`"](.+?)[`"] \((.+?)\)( ON DELETE (.+?))?( ON UPDATE (.+?))?,?$/
+            name = $1
+            column_names = $2
+            references_table_name = $3
+            references_column_names = $4
+            on_update = $8
+            on_delete = $6
+            on_update = on_update.downcase.gsub(' ', '_').to_sym if on_update
+            on_delete = on_delete.downcase.gsub(' ', '_').to_sym if on_delete
+
+            foreign_keys << ForeignKeyDefinition.new(name,
+                                           table_name, column_names.gsub('`', '').split(', '),
+                                           references_table_name, references_column_names.gsub('`', '').split(', '),
+                                           on_update, on_delete)
+         end
+       end
+      end
+
+      foreign_keys
+    end
+
+    def reverse_foreign_keys(table_name, name = nil)
+      @@schema ||= nil
+      @@schema_version ||= 0
+      temp = execute("select version from schema_info limit 1", name);
+      current_version = 0
+      temp.each { | row | current_version = row[0] }
+      if @@schema.nil? || @@schema_version != current_version
+        @@schema_version = current_version
+        ans = execute(<<-SQL, name)
+        SELECT constraint_name, table_name, column_name, referenced_table_name, referenced_column_name
+          FROM information_schema.key_column_usage
+         WHERE table_schema = SCHEMA()
+           AND referenced_table_schema = table_schema
+         ORDER BY constraint_name, ordinal_position;
+        SQL
+        @@schema = []
+        ans.each do | row |
+          @@schema << [row[0], row[1], row[2], row[3], row[4]]
+        end
+      end
+      results = @@schema
+      current_foreign_key = nil
+      foreign_keys = []
+
+      results.each do |row|
+        next if row[3] != table_name
+        if current_foreign_key != row[0]
+          foreign_keys << ForeignKeyDefinition.new(row[0], row[1], [], row[3], [])
+          current_foreign_key = row[0]
+        end
+
+        foreign_keys.last.column_names << row[2]
+        foreign_keys.last.references_column_names << row[4]
+      end
+
+      foreign_keys
+    end
+  end
+end

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/connection_adapters/mysql_column.rb

@@ -0,0 +1,8 @@
+module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
+  module MysqlColumn
+    def initialize(name, default, sql_type = nil, null = true)
+      default = nil if !null && default.blank?
+      super
+    end
+  end
+end

data/plugins/redhillonrails_core/lib/red_hill_consulting/core/active_record/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,131 @@
+module RedHillConsulting::Core::ActiveRecord::ConnectionAdapters
+  module PostgresqlAdapter
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :indexes, :redhillonrails_core
+      end
+    end
+
+    def set_table_comment(table_name, comment)
+      execute "COMMENT ON TABLE #{table_name} IS '#{quote_string(comment)}'"
+    end
+
+    def clear_table_comment(table_name)
+      execute "COMMENT ON TABLE #{table_name} IS NULL"
+    end
+
+    def add_index(table_name, column_name, options = {})
+      column_names = Array(column_name)
+      index_name   = index_name(table_name, :column => column_names)
+
+      if Hash === options # legacy support, since this param was a string
+        index_type = options[:unique] ? "UNIQUE" : ""
+        index_name = options[:name] || index_name
+      else
+        index_type = options
+      end
+
+      quoted_column_names = column_names.map { |e| options[:case_sensitive] == false && e.to_s !~ /_id$/ ? "LOWER(#{quote_column_name(e)})" : quote_column_name(e) }
+
+      execute "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{table_name} (#{quoted_column_names.join(", ")})"
+    end
+
+    def indexes_with_redhillonrails_core(table_name, name = nil)
+      indexes = indexes_without_redhillonrails_core(table_name, name)
+      result = query(<<-SQL, name)
+        SELECT c2.relname, i.indisunique, pg_catalog.pg_get_indexdef(i.indexrelid, 0, true)
+          FROM pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_index i
+         WHERE c.relname = '#{table_name}'
+           AND c.oid = i.indrelid AND i.indexrelid = c2.oid
+           AND i.indisprimary = 'f'
+           AND i.indexprs IS NOT NULL
+         ORDER BY 1
+      SQL
+
+      result.each do |row|
+        if row[2]=~ /\((.*LOWER\([^:]+(::text)?\).*)\)$/i
+          indexes.delete_if { |index| index.name == row[0] }
+          column_names = $1.split(", ").map do |name|
+            name = $1 if name =~ /^LOWER\(([^:]+)(::text)?\)$/i
+            name = $1 if name =~ /^"(.*)"$/
+            name
+          end
+          index = ActiveRecord::ConnectionAdapters::IndexDefinition.new(table_name, row[0], row[1] == "t", column_names)
+          index.case_sensitive = false
+          indexes << index
+        end
+      end
+
+      indexes
+    end
+
+    def foreign_keys(table_name, name = nil)
+      load_foreign_keys(<<-SQL, name)
+        SELECT f.conname, pg_get_constraintdef(f.oid), t.relname
+          FROM pg_class t, pg_constraint f
+         WHERE f.conrelid = t.oid
+           AND f.contype = 'f'
+           AND t.relname = '#{table_name}'
+      SQL
+    end
+
+    def reverse_foreign_keys(table_name, name = nil)
+      load_foreign_keys(<<-SQL, name)
+        SELECT f.conname, pg_get_constraintdef(f.oid), t2.relname
+          FROM pg_class t, pg_class t2, pg_constraint f
+         WHERE f.confrelid = t.oid
+           AND f.conrelid = t2.oid
+           AND f.contype = 'f'
+           AND t.relname = '#{table_name}'
+      SQL
+    end
+
+    def views(name = nil)
+      schemas = schema_search_path.split(/,/).map { |p| quote(p) }.join(',')
+      query(<<-SQL, name).map { |row| row[0] }
+        SELECT viewname
+          FROM pg_views
+         WHERE schemaname IN (#{schemas})
+      SQL
+    end
+    
+    def view_definition(view_name, name = nil)
+      result = query(<<-SQL, name)
+        SELECT pg_get_viewdef(oid)
+          FROM pg_class
+         WHERE relkind = 'v'
+           AND relname = '#{view_name}'
+      SQL
+      row = result.first
+      row.first unless row.nil?
+    end
+
+    private
+
+    def load_foreign_keys(sql, name = nil)
+      foreign_keys = []
+
+      query(sql, name).each do |row|
+          if row[1] =~ /^FOREIGN KEY \((.+?)\) REFERENCES (.+?)\((.+?)\)( ON UPDATE (.+?))?( ON DELETE (.+?))?( (DEFERRABLE|NOT DEFERRABLE))?$/
+              name = row[0]
+              from_table_name = row[2]
+              column_names = $1
+              references_table_name = $2
+              references_column_names = $3
+              on_update = $5
+              on_delete = $7
+              deferrable = $9 == "DEFERRABLE"
+              on_update = on_update.downcase.gsub(' ', '_').to_sym if on_update
+              on_delete = on_delete.downcase.gsub(' ', '_').to_sym if on_delete
+
+              foreign_keys << ForeignKeyDefinition.new(name,
+                                             from_table_name, column_names.split(', '),
+                                             references_table_name.sub(/^"(.*)"$/, '\1'), references_column_names.split(', '),
+                                             on_update, on_delete, deferrable)
+          end
+      end
+
+      foreign_keys
+    end
+  end
+end