dbview_cti 0.0.1

data/lib/db_view_cti/sql_generation/migration/base.rb

@@ -0,0 +1,92 @@
+module DBViewCTI
+  module SQLGeneration
+    module Migration
+      class Base
+        
+        def initialize(class_name, options = {})
+          @options = options
+          @derived_class = class_name.constantize
+          @base_class    = @derived_class.superclass
+          @base_class_table    = @base_class.table_name
+          @derived_class_table = DBViewCTI::Names.table_name(@derived_class)
+          # we assume the foreign key is in the derived class
+          @base_class_key = 'id'
+          @derived_class_key = DBViewCTI::Names.foreign_key(@base_class)
+          # columns in base class
+          @base_class_columns = @base_class.column_names
+          if @base_class.cti_derived_class?
+            # base class is itself derived, so we remove the foreign key it holds to the higher
+            # level class
+            foreign_key = DBViewCTI::Names.foreign_key(@base_class.superclass)
+            @base_class_columns = @base_class_columns - [ foreign_key ]
+          end
+          # columns in derived class
+          # first, reset table name (it might have been changed to the view name by cti_derived_class)
+          temp = @derived_class.table_name
+          @derived_class.table_name = @derived_class_table
+          @derived_class.reset_column_information
+          @derived_class_columns = @derived_class.column_names
+          # put back old table name (needed since the class might be used again in a next migration)
+          @derived_class.table_name = temp
+          @derived_class.reset_column_information
+          # names
+          @view_name    = DBViewCTI::Names.view_name(@derived_class)
+          @trigger_name = DBViewCTI::Names.trigger_name(@derived_class)
+          # column arrays for triggers
+          @insert_base_class_columns = @base_class_columns - ['id']
+          @insert_derived_class_columns = @derived_class_columns - ['id', @derived_class_key]
+          @update_base_class_columns = explicit_columns(@base_class_columns) + ['updated_at']
+          @update_derived_class_columns = @derived_class_columns - [ @derived_class_key ]
+        end
+        
+        def create_view_sql
+          base_columns = add_table_name( explicit_columns(@base_class_columns), @base_class_table).
+                         join(', ')
+          derived_columns = add_table_name( @derived_class_columns - ['id', @derived_class_key], @derived_class_table).
+                            join(', ')
+          query = <<-eos
+            CREATE VIEW #{@view_name} AS
+            SELECT #{@derived_class_table}.id, #{base_columns}, #{derived_columns}
+            FROM #{@base_class_table}
+            INNER JOIN #{@derived_class_table} 
+            ON #{ add_table_name(@base_class_key, @base_class_table) } = #{ add_table_name(@derived_class_key, @derived_class_table) };
+          eos
+        end
+        
+        def drop_view_sql
+          "DROP VIEW #{@view_name};"
+        end
+        
+        def create_trigger_sql
+          # to be implemented by derived classes
+          raise NotImplementedError, "DBViewCTI: create_trigger_sql not implemented for this adapter."
+        end
+        
+        def drop_trigger_sql
+          # to be implemented by derived classes
+          raise NotImplementedError, "DBViewCTI: drop_trigger_sql not implemented for this adapter."
+        end
+        
+        private
+        
+          def explicit_columns(columns)
+            columns - ['id', 'created_at', 'updated_at']
+          end
+          
+          def add_table_name(columns, table_name)
+            return table_name + '.' + columns if columns.is_a?(String)
+            columns.map do |column|
+              table_name + '.' + column
+            end
+          end
+        
+          def update_notation(columns, source_table)
+            columns.map do |column|
+              "#{column}=#{source_table}.#{column}"
+            end.join(', ')
+          end
+        
+      end
+    end
+  end
+end

data/lib/db_view_cti/sql_generation/migration/factory.rb

@@ -0,0 +1,19 @@
+module DBViewCTI
+  module SQLGeneration
+    module Migration
+      class Factory
+        
+        def self.generator(class_name, options = {})
+          adapter_type = ActiveRecord::Base.configurations[Rails.env]['adapter']
+          case adapter_type
+          when /postgresql/
+            PostgreSQL.new(class_name, options)
+          else
+            raise NotImplementedError, "DBViewCTI: Unknown adapter type '#{adapter_type}'"
+          end        
+        end
+        
+      end
+    end
+  end
+end

data/lib/db_view_cti/sql_generation/migration/postgresql.rb

@@ -0,0 +1,107 @@
+module DBViewCTI
+  module SQLGeneration
+    module Migration
+    
+      class PostgreSQL < Base
+        
+        def create_trigger_sql
+          # trigger function
+          @trigger_func_name = DBViewCTI::Names.trigger_function_name(@derived_class)
+  
+          insert_trigger_func = <<-eos
+            CREATE OR REPLACE FUNCTION #{trigger_func_name}()
+            RETURNS TRIGGER
+            LANGUAGE plpgsql
+            AS $function$
+              DECLARE
+                base_id integer;
+                derived_id integer;
+                return_row RECORD;
+              BEGIN
+                IF TG_OP = 'INSERT' THEN
+                  -- insert into base class and return id
+                  INSERT INTO #{@base_class_table} (#{ @insert_base_class_columns.join(', ') })
+                  VALUES (#{ add_table_name(@insert_base_class_columns, 'NEW').join(', ') })
+                  RETURNING #{@base_class_key}
+                  INTO base_id;
+                  -- insert into derived class, including foreign key
+                  INSERT INTO #{@derived_class_table} (#{ (@insert_derived_class_columns + [@derived_class_key]).join(', ') })
+                  VALUES (#{ add_table_name(@insert_derived_class_columns, 'NEW').join(', ') },
+                          base_id)
+                  RETURNING id
+                  INTO derived_id;
+                  -- return correct record from view
+                  SELECT * 
+                  INTO return_row
+                  FROM #{@view_name}
+                  WHERE id = derived_id
+                  LIMIT 1;
+                  RETURN return_row;
+  
+                ELSIF TG_OP = 'UPDATE' THEN
+                  -- update base class
+                  UPDATE #{@base_class_table}
+                  SET #{ update_notation(@update_base_class_columns, 'NEW') }
+                  WHERE #{@base_class_table}.#{@base_class_key} = 
+                        (SELECT #{@derived_class_key} FROM #{@derived_class_table}
+                         WHERE #{@derived_class_table}.id = OLD.id); 
+                  -- update derived class
+                  UPDATE #{@derived_class_table}
+                  SET #{ update_notation(@update_derived_class_columns, 'NEW') }
+                  WHERE #{@derived_class_table}.id = OLD.id;
+                  -- return correct record from view
+                  SELECT * 
+                  INTO return_row
+                  FROM #{@view_name}
+                  WHERE id = OLD.id
+                  LIMIT 1;
+                  RETURN return_row;
+  
+                ELSIF TG_OP = 'DELETE' THEN
+                  -- find foreign key (not present in view!) in derived class
+                  SELECT #{@derived_class_key}
+                  INTO base_id
+                  FROM #{@derived_class_table}
+                  WHERE id = OLD.id;
+                  -- due to possible key constraints we first delete the derived class
+                  DELETE FROM #{@derived_class_table}
+                  WHERE #{@derived_class_table}.id = OLD.id;
+                  -- delete base class
+                  DELETE FROM #{@base_class_table}
+                  WHERE #{@base_class_table}.#{@base_class_key} = base_id;
+                  RETURN NULL; 
+                  
+                END IF;
+                RETURN NEW;
+              END;          
+            $function$;
+          eos
+  
+          # trigger:
+          insert_trigger = <<-eos
+            CREATE TRIGGER #{@trigger_name}
+            INSTEAD OF INSERT OR UPDATE OR DELETE ON #{@view_name}
+            FOR EACH ROW
+            EXECUTE PROCEDURE #{trigger_func_name}(); 
+          eos
+          insert_trigger_func + insert_trigger
+        end
+  
+        def drop_trigger_sql
+          query = <<-eos
+            DROP TRIGGER IF EXISTS #{@trigger_name} ON #{@view_name};
+            DROP FUNCTION IF EXISTS #{trigger_func_name}();
+          eos
+        end
+        
+        private
+        
+          def trigger_func_name
+            DBViewCTI::Names.trigger_function_name(@derived_class)
+          end
+        
+      end
+      
+    end
+  end
+end

data/lib/db_view_cti/sql_generation/model.rb

@@ -0,0 +1,60 @@
+module DBViewCTI
+  module SQLGeneration
+    module Model
+
+      # generates left-outer-join query used in specialize and type
+     def cti_outer_join_sql(id)
+        if !@cti_outer_join_query.nil?
+          return [@cti_outer_join_query + "#{id if id}", @cti_outer_join_levels]
+        end
+        start = "SELECT #{DBViewCTI::Names.table_name(self)}.id AS #{DBViewCTI::Names.foreign_key(self)}"
+        end_  = "\nFROM #{DBViewCTI::Names.table_name(self)}"
+        levels = { DBViewCTI::Names.foreign_key(self) => 0 }
+        level = 1
+        base_class = self
+        block = Proc.new do |klass, descendants|
+          start += ", #{DBViewCTI::Names.table_name(klass)}.id AS #{DBViewCTI::Names.foreign_key(klass)}"
+          end_ += "\nLEFT OUTER JOIN #{DBViewCTI::Names.table_name(klass)} " +
+                  "ON #{DBViewCTI::Names.table_name(klass)}.#{DBViewCTI::Names.foreign_key(base_class)} = " +
+                  "#{DBViewCTI::Names.table_name(base_class)}.id"
+          prev_base_class = base_class
+          base_class = klass
+          levels[DBViewCTI::Names.foreign_key(klass)] = level
+          level += 1
+          descendants.each(&block) 
+          level -= 1
+          base_class = prev_base_class
+        end
+        @cti_descendants ||= {}
+        @cti_descendants.each(&block)
+        @cti_outer_join_query = start + end_ + "\nWHERE #{DBViewCTI::Names.table_name(self)}.id = "
+        @cti_outer_join_levels = levels
+        [@cti_outer_join_query + "#{id if id}", @cti_outer_join_levels]
+      end
+      
+      # generates inner-join query used in convert_to(target_class)
+      def cti_inner_join_sql(id, target_class)
+        if @cti_inner_join_query && @cti_inner_join_query[target_class]
+          return @cti_inner_join_query[target_class] + "#{id if id}"
+        end
+        return nil if !@cti_ascendants.include?(target_class)
+        query = "SELECT #{DBViewCTI::Names.table_name(target_class)}.id AS #{DBViewCTI::Names.foreign_key(target_class)}" +
+                "\nFROM #{DBViewCTI::Names.table_name(self)}"
+        base_class = self
+        @cti_ascendants ||= []
+        @cti_ascendants.reverse.each do |ascendant|
+          query += "\nINNER JOIN #{DBViewCTI::Names.table_name(ascendant)} " +
+                   "ON #{DBViewCTI::Names.table_name(base_class)}.#{DBViewCTI::Names.foreign_key(ascendant)} = " +
+                   "#{DBViewCTI::Names.table_name(ascendant)}.id"
+          break if ascendant == target_class
+          base_class = ascendant
+        end
+        query += "\nWHERE #{DBViewCTI::Names.table_name(self)}.id = "
+        @cti_inner_join_query ||= {}
+        @cti_inner_join_query[target_class] = query
+        query + "#{id if id}"
+      end
+      
+    end
+  end
+end

data/lib/db_view_cti/version.rb

@@ -0,0 +1,3 @@
+module DBViewCTI
+  VERSION = "0.0.1"
+end

data/lib/dbview_cti.rb

@@ -0,0 +1,35 @@
+module DBViewCTI
+  extend ActiveSupport::Autoload
+  autoload :Names
+
+  module ConnectionAdapters
+    extend ActiveSupport::Autoload
+    autoload :SchemaStatements
+  end
+
+  module Migration
+    extend ActiveSupport::Autoload
+    autoload :CommandRecorder
+  end
+
+  module SQLGeneration
+    module Migration
+      extend ActiveSupport::Autoload
+      autoload :Factory
+      autoload :Base
+      autoload :PostgreSQL, 'db_view_cti/sql_generation/migration/postgresql'
+    end
+    extend ActiveSupport::Autoload
+    autoload :Model
+  end
+  
+  module Model
+    extend ActiveSupport::Autoload
+    autoload :CTI
+    autoload :Extensions
+  end
+end
+
+require 'db_view_cti/loader'
+require 'db_view_cti/railtie' if defined?(Rails)
+

data/lib/tasks/view-based-cti_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :view-based-cti do
+#   # Task goes here
+# end

data/spec/dummy-rails-3/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy-rails-3/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy-rails-3/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy-rails-3/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy-rails-3/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy-rails-3/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy-rails-3/app/models/car.rb

@@ -0,0 +1,4 @@
+class Car < MotorVehicle
+  attr_accessible :stick_shift, :convertible, :vehicle_id unless Rails::VERSION::MAJOR > 3
+  cti_derived_class
+end

data/spec/dummy-rails-3/app/models/motor_cycle.rb

@@ -0,0 +1,4 @@
+class MotorCycle < MotorVehicle
+  attr_accessible :offroad unless Rails::VERSION::MAJOR > 3
+  cti_derived_class
+end

data/spec/dummy-rails-3/app/models/motor_vehicle.rb

@@ -0,0 +1,4 @@
+class MotorVehicle < Vehicle
+  attr_accessible :fuel, :number_of_wheels unless Rails::VERSION::MAJOR > 3
+  cti_derived_class
+end

data/spec/dummy-rails-3/app/models/rocket_engine.rb

@@ -0,0 +1,4 @@
+class RocketEngine < ActiveRecord::Base
+  attr_accessible :name, :space_ship_id unless Rails::VERSION::MAJOR > 3
+  belongs_to :space_ship
+end

data/spec/dummy-rails-3/app/models/space_ship.rb

@@ -0,0 +1,4 @@
+class SpaceShip < Vehicle
+  attr_accessible :single_use, :reliability unless Rails::VERSION::MAJOR > 3
+  cti_derived_class
+end

data/spec/dummy-rails-3/app/models/space_shuttle.rb

@@ -0,0 +1,4 @@
+class SpaceShuttle < SpaceShip
+  attr_accessible :single_use unless Rails::VERSION::MAJOR > 3
+  cti_derived_class
+end

data/spec/dummy-rails-3/app/models/vehicle.rb

@@ -0,0 +1,4 @@
+class Vehicle < ActiveRecord::Base
+  attr_accessible :name, :mass unless Rails::VERSION::MAJOR > 3
+  cti_base_class
+end

data/spec/dummy-rails-3/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy-rails-3/config/application.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "dbview_cti"
+
+# for some strange reason, we have to manually require foreigner, it doesn't work through the gemspec file
+require 'foreigner'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy-rails-3/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy-rails-3/config/database.yml

@@ -0,0 +1,37 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#development:
+#  adapter: sqlite3
+#  database: db/development.sqlite3
+#  pool: 5
+#  timeout: 5000
+
+development:
+  adapter: postgresql
+  encoding: utf8
+  pool: 5
+  database: dbview_cti
+  timeout: 5000
+  username: cti
+  password: cti
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: postgresql
+  encoding: utf8
+  pool: 5
+  database: dbview_cti_test
+  timeout: 5000
+  username: cti
+  password: cti
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy-rails-3/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy-rails-3/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end