feature #210 Added the new 'design -> theme' option (javiereguiluz)

This PR was merged into the master branch. Discussion ---------- Added the new 'design -> theme' option This is the second pull request related to #208 Commits ------- 95fd661 Added the new 'design -> theme' option
EasyCorp · Mar 31, 2015 · 58b2959 · 58b2959
2 parents 779be3e + 95fd661
commit 58b2959
Show file tree

Hide file tree

Showing 100 changed files with 255 additions and 1 deletion.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -198,6 +198,16 @@ private function addDesignSection(ArrayNodeDefinition $rootNode)
                     ->performNoDeepMerging()
                     ->addDefaultsIfNotSet()
                     ->children()
+                        // the 'theme' option is not used at the moment, but it allows us to be prepared for the future
+                        ->scalarNode('theme')
+                            ->defaultValue('default')
+                            ->info('The theme used to render the backend pages. For now this value can only be "default".')
+                            ->validate()
+                            ->ifNotInArray(array('default'))
+                                ->thenInvalid('The theme name can only be "default".')
+                            ->end()
+                        ->end()
+
                         ->arrayNode('assets')
                             ->performNoDeepMerging()
                             ->addDefaultsIfNotSet()

diff --git a/Resources/doc/10-customizing-design.md b/Resources/doc/10-customizing-design.md
@@ -11,6 +11,21 @@ easy_admin:
         # ...
 ```
 
+Changing the Backend Theme
+--------------------------
+
+The current version of EasyAdmin doesn't allow to select the theme used to
+render the backend pages. In future versions of the bundle, you'll be able to
+change the default theme using the `theme` option. For now, the value of this
+option can only be `default`:
+
+```yaml
+easy_admin:
+    design:
+        theme: 'default'
+        # ...
+```
+
 Adding Custom Web Assets
 ------------------------
 

diff --git a/Tests/DependencyInjection/EasyAdminExtensionTest.php b/Tests/DependencyInjection/EasyAdminExtensionTest.php
@@ -95,6 +95,15 @@ public function testActionNameCannotStartWithANumber()
         $this->parseConfigurationFile(__DIR__.'/fixtures/exceptions/action_name_cannot_start_with_a_number.yml');
     }
 
+    /**
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedExceptionMessage Invalid configuration for path "easy_admin.design.theme": The theme name can only be "default".
+     */
+    public function testThemeNameCanOnlyBeDefault()
+    {
+        $this->parseConfigurationFile(__DIR__.'/fixtures/exceptions/theme_name_can_only_be_default.yml');
+    }
+
     public function provideConfigurationFiles()
     {
         $fixtures = array();
@@ -107,7 +116,6 @@ public function provideConfigurationFiles()
         }
 
         return $fixtures;
-
         return $this->lookForFixturesFiles();
     }
 

diff --git a/Tests/DependencyInjection/fixtures/configurations/input/admin_083.yml b/Tests/DependencyInjection/fixtures/configurations/input/admin_083.yml
@@ -0,0 +1,10 @@
+# TEST
+# if the 'theme' option contains the only valid value ('default') the backend
+# configuration is properly parsed
+
+# CONFIGURATION
+easy_admin:
+    design:
+        theme: 'default'
+    entities:
+        - AppBundle\Entity\TestEntity
diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_001.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_001.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_002.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_002.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_003.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_003.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_004.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_004.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_005.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_005.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_006.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_006.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_007.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_007.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_008.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_008.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_009.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_009.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_010.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_010.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_011.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_011.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_012.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_012.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_013.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_013.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_014.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_014.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_015.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_015.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_016.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_016.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_017.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_017.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_018.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_018.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_019.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_019.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_020.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_020.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_021.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_021.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_022.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_022.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_023.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_023.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_024.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_024.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_025.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_025.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_026.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_026.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_027.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_027.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_028.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_028.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_029.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_029.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_030.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_030.yml
@@ -168,6 +168,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_031.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_031.yml
@@ -90,6 +90,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_032.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_032.yml
@@ -90,6 +90,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_033.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_033.yml
@@ -90,6 +90,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_034.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_034.yml
@@ -94,6 +94,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_035.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_035.yml
@@ -98,6 +98,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_036.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_036.yml
@@ -101,6 +101,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_037.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_037.yml
@@ -101,6 +101,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_038.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_038.yml
@@ -101,6 +101,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_039.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_039.yml
@@ -86,6 +86,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d

diff --git a/Tests/DependencyInjection/fixtures/configurations/output/config_040.yml b/Tests/DependencyInjection/fixtures/configurations/output/config_040.yml
@@ -102,6 +102,7 @@ easy_admin:
         assets:
             css: {  }
             js: {  }
+        theme: default
     site_name: 'Easy Admin'
     formats:
         date: Y-m-d