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
  - Models - models and migrations
  - Migrations - for table alters
  - Scaffold
    - Controller uses Sequel specific methods.
    - Views recognize migration data types.

+ Rake tasks

+ Railties
  - uses database.yml configuration
  - db connection
  - query logging
  - controller logging
  - sane default sequel options and plugins for Rails

+ Gemspec

*What is still need done:*

+ Write tests
+ i18n
+ Session Store
+ Observers
+ more rake tasks
+ adapter specific encoding / charset options
+ namespaced config (config.sequel.xxxx)

Installation
------------

    gem install rails3_sequel

OR, in your Gemfile

    gem 'rails3_sequel'

then run bundle install.

Please see the note at the top of this README for what version you should use.

Usage - Railties
----------------

In your config/application.rb, take out the require "all" line and choose what frameworks you want to include like this:

    require "action_controller/railtie"
    require "action_mailer/railtie"
    require "active_resource/railtie"
    require "rails/test_unit/railtie"

    # most importantly :)
    require 'rails3_sequel/railtie'

This way Rails wont load activerecord.

Config options:

    # set false to turn off Rails SQL logging
    # true by default
    config.rails_fancy_pants_logging = false

    # specify your own loggers
    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:

    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. 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
      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
      Uses Sequel's migration. Reads from db/schema.rb.
    db:seed
      Load the seed data from db/seeds.rb.
    db:version
      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!


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 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 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
-------------------------

Please feel free to email me with any issues or message me on github. janechii at gmail.


License
-------

MIT

Credits
-------

+ Piotr Usewicz for rails_sequel (http://github.com/pusewicz/rails_sequel)
+ Jeremy Evans for Sequel and pointers he gave for this plugin
+ Many thanks to ActiveRecord's and dm-rails' railties, and everyone at Rails 3 team for making this even possible