sfProjectAnalyserPlugin
0.9.1beta
for sf 1.4sf 1.3sf 1.2sf 1.1 MIT
The sfProjectAnalyserPlugin allows you to analyse your symfony project, it can
raise several coding standards alerts. A YAML configuration file allows you to
switch what to analyse and also allows you to parameter threshold for each alert.
This plugin can be helpful in mainly two situations:
- You quickly want to check the volumetry and code quality of a project your
are going to maintain.
- While developing a project from scratch, as a continuous integration tool,
to ensure that as the project grows, you keep on following the symfony coding
standards you defined at the very beginning of your project.
Features list:
Stats
- Count/list of applications, modules, actions (by project, application, module)
- Count/list of number of templates and partials (by module)
Alerts
- Alert for actions code length
- Alert for public non action methods in a module
- Alert for modules including too much actions
- Alert for functions without docblock
- Alert for calls of "sfContext::getInstance()
- Alert for templates and partials code length
- Alert for empty templates and partials
Developers
License
Plugin by Vernet Loïc aka COil. (qrf_coil[at]yahoo[dot]fr)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
sfProjectAnalyserPlugin
The sfProjectAnalyserPlugin allows you to analyse your symfony project, it can
raise several coding standards alerts. A YAML configuration file allows you to
switch what to analyse and also allows you to parameter threshold for each alert.
This plugin can be helpful in mainly two situations:
- You quickly want to check the volumetry and code quality of a project your
are going to maintain.
- While developing a project from scratch, as a continuous integration tool,
to ensure that as the project grows, you keep on following the symfony coding
standards you defined at the very beginning of your project.
Features list:
Stats
- Count/list of applications, modules, actions (by project, application, module)
- Count/list of number of templates and partials (by module)
Alerts
- Alert for actions code length
- Alert for public non action methods in a module
- Alert for modules including too much actions
- Alert for functions without docblock
- Alert for calls of "sfContext::getInstance()
- Alert for templates and partials code length
- Alert for empty templates and partials
Installation
Install the plugin
$ symfony plugin:install sfProjectAnalyserPlugin
- You can also checkout the svn repository
Clear you cache
$ symfony cc
Publish the assets of the plugin to have the alerts logos
$ symfony plugin:publish-assets
Run the analysis (using the default configuration)
$ php symfony project:analyse --application="frontend" --env="dev" > analysis.html
Then browse (locally) the generated html file "analysis.html"
Correct the code or modify your coding standards rules until having the
wonderfull "Congratulations ! Green message". ^^
Obviously the better is to CRON the task to send the report by email
Configuration
The plugin comes with a default configuration, but you can add several ones with
other rules and thresholds:
Copy the /plugins/sfProjectAnalyserPlugin/config/pdf_plugin_sfpa.yml into
the config folder of your application. Then this file will be used instead
of the plugin one.
Now, you can add your own configurations. You should keep the default one witch
is the basic configuration provided by the plugin.
# This is a custom analyser configuration
my_config:
# Global settings
global:
check_functions_docblock: true # Raise an alert if a function does not have its docblock
check_context_get_instance: true # Raise an alert is "sfContext::getInstance()" is encountered in the code
...
Usage
To use your own configuration just pass the config option to the task:
$ php symfony project:analyse --application="frontend" --env="dev" --config="my_config" > analysis.html
Where my_config is the config key name defined in your YAML file. (like above)
Demo
A demo is now included in the plugin, you can test it with a sandbox project for example.
Activate the plugin, activate the sfProjectAnalyser module in your settings.yml file,
then execute the task.
(Not parsed for now as of 0.9.0, copy it into one of your application to check the results
or use a sandbox)
TODO
1.0.0:
- Analyse the layout and partials of an application - LV
- Allow to parse custom actions files - LV
- Parse activated plugins code
- Provide 3 configurations (strict, standart, loose)
- Add a Javascript folding system to have a cascade display (+ an "expand all" button) - NL
1.0.1:
- Alert for ORM code at the action level
- Average action line code length (+with comments)
- Total of code lines (excluded from vendor and auto-generated stuff)
- Average line code length by action
- Number of classes (excluded from vendor and auto-generated stuff)
- Number of queries
For now the plugin is quiet basic, so I need feedbacks to include new interesting
statistics and alerts.
PS: You can also send me a contribution request if you have good ideas. :)
Support
Please report bugs on the official plugin post on my symfony blog. (not posted yet :))
I may also answer if you ask on the symfony users mailing list.
Have fun, COil ;)
Changelog
Check the changelog TAB of the plugin
This plugin is sponsored by SQL-Technologies
Vernet Loïc 
Loeuillet Nicolas 
Marchal Gregoire 