Sinatra ActiveRecord Extension

The official fork is now at: http://github.com/janko-m/sinatra-activerecord

This one is now closed.

---

Extends Sinatra with a extension methods and Rake tasks for dealing with a SQL database using the ActiveRecord ORM.

Install the sinatra-activerecord gem along with one of the database adapters:

sudo gem install activerecord
sudo gem install sinatra-activerecord -s http://gemcutter.org
sudo gem install sqlite3
sudo gem install mysql
sudo gem install postgres

adding this to your Rakefile

# require your app file first
require 'sinatra-ar-exmple-app'
require 'sinatra/activerecord/rake'

In terminal, test that it works

$ rake -T
rake db:create_migration  # create an ActiveRecord migration in ./db/migrate
rake db:migrate           # migrate your database

Now you can create a migration

$ rake db:create_migration NAME=create_foos

This will create a migration file in ./db/migrate, ready for editing

class CreateFoos < ActiveRecord::Migration
  def self.up
    create_table :foos do |t|
      t.string :name
    end
  end

  def self.down
    drop_table :foos
  end
end

run the migration

$ rake db:migrate

I like to split models out into a separate database.rb file and then require it from the main app file, but you can plop the following code in about anywhere and it'll work just fine:

require 'sinatra'
require 'sinatra/activerecord'

# Establish the database connection; or, omit this and use the DATABASE_URL
# environment variable or the default sqlite://<environment>.db as the connection string:
set :database, 'sqlite://foo.db'

# At this point, you can access the ActiveRecord::Base class using the
# "database" object:
puts "the foos table doesn't exist" if !database.table_exists?('foos')

# models just work ...
class Foo < ActiveRecord::Base
end

# see:
Foo.all

# access the models within the context of an HTTP request
get '/foos/:id' do
  @foo = Foo.find(params[:id])
  erb :foos
end

NOTE about the rip-off

This Code and README.md is a heavy adaption of rtomayko's sinatra-sequel

Copyright (c) 2009 Blake Mizerany

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.