Merge pull request #31 from kschroeder/develop

Oh geez, two things. Added configuration:list-keys and made configur…
magium · Feb 17, 2017 · b4560df · b4560df
2 parents ee596d6 + 629a9f7
commit b4560df
Show file tree

Hide file tree

Showing 16 changed files with 288 additions and 111 deletions.
diff --git a/lib/Config/Builder.php b/lib/Config/Builder.php
@@ -71,15 +71,30 @@ public function getRegisteredConfigurationFiles()
      */
 
     public function build($context = Config::CONTEXT_DEFAULT, ConfigInterface $config = null)
+    {
+
+        if (!$config instanceof Config) {
+            $config = new Config('<config />');
+        }
+
+        $structure = $this->getMergedStructure();
+
+        if (!$structure instanceof \SimpleXMLElement) {
+            throw new InvalidConfigurationException('No configuration files provided');
+        }
+
+        $this->buildConfigurationObject($structure, $config, $context);
+
+        return $config;
+    }
+
+    public function getMergedStructure()
     {
         $files = $this->getRegisteredConfigurationFiles();
         if (!count($files)) {
             throw new MissingConfigurationException('No configuration files have been provided.  Please add via registerConfigurationFile()');
         }
 
-        if (!$config instanceof Config) {
-            $config = new Config('<config />');
-        }
         $structure = null;
         foreach ($files as $file) {
             if (!$file instanceof AdapterInterface) {
@@ -93,16 +108,10 @@ public function build($context = Config::CONTEXT_DEFAULT, ConfigInterface $confi
                 $this->mergeStructure($structure, $simpleXml);
             }
         }
-
-        if (!$structure instanceof \SimpleXMLElement) {
-            throw new InvalidConfigurationException('No configuration files provided');
-        }
-
-        $this->buildConfigurationObject($structure, $config, $context);
-
-        return $config;
+        return $structure;
     }
 
+
     /**
      * @param \SimpleXMLElement $structure The object representing the merged configuration structure
      * @param \SimpleXmlElement $config An empty config object to be populated

diff --git a/lib/Config/BuilderInterface.php b/lib/Config/BuilderInterface.php
@@ -5,6 +5,18 @@
 interface BuilderInterface
 {
 
+    /**
+     * @param string $context
+     * @param ConfigInterface|null $config
+     * @return Config
+     */
+
     public function build($context = Config::CONTEXT_DEFAULT, ConfigInterface $config = null);
 
+    /**
+     * @return \SimpleXMLElement
+     */
+
+    public function getMergedStructure();
+
 }
diff --git a/lib/Console/Command/ConfigurationBuild.php b/lib/Console/Command/ConfigurationBuild.php
@@ -12,6 +12,7 @@
 
 class ConfigurationBuild extends Command
 {
+    use ConfigurationFactoryTrait;
 
     const COMMAND = 'magium:configuration:build';
 
@@ -30,19 +31,6 @@ protected function configure()
         $this->addArgument('context', InputArgument::OPTIONAL, 'Configuration Context (ignore to build all contexts)');
     }
 
-    public function setConfigurationFactory(MagiumConfigurationFactoryInterface $factory)
-    {
-        $this->configurationFactory = $factory;
-    }
-
-    protected function getConfigurationFactory()
-    {
-        if (!$this->configurationFactory instanceof MagiumConfigurationFactoryInterface) {
-            $this->configurationFactory = new MagiumConfigurationFactory();
-        }
-        return $this->configurationFactory;
-    }
-
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $factory = $this->getConfigurationFactory();

diff --git a/lib/Console/Command/ConfigurationFactoryTrait.php b/lib/Console/Command/ConfigurationFactoryTrait.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Magium\Configuration\Console\Command;
+
+use Magium\Configuration\MagiumConfigurationFactory;
+use Magium\Configuration\MagiumConfigurationFactoryInterface;
+
+trait ConfigurationFactoryTrait
+{
+
+    public function setConfigurationFactory(MagiumConfigurationFactoryInterface $factory)
+    {
+        $this->factory = $factory;
+    }
+
+    protected function getConfigurationFactory()
+    {
+        if (!$this->factory instanceof MagiumConfigurationFactoryInterface) {
+            $this->factory = new MagiumConfigurationFactory();
+        }
+        return $this->factory;
+    }
+}
diff --git a/lib/Console/Command/ConfigurationGet.php b/lib/Console/Command/ConfigurationGet.php
@@ -15,6 +15,8 @@
 class ConfigurationGet extends Command
 {
 
+    use ConfigurationFactoryTrait;
+
     const COMMAND = 'magium:configuration:get';
 
     protected $factory;
@@ -31,19 +33,6 @@ protected function configure()
         $this->addArgument('context', InputArgument::OPTIONAL, 'Configuration Context', Config::CONTEXT_DEFAULT);
     }
 
-    public function setConfigurationFactory(MagiumConfigurationFactoryInterface $factory)
-    {
-        $this->factory = $factory;
-    }
-
-    protected function getConfigurationFactory()
-    {
-        if (!$this->factory instanceof MagiumConfigurationFactoryInterface) {
-            $this->factory = new MagiumConfigurationFactory();
-        }
-        return $this->factory;
-    }
-
     protected function getValueFlag(ConfigInterface $config, $path)
     {
         $value = $config->getValueFlag($path);

diff --git a/lib/Console/Command/ConfigurationList.php b/lib/Console/Command/ConfigurationList.php
diff --git a/lib/Console/Command/ConfigurationListKeys.php b/lib/Console/Command/ConfigurationListKeys.php
@@ -0,0 +1,69 @@
+<?php
+
+namespace Magium\Configuration\Console\Command;
+
+use Magium\Configuration\Config\Config;
+use Magium\Configuration\MagiumConfigurationFactory;
+use Magium\Configuration\MagiumConfigurationFactoryInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ConfigurationListKeys extends Command
+{
+
+    const COMMAND = 'magium:configuration:list-keys';
+
+    const INITIAL_MESSAGE = 'Valid configuration keys';
+
+    protected $factory;
+
+    protected function configure()
+    {
+        $this
+            ->setName(self::COMMAND)
+            ->setDescription('List configuration settings')
+            ->setHelp("This command lists all of the configuration setting options")
+        ;
+    }
+
+    public function getConfigurationFactory()
+    {
+        if (!$this->factory instanceof MagiumConfigurationFactoryInterface) {
+            $this->factory = new MagiumConfigurationFactory();
+        }
+        return $this->factory;
+    }
+
+    public function setConfigurationFactory(MagiumConfigurationFactoryInterface $factory)
+    {
+        $this->factory = $factory;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $factory = $this->getConfigurationFactory();
+        $builder = $factory->getBuilder();
+        $merged = $builder->getMergedStructure();
+        $merged->registerXPathNamespace('s', 'http://www.magiumlib.com/Configuration');
+        $elements = $merged->xpath('//s:element');
+        $output->writeln(self::INITIAL_MESSAGE);
+        foreach ($elements as $element) {
+            $elementId = (string)$element['id'];
+            $parent = $element->xpath('..');
+            $groupId = (string)$parent[0]['id'];
+            $parent = $parent[0]->xpath('..');
+            $sectionId = (string)$parent[0]['id'];
+            $description = '';
+            if (isset($element->description)) {
+                $description = sprintf(' (%s)', (string)$element->description);
+            }
+
+            $out = sprintf('%s/%s/%s%s', $sectionId, $groupId, $elementId, $description);
+            $output->writeln($out);
+
+        }
+    }
+
+}
diff --git a/lib/Console/Command/ConfigurationSet.php b/lib/Console/Command/ConfigurationSet.php
@@ -14,6 +14,7 @@
 
 class ConfigurationSet extends Command
 {
+    use ConfigurationFactoryTrait;
 
     const COMMAND = 'magium:configuration:set';
 
@@ -32,18 +33,6 @@ protected function configure()
         $this->addArgument('context', InputArgument::OPTIONAL, 'Configuration Context', Config::CONTEXT_DEFAULT);
     }
 
-    public function setConfigurationFactory(MagiumConfigurationFactoryInterface $factory)
-    {
-        $this->factory = $factory;
-    }
-
-    protected function getConfigurationFactory()
-    {
-        if (!$this->factory instanceof MagiumConfigurationFactoryInterface) {
-            $this->factory = new MagiumConfigurationFactory();
-        }
-        return $this->factory;
-    }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -52,6 +41,20 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $path = $input->getArgument('path');
         $value = $input->getArgument('value');
         $context = $input->getArgument('context');
+
+        $structure = $factory->getBuilder()->getMergedStructure();
+        $structure->registerXPathNamespace('s', 'http://www.magiumlib.com/Configuration');
+        $paths = explode('/', $path);
+        $xpath = '/';
+        foreach ($paths as $pathName) {
+            $xpath .= sprintf('/s:*[@id="%s"]', $pathName);
+        }
+
+        $results = $structure->xpath($xpath);
+        if (!$results) {
+            throw new UnconfiguredPathException(sprintf('Path (%s) is not configured.  Do you need to create a configuration file?', $path));
+        }
+
         $builderFactory->getPersistence()->setValue($path, $value, $context);
 
         $out = sprintf("Set %s to %s (context: %s)", $path, $value, $context);

diff --git a/lib/Console/Command/ContextList.php b/lib/Console/Command/ContextList.php
@@ -11,6 +11,8 @@
 
 class ContextList extends Command
 {
+    use ConfigurationFactoryTrait;
+
     const TAB = '    ';
     const COMMAND = 'magium:configuration:list-contexts';
 
@@ -27,7 +29,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $output->writeln('Context List');
         $output->writeln(['Following is list of contexts shown by inheritance', '']);
-        $factory = new MagiumConfigurationFactory();
+        $factory = $this->getConfigurationFactory();
         $contextFile = $factory->getContextFile();
         $context = $contextFile->toXml();
         $output->writeln($this->formatNode('default', 'Default'));

diff --git a/lib/Console/Command/CreateTable.php b/lib/Console/Command/CreateTable.php
@@ -13,6 +13,8 @@
 class CreateTable extends Command
 {
 
+    use ConfigurationFactoryTrait;
+
     const COMMAND = 'magium:configuration:create-table';
 
     protected function configure()
@@ -29,7 +31,7 @@ protected function configure()
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $output->writeln('Creating configuration table...');
-        $factory = new MagiumConfigurationFactory();
+        $factory = $this->getConfigurationFactory();
         $persistence = $factory->getBuilderFactory()->getPersistence();
         try {
             $persistence->create();

diff --git a/lib/Console/Command/UnconfiguredPathException.php b/lib/Console/Command/UnconfiguredPathException.php
@@ -0,0 +1,5 @@
+<?php
+
+namespace Magium\Configuration\Console\Command;
+
+class UnconfiguredPathException extends \Exception {}
diff --git a/lib/Console/Symfony/CommandList.php b/lib/Console/Symfony/CommandList.php
@@ -5,6 +5,7 @@
 use Magium\Configuration\Console\Command\ConfigurationBuild;
 use Magium\Configuration\Console\Command\ConfigurationGet;
 use Magium\Configuration\Console\Command\ConfigurationList;
+use Magium\Configuration\Console\Command\ConfigurationListKeys;
 use Magium\Configuration\Console\Command\ConfigurationSet;
 use Magium\Configuration\Console\Command\ContextList;
 use Magium\Configuration\Console\Command\CreateTable;
@@ -20,7 +21,7 @@ public function addCommands(Application $application)
         $application->add(new ConfigurationBuild());
         $application->add(new ConfigurationGet());
         $application->add(new ConfigurationSet());
-        $application->add(new ConfigurationList());
+        $application->add(new ConfigurationListKeys());
         $application->add(new ContextList());
         $application->add(new CreateTable());
         $application->setDefaultCommand(DefaultCommand::COMMAND);