dbcompile 0.0.1

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tyler Lesmann
+
+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/README.markdown

@@ -0,0 +1,46 @@
+DbCompile
+---------
+
+Adds *rake db:compile* to your rails project tasks.  This task can be used to
+compile views, functions, triggers, and more!
+
+### Install
+
+script/plugin install git://github.com/redhatcat/dbcompile.git
+
+### Setup
+
+Configuration is contained in one file, **RAILS_ROOT/db/compile.yml**.
+In here, you describe the statement and dependencies.  You can fine an example
+with comments [here](http://github.com/redhatcat/dbcompile/blob/master/example/compile.yml).
+
+The SQL scripts themselves are places in several directories under **RAILS_ROOT/db**.
+
+* RAILS_ROOT/db/functions contains function scripts.
+* RAILS_ROOT/db/triggers contains trigger scripts.
+* RAILS_ROOT/db/views contains view scripts.
+
+All of these scripts, with the exception of views, should be self replacing,
+e.g. you will want to use statements like *CREATE OR REPLACE FUNCTION*.
+
+**Note on views**:  View scripts should be written as everything after the
+*AS* keyword, i.e. write views as SELECTs.  DbCompile will magically wrap
+the SELECT with CREATE OR REPLACE VIEW #{script_name} AS #{sql_source}.
+
+### Adding new SQL constructs
+
+If you want something beyond a function, trigger, or view, DbCompile is easy to
+extend.  Simply create a new class that extends *DbCompile::Construct* and
+require it in *lib/dbcompile/transaction.rb*.  See the source of
+[lib/dbcompile/view.rb](http://github.com/redhatcat/dbcompile/blob/master/lib/dbcompile/view.rb)
+and
+[lib/dbcompile/construct.rb](http://github.com/redhatcat/dbcompile/blob/master/lib/dbcompile/construct.rb)
+for reference.
+
+### How the dependencies work
+
+The dependencies of a contruct determine the order of (re)creation.  The
+consequences of not stating dependencies in the case of a view:
+
+* A view may fail being created entirely.
+* A view may be created, then deleted by DROP CASCADE of another view it depends on.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "dbcompile"
+  gem.homepage = "http://github.com/redhatcat/dbcompile"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails plugin for loading various SQL constructs, like views, functions, and triggers}
+  gem.description = %Q{Rails plugin for loading various SQL constructs, like views, functions, and triggers}
+  gem.email = "redhatcat@gmail.com"
+  gem.authors = ["Tyler Lesmann"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dbcompile #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/example/compile.yml

@@ -0,0 +1,16 @@
+views: # Statement type
+    asset_dashboard: # Script name.
+    # This will be translated into a filename.  Here it is db/views/asset_dashboard.sql.
+    # On views, the script name will also be the name of the view.
+    # This view has no dependencies.
+functions:
+    asset_immutable:
+    check_asset_integrity:
+        functions: # This function depends on the existence of the following functions:
+            - asset_immutable
+        views: # This function depends on the existence of the following views:
+            - asset_dashboard
+triggers:
+    check_asset_integrity:
+        functions:
+            - check_asset_integrity

data/lib/dbcompile/construct.rb

@@ -0,0 +1,59 @@
+module DbCompile
+  # Anything that can be expressed in SQL
+  class Construct
+    attr_accessor :name
+    attr_accessor :path
+    attr_accessor :root_path
+    attr_accessor :dependencies
+
+    def initialize(name, root_path)
+      @name = name
+      @root_path = root_path
+      build_path
+    end
+
+    # Override this to set path the SQL source
+    def build_path
+    end
+
+    # Execute the source to create contruct in database
+    def execute
+      ActiveRecord::Base.connection.execute(source)
+    end
+
+    # Return the SQL source.  Do any magic wrapping here.
+    def source
+      f = File.open(File.join(root_path, path))
+      data = f.read
+      f.close
+      data
+    end
+
+    # Override to verify the existence of the construct
+    # Return true for verified successs
+    # Return false for verified failure
+    # Return nil otherwise
+    def verify
+    end
+
+    #
+    # checks to see if one object exists based on the sql string 
+    # generated by an individual construct
+    #
+    def does_one_exist?(sql)
+      result = ActiveRecord::Base.connection.execute(sql)
+      case ActiveRecord::Base.connection.class.to_s
+      when "ActiveRecord::ConnectionAdapters::PostgreSQLAdapter"
+        return result.num_tuples == 1
+      when "ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter"
+        row_count= 0
+        while f = result.fetch
+          row_count += 1
+        end
+        return row_count == 1
+      else
+        return result.length == 1
+      end
+    end
+  end
+end

data/lib/dbcompile/function.rb

@@ -0,0 +1,16 @@
+module DbCompile
+  class Function < Construct
+    def build_path
+      @path = File.join('functions', "#{name}.sql")
+    end
+
+    def verify
+      sql = nil
+      case ActiveRecord::Base.connection.class.to_s
+        when 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
+          sql = "SELECT proname FROM pg_proc WHERE proname = '#{name.downcase}';"
+      end
+      return does_one_exist?(sql) if sql
+    end
+  end
+end

data/lib/dbcompile/transaction.rb

@@ -0,0 +1,83 @@
+require 'dbcompile/construct.rb'
+require 'dbcompile/function.rb'
+require 'dbcompile/trigger.rb'
+require 'dbcompile/view.rb'
+
+module DbCompile
+  class CircularDependenciesException < Exception; end
+
+  # Encapsulates entire transaction and dependency checking
+  class Transaction
+    def initialize(path)
+      @path = path
+      @run_queue = []
+      @deps_queue = []
+      @manifest = YAML::load_file(File.join(path, 'compile.yml'))
+
+      @manifest.each{ |construct_name, data|
+        if data
+          data.each{ |object_name, dependencies|
+            install_dependencies(construct_name, object_name)
+          }
+        end
+      }
+    end
+
+    def install_dependencies(construct_name, object_name)
+      if @deps_queue.include? [construct_name, object_name]
+        raise CircularDependenciesException.new(
+          "Dependency of #{construct_name} #{object_name} referenced it as a dependency!")
+      end
+      @deps_queue << [construct_name, object_name]
+      if not @run_queue.include? [construct_name, object_name]
+        dependencies = @manifest[construct_name][object_name]
+        if dependencies
+          dependencies.each{ |dep_construct_name, name_list|
+            name_list.each{ |dep_object_name|
+              install_dependencies(dep_construct_name, dep_object_name)
+            }
+          }
+        end
+        @run_queue << [construct_name, object_name]
+      end
+      @deps_queue.pop
+    end
+
+    def build_contruct(construct_name, object_name)
+      klass = "DbCompile::#{construct_name.singularize.camelize}".constantize
+      klass.new(object_name, @path)
+    end
+
+    def execute
+      @run_queue.each{ |construct_name, object_name|
+        construct = build_contruct(construct_name, object_name)
+        msg = "Compiling #{construct.path}"
+        puts msg
+        ActiveRecord::Base.logger.info msg
+        construct.execute
+      }
+    end
+
+    def verify
+      msg = "Verifying compilation"
+      puts msg
+      ActiveRecord::Base.logger.info msg
+      no_errors = true
+      @run_queue.each{ |construct_name, object_name|
+        construct = build_contruct(construct_name, object_name)
+        case construct.verify
+          when nil
+            msg = "#{construct_name.capitalize} #{object_name} could not be verified."
+          when true
+            msg = "#{construct_name.capitalize} #{object_name} successfully created."
+          when false
+            msg = "#{construct_name.capitalize} #{object_name} creation failed."
+            no_errors = false
+        end
+        puts msg
+        ActiveRecord::Base.logger.info msg
+      }
+      return no_errors
+    end
+  end
+end

data/lib/dbcompile/trigger.rb

@@ -0,0 +1,16 @@
+module DbCompile
+  class Trigger < Construct
+    def build_path
+      @path = File.join('triggers', "#{name}.sql")
+    end
+
+    def verify
+      sql = nil
+      case ActiveRecord::Base.connection.class.to_s
+        when 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
+          sql = "SELECT * FROM pg_trigger WHERE tgname = '#{name}';"
+      end
+      does_one_exist?(sql)
+    end
+  end
+end

data/lib/dbcompile/view.rb

@@ -0,0 +1,31 @@
+module DbCompile
+  class View < Construct
+    def build_path
+      @path = File.join('views', "#{name}.sql")
+    end
+
+    def source
+      case ActiveRecord::Base.connection.class.to_s
+      when "ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter"
+        "CREATE OR REPLACE VIEW #{name} AS #{super}"        
+      else
+        "DROP VIEW IF EXISTS #{name} CASCADE; CREATE VIEW #{name} AS #{super}"
+      end
+    end
+
+    def verify
+      sql = nil
+      case ActiveRecord::Base.connection.class.to_s
+      when 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
+        sql = "SELECT viewname FROM pg_catalog.pg_views WHERE viewname = '#{name}'"
+      when "ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter"
+        sql = "SELECT lower(view_name) FROM user_views WHERE lower(view_name) = lower('#{name}')"
+      else
+        raise "data dictionary query for adapter #{ActiveRecord::Base.connection.class.to_s} not defined"
+      end
+      require 'ckuru-tools'
+      ckebug 0, sql
+      return does_one_exist?(sql)
+    end
+  end
+end

data/lib/dbcompile.rb

@@ -0,0 +1,14 @@
+require 'dbcompile/transaction.rb'
+
+module DbCompile
+  def self.build_transaction(path=nil)
+    if not path
+      path = File.join(RAILS_ROOT, 'db')
+    end
+    transaction = Transaction.new(path)
+    transaction.execute
+    if not transaction.verify
+      exit 1
+    end
+  end
+end

data/lib/tasks/dbcompile.rake

@@ -0,0 +1,7 @@
+namespace :db do
+  desc "compile based on the contents of #{RAILS_ROOT}/db/compile.yml"
+  task :compile => 'environment' do
+    require 'dbcompile'
+    DbCompile.build_transaction
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: dbcompile
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tyler Lesmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &12005620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *12005620
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &12003800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *12003800
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &12002880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *12002880
+description: Rails plugin for loading various SQL constructs, like views, functions,
+  and triggers
+email: redhatcat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- example/compile.yml
+- lib/dbcompile.rb
+- lib/dbcompile/construct.rb
+- lib/dbcompile/function.rb
+- lib/dbcompile/transaction.rb
+- lib/dbcompile/trigger.rb
+- lib/dbcompile/view.rb
+- lib/tasks/dbcompile.rake
+homepage: http://github.com/redhatcat/dbcompile
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1816481755782367811
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Rails plugin for loading various SQL constructs, like views, functions, and
+  triggers
+test_files: []