Issue #3: Remove public prefix and align routes.

URGENT : Fix namespace pbm

See merge request Chill-Projet/chill-bundles!30

.gitignore

@@ -2,6 +2,7 @@
 composer.phar
 composer.lock
 
+docs/build/
 
 ###> symfony/framework-bundle ###
 /.env.local

.gitlab-ci.yml

@@ -30,6 +30,10 @@ variables:
   POSTGRES_PASSWORD: postgres
   # fetch the chill-app using git submodules
   GIT_SUBMODULE_STRATEGY: recursive
+  REDIS_HOST: redis
+  REDIS_PORT: 6379
+  REDIS_URL: redis://redis:6379
+
 
 # Run our tests
 test:

README.md

@@ -0,0 +1,9 @@
+# Chill framework
+
+Documentation of the Chill software.
+
+The online documentation can be found at http://docs.chill.social
+
+See the [`docs`][1] directory for more.
+
+[1]: docs/README.md

composer.json

@@ -42,6 +42,7 @@
         "symfony/validator": "4.*",
         "sensio/framework-extra-bundle": "^5.5",
         "symfony/yaml": "4.*",
+        "symfony/webpack-encore-bundle": "^1.11",
         "knplabs/knp-menu": "^3.1",
         "knplabs/knp-menu-bundle": "^3.0",
         "symfony/templating": "4.*",
@@ -56,7 +57,8 @@
         "symfony/browser-kit": "^5.2",
         "symfony/css-selector": "^5.2",
         "twig/markdown-extra": "^3.3",
-        "erusev/parsedown": "^1.7"
+        "erusev/parsedown": "^1.7",
+        "symfony/serializer": "^5.2"
     },
     "conflict": {
         "symfony/symfony": "*"

docs/README.md

@@ -10,10 +10,19 @@ Compilation into HTML
 
 To compile this documentation :
 
-1. Install [sphinx-doc](http://sphinx-doc.org) (eg. pip install sphinx &  pip install sphinx_rtd_theme)
+1. Install [sphinx-doc](http://sphinx-doc.org)
+    ``` bash
+            $ virtualenv .venv # creation of the virtual env (only the first time)
+            $ source .venv/bin/activate # activate the virtual env
+    (.venv) $ pip install -r requirements.txt
+    ```
 2. Install submodules : $ git submodule update --init;
 3. run `make html` from the root directory
 4. The base file is located on build/html/index.html
+    ``` bash
+    $ cd build/html
+    $ python -m http.server 8888 # will serve the site on the port 8888
+    ```
 
 Contribute
 ===========

docs/source/development/index.rst

@@ -29,7 +29,7 @@ As Chill rely on the `symfony <http://symfony.com>`_ framework, reading the fram
     Timelines <timelines.rst>
     Exports <exports.rst>
     Embeddable comments <embeddable-comments.rst>
-    Testing <make-test-working.rst>
+    Run tests <run-tests.rst>
     Useful snippets <useful-snippets.rst>
     manual/index.rst
     Assets <assets.rst>

docs/source/development/make-test-working.rst

@@ -1,231 +0,0 @@
-.. Copyright (C)  2014 Champs Libres Cooperative SCRLFS
-   Permission is granted to copy, distribute and/or modify this document
-   under the terms of the GNU Free Documentation License, Version 1.3
-   or any later version published by the Free Software Foundation;
-   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
-   A copy of the license is included in the section entitled "GNU
-   Free Documentation License".
-
-Make tests working
-******************
-
-Unit and functional tests are important to ensure that bundle may be deployed securely.
-
-In reason of the Chill architecture, test should be runnable from the bundle's directory and works correctly: this will allow continuous integration tools to run tests automatically. 
-
-.. note::
-
-    Integration tools (i.e. `travis-ci <https://travis-ci.org>`_) works like this : 
-
-    * they clone the bundle repository in a virtual machine, using git
-    * they optionnaly run `composer` to download and install depedencies
-    * they optionnaly run other command to prepare a database, insert fixtures, ...
-    * they run test
-
-On the developer's machine test should be runnable with two or three commands **runned from the bundle directory** : 
-
-.. code-block:: bash
-
-   $ composer install --dev
-   $ // command to insert fixtures, ...
-   $ phpunit
-
-This chapter has been inspired by `this useful blog post <http://blog.kevingomez.fr/2013/01/09/functional-testing-standalone-symfony2-bundles/>`_.
-
-Bootstrap phpunit for a standalone bundle
-==========================================
-
-Unit tests should run after achieving this step.
-
-
-phpunit.xml
------------
-
-A `phpunit.xml.dist` file should be present at the bundle root.
-
-.. code-block:: xml
-
-   <?xml version="1.0" encoding="UTF-8"?>
-
-   <phpunit bootstrap="./Tests/bootstrap.php" colors="true">
-        <!-- the file "./Tests/boostrap.php" will be created on the next step -->
-       <testsuites>
-           <testsuite name="ChillMain test suite">
-               <directory suffix="Test.php">./Tests</directory>
-           </testsuite>
-       </testsuites>
-       <filter>
-           <whitelist>
-               <directory>./</directory>
-               <exclude>
-                   <directory>./Resources</directory>
-                   <directory>./Tests</directory>
-                   <directory>./vendor</directory>
-               </exclude>
-          </whitelist>
-      </filter>
-   </phpunit>
-
-
-bootstrap.php
---------------
-
-A file `boostrap.php`, located in the `Tests` directory, will allow phpunit to resolve class autoloading :
-
-.. code-block:: php
-
-   <?php
-
-   if (!is_file($autoloadFile = __DIR__.'/../vendor/autoload.php')) {
-       throw new \LogicException('Could not find autoload.php in vendor/. Did you run "composer install --dev"?');
-   }
-
-   require $autoloadFile;
-
-
-composer.json
--------------
-
-The `composer.json` file **located at the bundle's root** should contains all depencies needed to run test (and to execute bundle functions).
-
-Ensure that all dependencies are included in the `require` and `require-dev` sections.
-
-
-Functional tests
-================
-
-If you want to access services, database, and run functional tests, you will have to bootstrap a symfony app, with the minimal configuration. Three files are required : 
-
-* a `config_test.yml` file (eventually with a `config.yml`);
-* a `routing.yml` file
-* an `AppKernel.php` file
-
-Adapt phpunit.xml
------------------
-
-You should add reference to the new application within `phpunit.xml.dist`. The directive `<php>` should be added like this, if your `AppKernel.php` file is located in `Tests/Fixtures/App` directory:
-
-.. code-block:: xml
-
-    <?xml version="1.0" encoding="UTF-8"?>
-
-    <phpunit bootstrap="./Tests/bootstrap.php" colors="true">
-        <testsuites>
-            <testsuite name="ChillMain test suite">
-                <directory suffix="Test.php">./Tests</directory>
-            </testsuite>
-        </testsuites>
-        <filter>
-            <whitelist>
-                <directory>./</directory>
-                <exclude>
-                    <directory>./Resources</directory>
-                    <directory>./Tests</directory>
-                    <directory>./vendor</directory>
-                </exclude>
-            </whitelist>
-        </filter>
-        <!-- the lines we added --> 
-       <php>
-            <server name="KERNEL_DIR" value="./Tests/Fixtures/App/" />
-        </php>
-    </phpunit>
-
-AppKernel.php
--------------
-
-This file boostrap the app. It contains three functions. This is the file used in the ChillMain bundle :
-
-.. code-block:: php
-                                                                                                                                                                                                                 
-    <?php
-
-    use Symfony\Component\HttpKernel\Kernel;
-    use Symfony\Component\Config\Loader\LoaderInterface;
-
-    class AppKernel extends Kernel
-    {
-        public function registerBundles()
-        {   
-            return array(
-                new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
-                new Chill\MainBundle\ChillMainBundle(),
-                new Symfony\Bundle\SecurityBundle\SecurityBundle(),
-                new Symfony\Bundle\TwigBundle\TwigBundle(),
-                new \Symfony\Bundle\AsseticBundle\AsseticBundle(),
-                #add here all the required bundle (some bundle are not required)
-            );
-        }   
-
-        public function registerContainerConfiguration(LoaderInterface $loader)
-        {   
-            $loader->load(__DIR__.'/config/config_'.$this->getEnvironment().'.yml');
-        }   
-
-        /** 
-         * @return string
-         */
-        public function getCacheDir()
-        {   
-            return sys_get_temp_dir().'/ChillMainBundle/cache';
-        }   
-
-        /** 
-         * @return string
-         */
-        public function getLogDir()
-        {   
-            return sys_get_temp_dir().'/ChillMainBundle/logs';
-        }   
-    }
-
-config_test.yml
----------------
-
-There are only few parameters required for the config file. This is a basic version for ChillMain :
-
-.. code-block:: yaml
-
-    # config/config_test.yml
-    imports:
-        - { resource: config.yml } #here we import a config.yml file, this is not required
-
-    framework:
-        test: ~
-        session:
-            storage_id: session.storage.filesystem
-
-.. code-block:: yaml
-
-   # config/config.yml
-   framework: 
-    secret:          Not very secret
-    router:          { resource: "%kernel.root_dir%/config/routing.yml" }
-    form:            true
-    csrf_protection: true
-    session:         ~
-    default_locale:  fr  
-    translator:      { fallback: fr }
-    profiler:        { only_exceptions: false }
-    templating: #required for assetic. Remove if not needed
-        engines: ['twig']
-
-.. note:: 
-
-    You must adapt config.yml file according to your required bundle. Some options will be missing, other may be removed...
-
-.. note::
-
-    If you would like to tests different environments, with differents configuration, you could create differents config_XXX.yml files.
-
-routing.yml
-------------
-
-You should add there all routing information needed for your bundle. 
-
-.. code-block: yaml
-
-    chill_main_bundle:
-      resource: "@CLChillMainBundle/Resources/config/routing.yml"
-
-That's it. Tests should pass.

docs/source/development/run-tests.rst

@@ -0,0 +1,68 @@
+.. Copyright (C)  2014 Champs Libres Cooperative SCRLFS
+   Permission is granted to copy, distribute and/or modify this document
+   under the terms of the GNU Free Documentation License, Version 1.3
+   or any later version published by the Free Software Foundation;
+   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+   A copy of the license is included in the section entitled "GNU
+   Free Documentation License".
+
+Run tests
+*********
+
+In reason of the Chill architecture, test should be runnable from the bundle's directory and works correctly: this will allow continuous integration tools to run tests automatically. 
+
+From chill app
+==============
+
+This is the most convenient method for developer: run test for chill bundle from the main app.
+
+.. code-block:: bash
+
+   # run into a container
+   docker-compose exec --user $(id -u) php bash
+   # execute all tests suites
+   bin/phpunit
+   # .. or execute a single test
+   bin/phpunit vendor/chill-project/chill-bundles/src/Bundle/ChillMainBundle/Tests/path/to/FileTest.php
+
+You can also run tests in a single command:
+
+.. code-block:: bash
+
+   docker-compose exec --user $(id -u) php bin/phpunit
+
+
+Tests from a bundle (chill-bundles)
+-----------------------------------
+
+Those tests needs the whole symfony app to execute Application Tests (which test html page).
+
+For ease, the app is cloned using a :code:`git submodule`, which clone the main app into :code:`tests/app`, and tests are bootstrapped to this app. The dependencies are also installed into `tests/app/vendor` to ensure compliance with relative path from this symfony application.
+
+You may boostrap the tests fro the chill bundle this way:
+
+.. code-block:: bash
+
+   # ensure to be located into the environement (provided by docker suits well)
+   docker-compose exec --user $(id -u) php bash
+   # go to chill subdirectory
+   cd vendor/chill-project/chill-bundles
+   # install submodule
+   git submodule init
+   git submodule update
+   # install composer and dependencies
+   curl -sS https://getcomposer.org/installer | php
+   # run tests
+   bin/phpunit
+
+.. note::
+
+   If you are on a fresh install, you will need to migrate database schema. 
+
+   The path to console tool must be adapted to the app. To load migration and add fixtures, one can execute the following commands:
+
+   .. code-block:: bash
+      
+      tests/app/bin/console doctrine:migrations:migrate
+      tests/app/bin/console doctrine:fixtures:load
+

phpunit.xml.dist

@@ -18,11 +18,11 @@
        <testsuite name="MainBundle">
          <directory suffix="Test.php">src/Bundle/ChillMainBundle/Tests/</directory>
        </testsuite>
-
+       <!--
        <testsuite name="PersonBundle">
          <directory suffix="Test.php">src/Bundle/ChillPersonBundle/Tests/</directory>
         </testsuite>
-
+      -->
       </testsuites>
 
     <listeners>

src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php

@@ -131,6 +131,7 @@ class ChillMainExtension extends Extension implements PrependExtensionInterface,
         $loader->load('services/templating.yaml');
         $loader->load('services/timeline.yaml');
         $loader->load('services/search.yaml');
+        $loader->load('services/serializer.yaml');
 
         $this->configureCruds($container, $config['cruds'], $loader);
     }

src/Bundle/ChillMainBundle/Notification/Mailer.php

@@ -104,7 +104,7 @@ class Mailer
      * @param \User $to
      * @param array $subject Subject of the message [ 0 => $message (required), 1 => $parameters (optional), 3 => $domain (optional) ]
      * @param array $bodies The bodies. An array where keys are the contentType and values the bodies
-     * @param \callable $callback a callback to customize the message (add attachment, etc.)
+     * @param callable $callback a callback to customize the message (add attachment, etc.)
      */
     public function sendNotification(
         $recipient,

src/Bundle/ChillMainBundle/Resources/public/main.js

@@ -21,9 +21,7 @@ global.chill = chill;
 /*
  * load requirements in chill entrypoint
  */
-
+require('./scss/chillmain.scss');
-require('./sass/scratch.scss');
-
 require('./css/chillmain.css');
 require('./css/pikaday.css');
 
@@ -37,6 +35,7 @@ require('./modules/download-report/index.js');
 require('./modules/select_interactive_loading/index.js');
 require('./modules/export-list/export-list.scss');
 require('./modules/entity/index.js');
+//require('./modules/tabs/index.js');
 
 /*
  * load img

src/Bundle/ChillMainBundle/Resources/public/modules/bootstrap/_custom.scss

@@ -0,0 +1,4 @@
+/*
+ *  These custom styles will override bootstrap enabled stylesheets
+ */
+

src/Bundle/ChillMainBundle/Resources/public/modules/bootstrap/bootstrap.scss

@@ -0,0 +1,47 @@
+/*
+ *  Enable / disable bootstrap assets
+ */
+
+@import "bootstrap/scss/functions";
+
+/* replace variables */
+// @import "bootstrap/scss/variables";
+@import "custom/_variables";
+
+@import "bootstrap/scss/mixins";
+// @import "bootstrap/scss/root";
+// @import "bootstrap/scss/reboot";
+// @import "bootstrap/scss/type";
+// @import "bootstrap/scss/images";
+// @import "bootstrap/scss/code";
+// @import "bootstrap/scss/grid";
+// @import "bootstrap/scss/tables";
+// @import "bootstrap/scss/forms";
+// @import "bootstrap/scss/buttons";
+// @import "bootstrap/scss/transitions";
+// @import "bootstrap/scss/dropdown";
+// @import "bootstrap/scss/button-group";
+// @import "bootstrap/scss/input-group";
+// @import "bootstrap/scss/custom-forms";
+// @import "bootstrap/scss/nav";
+// @import "bootstrap/scss/navbar";
+// @import "bootstrap/scss/card";
+// @import "bootstrap/scss/breadcrumb";
+// @import "bootstrap/scss/pagination";
+// @import "bootstrap/scss/badge";
+// @import "bootstrap/scss/jumbotron";
+// @import "bootstrap/scss/alert";
+// @import "bootstrap/scss/progress";
+// @import "bootstrap/scss/media";
+// @import "bootstrap/scss/list-group";
+// @import "bootstrap/scss/close";
+// @import "bootstrap/scss/toasts";
+@import "bootstrap/scss/modal";
+// @import "bootstrap/scss/tooltip";
+// @import "bootstrap/scss/popover";
+// @import "bootstrap/scss/carousel";
+// @import "bootstrap/scss/spinners";
+// @import "bootstrap/scss/utilities";
+// @import "bootstrap/scss/print";
+
+@import "custom";

src/Bundle/ChillMainBundle/Resources/public/modules/bootstrap/custom.scss

@@ -1,42 +0,0 @@
-/*
-*   when bootstrap.css comes after chill.css
-*   we have to disable conflict classes
-*/
-
-@import "bootstrap/scss/functions";
-@import "bootstrap/scss/variables";
-@import "bootstrap/scss/mixins";
-@import "bootstrap/scss/root";
-//@import "bootstrap/scss/reboot";  // h1, h2, h3, ...
-//@import "bootstrap/scss/type";    // h1, h2, h3, ...
-@import "bootstrap/scss/images";
-@import "bootstrap/scss/code";
-//@import "bootstrap/scss/grid";    // container
-@import "bootstrap/scss/tables";
-@import "bootstrap/scss/forms";
-@import "bootstrap/scss/buttons";
-@import "bootstrap/scss/transitions";
-@import "bootstrap/scss/dropdown";
-@import "bootstrap/scss/button-group";
-@import "bootstrap/scss/input-group";
-@import "bootstrap/scss/custom-forms";
-@import "bootstrap/scss/nav";
-@import "bootstrap/scss/navbar";
-@import "bootstrap/scss/card";
-@import "bootstrap/scss/breadcrumb";
-@import "bootstrap/scss/pagination";
-@import "bootstrap/scss/badge";
-@import "bootstrap/scss/jumbotron";
-@import "bootstrap/scss/alert";
-@import "bootstrap/scss/progress";
-@import "bootstrap/scss/media";
-@import "bootstrap/scss/list-group";
-@import "bootstrap/scss/close";
-@import "bootstrap/scss/toasts";
-@import "bootstrap/scss/modal";
-@import "bootstrap/scss/tooltip";
-@import "bootstrap/scss/popover";
-@import "bootstrap/scss/carousel";
-@import "bootstrap/scss/spinners";
-@import "bootstrap/scss/utilities";
-@import "bootstrap/scss/print";

src/Bundle/ChillMainBundle/Resources/public/modules/bootstrap/index.js

@@ -1,9 +1,9 @@
 // Compile all bootstrap assets from nodes-modules
 //require('bootstrap/scss/bootstrap.scss')
 
-// Compile custom styles to adapt bootstrap in chill context
+// Or compile bootstrap only enabled assets
-require('./custom.scss')
+require('./bootstrap.scss');
 
 // You can specify which plugins you need
 //import { Tooltip, Toast, Popover } from 'bootstrap';
-//import Alert from 'bootstrap/js/dist/alert';
+import Modal from 'bootstrap/js/dist/modal';

src/Bundle/ChillMainBundle/Resources/public/modules/scratch/_custom.scss

@@ -1,3 +1,9 @@
+/*
+ * NOTE 2021.04
+ * scss/chill.scss is the main sass file for the new chill.2
+ * scratch will be replaced by bootstrap, please avoid to edit in modules/scratch/_custom.scss
+ */
+
 // YOUR CUSTOM SCSS
 @import 'custom/config/colors';
 @import 'custom/config/variables';
@@ -156,7 +162,6 @@ dl.chill_view_data {
 
 }
 
-
 blockquote.chill-user-quote,
 div.chill-user-quote {
     border-left: 10px solid $chill-yellow;
@@ -182,5 +187,4 @@ div.chill-user-quote {
 
 .chill-no-data-statement {
     font-style: italic;
-
 }