sequel 3.13.0 → 3.14.0

data/lib/sequel/model/errors.rb

@@ -5,17 +5,24 @@ module Sequel
     class Errors < ::Hash
       ATTRIBUTE_JOINER = ' and '.freeze
 
-      # Assign an array of messages for each attribute on access
+      # Assign an array of messages for each attribute on access.
+      # Using this message is discouraged in new code, use +add+
+      # to add new error messages, and +on+ to check existing
+      # error messages.
       def [](k)
         has_key?(k) ? super : (self[k] = [])
       end
 
       # Adds an error for the given attribute.
+      #
+      #   errors.add(:name, 'is not valid') if name == 'invalid'
       def add(att, msg)
         self[att] << msg
       end
 
       # Return the total number of error messages.
+      #
+      #   errors.count # => 3
       def count
         values.inject(0){|m, v| m + v.length}
       end
@@ -26,6 +33,10 @@ module Sequel
       end
       
       # Returns an array of fully-formatted error messages.
+      #
+      #   errors.full_messages
+      #   # => ['name is not valid',
+      #   #     'hometown is not at least 2 letters']
       def full_messages
         inject([]) do |m, kv| 
           att, errors = *kv
@@ -36,6 +47,9 @@ module Sequel
       
       # Returns the array of errors for the given attribute, or nil
       # if there are no errors for the attribute.
+      #
+      #   errors.on(:name) # => ['name is not valid']
+      #   errors.on(:id) # => nil
       def on(att)
         if v = fetch(att, nil) and !v.empty?
           v

data/lib/sequel/model/exceptions.rb

@@ -1,12 +1,12 @@
 module Sequel
-  # Exception class raised when raise_on_save_failure is set and a before hook returns false
+  # Exception class raised when +raise_on_save_failure+ is set and a before hook returns false
   class BeforeHookFailed < Error; end
   
-  # Exception class raised when require_modification is set and an UPDATE or DELETE statement to modify the dataset doesn't
+  # Exception class raised when +require_modification+ is set and an UPDATE or DELETE statement to modify the dataset doesn't
   # modify a single row.
   class NoExistingObject < Error; end
   
-  # Exception class raised when raise_on_save_failure is set and validation fails
+  # Exception class raised when +raise_on_save_failure+ is set and validation fails
   class ValidationFailed < Error
     def initialize(errors)
       if errors.respond_to?(:full_messages)

data/lib/sequel/model/inflections.rb

@@ -39,10 +39,10 @@ module Sequel
     @plurals, @singulars, @uncountables = [], [], []
 
     class << self
-      # Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
+      # Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
       attr_reader :plurals
 
-      # Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
+      # Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
       attr_reader :singulars
 
       # Array of strings for words were the singular form is the same as the plural form

data/lib/sequel/model/plugins.rb

@@ -6,7 +6,8 @@ module Sequel
   # * A singleton method named apply, which takes a model, 
   #   additional arguments, and an optional block.  This is called
   #   the first time the plugin is loaded for this model (unless it was
-  #   already loaded by an ancestor class), with the arguments
+  #   already loaded by an ancestor class), before including/extending
+  #   any modules, with the arguments
   #   and block provided to the call to Model.plugin.
   # * A module inside the plugin module named InstanceMethods,
   #   which will be included in the model class.
@@ -16,7 +17,8 @@ module Sequel
   #   which will extend the model's dataset.
   # * A singleton method named configure, which takes a model, 
   #   additional arguments, and an optional block.  This is called
-  #   every time the Model.plugin method is called.
+  #   every time the Model.plugin method is called, after including/extending
+  #   any modules.
   module Plugins
   end
   
@@ -27,7 +29,6 @@ module Sequel
     # sequel_#{plugin}, and then attempt to load the module using a
     # the camelized plugin name under Sequel::Plugins.
     def self.plugin(plugin, *args, &blk)
-      arg = args.first
       m = plugin.is_a?(Module) ? plugin : plugin_module(plugin)
       unless @plugins.include?(m)
         @plugins << m
@@ -45,13 +46,16 @@ module Sequel
     end
     
     module ClassMethods
-      # Array of plugins loaded by this class
+      # Array of plugin modules loaded by this class
+      #
+      #   Sequel::Model.plugins
+      #   # => [Sequel::Model, Sequel::Model::Associations]
       attr_reader :plugins
       
       private
   
       # Returns the module for the specified plugin. If the module is not 
-      # defined, the corresponding plugin gem is automatically loaded.
+      # defined, the corresponding plugin required.
       def plugin_module(plugin)
         module_name = plugin.to_s.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase}
         if !Sequel::Plugins.const_defined?(module_name) ||

data/lib/sequel/plugins/rcte_tree.rb

@@ -32,9 +32,7 @@ module Sequel
     #
     # = Usage
     #
-    # The rcte_tree plugin is unlike most plugins in that it doesn't add any class,
-    # instance, or dataset modules.  It only has a single apply method, which
-    # adds four associations to the model: parent, children, ancestors, and
+    # The rcte_tree plugin adds four associations to the model: parent, children, ancestors, and
     # descendants.  Both the parent and children are fairly standard many_to_one
     # and one_to_many associations, respectively.  However, the ancestors and
     # descendants associations are special.  Both the ancestors and descendants
@@ -118,9 +116,17 @@ module Sequel
         a[:read_only] = true unless a.has_key?(:read_only)
         a[:eager_loader_key] = key
         a[:dataset] ||= proc do
-          model.from(t).
-           with_recursive(t, model.filter(prkey=>send(key)),
-            model.join(t, key=>prkey).
+          base_ds = model.filter(prkey=>send(key))
+          recursive_ds = model.join(t, key=>prkey)
+          if c = a[:conditions]
+            (base_ds, recursive_ds) = [base_ds, recursive_ds].collect do |ds|
+              (c.is_a?(Array) && !Sequel.condition_specifier?(c)) ? ds.filter(*c) : ds.filter(c)
+            end
+          end
+          table_alias = model.dataset.schema_and_table(model.table_name)[1].to_sym
+          model.from(t => table_alias).
+           with_recursive(t, base_ds,
+            recursive_ds.
             select(c_all))
         end
         aal = Array(a[:after_load])
@@ -156,12 +162,20 @@ module Sequel
             obj.associations[parent] = nil
           end
           r = model.association_reflection(ancestors)
+          base_case = model.filter(prkey=>id_map.keys).
+           select(SQL::AliasedExpression.new(prkey, ka), c_all)
+          recursive_case = model.join(t, key=>prkey).
+           select(SQL::QualifiedIdentifier.new(t, ka), c_all)
+          if c = r[:conditions]
+            (base_case, recursive_case) = [base_case, recursive_case].collect do |ds|
+              (c.is_a?(Array) && !Sequel.condition_specifier?(c)) ? ds.filter(*c) : ds.filter(c)
+            end
+          end
+          table_alias = model.dataset.schema_and_table(model.table_name)[1].to_sym
           model.eager_loading_dataset(r,
-           model.from(t).
-            with_recursive(t, model.filter(prkey=>id_map.keys).
-              select(SQL::AliasedExpression.new(prkey, ka), c_all),
-             model.join(t, key=>prkey).
-             select(SQL::QualifiedIdentifier.new(t, ka), c_all)),
+           model.from(t => table_alias).
+            with_recursive(t, base_case,
+             recursive_case),
            r.select,
            eo[:associations], eo).all do |obj|
             opk = obj[prkey]
@@ -197,9 +211,17 @@ module Sequel
         d[:read_only] = true unless d.has_key?(:read_only)
         la = d[:level_alias] ||= :x_level_x
         d[:dataset] ||= proc do
-          model.from(t).
-           with_recursive(t, model.filter(key=>send(prkey)),
-            model.join(t, prkey=>key).
+          base_ds = model.filter(key=>send(prkey))
+          recursive_ds = model.join(t, prkey=>key)
+          if c = d[:conditions]
+            (base_ds, recursive_ds) = [base_ds, recursive_ds].collect do |ds|
+              (c.is_a?(Array) && !Sequel.condition_specifier?(c)) ? ds.filter(*c) : ds.filter(c)
+            end
+          end
+          table_alias = model.dataset.schema_and_table(model.table_name)[1].to_sym
+          model.from(t => table_alias).
+           with_recursive(t, base_ds,
+            recursive_ds.
             select(SQL::ColumnAll.new(model.table_name)))
           end
         dal = Array(d[:after_load])
@@ -238,6 +260,11 @@ module Sequel
            select(SQL::AliasedExpression.new(key, ka), c_all)
           recursive_case = model.join(t, prkey=>key).
            select(SQL::QualifiedIdentifier.new(t, ka), c_all)
+          if c = r[:conditions]
+            (base_case, recursive_case) = [base_case, recursive_case].collect do |ds|
+              (c.is_a?(Array) && !Sequel.condition_specifier?(c)) ? ds.filter(*c) : ds.filter(c)
+            end
+          end
           if associations.is_a?(Integer)
             level = associations
             no_cache_level = level - 1
@@ -245,8 +272,9 @@ module Sequel
             base_case = base_case.select_more(SQL::AliasedExpression.new(0, la))
             recursive_case = recursive_case.select_more(SQL::AliasedExpression.new(SQL::QualifiedIdentifier.new(t, la) + 1, la)).filter(SQL::QualifiedIdentifier.new(t, la) < level - 1)
           end
+          table_alias = model.dataset.schema_and_table(model.table_name)[1].to_sym
           model.eager_loading_dataset(r,
-           model.from(t).with_recursive(t, base_case, recursive_case),
+           model.from(t => table_alias).with_recursive(t, base_case, recursive_case),
            r.select,
            associations, eo).all do |obj|
             if level

data/lib/sequel/plugins/schema.rb

@@ -19,7 +19,8 @@ module Sequel
     module Schema
       module ClassMethods
         # Creates table, using the column information from set_schema.
-        def create_table
+        def create_table(*args, &block)
+          set_schema(*args, &block) if block_given?
           db.create_table(table_name, :generator=>@schema)
           @db_schema = get_db_schema(true)
           columns
@@ -27,14 +28,14 @@ module Sequel
         
         # Drops the table if it exists and then runs create_table.  Should probably
         # not be used except in testing.
-        def create_table!
+        def create_table!(*args, &block)
           drop_table rescue nil
-          create_table
+          create_table(*args, &block)
         end
 
         # Creates the table unless the table already exists
-        def create_table?
-          create_table unless table_exists?
+        def create_table?(*args, &block)
+          create_table(*args, &block) unless table_exists?
         end
         
         # Drops table.

data/lib/sequel/plugins/serialization.rb

@@ -153,7 +153,7 @@ module Sequel
           when :yaml
             v.to_yaml
           when :json
-            JSON.generate v
+            v.to_json
           else
             raise Error, "Bad serialization format (#{model.serialization_map[column].inspect}) for column #{column.inspect}"
           end

data/lib/sequel/plugins/single_table_inheritance.rb

@@ -157,7 +157,7 @@ module Sequel
       module InstanceMethods
         # Set the sti_key column based on the sti_key_map.
         def before_create
-          send("#{model.sti_key}=", model.sti_key_map[model]) unless send(model.sti_key)
+          send("#{model.sti_key}=", model.sti_key_map[model]) unless self[model.sti_key]
           super
         end
       end

data/lib/sequel/plugins/tree.rb

@@ -8,6 +8,9 @@ module Sequel
     #
     # Optionally, a column to control order of nodes returned can be specified
     # by passing column name via :order.
+    #
+    # If you pass true for the :single_root option, the class will ensure there is
+    # only ever one root in the tree.
     # 
     # Examples:
     #
@@ -40,6 +43,8 @@ module Sequel
         chi = opts.merge(opts.fetch(:children, {}))
         children = chi.fetch(:name, :children)
         model.one_to_many children, chi
+
+        model.plugin SingleRoot if opts[:single_root]
       end
       
       module ClassMethods
@@ -88,7 +93,7 @@ module Sequel
         #
         #   subchild1.ancestors # => [child1, root]
         def descendants
-          nodes = self.children.dup
+          nodes = children.dup
           nodes.each{|child| nodes.concat(child.descendants)}
           nodes 
         end
@@ -99,6 +104,11 @@ module Sequel
           ancestors.last || self
         end
 
+        # Returns true if this is a root node, false otherwise.
+        def root?
+          !new? && self[model.parent_column].nil?
+        end
+
         # Returns all siblings and a reference to the current node.
         #
         #   subchild1.self_and_siblings # => [subchild1, subchild2]
@@ -113,6 +123,28 @@ module Sequel
           self_and_siblings - [self]
         end
       end
+
+      # Plugin included when :single_root option is passed
+      module SingleRoot
+        module ClassMethods
+          # Returns the single root node.
+          def root
+            roots_dataset.first
+          end
+        end
+
+        module InstanceMethods
+          # Hook that prevents a second root from being created.
+          def before_save
+            if self[model.parent_column].nil? && (root = model.root) && pk != root.pk
+              raise TreeMultipleRootError, "there is already a root #{model.name} defined"
+            end
+            super
+          end
+        end
+      end
+
+      class TreeMultipleRootError < Error; end
     end
   end
 end

data/lib/sequel/timezones.rb

@@ -1,10 +1,4 @@
 module Sequel
-  # The offset of the current time zone from UTC, in seconds.
-  LOCAL_DATETIME_OFFSET_SECS = Time.now.utc_offset
-  
-  # The offset of the current time zone from UTC, as a fraction of a day.
-  LOCAL_DATETIME_OFFSET = respond_to?(:Rational, true) ? Rational(LOCAL_DATETIME_OFFSET_SECS, 60*60*24) : LOCAL_DATETIME_OFFSET_SECS/60/60/24.0
-  
   @application_timezone = nil
   @database_timezone = nil
   @typecast_timezone = nil
@@ -75,7 +69,8 @@ module Sequel
       when :utc, nil
         v # DateTime assumes UTC if no offset is given
       when :local
-        v.new_offset(LOCAL_DATETIME_OFFSET) - LOCAL_DATETIME_OFFSET
+        offset = local_offset_for_datetime(v)
+        v.new_offset(offset) - offset
       else
         convert_input_datetime_other(v, input_timezone)
       end
@@ -103,7 +98,7 @@ module Sequel
             v2 = convert_input_datetime_no_offset(v2, input_timezone)
           else
             # Time assumes local time if no offset is given
-            v2 = v2.getutc + LOCAL_DATETIME_OFFSET_SECS if input_timezone == :utc
+            v2 = v2.getutc + v2.utc_offset if input_timezone == :utc
           end
           v2
         end
@@ -132,7 +127,7 @@ module Sequel
         raise InvalidValue, "Invalid convert_input_timestamp type: #{v.inspect}"
       end
     end
-    
+
     # Convert the given +DateTime+ to the given output_timezone that is not supported
     # by default (i.e. one other than +nil+, <tt>:local</tt>, or <tt>:utc</tt>).  Raises an +InvalidValue+ by default.
     # Can be overridden in extensions.
@@ -148,7 +143,7 @@ module Sequel
           when :utc
             v.new_offset(0)
           when :local
-            v.new_offset(LOCAL_DATETIME_OFFSET)
+            v.new_offset(local_offset_for_datetime(v))
           else
             convert_output_datetime_other(v, output_timezone)
           end
@@ -178,6 +173,17 @@ module Sequel
     def convert_timezone_setter_arg(tz)
       tz
     end
+
+    # Takes a DateTime dt, and returns the correct local offset for that dt, daylight savings included.
+    def local_offset_for_datetime(dt)
+      time_offset_to_datetime_offset Time.local(dt.year, dt.month, dt.day, dt.hour, dt.min, dt.sec).utc_offset
+    end
+
+    # Caches offset conversions to avoid excess Rational math.
+    def time_offset_to_datetime_offset(offset_secs)
+      @local_offsets ||= {}
+      @local_offsets[offset_secs] ||= respond_to?(:Rational, true) ? Rational(offset_secs, 60*60*24) : offset_secs/60/60/24.0
+    end
   end
 
   extend Timezones

data/lib/sequel/version.rb

@@ -3,7 +3,7 @@ module Sequel
   MAJOR = 3
   # The minor version of Sequel.  Bumped for every non-patch level
   # release, generally around once a month.
-  MINOR = 13
+  MINOR = 14
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.
   TINY  = 0

data/spec/adapters/mssql_spec.rb

@@ -63,8 +63,9 @@ context "MSSQL Dataset#join_table" do
   specify "should emulate the USING clause with ON" do
     MSSQL_DB[:items].join(:categories, [:id]).sql.should ==
       'SELECT * FROM ITEMS INNER JOIN CATEGORIES ON (CATEGORIES.ID = ITEMS.ID)'
-    MSSQL_DB[:items].join(:categories, [:id1, :id2]).sql.should ==
-      'SELECT * FROM ITEMS INNER JOIN CATEGORIES ON ((CATEGORIES.ID1 = ITEMS.ID1) AND (CATEGORIES.ID2 = ITEMS.ID2))'
+    ['SELECT * FROM ITEMS INNER JOIN CATEGORIES ON ((CATEGORIES.ID1 = ITEMS.ID1) AND (CATEGORIES.ID2 = ITEMS.ID2))',
+     'SELECT * FROM ITEMS INNER JOIN CATEGORIES ON ((CATEGORIES.ID2 = ITEMS.ID2) AND (CATEGORIES.ID1 = ITEMS.ID1))'].
+    should include(MSSQL_DB[:items].join(:categories, [:id1, :id2]).sql)
     MSSQL_DB[:items___i].join(:categories___c, [:id]).sql.should ==
       'SELECT * FROM ITEMS AS I INNER JOIN CATEGORIES AS C ON (C.ID = I.ID)'
   end
@@ -401,3 +402,36 @@ context "A MSSQL database" do
     (s[:max_chars] || s[:column_size]).should == 2
   end
 end
+
+context "MSSQL::Database#rename_table" do
+  specify "should work on non-schema bound tables which need escaping" do
+    MSSQL_DB.quote_identifiers = true
+    MSSQL_DB.create_table! :'foo bar' do
+      text :name
+    end
+    MSSQL_DB.drop_table :baz rescue nil
+    proc { MSSQL_DB.rename_table 'foo bar', 'baz' }.should_not raise_error
+  end
+  
+  specify "should workd on schema bound tables" do
+    MSSQL_DB.execute(<<-SQL)
+      IF NOT EXISTS (SELECT * FROM sys.schemas WHERE name = 'MY')
+        EXECUTE sp_executesql N'create schema MY'
+    SQL
+    MSSQL_DB.create_table! :MY__foo do
+      text :name
+    end
+    proc { MSSQL_DB.rename_table :MY__foo, :MY__bar }.should_not raise_error
+    proc { MSSQL_DB.rename_table :MY__bar, :foo }.should_not raise_error
+  end
+end
+
+context "MSSQL::Dataset#count" do
+  specify "should work with a distinct query with an order clause" do
+    MSSQL_DB.create_table!(:items){String :name; Integer :value}
+    MSSQL_DB[:items].insert(:name => "name", :value => 1)
+    MSSQL_DB[:items].insert(:name => "name", :value => 1)
+    MSSQL_DB[:items].select(:name, :value).distinct.order(:name).count.should == 1
+    MSSQL_DB[:items].select(:name, :value).group(:name, :value).order(:name).count.should == 1
+  end
+end