1.0.0 wip edge

.scrutinizer.yml

@@ -0,0 +1,34 @@
+# language: php
+
+inherit: true
+
+filter:
+    excluded_paths: [js/*, skin/*]
+
+checks:
+    php:
+        code_rating: true
+        duplication: true
+
+tools:
+    external_code_coverage: false
+    php_code_coverage: false
+    php_code_sniffer:
+        config:
+            standard: 'Zend'
+    php_sim: true
+    php_cs_fixer: true
+    php_mess_detector: true
+    php_pdepend: true
+    php_analyzer: true
+    sensiolabs_security_checker: true
+
+build:
+    environment:
+        php: '5.4.28'
+
+build_failure_conditions:
+    - 'elements.rating(<= D).exists'
+    - 'issues.count > 40'
+    - 'issues.severity(>= MAJOR).exists'
+    - 'project.metric("scrutinizer.quality", < 9)'

README.md

@@ -1,14 +1,26 @@
-# Enhanced Admin Grids
-
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mage-eag/mage-enhanced-admin-grids/badges/quality-score.png?b=1.0.0-wip-edge)](https://scrutinizer-ci.com/g/mage-eag/mage-enhanced-admin-grids/?branch=1.0.0-wip-edge) [![Build Status](https://scrutinizer-ci.com/g/mage-eag/mage-enhanced-admin-grids/badges/build.png?b=1.0.0-wip)](https://scrutinizer-ci.com/g/mage-eag/mage-enhanced-admin-grids/build-status/1.0.0-wip)
 
-Enhanced Admin Grids extension for Magento.
-More informations about the extension can be found on its Magento Connect page here : https://www.magentocommerce.com/magento-connect/enhanced-admin-grids-editor.html
+# Enhanced Admin Grids
+## Version 1.0.0 (work-in-progress / edge)
 
-_The new version is now under development, and should include :_
-- first wave of massive code refactoring (goals: clean-up almost every part of the code for a better maintainability, more consistency, more independence, better practices and a smaller footprint)
-- refined permissions
-- profiles system (for each grid, will allow to use different columns lists and parameters, assignable to different roles)
-- advanced filtering possibilities for text and options columns
-- in-grid customizations saved via Ajax, so that the pages do not (annoyingly) reload when customizations are saved from (eg) a product view tab
+_This version includes the latest changes which are considered too experimental to be featured in the [base work-in-progress branch](https://github.com/mage-eag/mage-enhanced-admin-grids/tree/1.0.0-wip). As such, it should only be used for testing purposes._
 
-No time frame for the moment, but a development version should hopefully be available within a month or two
+### Final steps before beta release
+- [ ] last waves of code refactoring/cleanup and complexity reduction (focus on [Scrutinizer hot spots](https://scrutinizer-ci.com/g/mage-eag/mage-enhanced-admin-grids/code-structure/1.0.0-wip/hot-spots))
+- [ ] **editor system refactoring** :
+    - [X] separate responsibilities into different models, introduce callbacks
+    - [X] implement custom columns editability
+    - [X] implement order address columns editability
+    - [X] implement inventory columns editability
+    - [ ] create a spreadsheet summarizing the compatibility of each editor across the different Magento versions (use three different states : "untested", "tested and functional", "tested with problems" - provide links to the related issues -)
+    - [ ] start filling up the compatibility spreadsheet
+- [ ] **JS code refactoring** :
+    - [ ] remove `CDATA` sections
+    - [ ] refactor and optimize code when possible
+    - [ ] review the code style (follow some best practices)
+    - [ ] ~~write comments (use [JSDoc](http://usejsdoc.org/index.html))~~ **(probably not worth the time)**
+    - [ ] implement an object manager, to remove as much clutter as possible from the global scope, and automatically cleanup unneeded/overridable objects (especially for Ajax grids)
+- [X] move the columns list form to dedicated window, as for the other forms (avoid cluttering any external wrapping form with a lot of parameters)
+- [X] rework the profiles bar so that the number of displayed profiles is adapted to the available width
+- [ ] rework the "Access All" profiles permission (make all the profiles be available from everywhere, except in the bar)
+- [ ] ~~rework the sales items columns (implement the advanced text filter, improve their extensibility, and allow to display a customizable value when exported)~~ **(later)**

app/code/community/BL/CustomGrid/Block/Column/Renderer/Attribute.php → app/code/community/BL/CustomGrid/Block/Column/Renderer/Attribute/Config.php

@@ -9,32 +9,29 @@
  *
  * @category   BL
  * @package    BL_CustomGrid
- * @copyright  Copyright (c) 2012 Benoît Leulliette <benoit.leulliette@gmail.com>
+ * @copyright  Copyright (c) 2015 Benoît Leulliette <benoit.leulliette@gmail.com>
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-class BL_CustomGrid_Block_Column_Renderer_Attribute
-    extends BL_CustomGrid_Block_Column_Renderer_Abstract
+class BL_CustomGrid_Block_Column_Renderer_Attribute_Config extends BL_CustomGrid_Block_Column_Renderer_Config_Abstract
 {
     protected function _getController()
     {
         return 'column_renderer_attribute';
     }
 
-    protected function _getFormId()
+    public function getFormId()
     {
-        return 'column_renderer_attribute_options_form';
-    }
-
-    public function getFormHtml()
-    {
-        $html = '<div class="blcg-attribute-renderer-help">' . $this->getRenderer()->getHelp() . '</div>';
-        $html .= parent::getFormHtml();
-        return $html;
+        return 'blcg_column_renderer_attribute_config_form';
     }
 
+    /**
+     * Return the current attribute column renderer
+     * 
+     * @return BL_CustomGrid_Model_Column_Renderer_Attribute_Abstract
+     */
     public function getRenderer()
     {
-        return Mage::registry('current_attribute_column_renderer');
+        return Mage::registry('blcg_attribute_column_renderer');
     }
-}
+}

app/code/community/BL/CustomGrid/Block/Column/Renderer/Attribute/Config/Form.php

@@ -9,23 +9,29 @@
  *
  * @category   BL
  * @package    BL_CustomGrid
- * @copyright  Copyright (c) 2012 Benoît Leulliette <benoit.leulliette@gmail.com>
+ * @copyright  Copyright (c) 2015 Benoît Leulliette <benoit.leulliette@gmail.com>
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-class BL_CustomGrid_Block_Column_Renderer_Attribute_Config_Form
-    extends BL_CustomGrid_Block_Column_Renderer_Config_Form_Abstract
-{   
-    protected function _getFormId()
+class BL_CustomGrid_Block_Column_Renderer_Attribute_Config_Form extends BL_CustomGrid_Block_Column_Renderer_Config_Form_Abstract
+{
+    public function getFormId()
     {
-        return 'column_renderer_attribute_options_form';
+        return 'blcg_column_renderer_attribute_config_form';
     }
 
+    public function getRendererType()
+    {
+        return 'attribute';
+    }
+
+    /**
+     * Return the current attribute column renderer
+     * 
+     * @return BL_CustomGrid_Model_Column_Renderer_Attribute_Abstract
+     */
     public function getRenderer()
     {
-        if (!$renderer = Mage::registry('current_attribute_column_renderer')) {
-            Mage::throwException($this->__('Renderer is not specified'));
-        }
-        return $renderer;
+        return Mage::registry('blcg_attribute_column_renderer');
     }
-}
+}

app/code/community/BL/CustomGrid/Block/Column/Renderer/Collection.php → app/code/community/BL/CustomGrid/Block/Column/Renderer/Collection/Config.php

@@ -9,32 +9,29 @@
  *
  * @category   BL
  * @package    BL_CustomGrid
- * @copyright  Copyright (c) 2012 Benoît Leulliette <benoit.leulliette@gmail.com>
+ * @copyright  Copyright (c) 2015 Benoît Leulliette <benoit.leulliette@gmail.com>
  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  */
 
-class BL_CustomGrid_Block_Column_Renderer_Collection
-    extends BL_CustomGrid_Block_Column_Renderer_Abstract
+class BL_CustomGrid_Block_Column_Renderer_Collection_Config extends BL_CustomGrid_Block_Column_Renderer_Config_Abstract
 {
     protected function _getController()
     {
         return 'column_renderer_collection';
     }
 
-    protected function _getFormId()
+    public function getFormId()
     {
-        return 'column_renderer_collection_options_form';
-    }
-
-    public function getFormHtml()
-    {
-        $html = '<div class="blcg-collection-renderer-help">' . $this->getRenderer()->getHelp() . '</div>';
-        $html .= parent::getFormHtml();
-        return $html;
+        return 'blcg_column_renderer_collection_config_form';
     }
 
+    /**
+     * Return the current collection column renderer
+     * 
+     * @return BL_CustomGrid_Model_Column_Renderer_Collection_Abstract
+     */
     public function getRenderer()
     {
-        return Mage::registry('current_collection_column_renderer');
+        return Mage::registry('blcg_collection_column_renderer');
     }
-}
+}