Merge branch 'release/v0.0.5'

Author: matteosister

Collection/GitElephantRepositoryCollection.php

@@ -1,16 +1,16 @@
 <?php
-/**
- * User: matteo
- * Date: 20/01/12
- * Time: 21.49
- *
- * Just for fun...
- */
 
 namespace Cypress\GitElephantBundle\Collection;
 
 use GitElephant\Repository;
 
+/**
+ * Class GitElephantRepositoryCollection
+ *
+ * @category Collection
+ * @package  Cypress\GitElephantBundle\Collection
+ * @author   Matteo Giachino <https://github.com/matteosister>
+ */
 class GitElephantRepositoryCollection implements \ArrayAccess, \Iterator, \Countable
 {
     /**
@@ -33,12 +33,13 @@ class GitElephantRepositoryCollection implements \ArrayAccess, \Iterator, \Count
      * )
      *
      * @param array $repositories an array of repository classes
+     * @param null  $binary
      */
     public function __construct($repositories, $binary = null)
     {
-        $this->position    = 0;
+        $this->position = 0;
 
-        foreach($repositories as $name => $path) {
+        foreach ($repositories as $name => $path) {
             $repository = new Repository($path, $binary);
             $repository->setName($name);
             $this->repositories[] = $repository;
@@ -50,16 +51,17 @@ public function __construct($repositories, $binary = null)
      *
      * @param string $name the repository name
      *
-     * @return \GitElephant\Repository $repository
+     * @return Repository $repository
      */
     public function get($name)
     {
-        foreach($this->repositories as $repository)
-        {
+        /** @var Repository $repository */
+        foreach ($this->repositories as $repository) {
             if ($repository->getName() == $name) {
                 return $repository;
             }
         }
+
         return null;
     }
 

Collector/GitElephantDataCollector.php

@@ -1,11 +1,4 @@
 <?php
-/**
- * User: matteo
- * Date: 19/01/12
- * Time: 21.07
- *
- * Just for fun...
- */
 
 namespace Cypress\GitElephantBundle\Collector;
 
@@ -14,11 +7,23 @@
 use Symfony\Component\HttpFoundation\Response;
 use GitElephant\Repository;
 
+/**
+ * Class GitElephantDataCollector
+ *
+ * @category Collector
+ * @package  Cypress\GitElephantBundle\Collector
+ * @author   Matteo Giachino <https://github.com/matteosister>
+ */
 class GitElephantDataCollector extends DataCollector
 {
     private $repository;
     private $enabled;
 
+    /**
+     * Constructor
+     *
+     * @param $path
+     */
     public function __construct($path)
     {
         if ($path == false) {
@@ -29,24 +34,46 @@ public function __construct($path)
         }
     }
 
+    /**
+     * Collect
+     *
+     * @param Request    $request
+     * @param Response   $response
+     * @param \Exception $exception
+     */
     public function collect(Request $request, Response $response, \Exception $exception = null)
     {
         $this->data = array(
             'repository' => $this->repository !== null ? $this->repository : null,
-            'enabled' => $this->enabled
+            'enabled'    => $this->enabled
         );
     }
 
+    /**
+     * Get repository
+     *
+     * @return mixed
+     */
     public function getRepository()
     {
         return $this->data['repository'];
     }
 
+    /**
+     * Get enabled
+     *
+     * @return mixed
+     */
     public function getEnabled()
     {
         return $this->data['enabled'];
     }
 
+    /**
+     * Get name
+     *
+     * @return string
+     */
     public function getName()
     {
         return 'git_elephant';

Command/TagCommand.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Cypress\GitElephantBundle\Command;
+
+use Cypress\GitElephantBundle\Collection\GitElephantRepositoryCollection;
+use GitElephant\Repository;
+use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\Output;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Helper\ProgressHelper;
+
+/**
+ * Class TagCommand
+ *
+ * @category Command
+ * @package  Cypress\GitElephantBundle\Command
+ * @author   David Romaní <[email protected]>
+ */
+class TagCommand extends ContainerAwareCommand
+{
+    /**
+     * Tag command configuration
+     */
+    protected function configure()
+    {
+        $this->setName('cypress:git:tag')
+            ->setDefinition(
+                array(
+                    new InputArgument(
+                        'tag',
+                        InputArgument::REQUIRED,
+                        'Tag title'
+                    ),
+                    new InputArgument(
+                        'comment',
+                        InputArgument::OPTIONAL,
+                        'Tag comment'
+                    ),
+                )
+            )
+            ->setDescription('Tag current commit and push to remote repository')
+            ->addOption(
+                'no-push',
+                null,
+                InputOption::VALUE_NONE,
+                'If set, the task won\'t push tag to remote repository'
+            )
+            ->addOption(
+                'all',
+                null,
+                InputOption::VALUE_NONE,
+                'If set, will tag all repositories'
+            )
+            ->setHelp(
+                <<<EOT
+<info>cypress:git:tag</info> command will tag your current commit and (optionally) push to remote repository. Only apply fisrt repository, use --all option to apply all repositories.
+EOT
+            );
+    }
+
+    /**
+     * Execute tag command
+     *
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     *
+     * @throws \Exception
+     * @return int|null|void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        // Welcome
+        $output->writeln(
+            '<info>Welcome to the Cypress GitElephantBundle tag command.</info>'
+        );
+        if ($input->getOption('no-push')) {
+            $output->writeln(
+                '<comment>--no-push option enabled (this option disable push tag to remote repository)</comment>'
+            );
+        }
+
+        /** @var GitElephantRepositoryCollection $rc */
+        $rc = $this->getContainer()->get('git_repositories');
+
+        if ($rc->count() == 0) {
+            throw new \Exception('Must have at least one Git repository. See https://github.com/matteosister/GitElephantBundle#how-to-use');
+        }
+
+        /** @var Repository $repository */
+        foreach ($rc as $key => $repository) {
+            if ($key == 0 || $key > 0 && $input->getOption('all')) {
+                $repository->createTag($input->getArgument('tag'), null, $input->getArgument('comment') ? $input->getArgument('comment') : null);
+                if (!$input->getOption('no-push')) {
+                    $repository->push();
+                }
+                $output->writeln('Set tag ' . $input->getArgument('tag') . ' to repository ' . $repository->getName() . (!$input->getOption('no-push') ? ' and push.' : ''));
+            }
+        }
+    }
+}

README.md

@@ -12,7 +12,7 @@ Watch a [simple live example](http://gitelephant.cypresslab.net/GitElephant) of
 How to install
 --------------
 
-**Method 1 - deps file**
+**Method 1 - deps file (for Symfony 2.1 and below)**
 
 - Add the GitElephant library and the bundle itself in the deps file
 
@@ -26,25 +26,41 @@ How to install
         git=git://github.com/matteosister/GitElephantBundle.git
         target=/bundles/Cypress/GitElephantBundle
 
-- register the two namespaces in the autoload.php file
+- Register the two namespaces in the autoload.php file
 
 *app/autoload.php*
 
 ``` php
-<?php
 $loader->registerNamespaces(array(
     // ...other namespaces
     'GitElephant'      => __DIR__.'/../vendor/git-elephant/src',
     'Cypress'          => __DIR__.'/../vendor/bundles',
 ));
 ```
 
-- register the bundle in the kernel file
+**Method 2 - composer (recommended)**
+
+- Add the following line to the `composer.json` file:
+
+``` json
+{
+    "require": {
+        "cypresslab/gitelephant-bundle": "dev-master"
+    }
+}
+```
+
+- Execute composer update command
+
+``` bash
+$ composer update
+```
+
+- Register the bundle in the kernel file
 
 *app/AppKernel.php*
 
 ``` php
-<?php
 class AppKernel extends Kernel
 {
     public function registerBundles()
@@ -59,7 +75,28 @@ class AppKernel extends Kernel
 }
 ```
 
-**Method 2 - submodules**
+>Is recommended to register this bundle only in development environment for safety reasons.
+
+``` php
+class AppKernel extends Kernel
+{
+    public function registerBundles()
+    {
+        $bundles = array(
+            // ...other bundles
+        );
+
+        if (in_array($this->getEnvironment(), array('dev', 'test'))) {
+            // ...other development and testing bundles
+            $bundles[] = new Cypress\GitElephantBundle\CypressGitElephantBundle();
+        }
+
+        return $bundles;
+    }
+}
+```
+
+**Method 3 - submodules**
 
 You can also manage the two git repositories with git and submodules. It could be a mess if you don't know what you do, but I personally prefer this way
 
@@ -103,7 +140,6 @@ Now, inside your controllers, you can easily access the GitElephant library with
 The repository path could also be a bare repository (useful for web servers). But without a checked out copy you won't be able to modify the repository state. You will be able to show the repository, but not, for example, create a new commit
 
 ``` php
-<?php
 class AwesomeController extends Controller
 {
     /**
@@ -146,6 +182,17 @@ Add this to your **dev** configuration file *app/config/config_dev.yml*
 
 If you use git with Symfony2, with the above configuration, you can see directly from the browser the branch you are in. Click on the icon and you get a list of the last 10 commits for the branch you are in.
 
+Available console commands
+--------------------------
+
+**cypress:git:tag**
+
+This command is useful to tag current commit and push to remote repository.
+
+``` bash
+$ php app/console cypress:git:tag [--no-push] [--all] tag [comment]
+```
+
 Example
 -------
 

composer.json

@@ -14,6 +14,12 @@
     ],
     "require": {
         "php": ">=5.3.2",
+        "symfony/config": "~2.3",
+        "symfony/console": "~2.3",
+        "symfony/dependency-injection": "~2.3",
+        "symfony/framework-bundle": "~2.3",
+        "symfony/http-foundation": "~2.3",
+        "symfony/http-kernel": "~2.3",
         "cypresslab/gitelephant": "*"
     },
     "autoload": {