Updating per code review comments at hackathon

Author: JosephMaxwell

app/code/Magento/Config/Model/Config/Backend/Admin/Robots.php

@@ -9,6 +9,9 @@
  */
 namespace Magento\Config\Model\Config\Backend\Admin;
 
+use Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot;
+use Magento\Framework\App\ObjectManager;
+
 class Robots extends \Magento\Framework\App\Config\Value
 {
     /**
@@ -37,12 +40,14 @@ public function __construct(
         \Magento\Framework\App\Config\ScopeConfigInterface $config,
         \Magento\Framework\App\Cache\TypeListInterface $cacheTypeList,
         \Magento\Framework\Filesystem $filesystem,
-        \Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot $documentRoot,
         \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
-        array $data = []
+        array $data = [],
+        \Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot $documentRoot = null
     ) {
         parent::__construct($context, $registry, $config, $cacheTypeList, $resource, $resourceCollection, $data);
+
+        $documentRoot = $documentRoot ?: ObjectManager::getInstance()->get(DocumentRoot::class);
         $this->_directory = $filesystem->getDirectoryWrite($documentRoot->getPath());
         $this->_file = 'robots.txt';
     }

app/code/Magento/Config/Model/Config/Reader/Source/Deployed/DocumentRoot.php

@@ -1,30 +1,51 @@
 <?php
 /**
- * @by SwiftOtter, Inc., 04/01/2017
- * @website https://swiftotter.com
- **/
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 
 namespace Magento\Config\Model\Config\Reader\Source\Deployed;
 
 use Magento\Framework\Config\ConfigOptionsListConstants;
 use Magento\Framework\App\Filesystem\DirectoryList;
 
+/**
+ * Class DocumentRoot
+ * @package Magento\Config\Model\Config\Reader\Source\Deployed
+ */
 class DocumentRoot
 {
     private $config;
 
+    /**
+     * DocumentRoot constructor.
+     * @param \Magento\Framework\App\DeploymentConfig $config
+     */
     public function __construct(\Magento\Framework\App\DeploymentConfig $config)
     {
         $this->config = $config;
     }
 
+    /**
+     * A shortcut to load the document root path from the DirectoryList based on the
+     * deployment configuration.
+     *
+     * @return string
+     */
     public function getPath()
     {
         return $this->isPub() ? DirectoryList::PUB : DirectoryList::ROOT;
     }
 
+    /**
+     * Returns whether the deployment configuration specifies that the document root is
+     * in the pub/ folder. This affects ares such as sitemaps and robots.txt (and will
+     * likely be extended to control other areas).
+     *
+     * @return bool
+     */
     public function isPub()
     {
         return (bool)$this->config->get(ConfigOptionsListConstants::CONFIG_PATH_DOCUMENT_ROOT_IS_PUB);
     }
-}
+}

app/code/Magento/Config/Test/Unit/Model/Config/Reader/Source/Deployed/DocumentRootTest.php

@@ -53,13 +53,20 @@ public function setUp()
         $this->documentRoot = new Reader\Source\Deployed\DocumentRoot($this->configMock);
     }
 
+    /**
+     * Ensures that the path returned matches the pub/ path.
+     */
     public function testGetPath()
     {
         $this->configMockSetForDocumentRootIsPub();
 
         $this->assertSame(DirectoryList::PUB, $this->documentRoot->getPath());
     }
 
+    /**
+     * Ensures that the deployment configuration returns the mocked value for
+     * the pub/ folder.
+     */
     public function testIsPub()
     {
         $this->configMockSetForDocumentRootIsPub();

app/code/Magento/Sitemap/Model/Sitemap.php

@@ -7,6 +7,8 @@
 // @codingStandardsIgnoreFile
 
 namespace Magento\Sitemap\Model;
+use Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * Sitemap model
@@ -175,13 +177,14 @@ public function __construct(
         \Magento\Store\Model\StoreManagerInterface $storeManager,
         \Magento\Framework\App\RequestInterface $request,
         \Magento\Framework\Stdlib\DateTime $dateTime,
-        \Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot $documentRoot,
         \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
-        array $data = []
+        array $data = [],
+        \Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot $documentRoot = null
     ) {
         $this->_escaper = $escaper;
         $this->_sitemapData = $sitemapData;
+        $documentRoot = $documentRoot ?: ObjectManager::getInstance()->get(DocumentRoot::class);
         $this->_directory = $filesystem->getDirectoryWrite($documentRoot->getPath());
         $this->_categoryFactory = $categoryFactory;
         $this->_productFactory = $productFactory;

generated/.htaccess

@@ -0,0 +1,2 @@
+Order allow,deny
+Deny from all

vendor/.htaccess

@@ -0,0 +1,2 @@
+Order allow,deny
+Deny from all