sequel 4.13.0 → 4.14.0

data/lib/sequel/extensions/hash_aliases.rb

@@ -14,6 +14,7 @@
 #
 #   DB.extension(:hash_aliases)
 
+#
 module Sequel
   module HashAliases
     def from(*source)

data/lib/sequel/extensions/looser_typecasting.rb

@@ -10,6 +10,7 @@
 #
 #   DB.extension :looser_typecasting
 
+#
 module Sequel
   module LooserTypecasting
     # Typecast the value to a Float using to_f instead of Kernel.Float

data/lib/sequel/extensions/meta_def.rb

@@ -5,6 +5,7 @@
 #
 #   Sequel.extension :meta_def
 
+#
 module Sequel
   # Contains meta_def method for adding methods to objects via blocks.
   # Only recommended for backwards compatibility with existing code.

data/lib/sequel/extensions/migration.rb

@@ -6,6 +6,7 @@
 #
 #   Sequel.extension :migration
 
+#
 module Sequel
   # Sequel's older migration class, available for backward compatibility.
   # Uses subclasses with up and down instance methods for each migration:

data/lib/sequel/extensions/mssql_emulate_lateral_with_apply.rb

@@ -22,6 +22,7 @@
 #
 #   DB.extension(:mssql_emulate_lateral_with_apply)
 
+#
 module Sequel
   module MSSQL
     module EmulateLateralWithApply

data/lib/sequel/extensions/named_timezones.rb

@@ -39,6 +39,7 @@
 
 require 'tzinfo'
 
+#
 module Sequel
   self.datetime_class = DateTime
   

data/lib/sequel/extensions/null_dataset.rb

@@ -31,6 +31,7 @@
 #
 #   DB.extension(:null_dataset)
 
+#
 module Sequel
   class Dataset
     module Nullifiable

data/lib/sequel/extensions/pagination.rb

@@ -14,6 +14,7 @@
 #
 #   DB.extension(:pagination)
 
+#
 module Sequel
   module DatasetPagination
     # Returns a paginated dataset. The returned dataset is limited to

data/lib/sequel/extensions/pg_array.rb

@@ -52,7 +52,7 @@
 # conversion_procs usingthe appropriate type OID.  For user defined
 # types, you can do this via:
 #
-#   DB.conversion_procs[scalar_type_oid] = lambda{|string| ...}
+#   DB.conversion_procs[scalar_type_oid] = lambda{|string| }
 #
 # Then you can call
 # Sequel::Postgres::PGArray::DatabaseMethods#register_array_type
@@ -66,7 +66,7 @@
 # Sequel::Postgres::PGArray.register.  In this case, you'll have
 # to specify the type oids:
 #
-#   Sequel::Postgres::PG_TYPES[1234] = lambda{|string| ...}
+#   Sequel::Postgres::PG_TYPES[1234] = lambda{|string| }
 #   Sequel::Postgres::PGArray.register('foo', :oid=>4321, :scalar_oid=>1234)
 #
 # Both Sequel::Postgres::PGArray::DatabaseMethods#register_array_type

data/lib/sequel/extensions/pg_array_ops.rb

@@ -65,6 +65,7 @@
 # In order for #hstore to automatically wrap the returned value correctly in
 # an HStoreOp, you need to load the pg_hstore_ops extension.
 
+#
 module Sequel
   module Postgres
     # The ArrayOp class is a simple container for a single object that

data/lib/sequel/extensions/pg_enum.rb

@@ -42,6 +42,7 @@
 # the enum values as symbols when creating enums using create_enum or
 # add_enum_value.
 
+#
 module Sequel
   module Postgres
     # Methods enabling Database object integration with enum types.

data/lib/sequel/extensions/pg_hstore_ops.rb

@@ -66,6 +66,7 @@
 # PostgreSQL arrays will have the returned expression automatically wrapped in a
 # Postgres::ArrayOp if the pg_array_ops extension is loaded.
 
+#
 module Sequel
   module Postgres
     # The HStoreOp class is a simple container for a single object that

data/lib/sequel/extensions/pg_json_ops.rb

@@ -65,6 +65,7 @@
 # (as shown in the #[] and #get_text examples above), you need to load the pg_array
 # extension.
 
+#
 module Sequel
   module Postgres
     # The JSONBaseOp class is a simple container for a single object that

data/lib/sequel/extensions/pg_loose_count.rb

@@ -16,6 +16,7 @@
 #
 #   DB.extension :pg_loose_count
 
+#
 module Sequel
   module Postgres
     module LooseCount

data/lib/sequel/extensions/pg_range_ops.rb

@@ -52,6 +52,7 @@
 # loading this extension.  Doing so will allow you to use PGArray#op to get
 # an RangeOp, allowing you to perform range operations on range literals.
 
+#
 module Sequel
   module Postgres
     # The RangeOp class is a simple container for a single object that

data/lib/sequel/extensions/pg_row_ops.rb

@@ -79,6 +79,7 @@
 #   # SELECT (a.*)::a, (b.*)::b FROM a INNER JOIN b ON (b.id = a.b_id)
 #   # => {:a=>{:id=>1, :b_id=>2}, :b=>{:id=>2}}
 
+#
 module Sequel
   module Postgres
     # This class represents a composite type expression reference.

data/lib/sequel/extensions/pg_static_cache_updater.rb

@@ -62,6 +62,7 @@
 #   use the same Database).
 # * Must be using a thread-safe connection pool (the default).
 
+#
 module Sequel
   module Postgres
     module StaticCacheUpdater

data/lib/sequel/extensions/pretty_table.rb

@@ -19,6 +19,7 @@
 #
 #   DB.extension(:pretty_table)
 
+#
 module Sequel
   extension :_pretty_table
 

data/lib/sequel/extensions/query.rb

@@ -18,6 +18,7 @@
 #
 #   DB.extension(:query)
 
+#
 module Sequel
   module DatabaseQuery
     def self.extended(db)

data/lib/sequel/extensions/query_literals.rb

@@ -31,6 +31,7 @@
 #
 #   DB.extension(:query_literals)
 
+#
 module Sequel
   # The QueryLiterals module can be used to make select, group, and
   # order methods operate similar to the filter methods if the first

data/lib/sequel/extensions/schema_caching.rb

@@ -42,6 +42,7 @@
 # and it handles all ruby objects used in the schema hash.  Because of this,
 # you should not attempt to load the schema from a untrusted file.
 
+#
 module Sequel
   module SchemaCaching
     # Dump the cached schema to the filename given in Marshal format.

data/lib/sequel/extensions/schema_dumper.rb

@@ -105,7 +105,7 @@ END_MIG
     #             will yield the same type.  Without this set, types that aren't
     #             recognized will be translated to a string-like type.
     # :foreign_keys :: If set to false, don't dump foreign_keys (they can be
-    #             added later via #dump_foreign_key_migration)
+    #                  added later via #dump_foreign_key_migration)
     # :indexes :: If set to false, don't dump indexes (they can be added
     #             later via #dump_index_migration).
     # :index_names :: If set to false, don't record names of indexes. If

data/lib/sequel/extensions/select_remove.rb

@@ -12,6 +12,7 @@
 #
 #   DB.extension(:select_remove)
 
+#
 module Sequel
   module SelectRemove
     # Remove columns from the list of selected columns.  If any of the currently selected

data/lib/sequel/extensions/sequel_3_dataset_methods.rb

@@ -19,6 +19,7 @@
 #
 #   DB.extension(:sequel_3_dataset_methods)
 
+#
 module Sequel
   module Sequel3DatasetMethods
     COMMA = Dataset::COMMA

data/lib/sequel/extensions/server_block.rb

@@ -37,6 +37,7 @@
 #     DB[:a].server(:read_only).all # Uses shard1
 #   end
 
+#
 module Sequel
   module ServerBlock
     # Enable the server block on the connection pool, choosing the correct

data/lib/sequel/extensions/set_overrides.rb

@@ -14,6 +14,7 @@
 #
 #   DB.extension(:set_overrides)
 
+#
 module Sequel
   module SetOverrides
     Dataset::NON_SQL_OPTIONS.concat([:defaults, :overrides])

data/lib/sequel/extensions/split_array_nil.rb

@@ -31,6 +31,7 @@
 #
 #   DB.extension(:split_array_nil)
 
+#
 module Sequel
   class Dataset
     module SplitArrayNil

data/lib/sequel/extensions/thread_local_timezones.rb

@@ -34,6 +34,7 @@
 #   Sequel.thread_application_timezone = :nil
 #   Sequel.application_timezone # => nil
 
+#
 module Sequel
   module ThreadLocalTimezones
     %w'application database typecast'.each do |t|

data/lib/sequel/extensions/to_dot.rb

@@ -7,6 +7,7 @@
 #
 #   Sequel.extension :to_dot
 
+#
 module Sequel
   class ToDot
     module DatasetMethods

data/lib/sequel/model/associations.rb

@@ -1791,10 +1791,10 @@ module Sequel
                 select_all(egds.first_source).
                 select_append(*associated_key_array)
               egds = opts.apply_eager_graph_limit_strategy(egls, egds)
-              ds.graph(egds, associated_key_array.map{|v| v.alias}.zip(lpkcs) + conditions, :qualify=>:deep, :table_alias=>eo[:table_alias], :implicit_qualifier=>eo[:implicit_qualifier], :join_type=>eo[:join_type]||join_type, :from_self_alias=>eo[:from_self_alias], :select=>select||orig_egds.columns, &graph_block)
+              ds.graph(egds, associated_key_array.map{|v| v.alias}.zip(lpkcs) + conditions, :qualify=>:deep, :table_alias=>eo[:table_alias], :implicit_qualifier=>eo[:implicit_qualifier], :join_type=>eo[:join_type]||join_type, :from_self_alias=>eo[:from_self_alias], :join_only=>eo[:join_only], :select=>select||orig_egds.columns, &graph_block)
             else
-              ds = ds.graph(join_table, use_jt_only_conditions ? jt_only_conditions : lcks.zip(lpkcs) + graph_jt_conds, :select=>false, :table_alias=>ds.unused_table_alias(join_table, [eo[:table_alias]]), :join_type=>eo[:join_type]||jt_join_type, :implicit_qualifier=>eo[:implicit_qualifier], :qualify=>:deep, :from_self_alias=>eo[:from_self_alias], &jt_graph_block)
-              ds.graph(eager_graph_dataset(opts, eo), use_only_conditions ? only_conditions : opts.right_primary_keys.zip(rcks) + conditions, :select=>select, :table_alias=>eo[:table_alias], :qualify=>:deep, :join_type=>eo[:join_type]||join_type, &graph_block)
+              ds = ds.graph(join_table, use_jt_only_conditions ? jt_only_conditions : lcks.zip(lpkcs) + graph_jt_conds, :select=>false, :table_alias=>ds.unused_table_alias(join_table, [eo[:table_alias]]), :join_type=>eo[:join_type]||jt_join_type, :join_only=>eo[:join_only], :implicit_qualifier=>eo[:implicit_qualifier], :qualify=>:deep, :from_self_alias=>eo[:from_self_alias], &jt_graph_block)
+              ds.graph(eager_graph_dataset(opts, eo), use_only_conditions ? only_conditions : opts.right_primary_keys.zip(rcks) + conditions, :select=>select, :table_alias=>eo[:table_alias], :qualify=>:deep, :join_type=>eo[:join_type]||join_type, :join_only=>eo[:join_only], &graph_block)
             end
           end
       
@@ -2561,7 +2561,7 @@ END
           end
           local_opts = ds.opts[:eager_graph][:local]
           limit_strategy = r.eager_graph_limit_strategy(local_opts[:limit_strategy])
-          ds = loader.call(:self=>ds, :table_alias=>assoc_table_alias, :implicit_qualifier=>(ta == ds.opts[:eager_graph][:master]) ? first_source : qualifier_from_alias_symbol(ta, first_source), :callback=>callback, :join_type=>local_opts[:join_type], :limit_strategy=>limit_strategy, :from_self_alias=>ds.opts[:eager_graph][:master])
+          ds = loader.call(:self=>ds, :table_alias=>assoc_table_alias, :implicit_qualifier=>(ta == ds.opts[:eager_graph][:master]) ? first_source : qualifier_from_alias_symbol(ta, first_source), :callback=>callback, :join_type=>local_opts[:join_type], :join_only=>local_opts[:join_only], :limit_strategy=>limit_strategy, :from_self_alias=>ds.opts[:eager_graph][:master])
           if r[:order_eager_graph] && (order = r.fetch(:graph_order, r[:order]))
             ds = ds.order_more(*qualified_expression(order, assoc_table_alias))
           end
@@ -2614,7 +2614,7 @@ END
         # Return a new dataset with JOINs of the given type added, using the tables and
         # conditions specified by the associations.
         def _association_join(type, associations)
-          clone(:join=>clone(:graph_from_self=>false).eager_graph_with_options(associations, :join_type=>type).opts[:join])
+          clone(:join=>clone(:graph_from_self=>false).eager_graph_with_options(associations, :join_type=>type, :join_only=>true).opts[:join])
         end
 
         # If the association has conditions itself, then it requires additional filters be

data/lib/sequel/model/base.rb

@@ -1351,7 +1351,7 @@ module Sequel
       #   a = Artist[1]
       #   Artist.db.transaction do
       #     a.lock!
-      #     a.update(...)
+      #     a.update(:name=>'A')
       #   end
       def lock!
         _refresh(this.for_update) unless new?
@@ -2091,7 +2091,7 @@ module Sequel
       # Returns all methods that can be used for attribute assignment (those that end with =),
       # depending on the type:
       #
-      # :default :: Use the default methods allowed in th model class. 
+      # :default :: Use the default methods allowed in the model class. 
       # :all :: Allow setting all setters, except those specifically restricted (such as ==).
       # Array :: Only allow setting of columns in the given array.
       def setter_methods(type)
@@ -2249,7 +2249,7 @@ module Sequel
       # If there is no order already defined on this dataset, order it by
       # the primary key and call paged_each.
       #
-      #   Album.paged_each{|row| ...}
+      #   Album.paged_each{|row| }
       #   # SELECT * FROM albums ORDER BY id LIMIT 1000 OFFSET 0
       #   # SELECT * FROM albums ORDER BY id LIMIT 1000 OFFSET 1000
       #   # SELECT * FROM albums ORDER BY id LIMIT 1000 OFFSET 2000

data/lib/sequel/plugins/association_proxies.rb

@@ -35,7 +35,7 @@ module Sequel
     #     :arguments => [2],
     #     :block => {|x| 3},
     #     :instance => artist,
-    #     :reflection => {:name=>:albums, ...},
+    #     :reflection => {:name=>:albums} # AssociationReflection instance 
     #     :proxy_argument => 1,
     #     :proxy_block => {|ds| ds}
     #   }

data/lib/sequel/plugins/caching.rb

@@ -7,8 +7,8 @@ module Sequel
     #    cache_store.set(key, obj, time) # Associate the obj with the given key
     #                                    # in the cache for the time (specified
     #                                    # in seconds).
-    #    cache_store.get(key) => obj     # Returns object set with same key.
-    #    cache_store.get(key2) => nil    # nil returned if there isn't an object
+    #    cache_store.get(key) # => obj   # Returns object set with same key.
+    #    cache_store.get(key2) # => nil  # nil returned if there isn't an object
     #                                    # currently in the cache with that key.
     #    cache_store.delete(key)         # Remove key from cache
     #
@@ -64,10 +64,15 @@ module Sequel
           cache_get(cache_key(pk))
         end
 
+        # Returns the prefix used to namespace this class in the cache.
+        def cache_key_prefix
+          "#{self}"
+        end
+
         # Return a key string for the given primary key.
         def cache_key(pk)
           raise(Error, 'no primary key for this record') unless pk.is_a?(Array) ? pk.all? : pk
-          "#{self}:#{Array(pk).join(',')}"
+          "#{cache_key_prefix}:#{Array(pk).join(',')}"
         end
         
         Plugins.inherited_instance_variables(self, :@cache_store=>nil, :@cache_ttl=>nil, :@cache_ignore_exceptions=>nil)

data/lib/sequel/plugins/class_table_inheritance.rb

@@ -13,20 +13,20 @@ module Sequel
     #
     # the following database schema may be used (table - columns):
     #
-    # * employees - id, name, kind
-    # * staff - id, manager_id
-    # * managers - id, num_staff
-    # * executives - id, num_managers
+    # employees :: id, name, kind
+    # staff :: id, manager_id
+    # managers :: id, num_staff
+    # executives :: id, num_managers
     #
     # The class_table_inheritance plugin assumes that the main table
     # (e.g. employees) has a primary key field (usually autoincrementing),
     # and all other tables have a foreign key of the same name that points
     # to the same key in their superclass's table.  For example:
     #
-    # * employees.id  - primary key, autoincrementing
-    # * staff.id - foreign key referencing employees(id)
-    # * managers.id - foreign key referencing employees(id)
-    # * executives.id - foreign key referencing managers(id)
+    # employees.id :: primary key, autoincrementing
+    # staff.id :: foreign key referencing employees(id)
+    # managers.id :: foreign key referencing employees(id)
+    # executives.id :: foreign key referencing managers(id)
     #
     # When using the class_table_inheritance plugin, subclasses use joined 
     # datasets:
@@ -62,6 +62,13 @@ module Sequel
     #   a = Employee.all # [<#Staff>, <#Manager>, <#Executive>]
     #   a.first.values # {:id=>1, name=>'S', :kind=>'Staff'}
     #   a.first.manager_id # Loads the manager_id attribute from the database
+    #
+    # If you want to get all columns in a subclass instance after loading
+    # via the superclass, call Model#refresh.
+    #
+    #   a = Employee.first
+    #   a.values # {:id=>1, name=>'S', :kind=>'Executive'}
+    #   a.refresh.values # {:id=>1, name=>'S', :kind=>'Executive', :num_staff=>4, :num_managers=>2}
     # 
     # Usage:
     #
@@ -159,6 +166,8 @@ module Sequel
           cmm = cti_model_map
           pk = primary_key
           ds = dataset
+          table = nil
+          columns = nil
           subclass.instance_eval do
             raise(Error, "cannot create anonymous subclass for model class using class_table_inheritance") if !(n = name) || n.empty?
             table = ctm[n.to_sym] || implicit_table_name
@@ -178,9 +187,9 @@ module Sequel
           super
           subclass.instance_eval do
             set_dataset_cti_row_proc
-            (columns - [cbm.primary_key]).each{|a| define_lazy_attribute_getter(a)}
-            cti_tables.reverse.each do |table|
-              db.schema(table).each{|k,v| db_schema[k] = v}
+            (columns - [cbm.primary_key]).each{|a| define_lazy_attribute_getter(a, :dataset=>dataset, :table=>table)}
+            cti_tables.reverse.each do |t|
+              db.schema(t).each{|k,v| db_schema[k] = v}
             end
           end
         end

data/lib/sequel/plugins/composition.rb

@@ -72,24 +72,24 @@ module Sequel
         # You must provide either a :mapping option or both the :composer and :decomposer options. 
         #
         # Options:
-        # * :class - if using the :mapping option, the class to use, as a Class, String or Symbol.
-        # * :composer - A proc that is instance evaled when the composition getter method is called
-        #   to create the composition.
-        # * :decomposer - A proc that is instance evaled before saving the model object,
-        #   if the composition object exists, which sets the columns in the model object
-        #   based on the value of the composition object.
-        # * :mapping - An array where each element is either a symbol or an array of two symbols.
-        #   A symbol is treated like an array of two symbols where both symbols are the same.
-        #   The first symbol represents the getter method in the model, and the second symbol
-        #   represents the getter method in the composition object. Example:
-        #     # Uses columns year, month, and day in the current model
-        #     # Uses year, month, and day methods in the composition object
-        #     :mapping=>[:year, :month, :day]
-        #     # Uses columns year, month, and day in the current model
-        #     # Uses y, m, and d methods in the composition object where
-        #     # for example y in the composition object represents year
-        #     # in the model object.
-        #     :mapping=>[[:year, :y], [:month, :m], [:day, :d]]
+        # :class :: if using the :mapping option, the class to use, as a Class, String or Symbol.
+        # :composer :: A proc that is instance evaled when the composition getter method is called
+        #              to create the composition.
+        # :decomposer :: A proc that is instance evaled before saving the model object,
+        #                if the composition object exists, which sets the columns in the model object
+        #                based on the value of the composition object.
+        # :mapping :: An array where each element is either a symbol or an array of two symbols.
+        #             A symbol is treated like an array of two symbols where both symbols are the same.
+        #             The first symbol represents the getter method in the model, and the second symbol
+        #             represents the getter method in the composition object. Example:
+        #                 # Uses columns year, month, and day in the current model
+        #                 # Uses year, month, and day methods in the composition object
+        #                 {:mapping=>[:year, :month, :day]}
+        #                 # Uses columns year, month, and day in the current model
+        #                 # Uses y, m, and d methods in the composition object where
+        #                 # for example y in the composition object represents year
+        #                 # in the model object.
+        #                 {:mapping=>[[:year, :y], [:month, :m], [:day, :d]]}
         def composition(name, opts=OPTS)
           opts = opts.dup
           compositions[name] = opts