sinatra-activerecord 1.1.2 → 1.2.0

data/README.md

@@ -1,91 +1,86 @@
 # Sinatra ActiveRecord Extension
 
-## About
-
 Extends [Sinatra](http://www.sinatrarb.com/) with extension methods and Rake
 tasks for dealing with an SQL database using the
 [ActiveRecord ORM](https://github.com/rails/rails/tree/master/activerecord).
 
-## Instructions
+## Setup
 
-First, put the gem into your `Gemfile` (or install it manually):
+Put it in your `Gemfile`, along with the adapter of your database. For
+simplicity, let's assume you're using SQLite:
 
 ```ruby
-gem 'sinatra-activerecord'
+gem "sinatra-activerecord"
+gem "sqlite3"
 ```
 
-Also put one of the database adapters into your `Gemfile` (or install
-them manually):
-
-- `sqlite3` (SQLite)
-- `mysql` (MySQL)
-- `pg` (PostgreSQL)
-
-Now specify the database in your `app.rb`
-(let's assume you chose the `sqlite3` adapter):
+Now require it in your Sinatra application, and establish the database
+connection:
 
 ```ruby
-# app.rb
-require 'sinatra'
-require 'sinatra/activerecord'
+require "sinatra/activerecord"
 
-set :database, 'sqlite3:///foo.db'
+set :database, "sqlite3:///foo.sqlite3"
 ```
 
-Note that the database URL here has **3** slashes. This is the difference from
-<= 1.0.0 versions, where it was typed with 2 slashes.
+Alternatively, you can set the database with a hash or a YAML file. Take a look at
+[this wiki](https://github.com/janko-m/sinatra-activerecord/wiki/Alternative-database-setup).
 
-Also note that in **modular** Sinatra applications (ones in which you explicitly
-subclass `Sinatra::Base`), you will need to manually add the line:
+Note that in **modular** Sinatra applications you will need to first register
+the extension:
 
 ```ruby
-register Sinatra::ActiveRecordExtension
+class YourApplication < Sinatra::Base
+  register Sinatra::ActiveRecordExtension
+end
 ```
 
 Now require the rake tasks and your app in your `Rakefile`:
 
 ```ruby
-require 'sinatra/activerecord/rake'
-require './app'
+require "sinatra/activerecord/rake"
+require "./app"
 ```
 
 In the Terminal test that it works:
 
 ```sh
 $ rake -T
-rake db:create_migration  # create an ActiveRecord migration in ./db/migrate
-rake db:migrate           # migrate your database
+rake db:create_migration  # create an ActiveRecord migration
+rake db:migrate           # migrate the database (use version with VERSION=n)
+rake db:rollback          # roll back the migration (use steps with STEP=n)
 ```
 
-Now you can create a migration:
+And that's it, you're all set :)
+
+## Usage
+
+You can create a migration:
 
 ```sh
 $ rake db:create_migration NAME=create_users
 ```
 
-This will create a migration file in the `./db/migrate` folder, ready for editing.
+This will create a migration file in your migrations directory (`./db/migrate`
+by default), ready for editing.
 
 ```ruby
 class CreateUsers < ActiveRecord::Migration
-  def up
+  def change
     create_table :users do |t|
       t.string :name
     end
   end
-
-  def down
-    drop_table :users
-  end
 end
 ```
 
-After you've written the migration, migrate the database:
+Now migrate the database:
 
 ```sh
 $ rake db:migrate
 ```
 
-You can then also write the model:
+You can also write models:
 
 ```ruby
 class User < ActiveRecord::Base
@@ -93,10 +88,9 @@ class User < ActiveRecord::Base
 end
 ```
 
-You can put the models anywhere. It's probably best to put them in an
-external file, and require them in your `app.rb`. Usually
-models in Sinatra aren't that complex, so you can put them all in one
-file, for example `./db/models.rb`.
+You can put your models anywhere you want. If you put them in a separate file,
+just remember to require the file, and to load the models **after** requiring
+`"sinatra/activerecord"`.
 
 Now everything just works:
 
@@ -113,8 +107,7 @@ end
 ```
 
 A nice thing is that the `ActiveRecord::Base` class is available to
-you through the `database` variable. This means that you can write something
-like this:
+you through the `database` variable:
 
 ```ruby
 if database.table_exists?('users')
@@ -124,14 +117,9 @@ else
 end
 ```
 
-## Changelog
-
-You can see the changelog
-[here](https://github.com/janko-m/sinatra-activerecord/blob/master/CHANGELOG.md).
-
 ## History
 
-This gem was made in 2009 by Blake Mizerany, one of the authors of Sinatra.
+This gem was made in 2009 by Blake Mizerany, creator of Sinatra.
 
 ## Social
 

data/lib/sinatra/activerecord/rake.rb

@@ -44,7 +44,7 @@ module Sinatra
     private
 
     def migrations_dir
-      "db/migrate"
+      ActiveRecord::Migrator.migrations_paths.first
     end
 
     def silence_activerecord(&block)

data/lib/sinatra/activerecord/tasks.rake

@@ -1,7 +1,7 @@
 require 'rake'
 
 namespace :db do
-  desc "create an ActiveRecord migration in ./db/migrate"
+  desc "create an ActiveRecord migration"
   task :create_migration do
     Sinatra::ActiveRecordTasks.create_migration(ENV["NAME"], ENV["VERSION"])
   end

data/lib/sinatra/activerecord.rb

@@ -20,18 +20,35 @@ module Sinatra
     def database
       @database ||= begin
         ActiveRecord::Base.logger = activerecord_logger
-        spec = resolve_spec(database_url)
-        ActiveRecord::Base.establish_connection(spec)
+        ActiveRecord::Base.establish_connection(resolve_spec(database_url))
+        ActiveRecord::Base.connection
         ActiveRecord::Base
       end
     end
 
-  protected
+    def database_file=(path)
+      require 'pathname'
+
+      return if app_file.nil?
+      path = File.join(app_file, path) if Pathname.new(path).relative?
+
+      if File.exists?(path)
+        require 'yaml'
+        require 'erb'
+
+        database_hash = YAML.load(ERB.new(File.read(path)).result) || {}
+        database_hash = database_hash[environment] if database_hash[environment]
+        set :database, database_hash
+      end
+    end
+
+    protected
 
     def self.registered(app)
       app.set :activerecord_logger, Logger.new(STDOUT)
       app.set :database_url, ENV['DATABASE_URL']
-      app.database if ENV['DATABASE_URL'] # Force connection if DATABASE_URL is set
+      app.set :database_file, "config/database.yml"
+      app.database if app.database_url
       app.helpers ActiveRecordHelper
 
       # re-connect if database connection dropped
@@ -39,11 +56,11 @@ module Sinatra
       app.after  { ActiveRecord::Base.clear_active_connections! }
     end
 
-  private
+    private
 
     def resolve_spec(database_url)
       if database_url.is_a?(String)
-        if database_url =~ %r{^sqlite3?://[A-Za-z_-]+\.(db|sqlite3?)$}
+        if database_url =~ %r{^sqlite3?://[^/]+$}
           warn <<-MESSAGE.strip_heredoc
             It seems your database URL looks something like this: "sqlite3://<database_name>".
             This doesn't work anymore, you need to use 3 slashes, like this: "sqlite3:///<database_name>".

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
+- Blake Mizerany
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2180039102864061955
+      hash: -4164762021753065434
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23