// Copyright (C) 2015 xaizek <xaizek@posteo.net>
//
// This file is part of dit.
//
// dit is free software: you can redistribute it and/or modify
// it under the terms of version 3 of the GNU Affero General Public
// License as published by the Free Software Foundation.
//
// dit is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with dit.  If not, see <http://www.gnu.org/licenses/>.

#ifndef DIT__PROJECT_HPP__
#define DIT__PROJECT_HPP__

#include <functional>
#include <memory>
#include <string>

#include "utils/Passkey.hpp"
#include "Config.hpp"
#include "Storage.hpp"

class Tests;

/**
 * @brief Project, parent of items.
 */
class Project
{
public:
    /**
     * @brief Initializes new project.
     *
     * @param rootDir Root directory of the project.
     *
     * @throws std::runtime_error If project directory already exists.
     */
    static void init(const std::string &rootDir);

public:
    /**
     * @brief Type of function that should create project configurations.
     *
     * The argument is a path to real configuration file.
     *
     * Return value is a pair of proxy (unsaved) and real configuration.
     */
    using mkConfig =
        std::function<std::pair<Config,
                                std::unique_ptr<Config>>(std::string path)>;

    /**
     * @brief Creates an instance of particular project.
     *
     * The configuration is created standalone.
     *
     * @param rootDir Root directory of the project.
     */
    explicit Project(std::string rootDir);
    /**
     * @brief Creates an instance of particular project.
     *
     * @param rootDir Root directory of the project.
     * @param makeConfig Function that opens configuration by path.
     */
    Project(std::string rootDir, mkConfig makeConfig);
    /**
     * @brief Same as normal ctor, but marks associated storage as loaded.
     *
     * @p makeConfig can be empty.
     *
     * @param rootDir Root directory of the project.
     * @param makeConfig Function that opens configuration by path.
     */
    Project(std::string rootDir, mkConfig makeConfig, pk<Tests>);
    /**
     * @brief Emit destructor in the corresponding source file.
     */
    ~Project();

public:
    /**
     * @brief Checks whether project exists.
     *
     * @returns @c true if so, @c false otherwise.
     */
    bool exists() const;
    /**
     * @brief Retrieves name of the project.
     *
     * @returns The name.
     */
    std::string getName() const;
    /**
     * @brief Retrieves storage associates with this project.
     *
     * @returns The storage.
     */
    Storage & getStorage();
    /**
     * @brief Retrieves configuration of the project.
     *
     * @param proxy Whether retrieve proxy or real configuration.
     *
     * @returns The configuration, which state is never saved.
     */
    Config & getConfig(bool proxy = true);
    /**
     * @brief Retrieves path to directory where items are stored.
     *
     * @returns The path.
     */
    const std::string & getDataDir() const;
    /**
     * @brief Stores all project related data.
     *
     * @throws boost::filesystem::filesystem_error On issues with storage.
     * @throws std::runtime_error On data write failure.
     */
    void save();

private:
    /**
     * @brief Configuration of the project.
     *
     * First element is a proxy that is not saved.
     * Second one is real configuration.
     */
    std::pair<Config, std::unique_ptr<Config>> configs;
    /**
     * @brief Storage of the project.
     */
    Storage storage;
    /**
     * @brief Path to root directory of the project.
     */
    const std::string rootDir;
    /**
     * @brief Path to directory containing items.
     */
    std::string dataDir;
};

#endif // DIT__PROJECT_HPP__