rails3_sequel 0.2.2 → 0.3.0

data/CHANGELOG

@@ -0,0 +1,6 @@
+=== HEAD
+
+* Can now do adapter specific database configurations. Specifically this addressed Postgres schema_search_path option.
+* Create database in Postgres will also create schema.
+* MySql and SQLite adapters
+* Rake tasks db:create:all, db:drop:all, db:drop

data/README.md

@@ -1,6 +1,8 @@
 Rails 3 Sequel integration
 ==========================
 
+**There has been some confusions with how the logging works. if you are using Rails 3 beta 3, please use the released gem or the beta3 branch on github. if you are using edge Rails 3, then please use this master branch**
+
 Features:
 
 + Generators
@@ -11,7 +13,6 @@ Features:
     - Views recognize migration data types.
 
 + Rake tasks
-  - mostly everything except db:test:prepare, db:setup, and db:create:all (should be ready next version)
 
 + Railties
   - uses database.yml configuration
@@ -24,12 +25,13 @@ Features:
 
 *What is still need done:*
 
-+ More testing
++ Write tests
 + i18n
 + Session Store
 + Observers
 + more rake tasks
-+ adapter specific after_create proc
++ adapter specific encoding / charset options
++ namespaced config (config.sequel.xxxx)
 
 Installation
 ------------
@@ -42,6 +44,8 @@ OR, in your Gemfile
 
 then run bundle install.
 
+Please see the note at the top of this README for what version you should use.
+
 Usage - Railties
 ----------------
 
@@ -76,7 +80,9 @@ Rake tasks usage:
 
     db:create
       Creates the database defined in your Rails environment. Unlike AR, this does not create test database with your development. You must specify your Rails environment manually.
-      ex. RAILS_ENV=test rake db:create
+      ex. rake db:create[test] or RAILS_ENV=test rake db:create
+    db:create:all
+      Does the above for all environments
     db:migrate
       You know what this does.
     db:migrate:up
@@ -90,13 +96,18 @@ Rake tasks usage:
     db:schema:dump
       Uses Sequel's schema_dumper. Stores output in db/schema.rb.
     db:schema:load
-      Does not work yet, but you can just run Sequel::Migrator on the schema file.
+      Uses Sequel's migration. Reads from db/schema.rb.
     db:seed
-      Load the seed data from db/seeds.rb
+      Load the seed data from db/seeds.rb.
     db:version
-      Shows the current migration version
-    db:setup, db:test:load, db:test:purge
-      Not implemented yet
+      Shows the current migration version.
+    db:setup
+      Create the database, load the schema, and initialize with the seed data.
+    db:test:load
+      Recreate the test database from the current schema.rb.
+    db:test:purge
+      Empty the test database.
+      
 
 Please note that db:create currently only works with PostgreSQL, MySQL, and SQLite. If you have other DBs, please contribute if you can!
 

data/lib/rails3_sequel/adapters/mysql.rb

@@ -0,0 +1,41 @@
+module Rails
+  module Sequel
+    class Database
+
+      class Mysql
+        def initialize (env)
+          @env = env
+          @config = Database.configurations[@env]
+        end
+
+        def connect (options = {})
+          ::Sequel.connect(@config.merge(options))
+        end       
+
+        def create_database (options = {})
+          db = management_connect
+          name = @config['database']
+
+          if options[:collation]
+            db.execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}` COLLATE `#{options[:collation]}`"
+          else
+            db.execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}`"
+          end 
+        end
+
+        def drop_database
+          db = management_connect
+          name = @config['database']
+          db.execute "DROP DATABASE IF EXISTS `#{name}`"
+        end
+
+        private
+
+        def management_connect
+          connect('database' => nil)
+        end
+      end
+
+    end
+  end
+end

data/lib/rails3_sequel/adapters/postgres.rb

@@ -0,0 +1,89 @@
+module Rails
+  module Sequel
+    class Database
+
+      class Postgres
+        def initialize (env)
+          @env = env
+          @config = parse_special_options(Database.configurations[@env])
+        end
+
+        def connect (options = {})
+          options = parse_special_options(options)
+          ::Sequel.connect(@config.merge(options))
+        end
+
+        # from ActiveRecord
+        def create_database (options = {})
+          db = management_connect
+          name = @config['database']
+
+          if name.nil? or name.strip == '' then
+            raise "No valid database specified for #{@env} environment"
+          end
+
+          options = options.reverse_merge(:encoding => "utf8")
+
+          option_string = options.sum do |key, value|
+            case key
+            when 'owner'
+              " OWNER = \"#{value}\""
+            when 'template'
+              " TEMPLATE = \"#{value}\""
+            when 'encoding'
+              " ENCODING = '#{value}'"
+            when 'tablespace'
+              " TABLESPACE = \"#{value}\""
+            when :connection_limit
+              " CONNECTION LIMIT = #{value}"
+            else 
+              ""   
+            end  
+          end  
+
+          # TODO: quote table name
+          db.execute "CREATE DATABASE #{name} #{option_string}"
+
+          # create schema too, if the previous command succeeds, this should be fine
+          # first connect without schema specified
+          db = connect('schema_search_path' => nil)
+          for schema in @config['schema_search_path'].split(',') do
+            next if schema.strip == 'public'
+            db.execute "CREATE SCHEMA #{schema}"
+          end
+        end
+
+        def drop_database
+          db = management_connect
+          name = @config['database']
+
+          db.execute "DROP DATABASE #{name}"
+        end
+
+        private
+
+        def management_connect
+          connect({ 'database' => 'postgres', 'schema_search_path' => 'public' })
+        end
+
+        def parse_special_options (opts)
+          # not a deep dup
+          options = opts.dup
+
+          if options['schema_search_path'].nil? then
+            options['after_connect'] = nil
+          else
+            options['after_connect'] = (
+              proc do |conn|
+                conn.execute("SET search_path = #{options['schema_search_path']}")
+              end
+            )
+          end
+
+          return options
+        end
+      end
+
+    end
+  end
+end

data/lib/rails3_sequel/adapters/sqlite.rb

@@ -0,0 +1,28 @@
+module Rails
+  module Sequel
+    class Database
+
+      class Sqlite
+        def initialize (env)
+          @env = env
+          @config = Database.configurations[@env]
+        end
+
+        def connect (options = {})
+          ::Sequel.connect(@config.merge(options))
+        end
+
+        def create_database (*args)
+          connect
+          puts 'Warning: sqlite file may not have been created until there are some operations on it'
+        end
+
+        def drop_database (*args)
+          dbfile = @config['database']
+          File.delete(dbfile) if File.exists?(dbfile)
+        end
+      end
+
+    end
+  end
+end

data/lib/rails3_sequel/database.rb

@@ -1,119 +1,73 @@
 module Rails
   module Sequel
-    module Database    
-      mattr_reader :configurations, :db
-
-      def self.configurations= (config)
-        @@configurations = config
-
-        for key,env in @@configurations do
-          # some translations
-          env['adapter'] = case env['adapter']
-            when 'postgresql' then 'postgres'
-            when 'sqlite3'    then 'sqlite'
-            else env['adapter']
-          end
-        end
-      end
-
-      # Connects to database
-      def self.connect (options = {})
-        @@db = ::Sequel.connect(self.configurations[Rails.env].merge(options))
-      end
-
-      def self.create_database (options = {})
-        adapter.new.create_database(self.configurations[Rails.env]['database'], options)
-      end
-
-      def self.drop_database
-        adapter.new.drop_database(self.configurations[Rails.env]['database'])
-      end
+    class Database    
 
       class << self
-        private
+        attr_reader :configurations
+
+        def configurations= (config)
+          @configurations = config
+
+          for key,env in @configurations do
+            # some translations
+            env['adapter'] = case env['adapter']
+              when 'postgresql' then 'postgres'
+              when 'sqlite3'    then 'sqlite'
+              else env['adapter']
+            end
+          end
+        end
 
-        def adapter
-          a = configurations[Rails.env]['adapter'].camelize.to_sym
+        def adapter(env)
+          a = configurations[env]['adapter']
+          a_file = File.join(File.dirname(__FILE__), 'adapters', "#{a}.rb")
 
-          unless const_defined?(a)
+          unless File.exists?(a_file)
             raise "Adapter #{a} not supported."
           end
 
-          const_get(a)
+          load a_file
+          const_get(a.camelize.to_sym).new(env)
         end
-      end
 
-      class Postgres
-        def initialize
-          @db = Rails::Sequel::Database.connect({ :database => 'postgres', :after_connect => ( 
-              proc do |conn|
-                conn.execute('SET search_path = public')
-              end
-            )
-          })
+        # convenient methods
+
+        def connect (env, options = {})
+          adapter(env).connect(options)
         end
 
-        # from ActiveRecord
-        def create_database (name, options = {})
-          options = options.reverse_merge(:encoding => "utf8")
-
-          option_string = options.sum do |key, value|
-            case key
-            when 'owner'
-              " OWNER = \"#{value}\""
-            when 'template'
-              " TEMPLATE = \"#{value}\""
-            when 'encoding'
-              " ENCODING = '#{value}'"
-            when 'tablespace'
-              " TABLESPACE = \"#{value}\""
-            when :connection_limit
-              " CONNECTION LIMIT = #{value}"
-            else 
-              ""   
-            end  
-          end  
-
-          # TODO: quote table name
-          @db.execute "CREATE DATABASE #{name} #{option_string}"
+        def create_database (env, options = {})
+          local_database?(env) { adapter(env).create_database(options) }
         end
 
-        def drop_database (name)
-          begin
-            @db.execute "DROP DATABASE #{name}"
-          rescue Sequel::DatabaseError
-            raise 'Cannot drop database'
+        def create_all (options = {})
+          for env,config in configurations do
+            next unless config['database']
+            create_database(env, options)
           end
         end
-      end
-
-      class Mysql
-        def initialize
-          Rails::Sequel::Database.connect({ :database => nil })
-        end       
 
-        def create_database (name, options = {})
-          if options[:collation]
-            @db.execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}` COLLATE `#{options[:collation]}`"
-          else
-            @db.execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}`"
-          end 
+        def drop_database (env)
+          local_database?(env) { adapter(env).drop_database }
         end
 
-        def drop_database (name)
-          @db.execute "DROP DATABASE IF EXISTS `#{name}`"
+        def drop_all
+          for env,config in configurations do
+            next unless config['database']
+            drop_database(env)
+          end
         end
-      end
 
-      class Sqlite
-        def initialize
-          Rails::Sequel::Database.connect
-        end
+        private
 
-        def create_database (*args)
-        end
+        def local_database? (env, &block)
+          config = configurations[env]
 
-        def drop_database (*args)
+          if %w( 127.0.0.1 localhost ).include?(config['host']) || config['host'].blank?
+            yield
+          else
+            $stderr.puts "This task only modifies local databases. #{config['database']} is on a remote host."
+          end 
         end
       end
 

data/lib/rails3_sequel/logging.rb

@@ -4,7 +4,7 @@ module Rails
       def log_duration (duration, message)
         @controller_runtime ||= 0
         @controller_runtime += duration
-        ActiveSupport::Notifications.instrument('sql.sequel', 
+        ActiveSupport::Notifications.instrument('sequel.sql', 
           :sql => message,
           :name => 'SQL',
           :duration => duration * 1000

data/lib/rails3_sequel/railtie.rb

@@ -30,7 +30,7 @@ module Rails
 
       initializer 'sequel.initialize_database' do |app|
         Rails::Sequel::Database.configurations = app.config.database_configuration
-        Rails::Sequel::Database.connect
+        Rails::Sequel::Database.connect(Rails.env)
       end
 
       initializer 'sequel.logging' do |app|

data/lib/rails3_sequel/railties/database.rake

@@ -23,14 +23,28 @@ namespace :db do
   end
 
   namespace :create do
-    task :all do
-      # cant choose which db to create yet.
-      puts 'Pending implementation'
+    task :all => :environment do
+      Rails::Sequel::Database.create_all
+    end
+  end
+  
+  desc 'Creates the database defined in your Rails environment. Unlike AR, this does not create test database with your development. You must specify your Rails environment manually.'
+  task :create, :env, :needs => :environment do |t, args|
+    args.with_defaults(:env => Rails.env)
+    Rails::Sequel::Database.create_database(args.env)
+  end
+
+  namespace :drop do
+    task :all => :environment do
+      Rails::Sequel::Database.drop_all
     end
   end
 
-  task :create => :environment do
-    Rails::Sequel::Database.create_database
+  desc 'Opposite of db:create'
+  task :drop, :env, :needs => :environment do |t, args|
+    args.with_defaults(:env => Rails.env)
+    # TODO: what happens if database doesn't exist?
+    Rails::Sequel::Database.drop_database(args.env)
   end
 
   namespace :migrate do
@@ -85,15 +99,18 @@ namespace :db do
         file.puts Sequel::Model.db.dump_schema_migration
       end
 
-      # needs also away to store current schema version
+      # TODO: needs also away to store current schema version
     end
 
     desc "Load a schema.rb file into the database."
-    task :load => :environment do
+    task :load, :db, :needs => :environment do |t, args|
+      args.with_defaults(:db => Sequel::Model.db)
+
       file = ENV['SCHEMA'] || "#{Rails.root}/db/schema.rb"
       if File.exists?(file) then
-        load(file)
-        # probably needs to also run "up: here
+        Sequel.extension :migration
+        schema_migration = eval(File.read(file))
+        schema_migration.apply(args.db, :up)
       else
         abort "#{file} doesn't exist."
       end
@@ -103,14 +120,20 @@ namespace :db do
   namespace :test do
     desc "Recreate the test database from the current schema.rb"
     task :load => 'db:test:purge' do
-      Sequel.connect(Rails::Sequel::Database.configurations['test'])
-      Rake::Task['db:schema:load'].invoke
+      db = Rails::Sequel::Database.connect('test')
+      Rake::Task['db:schema:load'].invoke(db)
     end
 
+    desc 'Runs db:test:load'
+    task :prepare => :load
+
     desc 'Empty the test database'
     task :purge => :environment do
-      raise NotImplementedError
+      Rake::Task['db:drop'].invoke('test')
+      Rake::Task['db:create'].invoke('test')
     end
   end
 
 end
+
+task 'test:prepare' => 'db:test:prepare'

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rails3_sequel
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Rachot Moragraan
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-29 00:00:00 -07:00
+date: 2010-06-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sequel
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
         segments: 
         - 3
         - 11
@@ -38,11 +35,9 @@ dependencies:
   name: rails
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 222005035
         segments: 
         - 3
         - 0
@@ -70,6 +65,9 @@ files:
 - lib/rails/generators/sequel/migration/migration_generator.rb
 - lib/rails/generators/sequel/generated_attribute.rb
 - lib/rails/generators/sequel.rb
+- lib/rails3_sequel/adapters/mysql.rb
+- lib/rails3_sequel/adapters/sqlite.rb
+- lib/rails3_sequel/adapters/postgres.rb
 - lib/rails3_sequel/railtie.rb
 - lib/rails3_sequel/database.rb
 - lib/rails3_sequel/logging.rb
@@ -77,6 +75,7 @@ files:
 - lib/rails3_sequel/railties/log_subscriber.rb
 - lib/rails3_sequel.rb
 - lib/rails3_sequel/railties/database.rake
+- CHANGELOG
 - README.md
 - VERSION
 - LICENSE
@@ -90,27 +89,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Rails 3 integration with Sequel