dev #48349 : versions handled in files

VERSIONS_WIP/48349

+ - ticket #48349 : Versionning des profils
\ No newline at end of file

application/modules/admin/controllers/ProfilController.php

@@ -36,7 +36,7 @@ class Admin_ProfilController extends ZendAfi_Controller_Action {
     // Init du profil en cours de traitement
     $id_profil_param = (int)$this->_request->getParam('id_profil', 0);
 
-    if (!$this->_profil = Class_Profil::getLoader()->find($id_profil_param)) {
+    if (!$this->_profil = Class_Profil::find($id_profil_param)) {
       if (!in_array(
                     $this->_request->getActionName(),
                     array('index', 'redirect-to-index', 'add', 'genres', 'module-sort'))
@@ -520,12 +520,15 @@ class Admin_ProfilController extends ZendAfi_Controller_Action {
 
 
   private function _postProfil($profil) {
-
     if (!$this->_request->isPost())
       return false;
 
     $post = ZendAfi_Filters_Post::filterStatic($this->_request->getPost());
     if ($result = $profil->updateAttributes($post)->save()) {
+      $this->_getVersionModel($profil)
+           ->setData($this->_request->getPost())
+           ->save();
+
       Class_Profil::setCurrentProfil($profil);
       Zend_Registry::get('session')->id_profil = $profil->getId();
     }
@@ -606,4 +609,20 @@ class Admin_ProfilController extends ZendAfi_Controller_Action {
 
     return explode('=', $item, 2);
   }
+
+
+  public function versionsAction() {
+    $this->view->titre = $this->_('Versions du profil : "%s"',
+                                  $this->_profil->getLibelle());
+
+    $this->view->versions = $this->_getVersionModel($this->_profil)
+                                 ->findAll();
+  }
+
+
+  protected function _getVersionModel($profil) {
+    return (new Class_Version())
+      ->setName('profile')
+      ->setKey($profil->getId());
+  }
 }
\ No newline at end of file

application/modules/admin/views/scripts/profil/_page_row.phtml

@@ -19,35 +19,36 @@ $url_delete_profil = $this->url(['module' => 'admin',
   <div><?php echo $this->boutonIco('picto=' . $this->icon, 'bulle=Page'); ?></div>
 
   <div>
-    <a  href="<?php echo $url_edit_profil ?>"
-        title="Modifier la page">
+    <a href="<?php echo $url_edit_profil ?>" title="Modifier la page">
       <?php echo $this->libelle . $this->tag('sub', ' #' . $this->profil->getId(), ['style' => 'color: #999']); ?>
     </a>
   </div>
 
   <div class="actions">
-    <a  href="<?php echo $url_edit_profil ?>"
-        title="Modifier la page">
+    <a href="<?php echo $url_edit_profil ?>" title="Modifier la page">
       <?php echo $this->boutonIco("type=edit") ?>
     </a>
 
     <?php
-
     echo $this->tagPreview($this->url(['id_profil' => $this->profil->getId()], null, true),
                            sprintf("Visualisation de la page '%s'", $this->profil->getLibelle()));
-
     ?>
 
     <a href="<?php echo $url_copy_profil ?>">
       <?php echo $this->boutonIco('picto=copy', 'bulle=Dupliquer la page'); ?>
     </a>
 
+    <?php echo $this->tagAnchor($this->url(['module' => 'admin',
+                                            'controller' => 'profil',
+                                            'action' => 'versions',
+                                            'id_profil' => $this->profil->getId()], null, true),
+                                $this->boutonIco('picto=back',
+                                                 'bulle=' . $this->_('Versions'))); ?>
+
     <?php if ($this->include_delete_action) { ?>
       <a href="<?php echo $url_delete_profil ?>">
         <?php echo $this->boutonIco("type=del") ?>
       </a>
     <?php } ?>
-
-
   </div>
 </li>

application/modules/admin/views/scripts/profil/_profil_row.phtml

@@ -41,7 +41,8 @@ if ($this->profil->isTelephone()) {
                   ['action' => 'menusindex', 'icon' => 'menu_configuration', 'help' => 'Configuration des menus'],
                   ['action' => 'proprietes', 'icon' => 'module_configuration', 'help' => 'Propriétés des modules'],
                   ['action' => 'deep_copy', 'icon' => 'copy_profil', 'help' => 'Dupliquer le profil'],
-                  ['action' => 'newpage', 'icon' => 'add_profil', 'help' => 'Ajouter une page']];
+                  ['action' => 'newpage', 'icon' => 'add_profil', 'help' => 'Ajouter une page'],
+                  ['action' => 'versions', 'icon' => 'back', 'help' => $this->_('Versions')]];
 
     $current_skin = Class_Admin_Skin::current();
     foreach ($actions as $action) {
@@ -55,8 +56,8 @@ if ($this->profil->isTelephone()) {
 
         echo $this->tagAnchor($this->url(['action' => 'duplicate-config-modules', 'id_profil' => $this->profil->getId()]),
                               $current_skin->renderActionIconOn('copy_module', $this, ['title' => 'Appliquer la configuration des pages aux autres profils',
-                                                                                         'alt' => 'Appliquer la configuration des pages aux autres profils',
-                                                                                         'onclick' => 'javascript:if(!confirm(\'Cette action permet d\\\'appliquer le même affichage des notices, résultats de recherches, fil d\\\'arianne et style de page à l\\\'ensemble des profils du site. Attention, cela écrasera la configuration des autres profils. Continuer ?\')) return false;']));
+                                                                                       'alt' => 'Appliquer la configuration des pages aux autres profils',
+                                                                                       'onclick' => 'javascript:if(!confirm(\'Cette action permet d\\\'appliquer le même affichage des notices, résultats de recherches, fil d\\\'arianne et style de page à l\\\'ensemble des profils du site. Attention, cela écrasera la configuration des autres profils. Continuer ?\')) return false;']));
       }
       else
         echo

application/modules/admin/views/scripts/profil/versions.phtml

+<?php
+$date_formater = function($model, $attrib) {
+  return strftime($this->_('%d %B %Y à %Hh %Mmn %Ss'), $model->get($attrib));
+};
+
+
+$user_formater = function($model, $attrib) {
+  return ($user = $model->get($attrib)) ? $user->getNomAff() : $this->_('Inconnu');
+};
+
+
+echo $this->tagModelTable($this->versions,
+                          [$this->_('Date'), $this->_('Auteur')],
+                          ['Date', 'User'],
+                          [],
+                          'versions',
+                          null,
+                          ['Date' => $date_formater,
+                           'User' => $user_formater]);

library/Class/Folder/Manager.php

@@ -16,9 +16,11 @@
  *
  * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
  * along with BOKEH; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA 
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
  */
 class Class_Folder_Manager {
+  use Trait_StaticFileSystem;
+
   /** @var string */
   protected $_allowedBasePath;
 
@@ -62,15 +64,13 @@ class Class_Folder_Manager {
    * @return bool
    */
   public function ensure($path) {
-    if (0 !== strpos($path, $this->getAllowedBasePath())) {
+    if (0 !== strpos($path, $this->getAllowedBasePath()))
       return false;
-    }
 
-    if (file_exists($path)) {
+    $file_system = $this->getFileSystem();
+    if ($file_system->file_exists($path))
       return true;
-    }
 
-    return @mkdir($path, 0777, true);
+    return $file_system->mkdir($path, 0777, true);
   }
 }
-?>
\ No newline at end of file

library/Class/Testing/FileSystem.php

@@ -27,7 +27,7 @@ class Class_Testing_FileSystem extends Class_Testing_Abstract {
      'getcwd', 'file_exists', 'scandir', 'is_dir',
      'opendir', 'readdir', 'closedir', 'mkdir', 'glob', 'file', 'fwrite','rename',
      'getimagesize', 'file_get_contents', 'sha1_file', 'is_file', 'pathinfo',
-     'is_readable'
+     'is_readable', 'file_put_contents'
     ],
     $_error = 'Call to unknown fileSystem method ';
 }

library/Class/Version.php

+<?php
+/**
+ * Copyright (c) 2012-2017, Agence Française Informatique (AFI). All rights reserved.
+ *
+ * BOKEH is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+ * the Free Software Foundation.
+ *
+ * There are special exceptions to the terms and conditions of the AGPL as it
+ * is applied to this software (see README file).
+ *
+ * BOKEH is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+ *
+ * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * along with BOKEH; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+
+class Class_Version extends Class_Entity {
+  protected
+    $_attribs = ['Name' => '',
+                 'Key' => '',
+                 'Data' => ''];
+
+
+  protected static $_persistence;
+
+
+  public static function setPersistence($persistence) {
+    static::$_persistence = $persistence;
+  }
+
+
+  public static function getPersistence() {
+    return static::$_persistence
+      ? static::$_persistence
+      : static::$_persistence = new Class_Version_FilePersistence();
+  }
+
+
+  public function findAll() {
+    return static::getPersistence()->findAllOf($this);
+  }
+
+
+  public function save() {
+    static::getPersistence()->save($this);
+  }
+
+
+  public function newFromMe() {
+    return (new Class_Version())
+      ->setName($this->getName())
+      ->setKey($this->getKey());
+  }
+
+
+  public function callGetterByAttributeName($attribute) {
+    return $this->get($attribute);
+  }
+}

library/Class/Version/FilePersistence.php

+<?php
+/**
+ * Copyright (c) 2012-2017, Agence Française Informatique (AFI). All rights reserved.
+ *
+ * BOKEH is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+ * the Free Software Foundation.
+ *
+ * There are special exceptions to the terms and conditions of the AGPL as it
+ * is applied to this software (see README file).
+ *
+ * BOKEH is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+ *
+ * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * along with BOKEH; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+
+class Class_Version_FilePersistence extends Class_Entity {
+  use Trait_StaticFileSystem, Trait_TimeSource;
+
+  const BASE_PATH = 'versions';
+
+  protected $_folder_manager;
+
+  public function findAllOf($version) {
+    if (!$version->getName() || !$version->getKey())
+      return [];
+
+    $path = $this->_getFolderPath($version);
+    $file_system = $this->getFileSystem();
+
+    if (!$file_system->is_readable($path))
+      return [];
+
+    if (!$files = $file_system->scandir($path, SCANDIR_SORT_DESCENDING))
+      return [];
+
+    $versions = [];
+    foreach($files as $file)
+      $versions[] = $this->_newFromFile($version, $file, $path);
+
+    return array_filter($versions);
+  }
+
+
+  public function save($version) {
+    if (!$version->getName() || !$version->getKey() || !$version->getData())
+      return;
+
+    if (!$path = $this->getPathOf($version))
+      return;
+
+    $this->getFileSystem()
+         ->file_put_contents($path, $this->encode($version));
+  }
+
+
+  public function encode($version) {
+    return json_encode($version->getData());
+  }
+
+
+  public function getPathOf($version) {
+    if (!$this->getFolderManager()
+        ->ensure($folder = $this->_getFolderPath($version)))
+      return;
+
+    return $folder . '/'. $this->_fileName($version);
+  }
+
+
+  public function getFolderManager() {
+    if (null === $this->_folder_manager)
+      $this->_folder_manager = Class_Folder_Manager::newInstanceLimitedTo(PATH_TEMP);
+
+    return $this->_folder_manager;
+  }
+
+
+
+  protected function _getFolderPath($version) {
+    return PATH_TEMP
+      . implode('/', [static::BASE_PATH,
+                      $this->_sanitize($version->getName()),
+                      $this->_sanitize($version->getKey())]);
+  }
+
+
+  protected function _sanitize($value) {
+    return (new Zend_Filter_Alnum())->filter($value);
+  }
+
+
+  protected function _fileName() {
+    return
+      $this->getTimeSource()->dateFormat('Y-m-d_His')
+      . '_' . Class_Users::getIdentity()->getId()
+      . '.json';
+  }
+
+
+  protected function _newFromFile($version, $name, $path) {
+    if (in_array($name, ['.', '..']))
+      return;
+
+    return $this->_populateFrom($version->newFromMe(), $name, $path);
+  }
+
+
+  protected function _populateFrom($version, $name, $path) {
+    list($date, $time, $user_id) = explode('_', str_replace('.json', '', $name));
+
+    return $version
+      ->setData($this->getFileSystem()->file_get_contents($path . '/' . $name))
+      ->setDate($this->_extractDate($date, $time))
+      ->setUser(Class_Users::find($user_id))
+      ;
+  }
+
+
+  protected function _extractDate($date, $time) {
+    return strtotime($date .  ' ' . implode(':', str_split($time, 2)));
+  }
+}

tests/scenarios/Versionning/VersionningTest.php

+<?php
+/**
+ * Copyright (c) 2012-2017, Agence Française Informatique (AFI). All rights reserved.
+ *
+ * BOKEH is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+ * the Free Software Foundation.
+ *
+ * There are special exceptions to the terms and conditions of the AGPL as it
+ * is applied to this software (see README file).
+ *
+ * BOKEH is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+ *
+ * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * along with BOKEH; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+
+abstract class VersionningAdminTestCase extends Admin_AbstractControllerTestCase {
+  protected
+    $_storm_default_to_volatile = true,
+    $_file_system;
+
+
+  public function setUp() {
+    parent::setUp();
+
+    $this->_file_system = $this->mock();
+
+    Class_Version_FilePersistence::setFileSystem($this->_file_system);
+    Class_Version_FilePersistence::setTimeSource(new TimeSourceForTest('2017-03-20 11:24:08'));
+    Class_Folder_Manager::setFileSystem($this->_file_system);
+
+    $parent = $this->fixture('Class_Profil', ['id' => 27,
+                                              'libelle' => 'A Profile',
+                                              'id_site' => 1]);
+
+    $this->fixture('Class_Profil', ['id' => 28,
+                                    'libelle' => 'A Page',
+                                    'parent_profil' => $parent]);
+  }
+
+
+  public function tearDown() {
+    Class_Version_FilePersistence::setFileSystem(null);
+    Class_Version_FilePersistence::setTimeSource(null);
+    Class_Folder_Manager::setFileSystem(null);
+
+    parent::tearDown();
+  }
+}
+
+
+
+
+class VersionningProfileVersionsTest extends VersionningAdminTestCase {
+  public function setUp() {
+    parent::setUp();
+
+    $this->fixture('Class_Users',
+                   ['id' => 33,
+                    'login' => 'Albator',
+                    'password' => 'arc4di4']);
+
+    $this->_file_system->whenCalled('is_readable')
+                       ->answers(true)
+
+                       ->whenCalled('scandir')
+                       ->answers(['.', '..',
+                                  '2017-03-20_112408_33.json',
+                                  '2017-03-19_103345_32.json',
+                                  '2017-03-19_102612_32.json',])
+
+                       ->whenCalled('file_get_contents')
+                       ->answers('');
+
+    $this->dispatch('/admin/profil/versions/id_profil/27', true);
+  }
+
+
+  /** @test */
+  public function titleShouldBeVersionDuProfilAProfile() {
+    $this->assertXPathContentContains('//h1', 'Versions du profil : "A Profile"');
+  }
+
+
+  /** @test */
+  public function profileShouldHaveThreeVersionsAndOneHeader() {
+    $this->assertXPathCount('//table[@id="versions"]//tr', 4);
+  }
+
+
+  /** @test */
+  public function firstVersionDateShouldBeLe20Mars2017A11H24Mn08S() {
+    $this->assertXPathContentContains('//table[@id="versions"]//tr[1]//td',
+                                      '20 mars 2017 à 11h 24mn 08s',
+                                      $this->_response->getBody());
+  }
+
+
+  /** @test */
+  public function firstVersionAuthorShouldBeAlbator() {
+    $this->assertXPathContentContains('//table[@id="versions"]//tr[1]//td',
+                                      'Albator',
+                                      $this->_response->getBody());
+  }
+
+
+  /** @test */
+  public function secondVersionAuthorShouldBeInconnu() {
+    $this->assertXPathContentContains('//table[@id="versions"]//tr[2]//td',
+                                      'Inconnu');
+  }
+}
+
+
+
+
+
+
+class VersionningProfileIndexTest extends VersionningAdminTestCase {
+  public function setUp() {
+    parent::setUp();
+    $this->dispatch('/admin/profil', true);
+  }
+
+
+  /** @test */
+  public function versionsLinkOfProfileShouldBePresent() {
+    $this->assertXPath('//a[contains(@href, "profil/versions/id_profil/27")]');
+  }
+
+
+  /** @test */
+  public function versionsLinkOfPageShouldBePresent() {
+    $this->assertXPath('//a[contains(@href, "profil/versions/id_profil/28")]');
+  }
+}
+
+
+
+
+
+
+class VersionningProfileEditTest extends VersionningAdminTestCase {
+  public function setUp() {
+    parent::setUp();
+
+    $this->dispatch('/admin/profil/edit/id_profil/27', true);
+  }
+
+
+  /** @test */
+  public function versionsLinkOfProfileShouldBePresent() {
+    $this->assertXPath('//a[contains(@href, "profil/versions/id_profil/27")]');
+  }
+
+
+  /** @test */
+  public function versionsLinkOfPageShouldBePresent() {
+    $this->assertXPath('//a[contains(@href, "profil/versions/id_profil/28")]');
+  }
+}
+
+
+
+
+class VersionningProfileEditPostTest extends VersionningAdminTestCase {
+  protected
+    $_file_name,
+    $_file_content,
+    $_file_directory;
+
+
+  public function setUp() {
+    parent::setUp();
+
+    $this->_file_system
+      ->whenCalled('file_exists')->answers(false)
+
+      ->whenCalled('mkdir')
+      ->willDo(function($name, $mode, $parents)
+               {
+                 $this->_file_directory = $name;
+                 return true;
+               })
+
+      ->whenCalled('file_put_contents')
+      ->willDo(function($name, $content)
+               {
+                 $this->_file_name = $name;
+                 $this->_file_content = $content;
+               });
+
+    $this->postDispatch('/admin/profil/edit/id_profil/27',
+                        ['libelle' => 'Another label']);
+  }
+
+
+  /** @test */
+  public function versionFileDirectoryShouldBeCreated() {
+    $this->assertContains('/temp/versions/profile/27',
+                          $this->_file_directory);
+  }
+
+
+  /** @test */
+  public function versionFileNameShouldContainsProfileIdAndUserIdAndDatetime() {
+    $this->assertContains('/temp/versions/profile/27/2017-03-20_112408_666.json',
+                          $this->_file_name);
+  }
+
+
+  /** @test */
+  public function versionFileContentShouldContainsPostedData() {
+    $this->assertEquals(['libelle' => 'Another label'],
+                        json_decode($this->_file_content, true));
+  }
+}