sequel 3.33.0 → 3.34.0

data/lib/sequel/extensions/pretty_table.rb

@@ -3,80 +3,14 @@
 # tables.
 
 module Sequel
+  extension :_pretty_table
+
   class Dataset
     # Pretty prints the records in the dataset as plain-text table.
     def print(*cols)
-      Sequel::PrettyTable.print(naked.all, cols.empty? ? columns : cols)
+      ds = naked
+      rows = ds.all
+      Sequel::PrettyTable.print(rows, cols.empty? ? ds.columns : cols)
     end
   end
-
-  module PrettyTable
-    # Prints nice-looking plain-text tables via puts
-    # 
-    #   +--+-------+
-    #   |id|name   |
-    #   |--+-------|
-    #   |1 |fasdfas|
-    #   |2 |test   |
-    #   +--+-------+
-    def self.print(records, columns = nil) # records is an array of hashes
-      columns ||= records.first.keys.sort_by{|x|x.to_s}
-      sizes = column_sizes(records, columns)
-      sep_line = separator_line(columns, sizes)
-
-      puts sep_line
-      puts header_line(columns, sizes)
-      puts sep_line
-      records.each {|r| puts data_line(columns, sizes, r)}
-      puts sep_line
-    end
-
-    ### Private Module Methods ###
-
-    # Hash of the maximum size of the value for each column 
-    def self.column_sizes(records, columns) # :nodoc:
-      sizes = Hash.new {0}
-      columns.each do |c|
-        s = c.to_s.size
-        sizes[c.to_sym] = s if s > sizes[c.to_sym]
-      end
-      records.each do |r|
-        columns.each do |c|
-          s = r[c].to_s.size
-          sizes[c.to_sym] = s if s > sizes[c.to_sym]
-        end
-      end
-      sizes
-    end
-    
-    # String for each data line
-    def self.data_line(columns, sizes, record) # :nodoc:
-      '|' << columns.map {|c| format_cell(sizes[c], record[c])}.join('|') << '|'
-    end
-    
-    # Format the value so it takes up exactly size characters
-    def self.format_cell(size, v) # :nodoc:
-      case v
-      when Bignum, Fixnum
-        "%#{size}d" % v
-      when Float
-        "%#{size}g" % v
-      else
-        "%-#{size}s" % v.to_s
-      end
-    end
-    
-    # String for header line
-    def self.header_line(columns, sizes) # :nodoc:
-      '|' << columns.map {|c| "%-#{sizes[c]}s" % c.to_s}.join('|') << '|'
-    end
-
-    # String for separtor line
-    def self.separator_line(columns, sizes) # :nodoc:
-      '+' << columns.map {|c| '-' * sizes[c]}.join('+') << '+'
-    end
-
-    private_class_method :column_sizes, :data_line, :format_cell, :header_line, :separator_line
-  end
 end
-

data/lib/sequel/extensions/query_literals.rb

@@ -0,0 +1,79 @@
+# The query_literals extension changes Sequel's default behavior of
+# the select, order and group methods so that if the first argument
+# is a regular string, it is treated as a literal string, with the
+# rest of the arguments (if any) treated as placeholder values. This
+# allows you to write code such as:
+#
+#   DB[:table].select('a, b, ?', 2).group('a, b').order('c')
+#
+# The default Sequel behavior would literalize that as:
+#
+#   SELECT 'a, b, ?', 2 FROM table GROUP BY 'a, b' ORDER BY 'c'
+#
+# Using this extension changes the literalization to:
+#
+#   SELECT a, b, 2, FROM table GROUP BY a, b ORDER BY c
+#
+# This extension makes select, group, and order methods operate
+# like filter methods, which support the same interface.
+#
+# There are very few places where Sequel's default behavior is
+# desirable in this area, but for backwards compatibility, the
+# defaults won't be changed until the next major release.
+#
+# Loading this extension does nothing by default except make the
+# Sequel::QueryLiterals module available.  You can extend specific
+# datasets with this module:
+#
+#   ds = DB[:table]
+#   ds.extend(Sequel::QueryLiterals)
+#
+# Order you can extend all of a database's datasets with it, which
+# is probably the desired behavior if you are using this extension:
+#
+#   DB.extend_datasets(Sequel::QueryLiterals)
+
+module Sequel
+  # The QueryLiterals module can be used to make select, group, and
+  # order methods operate similar to the filter methods if the first
+  # argument is a plain string, treating it like a literal string,
+  # with any remaining arguments treated as placeholder values.
+  #
+  # This adds such support to the following methods: select, select_append,
+  # select_group, select_more, group, group_and_count, order, order_append,
+  # and order_more.
+  #
+  # Note that if you pass a block to these methods, it will use the default
+  # implementation without the special literal handling.
+  module QueryLiterals
+    %w'select select_append select_group select_more group group_and_count order order_append order_more'.each do |m|
+      class_eval(<<-END, __FILE__, __LINE__ + 1)
+        def #{m}(*args)
+          if !block_given? && (l = query_literal(args))
+            super(l)
+          else
+            super
+          end
+        end
+      END
+    end
+
+    private
+
+    # If the first argument is a plain string, return a literal string
+    # if there are no additional args or a placeholder literal string with
+    # the remaining args.  Otherwise, return nil.
+    def query_literal(args)
+      case (s = args[0])
+      when LiteralString, SQL::Blob
+        nil
+      when String
+        if args.length == 1
+          LiteralString.new(s)
+        else
+          SQL::PlaceholderLiteralString.new(s, args[1..-1])
+        end
+      end
+    end
+  end
+end

data/lib/sequel/extensions/schema_caching.rb

@@ -0,0 +1,76 @@
+# The schema_caching extension adds a few methods to Sequel::Database
+# that make it easy to dump the parsed schema information to a file,
+# and load it from that file.  Loading the schema information from a
+# dumped file is faster than parsing it from the database, so this
+# can save bootup time for applications with large numbers of models.
+#
+# Basic usage in application code:
+#
+#   Sequel.extension :schema_caching
+#
+#   DB = Sequel.connect('...')
+#
+#   DB.load_schema_cache('/path/to/schema.dump')
+#
+#   # load model files
+#
+# Then, whenever the database schema is modified, write a new cached
+# file.  You can do that with <tt>bin/sequel</tt>'s -S option:
+#
+#   bin/sequel -S /path/to/schema.dump postgres://...
+#
+# Alternatively, if you don't want to dump the schema information for
+# all tables, and you don't worry about race conditions, you can
+# choose to use the following in your application code:
+#
+#   Sequel.extension :schema_caching
+#
+#   DB = Sequel.connect('...')
+#
+#   DB.load_schema_cache?('/path/to/schema.dump')
+#
+#   # load model files
+#
+#   DB.dump_schema_cache?('/path/to/schema.dump')
+#
+# With this method, you just have to delete the schema dump file if
+# the schema is modified, and the application will recreate it for you
+# using just the tables that your models use.
+#
+# Note that it is up to the application to ensure that the dumped
+# cached schema reflects the current state of the database.  Sequel
+# does no checking to ensure this, as checking would take time and the
+# purpose of this code is to take a shortcut.
+#
+# The cached schema is dumped in Marshal format, since it is the fastest
+# 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
+  class Database
+    # Dump the cached schema to the filename given in Marshal format.
+    def dump_schema_cache(file)
+      File.open(file, 'wb'){|f| f.write(Marshal.dump(@schemas))}
+      nil
+    end
+
+    # Dump the cached schema to the filename given unless the file
+    # already exists.
+    def dump_schema_cache?(file)
+      dump_schema_cache(file) unless File.exist?(file)
+    end
+
+    # Replace the schema cache with the data from the given file, which
+    # should be in Marshal format.
+    def load_schema_cache(file)
+      @schemas = Marshal.load(File.read(file))
+      nil
+    end
+
+    # Replace the schema cache with the data from the given file if the
+    # file exists.
+    def load_schema_cache?(file)
+      load_schema_cache(file) if File.exist?(file)
+    end
+  end
+end

data/lib/sequel/extensions/schema_dumper.rb

@@ -6,6 +6,24 @@
 
 module Sequel
   class Database
+    # Dump foreign key constraints for all tables as a migration. This complements
+    # the :foreign_keys=>false option to dump_schema_migration. This only dumps
+    # the constraints (not the columns) using alter_table/add_foreign_key with an
+    # array of columns.
+    #
+    # Note that the migration this produces does not have a down
+    # block, so you cannot reverse it.
+    def dump_foreign_key_migration(options={})
+      ts = tables(options)
+      <<END_MIG
+Sequel.migration do
+  up do
+#{ts.sort_by{|t| t.to_s}.map{|t| dump_table_foreign_keys(t)}.reject{|x| x == ''}.join("\n\n").gsub(/^/o, '    ')}
+  end
+end
+END_MIG
+    end
+
     # Dump indexes for all tables as a migration.  This complements
     # the :indexes=>false option to dump_schema_migration. Options:
     # * :same_db - Create a dump for the same database type, so
@@ -19,7 +37,7 @@ Sequel.migration do
   end
   
   down do
-#{ts.sort_by{|t| t.to_s}.map{|t| dump_table_indexes(t, :drop_index, options)}.reject{|x| x == ''}.join("\n\n").gsub(/^/o, '    ')}
+#{ts.sort_by{|t| t.to_s}.reverse.map{|t| dump_table_indexes(t, :drop_index, options)}.reject{|x| x == ''}.join("\n\n").gsub(/^/o, '    ')}
   end
 end
 END_MIG
@@ -32,18 +50,35 @@ END_MIG
     #   ruby types, but there is no guarantee that the migration generated
     #   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
     # * :indexes - If set to false, don't dump indexes (they can be added
     #   later via dump_index_migration).
     def dump_schema_migration(options={})
-      ts = tables(options)
+      options = options.dup
+      if options[:indexes] == false && !options.has_key?(:foreign_keys)
+        # Unless foreign_keys option is specifically set, disable if indexes
+        # are disabled, as foreign keys that point to non-primary keys rely
+        # on unique indexes being created first
+        options[:foreign_keys] = false
+      end
+
+      ts = sort_dumped_tables(tables(options), options)
+      skipped_fks = if sfk = options[:skipped_foreign_keys]
+        # Handle skipped foreign keys by adding them at the end via
+        # alter_table/add_foreign_key.  Note that skipped foreign keys
+        # probably result in a broken down migration.
+        sfka = sfk.sort_by{|table, fks| table.to_s}.map{|table, fks| dump_add_fk_constraints(table, fks.values)}
+        sfka.join("\n\n").gsub(/^/o, '    ') unless sfka.empty?
+      end
+
       <<END_MIG
 Sequel.migration do
   up do
-#{ts.sort_by{|t| t.to_s}.map{|t| dump_table_schema(t, options)}.join("\n\n").gsub(/^/o, '    ')}
+#{ts.map{|t| dump_table_schema(t, options)}.join("\n\n").gsub(/^/o, '    ')}#{"\n    \n" if skipped_fks}#{skipped_fks}
   end
   
   down do
-    drop_table(#{ts.sort_by{|t| t.to_s}.inspect[1...-1]})
+    drop_table(#{ts.reverse.inspect[1...-1]})
   end
 end
 END_MIG
@@ -53,24 +88,9 @@ END_MIG
     # table's schema.  Takes the same options as dump_schema_migration.
     def dump_table_schema(table, options={})
       table = table.value.to_s if table.is_a?(SQL::Identifier)
-      raise(Error, "must provide table as a Symbol, String, or Sequel::SQL::Identifier") unless [String, Symbol].any?{|c| table.is_a?(c)}
-      s = schema(table).dup
-      pks = s.find_all{|x| x.last[:primary_key] == true}.map{|x| x.first}
-      options = options.merge(:single_pk=>true) if pks.length == 1
-      m = method(:column_schema_to_generator_opts)
-      im = method(:index_to_generator_opts)
-      begin
-        indexes = indexes(table).sort_by{|k,v| k.to_s} if options[:indexes] != false
-      rescue Sequel::NotImplemented
-        nil
-      end
-      gen = Schema::Generator.new(self) do
-        s.each{|name, info| send(*m.call(name, info, options))}
-        primary_key(pks) if !@primary_key && pks.length > 0
-        indexes.each{|iname, iopts| send(:index, iopts[:columns], im.call(table, iname, iopts))} if indexes
-      end
+      gen = dump_table_generator(table, options)
       commands = [gen.dump_columns, gen.dump_constraints, gen.dump_indexes].reject{|x| x == ''}.join("\n\n")
-      "create_table(#{table.inspect}#{', :ignore_index_errors=>true' if !options[:same_db] && options[:indexes] != false && indexes && !indexes.empty?}) do\n#{commands.gsub(/^/o, '  ')}\nend"
+      "create_table(#{table.inspect}#{', :ignore_index_errors=>true' if !options[:same_db] && options[:indexes] != false && !gen.indexes.empty?}) do\n#{commands.gsub(/^/o, '  ')}\nend"
     end
 
     private
@@ -82,7 +102,7 @@ END_MIG
       if default.is_a?(String) && options[:same_db] && use_column_schema_to_ruby_default_fallback?
         default = default.to_s
         def default.inspect
-          "#{super}.lit"
+          "#{super}.lit"  # core_sql use
         end
         default
       end
@@ -93,6 +113,7 @@ END_MIG
     def column_schema_to_generator_opts(name, schema, options)
       if options[:single_pk] && schema_autoincrementing_primary_key?(schema)
         type_hash = options[:same_db] ? {:type=>schema[:db_type]} : column_schema_to_ruby_type(schema)
+        [:table, :key, :on_delete, :on_update, :deferrable].each{|f| type_hash[f] = schema[f] if schema[f]}
         if type_hash == {:type=>Integer} || type_hash == {:type=>"integer"}
           [:primary_key, name]
         else
@@ -109,7 +130,12 @@ END_MIG
         end
         col_opts.delete(:default) if col_opts[:default].nil?
         col_opts[:null] = false if schema[:allow_null] == false
-        [:column, name, type, col_opts]
+        if table = schema[:table]
+          [:key, :on_delete, :on_update, :deferrable].each{|f| col_opts[f] = schema[f] if schema[f]}
+          [:foreign_key, name, table, col_opts]
+        else
+          [:column, name, type, col_opts]
+        end
       end
     end
 
@@ -120,7 +146,7 @@ END_MIG
       case t = schema[:db_type].downcase
       when /\A(?:medium|small)?int(?:eger)?(?:\((?:\d+)\))?(?: unsigned)?\z/o
         {:type=>Integer}
-      when /\Atinyint(?:\((\d+)\))?\z/o
+      when /\Atinyint(?:\((\d+)\))?(?: unsigned)?\z/o
         {:type =>schema[:type] == :boolean ? TrueClass : Integer}
       when /\Abigint(?:\((?:\d+)\))?(?: unsigned)?\z/o
         {:type=>Bignum}
@@ -156,12 +182,99 @@ END_MIG
       end
     end
 
+    # For the table and foreign key metadata array, return an alter_table
+    # string that would add the foreign keys if run in a migration.
+    def dump_add_fk_constraints(table, fks)
+      sfks = "alter_table(#{table.inspect}) do\n"
+      sfks << Schema::Generator.new(self) do
+        fks.sort_by{|fk| fk[:columns].map{|c| c.to_s}}.each do |fk|
+          foreign_key fk[:columns], fk
+        end
+      end.dump_constraints.gsub(/^foreign_key /, '  add_foreign_key ')
+      sfks << "\nend"
+    end
+
+    # For the table given, get the list of foreign keys and return an alter_table
+    # string that would add the foreign keys if run in a migration.
+    def dump_table_foreign_keys(table, options={})
+      begin
+        fks = foreign_key_list(table, options).sort_by{|fk| fk[:columns].map{|c| c.to_s}}
+      rescue Sequel::NotImplemented
+        return ''
+      end
+
+      if fks.empty?
+        ''
+      else
+        dump_add_fk_constraints(table, fks)
+      end
+    end
+
+    # Return a Schema::Generator object that will recreate the
+    # table's schema.  Takes the same options as dump_schema_migration.
+    def dump_table_generator(table, options={})
+      table = table.value.to_s if table.is_a?(SQL::Identifier)
+      raise(Error, "must provide table as a Symbol, String, or Sequel::SQL::Identifier") unless [String, Symbol].any?{|c| table.is_a?(c)}
+      s = schema(table).dup
+      pks = s.find_all{|x| x.last[:primary_key] == true}.map{|x| x.first}
+      options = options.merge(:single_pk=>true) if pks.length == 1
+      m = method(:column_schema_to_generator_opts)
+      im = method(:index_to_generator_opts)
+
+      if options[:indexes] != false
+        begin
+          indexes = indexes(table).sort_by{|k,v| k.to_s}
+        rescue Sequel::NotImplemented
+          nil
+        end
+      end
+
+      if options[:foreign_keys] != false
+        begin
+          fk_list = foreign_key_list(table)
+          
+          if (sfk = options[:skipped_foreign_keys]) && (sfkt = sfk[table])
+            fk_list.delete_if{|fk| sfkt.has_key?(fk[:columns])}
+          end
+
+          composite_fks, single_fks = fk_list.partition{|h| h[:columns].length > 1}
+          fk_hash = {}
+
+          single_fks.each do |fk|
+            column = fk.delete(:columns).first
+            fk.delete(:name)
+            fk_hash[column] = fk
+          end
+
+          s = s.map do |name, info|
+            if fk_info = fk_hash[name]
+              [name, fk_info.merge(info)]
+            else
+              [name, info]
+            end
+          end
+        rescue Sequel::NotImplemented
+          nil
+        end
+      end
+
+      Schema::Generator.new(self) do
+        s.each{|name, info| send(*m.call(name, info, options))}
+        primary_key(pks) if !@primary_key && pks.length > 0
+        indexes.each{|iname, iopts| send(:index, iopts[:columns], im.call(table, iname, iopts))} if indexes
+        composite_fks.each{|fk| send(:foreign_key, fk[:columns], fk)} if composite_fks
+      end
+    end
+
     # Return a string that containing add_index/drop_index method calls for
     # creating the index migration.
     def dump_table_indexes(table, meth, options={})
-      return '' unless respond_to?(:indexes)
+      begin
+        indexes = indexes(table).sort_by{|k,v| k.to_s}
+      rescue Sequel::NotImplemented
+        return ''
+      end
       im = method(:index_to_generator_opts)
-      indexes = indexes(table).sort_by{|k,v| k.to_s} 
       gen = Schema::Generator.new(self) do
         indexes.each{|iname, iopts| send(:index, iopts[:columns], im.call(table, iname, iopts))}
       end
@@ -175,6 +288,70 @@ END_MIG
       h[:unique] = true if index_opts[:unique]
       h
     end
+
+    # Sort the tables so that referenced tables are created before tables that
+    # reference them, and then by name.  If foreign keys are disabled, just sort by name.
+    def sort_dumped_tables(tables, options={})
+      sort_topologically = if options[:foreign_keys] != false
+        begin
+          foreign_key_list(:some_table_that_does_not_exist)
+          true
+        rescue Sequel::NotImplemented
+          false
+        rescue
+          true
+        end
+      end
+
+      if sort_topologically
+        table_fks = {}
+        tables.each{|t| table_fks[t] = foreign_key_list(t)}
+        # Remove self referential foreign keys, not important when sorting.
+        table_fks.each{|t, fks| fks.delete_if{|fk| fk[:table] == t}}
+        tables, skipped_foreign_keys = sort_dumped_tables_topologically(table_fks, [])
+        options[:skipped_foreign_keys] = skipped_foreign_keys
+        tables
+      else
+        tables.sort_by{|t| t.to_s}
+      end
+    end
+
+    # Do a topological sort of tables, so that referenced tables
+    # come before referencing tables.  Returns an array of sorted
+    # tables and a hash of skipped foreign keys.  The hash will be
+    # empty unless there are circular dependencies.
+    def sort_dumped_tables_topologically(table_fks, sorted_tables)
+      skipped_foreign_keys = {}
+
+      until table_fks.empty? 
+        this_loop = []
+
+        table_fks.each do |table, fks|
+          fks.delete_if{|fk| !table_fks.has_key?(fk[:table])}
+          this_loop << table if fks.empty?
+        end
+
+        if this_loop.empty?
+          # No tables were changed this round, there must be a circular dependency.
+          # Break circular dependency by picking the table with the least number of
+          # outstanding foreign keys and skipping those foreign keys.
+          # The skipped foreign keys will be added at the end of the
+          # migration.
+          skip_table, skip_fks = table_fks.sort_by{|table, fks| [fks.length, table.to_s]}.first
+          skip_fks_hash = skipped_foreign_keys[skip_table] = {}
+          skip_fks.each{|fk| skip_fks_hash[fk[:columns]] = fk}
+          this_loop << skip_table
+        end
+
+        # Add sorted tables from this loop to the final list
+        sorted_tables.concat(this_loop.sort_by{|t| t.to_s})
+
+        # Remove tables that were handled this loop
+        this_loop.each{|t| table_fks.delete(t)}
+      end
+
+      [sorted_tables, skipped_foreign_keys]
+    end
     
     # Don't use the "...".lit fallback on MySQL, since the defaults it uses aren't
     # valid literal SQL values.
@@ -190,6 +367,10 @@ END_MIG
       def dump_columns
         strings = []
         cols = columns.dup
+        cols.each do |x|
+          x.delete(:on_delete) if x[:on_delete] == :no_action
+          x.delete(:on_update) if x[:on_update] == :no_action
+        end
         if pkn = primary_key_name
           cols.delete_if{|x| x[:name] == pkn}
           pk = @primary_key.dup
@@ -200,12 +381,17 @@ END_MIG
         cols.each do |c|
           c = c.dup
           name = c.delete(:name)
-          type = c.delete(:type)
-          opts = opts_inspect(c)
-          strings << if type.is_a?(Class)
-            "#{type.name} #{name.inspect}#{opts}"
+          strings << if table = c.delete(:table)
+            c.delete(:type) if c[:type] == Integer || c[:type] == 'integer'
+            "foreign_key #{name.inspect}, #{table.inspect}#{opts_inspect(c)}"
           else
-            "column #{name.inspect}, #{type.inspect}#{opts}"
+            type = c.delete(:type)
+            opts = opts_inspect(c)
+            if type.is_a?(Class)
+              "#{type.name} #{name.inspect}#{opts}"
+            else
+              "column #{name.inspect}, #{type.inspect}#{opts}"
+            end
           end
         end
         strings.join("\n")
@@ -226,6 +412,13 @@ END_MIG
             else
               "#{name ? "constraint #{name.inspect}," : 'check'} #{c[:check].map{|x| x.inspect}.join(', ')}"
             end
+          when :foreign_key
+            c.delete(:on_delete) if c[:on_delete] == :no_action
+            c.delete(:on_update) if c[:on_update] == :no_action
+            c.delete(:deferrable) unless c[:deferrable]
+            cols = c.delete(:columns)
+            table = c.delete(:table)
+            "#{type} #{cols.inspect}, #{table.inspect}#{opts_inspect(c)}"
           else
             cols = c.delete(:columns)
             "#{type} #{cols.inspect}#{opts_inspect(c)}"
@@ -256,6 +449,9 @@ END_MIG
 
       private
 
+      # Return a string that converts the given options into one
+      # suitable for literal ruby code, handling default values
+      # that don't default to a literal interpretation.
       def opts_inspect(opts)
         if opts[:default]
           opts = opts.dup