sequel 0.0.16 → 0.0.17

data/CHANGELOG

@@ -1,5 +1,21 @@
+*0.0.17*
+
+* Fixed Dataset#from to have variable arity, like Dataset#select and Dataset#where (patch by Alex Bradbury.)
+
+* Added support for GROUP BY and HAVING clauses (patches by Alex Bradbury.) Refactored Dataset#filter.
+
+* More specs.
+
+* Refactored Dataset#where for better composability.
+
+* Added Dataset#[]= method.
+
+* Added support for DISTINCT and OFFSET clauses (patches by Alex Bradbury.) Dataset#limit now accepts ranges. Added Dataset#uniq and distinct methods.
+
 *0.0.16*
 
+* More documentation.
+
 * Added support for subqueries in Dataset#literal.
 
 * Added support for Model.all_by_XXX methods through Model.method_missing.

data/README

@@ -39,7 +39,36 @@ Sequel includes an IRB console for quick'n'dirty access to databases. You can us
 
 You get an IRB session with the database object stored in DB.
 
-== A Short Tutorial
+== An Introduction
+
+Sequel was designed to take the hassle away from connecting to databases and manipulating them. Sequel deals with all the boring stuff like maintaining connections, formatting SQL correctly and fetching records so you can concentrate on your application.
+
+Sequel uses the concept of datasets to retrieve data. A Dataset object encapsulates an SQL query and supports chainability, letting you fetch data using a convenient Ruby DSL that is both concise and infinitely flexible.
+
+For example, the following one-liner returns the average GDP for the five biggest countries in the middle east region:
+
+  DB[:countries].filter(:region => 'Middle East').reverse_order(:area).limit(5).avg(:GDP)
+  
+Which is equivalent to:
+
+  SELECT avg(GDP) FROM countries WHERE region = 'Middle East' ORDER BY area DESC LIMIT 5
+
+Since datasets retrieve records only when needed, they can be stored and later reused. Records are fetched as hashes (they can also be fetched as custom model objects), and are accessed using an Enumerable interface:
+
+  middle_east = DB[:countries].filter(:region => 'Middle East')
+  middle_east.order(:name).each {|r| puts r[:name]}
+  
+Sequel also offers convenience methods for extracting data from Datasets, such as an extended map method:
+
+  middle_east.map(:name) #=> ['Egypt', 'Greece', 'Israel', ...]
+  
+Or getting results as a transposed hash, with one column as key and another as value:
+
+  middle_east.hash_column(:name, :area) #=> {'Israel' => 20000, 'Greece' => 120000, ...}
+
+Much of Sequel is still undocumented (especially the part relating to model classes). The following section provides examples of common usage. Feel free to explore...
+
+== Getting Started
 
 === Connecting to a database
 
@@ -49,18 +78,18 @@ Before connecting to a database, you should require the corresponding adaptor, f
 
 Note: you don't need to require 'sequel' separately before that, as each adapter requires 'sequel' if it hasn't yet been required.
 
-There are two ways to create a connection to a database. The easier way is to provide a connection URL:
+To connect to a database you simply provide Sequel with a URL:
 
-  DB = Sequel.open("sqlite:///blog.db")
-
-You can also specify optional parameters, such as the connection pool size:
+  DB = Sequel.open 'sqlite:///blog.db'
+  
+The connection URL can also include such stuff as the user name and password:
 
-  DB = Sequel.open("postgres://postgres:postgres@localhost/my_db",
-    :max_connections => 10)
+  DB = Sequel.open 'postgres://cico:12345@localhost:5432/mydb'
 
-The second, more verbose, way is to create an instance of a database class:
+You can also specify optional parameters, such as the connection pool size, or a logger for logging SQL queries:
 
-  DB = Sequel::Postgres::Database.new(:database => 'my_db', :host => 'localhost')
+  DB = Sequel.open("postgres://postgres:postgres@localhost/my_db",
+    :max_connections => 10, :logger => Logger.new('log/db.log'))
 
 === Arbitrary SQL queries
 
@@ -72,7 +101,7 @@ Or more succinctly:
   DB << "create table t (a text, b text)"
   DB << "insert into t values ('a', 'b')"
 
-=== Creating Datasets
+=== Getting Dataset Instances
 
 Dataset is the primary means through which records are retrieved and manipulated. You can create an blank dataset by using the dataset method:
 
@@ -147,9 +176,9 @@ You can also specify a custom WHERE clause:
 
   posts.filter('(stamp < ?) AND (author <> ?)', 3.days.ago, author_name)
 
-Datasets can also be used as subqueries for filtering:
+Datasets can also be used as subqueries:
 
-expensive_stuff = DB[:items].filter(:price => DB[:items].select('AVG(price) + 100'))
+  DB[:items].filter('price > ?', DB[:items].select('AVG(price) + 100'))
 
 === Summarizing Records
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'fileutils'
 include FileUtils
 
 NAME = "sequel"
-VERS = "0.0.16"
+VERS = "0.0.17"
 CLEAN.include ['**/.*.sw?', 'pkg/*', '.config', 'doc/*', 'coverage/*']
 RDOC_OPTS = ['--quiet', '--title', "Sequel: Concise ORM for Ruby",
   "--opname", "index.html",

data/lib/sequel/dataset.rb

@@ -36,7 +36,7 @@ module Sequel
     #
     # Sequel::Dataset is an abstract class that is not useful by itself. Each
     # database adaptor should provide a descendant class of Sequel::Dataset.
-    def initialize(db, opts = {}, record_class = nil)
+    def initialize(db, opts = nil, record_class = nil)
       @db = db
       @opts = opts || {}
       @record_class = record_class
@@ -100,7 +100,7 @@ module Sequel
       case source
       when Array: source.join(COMMA_SEPARATOR)
       else source
-      end 
+      end
     end
     
     NULL = "NULL".freeze
@@ -149,7 +149,7 @@ module Sequel
     end
     
     # Formats a where clause.
-    def where_list(where)
+    def where_list(where, parenthesize = false)
       case where
       when Hash:
         where.map {|kv| where_condition(*kv)}.join(AND_SEPARATOR)
@@ -157,7 +157,7 @@ module Sequel
         fmt = where.shift
         fmt.gsub('?') {|i| literal(where.shift)}
       else
-        where
+        parenthesize ? "(#{where})" : where
       end
     end
     
@@ -171,7 +171,8 @@ module Sequel
     end
     
     # Returns a copy of the dataset with the source changed.
-    def from(source)
+    def from(*source)
+      source = source.first if source.size == 1
       dup_merge(:from => source)
     end
     
@@ -181,6 +182,12 @@ module Sequel
       dup_merge(:select => fields)
     end
 
+    # Returns a copy of the dataset with the distinct option.
+    def uniq
+      dup_merge(:distinct => true)
+    end
+    alias distinct uniq
+
     # Returns a copy of the dataset with the order changed.
     def order(*order)
       dup_merge(:order => order)
@@ -200,26 +207,51 @@ module Sequel
       end
     end
     
+    # Returns a copy of the dataset with the results grouped by the value of 
+    # the given fields
+    def group(*fields)
+      dup_merge(:group => fields)
+    end
+
     AND_WHERE = "%s AND %s".freeze
     
-    # Returns a copy of the dataset with the where conditions changed.
-    def where(*cond)
+    # Returns a copy of the dataset with the given conditions imposed upon it.  
+    # If the query has been grouped, then the conditions are imposed in the 
+    # HAVING clause. If not, then they are imposed in the WHERE clause.
+    def filter(*cond)
+      clause = (@opts[:group] ? :having : :where)
       cond = cond.first if cond.size == 1
-      if @opts[:where]
-        if @opts[:where].is_a?(Hash) && cond.is_a?(Hash)
-          cond = @opts[:where].merge(cond)
-        else
-          cond = AND_WHERE % [where_list(@opts[:where]), where_list(cond)]
-        end
+      if @opts[clause]
+        cond = AND_WHERE % [where_list(@opts[clause]), where_list(cond, true)]
       end
-      dup_merge(:where => cond)
+      dup_merge(clause => where_list(cond))
     end
+
+    # Returns a copy of the dataset with the where conditions changed. Raises 
+    # if the dataset has been grouped. See also #filter
+    def where(*cond)
+      if @opts[:group]
+        raise "Can't specify a WHERE clause once the dataset has been grouped"
+      else
+        filter(*cond)
+      end
+    end
+
+    # Returns a copy of the dataset with the having conditions changed. Raises 
+    # if the dataset has not been grouped. See also #filter
+    def having(*cond)
+      unless @opts[:group]
+        raise "Can only specify a HAVING clause on a grouped dataset"
+      else
+        filter(*cond)
+       end
+     end
     
     NOT_WHERE = "NOT %s".freeze
     
     def exclude(*cond)
       cond = cond.first if cond.size == 1
-      where(NOT_WHERE % where_list(cond))
+      filter(NOT_WHERE % where_list(cond))
     end
     
     LEFT_OUTER_JOIN = 'LEFT OUTER JOIN'.freeze
@@ -232,7 +264,6 @@ module Sequel
         :join_cond => cond)
     end
 
-    alias_method :filter, :where
     alias_method :all, :to_a
     
     alias_method :enum_map, :map
@@ -266,9 +297,13 @@ module Sequel
     end
 
     SELECT = "SELECT %s FROM %s".freeze
+    SELECT_DISTINCT = "SELECT DISTINCT %s FROM %s".freeze
     LIMIT = " LIMIT %s".freeze
+    OFFSET = " OFFSET %s".freeze
     ORDER = " ORDER BY %s".freeze
     WHERE = " WHERE %s".freeze
+    GROUP = " GROUP BY %s".freeze
+    HAVING = " HAVING %s".freeze
     JOIN_CLAUSE = " %s %s ON %s".freeze
     
     EMPTY = ''.freeze
@@ -281,7 +316,7 @@ module Sequel
       fields = opts[:select]
       select_fields = fields ? field_list(fields) : WILDCARD
       select_source = source_list(opts[:from])
-      sql = SELECT % [select_fields, select_source]
+      sql = (opts[:distinct] ? SELECT_DISTINCT : SELECT) % [select_fields, select_source]
       
       if join_type = opts[:join_type]
         join_table = opts[:join_table]
@@ -290,17 +325,28 @@ module Sequel
       end
       
       if where = opts[:where]
-        sql << (WHERE % where_list(where))
+        sql << (WHERE % where)
       end
       
+      if group = opts[:group]
+        sql << (GROUP % group.join(COMMA_SEPARATOR))
+      end
+
       if order = opts[:order]
         sql << (ORDER % order.join(COMMA_SEPARATOR))
       end
       
+      if having = opts[:having]
+        sql << (HAVING % having)
+      end
+
       if limit = opts[:limit]
         sql << (LIMIT % limit)
+        if offset = opts[:offset]
+          sql << (OFFSET % offset)
+        end
       end
-      
+            
       sql
     end
     
@@ -335,14 +381,21 @@ module Sequel
     def update_sql(values, opts = nil)
       opts = opts ? @opts.merge(opts) : @opts
       
+      if opts[:group]
+        raise "Can't update a grouped dataset" 
+      elsif opts[:from].is_a?(Array) && opts[:from].size > 1
+        raise "Can't update in a joined dataset"
+      end
+
       set_list = values.map {|kv| SET_FORMAT % [kv[0], literal(kv[1])]}.
         join(COMMA_SEPARATOR)
-      update_clause = UPDATE % [opts[:from], set_list]
+      sql = UPDATE % [opts[:from], set_list]
       
-      where = opts[:where]
-      where_clause = where ? WHERE % where_list(where) : EMPTY
+      if where = opts[:where]
+        sql << WHERE % where_list(where)
+      end
 
-      [update_clause, where_clause].join(SPACE)
+      sql
     end
     
     DELETE = "DELETE FROM %s".freeze
@@ -350,12 +403,19 @@ module Sequel
     def delete_sql(opts = nil)
       opts = opts ? @opts.merge(opts) : @opts
 
-      delete_source = opts[:from] 
-      
-      where = opts[:where]
-      where_clause = where ? WHERE % where_list(where) : EMPTY
-      
-      [DELETE % delete_source, where_clause].join(SPACE)
+      if opts[:group]
+        raise "Can't delete from a grouped dataset" 
+      elsif opts[:from].is_a?(Array) && opts[:from].size > 1
+        raise "Can't delete from a joined dataset"
+      end
+
+      sql = DELETE % opts[:from]
+
+      if where = opts[:where]
+        sql << WHERE % where_list(where)
+      end
+
+      sql
     end
     
     COUNT = "COUNT(*)".freeze
@@ -390,10 +450,22 @@ module Sequel
     
     LIMIT_1 = {:limit => 1}.freeze
     
-    def limit(l)
-      dup_merge(:limit => l)
+    # If given an integer, the dataset will contain only the first l results.
+    # If given a range, it will contain only those at offsets within that
+    # range. If a second argument is given, it is used as an offset.
+    def limit(l, o = nil)
+      if l.is_a? Range
+        lim = (l.exclude_end? ? l.last - l.first : l.last + 1 - l.first)
+        dup_merge(:limit => lim, :offset=>l.first)
+      elsif o
+        dup_merge(:limit => l, :offset => o)
+      else
+        dup_merge(:limit => l)
+      end
     end
-
+    
+    # Returns the first record in the dataset. If the num argument is specified,
+    # an array is returned with the first <i>num</i> records.
     def first(num = 1)
       if num == 1
         first_record
@@ -402,9 +474,15 @@ module Sequel
       end
     end
     
+    # Returns the first record matching the condition.
     def [](condition)
       where(condition).first
     end
+    
+    # Updates all records matching the condition with the values specified.
+    def []=(condition, values)
+      where(condition).update(values)
+    end
   
     def last(num = 1)
       raise 'No order specified' unless @opts[:order] || (opts && opts[:order])
@@ -420,6 +498,8 @@ module Sequel
       end
     end
     
+    # Deletes all records in the dataset one at a time by invoking the destroy
+    # method of the associated model class.
     def destroy
       raise 'Dataset not associated with model' unless @record_class
       
@@ -428,6 +508,7 @@ module Sequel
       count
     end
     
+    # Pretty prints the records in the dataset as plain-text table.
     def print(*columns)
       Sequel::PrettyTable.print(naked.all, columns.empty? ? nil : columns)
     end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: sequel
 version: !ruby/object:Gem::Version 
-  version: 0.0.16
-date: 2007-04-08 00:00:00 +03:00
+  version: 0.0.17
+date: 2007-04-10 00:00:00 +03:00
 summary: Concise ORM for Ruby.
 require_paths: 
 - lib