Added remove feature\nWritten CHANGELOG.md

Author: TiBeN

CHANGELOG.md

@@ -0,0 +1,10 @@
+1.1.0 (2014-01-11)
+------------------
+- Cronjob can now be removed from de crontab
+
+1.0.0 (2014-01-11)
+------------------
+- Done some refactoring and cs fixes 
+- Written README.md documentation
+- Preparing source to be published on Github
+

README.md

@@ -70,6 +70,16 @@ $crontabJob->hours = '21';
 $crontabRepository->persist();
 ```
 
+### Remove a cron job from the crontab
+You can removing a job like this :
+```php
+$results = $crontabRepository->findJobByRegex('/Logging\ disk\ usage/');
+$crontabJob = $results[0];
+$crontabRepository->removeJob($crontabJob);
+$crontabRepository->persist();
+```
+Note: Since cron jobs are internally matched by reference, theses must be previously obtained by the repository.   
+
 ### Work with the crontab of another user than runtime user:
 This feature allow you to manage the crontab of another user than the user who launched the runtime. This can be useful when the runtime user is `www-data` but the owner of the crontab you want to edit is your own linux user account. 
 

src/CrontabManager/CrontabRepository.php

@@ -96,9 +96,28 @@ public function findJobByRegex($regex)
      */
     public function addJob(CrontabJob $crontabJob)
     {
+        if (array_search($crontabJob, $this->crontabJobs) !== false) {
+            $exceptionMessage = 'This job is already in the crontab. Please consider cloning the'
+                . 'CrontabJob object if you want it to be registered twice.'
+            ;
+            throw new \LogicException($exceptionMessage);
+        }
         array_push($this->crontabJobs, $crontabJob);
     }
-    
+
+    /**
+     * Remove a CrontabJob in the connected crontab
+     * @param CrontabJob $crontabJob
+     */
+    public function removeJob(CrontabJob $crontabJob)
+    {
+        $jobKey = array_search($crontabJob, $this->crontabJobs, true);
+        if ($jobKey === false) {
+            throw new \LogicException('This job is not part of this crontab');
+        }
+        unset($this->crontabJobs[$jobKey]);
+    }
+
     /**
      * Save all operations to the connected crontab.
      */

tests/CrontabManager/Tests/CrontabRepositoryTest.php

@@ -174,6 +174,42 @@ public function testPersist()
         $crontabRepository->persist();
     }
 
+    /**
+     * Test Remove a job
+     */
+    public function testRemove()
+    {
+        /* Create fake crontabAdapter */
+        $fakeCrontabAdapter = $this->getMock('TiBeN\CrontabManager\CrontabAdapter');
+
+        $fakeCrontabAdapter
+            ->expects($this->any())
+            ->method('readCrontab')
+            ->will($this->returnValue(file_get_contents($this->fixturesPath . 'testing_persisted_crontab.txt')))
+        ;
+
+        $fakeCrontabAdapter
+            ->expects($this->once())
+            ->method('writeCrontab')
+            ->with($this->equalTo(file_get_contents($this->fixturesPath . 'testing_removed_crontab.txt')))
+        ;
+
+        $crontabRepository = new CrontabRepository($fakeCrontabAdapter);
+
+        /* Retrieve job */
+        $crontabJobs = $crontabRepository->findJobByRegex('/launch\ -param\ mycommand/');
+
+        /* Apply some local updates on the job to ensure
+         * it is linked by reference to the repository
+         */
+        $crontabJobs[0]->minutes = '00';
+        $crontabJobs[0]->hours = '01';
+
+        /* Remove job */
+        $crontabRepository->removeJob($crontabJobs[0]);
+        $crontabRepository->persist();
+    }
+
     /**
      * Test if pass a wrong regular expression when searching by regex throw an invalid regex exception
      * @expectedException InvalidArgumentException
@@ -191,4 +227,45 @@ public function testExceptionInvalidRegexOnFindJobByRegex()
         $crontabRepository = new CrontabRepository($fakeCrontabAdapter);
         $crontabRepository->findJobByRegex('/$');
     }
+
+    /**
+     * Test remove an unknown Job
+     * @expectedException LogicException
+     * @expectedExceptionMessage This job is not part of this crontab
+     */
+    public function testRemoveAnUnknownJob()
+    {
+        $fakeCrontabAdapter = $this->getMock('TiBeN\CrontabManager\CrontabAdapter');
+
+        $fakeCrontabAdapter
+            ->expects($this->any())
+            ->method('readCrontab')
+            ->will($this->returnValue(file_get_contents($this->fixturesPath . 'simple_crontab.txt')))
+        ;
+        $crontabRepository = new CrontabRepository($fakeCrontabAdapter);
+
+        $job = CrontabJob::createFromCrontabLine('30 23 * * * launch -param mycommand');
+        $crontabRepository->removeJob($job);
+    }
+
+    /**
+     * Add an already in the repository job
+     * @expectedException \LogicException
+     */
+    public function testAddAnAlreadyInTheRepositoryJob()
+    {
+        $fakeCrontabAdapter = $this->getMock('TiBeN\CrontabManager\CrontabAdapter');
+
+        $fakeCrontabAdapter
+            ->expects($this->any())
+            ->method('readCrontab')
+            ->will($this->returnValue(file_get_contents($this->fixturesPath . 'simple_crontab.txt')))
+        ;
+
+        $crontabRepository = new CrontabRepository($fakeCrontabAdapter);
+
+        /* Modify the existing job */
+        $crontabJobs = $crontabRepository->findJobByRegex('/launch\ -param\ mycommand/');
+        $crontabRepository->addJob($crontabJobs[0]);
+    }
 }

tests/CrontabManager/Tests/Fixtures/testing_removed_crontab.txt

@@ -0,0 +1,24 @@
+# Edit this file to introduce tasks to be run by cron.
+# 
+# Each task to run has to be defined through a single line
+# indicating with different fields when the task will be run
+# and what command to run for the task
+# 
+# To define the time you can provide concrete values for
+# minute (m), hour (h), day of month (dom), month (mon),
+# and day of week (dow) or use '*' in these fields (for 'any').# 
+# Notice that tasks will be started based on the cron's system
+# daemon's notion of time and timezones.
+# 
+# Output of the crontab jobs (including errors) is sent through
+# email to the user the crontab file belongs to (unless redirected).
+# 
+# For example, you can run a backup of all your user accounts
+# at 5 a.m every week with:
+# 0 5 * * 1 tar -zcf /var/backups/home.tgz /home/
+# 
+# For more information see the manual pages of crontab(5) and cron(8)
+# 
+# m h  dom mon dow   command
+
+30 23 * * * df >> /tmp/df.log #new crontab job