Fixed GH-20

Author: Rafael Grigorian

CHANGELOG.md

@@ -27,4 +27,7 @@
 
 ## Version 1.1.6
 -	Fixed GH-15, added module version and combines auto-purge messages
--	Fixed GH-18, Auto-purge loops through store views on "all store view" scope
+-	Fixed GH-18, auto-purge loops through store views on "all store view" scope
+
+## Version 1.1.7
+-	Fixed GH-20, Varnish trademark compliance

README.md

@@ -1,8 +1,8 @@
 # Magento 2 - Varnish
-> Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend.
+> Magento 2 extension which interfaces with the Varnish® caching application in order to manage it through the Magento backend.
 
 ![](https://img.shields.io/badge/License-MIT-lightgrey.svg?style=for-the-badge)
-![](https://img.shields.io/badge/Version-1.1.6-lightgrey.svg?style=for-the-badge)
+![](https://img.shields.io/badge/Version-1.1.7-lightgrey.svg?style=for-the-badge)
 ![](https://img.shields.io/badge/Stability-Stable-lightgrey.svg?style=for-the-badge)
 
 <p align="center" >
@@ -11,7 +11,7 @@
 
 ## About
 
-This module helps manage varnish cache for your Magento 2 store.  It supports a multiple varnish server configuration.  Purge requests can be sent to all these servers in order to purge a specific URL, a whole store view, or simply to purge all the cache that is contained in said varnish server. Additionally, the purge process can be executed automatically on product or CMS page save. Cache exclusion rules can be set to not cache paths or Magento routes. Finally, there exists a _debug_ mode that will display if Varnish FPC was used in loading the page and which exclusion rules should be blamed if the page is excluded.
+This module helps manage varnish Cache™ for your Magento 2 store.  It supports a multiple varnish server configuration.  Purge requests can be sent to all these servers in order to purge a specific URL, a whole store view, or simply to purge all the cache that is contained in said varnish server. Additionally, the purge process can be executed automatically on product or CMS page save. Cache exclusion rules can be set to not cache paths or Magento routes. Finally, there exists a _debug_ mode that will display if Varnish FPC was used in loading the page and which exclusion rules should be blamed if the page is excluded.
 
 ## Documentation
 
@@ -26,9 +26,13 @@ All JetRails® modules use __Grunt__ as a build system.  Grunt is a package that
 | `version`  | Updates the version number in all __php__ and __xml__ files with the one defined in __package.json__.                                                                                           |
 | `release`  | This command first runs __init__ and then __resolve__.  It then compresses the source and dependencies and outputs the archive in __dist__.  This command gets the repo ready for a git commit. |
 | `deploy`   | Will upload dependencies and source code to a staging server.  Credentials to this server can be configured in the __package.json__ file under the _staging_ attribute.                         |
-| `stream`   | Will watch the __lib__ and __src__ folders for any changes. Once a change occurs it will run the __deploy__ task.                                                                               |
+| `watch`    | Will watch the __src__ folder for any changes. Once a change occurs it will run the __deploy__ task.                                                                               |
 |            | The default task is aliased to run the __release__ task.                                                                                                                                        |
 
 ## Docker Environment
 
 This project comes with a [docker-compose.yml](docker-compose.yml) file as well as a [docker-sync.yml](docker-sync.yml) file, which can be used to spin up a Magento 2 environment. In order to use docker, please make sure you have **Docker**, **Docker Compose**, and **Docker Sync** installed. For information about configuring this docker environment, please refer to it's Github repository which can be found [here](https://github.com/jetrails/docker-magento-alpine).
+
+## Legal Disclaimer
+
+Varnish is a registered trademark of Varnish Software AB and its affiliates.

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.6",
+	"version": "1.1.7",
 	"license": "MIT",
 	"authors": [
 		{

package.json

@@ -1,7 +1,7 @@
 {
-	"version": "1.1.6",
+	"version": "1.1.7",
 	"name": "magento2-varnish",
-	"description": "Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend",
+	"description": "Magento 2 extension which interfaces with the Varnish® caching application in order to manage it through the Magento backend.",
 	"author": "Rafael Grigorian",
 	"company": "JetRails®",
 	"license": "MIT",

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.6
+	 * @version         1.1.7
 	 * @package         JetRails® Varnish
 	 * @category        Form
 	 * @author          Rafael Grigorian - JetRails®

src/app/code/JetRails/Varnish/Console/Command/AbstractCommand.php

@@ -15,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.6
+	 * @version         1.1.7
 	 * @package         JetRails® Varnish
 	 * @category        Status
 	 * @author          Rafael Grigorian - JetRails®
@@ -107,14 +107,15 @@ protected function execute ( InputInterface $input, OutputInterface $output ) {
 			$this->_printLabel ( $output, "Powered By", "The JetRails Team" );
 			$this->_printLabel ( $output, "Email Us", "[email protected]" );
 			$this->_printLabel ( $output, "Call Us", "+1 (888) 554-9990" );
+			$this->_printLabel ( $output, "Disclaimer", "Varnish is a registered trademark of Varnish Software AB and its affiliates." );
 			$output->writeln ("");
 			// Check to see if we should run the command if feature is disabled
 			if ( !$this->_runIfDisabled && !$this->_data->isEnabled () ) {
 				// Define the return parameters
 				$status   = "unsuccessful";
-				$message  = "Cache application must be set to <options=underscore>Varnish Cache</>";
+				$message  = "Cache application must be set to <options=underscore>Varnish Cache™</>";
 				$payload  = "<fg=red>varnish:status:set enable</>";
-				$payload .= "Run '$payload' to set varnish cache as caching application";
+				$payload .= "Run '$payload' to set Varnish Cache™ as caching application";
 				// Set the response object to be the above parameters
 				$response = ( object ) [
 					"status" => $status,

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.6
+	 * @version         1.1.7
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®

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.6
+	 * @version         1.1.7
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
@@ -53,7 +53,7 @@ private function _findStoreViewById ( $storeViews, $id ) {
 		protected function configure () {
 			// Register the command and set the arguments
 			$this->setName ("varnish:purge:store")
-			->setDescription ("Purge varnish cache based on store view")
+			->setDescription ("Purge Varnish Cache™ based on store view")
 			->addArgument ( "store", InputArgument::OPTIONAL, "Store view id to purge" );
 		}
 

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.6
+	 * @version         1.1.7
 	 * @package         JetRails® Varnish
 	 * @category        Purge
 	 * @author          Rafael Grigorian - JetRails®
@@ -35,7 +35,7 @@ class Url extends AbstractCommand {
 		protected function configure () {
 			// Register the command and set the arguments
 			$this->setName ("varnish:purge:url")
-			->setDescription ("Purge specific url from varnish cache")
+			->setDescription ("Purge specific url from Varnish Cache™")
 			->addArgument ( "url", InputArgument::REQUIRED, "What URL do you want to purge?" )
 			->addOption ( "substring", null, InputOption::VALUE_NONE, "Purge all URLs that contain the given URL" );
 		}

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.6
+	 * @version         1.1.7
 	 * @package         JetRails® Varnish
 	 * @category        Command
 	 * @author          Rafael Grigorian - JetRails®
@@ -39,8 +39,8 @@ protected function configure () {
 		protected function runCommand ( InputInterface $input ) {
 			// Check to see if varnish caching is enabled and prepare message
 			$status = $this->_data->isEnabled ();
-			$message = $status ? "Varnish" : "Built-in";
-			$message = "<options=underscore>$message Cache</>";
+			$message = $status ? "Varnish Cache™" : "Built-in Cache";
+			$message = "<options=underscore>$message</>";
 			$message = "Caching application is set to $message";
 			// Return the message and status to caller
 			return [ "status" => $status, "message" => $message ];