added csv, labels filtering, new config and first steps towards merge requests

Author: kriskbx

composer.json

@@ -14,7 +14,8 @@
     "illuminate/support": "^5.4",
     "nesbot/carbon": "^1.22",
     "symfony/yaml": "^3.2",
-    "symfony/process": "^3.2"
+    "symfony/process": "^3.2",
+    "league/csv": "^8.2"
   },
   "autoload": {
     "psr-4": {

composer.lock

@@ -50,6 +50,9 @@ gtt report ["namespace/project"] [issue_id]
 gtt report:month ["2017-03"] ["namespace/project"]
 gtt report:day ["2017-03-01"] ["namespace/project"]
 
+# timeframe
+git report --from="2017-03-01" --to="2017-04-01"
+
 # include closed issues
 gtt report --closed=true
 
@@ -65,14 +68,21 @@ gtt report --date_format="d.m.Y H:i:s"
 # overwrite the default columns or the columns stored in your config
 gtt report --columns=iid --columns=title --columns=estimation
 
-# only include the given labels in the results, overwrites the includeLabels stored in your config file
+# only include issues and merge requests that have the following labels, overwrites the includeByLabels store in your config
+gtt report --include_by_labels=critical --include_by_labels=important
+
+# exclude issues and merge requests that have the following labels, overwrites the excludeByLabels store in your config
+gtt report --exclude_by_labels=wont-fix --exclude_by_labels=ignore
+
+# only include the given labels in the results, overwrites the includeLabels stored in your config
 gtt report --include_labels=pending --include_labels=approved
 
-# exclude the given labels from the results, overwrites the excludeLabels stored in your config file
+# exclude the given labels from the results, overwrites the excludeLabels stored in your config
 gtt report --exclude_labels=bug --exclude_labels=feature
 
-# choose a different output than a stdout table (csv & json coming soon)
+# choose a different output than a stdout table (json coming soon)
 gtt report --output=markdown --file=filename.md
+gtt report --output=csv --file=filename.csv
 ```
 
 #### time tracking
@@ -96,13 +106,14 @@ project: namespace/projectname
 # include closed by default
 closed: true
 
-# default milestone
+# default milestone to filter issues by
 milestone: milestone_name
 
 # hours per day
 hoursPerDay: 8
 
-# columns
+# columns to include in the report
+# available columns: id, iid, title, 
 columns:
 - iid
 - title
@@ -114,6 +125,16 @@ dateFormat: Y-m-d H:i:s
 # default output
 output: markdown
 
+# exclude issues and merge requests that have the following labels
+excludeByLabels:
+- wont-fix
+- ignore
+
+# only include issues and merge request that have the following labels
+includeByLabels:
+- critical
+- important
+
 # exclude the following labels in the results
 excludeLabels:
 - bug

readme.md

@@ -6,7 +6,11 @@
 
 use Gitlab\Api\AbstractApi;
 
-class TimeStats extends AbstractApi
+/**
+ * Class TimeStats
+ * @package kriskbx\gtt\Api
+ */
+class IssueTimeStats extends AbstractApi
 {
     /**
      * @param int $project_id

src/Api/TimeStats.php src/Api/IssueTimeStats.phpsrc/Api/TimeStats.php renamed to src/Api/IssueTimeStats.php

@@ -3,10 +3,16 @@
 
 namespace kriskbx\gtt\Api;
 
-
+/**
+ * Class Issues
+ * @package kriskbx\gtt\Api
+ */
 class Issues extends \Gitlab\Api\Issues
 {
     /**
+     * Overwriting the GitLab API package showComments function, because it doesn't
+     * support pagination.
+     *
      * @param int $project_id
      * @param int $issue_id
      * @param int $page
@@ -16,11 +22,12 @@ class Issues extends \Gitlab\Api\Issues
      */
     public function showComments($project_id, $issue_id, $page = 1, $per_page = self::PER_PAGE)
     {
-        $params = array_merge(array(
-            'page' => $page,
+        $params = [
+            'page'     => $page,
             'per_page' => $per_page
-        ));
+        ];
 
-        return $this->get($this->getProjectPath($project_id, 'issues/'.$this->encodePath($issue_id)).'/notes', $params);
+        return $this->get($this->getProjectPath($project_id, 'issues/' . $this->encodePath($issue_id)) . '/notes',
+            $params);
     }
 }

src/Api/Issues.php

@@ -0,0 +1,26 @@
+<?php
+
+
+namespace kriskbx\gtt\Api;
+
+
+use Gitlab\Api\AbstractApi;
+
+/**
+ * Class TimeStats
+ * @package kriskbx\gtt\Api
+ */
+class MergeRequestTimeStats extends AbstractApi
+{
+    /**
+     * @param int $project_id
+     * @param int $issue_id
+     *
+     * @return mixed
+     */
+    public function getTimeStats($project_id, $issue_id)
+    {
+        return $this->get($this->getProjectPath($project_id,
+                'merge_request/' . $this->encodePath($issue_id)) . '/time_stats');
+    }
+}

src/Api/MergeRequestTimeStats.php

@@ -0,0 +1,30 @@
+<?php
+
+
+namespace kriskbx\gtt\Api;
+
+
+class MergeRequests extends \Gitlab\Api\MergeRequests
+{
+    /**
+     * Overwriting the GitLab API package showComments function, because it doesn't
+     * support pagination.
+     *
+     * @param int $project_id
+     * @param int $mr_id
+     * @param int $page
+     * @param int $per_page
+     *
+     * @return mixed
+     */
+    public function showComments($project_id, $mr_id, $page = 1, $per_page = self::PER_PAGE)
+    {
+        $params = [
+            'page'     => $page,
+            'per_page' => $per_page
+        ];
+
+        return $this->get($this->getProjectPath($project_id,
+            'merge_request/' . $this->encodePath($mr_id) . '/comments'), $params);
+    }
+}

src/Api/MergeRequests.php

@@ -7,6 +7,12 @@
 use Illuminate\Support\Collection;
 use kriskbx\gtt\Time;
 
+/**
+ * Class TimesCollection
+ *
+ * Time should be rendered differently, so we extend the base Collection and implement our own toString method.
+ * @package kriskbx\gtt\Collection
+ */
 class TimesCollection extends Collection
 {
     /**

src/Collection/TimesCollection.php

@@ -4,8 +4,9 @@
 namespace kriskbx\gtt\Commands;
 
 use Gitlab\Client;
-use kriskbx\gtt\Output\Csv;
-use kriskbx\gtt\Output\Markdown;
+use kriskbx\gtt\Config\Config;
+use kriskbx\gtt\Output\CsvOutput;
+use kriskbx\gtt\Output\MarkdownOutput;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputInterface;
@@ -16,7 +17,7 @@ class BaseCommand extends Command
 {
     /**
      * Config array.
-     * @var array
+     * @var Config
      */
     protected $config;
 
@@ -31,16 +32,17 @@ class BaseCommand extends Command
      * @var array
      */
     protected $outputs = [
-        'markdown' => Markdown::class
+        'markdown' => MarkdownOutput::class,
+        'csv'      => CsvOutput::class
     ];
 
     /**
      * ReportMonth constructor.
      *
      * @param Client $client
-     * @param array $config
+     * @param Config $config
      */
-    public function __construct(Client $client, array $config)
+    public function __construct(Client $client, Config $config)
     {
         $this->config = $config;
         $this->client = $client;
@@ -69,7 +71,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
      */
     protected function configure()
     {
-        $this->addOption('closed', null, InputOption::VALUE_REQUIRED, 'Include closed issues, defaults to false')
+        $this->addOption('closed', null, InputOption::VALUE_REQUIRED,
+            'Include closed issues and merged merge requests, defaults to false')
              ->addOption('columns', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
                  'Include the given columns in the report')
              ->addOption('date_format', null, InputOption::VALUE_REQUIRED, 'Date format')
@@ -80,10 +83,14 @@ protected function configure()
                  null)
              ->addOption('file', null, InputOption::VALUE_OPTIONAL,
                  'If output supports file-saving, specify the path to the file', null)
+             ->addOption('include_by_labels', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
+                 'Include only issues and merge requests by the given labels', null)
              ->addOption('include_labels', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
                  'Include only the given labels in the result', null)
              ->addOption('exclude_labels', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
-                 'Exclude the given labels from the result', null);
+                 'Exclude the given labels from the result', null)
+             ->addOption('exclude_by_labels', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
+                 'Exclude issues and merge requests by the given labels', null);;
     }
 
     /**
@@ -118,9 +125,15 @@ protected function getDefaultArguments(InputInterface $input)
         if ($input->getOption('include_labels')) {
             $arguments['--include_labels'] = $input->getOption('include_labels');
         }
+        if ($input->getOption('include_by_labels')) {
+            $arguments['--include_by_labels'] = $input->getOption('include_by_labels');
+        }
         if ($input->getOption('exclude_labels')) {
             $arguments['--exclude_labels'] = $input->getOption('exclude_labels');
         }
+        if ($input->getOption('exclude_by_labels')) {
+            $arguments['--exclude_by_labels'] = $input->getOption('exclude_by_labels');
+        }
 
         return $arguments;
     }