rails3_sequel 0.1.0 → 0.2.0

data/README.md

@@ -1,16 +1,17 @@
 Rails 3 Sequel integration
 ==========================
 
-*What works so far:*
+Features:
 
 + Generators
-  - Models
-  - Migrations
-  - Observers
-  - Scaffolding Controllers - Sequel specific methods
+  - Models - models and migrations
+  - Migrations - for table alters
+  - Scaffold
+    - Controller uses Sequel specific methods.
+    - Views recognize migration data types.
 
 + Rake tasks
-  - mostly everything except anything that has to do with database creation (db:create, test:prepare, etc)
+  - mostly everything except db:test:prepare, db:setup, and db:create:all (should be ready next version)
 
 + Railties
   - uses database.yml configuration
@@ -26,18 +27,20 @@ Rails 3 Sequel integration
 + More testing
 + i18n
 + Session Store
++ Observers
 + more rake tasks
++ adapter specific after_create proc
 
 Installation
 ------------
 
-Build from the gem spec:
+    gem install rails3_sequel
 
-    gem build rails3_sequel.gemspec
+OR, in your Gemfile
 
-Install:
+    gem 'rails3_sequel'
 
-    gem install rails3_sequel-x.x.x.gem
+then run bundle install.
 
 Usage - Railties
 ----------------
@@ -64,30 +67,82 @@ Config options:
     config.loggers << Logger.new('test.log')
 
     # shortcut to log_warn_duration in Sequel
+    # you can also set this option in database.yml
     config.log_warn_duration
 
 These options may be useful in the production configuration file. Rails does not log any SQL in production mode, but you may want to still log long running queries or queries with errors (which are supported by Sequel).
 
-Rake tasks usage.... todo
+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
+    db:migrate
+      You know what this does.
+    db:migrate:up
+      Alias to db:migrate.
+    db:migrate:down
+      Define either VERSION or STEP. VERSION takes precedence if both are defined. STEP=1 if neither are defined.
+    db:migrate:redo
+      Migrates down 1 version, then runs db:migrate.
+    db:migrate:rollback
+      Alias to db:migrate:down. Can use VERSION and STEP also.
+    db:schema:dump
+      Uses Sequel's schema_dumper. Stores output in db/schema.rb.
+    db:schema:load
+      Does not work yet, but you can use just run the migrator on the schema file.
+    db:seed
+      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
+
+Please note that db:create currently only works with PostgreSQL, MySQL, and SQLite. If you have other DBs, please contribute if you can!
+
 
 Usage - Generators
 ------------------
 
 Basics:
 
+    rails g [scaffold, model, migration] <name> <field_name:data_type[:primary_key?]> [...]
+
+Example:
+
     rails g scaffold cat name:String:pk specie:String:pk age:Integer
 
-Will use name and specie as composite primary key.
+Will use name and specie as composite primary keys. Data types are as specified in Sequel's documentation, which means if you use Ruby's classes, Sequel will try to convert it for your particular database, otherwise, it will take the type as is. With that said, there are 2 special types that are not Ruby classes (mainly to help out with view scaffolding):
+    
+    Boolean - will use a TrueClass in your migration and a checkbox in your view.
+    Text    - will use a String with the :text option set to true and a text_area in your view.
+
+Example:
+
+   rails g scaffold cat name:String:pk description:Text ugly:Boolean location:geocode
 
+Note that the "location" field's type will not be translated and geocode will be used as the type in the database.
 
-Generator options (set in config/application.rb):
+
+Generator options (set in config/application.rb for defaults):
 
     config.generators do |g|
       g.orm :sequel, :autoincrement => true, :migration => true, :timestamps => false
+      ...
+    end
+
+The above will always generate migration files, with autoincrement/serial field named "id", but no automatic timstamp fields updated_at or created_at. Defaults are :autoincrement => false, :migration => :true, :timestamps => false. In the commandline, you can override these on a case-by-case basis.
+
+Example:
+    
+    rails g model dog name:String specie:String --autoincrement
+
+
+BUGS / ISSUES / QUESTIONS
+-------------------------
 
-The above will always generate migration files, with autoincrement/serial field named "id", but no automatic timstamp fields updated_at or created_at.
+Please feel free to email me with any issues or message me on github. janechii at gmail.
 
-more to come...
 
 License
 -------
@@ -98,3 +153,4 @@ Credits
 -------
 
 Based partially on rails_sequel by Piotr Usewicz: http://github.com/pusewicz/rails_sequel
+Thanks to ActiveRecord's and dm-rails' railties

data/lib/rails3_sequel/database.rb

@@ -1,7 +1,7 @@
 module Rails
   module Sequel
     module Database    
-      mattr_reader :configurations
+      mattr_reader :configurations, :db
 
       def self.configurations= (config)
         @@configurations = config
@@ -16,10 +16,107 @@ module Rails
         end
       end
 
-      # Connects to database using constructed Database Connection URI
-      def self.connect
-        ::Sequel.connect(self.configurations[Rails.env])
+      # 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 << self
+        private
+
+        def adapter
+          a = configurations[Rails.env]['adapter'].camelize.to_sym
+
+          unless const_defined?(a)
+            raise "Adapter #{a} not supported."
+          end
+
+          const_get(a)
+        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
+            )
+          })
+        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}"
+        end
+
+        def drop_database (name)
+          begin
+            @db.execute "DROP DATABASE #{name}"
+          rescue Sequel::DatabaseError
+            raise 'Cannot drop database'
+          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 
+        end
+
+        def drop_database (name)
+          @db.execute "DROP DATABASE IF EXISTS `#{name}`"
+        end
+      end
+
+      class Sqlite
+        def initialize
+          Rails::Sequel::Database.connect
+        end
+
+        def create_database (*args)
+        end
+
+        def drop_database (*args)
+        end
+      end
+
     end
   end
 end

data/lib/rails3_sequel/logging.rb

@@ -9,7 +9,7 @@ module Rails
           :name => 'SQL',
           :duration => duration * 1000
         )
-        super(duration, message)
+        super
       end
 
       def log_each (level, message)

data/lib/rails3_sequel/railties/database.rake

@@ -24,12 +24,13 @@ namespace :db do
 
   namespace :create do
     task :all do
+      # cant choose which db to create yet.
       puts 'Pending implementation'
     end
   end
 
-  task :create do
-    puts 'Pending implementation'
+  task :create => :environment do
+    Rails::Sequel::Database.create_database
   end
 
   namespace :migrate do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rachot Moragraan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-19 00:00:00 -07:00
+date: 2010-05-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency