sinatra-activerecord 0.1.3 → 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Janko Marohnić
+
+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.

data/README.md

@@ -1,98 +1,131 @@
-Sinatra ActiveRecord Extension
-========================
+# Sinatra ActiveRecord Extension
 
-Extends [Sinatra](http://www.sinatrarb.com/) with a extension methods and Rake
-tasks for dealing with a SQL database using the [ActiveRecord ORM](http://api.rubyonrails.org/).
+## About
 
-Install the `sinatra-activerecord` gem along with one of the database adapters:
+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).
 
-    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
+## Instructions
 
-adding this to your `Rakefile`
+First, put the gem into your `Gemfile` (or install it manually):
 
-    # require your app file first
-    require 'sinatra-ar-exmple-app'
-    require 'sinatra/activerecord/rake'
+```ruby
+gem 'sinatra-activerecord'
+```
 
-    $ rake -T
-    rake db:create_migration  # create an ActiveRecord migration in ./db/migrate
-    rake db:migrate           # migrate your database
+Also put one of the database adapters into your `Gemfile` (or install
+them manually):
 
-create a migration
+- `sqlite3` (SQLite)
+- `mysql` (MySQL)
+- `pg` (PostgreSQL)
 
-    $ rake db:create_migration NAME=create_foos
-    $ vim db/migrate/20090922043513_create_foos.rb
+Then require the rake tasks and your app in your `Rakefile`:
 
-    class CreateFoos < ActiveRecord::Migration
-      def self.up
-        create_table :foos do |t|
-          t.string :name
-        end
-      end
+```ruby
+require 'sinatra/activerecord/rake'
+require './app'
+```
 
-      def self.down
-      end
+In the 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_users
+```
+
+This will create a migration file in the `./db/migrate` folder, ready for editing.
+
+```ruby
+class CreateUsers < ActiveRecord::Migration
+  def up
+    create_table :users do |t|
+      t.string :name
     end
+  end
 
-run the migration
+  def down
+    drop_table :users
+  end
+end
+```
 
-    $ rake db:migrate
+After you've written the migration, migrate the database:
 
-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:
+```
+$ rake db:migrate
+```
 
-    require 'sinatra'
-    require 'sinatra/activerecord'
+You can then also write the model:
 
-    # 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'
+```ruby
+class User < ActiveRecord::Base
+  validates_presence_of :name
+end
+```
 
-    # 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')
+You can put the models anywhere. It's probably best to put them in an
+external file, and require them in your `app.rb` aftewards. Usually
+models in Sinatra aren't that complex, so you can put them all in one
+file, for example `./db/models.rb`.
 
-    # models just work ...
-    class Foo < ActiveRecord::Base
-    end
+Now just establish the database connection in your `app.rb`
+(let's assume you chose the `sqlite3` adapter), and
+require the models if necessary:
 
-    # see:
-    Foo.all
+```ruby
+# app.rb
+require 'sinatra'
+require 'sinatra/activerecord'
 
-    # access the models within the context of an HTTP request
-    get '/foos/:id' do
-      @foo = Foo.find(params[:id])
-      erb :foos
-    end
+require './db/models'
+
+set :database, 'sqlite://foo.db'
+```
+
+Now everything just works:
+
+```ruby
+get '/users' do
+  @users = User.all
+  erb :index
+end
+
+get '/users/:id' do
+  @user = User.find(params[:id])
+  erb :show
+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:
+
+```ruby
+if database.table_exists?('users')
+  # Do stuff
+else
+  raise "The table 'users' doesn't exist."
+end
+```
 
-### NOTE about the rip-off
+## Changelog
 
-  This Code and README.md is a heavy adaption of [rtomayko's sinatra-sequel](http://github.com/rtomayko/sinatra-sequel/)
+You can see the changelog
+[here](https://github.com/janko-m/sinatra-activerecord/blob/master/CHANGELOG.md).
 
-Copyright (c) 2009 Blake Mizerany
+## History
 
-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:
+This gem was made in 2009 by Blake Mizerany, one of the authors of Sinatra.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+## License
 
-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.
+[MIT](https://github.com/janko-m/sinatra-activerecord/blob/master/LICENSE)

data/lib/sinatra/activerecord.rb

@@ -1,5 +1,3 @@
-require 'uri'
-require 'time'
 require 'sinatra/base'
 require 'active_record'
 require 'logger'
@@ -13,48 +11,27 @@ module Sinatra
 
   module ActiveRecordExtension
     def database=(url)
-      @database = nil
       set :database_url, url
       database
     end
 
     def database
-      @database ||= (
-        url = URI(database_url)
+      @database ||= begin
         ActiveRecord::Base.logger = activerecord_logger
-        ActiveRecord::Base.establish_connection(database_options)
+        ActiveRecord::Base.establish_connection(database_url.sub(/^sqlite/, "sqlite3"))
         ActiveRecord::Base
-      )
+      end
     end
 
   protected
 
-    def database_options
-      url = URI(database_url)
-      options = {
-        :adapter => url.scheme,
-        :host => url.host,
-        :port => url.port,
-        :database => url.path[1..-1],
-        :username => url.user,
-        :password => url.password
-      }
-      case url.scheme
-      when "sqlite"
-        options[:adapter] = "sqlite3"
-        options[:database] = url.host
-      when "postgres"
-        options[:adapter] = "postgresql"
-      end
-      options.merge(database_extras)
-    end
-
     def self.registered(app)
-      app.set :database_url, lambda { ENV['DATABASE_URL'] || "sqlite://#{environment}.db" }
-      app.set :database_extras, Hash.new
       app.set :activerecord_logger, Logger.new(STDOUT)
-      app.database # force connection
       app.helpers ActiveRecordHelper
+
+      # re-connect if database connection dropped
+      app.before { ActiveRecord::Base.verify_active_connections! }
+      app.after  { ActiveRecord::Base.clear_active_connections! }
     end
   end
 

data/lib/sinatra/activerecord/rake.rb

@@ -1,37 +1 @@
-require 'active_record'
-require 'fileutils'
-
-namespace :db do
-  desc "migrate your database"
-  task :migrate do
-    ActiveRecord::Migrator.migrate(
-      'db/migrate', 
-      ENV["VERSION"] ? ENV["VERSION"].to_i : nil
-    )
-  end
-
-  desc "create an ActiveRecord migration in ./db/migrate"
-  task :create_migration do
-    name = ENV['NAME']
-    abort("no NAME specified. use `rake db:create_migration NAME=create_users`") if !name
-
-    migrations_dir = File.join("db", "migrate")
-    version = ENV["VERSION"] || Time.now.utc.strftime("%Y%m%d%H%M%S") 
-    filename = "#{version}_#{name}.rb"
-    migration_name = name.gsub(/_(.)/) { $1.upcase }.gsub(/^(.)/) { $1.upcase }
-
-    FileUtils.mkdir_p(migrations_dir)
-
-    open(File.join(migrations_dir, filename), 'w') do |f|
-      f << (<<-EOS).gsub("      ", "")
-      class #{migration_name} < ActiveRecord::Migration
-        def self.up
-        end
-
-        def self.down
-        end
-      end
-      EOS
-    end
-  end
-end
+load 'sinatra/activerecord/rake_tasks.rake'

data/lib/sinatra/activerecord/rake_tasks.rake

@@ -0,0 +1,44 @@
+require 'active_record'
+require 'active_support/core_ext/string/strip'
+require 'fileutils'
+
+namespace :db do
+  desc "create an ActiveRecord migration in ./db/migrate"
+  task :create_migration do
+    name = ENV['NAME']
+    if name.nil?
+      raise "No NAME specified. Example usage: `rake db:create_migration NAME=create_users`"
+    end
+
+    migrations_dir = File.join("db", "migrate")
+    version = ENV["VERSION"] || Time.now.utc.strftime("%Y%m%d%H%M%S")
+    filename = "#{version}_#{name}.rb"
+    migration_class = name.split("_").map(&:capitalize).join
+
+    FileUtils.mkdir_p(migrations_dir)
+
+    File.open(File.join(migrations_dir, filename), 'w') do |file|
+      file.write <<-MIGRATION.strip_heredoc
+        class #{migration_class} < ActiveRecord::Migration
+          def up
+          end
+
+          def down
+          end
+        end
+      MIGRATION
+    end
+  end
+
+  desc "migrate the database (use version with VERSION=n)"
+  task :migrate do
+    version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+    ActiveRecord::Migrator.migrate('db/migrate', version)
+  end
+
+  desc "rolls back the migration (use steps with STEP=n)"
+  task :rollback do
+    step = ENV["STEP"] ? ENV["STEP"].to_i : 1
+    ActiveRecord::Migrator.rollback('db/migrate', step)
+  end
+end

metadata

@@ -1,88 +1,111 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sinatra-activerecord
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
 platform: ruby
-authors: 
-- Blake Mizerany
+authors:
+- Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-09-21 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sinatra
+  requirement: &70294476610880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *70294476610880
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70294476607980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 9
-        - 4
-        version: 0.9.4
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-description: Extends Sinatra with activerecord helpers for instant activerecord use
-email: blake.mizerany@gmail.com
+  prerelease: false
+  version_requirements: *70294476607980
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70294476606740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70294476606740
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70294476621660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70294476621660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70294476618440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: *70294476618440
+description: Extends Sinatra with ActiveRecord helpers.
+email: janko.marohnic@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.md
-files: 
-- README.md
-- lib/sinatra/activerecord.rb
+extra_rdoc_files: []
+files:
 - lib/sinatra/activerecord/rake.rb
-- sinatra-activerecord.gemspec
-has_rdoc: true
-homepage: http://github.com/rtomayko/sinatra-activerecord
-licenses: []
-
+- lib/sinatra/activerecord/rake_tasks.rake
+- lib/sinatra/activerecord.rb
+- README.md
+- LICENSE
+homepage: http://github.com/janko-m/sinatra-activerecord
+licenses:
+- MIT
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Sinatra::ActiveRecord
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 4034299485721175520
 requirements: []
-
-rubyforge_project: bmizerany
-rubygems_version: 1.5.2
+rubyforge_project: 
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 2
-summary: Extends Sinatra with activerecord helpers for instant activerecord use
+specification_version: 3
+summary: Extends Sinatra with ActiveRecord helpers.
 test_files: []
-

data/sinatra-activerecord.gemspec

@@ -1,33 +0,0 @@
-Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-
-  s.name = 'sinatra-activerecord'
-  s.version = '0.1.3'
-  s.date = '2009-09-21'
-
-  s.description = "Extends Sinatra with activerecord helpers for instant activerecord use"
-  s.summary = s.description
-
-  s.authors = ["Blake Mizerany"]
-  s.email = "blake.mizerany@gmail.com"
-
-  # = MANIFEST =
-  s.files = %w[
-    README.md
-    lib/sinatra/activerecord.rb
-    lib/sinatra/activerecord/rake.rb
-    sinatra-activerecord.gemspec
-  ]
-  # = MANIFEST =
-
-  s.extra_rdoc_files = %w[README.md]
-  s.add_dependency 'sinatra',    '>= 0.9.4'
-
-  s.has_rdoc = true
-  s.homepage = "http://github.com/rtomayko/sinatra-activerecord"
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sinatra::ActiveRecord"]
-  s.require_paths = %w[lib]
-  s.rubyforge_project = 'bmizerany'
-  s.rubygems_version = '1.1.1'
-end