Implemented extra config builder extension point

src/SiteConfig/ConfigBuilder.php

@@ -14,6 +14,13 @@ class ConfigBuilder
     private $configFiles = array();
     private $cache = array();
 
+    /**
+     * Third party config builders, indexed by their prefix.
+     *
+     * @var \Graby\SiteConfig\ExtraConfigBuilder[]
+     */
+    private $extraConfigBuilders = [];
+
     /**
      * @param array                $config
      * @param LoggerInterface|null $logger
@@ -40,6 +47,17 @@ public function __construct($config = array(), LoggerInterface $logger = null)
         $this->configFiles = Files::getFiles($this->config['site_config']);
     }
 
+    /**
+     * Adds a ConfigBuilder for an extra, custom configuration.
+     *
+     * @param $prefix
+     * @param \Graby\SiteConfig\ExtraConfigBuilder $extraConfigBuilder
+     */
+    public function addExtraConfigBuilder($prefix, ExtraConfigBuilder $extraConfigBuilder)
+    {
+        $this->extraConfigBuilders[$prefix] = $extraConfigBuilder;
+    }
+
     public function setLogger(LoggerInterface $logger)
     {
         $this->logger = $logger;
@@ -309,6 +327,7 @@ public function mergeConfig(SiteConfig $currentConfig, SiteConfig $newConfig)
      */
     public function parseLines(array $lines)
     {
+        $extraConfigItems = [];
         $config = new SiteConfig();
 
         foreach ($lines as $line) {
@@ -332,6 +351,24 @@ public function parseLines(array $lines)
                 continue;
             }
 
+            foreach (array_keys($this->extraConfigBuilders) as $prefix) {
+                if (strpos($command, $prefix.'_') === false) {
+                    continue;
+                }
+                $command = substr($command, strlen($prefix) + 1);
+                if (!isset($extraConfigItems[$prefix][$command])) {
+                    $extraConfigItems[$prefix][$command] = $val;
+                } elseif (!is_array($extraConfigItems[$prefix][$command])) {
+                    $extraConfigItems[$prefix][$command] = [
+                        $extraConfigItems[$prefix][$command],
+                        $val,
+                    ];
+                } else {
+                    $extraConfigItems[$prefix][$command][] = $val;
+                }
+                continue 2;
+            }
+
             // check for commands where we accept multiple statements
             if (in_array($command, array('title', 'body', 'strip', 'strip_id_or_class', 'strip_image_src', 'single_page_link', 'next_page_link', 'test_url', 'find_string', 'replace_string', 'login_extra_fields'))) {
                 array_push($config->$command, $val);
@@ -350,6 +387,14 @@ public function parseLines(array $lines)
             }
         }
 
+        foreach ($extraConfigItems as $extraConfigBuilderKey => $commands) {
+            if (!isset($this->extraConfigBuilders[$extraConfigBuilderKey])) {
+                continue;
+            }
+            $config->extraConfigs[$extraConfigBuilderKey] =
+                $this->extraConfigBuilders[$extraConfigBuilderKey]->parseCommands($commands);
+        }
+
         return $config;
     }
 }

src/SiteConfig/ExtraConfigBuilder.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Graby\SiteConfig;
+
+interface ExtraConfigBuilder
+{
+    /**
+     * Parses an array of commands => values into a SiteExtraConfig object.
+     *
+     * @param array $commands
+     *
+     * @return \Graby\SiteConfig\SiteExtraConfig
+     */
+    public function parseCommands(array $commands);
+}

src/SiteConfig/SiteConfig.php

@@ -128,6 +128,11 @@ class SiteConfig
      */
     public $login_extra_fields = array();
 
+    /**
+     * @var \Graby\SiteConfig\SiteExtraConfig[]
+     */
+    public $extraConfigs = [];
+
     /**
      * Process HTML with tidy before creating DOM (bool or null if undeclared).
      *

src/SiteConfig/SiteExtraConfig.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Graby\SiteConfig;
+
+interface SiteExtraConfig
+{
+}

tests/GrabyFunctionalTest.php

@@ -335,8 +335,8 @@ public function testMultipage()
             'extractor' => array(
                 'config_builder' => array(
                     'site_config' => array(dirname(__FILE__).'/fixtures/site_config'),
-                )
-            )
+                ),
+            ),
         ));
         $res = $graby->fetchContent('http://www.journaldugamer.com/tests/rencontre-ils-bossaient-sur-une-exclu-kinect-qui-ne-sortira-jamais/');