robdimarco_rails_sql_views 0.9.0

data/lib/rails_sql_views/connection_adapters/sqlite_adapter.rb

@@ -0,0 +1,66 @@
+module RailsSqlViews
+  module ConnectionAdapters
+    module SQLiteAdapter
+      def supports_views?
+        true
+      end
+
+      def supports_drop_table_cascade?
+        return false 
+      end
+      
+      def tables(name = nil) #:nodoc:
+        sql = <<-SQL
+          SELECT name
+          FROM sqlite_master
+          WHERE (type = 'table' OR type = 'view') AND NOT name = 'sqlite_sequence'
+        SQL
+
+        execute(sql, name).map do |row|
+          row[0]
+        end
+      end
+
+      def base_tables(name = nil)
+        sql = <<-SQL
+          SELECT name
+          FROM sqlite_master
+          WHERE (type = 'table') AND NOT name = 'sqlite_sequence'
+        SQL
+
+        execute(sql, name).map do |row|
+          row[0]
+        end        
+      end
+      alias nonview_tables base_tables
+      
+      def views(name = nil)
+        sql = <<-SQL
+          SELECT name
+          FROM sqlite_master
+          WHERE type = 'view' AND NOT name = 'sqlite_sequence'
+        SQL
+
+        execute(sql, name).map do |row|
+          row[0]
+        end
+      end
+      
+      # Get the view select statement for the specified table.
+      def view_select_statement(view, name = nil)
+        sql = <<-SQL
+          SELECT sql
+          FROM sqlite_master
+          WHERE name = '#{view}' AND NOT name = 'sqlite_sequence'
+        SQL
+        
+        (select_value(sql, name).gsub("CREATE VIEW #{view} AS ", "")) or raise "No view called #{view} found"
+      end
+      
+      def supports_view_columns_definition?
+        false
+      end
+      
+    end
+  end
+end

data/lib/rails_sql_views/connection_adapters/sqlserver_adapter.rb

@@ -0,0 +1,43 @@
+module RailsSqlViews
+  module ConnectionAdapters
+    module SQLServerAdapter
+      # Returns true as this adapter supports views.
+      def supports_views?
+        true
+      end
+      
+      # Get all of the non-view tables from the currently connected schema
+      def base_tables(name = nil)
+        # this is untested
+        select_values("SELECT table_name FROM information_schema.tables", name)
+      end
+      alias nonview_tables base_tables
+      
+      # Returns all the view names from the currently connected schema.
+      def views(name = nil)
+        select_values("SELECT table_name FROM information_schema.views", name)
+      end
+      
+      # Get the view select statement for the specified view.
+      def view_select_statement(view, name=nil)
+        q =<<-ENDSQL
+          SELECT view_definition FROM information_schema.views
+          WHERE table_name = '#{view}'
+        ENDSQL
+        
+        view_def = select_value(q, name)
+        
+        if view_def
+          return convert_statement(view_def)
+        else
+          raise "No view called #{view} found"
+        end
+      end
+      
+      private
+      def convert_statement(s)
+        s.sub(/^CREATE.* AS (select .*)/i, '\1').gsub(/\n/, '')
+      end
+    end
+  end
+end

data/lib/rails_sql_views/loader.rb

@@ -0,0 +1,20 @@
+
+module RailsSqlViews
+  module Loader
+    SUPPORTED_ADAPTERS = %w( Mysql Mysql2 PostgreSQL SQLServer SQLite OracleEnhanced )
+
+    def self.load_extensions
+      SUPPORTED_ADAPTERS.each do |db|
+        if ActiveRecord::ConnectionAdapters.const_defined?("#{db}Adapter")
+          require "rails_sql_views/connection_adapters/#{db.downcase}_adapter"
+          ActiveRecord::ConnectionAdapters.const_get("#{db}Adapter").class_eval do
+            include RailsSqlViews::ConnectionAdapters::AbstractAdapter
+            include RailsSqlViews::ConnectionAdapters.const_get("#{db}Adapter")
+            # prevent reloading extension when the environment is reloaded
+            $rails_sql_views_included = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_sql_views/schema_dumper.rb

@@ -0,0 +1,113 @@
+module RailsSqlViews
+  module SchemaDumper
+    def self.included(base)
+      base.alias_method_chain :trailer, :views
+      base.alias_method_chain :dump, :views
+      base.alias_method_chain :tables, :views_excluded
+      
+      # A list of views which should not be dumped to the schema. 
+      # Acceptable values are strings as well as regexp.
+      # This setting is only used if ActiveRecord::Base.schema_format == :ruby
+      base.cattr_accessor :ignore_views
+      base.ignore_views = []
+      # Optional: specify the order that in which views are created.
+      # This allows views to depend on and include fields from other views.
+      # It is not necessary to specify all the view names, just the ones that 
+      # need to be created first
+      base.cattr_accessor :view_creation_order
+      base.view_creation_order = []
+    end
+    
+    def trailer_with_views(stream)
+      # do nothing...we'll call this later
+    end
+    
+    # Add views to the end of the dump stream
+    def dump_with_views(stream)
+      dump_without_views(stream)
+      begin
+        @connection.class.send(:public, :supports_views?) # this is a kluge, but I don't know why it's changing back to private before it gets here
+        if @connection.supports_views?
+          views(stream)
+        end
+      rescue => e
+        if ActiveRecord::Base.logger
+          ActiveRecord::Base.logger.error "Unable to dump views: #{e}"
+        else
+          raise e
+        end
+      end
+      trailer_without_views(stream)
+      stream
+    end
+    
+    # Add views to the stream
+    def views(stream)
+      if view_creation_order.empty?
+        sorted_views = @connection.views.sort
+      else
+        # set union, merge by joining arrays, removing dups
+        # this will float the view name sin view_creation_order to the top
+        # without requiring all the views to be specified
+        sorted_views = view_creation_order | @connection.views
+      end
+      sorted_views.each do |v|
+        next if [ActiveRecord::Migrator.schema_migrations_table_name, ignore_views].flatten.any? do |ignored|
+          case ignored
+          when String then v == ignored
+          when Symbol then v == ignored.to_s
+          when Regexp then v =~ ignored
+          else
+            raise StandardError, 'ActiveRecord::SchemaDumper.ignore_views accepts an array of String and / or Regexp values.'
+          end
+        end 
+        view(v, stream)
+      end
+    end
+    
+    # Add the specified view to the stream
+    def view(view, stream)
+      columns = @connection.columns(view).collect { |c| c.name }
+      begin
+        v = StringIO.new
+
+        v.print "  create_view #{view.inspect}"
+        v.print ", #{@connection.view_select_statement(view).dump}"
+        v.print ", :force => true"
+        v.puts " do |v|"
+
+        columns.each do |column|
+          v.print "    v.column :#{column}"
+          v.puts
+        end
+
+        v.puts "  end"
+        v.puts
+        
+        v.rewind
+        stream.print v.read
+      rescue => e
+        stream.puts "# Could not dump view #{view.inspect} because of following #{e.class}"
+        stream.puts "#   #{e.message}"
+        stream.puts
+      end
+      
+      stream
+    end
+
+    def tables_with_views_excluded(stream)
+      @connection.base_tables.sort.each do |tbl|
+        next if [ActiveRecord::Migrator.schema_migrations_table_name, ignore_tables].flatten.any? do |ignored|
+          case ignored
+          when String then tbl == ignored
+          when Regexp then tbl =~ ignored
+          else
+            raise StandardError, 'ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values.'
+          end
+        end
+        table(tbl, stream)
+      end
+    end
+
+  end
+end

data/lib/rails_sql_views/version.rb

@@ -0,0 +1,9 @@
+module RailsSqlViews
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 9
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'rails_sql_views'

data/test/README

@@ -0,0 +1,63 @@
+== Executing Tests
+
+First create the test database: rails_sql_views_unittest 
+
+Next, copy test/connection.example.yml to test/connection.yml and change the
+settings to match your database configuration that you are testing.
+
+To run the tests either use:
+
+  rake
+ 
+Which will run the MySQL tests, or use something like the following:
+
+  rake DB=native_postgresql
+ 
+Substituting the directory name inside the connection directory.
+
+== Status
+
+Currently the following adapters have been tested:
+
+* MySQL
+* PostgreSQL Pure Ruby
+ 
+The Oracle and SQL Server adapters have not been tested by me.
+
+== Implementing Adapters
+
+If you would like to implement an adapter, it should go in 
+lib/rails_sql_views/connection_adapters. Follow the conventions
+of the other adapters currently implemented. Every adapter must implement the 
+following methods:
+
+  supports_views?
+  base_tables(name = nil)
+  views(name = nil)
+  view_select_statement(view, name=nil)
+  
+The suports_views? method must return true. The views method must return an 
+array of all view names. The view_select_statement method must return the 
+select statement used to construct the specified view.
+
+In addition you must include the following for testing purposes:
+
+The script which establishes the database connection in ActiveRecord:
+
+  test/connection/driver_name/connection.rb
+  
+The schema to setup the test database in your drivers native form:
+
+  test/connection/driver_name/schema.sql
+  
+The expected schema output from a schema dump. Note that it must be formatted 
+*exactly* as the output would be:
+  
+  test/schema.driver_name.out.rb
+  
+Once this is done you should send the diff of the changes to 
+anthonyeden@gmail.com. Any questions can also be emailed to this address.
+
+== Known Issues
+
+* If you are running on Rails 1.1.6 then the schema dumper test will fail because the formatting of the schema output has changed between 1.1.6 and 1.2.

data/test/adapter_test.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class AdapterTest < Test::Unit::TestCase
+  def test_current_database
+    if ActiveRecord::Base.connection.respond_to?(:current_database)
+      assert_equal 'rails_sql_views_unittest', ActiveRecord::Base.connection.current_database
+    end
+  end
+  def test_tables
+    create_view
+    found = ActiveRecord::Base.connection.tables.sort
+    found.delete(ActiveRecord::Migrator.schema_migrations_table_name)
+    assert_equal ["items", "items_people", "people", "people2", "places", "v_people"], found
+  end
+  def test_base_tables
+    create_view
+    found = ActiveRecord::Base.connection.base_tables.sort
+    found.delete(ActiveRecord::Migrator.schema_migrations_table_name)
+    assert_equal ["items", "items_people", "people", "people2", "places"], found
+  end
+  def test_views
+    create_view
+    assert_equal ['v_people'], ActiveRecord::Base.connection.views
+  end
+  def test_columns
+    create_view
+    assert_equal ["f_name", "l_name", "social_security"], ActiveRecord::Base.connection.columns('v_people').collect { |c| c.name }
+  end
+  def test_supports_views
+    assert ActiveRecord::Base.connection.supports_views?
+  end
+  
+  def test_mapped_views
+    create_mapping
+    assert_equal ['v_people'], ActiveRecord::Base.connection.views
+  end
+  def test_mapped_columns
+    create_mapping
+    assert_equal ["f_name", "l_name", "address_id"], ActiveRecord::Base.connection.columns('v_people').collect { |c| c.name }
+  end
+  
+  def test_view_select_statement
+    case ActiveRecord::Base.connection.adapter_name
+    when "MySQL"
+      assert_equal "select `people`.`first_name` AS `f_name`,`people`.`last_name` AS `l_name`,`people`.`ssn` AS `social_security` from `people`", ActiveRecord::Base.connection.view_select_statement('v_people')
+    when "PostgreSQL"
+      assert_equal "SELECT people.first_name AS f_name, people.last_name AS l_name, people.ssn AS social_security FROM people;", ActiveRecord::Base.connection.view_select_statement('v_people')
+    end
+  end
+  
+  def test_old_name_not_found_error_during_mapping
+    assert_raise ActiveRecord::ActiveRecordError do
+      ActiveRecord::Base.connection.create_mapping_view(:people, :v_people, :force => true) do |v|
+        v.map_column :foo, :bar
+      end
+    end
+  end
+ 
+### TODO
+#  def test_only_base_table_triggers_are_dropped_for_disabled_ref_integrity
+#    ActiveRecord::Base.connection.disable_referential_integrity do
+#    end
+#  end
+  
+  private
+  def create_view
+    ActiveRecord::Base.connection.create_view(:v_people, 'select first_name, last_name, ssn from people', :force => true) do |v|
+      v.column :f_name
+      v.column :l_name
+      v.column :social_security
+    end
+  end
+  
+  def create_mapping
+    ActiveRecord::Base.connection.create_mapping_view(:people, :v_people, :force => true) do |v|
+      v.map_column :id, nil
+      v.map_column :first_name, :f_name
+      v.map_column :last_name, :l_name
+      v.map_column :ssn, nil
+    end
+  end
+end

data/test/connection.example.yml

@@ -0,0 +1,12 @@
+postgresql:
+  username: postgres
+  password: 
+  host: localhost
+  database: rails_sql_views_unittest
+  encoding: utf8
+  schema_file: schema.sql
+mysql:
+  username: root
+  host: localhost
+  database: rails_sql_views_unittest
+  schema_file: schema.sql

data/test/connection/native_mysql/connection.rb

@@ -0,0 +1,32 @@
+print "Using native MySQL\n"
+
+adapter_name = 'mysql'
+config = YAML.load_file(File.join(File.dirname(__FILE__), '/../../connection.yml'))[adapter_name]
+
+#require 'logger'
+#ActiveRecord::Base.logger = Logger.new("debug.log")
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Base.configurations = {
+    config['database'] => {
+    :adapter  => adapter_name,
+    :username => config['username'],
+    :password => config['password'],
+    :host     => config['host'],
+    :database => config['database'],
+    :encoding => config['encoding'],
+    :schema_file => config['schema_file'],
+  }
+  }
+
+  ActiveRecord::Base.establish_connection config['database']
+  ActiveRecord::Migration.verbose = false
+
+  puts "Resetting database"
+  conn = ActiveRecord::Base.connection
+  conn.recreate_database(conn.current_database)
+  conn.reconnect!
+  lines = open(File.join(File.dirname(__FILE__), ActiveRecord::Base.configurations[config['database']][:schema_file])).readlines
+  lines.join.split(';').each { |line| conn.execute(line) }
+  conn.reconnect!
+end