Merge pull request #26 from ho-nl/develop

Release v0.2.2
ho-nl · Jun 22, 2017 · f7ddfc2 · f7ddfc2
2 parents ff5c8c0 + efef533
commit f7ddfc2
Show file tree

Hide file tree

Showing 8 changed files with 88 additions and 68 deletions.
diff --git a/Block/Hints/Init.php b/Block/Hints/Init.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2016 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
+ * Copyright © 2017 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
  * See LICENSE.txt for license details.
  */
 
@@ -12,39 +12,32 @@
 use Magento\Framework\View\Element\Context;
 
 /**
- * 
- *
  * @package Ho\Templatehints\Block\Hints
  */
 class Init extends AbstractBlock
 {
     /**
-     * A repository service for view assets
-     * @var \Magento\Framework\View\Asset\Repository
+     * A repository service for view assets.
+     *
+     * @var \Magento\Framework\View\Asset\Repository $assetRepository
      */
-    protected $assetRepository;
+    private $assetRepository;
 
     /**
-     * List of page assets that combines into groups ones having the same properties
-     * @var AssetCollection
+     * List of page assets that combines into groups ones having the same properties.
+     *
+     * @var AssetCollection $assetCollection
      */
-    protected $assetCollection;
-
+    private $assetCollection;
 
     /**
-     * Constructor
-     *
      * @param Context         $context
      * @param AssetCollection $assetCollection
      * @param Config          $config
      * @param array           $data
      */
-    public function __construct(
-        Context $context,
-        AssetCollection $assetCollection,
-        Config $config,
-        array $data = []
-    ) {
+    public function __construct(Context $context, AssetCollection $assetCollection, Config $config, array $data = [])
+    {
         if ($config->isHintEnabled()) {
             $this->assetRepository = $context->getAssetRepository();
             $this->assetCollection = $assetCollection;
@@ -54,7 +47,6 @@ public function __construct(
         return parent::__construct($context, $data);
     }
 
-
     /**
      * Add assets to the header required for the initialisation of the scripts
      *

diff --git a/Helper/Config.php b/Helper/Config.php
@@ -1,39 +1,68 @@
 <?php
 /**
- * Copyright (c) 2016 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
+ * Copyright © 2017 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
  * See LICENSE.txt for license details.
  */
 
 namespace Ho\Templatehints\Helper;
 
+use Magento\Developer\Helper\Data as DeveloperHelper;
 use Magento\Framework\App\Helper\AbstractHelper;
 use Magento\Framework\App\Helper\Context;
 use Magento\Framework\App\State as AppState;
+use Magento\Store\Model\StoreManagerInterface;
 
-class Config extends AbstractHelper {
-
-    /**
-     * @var AppState
-     */
+class Config extends AbstractHelper
+{
+    /** @var AppState $appState */
     private $appState;
 
+    /** @var StoreManagerInterface $storeManager */
+    private $storeManager;
 
-    public function __construct(Context $context, AppState $appState)
-    {
+    /** @var DeveloperHelper $developerHelper */
+    private $developerHelper;
+
+    /**
+     * @param Context               $context
+     * @param AppState              $appState
+     * @param StoreManagerInterface $storeManager
+     * @param DeveloperHelper       $developerHelper
+     */
+    public function __construct(
+        Context $context,
+        AppState $appState,
+        StoreManagerInterface $storeManager,
+        DeveloperHelper $developerHelper
+    ) {
         parent::__construct($context);
+
         $this->appState = $appState;
+        $this->storeManager = $storeManager;
+        $this->developerHelper = $developerHelper;
     }
 
-
     /**
-     * Check if the hints can be displayed, depends on the developer mode and if the url parameter is present.
+     * Check if the hints can be displayed.
+     *
+     * It will check if the url parameter is present.
+     * For production mode it will also check if the IP-address is in Developer Client Restrictions.
      *
      * @return bool
      */
     public function isHintEnabled()
     {
-        $isDeveloperMode = $this->appState->getMode() === AppState::MODE_DEVELOPER;
         $isParamPresent = $this->_request->getParam('ath', false) === '1';
-        return $isDeveloperMode && $isParamPresent;
+
+        if ($isParamPresent) {
+            $applicationMode = $this->appState->getMode();
+            $storeId = $this->storeManager->getStore()->getId();
+
+            if ($applicationMode === AppState::MODE_DEVELOPER || $this->developerHelper->isDevAllowed($storeId)) {
+                return true;
+            }
+        }
+
+        return false;
     }
 }
diff --git a/Plugin/View/LayoutPlugin.php b/Plugin/View/LayoutPlugin.php
@@ -1,8 +1,9 @@
 <?php
 /**
- * Copyright (c) 2016 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
+ * Copyright © 2017 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
  * See LICENSE.txt for license details.
  */
+
 namespace Ho\Templatehints\Plugin\View;
 
 use Closure;
@@ -12,36 +13,30 @@
 use Magento\Framework\View\Layout\Data\Structure;
 
 /**
- * When a block is rendered
+ * When a block is rendered.
  *
- * Class LayoutPlugin
  * @package Ho\Templatehints\Plugin\View
  */
 class LayoutPlugin
 {
-
     /**
-     * Layout model
+     * Layout model.
      *
-     * @var Layout
+     * @var Layout $layout
      */
     private $layout;
 
     /**
-     * Magento directory listing
+     * Magento directory listing.
      *
-     * @var DirectoryList
+     * @var DirectoryList $directoryList
      */
     private $directoryList;
 
-    /**
-     * @var Structure
-     */
+    /** @var Structure $structure */
     private $structure;
 
     /**
-     * LayoutPlugin constructor.
-     *
      * @param DirectoryList $directoryList
      * @param HintConfig    $hintConfig
      * @param Layout        $layout
@@ -51,8 +46,8 @@ public function __construct(
         HintConfig $hintConfig,
         Layout $layout
     ) {
-        $this->hintConfig = $hintConfig;
         $this->directoryList = $directoryList;
+        $this->hintConfig = $hintConfig;
         $this->layout = $layout;
 
         $layoutReflection = new \ReflectionClass($this->layout);
@@ -76,6 +71,7 @@ public function aroundRenderElement(Layout $layout, Closure $proceed, $name, $us
         if ($this->hintConfig->isHintEnabled() === false) {
             return $result;
         }
+
         return $this->_decorateElement($result, $name);
     }
 
@@ -120,8 +116,7 @@ private function _decorateElement($result, $name)
      */
     public function decorateOuterElement($html, $attributes)
     {
-
-        if (!$html) {
+        if (! $html) {
             return $html;
         }
 
@@ -137,12 +132,13 @@ public function decorateOuterElement($html, $attributes)
             $html,
             1
         );
+
         return $html;
     }
 
     /**
      * @param string $nameInLayout
-     * @param [] $container
+     * @param array $container
      *
      * @return string
      */
@@ -198,8 +194,10 @@ public static function filterEscapeEncode(array $data)
     }
 
     /**
-     * Filter and escape the complete array
+     * Filter and escape the complete array.
+     *
      * @param $data
+     *
      * @return array
      */
     private static function filterEscape($data)
@@ -237,6 +235,7 @@ private function getBlockClass(\Magento\Framework\View\Element\AbstractBlock $bl
             $reflector = new \ReflectionClass($block); //@codingStandardsIgnoreLine
             $className = $reflector->getParentClass()->getName();
         }
+
         return $className;
     }
 }
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ php bin/magento setup:upgrade
 ![Setting up PHPStorm](docs/phpstorm-config.png)
 
 ## Usage
-1. Set your Magento 2 installation to developer mode.
+1. Set your Magento 2 installation to developer mode (when in production mode make sure to add your IP-address in Developer Client Restrictions).
 2. Add `?ath=1` to your URL to activate.
 3. Open up your console in you Chrome/Firefox/Safari/~IE~ devtools.
 4. hold <kbd>⇧</kbd> (shift)

diff --git a/composer.json b/composer.json
@@ -15,7 +15,6 @@
     "php": "~5.5.0|~5.6.0|~7.0.0"
   },
   "type": "magento2-module",
-  "version": "0.2.1",
   "license": "BSD-2-Clause",
   "autoload": {
     "files": [
@@ -24,5 +23,10 @@
     "psr-4": {
       "Ho\\Templatehints\\": ""
     }
+  },
+  "extra": {
+    "branch-alias": {
+      "dev-master": "0.2-dev"
+    }
   }
 }
diff --git a/etc/di.xml b/etc/di.xml
@@ -1,12 +1,10 @@
 <?xml version="1.0"?>
 <!--
-/**
- * Copyright (c) 2016 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
- * See LICENSE.txt for license details.
- */
--->
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+  ~ Copyright © 2017 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
+  ~ See LICENSE.txt for license details.
+  -->
 
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <type name="Magento\Framework\View\Layout">
         <plugin sortOrder="1" name="hoTemplatehintsLayout" type="Ho\Templatehints\Plugin\View\LayoutPlugin" />
     </type>

diff --git a/etc/module.xml b/etc/module.xml
@@ -1,10 +1,9 @@
 <?xml version="1.0"?>
 <!--
-/**
- * Copyright (c) 2016 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
- * See LICENSE.txt for license details.
- */
--->
+  ~ Copyright © 2017 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
+  ~ See LICENSE.txt for license details.
+  -->
+
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="Ho_Templatehints" setup_version="0.2.1" />
+    <module name="Ho_Templatehints" setup_version="0.2.2"/>
 </config>
diff --git a/view/base/layout/default.xml b/view/base/layout/default.xml
@@ -1,10 +1,9 @@
 <?xml version="1.0"?>
 <!--
-/**
- * Copyright (c) 2016 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
- * See LICENSE.txt for license details.
- */
--->
+  ~ Copyright © 2017 H&O E-commerce specialisten B.V. (http://www.h-o.nl/)
+  ~ See LICENSE.txt for license details.
+  -->
+
 <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
     <body>
         <referenceContainer name='root'>