﻿#region Copyright (c) 2015 James Snape
// <copyright file="DbConnectionExtensions.cs" company="James Snape">
// The MIT License (MIT)
//
// Copyright (c) 2015 James Snape
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// </copyright>
#endregion

namespace Annex
{
    using System;
    using System.Data;

    /// <summary>
    /// DbConnection Extensions
    /// </summary>
    public static class DbConnectionExtensions
    {
        /// <summary>
        /// Opens the specified connection.
        /// </summary>
        /// <remarks>This is a more functional version of Open that returns a value.</remarks>
        /// <param name="connection">The connection.</param>
        /// <returns>The connection that was opened.</returns>
        public static IDbConnection Connect(this IDbConnection connection)
        {
            if (connection == null)
            {
                throw new ArgumentNullException(nameof(connection));
            }

            connection.Open();

            return connection;
        }
    }
}
