sequel 0.1.9.6 → 0.1.9.7

data/CHANGELOG

@@ -1,4 +1,20 @@
-=== 0.2 (2007-08-13)
+=== 0.1.9.7 (2007-08-15)
+
+* Added suppoort for executing batch statements in sqlite adapter.
+
+* Changed #current_page_record_range to return 0..0 for an invalid page.
+
+* Fixed joining of aliased tables.
+
+* Improved Symbol#to_field_name to prevent false positives.
+
+* Implemented Dataset#multi_insert with :commit_every option.
+
+* More docs for Dataset#set_model.
+
+* Implemented automatic creation of convenience methods for each adapter (e.g. Sequel.sqlite etc.)
+
+=== 0.1.9.6 (2007-08-13)
 
 * Refactored schema definition code. Gets rid of famous primary_key problem as well as other issues (e.g. issue #22).
 
@@ -6,7 +22,7 @@
 
 * Changed MySQL adapter to automatically reconnect (issue #26).
 
-* Changed Sequel() to acccept variable arity.
+* Changed Sequel() to accept variable arity.
 
 * Added :elements option to column definition, in order to support ENUM and SET types.
 
@@ -30,7 +46,7 @@
 
 === 0.1.9.2 (2007-07-24)
 
-* Removed metaid dependency. Refactored requires in lib/sequel.rb.
+* Removed metaid dependency. Re-factored requires in lib/sequel.rb.
 
 === 0.1.9.1 (2007-07-22)
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'fileutils'
 include FileUtils
 
 NAME = "sequel"
-VERS = "0.1.9.6"
+VERS = "0.1.9.7"
 CLEAN.include ['**/.*.sw?', 'pkg/*', '.config', 'doc/*', 'coverage/*']
 RDOC_OPTS = ['--quiet', '--title', "Sequel: Concise ORM for Ruby",
   "--opname", "index.html",
@@ -24,7 +24,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'doc/rdoc'
   rdoc.options += RDOC_OPTS
   rdoc.main = "README"
-  rdoc.title = "Sequel: Concise ORM for Ruby"
+  rdoc.title = "Sequel: Lightweight ORM library for Ruby"
   rdoc.rdoc_files.add ['README', 'COPYING', 'lib/sequel.rb', 'lib/sequel/**/*.rb']
 end
 
@@ -36,7 +36,7 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
   s.rdoc_options += RDOC_OPTS + 
     ['--exclude', '^(examples|extras)\/', '--exclude', 'lib/sequel.rb']
-  s.summary = "Concise ORM for Ruby."
+  s.summary = "Lightweight ORM library for Ruby"
   s.description = s.summary
   s.author = "Sharon Rosner"
   s.email = 'ciconia@gmail.com'

data/bin/sequel

@@ -3,17 +3,21 @@
 require 'rubygems'
 require 'sequel'
 
+usage = <<END
+Usage: sequel <connection URI>
+Sequel: Lightweight ORM library for Ruby
+
+Examples:
+  sequel sqlite:///blog.db
+  sequel postgres://localhost/my_blog
+
+For more information see http://code.google.com/p/ruby-sequel
+END
+
 db = ARGV.shift
 
 if db.nil? || db.empty?
-  puts "Usage: sequel <connection string>"
-  puts "Sequel: Concise ORM for Ruby."
-  puts
-  puts "Examples:"
-  puts "  sequel sqlite:///blog.db"
-  puts "  sequel postgres://localhost/blog"
-  puts
-  puts "For more information see http://sequel.rubyforge.org"
+  puts usage
   exit
 end
 
@@ -21,7 +25,7 @@ begin
   scheme = URI.parse(db).scheme
   require File.join('sequel', scheme)
 rescue LoadError
-  puts "Invalid or unknown scheme: #{scheme}"
+  puts "Invalid adapter specified: #{scheme}"
   exit
 rescue => e
   puts e.message

data/lib/sequel/core_ext.rb

@@ -54,17 +54,22 @@ class Symbol
   def AS(target)
     "#{to_field_name} AS #{target}"
   end
-  
-  AS_REGEXP = /(.*)___(.*)/.freeze
+
+  FIELD_REF_RE1 = /^([a-z_]+)__([a-z_]+)___([a-z_]+)/.freeze
+  FIELD_REF_RE2 = /^([a-z_]+)___([a-z_]+)$/.freeze
+  FIELD_REF_RE3 = /^([a-z_]+)__([a-z_]+)$/.freeze
   DOUBLE_UNDERSCORE = '__'.freeze
   PERIOD = '.'.freeze
   
   def to_field_name
     s = to_s
-    if s =~ AS_REGEXP
-      s = "#{$1} AS #{$2}"
+    case s
+    when FIELD_REF_RE1: "#{$1}.#{$2} AS #{$3}"
+    when FIELD_REF_RE2: "#{$1} AS #{$2}"
+    when FIELD_REF_RE3: "#{$1}.#{$2}"
+    else
+      s
     end
-    s.split(DOUBLE_UNDERSCORE).join(PERIOD)
   end
   
   def ALL

data/lib/sequel/database.rb

@@ -215,6 +215,24 @@ module Sequel
     def self.set_adapter_scheme(scheme)
       @scheme = scheme
       @@adapters[scheme.to_sym] = self
+      
+      # Define convenience method for this database class
+      db_class = self
+      Sequel.meta_def(scheme) do |*args|
+        begin
+          case args.size
+          when 1: # Sequel.dbi(db_name)
+            opts = {:database => args[0]}
+          when 0 # Sequel.dbi
+            opts = {}
+          else # Sequel.dbi(db_name, opts)
+            opts = args[1].merge(:database => args[0])
+          end
+        rescue
+          raise SequelError, "Invalid parameters specified"
+        end
+        db_class.new(opts)
+      end
     end
     
     # Returns the scheme for the Database class.

data/lib/sequel/dataset.rb

@@ -171,21 +171,44 @@ module Sequel
       d
     end
     
-    # Associates the dataset with a model. If 
+    # Associates or disassociates the dataset with a model. If no argument or
+    # nil is specified, the dataset is turned into a naked dataset and returns
+    # records as hashes. If a model class specified, the dataset is modified
+    # to return records as instances of the model class, e.g:
+    #
+    #   class MyModel
+    #     def initialize(values)
+    #       @values = values
+    #     end
+    #   end
+    # 
+    #   dataset.set_model(MyModel)
+    #
+    # The dataset can be made polymorphic by specifying a column name as the
+    # polymorphic key and a hash mapping column values to model classes.
+    #
+    #   dataset.set_model(:kind, {1 => Person, 2 => Business})
+    #
     def set_model(*args)
       if args.empty? || (args.first == nil)
+        # If no argument or nil is provided, the dataset is denuded
         @opts.merge!(:naked => true, :models => nil, :polymorphic_key => nil)
         extend_with_stock_each
       elsif args.size == 1
+        # If a single argument is provided, it is regarded the model class
         c = args.first
         @opts.merge!(:naked => nil, :models => {nil => c}, :polymorphic_key => nil)
         extend_with_model(c)
         extend_with_destroy
-      else
+      elsif args.size == 2
+        # If two arguments are provided, the first is considered the
+        # polymorphic key, and the second a hash of classes.
         key, hash = args
         @opts.merge!(:naked => true, :models => hash, :polymorphic_key => key)
         extend_with_polymorphic_model(key, hash)
         extend_with_destroy
+      else
+        raise SequelError, "Invalid parameters specified"
       end
       self
     end

data/lib/sequel/dataset/dataset_convenience.rb

@@ -1,3 +1,5 @@
+require 'enumerator'
+
 module Sequel
   class Dataset
     module Convenience
@@ -119,7 +121,7 @@ module Sequel
       
       # Returns the record range for the current page
       def current_page_record_range
-        return nil if @current_page > @page_count
+        return (0..0) if @current_page > @page_count
         
         a = 1 + (@current_page - 1) * @page_size
         b = a + @page_size - 1
@@ -151,6 +153,29 @@ module Sequel
       def print(*cols)
         Sequel::PrettyTable.print(naked.all, cols.empty? ? columns : cols)
       end
+      
+      # Inserts multiple records into the associated table. This method can be
+      # to efficiently insert a large amounts of records into a table. Inserts
+      # are automatically wrapped in a transaction. If the :commit_every 
+      # option is specified, the method will generate a separate transaction 
+      # for each batch of records, e.g.:
+      #
+      #   dataset.multi_insert(list, :commit_every => 1000)
+      def multi_insert(list, opts = {})
+        if every = opts[:commit_every]
+          list.each_slice(every) do |s|
+            @db.transaction do
+              s.each {|r| @db.execute(insert_sql(r))}
+              # @db.execute(s.map {|r| insert_sql(r)}.join)
+            end
+          end
+        else
+          @db.transaction do
+            # @db.execute(list.map {|r| insert_sql(r)}.join)
+            list.each {|r| @db.execute(insert_sql(r))}
+          end
+        end
+      end
     end
   end
 end

data/lib/sequel/dataset/dataset_sql.rb

@@ -10,13 +10,23 @@ module Sequel
         field.is_a?(Symbol) ? field.to_field_name : field
       end
 
-      QUALIFIED_REGEXP = /(.*)\.(.*)/.freeze
+      ALIASED_REGEXP = /^(.*)\s(.*)$/.freeze
+      QUALIFIED_REGEXP = /^(.*)\.(.*)$/.freeze
 
       # Returns a qualified field name (including a table name) if the field
       # name isn't already qualified.
       def qualified_field_name(field, table)
-        fn = field_name(field)
-        fn =~ QUALIFIED_REGEXP ? fn : "#{table}.#{fn}"
+        field = field_name(field)
+        if field =~ QUALIFIED_REGEXP
+          # field is already qualified
+          field
+        else 
+          # check if the table is aliased
+          if table =~ ALIASED_REGEXP
+            table = $2
+          end
+          "#{table}.#{field}"
+        end
       end
 
       WILDCARD = '*'.freeze
@@ -358,7 +368,7 @@ module Sequel
 
         join_expr = expr.map do |k, v|
           l = qualified_field_name(k, table)
-          r = qualified_field_name(v, @opts[:last_joined_table] || @opts[:from])
+          r = qualified_field_name(v, @opts[:last_joined_table] || @opts[:from].first)
           "(#{l} = #{r})"
         end.join(AND_SEPARATOR)
 
@@ -463,7 +473,7 @@ module Sequel
       #     'INSERT INTO items (a, b) VALUES (1, 2)'
       def insert_sql(*values)
         if values.empty?
-          "INSERT INTO #{@opts[:from]} DEFAULT VALUES"
+          "INSERT INTO #{@opts[:from]} DEFAULT VALUES;"
         elsif (values.size == 1) && values[0].is_a?(Hash)
           field_list = []
           value_list = []
@@ -473,9 +483,9 @@ module Sequel
           end
           fl = field_list.join(COMMA_SEPARATOR)
           vl = value_list.join(COMMA_SEPARATOR)
-          "INSERT INTO #{@opts[:from]} (#{fl}) VALUES (#{vl})"
+          "INSERT INTO #{@opts[:from]} (#{fl}) VALUES (#{vl});"
         else
-          "INSERT INTO #{@opts[:from]} VALUES (#{literal(values)})"
+          "INSERT INTO #{@opts[:from]} VALUES (#{literal(values)});"
         end
       end
 

data/lib/sequel/dbi.rb

@@ -2,15 +2,9 @@ if !Object.const_defined?('Sequel')
   require File.join(File.dirname(__FILE__), '../sequel')
 end
 
-require 'dbi'
+# require 'dbi'
 
 module Sequel
-  def self.dbi(conn_string, opts = nil)
-    opts ||= {}
-    opts.merge!(:database => conn_string)
-    Sequel::DBI::Database.new(opts)
-  end
-  
   module DBI
     class Database < Sequel::Database
       set_adapter_scheme :dbi

data/lib/sequel/sqlite.rb

@@ -14,7 +14,7 @@ module Sequel
       end
 
       def connect
-        if @opts[:database].empty?
+        if @opts[:database].nil? || @opts[:database].empty?
           @opts[:database] = ':memory:'
         end
         db = ::SQLite3::Database.new(@opts[:database])
@@ -34,7 +34,7 @@ module Sequel
     
       def execute(sql)
         @logger.info(sql) if @logger
-        @pool.hold {|conn| conn.execute(sql)}
+        @pool.hold {|conn| conn.execute_batch(sql)}
       end
       
       def execute_insert(sql)

data/spec/adapters/sqlite_spec.rb

@@ -60,6 +60,18 @@ context "An SQLite database" do
     
     proc {@db.temp_store = :invalid}.should raise_error(SequelError)
   end
+  
+  specify "should be able to execute multiple statements at once" do
+    @db.create_table :t do
+      text :name
+    end
+    
+    @db << "insert into t (name) values ('abc');insert into t (name) values ('def')"
+
+    @db[:t].count.should == 2
+    
+    @db[:t].order(:name).map(:name).should == ['abc', 'def']
+  end
 end
 
 context "An SQLite dataset" do

data/spec/database_spec.rb

@@ -339,6 +339,24 @@ context "A Database adapter with a scheme" do
     c.opts[:database].should == 'db'
   end
 
+  specify "should register a convenience method on Sequel" do
+    Sequel.should respond_to(:ccc)
+    
+    # invalid parameters
+    proc {Sequel.ccc('abc', 'def')}.should raise_error(SequelError)
+    
+    c = Sequel.ccc('mydb')
+    c.should be_a_kind_of(CCC)
+    c.opts.should == {:database => 'mydb'}
+    
+    c = Sequel.ccc('mydb', :host => 'localhost')
+    c.should be_a_kind_of(CCC)
+    c.opts.should == {:database => 'mydb', :host => 'localhost'}
+    
+    c = Sequel.ccc
+    c.should be_a_kind_of(CCC)
+    c.opts.should == {}
+  end
 end
 
 context "An unknown database scheme" do

data/spec/dataset_spec.rb

@@ -99,11 +99,11 @@ context "A simple dataset" do
   end
   
   specify "should format an insert statement" do
-    @dataset.insert_sql.should == 'INSERT INTO test DEFAULT VALUES'
+    @dataset.insert_sql.should == 'INSERT INTO test DEFAULT VALUES;'
     @dataset.insert_sql(:name => 'wxyz', :price => 342).
       should match(/INSERT INTO test \(name, price\) VALUES \('wxyz', 342\)|INSERT INTO test \(price, name\) VALUES \(342, 'wxyz'\)/)
     @dataset.insert_sql('a', 2, 6.5).should ==
-      "INSERT INTO test VALUES ('a', 2, 6.5)"
+      "INSERT INTO test VALUES ('a', 2, 6.5);"
   end
   
   specify "should format an update statement" do
@@ -830,6 +830,11 @@ context "Dataset#join_table" do
   specify "should raise if an invalid join type is specified" do
     proc {@d.join_table(:invalid, :a, :b)}.should raise_error(SequelError)
   end
+  
+  specify "should treat aliased tables correctly" do
+    @d.from('stats s').join('players p', :id => :player_id).sql.should ==
+      'SELECT * FROM stats s INNER JOIN players p ON (p.id = s.player_id)'
+  end
 end
 
 context "Dataset#[]=" do
@@ -1413,7 +1418,7 @@ context "A paginated dataset" do
   specify "should return the record range for the current page" do
     @paginated.current_page_record_range.should == (1..20)
     @d.paginate(4, 50).current_page_record_range.should == (151..153)
-    @d.paginate(5, 50).current_page_record_range.should == nil
+    @d.paginate(5, 50).current_page_record_range.should == (0..0)
   end
 end
 
@@ -1457,4 +1462,53 @@ context "Dataset#print" do
     @output.read.should == \
       "+-+-+\n|a|b|\n+-+-+\n|1|2|\n|3|4|\n|5|6|\n+-+-+\n"
   end
+end
+
+context "Dataset#multi_insert" do
+  setup do
+    @dbc = Class.new do
+      attr_reader :sqls
+      
+      def execute(sql)
+        @sqls ||= []
+        @sqls << sql
+      end
+      
+      def transaction
+        @sqls ||= []
+        @sqls << 'BEGIN;'
+        yield
+        @sqls << 'COMMIT;'
+      end
+    end
+    @db = @dbc.new
+    
+    @ds = Sequel::Dataset.new(@db).from(:items)
+    
+    @list = [{:name => 'abc'}, {:name => 'def'}, {:name => 'ghi'}]
+  end
+  
+  specify "should join all inserts into a single SQL string" do
+    @ds.multi_insert(@list)
+    @db.sqls.should == [
+      'BEGIN;',
+      "INSERT INTO items (name) VALUES ('abc');",
+      "INSERT INTO items (name) VALUES ('def');",
+      "INSERT INTO items (name) VALUES ('ghi');",
+      'COMMIT;'
+    ]
+  end
+  
+  specify "should accept the commit_every option for commiting every x records" do
+    @ds.multi_insert(@list, :commit_every => 2)
+    @db.sqls.should == [
+      'BEGIN;',
+      "INSERT INTO items (name) VALUES ('abc');",
+      "INSERT INTO items (name) VALUES ('def');",
+      'COMMIT;',
+      'BEGIN;',
+      "INSERT INTO items (name) VALUES ('ghi');",
+      'COMMIT;'
+    ]
+  end
 end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: sequel
 version: !ruby/object:Gem::Version 
-  version: 0.1.9.6
-date: 2007-08-13 00:00:00 +03:00
-summary: Concise ORM for Ruby.
+  version: 0.1.9.7
+date: 2007-08-15 00:00:00 +03:00
+summary: Lightweight ORM library for Ruby
 require_paths: 
 - lib
 email: ciconia@gmail.com
 homepage: http://sequel.rubyforge.org
 rubyforge_project: 
-description: Concise ORM for Ruby.
+description: Lightweight ORM library for Ruby
 autorequire: 
 default_executable: 
 bindir: bin
@@ -33,7 +33,6 @@ files:
 - README
 - Rakefile
 - bin/sequel
-- doc/rdoc
 - spec/adapters
 - spec/connection_pool_spec.rb
 - spec/core_ext_spec.rb