sinatra-activerecord 0.1.0

data/README.md

@@ -0,0 +1,94 @@
+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/).
+
+Install the `sinatra-activerecord` gem along with one of the database adapters:
+
+    sudo gem install activerecord
+    sudo gem install sinatra-activerecord -s http://gems.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'
+
+    $ rake -T
+    rake db:create_migration  # create an ActiveRecord migration in ./db/migrate
+    rake db:migrate           # migrate your database
+
+create a migration
+
+    $ rake db:create_migration NAME=create_foos
+    $ vim db/migrate/20090922043513_create_foos.rb
+
+    class CreateFoos < ActiveRecord::Migration
+      def self.up
+        create_table :foos do |t|
+          t.string :name
+        end
+      end
+
+      def self.down
+      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
+
+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.

data/lib/sinatra/activerecord/rake.rb

@@ -0,0 +1,37 @@
+require 'activerecord'
+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

data/lib/sinatra/activerecord.rb

@@ -0,0 +1,61 @@
+require 'uri'
+require 'time'
+require 'sinatra/base'
+require 'active_record'
+require 'logger'
+
+module Sinatra
+  module ActiveRecordHelper
+    def database
+      options.database
+    end
+  end
+
+  module ActiveRecordExtension
+    def database=(url)
+      @database = nil
+      set :database_url, url
+      database
+    end
+
+    def database
+      @database ||= (
+        url = URI(database_url)
+        ActiveRecord::Base.logger = activerecord_logger
+        ActiveRecord::Base.establish_connection(database_options)
+        ActiveRecord::Base
+      )
+    end
+
+  protected
+
+    def database_options
+      url = URI(database_url)
+      if url.scheme == "sqlite"
+        {
+          :adapter => "sqlite3",
+          :database => url.host
+        }
+      else
+        {
+          :adapter => url.scheme,
+          :host => url.host,
+          :port => url.port,
+          :database => url.path[1..-1],
+          :username => url.user,
+          :password => url.password
+        }
+      end.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
+    end
+  end
+
+  register ActiveRecordExtension
+end

data/sinatra-activerecord.gemspec

@@ -0,0 +1,33 @@
+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.0'
+  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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-activerecord
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Blake Mizerany
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+description: Extends Sinatra with activerecord helpers for instant activerecord use
+email: blake.mizerany@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- lib/sinatra/activerecord.rb
+- lib/sinatra/activerecord/rake.rb
+- sinatra-activerecord.gemspec
+has_rdoc: true
+homepage: http://github.com/rtomayko/sinatra-activerecord
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sinatra::ActiveRecord
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bmizerany
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 2
+summary: Extends Sinatra with activerecord helpers for instant activerecord use
+test_files: []
+