Merge pull request #7 from EdisonLabs/summary

Added base date and config as constructor parameters

Author: kmoll

README.md

@@ -7,51 +7,16 @@ The Metrics Collector is a simple library that provides base classes to easily e
 
 ## Usage
 
-This library does not provide any metrics by default. To create your own metrics, [create a Composer package](https://getcomposer.org/doc/01-basic-usage.md) and then add a dependency to this package:
+This library does not provide any metrics by default. To create new metrics, [create a Composer package](https://getcomposer.org/doc/01-basic-usage.md) and then add a dependency to this package:
 
 ```
 composer require edisonlabs/metrics
 ```
 
-Now create your metrics classes extending `edisonlabs/metrics` classes.
+Now create the metrics classes extending `edisonlabs/metrics` classes.
 
-In the following example, we will create three metrics:
-- Total number of files that a location has
-- Total number of PHP files
-- Percentage of PHP files
+Example: Number of PHP files.
 
-Create number of files metric:
-```php
-// src/EdisonLabs/Metric/NumberOfFiles.php
-
-namespace EdisonLabs\Metric;
-
-use EdisonLabs\Metrics\Metric\AbstractMetricBase;
-
-class NumberOfFiles extends AbstractMetricBase
-{
-    public function getName()
-    {
-        return 'Number of files';
-    }
-
-    public function getDescription()
-    {
-        return 'The total number of files';
-    }
-
-    public function getMetric()
-    {
-        // Put the logic to calculate the total here.
-        // ..
-
-        // Random example.
-        return rand(10, 100);
-    }
-}
-```
-
-Create number of PHP files metric:
 ```php
 // src/EdisonLabs/Metric/NumberOfPhpFiles.php
 
@@ -82,34 +47,7 @@ class NumberOfPhpFiles extends AbstractMetricBase
 }
 ```
 
-Create the percentage of PHP files metric:
-```php
-// src/EdisonLabs/Metric/PercentageOfPhpFiles.php
-
-namespace EdisonLabs\Metric;
-
-use EdisonLabs\Metrics\Metric\AbstractMetricPercentage;
-
-class PercentageOfPhpFiles extends AbstractMetricPercentage
-{
-    public function __construct(NumberOfFiles $total, NumberOfPhpFiles $count)
-    {
-        parent::__construct($total, $count);
-    }
-
-    public function getName()
-    {
-        return 'PHP files (%)';
-    }
-
-    public function getDescription()
-    {
-        return 'Percentage of PHP files';
-    }
-}
-```
-
-Configure the autoload on the `composer.json` file:
+Configure the autoload in `composer.json`:
 ```json
 "autoload": {
     "psr-4": {
@@ -134,7 +72,10 @@ There are two ways to collect the metrics: programmatically and by command-line.
 
 use EdisonLabs\Metrics\Collector;
 
-$collector = new Collector();
+$date = strtotime('now');
+$config = array();
+
+$collector = new Collector($date, $config);
 $metrics = $collector->getMetrics();
 ```
 
@@ -183,10 +124,13 @@ class SqLite extends AbstractMetricDatastore
 use EdisonLabs\Metrics\Collector;
 use EdisonLabs\Metrics\DatastoreHandler;
 
-$collector = new Collector();
+$date = strtotime('now');
+$config = array();
+
+$collector = new Collector($date, $config);
 $metrics = $collector->getMetrics();
 
-$datastoreHandler = new DatastoreHandler();
+$datastoreHandler = new DatastoreHandler($date, $config);
 $datastore = $datastoreHandler->getDatastoreByName('SQLite');
 $datastore->setMetrics($metrics);
 $datastore->save();

config/services.php

@@ -17,6 +17,8 @@
 if ($finder->count() !== 0) {
     $definition = new Definition();
     $definition
+        ->addArgument('%metrics.date%')
+        ->addArgument('%metrics.config%')
         ->setAutowired(true)
         ->setAutoconfigured(true)
         ->setPublic(true);

src/Collector.php

@@ -12,10 +12,15 @@ class Collector
 
     const METRICS_NAMESPACE = 'EdisonLabs\Metric';
 
+    /**
+     * @var string
+     */
+    protected $date;
+
     /**
      * @var array
      */
-    protected $metrics = array();
+    protected $config;
 
     /**
      * @var array
@@ -25,30 +30,29 @@ class Collector
     /**
      * @var array
      */
-    protected $config;
+    protected $metrics = array();
 
     /**
      * Collector constructor.
      *
-     * @param array $groups
-     *   A list containing the groups to filter for.
-     * @param array $config
-     *   The custom config array.
+     * @param string $date   A date timestamp to collect for.
+     * @param array  $config The custom config array.
+     * @param array  $groups A list containing the groups to filter for.
      *
      * @throws \Exception
      */
-    public function __construct(array $groups = array(), array $config = array())
+    public function __construct($date, array $config = array(), array $groups = array())
     {
         $this->groups = $groups;
         $this->config = $config;
+        $this->date = $date;
         $this->setMetrics();
     }
 
     /**
      * Register a metric to be collected.
      *
-     * @param AbstractMetricBase $metric
-     *   The Metric object.
+     * @param AbstractMetricBase $metric The Metric object.
      */
     public function setMetric(AbstractMetricBase $metric)
     {
@@ -58,8 +62,7 @@ public function setMetric(AbstractMetricBase $metric)
     /**
      * Returns the available metrics.
      *
-     * @return array
-     *   An array containing the metrics objects.
+     * @return array An array containing the metrics objects.
      */
     public function getMetrics()
     {
@@ -73,7 +76,7 @@ public function getMetrics()
      */
     protected function setMetrics()
     {
-        $containerBuilder = new ContainerBuilder();
+        $containerBuilder = new ContainerBuilder($this->date, $this->config);
         $containerBuilder = $containerBuilder->getContainerBuilder();
 
         $services = $containerBuilder->getServiceIds();
@@ -83,6 +86,7 @@ protected function setMetrics()
                 continue;
             }
 
+            /** @var \EdisonLabs\Metrics\Metric\MetricInterface $metric */
             $metric = $containerBuilder->get($serviceName);
 
             // Sanity check by class type.
@@ -95,7 +99,6 @@ protected function setMetrics()
                 continue;
             }
 
-            $metric->setConfig($this->config);
             $this->setMetric($metric);
         }
     }

src/Command/MetricsCommand.php

@@ -51,8 +51,14 @@ protected function initialize(InputInterface $input, OutputInterface $output)
 
         $this->config = $config;
 
+        // Gets the date.
+        $date = $input->getOption('date');
+        if (!$date = strtotime($date)) {
+            throw new RuntimeException('Invalid date string');
+        }
+
         // Sets datastore handler.
-        $this->datastoreHandler = new DatastoreHandler($this->config);
+        $this->datastoreHandler = new DatastoreHandler($date, $this->config);
 
         if ($input->getOption('list-datastores')) {
             return;
@@ -65,7 +71,7 @@ protected function initialize(InputInterface $input, OutputInterface $output)
         }
 
         // Gets metrics.
-        $collector = new Collector($groups, $this->config);
+        $collector = new Collector($date, $this->config, $groups);
         $this->metrics = $collector->getMetrics();
     }
 
@@ -83,18 +89,17 @@ protected function configure()
             ->addOption('save', null, InputOption::VALUE_REQUIRED, 'Save the metrics to target datastores')
             ->addOption('no-messages', null, InputOption::VALUE_NONE, 'Do not output messages')
             ->addOption('groups', null, InputOption::VALUE_REQUIRED, 'Collect metrics from specific groups only', array())
-            ->addOption('config', null, InputOption::VALUE_REQUIRED, 'Pass custom config to the metrics, which can be a file or a string containing JSON format');
+            ->addOption('config', null, InputOption::VALUE_REQUIRED, 'Pass custom config to the metrics, which can be a file or a string containing JSON format')
+            ->addOption('date', null, InputOption::VALUE_REQUIRED, 'Collect metrics from a specific date. Pass a string supported by strtotime()', 'now')
         ;
     }
 
     /**
      * Converts and returns the config parameter value to array.
      *
-     * @param string $config
-     *   The config string.
+     * @param string $config The config string.
      *
-     * @return array
-     *   The config array.
+     * @return array The config array.
      */
     protected function getConfigArray($config)
     {
@@ -120,8 +125,7 @@ protected function getConfigArray($config)
     /**
      * Outputs the metrics on Json format.
      *
-     * @param OutputInterface $output
-     *   Console output object.
+     * @param OutputInterface $output Console output object.
      */
     protected function outputMetricsJson(OutputInterface $output)
     {
@@ -145,12 +149,9 @@ protected function outputMetricsJson(OutputInterface $output)
     /**
      * Outputs a table.
      *
-     * @param array           $header
-     *   An array containing the header columns.
-     * @param array           $rows
-     *   An array containing the table rows.
-     * @param OutputInterface $output
-     *   Console output object.
+     * @param array           $header An array containing the header columns.
+     * @param array           $rows   An array containing the table rows.
+     * @param OutputInterface $output Console output object.
      */
     protected function outputTable(array $header, array $rows, OutputInterface $output)
     {
@@ -166,8 +167,7 @@ protected function outputTable(array $header, array $rows, OutputInterface $outp
     /**
      * Outputs the available datastores on table format.
      *
-     * @param OutputInterface $output
-     *   Console output object.
+     * @param OutputInterface $output Console output object.
      */
     protected function outputDatastoresTable(OutputInterface $output)
     {
@@ -188,8 +188,7 @@ protected function outputDatastoresTable(OutputInterface $output)
     /**
      * Outputs the metrics on table format.
      *
-     * @param OutputInterface $output
-     *   Console output object.
+     * @param OutputInterface $output Console output object.
      */
     protected function outputMetricsTable(OutputInterface $output)
     {

src/ContainerBuilder.php

@@ -18,12 +18,20 @@ class ContainerBuilder
 
     /**
      * ContainerBuilder constructor.
+     *
+     * @param int   $date   The date (timestamp) of the metrics.
+     * @param array $config The custom config array.
+     *
+     * @throws \Exception
      */
-    public function __construct()
+    public function __construct($date = null, array $config = array())
     {
         $containerBuilder = new SymfonyContainerBuilder();
         $loader = new PhpFileLoader($containerBuilder, new FileLocator(__DIR__));
         $loader->load(self::SERVICES_PHP_FILE);
+
+        $containerBuilder->setParameter('metrics.date', $date);
+        $containerBuilder->setParameter('metrics.config', $config);
         $containerBuilder->compile();
 
         $this->containerBuilder = $containerBuilder;
@@ -32,8 +40,7 @@ public function __construct()
     /**
      * Returns the container builder instance.
      *
-     * @return SymfonyContainerBuilder
-     *   Container builder instance.
+     * @return SymfonyContainerBuilder Container builder instance.
      */
     public function getContainerBuilder()
     {