sequel_core 1.0

data/lib/sequel_core/exceptions.rb

@@ -0,0 +1,45 @@
+module Sequel
+  # Represents an error raised in Sequel code.
+  class Error < StandardError
+
+    # Rollback is a special error used to rollback a transactions.
+    # A transaction block will catch this error and wont pass further up the stack.
+    class Rollback < Error ; end
+    
+    # Represents an invalid value stored in the database.
+    class InvalidValue < Error ; end
+                                       
+    # Represents an Invalid transform.
+    class InvalidTransform < Error ; end
+                                       
+    # Represents an Invalid filter.    
+    class InvalidFilter < Error ; end
+    
+    class InvalidExpression < Error; end
+                                       
+    # Represents an attempt to performing filter operations when no filter has been specified yet.
+    class NoExistingFilter < Error ; end
+                                       
+    # Represents an invalid join type.
+    class InvalidJoinType < Error ; end
+                                       
+    class WorkerStop < RuntimeError ; end
+    
+    # Raised when Sequel is unable to load a specified adapter.
+    class AdapterNotFound < Error ; end
+  end  
+end
+
+# Object extensions
+class Object
+  # Cancels the current transaction without an error:
+  #
+  #   DB.tranaction do
+  #     ...
+  #     rollback! if failed_to_contact_client
+  #     ...
+  #   end
+  def rollback!
+    raise Sequel::Error::Rollback
+  end
+end

data/lib/sequel_core/migration.rb

@@ -0,0 +1,191 @@
+# The migration code is based on work by Florian Aßmann:
+#   http://code.google.com/p/ruby-sequel/issues/detail?id=23
+
+module Sequel
+  # The Migration class describes a database migration that can be reversed.
+  # The migration looks very similar to ActiveRecord (Rails) migrations, e.g.:
+  #
+  #   class CreateSessions < Sequel::Migration
+  #     def up
+  #       create_table :sessions do
+  #         primary_key :id
+  #         varchar   :session_id, :size => 32, :unique => true
+  #         timestamp :created_at
+  #         text      :data
+  #       end
+  #     end
+  # 
+  #     def down
+  #       execute 'DROP TABLE sessions'
+  #     end
+  #   end
+  #
+  # To apply a migration to a database, you can invoke the #apply with
+  # the target database instance and the direction :up or :down, e.g.:
+  #
+  #   DB = Sequel.open ('sqlite:///mydb')
+  #   CreateSessions.apply(DB, :up)
+  #
+  class Migration
+    # Creates a new instance of the migration and sets the @db attribute.
+    def initialize(db)
+      @db = db
+    end
+    
+    # Adds the new migration class to the list of Migration descendants.
+    def self.inherited(base)
+      descendants << base
+    end
+    
+    # Returns the list of Migration descendants.
+    def self.descendants
+      @descendants ||= []
+    end
+    
+    def up; end #:nodoc:
+    def down; end #:nodoc:
+    
+    # Applies the migration to the supplied database in the specified
+    # direction.
+    def self.apply(db, direction)
+      obj = new(db)
+      case direction
+      when :up
+        obj.up
+      when :down
+        obj.down
+      else
+        raise ArgumentError, "Invalid migration direction specified (#{direction.inspect})"
+      end
+    end
+
+    # Intercepts method calls intended for the database and sends them along.
+    def method_missing(method_sym, *args, &block)
+      @db.send method_sym, *args, &block
+    end
+  end
+
+  # The Migrator module performs migrations based on migration files in a 
+  # specified directory. The migration files should be named using the
+  # following pattern (in similar fashion to ActiveRecord migrations):
+  # 
+  #   <version>_<title>.rb
+  #
+  # For example, the following files are considered migration files:
+  #   
+  #   001_create_sessions.rb
+  #   002_add_data_column.rb
+  #   ...
+  #
+  # The migration files should contain one or more migration classes based
+  # on Sequel::Migration.
+  #
+  # To apply a migration, the #apply method must be invoked with the database
+  # instance, the directory of migration files and the target version. If
+  # no current version is supplied, it is read from the database. The migrator
+  # automatically creates a schema_info table in the database to keep track
+  # of the current migration version. If no migration version is stored in the
+  # database, the version is considered to be 0. If no target version is 
+  # specified, the database is migrated to the latest version available in the
+  # migration directory.
+  #
+  # For example, to migrate the database to the latest version:
+  #
+  #   Sequel::Migrator.apply(DB, '.')
+  #
+  # To migrate the database from version 1 to version 5:
+  #
+  #   Sequel::Migrator.apply(DB, '.', 5, 1)
+  #
+  module Migrator
+    # Migrates the supplied database in the specified directory from the
+    # current version to the target version. If no current version is
+    # supplied, it is extracted from a schema_info table. The schema_info
+    # table is automatically created and maintained by the apply function.
+    def self.apply(db, directory, target = nil, current = nil)
+      # determine current and target version and direction
+      current ||= get_current_migration_version(db)
+      target ||= latest_migration_version(directory)
+      raise Error, "No current version available" if current.nil?
+      raise Error, "No target version available" if target.nil?
+
+      direction = current < target ? :up : :down
+      
+      classes = migration_classes(directory, target, current, direction)
+      
+      db.transaction do
+        classes.each {|c| c.apply(db, direction)}
+        set_current_migration_version(db, target)
+      end
+      
+      target
+    end
+
+    # Returns a list of migration classes filtered for the migration range and
+    # ordered according to the migration direction.
+    def self.migration_classes(directory, target, current, direction)
+      range = direction == :up ?
+        (current + 1)..target : (target + 1)..current
+
+      # Remove class definitions
+      Migration.descendants.each do |c|
+        Object.send(:remove_const, c.to_s) rescue nil
+      end
+      Migration.descendants.clear # remove any defined migration classes
+
+      # load migration files
+      migration_files(directory, range).each {|fn| load(fn)}
+      
+      # get migration classes
+      classes = Migration.descendants
+      classes.reverse! if direction == :down
+      classes
+    end
+    
+    MIGRATION_FILE_PATTERN = '[0-9][0-9][0-9]_*.rb'.freeze
+
+    # Returns any found migration files in the supplied directory.
+    def self.migration_files(directory, range = nil)
+      pattern = File.join(directory, MIGRATION_FILE_PATTERN)
+      files = Dir[pattern].inject([]) do |m, path|
+        m[File.basename(path).to_i] = path
+        m
+      end
+      filtered = range ? files[range] : files
+      filtered ? filtered.compact : []
+    end
+    
+    # Returns the latest version available in the specified directory.
+    def self.latest_migration_version(directory)
+      l = migration_files(directory).last
+      l ? File.basename(l).to_i : nil
+    end
+
+    # Gets the current migration version stored in the database. If no version
+    # number is stored, 0 is returned.
+    def self.get_current_migration_version(db)
+      r = schema_info_dataset(db).first
+      r ? r[:version] : 0
+    end
+    
+    # Sets the current migration  version stored in the database.
+    def self.set_current_migration_version(db, version)
+      dataset = schema_info_dataset(db)
+      if dataset.first
+        dataset.update(:version => version)
+      else
+        dataset << {:version => version}
+      end
+    end
+    
+    # Returns the dataset for the schema_info table. If no such table
+    # exists, it is automatically created.
+    def self.schema_info_dataset(db)
+      unless db.table_exists?(:schema_info)
+        db.create_table(:schema_info) {integer :version}
+      end
+
+      db[:schema_info]
+    end
+  end
+end

data/lib/sequel_core/model.rb

@@ -0,0 +1,8 @@
+module Sequel
+  class Model
+    def self.database_opened(db)
+      @db = db if (self == Model) && !@db
+    end
+  end
+end
+

data/lib/sequel_core/pretty_table.rb

@@ -0,0 +1,73 @@
+module Sequel
+  # Prints nice-looking plain-text tables
+  # +--+-------+
+  # |id|name   |
+  # |--+-------|
+  # |1 |fasdfas|
+  # |2 |test   |
+  # +--+-------+
+  module PrettyTable
+    def self.records_columns(records)
+      columns = []
+      records.each do |r|
+        if Array === r && (k = r.keys)
+          return k
+        elsif Hash === r
+          r.keys.each {|k| columns << k unless columns.include?(k)}
+        end
+      end
+      columns
+    end
+    
+    def self.column_sizes(records, columns)
+      sizes = Hash.new {0}
+      columns.each do |c|
+        s = c.to_s.size
+        sizes[c.to_sym] = s if s > sizes[c.to_sym]
+      end
+      records.each do |r|
+        columns.each do |c|
+          s = r[c].to_s.size
+          sizes[c.to_sym] = s if s > sizes[c.to_sym]
+        end
+      end
+      sizes
+    end
+    
+    def self.separator_line(columns, sizes)
+      l = ''
+      '+' + columns.map {|c| '-' * sizes[c]}.join('+') + '+'
+    end
+    
+    def self.format_cell(size, v)
+      case v
+      when Bignum, Fixnum
+        "%#{size}d" % v
+      when Float
+        "%#{size}g" % v
+      else
+        "%-#{size}s" % v.to_s
+      end
+    end
+    
+    def self.data_line(columns, sizes, record)
+      '|' + columns.map {|c| format_cell(sizes[c], record[c])}.join('|') + '|'
+    end
+    
+    def self.header_line(columns, sizes)
+      '|' + columns.map {|c| "%-#{sizes[c]}s" % c.to_s}.join('|') + '|'
+    end
+    
+    def self.print(records, columns = nil) # records is an array of hashes
+      columns ||= records_columns(records)
+      sizes = column_sizes(records, columns)
+      
+      puts separator_line(columns, sizes)
+      puts header_line(columns, sizes)
+      puts separator_line(columns, sizes)
+      records.each {|r| puts data_line(columns, sizes, r)}
+      puts separator_line(columns, sizes)
+    end
+  end
+end
+

data/lib/sequel_core/schema.rb

@@ -0,0 +1,8 @@
+module Sequel
+  module Schema
+  end
+end
+
+require File.join(File.dirname(__FILE__), 'schema/schema_sql')
+require File.join(File.dirname(__FILE__), 'schema/schema_generator')
+

data/lib/sequel_core/schema/schema_generator.rb

@@ -0,0 +1,131 @@
+module Sequel
+  module Schema
+    class Generator
+      def initialize(db, &block)
+        @db = db
+        @columns = []
+        @indexes = []
+        @primary_key = nil
+        instance_eval(&block) if block
+      end
+      
+      def method_missing(type, name = nil, opts = {})
+        name ? column(name, type, opts) : super
+      end
+      
+      def primary_key_name
+        @primary_key ? @primary_key[:name] : nil
+      end
+      
+      def primary_key(name, *args)
+        @primary_key = @db.serial_primary_key_options.merge({:name => name})
+        
+        if opts = args.pop
+          opts = {:type => opts} unless opts.is_a?(Hash)
+          if type = args.pop
+            opts.merge!(:type => type)
+          end
+          @primary_key.merge!(opts)
+        end
+        @primary_key
+      end
+      
+      def column(name, type, opts = {})
+        @columns << {:name => name, :type => type}.merge(opts)
+        index(name) if opts[:index]
+      end
+      
+      def foreign_key(name, opts = {})
+        @columns << {:name => name, :type => :integer}.merge(opts)
+        index(name) if opts[:index]
+      end
+      
+      def has_column?(name)
+        @columns.each {|c| return true if c[:name] == name}
+        false
+      end
+      
+      def index(columns, opts = {})
+        columns = [columns] unless columns.is_a?(Array)
+        @indexes << {:columns => columns}.merge(opts)
+      end
+      
+      def unique(columns, opts = {})
+        index(columns, {:unique => true}.merge(opts))
+      end
+      
+      def create_info
+        if @primary_key && !has_column?(@primary_key[:name])
+          @columns.unshift(@primary_key)
+        end
+        [@columns, @indexes]
+      end
+    end
+  
+    class AlterTableGenerator
+      attr_reader :operations
+      
+      def initialize(db, &block)
+        @db = db
+        @operations = []
+        instance_eval(&block) if block
+      end
+      
+      def add_column(name, type, opts = {})
+        @operations << { \
+          :op => :add_column, \
+          :name => name, \
+          :type => type \
+        }.merge(opts)
+      end
+      
+      def drop_column(name)
+        @operations << { \
+          :op => :drop_column, \
+          :name => name \
+        }
+      end
+      
+      def rename_column(name, new_name, opts = {})
+        @operations << { \
+          :op => :rename_column, \
+          :name => name, \
+          :new_name => new_name \
+        }.merge(opts)
+      end
+      
+      def set_column_type(name, type)
+        @operations << { \
+          :op => :set_column_type, \
+          :name => name, \
+          :type => type \
+        }
+      end
+      
+      def set_column_default(name, default)
+        @operations << { \
+          :op => :set_column_default, \
+          :name => name, \
+          :default => default \
+        }
+      end
+      
+      def add_index(columns, opts = {})
+        columns = [columns] unless columns.is_a?(Array)
+        @operations << { \
+          :op => :add_index, \
+          :columns => columns \
+        }.merge(opts)
+      end
+      
+      def drop_index(columns)
+        columns = [columns] unless columns.is_a?(Array)
+        @operations << { \
+          :op => :drop_index, \
+          :columns => columns \
+        }
+      end
+    end
+  end
+end
+