Как обрабатывать конфигурационные файлы в библиотеке PHP

Question

Я написал небольшую библиотеку (https://github.com/dborsatto/php-giantbomb), которая выступает в качестве оболочки для API. Для работы в библиотеке необходимо 2 основные параметры конфигурации:

• АНИ ключ
• Файл, который описывает параметры API

Что такое предложил способ справиться с этими двумя файлами?

Ключ API, конечно, личный, поэтому его нельзя добавить в репозиторий. Но при этом я не могу написать функциональный тест для библиотеки в целом, ограничившись только модульными тестами для отдельных частей. Я вообще отказываюсь от функциональных тестов или есть способ сделать эту работу?

О другой конфигурации, в основном это файл YAML (https://github.com/dborsatto/php-giantbomb/blob/master/api_config.yml), который включает базовую конечную точку API и конфигурацию для каждого репозитория данных. На данный момент это обрабатывается классом Config, который отделен таким образом, что пользователь должен написать код клея и ввести данные в конфигурацию. Таким образом, тест легче тестировать, но в целом я чувствую, что он создает больший недостаток, чем просто позволить классу Config загружать файл, анализировать его и вести себя соответствующим образом. Каков наилучший способ сделать это? На данный момент в репозитории нет тестов, но я работаю над ним (наряду с рефакторингом кода).

Answer 1

Я предлагаю оставить конфигурацию вне вашей библиотеки; Я сделал что-то подобное для службы рассылки Mandrill, где я оставил разработчику управление конфигурацией (я работал в проекте Symfony 2). Для меня нет Config класса, только конструктора сервиса, который принимает ключ API и (опционально) массив опций:

public function __construct($api, $options = array()) 
{ 
    // My code 
} 

Когда мне нужно использовать мою службу внутри приложения Symfony 2, я беру необходимый параметры и конфигурация из места (файлы конфигурации Symfony), внешние по отношению к моей службе; таким образом я могу отделить библиотеку от конфигурации. Разумеется, диспетчер служб генерирует исключение, если отсутствуют обязательные параметры.