sequel 3.21.0 → 3.36.0

data/lib/sequel/adapters/mock.rb

@@ -0,0 +1,361 @@
+module Sequel
+  module Mock
+    # Connection class for Sequel's mock adapter.
+    class Connection
+      # Sequel::Mock::Database object that created this connection
+      attr_reader :db
+
+      # Shard this connection operates on, when using Sequel's
+      # sharding support (always :default for databases not using
+      # sharding).
+      attr_reader :server
+
+      # The specific database options for this connection.
+      attr_reader :opts
+
+      # Store the db, server, and opts.
+      def initialize(db, server, opts)
+        @db = db
+        @server = server
+        @opts = opts
+      end
+
+      # Delegate to the db's #_execute method.
+      def execute(sql)
+        @db.send(:_execute, self, sql, :log=>false) 
+      end
+    end
+
+    # Database class for Sequel's mock adapter.
+    class Database < Sequel::Database
+      set_adapter_scheme :mock
+
+      # Map of database type names to module names, used for handling
+      # mock adapters for specific database types.
+      SHARED_ADAPTERS = {
+        'access'=>'Access',
+        'db2'=>'DB2',
+        'firebird'=>'Firebird',
+        'informix'=>'Informix',
+        'mssql'=>'MSSQL',
+        'mysql'=>'MySQL',
+        'oracle'=>'Oracle',
+        'postgres'=>'Postgres',
+        'sqlite'=>'SQLite'
+      }
+
+      # Procs to run for specific database types to get the mock adapter
+      # to work with the shared adapter
+      SHARED_ADAPTER_SETUP = {
+        'postgres' => lambda do |db|
+          db.instance_eval do
+            @server_version = 90103
+            @primary_keys = {}
+            @primary_key_sequences = {}
+            def primary_key(table)
+              :id
+            end
+          end
+        end
+      }
+
+      # Set the autogenerated primary key integer
+      # to be returned when running an insert query.
+      # Argument types supported:
+      #
+      # nil :: Return nil for all inserts
+      # Integer :: Starting integer for next insert, with
+      #            futher inserts getting an incremented
+      #            value
+      # Array :: First insert gets the first value in the
+      #          array, second gets the second value, etc.
+      # Proc :: Called with the insert SQL query, uses
+      #         the value returned
+      # Class :: Should be an Exception subclass, will create a new
+      #          instance an raise it wrapped in a DatabaseError.
+      attr_writer :autoid
+
+      # Set the columns to set in the dataset when the dataset fetches
+      # rows.  Argument types supported:
+      # nil :: Set no columns
+      # Array of Symbols: Used for all datasets
+      # Array (otherwise): First retrieval gets the first value in the
+      #                    array, second gets the second value, etc.
+      # Proc :: Called with the select SQL query, uses the value
+      #         returned, which should be an array of symbols
+      attr_writer :columns
+
+      # Set the hashes to yield by execute when retrieving rows.
+      # Argument types supported:
+      #
+      # nil :: Yield no rows
+      # Hash :: Always yield a single row with this hash
+      # Array of Hashes :: Yield separately for each hash in this array
+      # Array (otherwise) :: First retrieval gets the first value
+      #                      in the array, second gets the second value, etc.
+      # Proc :: Called with the select SQL query, uses
+      #         the value returned, which should be a hash or
+      #         array of hashes.
+      # Class :: Should be an Exception subclass, will create a new
+      #          instance an raise it wrapped in a DatabaseError.
+      attr_writer :fetch
+
+      # Set the number of rows to return from update or delete.
+      # Argument types supported:
+      #
+      # nil :: Return 0 for all updates and deletes
+      # Integer :: Used for all updates and deletes
+      # Array :: First update/delete gets the first value in the
+      #          array, second gets the second value, etc.
+      # Proc :: Called with the update/delete SQL query, uses
+      #         the value returned.
+      # Class :: Should be an Exception subclass, will create a new
+      #          instance an raise it wrapped in a DatabaseError.
+      attr_writer :numrows
+
+      # Mock the server version, useful when using the shared adapters
+      attr_accessor :server_version
+
+      # Additional options supported:
+      #
+      # :autoid :: Call #autoid= with the value
+      # :columns :: Call #columns= with the value
+      # :fetch ::  Call #fetch= with the value
+      # :numrows :: Call #numrows= with the value
+      # :extend :: A module the object is extended with.
+      # :sqls :: The array to store the SQL queries in.
+      def initialize(opts={})
+        super
+        opts = @opts
+        if mod_name = SHARED_ADAPTERS[opts[:host]]
+          @shared_adapter = true
+          require "sequel/adapters/shared/#{opts[:host]}"
+          extend Sequel.const_get(mod_name)::DatabaseMethods
+          extend_datasets Sequel.const_get(mod_name)::DatasetMethods
+          if pr = SHARED_ADAPTER_SETUP[opts[:host]]
+            pr.call(self)
+          end
+        end
+        self.autoid = opts[:autoid]
+        self.columns = opts[:columns]
+        self.fetch = opts[:fetch]
+        self.numrows = opts[:numrows]
+        extend(opts[:extend]) if opts[:extend]
+        @sqls = opts[:sqls] || []
+      end
+
+      # Return a related Connection option connecting to the given shard.
+      def connect(server)
+        Connection.new(self, server, server_opts(server))
+      end
+
+      # Store the sql used for later retrieval with #sqls, and return
+      # the appropriate value using either the #autoid, #fetch, or
+      # #numrows methods.
+      def execute(sql, opts={}, &block)
+        synchronize(opts[:server]){|c| _execute(c, sql, opts, &block)} 
+      end
+      alias execute_ddl execute
+
+      # Store the sql used, and return the value of the #numrows method.
+      def execute_dui(sql, opts={})
+        execute(sql, opts.merge(:meth=>:numrows))
+      end
+
+      # Store the sql used, and return the value of the #autoid method.
+      def execute_insert(sql, opts={})
+        execute(sql, opts.merge(:meth=>:autoid))
+      end
+
+      # Return all stored SQL queries, and clear the cache
+      # of SQL queries.
+      def sqls
+        s = @sqls.dup
+        @sqls.clear
+        s
+      end
+
+      # Enable use of savepoints.
+      def supports_savepoints?
+        shared_adapter? ? super : true
+      end
+
+      private
+
+      def _autoid(sql, v, ds=nil)
+        case v
+        when Integer
+          if ds
+            ds.autoid += 1 if ds.autoid.is_a?(Integer)
+          else
+            @autoid += 1
+          end
+          v
+        else
+          _nextres(v, sql, nil)
+        end
+      end
+
+      def _execute(c, sql, opts={}, &block)
+        sql += " -- args: #{opts[:arguments].inspect}" if opts[:arguments]
+        sql += " -- #{@opts[:append]}" if @opts[:append]
+        sql += " -- #{c.server.is_a?(Symbol) ? c.server : c.server.inspect}" if c.server != :default
+        log_info(sql) unless opts[:log] == false
+        @sqls << sql 
+
+        ds = opts[:dataset]
+        begin
+          if block
+            columns(ds, sql) if ds
+            _fetch(sql, (ds._fetch if ds) || @fetch, &block)
+          elsif meth = opts[:meth]
+            if meth == :numrows
+              _numrows(sql, (ds.numrows if ds) || @numrows)
+            else
+              v = ds.autoid if ds
+              _autoid(sql, v || @autoid, (ds if v))
+            end
+          end
+        rescue => e
+          raise_error(e)
+        end
+      end
+
+      def _fetch(sql, f, &block)
+        case f
+        when Hash
+          yield f.dup
+        when Array
+          if f.all?{|h| h.is_a?(Hash)}
+            f.each{|h| yield h.dup}
+          else
+            _fetch(sql, f.shift, &block)
+          end
+        when Proc
+          h = f.call(sql)
+          if h.is_a?(Hash)
+            yield h.dup
+          elsif h
+            h.each{|h1| yield h1.dup}
+          end
+        when Class
+          if f < Exception
+            raise f
+          else
+            raise Error, "Invalid @autoid/@numrows attribute: #{v.inspect}"
+          end
+        when nil
+          # nothing
+        else
+          raise Error, "Invalid @fetch attribute: #{f.inspect}"
+        end
+      end
+
+      def _nextres(v, sql, default)
+        case v
+        when Integer
+          v
+        when Array
+          v.empty? ? default : _nextres(v.shift, sql, default)
+        when Proc
+          v.call(sql)
+        when Class
+          if v < Exception
+            raise v
+          else
+            raise Error, "Invalid @autoid/@numrows attribute: #{v.inspect}"
+          end
+        when nil
+          default
+        else
+          raise Error, "Invalid @autoid/@numrows attribute: #{v.inspect}"
+        end
+      end
+
+      def _numrows(sql, v)
+        _nextres(v, sql, 0)
+      end
+
+      def columns(ds, sql, cs=@columns)
+        case cs
+        when Array
+          unless cs.empty?
+            if cs.all?{|c| c.is_a?(Symbol)}
+              ds.columns(*cs)
+            else
+              columns(ds, sql, cs.shift)
+            end
+          end
+        when Proc
+          ds.columns(*cs.call(sql))
+        when nil
+          # nothing
+        else
+          raise Error, "Invalid @columns attribute: #{cs.inspect}"
+        end
+      end
+
+      def disconnect_connection(c)
+      end
+
+      def quote_identifiers_default
+        shared_adapter? ? super : false
+      end
+
+      def identifier_input_method_default
+        shared_adapter? ? super : nil
+      end
+
+      def identifier_output_method_default
+        shared_adapter? ? super : nil
+      end
+
+      def shared_adapter?
+        @shared_adapter
+      end
+    end
+
+    class Dataset < Sequel::Dataset
+      Database::DatasetClass = self
+
+      # Override the databases's autoid setting for this dataset
+      attr_accessor :autoid
+
+      # Override the databases's fetch setting for this dataset
+      attr_accessor :_fetch
+
+      # Override the databases's numrows setting for this dataset
+      attr_accessor :numrows
+
+      # If arguments are provided, use them to set the columns
+      # for this dataset and return self.  Otherwise, use the
+      # default Sequel behavior and return the columns.
+      def columns(*cs)
+        if cs.empty?
+          super
+        else
+          @columns = cs
+          self
+        end
+      end
+
+      def fetch_rows(sql, &block)
+        execute(sql, &block)
+      end
+
+      private
+
+      def execute(sql, opts={}, &block)
+        super(sql, opts.merge(:dataset=>self), &block)
+      end
+
+      def execute_dui(sql, opts={}, &block)
+        super(sql, opts.merge(:dataset=>self), &block)
+      end
+
+      def execute_insert(sql, opts={}, &block)
+        super(sql, opts.merge(:dataset=>self), &block)
+      end
+    end
+  end
+end