add remove function #7

CHANGELOG.md

@@ -6,7 +6,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## 1.3.0
 
-+ [#6](https://github.com/nadar/php-composer-reader/issues/6) Added add method for require and require-dev section.
++ [#7](https://github.com/nadar/php-composer-reader/issues/7) Added remove() method for require(-dev) and autoload(-dev) sections.
++ [#6](https://github.com/nadar/php-composer-reader/issues/6) Added add() method for require and require-dev sections.
 + Moved interfaces into interface folder.
 + Added AutoloadDevSection
 + Fixed bug in composer reader when file is unable to write.

src/Autoload.php

@@ -23,6 +23,14 @@ class Autoload implements SectionInstanceInterface
 
     public $type;
 
+    /**
+     * Autoload Section
+     *
+     * @param ComposerReaderInterface $reader
+     * @param string $namespace The namespace like \\foo\\bar\\
+     * @param string $source The path which is root for the namespace like path/to
+     * @param string $type The type psr-4 or psr-0
+     */
     public function __construct(ComposerReaderInterface $reader, $namespace, $source, $type)
     {
         $this->reader = $reader;

src/AutoloadSection.php

@@ -2,6 +2,7 @@
 
 namespace Nadar\PhpComposerReader;
 
+use Exception;
 use Nadar\PhpComposerReader\Interfaces\ManipulationInterface;
 use Nadar\PhpComposerReader\Interfaces\ComposerReaderInterface;
 use Nadar\PhpComposerReader\Interfaces\SectionInstanceInterface;
@@ -24,6 +25,12 @@ class AutoloadSection extends DataIterator implements ManipulationInterface
 
     const SECTION_KEY = 'autoload';
 
+    /**
+     * Constuctor
+     *
+     * @param ComposerReaderInterface $reader
+     * @param string $type
+     */
     public function __construct(ComposerReaderInterface $reader, $type = self::TYPE_PSR4)
     {
         $this->reader = $reader;
@@ -62,11 +69,30 @@ public function add(SectionInstanceInterface $sectionInstance): ComposerReaderIn
 
         $data = $this->ensureDoubleBackslash($data);
 
-        $sectionInstance->reader->updateSection(static::SECTION_KEY, $data);
+        $this->reader->updateSection(static::SECTION_KEY, $data);
 
-        return $sectionInstance->reader;
+        return $this->reader;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function remove($sectionIdentifier): ComposerReaderInterface
+    {
+        /** @var array $data */
+        $data = $this->reader->contentSection(static::SECTION_KEY, []);
+
+        foreach ($data as $type => $values) {
+            if (array_key_exists($sectionIdentifier, $values)) {
+                unset($data[$type][$sectionIdentifier]);
+            }
+        }
+
+        $this->reader->updateSection(static::SECTION_KEY, $data);
+
+        return $this->reader;
+    }
+
     /**
      * Ensure double black slashes of input data.
      *

src/Interfaces/ComposerReaderInterface.php

@@ -42,6 +42,8 @@ public function removeSection($section);
      * Save the current Data.
      *
      * Saves the current json data into the composer.json of the given reader.
+     * 
+     * @return boolean Whether saving was successfull or not.
      */
     public function save();
 }

src/Interfaces/ManipulationInterface.php

@@ -19,4 +19,12 @@ interface ManipulationInterface
      * @return ComposerReaderInterface
      */
     public function add(SectionInstanceInterface $sectionInstance): ComposerReaderInterface;
+
+    /**
+     * Removes a given section entry based on the identifier.
+     * 
+     * @param string $sectionIdentifier The section identifer which is the namespace or the package name
+     * @return ComposerReaderInterface
+     */
+    public function remove($sectionIdentifier): ComposerReaderInterface;
 }

src/Package.php

@@ -22,6 +22,13 @@ class Package implements SectionInstanceInterface
 
     public $constraint;
 
+    /**
+     * Constructor
+     *
+     * @param ComposerReaderInterface $reader
+     * @param string $name
+     * @param string $constraint
+     */
     public function __construct(ComposerReaderInterface $reader, $name, $constraint)
     {
         $this->reader = $reader;

src/RequireSection.php

@@ -18,6 +18,11 @@ class RequireSection extends DataIterator implements ManipulationInterface
 
     protected $reader;
 
+    /**
+     * Constructor
+     *
+     * @param ComposerReaderInterface $reader
+     */
     public function __construct(ComposerReaderInterface $reader)
     {
         $this->reader = $reader;
@@ -49,8 +54,25 @@ public function add(SectionInstanceInterface $sectionInstance): ComposerReaderIn
         /** @var Package $sectionInstance */
         $data[$sectionInstance->name] = $sectionInstance->constraint;
 
-        $sectionInstance->reader->updateSection(static::SECTION_KEY, $data);
+        $this->reader->updateSection(static::SECTION_KEY, $data);
 
-        return $sectionInstance->reader;
+        return $this->reader;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function remove($sectionIdentifier): ComposerReaderInterface
+    {
+        /** @var array $data */
+        $data = $this->reader->contentSection(static::SECTION_KEY, []);
+
+        if (!array_key_exists($sectionIdentifier, $data)) {
+            throw new Exception("Unable to find the given section key '{$sectionIdentifier}' to remove.");
+        }
+        unset($data[$sectionIdentifier]);
+        $this->reader->updateSection(static::SECTION_KEY, $data);
+
+        return $this->reader;
     }
 }

tests/AutoloadSectionTest.php

@@ -62,4 +62,15 @@ public function testSave()
 
         $this->removeTemporaryJson($json);
     }
+
+    public function testAddAndRemove()
+    {
+        $reader = new ComposerReader($this->getValidJson());
+
+        $section = new AutoloadSection($reader);
+        $new = new Autoload($reader, 'Foo\\Bar\\', 'src/foo/bar', AutoloadSection::TYPE_PSR4);
+
+        $this->assertTrue($section->add($new)->save());
+        $this->assertTrue($section->remove($new->namespace)->save());
+    }
 }

tests/RequireSectionTest.php

@@ -53,4 +53,15 @@ public function testAddFunctionOfRequireSection()
 
         $this->removeTemporaryJson($json);
     }
+
+    public function testAddAndRemove()
+    {
+        $reader = new ComposerReader($this->getValidJson());
+        $section = new RequireSection($reader);
+
+        $new = new Package($reader, 'xyz', '1.0.0');
+
+        $this->assertTrue($section->add($new)->save());
+        $this->assertTrue($section->remove($new->name)->save());
+    }
 }