Version 1.1.5 Released

Rafael Grigorian · Rafael Grigorian · commit a74997b61e18 · 2018-08-17T15:07:03.000-05:00
- Fixed GH-10, added auto-purge for categories - Fixed GH-11, when product is saved, categories are purged as well - Fixed GH-12, add 'substring' option for purge url functionality - Fixed GH-13, auto purge no works when deleting products/categories
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,3 +18,9 @@
 
 ## Version 1.1.4
 -	Fixed GH-8, issue with not using rewrites for auto-purge
+
+## Version 1.1.5
+-	Fixed GH-10, added auto-purge for categories
+-	Fixed GH-11, when product is saved, categories are purged as well
+-	Fixed GH-12, add 'substring' option for purge url functionality
+-	Fixed GH-13, auto purge no works when deleting products/categories
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Magento 2 - Varnish
 > Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend
 
-![MIT License](https://img.shields.io/badge/License-MIT-lightgrey.svg?style=for-the-badge)
-![Version 1.1.4](https://img.shields.io/badge/Version-1.1.4-lightgrey.svg?style=for-the-badge)
-![Stability Beta](https://img.shields.io/badge/Stability-Beta-lightgrey.svg?style=for-the-badge)
+![](https://img.shields.io/badge/License-MIT-lightgrey.svg?style=for-the-badge)
+![](https://img.shields.io/badge/Version-1.1.5-lightgrey.svg?style=for-the-badge)
+![](https://img.shields.io/badge/Stability-Stable-lightgrey.svg?style=for-the-badge)
 
 <p align="center" >
 	<img src="docs/images/preview.png" width="100%" />
diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
 	"name": "jetrails/magento2-varnish",
 	"description": "Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend",
 	"type": "magento2-module",
-	"version": "1.1.4",
+	"version": "1.1.5",
 	"license": "MIT",
 	"authors": [
 		{
diff --git a/design/user_guide.sketch b/design/user_guide.sketch
diff --git a/docs/user_guide.pdf b/docs/user_guide.pdf
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "Varnish",
-	"version": "1.1.4",
+	"version": "1.1.5",
 	"description": "Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend",
 	"repository": {
 		"type": "git",
diff --git a/src/app/code/JetRails/Varnish/Block/Adminhtml/System/Config/Form/Link.php b/src/app/code/JetRails/Varnish/Block/Adminhtml/System/Config/Form/Link.php
@@ -9,7 +9,7 @@
 	 * Link.php - This block alongside the template is used to render a link to the cache management
 	 * page in the magento store backend.  This block is also referenced as a frontend model in the
 	 * system.xml file.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Form
 	 * @author          Rafael Grigorian - JetRails®
@@ -44,4 +44,4 @@ public function getActionUrl () {
 			return $this->getUrl ("adminhtml/cache/index");
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Console/Command/AbstractCommand.php b/src/app/code/JetRails/Varnish/Console/Command/AbstractCommand.php
@@ -2,7 +2,6 @@
 
 	namespace JetRails\Varnish\Console\Command;
 
-
 	use JetRails\Varnish\Helper\Data;
 	use JetRails\Varnish\Helper\Purger;
 	use JetRails\Varnish\Logger\Logger;
@@ -16,7 +15,7 @@
 	 * is meant to be a buffer between that class and the commands that are implemented in this
 	 * module.  Instead of using the execute command, the child classes overload the runCommand
 	 * method.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Status
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Purge/All.php b/src/app/code/JetRails/Varnish/Console/Command/Purge/All.php
@@ -8,7 +8,7 @@
 	/**
 	 * All.php - This class inherits from the AbstractCommand.  This command contacts all the
 	 * configured varnish cache servers and asks them to flush all the cache for all urls.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
@@ -81,4 +81,4 @@ protected function runCommand ( InputInterface $input ) {
 			];
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Purge/Store.php b/src/app/code/JetRails/Varnish/Console/Command/Purge/Store.php
@@ -12,7 +12,7 @@
 	 * servers that start with the store view's base url.  If no argument is passed, then a list of
 	 * store views along with their base url, id, and name is displayed in the payload of the
 	 * response.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
@@ -138,4 +138,4 @@ protected function runCommand ( InputInterface $input ) {
 			return [ "status" => false, "message" => "could not find specified store view" ];
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Purge/Url.php b/src/app/code/JetRails/Varnish/Console/Command/Purge/Url.php
@@ -10,7 +10,7 @@
 	/**
 	 * Url.php - This class inherits from the AbstractCommand.  This command takes in a url and asks
 	 * all the saved varnish servers a request to purge the passed url from cache.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Status.php b/src/app/code/JetRails/Varnish/Console/Command/Status.php
@@ -9,7 +9,7 @@
 	 * Status.php - This class inherits from the AbstractCommand.  This command tells the user if
 	 * the module is enabled.  In the sense that the 'Caching Application' setting is set to
 	 * 'Varnish Cache', and not 'Built-in Cache'.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Command
 	 * @author          Rafael Grigorian - JetRails®
@@ -46,4 +46,4 @@ protected function runCommand ( InputInterface $input ) {
 			return [ "status" => $status, "message" => $message ];
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Console/Command/Status/Set.php b/src/app/code/JetRails/Varnish/Console/Command/Status/Set.php
@@ -2,7 +2,6 @@
 
 	namespace JetRails\Varnish\Console\Command\Status;
 
-
 	use JetRails\Varnish\Console\Command\AbstractCommand;
 	use Magento\Framework\App\Cache\Type\Config as ConfigType;
 	use Magento\PageCache\Model\Config;
@@ -13,7 +12,7 @@
 	 * Set.php - This class inherits from the AbstractCommand.  This command takes in an additional
 	 * argument, either enable or disable, and sets the caching application to 'Varnish Cache' or
 	 * 'Built-in Cache' respectfully.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Status
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/All.php b/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/All.php
@@ -13,7 +13,7 @@
 	 * All.php - This class is a controller action and when it is triggered, it is responsible for
 	 * looping through all the saved varnish cache servers and purging all the cache for all the
 	 * urls that are stored with those varnish cache servers.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
@@ -99,4 +99,4 @@ public function execute () {
 			return $redirect->setPath ("adminhtml/cache/index");
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Store.php b/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Store.php
@@ -13,7 +13,7 @@
 	 * Store.php - This class is a controller action and when it is triggered, it is responsible for
 	 * purging all the cache in all the configured cache servers that match (start with) the base
 	 * url of the store view.  The store view id is passed as a parameter
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
@@ -112,4 +112,4 @@ public function execute () {
 			return $redirect->setPath ("adminhtml/cache/index");
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Url.php b/src/app/code/JetRails/Varnish/Controller/Adminhtml/Purge/Url.php
@@ -12,7 +12,7 @@
 	/**
 	 * Url.php - This class is a controller action and when it is triggered, it is responsible for
 	 * purging all the cache in all the configured cache servers that exactly match the passed url.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Helper/Data.php b/src/app/code/JetRails/Varnish/Helper/Data.php
@@ -16,7 +16,7 @@
 	 * Data.php - This helper class is responsible for data retrieval and configuration.  It can use
 	 * the store config and the Magento session information to return data about the user and about
 	 * the module configuration on the store scope.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Helper
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Helper/Purger.php b/src/app/code/JetRails/Varnish/Helper/Purger.php
@@ -12,7 +12,7 @@
 	 * Purger.php - This class is encapsulated with purge specific methods in order to use them on
 	 * the backend controllers and the console commands.  These methods specifically purge single
 	 * URLs, store views, and even purge all cache from a list of given varnish servers.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Helper
 	 * @author          Rafael Grigorian - JetRails®
@@ -24,12 +24,9 @@ class Purger extends AbstractHelper {
 		/**
 		 * These internal data members include instances of helper classes that are injected into
 		 * the class using dependency injection on runtime.
-		 * @var         Data                _data               Instance of the Data helper class
-		 * @var         Data                _storeManager       Instance of the StoreManager
-		 *
-		 *
-		 *
-		 *
+		 * @var         Data                  _data              Instance of the Data helper class
+		 * @var         StoreManagerInterface _storeManager      Instance of the StoreManager
+		 * @var         UrlFinderInterface    _urlFinder         Instance of the UrlFinder
 		 */
 		protected $_data;
 		protected $_storeManager;
diff --git a/src/app/code/JetRails/Varnish/Logger/Handler.php b/src/app/code/JetRails/Varnish/Logger/Handler.php
@@ -8,7 +8,7 @@
 	/**
 	 * Handler.php - This class is used by Magento to define a custom log file.  These injections
 	 * for runtime reflection of this custom logging class is defined within the di.xml file.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Logger
 	 * @author          Rafael Grigorian - JetRails®
@@ -26,4 +26,4 @@ class Handler extends Base {
 		protected $fileName = "/var/log/jetrails/purge.varnish.log";
 		protected $loggerType = MonoLogger::INFO;
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Logger/Logger.php b/src/app/code/JetRails/Varnish/Logger/Logger.php
@@ -9,7 +9,7 @@
 	 * method in essence is the same as the info method because it logs with the same severity, but
 	 * it also takes in additional blame oriented data in order to propagate blame to the caller as
 	 * well as the action that was taken.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Logger
 	 * @author          Rafael Grigorian - JetRails®
@@ -35,4 +35,4 @@ public function blame ( $info, $message, array $context = [] ) {
 			parent::info ( strtolower ( json_encode ( $message ) ), $context );
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/EnableDisable.php b/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/EnableDisable.php
@@ -7,7 +7,7 @@
 	/**
 	 * EnableDisable.php - These options include enable and disable with enable having an integer
 	 * value of 1 and disable having an integer value of 0.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Options
 	 * @author          Rafael Grigorian - JetRails®
@@ -38,4 +38,4 @@ public function toOptionArray () {
 			];
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/YesNo.php b/src/app/code/JetRails/Varnish/Model/Adminhtml/Config/Options/YesNo.php
@@ -7,7 +7,7 @@
 	/**
 	 * YesNo.php - These options include yes and no.  Yes has an integer value of 1 and no has an
 	 * integer value of 0.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Options
 	 * @author          Rafael Grigorian - JetRails®
@@ -38,4 +38,4 @@ public function toOptionArray () {
 			];
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Observer/AutoPurge.php b/src/app/code/JetRails/Varnish/Observer/AutoPurge.php
@@ -11,12 +11,10 @@
 	use Magento\Store\Model\StoreManagerInterface;
 
 	/**
-	 * AutoPurge.php -
-	 *
-	 *
-	 *
-	 *
-	 * @version         1.1.4
+	 * AutoPurge.php - This abstract class is in place to contain some necessary methods that
+	 * in all sub classes. These classes must implement the execute method since this class
+	 * extends from the Magento Action class.
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
@@ -65,6 +63,14 @@ public function __construct (
 			$this->_storeManager = $storeManager;
 		}
 
+		/**
+		 * This method takes in a target url to purge and it traverses through all the configured
+		 * varnish servers and asks them to purge said url. An optional flag is passed to purge
+		 * all urls that contain the given string.
+		 * @var         Boolean             purgeChildren       Purge all URLS that contain target?
+		 * @param       String              target              The URL to purge
+		 * @return      void
+		 */
 		protected function _purgeOnAllServers ( $target, $purgeChildren = false ) {
 			$noErrors = true;
 			$url = $this->_purger->validateUrl ( $target );
@@ -92,6 +98,12 @@ protected function _purgeOnAllServers ( $target, $purgeChildren = false ) {
 			return $noErrors;
 		}
 
+		/**
+		 * This method takes in a route and it looks through the rewrites table for all urls that lead
+		 * to said url.
+		 * @param       String              route               The route to look for in rewrites table
+		 * @return      void
+		 */
 		protected function _purgeUsingRoute ( $route ) {
 			// Get the base url for the current store
 			$baseUrl = $this->_storeManager->getStore ()->getBaseUrl ();
@@ -115,6 +127,11 @@ protected function _purgeUsingRoute ( $route ) {
 			}
 		}
 
+		/**
+		 * This method is abstract because this class implements the Action class.
+		 * @param       Observer            observer            Observer object passed on dispatch
+		 * @return      void
+		 */
 		public abstract function execute ( Observer $observer );
 
 	}
diff --git a/src/app/code/JetRails/Varnish/Observer/AutoPurge/Category.php b/src/app/code/JetRails/Varnish/Observer/AutoPurge/Category.php
@@ -9,7 +9,7 @@
 	 * Category.php - This observer is triggered when the category save event is fired.  It then
 	 * finds the url of the category and sends a URL purge request to the configured varnish
 	 * servers.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Observer/AutoPurge/Page.php b/src/app/code/JetRails/Varnish/Observer/AutoPurge/Page.php
@@ -8,7 +8,7 @@
 	/**
 	 * Page.php - This observer is triggered when the CMS page save event is fired.  It then finds
 	 * the url of the CMS page and sends a URL purge request to the configured varnish servers.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Observer/AutoPurge/Product.php b/src/app/code/JetRails/Varnish/Observer/AutoPurge/Product.php
@@ -8,7 +8,7 @@
 	/**
 	 * Product.php - This observer is triggered when the product save event is fired.  It then finds
 	 * the url of the product and sends a URL purge request to the configured varnish servers.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Observer/Excluder.php b/src/app/code/JetRails/Varnish/Observer/Excluder.php
@@ -14,7 +14,7 @@
 	 * then looks at the URL and route of the controller action in question, and it checks the store
 	 * config for excluded URLs and routes.  If any match, then a header parameter is set in order
 	 * not to cache the page.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Observer
 	 * @author          Rafael Grigorian - JetRails®
@@ -102,4 +102,4 @@ public function execute ( Observer $observer ) {
 
 		}
 
-	}
+	}
diff --git a/src/app/code/JetRails/Varnish/Observer/Save/Cache.php b/src/app/code/JetRails/Varnish/Observer/Save/Cache.php
@@ -16,7 +16,7 @@
 	 * Cache.php - This observer event is triggered whenever the caching application is changed in
 	 * the system configuration page under the Advanced menu. Based on the caching application,
 	 * the varnish module will be disabled or enabled.
-	 * @version         1.1.4
+	 * @version         1.1.5
 	 * @package         JetRails® Varnish
 	 * @category        Save
 	 * @author          Rafael Grigorian - JetRails®
diff --git a/src/app/code/JetRails/Varnish/Observer/Save/Config.php b/src/app/code/JetRails/Varnish/Observer/Save/Config.php
diff --git a/src/app/code/JetRails/Varnish/etc/acl.xml b/src/app/code/JetRails/Varnish/etc/acl.xml
diff --git a/src/app/code/JetRails/Varnish/etc/adminhtml/routes.xml b/src/app/code/JetRails/Varnish/etc/adminhtml/routes.xml
diff --git a/src/app/code/JetRails/Varnish/etc/di.xml b/src/app/code/JetRails/Varnish/etc/di.xml
diff --git a/src/app/code/JetRails/Varnish/etc/module.xml b/src/app/code/JetRails/Varnish/etc/module.xml
diff --git a/src/app/code/JetRails/Varnish/registration.php b/src/app/code/JetRails/Varnish/registration.php
diff --git a/src/app/code/JetRails/Varnish/view/adminhtml/layout/adminhtml_cache_index.xml b/src/app/code/JetRails/Varnish/view/adminhtml/layout/adminhtml_cache_index.xml
diff --git a/src/app/code/JetRails/Varnish/view/adminhtml/templates/adminhtml/system/config/form/link.phtml b/src/app/code/JetRails/Varnish/view/adminhtml/templates/adminhtml/system/config/form/link.phtml

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"name": "jetrails/magento2-varnish",`
`3`	`3`	`"description": "Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend",`
`4`	`4`	`"type": "magento2-module",`
`5`		`- "version": "1.1.4",`
	`5`	`+ "version": "1.1.5",`
`6`	`6`	`"license": "MIT",`
`7`	`7`	`"authors": [`
`8`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Varnish",`
`3`		`- "version": "1.1.4",`
	`3`	`+ "version": "1.1.5",`
`4`	`4`	`"description": "Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`