Source

libdb-mock-proto-cpp / DB.cpp

Full commit
/*
 Prototype for a mockable database library
 Copyright (C) 2012 Daybo Logic
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. Neither the name of the project nor the names of its contributors
    may be used to endorse or promote products derived from this software
    without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.
*/

/*
  This is the base class, which does the real work for the database,
  at present, is is just a back-end which does nothing, except provide
  a basis to demonstrate the rest of the library.
*/

#include <iostream>
#include "DB.hpp"

DB::DB()
	: tag("DB")
{
}

bool DB::query(const std::string &Query)
{
	// Print the query.  TODO: This should be redirected to a log.
	std::cout << this->name() << ": " << Query << std::endl;
	return false; // FIXME: Everything fails.
}

/*
  the is_mock() function provides a way for users to know whether the database class
  they are using is really a mocked variant.  You should avoid using this, except
  to abort a test-bed before doing a destructive operation, when somebody has accidentally
  pointed the unit tests to a real-backend.  In general, avoid making logic branches based
  on whether the back-end is mocked, or your unit testing will not have full code coverage.
*/
bool DB::is_mock()
{
	// This base class is not mocked, this function is overridden in mock derivatives.
	return false;
}

/*
  The DB::name() function variant accepting a new name may be used by any derived class
  in order to override the tag associated with a database connection, for logging
  purposes.  Attempted to set a string of zero length will be ignored.  The new string
  is returned, to provide consisent behaviour.
*/
const std::string &DB::name(const std::string &NewName)
{
	if ( NewName.length() )
		this->tag.assign(NewName);

	// nb. you can't assign no name.
	return this->name();
}

const std::string &DB::name()
{
	// Return the name associated with the database.
	return this->tag;
}