dbgeni 0.10.0

data/lib/dbgeni/connectors/oracle.rb

@@ -0,0 +1,149 @@
+module DBGeni
+
+  module Connector
+
+    class Oracle
+
+      if RUBY_PLATFORM == 'java'
+        require 'java'
+        java_import 'oracle.jdbc.OracleDriver'
+        java_import 'java.sql.DriverManager'
+      else
+        require 'oci8'
+      end
+
+      attr_reader :connection
+      attr_reader :database
+
+      def self.connect(user, password, database, host=nil, port=nil)
+        self.new(user, password, database, host, port)
+      end
+
+      def disconnect
+        @connection.logoff
+      end
+
+      def execute(sql, *binds)
+        if RUBY_PLATFORM == 'java'
+          return execute_jdbc(sql, *binds)
+        end
+
+        begin
+          # OCI doesn't like the ? bind variables, so need to convert them
+          index = 0
+          new_sql = sql.gsub(/\?/) do |m|
+            index += 1
+            ":b#{index.to_s}"
+          end
+
+          query = @connection.parse(new_sql)
+          query.exec(*binds)
+
+          results = nil
+          if query.type == OCI8::STMT_SELECT
+            results = Array.new
+            while r = query.fetch()
+              results.push r
+            end
+          else
+            # everthing is auto commit right now ...
+            @connection.commit
+          end
+        ensure
+          begin
+            query.close()
+          rescue
+          end
+        end
+        results
+      end
+
+      def ping
+        results = self.execute('select dummy from dual')
+        if results.length == 1
+          true
+        else
+          false
+        end
+      end
+
+      def commit
+        @connection.commit
+      end
+
+      def rollback
+        @connection.rollback
+      end
+
+      def date_placeholder(bind_var)
+        "to_date(:#{bind_var}, 'YYYYMMDDHH24MISS')"
+      end
+
+      def date_as_string(dtm)
+        dtm.strftime '%Y%m%d%H%M%S'
+      end
+
+      private
+
+      def initialize(user, password, database, host=nil, port=1521)
+        @database = database
+
+        if RUBY_PLATFORM == 'java'
+          oradriver = OracleDriver.new
+          DriverManager.registerDriver oradriver
+          begin
+            @connection = DriverManager.get_connection("jdbc:oracle:thin:@#{host}:#{port}/#{database}", user, password)
+            @connection.auto_commit = true
+          rescue Exception => e
+            raise DBGeni::DBConnectionError, e.to_s
+          end
+        else
+          begin
+            @connection = OCI8.new(user, password, database)
+          rescue Exception => e
+            raise DBGeni::DBConnectionError, e.to_s
+          end
+        end
+      end
+
+      def execute_jdbc(sql, *binds)
+        begin
+          query = @connection.prepare_statement(sql)
+          binds.each_with_index do |b, i|
+            if b.is_a?(String)
+              query.setString(i+1, b)
+            elsif b.is_a?(Fixnum)
+              query.setInt(i+1, b)
+            end
+          end
+          results = nil
+          unless sql =~ /^\s*select/i
+            query.execute()
+          else
+            results = Array.new
+            rset = query.execute_query()
+            cols = rset.get_meta_data.get_column_count
+            while(r = rset.next) do
+              a = Array.new
+              1.upto(cols) do |i|
+                if rset.get_meta_data.get_column_type_name(i) == 'NUMBER'
+                  a.push rset.get_float(i)
+                else
+                  a.push rset.get_object(i)
+                end
+              end
+              results.push a
+            end
+          end
+          results
+        ensure
+          begin
+            query.close()
+          rescue Exception => e
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/dbgeni/connectors/sqlite.rb

@@ -0,0 +1,166 @@
+module DBGeni
+
+  module Connector
+    class Sqlite
+
+      if RUBY_PLATFORM == 'java'
+        require 'rubygems'
+        require 'jdbc/sqlite3'
+        Java::org.sqlite.JDBC #initialize the driver
+      else
+        require 'sqlite3'
+      end
+
+      attr_reader :connection
+      attr_reader :database
+
+      def self.db_file_path(base, file)
+        # starts with a ., eg ./filename, or does not
+        # contain any forward or backslashes, eg db.sqlite3
+        if file =~ /^\./ || file !~ /\/|\\/
+          # it is a relative path, so join to base directory
+          File.join(base, file)
+        else
+          file
+        end
+      end
+
+      def self.connect(user, password, database)
+        raise DBGeni::DatabaseNotSpecified unless database
+        self.new(database)
+      end
+
+      def disconnect
+        @connection.close
+      end
+
+      def execute(sql, *binds)
+#        unless @connection.transaction_active?
+#          @connection.transaction
+#        end
+        if RUBY_PLATFORM == 'java'
+          return execute_jdbc(sql, *binds)
+        end
+        begin
+          # Why am I re-establishing the database connection? Well, something has changed
+          # somewhere in the sqlite3 application or ruby drivers, and without this line
+          # I get lots of errors in the test suite:
+          #
+          # sqlite 3.7.8 QLite3::SQLException: SQL logic error or missing database
+          #
+          # This line fixes it be reconnecting. I am not sure if this is a non-reentrant
+          # issue, but it used to work just fine :-/
+          # SQLITE + DBGeni is not really intended as a production combo, so this is probably
+          # ok.
+          @connection = SQLite3::Database.new(@database)
+          query = @connection.prepare(sql)
+          binds.each_with_index do |b, i|
+            query.bind_param(i+1, b)
+          end
+          results = query.execute!
+          # This shouldn't even be needed, as there are never transactions started.
+          # by default everthing in sqlite is autocommit
+          if @connection.transaction_active?
+            @connection.commit
+          end
+          results
+        ensure
+          begin
+            query.close
+          rescue Exception => e
+          end
+        end
+      end
+
+      def execute_jdbc(sql, *binds)
+        query = @connection.prepare_statement(sql)
+        binds.each_with_index do |b, i|
+          if b.is_a?(String)
+            query.setString(i+1, b)
+          elsif b.is_a?(Fixnum)
+            query.setInt(i+1, b)
+          end
+        end
+        results = Array.new
+        unless sql =~ /^\s*select/i
+          query.execute()
+        else
+          rset = query.execute_query()
+          cols = rset.get_meta_data.get_column_count
+          while(r = rset.next) do
+            a = Array.new
+            1.upto(cols) do |i|
+              a.push rset.get_object(i)
+            end
+            results.push a
+          end
+        end
+        query.close
+        results
+      end
+
+      def ping
+        ! @connection.closed?
+      end
+
+      def commit
+        @connection.commit
+      end
+
+      def rollback
+        @connection.rollback
+      end
+
+      def date_placeholder(bind_var)
+        "time(:#{bind_var})"
+      end
+
+      def date_as_string(dtm)
+        dtm.strftime '%Y-%m-%d %H:%M:%S'
+      end
+
+      private
+
+      def initialize(database)
+        @database   = database
+        begin
+          if RUBY_PLATFORM == 'java'
+            @connection = ::JavaSql::DriverManager.getConnection("jdbc:sqlite:#{database}")
+          else
+            @connection = SQLite3::Database.new(database)
+          end
+        rescue Exception => e
+          raise DBGeni::DBConnectionError, e.to_s
+        end
+      end
+
+      def execute_jdbc(sql, *binds)
+        query = @connection.prepare_statement(sql)
+        binds.each_with_index do |b, i|
+          if b.is_a?(String)
+            query.setString(i+1, b)
+          elsif b.is_a?(Fixnum)
+            query.setInt(i+1, b)
+          end
+        end
+        results = Array.new
+        unless sql =~ /^\s*select/i
+          query.execute()
+        else
+          rset = query.execute_query()
+          cols = rset.get_meta_data.get_column_count
+          while(r = rset.next) do
+            a = Array.new
+            1.upto(cols) do |i|
+              a.push rset.get_object(i)
+            end
+            results.push a
+          end
+        end
+        query.close
+        results
+      end
+
+    end
+  end
+end

data/lib/dbgeni/connectors/sybase.rb

@@ -0,0 +1,97 @@
+module DBGeni
+
+  module Connector
+
+    class Sybase
+
+      unless RUBY_PLATFORM == 'java'
+        raise DBGeni::UnsupportedRubyPlatform
+      end
+
+      require 'java'
+      java_import 'net.sourceforge.jtds.jdbc.Driver'
+      java_import 'java.sql.DriverManager'
+
+      attr_reader :connection
+      attr_reader :database
+
+      def self.connect(user, password, database, host=nil, port=nil)
+        self.new(user, password, database, host, port)
+      end
+
+      def disconnect
+        @connection.close
+      end
+
+      def execute(sql, *binds)
+        query = @connection.prepare_statement(sql)
+        binds.each_with_index do |b, i|
+          if b.is_a?(String)
+            query.setString(i+1, b)
+          elsif b.is_a?(Fixnum)
+            query.setInt(i+1, b)
+          end
+        end
+        results = Array.new
+        unless sql =~ /^\s*select/i
+          query.execute()
+        else
+          rset = query.execute_query()
+          cols = rset.get_meta_data.get_column_count
+          while(r = rset.next) do
+            a = Array.new
+            1.upto(cols) do |i|
+              a.push rset.get_object(i)
+            end
+            results.push a
+          end
+        end
+        query.close
+        results
+      end
+
+      def ping
+        results = self.execute('select 1')
+        if results.length == 1
+          true
+        else
+          false
+        end
+      end
+
+      def commit
+        @connection.commit
+      end
+
+      def rollback
+        @connection.rollback
+      end
+
+      def date_placeholder(bind_var)
+        "cast(? as datetime)"
+      end
+
+      def date_as_string(dtm)
+        dtm.strftime '%Y-%m-%d %H:%M:%S'
+      end
+
+      private
+
+
+      #
+      def initialize(user, password, database, host=nil, port=nil)
+        @database = database
+
+        sybdriver = Driver.new
+        DriverManager.registerDriver sybdriver
+        begin
+          @connection = DriverManager.get_connection("jdbc:jtds:sybase://#{host}:#{port}/#{database}", user, password)
+          @connection.auto_commit = true
+        rescue Exception => e
+          raise DBGeni::DBConnectionError, e.to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/dbgeni/dml_cli.rb

@@ -0,0 +1,35 @@
+module DBGeni
+
+  class DmlCLI < MigrationCLI
+
+    BEFORE_UP_RUN_PLUGIN   = :before_dml_up
+    AFTER_UP_RUN_PLUGIN    = :after_dml_up
+    BEFORE_DOWN_RUN_PLUGIN = :before_dml_down
+    AFTER_DOWN_RUN_PLUGIN  = :after_dml_down
+    BEFORE_RUNNING_PLUGIN  = :before_running_dml
+    AFTER_RUNNING_PLUGIN   = :after_running_dml
+
+    def migrations
+      @migration_list ||= DBGeni::MigrationList.new_dml_migrations(@config.dml_directory) unless @migration_list
+      @migration_list.migrations
+    end
+
+    private
+
+    def find_migration(migration_name)
+      m = Migration.initialize_from_internal_name(@config.dml_directory, migration_name)
+    end
+
+    def set_plugin_hooks
+      @before_up_run_plugin   = :before_dml_up
+      @after_up_run_plugin    = :after_dml_up
+      @before_down_run_plugin = :before_dml_down
+      @after_down_run_plugin  = :after_dml_down
+      @before_running_plugin  = :before_running_dmls
+      @after_running_plugin   = :after_running_dmls
+    end
+
+
+  end
+
+end

data/lib/dbgeni/environment.rb

@@ -0,0 +1,161 @@
+module DBGeni
+
+  class Environment < BlankSlate
+
+    def initialize(environment_name)
+      @environment_name = environment_name
+      @params           = Hash.new
+      @loading          = true
+    end
+
+
+    def __merge_environment(new_env)
+      @params.merge!(new_env.__params)
+    end
+
+    def __enable_loading
+      @loading = true
+    end
+
+    def __completed_loading
+      @loading = false
+    end
+
+    def __is_loadable?
+      @loading
+    end
+
+    def __environment_name
+      @environment_name
+    end
+
+    def __params
+      @params
+    end
+
+    def __merge_defaults(default_params)
+      all_params = default_params.merge(@params)
+      @params = all_params
+    end
+
+    def method_missing(name, *args, &block)
+      str_name = name.to_s.gsub(/=$/, '')
+      if __is_loadable?
+        __load_parameter(str_name, *args)
+      else
+        __get_parameter(str_name, *args)
+      end
+    end
+
+    def __to_s
+      str = ''
+      # get the longest key length to pad the keys
+      max_length = @params.keys.map{ |k| k.length }.sort.last
+      @params.keys.sort.each do |k|
+        str << "#{k.ljust(max_length, ' ')} => #{@params[k]}\n"
+      end
+      str
+    end
+
+    private
+
+    def __load_parameter(name, *args)
+      if @params.has_key?(name)
+        warn "Parameter #{name} was previously defined"
+      end
+      # TODO - Not sure whether to raise or just let it be nil
+      #if nil == args[0]
+      #  raise ""
+      #end
+      @params[name] = args[0] unless args[0] == ''
+    end
+
+    def __get_parameter(name, *args)
+      unless @params.has_key?(name)
+        # Password is a special case - if it is not defined it should be prompted for
+        if name == 'password'
+          puts "Please enter the password for #{@params['database']} in the #{@environment_name} environment\n"
+          password = ''
+          begin
+            while (password == '')
+              print "password: "
+              unless is_windows?
+                system "stty -echo"
+              end
+              password = gets.chomp
+              unless is_windows?
+                system "stty echo"
+              end
+              print "\n"
+            end
+          rescue Interrupt
+            unless is_windows?
+              system "stty echo"
+            end
+            exit(1)
+          end
+          @params[name] = password
+          password
+        end
+      else
+        @params[name]
+      end
+    end
+
+  end
+
+end
+
+  # class Environment < BlankSlate
+
+  #   def initialize(name)
+  #     @__environment_name = name
+  #   end
+
+  #   def metaclass
+  #     class << self
+  #       self
+  #     end
+  #   end
+
+  #   def lock
+  #     metaclass.send(:alias_method, :__method_missing, :method_missing)
+  #     metaclass.send(:undef_method, :method_missing)
+  #   end
+
+  #   def unlock
+  #     metaclass.send(:alias_method, :method_missing, :__method_missing)
+  #   end
+
+  #   def method_missing(name, *args, &block)
+  #     # TODO - add list of illegal param names (ie the list of kept methods
+  #     #
+  #     # if the method was a meth= type one, we need to get rid of the = sign
+  #     #
+  #     # This allows variables to be defined as
+  #     #   param 'value'
+  #     # or
+  #     #   param = 'value'
+  #     str_name = name.to_s.gsub(/=$/, '')
+  #     method_name = ('@'+str_name).intern
+  #     self.instance_variable_set(method_name, args[0])
+  #     instance_eval("
+  #       def #{str_name}(__param = nil)
+  #         return @#{str_name} unless __param
+  #         @#{str_name} = __param
+  #       end
+  #     ")
+  #     metaclass.send(:alias_method, "#{str_name}=".intern, str_name.intern)
+  #   end
+
+
+
+    # Method to define a generic getter setter.
+#def font_size(size = nil)
+#  return @font_size unless size
+#  @font_size = size
+#  end
+#alias_method :font_size=, :font_size
+
+#  end
+#end

data/lib/dbgeni/exceptions/exception.rb

@@ -0,0 +1,69 @@
+module DBGeni
+
+  class DBConnectionError          < Exception; end
+  class NoLoggerLocation           < Exception; end
+  class MigrationDirectoryNotExist < Exception; end
+  class MigrationFilenameInvalid   < Exception; end
+  class MigrationFileNotExist      < Exception; end
+  class MigrationAlreadyApplied    < Exception; end
+  class MigrationNotApplied        < Exception; end
+  class MigrationApplyFailed       < Exception; end
+  class MigrationContainsErrors    < Exception; end
+  class MigrationNotOutstanding    < Exception; end
+
+  class EnvironmentNotExist        < Exception; end
+
+  class ConfigFileNotExist         < Exception; end
+  class ConfigAmbiguousEnvironment < Exception; end
+  class ConfigFileNotSpecified     < Exception; end
+  class ConfigSyntaxError          < Exception; end
+
+  class NoEnvironmentSelected      < Exception; end
+
+  ## Initializer
+
+  # If an attempt is made to load an initializer that doesn't exist
+  class NoInitializerForDBType      < Exception; end
+  # If the initializer is not corretly defined, this will be raise.
+  class InvalidInitializerForDBType < Exception; end
+
+  ## Connectors
+  class NoConnectorForDBType        < Exception; end
+  class InvalidConnectorForDBType   < Exception; end
+
+  ## Migrators
+  class NoMigratorForDBType         < Exception; end
+  class InvalidMigratorForDBType    < Exception; end
+
+  class DatabaseAlreadyInitialized  < Exception; end
+  class DatabaseNotInitialized      < Exception; end
+  class DBGeni::DatabaseNotSpecified < Exception; end
+  class NoOutstandingMigrations     < Exception; end
+  class NoAppliedMigrations         < Exception; end
+  class MigratorCouldNotConnect     < Exception; end
+
+  ## code
+  class UnknownCodeType             < Exception; end
+  class CodeModuleCurrent           < Exception; end
+  class CodeApplyFailed             < Exception; end
+  class CodeFileNotExist            < Exception; end
+  class CodeDirectoryNotExist       < Exception; end
+  class NoOutstandingCode           < Exception; end
+  class NoCodeFilesExist            < Exception; end
+  class CannotRemoveUnknownObject   < Exception; end
+
+  class DBCLINotOnPath              < Exception; end
+  class CodeRemoveFailed            < Exception; end
+  class NotImplemented              < Exception; end
+
+  class MilestoneHasNoMigration     < Exception; end
+  class UnsupportedRubyPlatform     < Exception; end
+  class ConnectionError             < Exception; end
+
+  # Plugins
+  class InvalidHook                  < Exception; end
+  class PluginDoesNotRespondToRun    < Exception; end
+  class PluginDirectoryNotAccessible < Exception; end
+  class PluginException              < Exception; end
+
+end