sinatra-sequel 0.9.0

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Ryan Tomayko <tomayko.com/about>
+
+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 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

@@ -0,0 +1,84 @@
+Sinatra Sequel Extension
+========================
+
+Extends [Sinatra](http://www.sinatrarb.com/) with a variety of extension methods
+for dealing with a SQL database using the [Sequel ORM](http://sequel.rubyforge.org/).
+
+Install the `sinatra-sequel` gem along with one of the database adapters:
+
+    sudo gem install sequel sinatra-sequel
+    sudo gem install sqlite3
+    sudo gem install mysql
+    sudo gem install postgres
+
+I like to split database configuration and migrations 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/sequel'
+
+    # Establish the database connection; or, omit this and use the DATABASE_URL
+    # environment variable as the connection string:
+    set :database, 'sqlite://foo.db'
+
+    # At this point, you can access the Sequel Database object using the
+    # "database" object:
+    puts "the foos table doesn't exist" if !database.table_exists?('foos')
+
+    # define database migrations. pending migrations are run at startup and
+    # are guaranteed to run exactly once per database.
+    migration "create teh foos table" do
+      database.create_table :foos do
+        primary_key :id
+        text        :bar
+        integer     :baz, :default => 42
+        timestamp   :bizzle, :null => false
+
+        index :baz, :unique => true
+      end
+    end
+
+    # you can also alter tables
+    migration "everything's better with bling" do
+      database.alter_table :foos do
+        drop_column :baz
+        add_column :bling, :float
+      end
+    end
+
+    # models just work ...
+    class Foo < Sequel::Model
+      many_to_one :bar
+    end
+
+    # see:
+    Foo.filter(:baz => 42).each { |foo| puts(foo.bar.name) }
+
+    # access the database within the context of an HTTP request
+    get '/foos/:id' do
+      @foo = database[:foos].filter(:id => params[:id]).first
+      erb :foos
+    end
+
+    # or, using the model
+    delete '/foos/:id' do
+      @foo = Foo[params[:id]]
+      @foo.delete
+    end
+
+### Sequel Reference Material
+
+  * The [Sequel README](http://sequel.rubyforge.org/rdoc/files/README_rdoc.html)
+    and [CHEATSHEET](http://sequel.rubyforge.org/rdoc/files/doc/cheat_sheet_rdoc.html)
+    are quite useful.
+
+  * Migrations are a light facade over Sequel's
+    [Schema module](http://sequel.rubyforge.org/rdoc/files/doc/schema_rdoc.html).
+    Like, [create_table](http://sequel.rubyforge.org/rdoc/classes/Sequel/Schema/Generator.html)
+    and [alter_table](http://sequel.rubyforge.org/rdoc/classes/Sequel/Schema/AlterTableGenerator.html).
+
+  * The best reference on Sequel Models is [the README](http://sequel.rubyforge.org/rdoc/files/README_rdoc.html)
+    and the [Associations](http://sequel.rubyforge.org/rdoc/files/doc/advanced_associations_rdoc.html) doc.
+    You might find this post on [many_to_many / one_to_one](http://steamcode.blogspot.com/2009/03/sequel-models-manytoone-onetomany.html)
+    useful.

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rake/clean'
+
+task :default => :spec
+
+desc 'Run specs'
+task :spec do
+  sh 'bacon -a'
+end
+
+# PACKAGING ============================================================
+
+# Load the gemspec using the same limitations as github
+require 'rubygems/specification'
+$spec = eval(File.read('sinatra-sequel.gemspec'))
+
+def package(ext='')
+  "pkg/#{$spec.name}-#{$spec.version}" + ext
+end
+
+desc 'Build packages'
+task :package => %w[.gem .tar.gz].map { |ext| package(ext) }
+
+desc 'Build and install as local gem'
+task :install => package('.gem') do
+  sh "gem install #{package('.gem')}"
+end
+
+directory 'pkg/'
+CLOBBER.include('pkg')
+
+file package('.gem') => %W[pkg/ #{$spec.name}.gemspec] + $spec.files do |f|
+  sh "gem build #{$spec.name}.gemspec"
+  mv File.basename(f.name), f.name
+end
+
+file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
+  sh <<-SH
+    git archive \
+      --prefix=#{$spec.name}-#{$spec.version}/ \
+      --format=tar \
+      HEAD | gzip > #{f.name}
+  SH
+end
+
+# Rubyforge Release / Publish Tasks ==================================
+
+desc 'Publish gem and tarball to rubyforge'
+task 'release' => [package('.gem'), package('.tar.gz')] do |t|
+  sh <<-SH
+    rubyforge add_release wink #{$spec.name} #{$spec.version} #{package('.gem')} &&
+    rubyforge add_file    wink #{$spec.name} #{$spec.version} #{package('.tar.gz')}
+  SH
+end
+
+# rebuild the gemspec manifest and update timestamps.
+task "#{$spec.name}.gemspec" => FileList['{lib,spec}/**','Rakefile','COPYING','README.md'] do |f|
+  # read spec file and split out manifest section
+  spec = File.read(f.name)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+  # replace version and date
+  head.sub!(/\.date = '.*'/, ".date = '#{Date.today.to_s}'")
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject{ |file| file =~ /^\./ }.
+    reject { |file| file =~ /^doc/ }.
+    map{ |file| "    #{file}" }.
+    join("\n")
+  # piece file back together and write...
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head,manifest,tail].join("  # = MANIFEST =\n")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "updated #{f.name}"
+end

data/lib/sinatra/sequel.rb

@@ -0,0 +1,62 @@
+require 'time'
+require 'sinatra/base'
+require 'sequel'
+
+module Sinatra
+  module SequelHelper
+    def database
+      options.database
+    end
+  end
+
+  module SequelExtension
+    def database=(url)
+      @database = nil
+      set :database_url, url
+      database
+    end
+
+    def database
+      @database ||=
+        Sequel.connect(database_url)
+    end
+
+    def sqlite?
+      defined?(Sequel::SQLite::Database) && database.kind_of?(Sequel::SQLite::Database)
+    end
+
+    # TODO: wrong!
+    def postgres?
+      ! sqlite?
+    end
+
+    def migration(name, &block)
+      create_migrations_table
+      return if database[migrations_table_name].filter(:name => name).count > 0
+      migrations_log.puts "Running migration: #{name}"
+      database.transaction do
+        yield database
+        database[migrations_table_name] << { :name => name, :ran_at => Time.now }
+      end
+    end
+
+  protected
+
+    def create_migrations_table
+      database.create_table? :migrations do
+        primary_key :id
+        text :name, :null => false, :index => true
+        timestamp :ran_at
+      end
+    end
+
+    def self.registered(app)
+      app.set :database_url, lambda { ENV['DATABASE_URL'] || "sqlite://#{environment}.db" }
+      app.set :migrations_table_name, :migrations
+      app.set :migrations_log, lambda { STDOUT }
+      app.helpers SequelHelper
+    end
+  end
+
+  register SequelExtension
+end

data/sinatra-sequel.gemspec

@@ -0,0 +1,39 @@
+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-sequel'
+  s.version = '0.9.0'
+  s.date = '2009-08-08'
+
+  s.description = "Extends Sinatra with Sequel ORM config, migrations, and helpers"
+  s.summary = s.description
+
+  s.authors = ["Ryan Tomayko"]
+  s.email = "rtomayko@gmail.com"
+
+  # = MANIFEST =
+  s.files = %w[
+    COPYING
+    README.md
+    Rakefile
+    lib/sinatra/sequel.rb
+    sinatra-sequel.gemspec
+    spec/spec_sinatra_sequel.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select {|path| path =~ /^spec\/.*.rb/ }
+
+  s.extra_rdoc_files = %w[README.md COPYING]
+  s.add_dependency 'sinatra',    '>= 0.9.4'
+  s.add_dependency 'sequel',     '>= 3.2.0'
+  s.add_development_dependency 'bacon'
+
+  s.has_rdoc = true
+  s.homepage = "http://github.com/rtomayko/sinatra-sequel"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sinatra::Sequel"]
+  s.require_paths = %w[lib]
+  s.rubyforge_project = 'wink'
+  s.rubygems_version = '1.1.1'
+end

data/spec/spec_sinatra_sequel.rb

@@ -0,0 +1,58 @@
+root = File.expand_path(File.dirname(__FILE__) + '/..') 
+$: << "#{root}/lib"
+
+require 'sinatra/base'
+require 'sinatra/sequel'
+
+class MockSinatraApp < Sinatra::Base
+  register Sinatra::SequelExtension
+end
+
+describe 'A Sinatra app with Sequel extensions' do
+  before {
+    File.unlink 'test.db' rescue nil
+    ENV.delete('DATABASE_URL')
+    @app = Class.new(MockSinatraApp)
+    @app.set :migrations_log, File.open('/dev/null', 'wb')
+  }
+
+  it 'exposes the Sequel database object' do
+    @app.should.respond_to :database
+  end
+
+  it 'uses the DATABASE_URL environment variable if set' do
+    ENV['DATABASE_URL'] = 'sqlite://test-database-url.db'
+    @app.database_url.should.equal 'sqlite://test-database-url.db'
+  end
+
+  it 'uses sqlite://<environment>.db when no DATABASE_URL is defined' do
+    @app.environment = :foo
+    @app.database_url.should.equal "sqlite://foo.db"
+  end
+
+  it 'establishes a database connection when set' do
+    @app.database = 'sqlite://test.db'
+    @app.database.should.respond_to :table_exists?
+  end
+
+  it 'runs database migrations' do
+    @app.database = 'sqlite://test.db'
+    @app.migration 'create the foos table' do |db|
+      db.create_table :foos do
+        primary_key :id
+        text :foo
+        integer :bar
+      end
+    end
+
+    @app.database[:migrations].count.should.equal 1
+    @app.database.should.table_exists :foos
+  end
+
+  it 'does not run database migrations more than once' do
+    @app.database = 'sqlite://test.db'
+    @app.migration('this should run once') { }
+    @app.migration('this should run once') { fail }
+    @app.database[:migrations].count.should.equal 1
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-sequel
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Ryan Tomayko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-08 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: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Extends Sinatra with Sequel ORM config, migrations, and helpers
+email: rtomayko@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- COPYING
+files: 
+- COPYING
+- README.md
+- Rakefile
+- lib/sinatra/sequel.rb
+- sinatra-sequel.gemspec
+- spec/spec_sinatra_sequel.rb
+has_rdoc: true
+homepage: http://github.com/rtomayko/sinatra-sequel
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sinatra::Sequel
+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: wink
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 2
+summary: Extends Sinatra with Sequel ORM config, migrations, and helpers
+test_files: 
+- spec/spec_sinatra_sequel.rb