Final touch for first release

Author: schmengler

CHANGELOG.md

@@ -6,6 +6,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 ### Added
-### Changed
-### Removed
-### Fixed
+
+- Cronjob that generates rewrite map files for each store and redirect type

README.md

@@ -13,7 +13,9 @@
 
 ---
 
-Generate RewriteMap files for Apache from Magento URL rewrites
+Generate RewriteMap files for Apache from custom Magento URL rewrites (redirects). This can be useful to re-use the rewrites in a different frontend.
+
+For example, to use the redirects in **Vue Storefront**, a reverse proxy that uses the generated rewrite maps can be configured.  
 
 ## Installation
 
@@ -29,8 +31,17 @@ Generate RewriteMap files for Apache from Magento URL rewrites
 
 ## Configuration
 
+In your store configuration navigate to *Catalog > SEO*:
+
+- **Enable Rewrite Maps Generation**: set to "yes" to enable (Default: no)
+- **Rewrite Maps Generation Cron Schedule**: configure, when rewrite maps are regenerated (Default: every hour)
+
 ## Usage
 
+Rewrite maps are stored in `var/rewrite_maps` as one text file per store and redirect type (301, 302).
+
+See http://httpd.apache.org/docs/current/rewrite/rewritemap.html for details how to use those files.
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

src/Cron/GenerateRewriteMaps.php

@@ -3,11 +3,11 @@
 
 namespace IntegerNet\RewriteMap\Cron;
 
-use IntegerNet\RewriteMap\Model\RewriteMapsSavingService as RewriteMapsSavingService;
+use IntegerNet\RewriteMap\Model\RewriteMapsSavingService;
 use Magento\Framework\App\Config\ScopeConfigInterface;
-use Magento\Framework\Exception\FileSystemException as FileSystemException;
+use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Exception\InputException;
-use Psr\Log\LoggerInterface as LoggerInterface;
+use Psr\Log\LoggerInterface;
 
 class GenerateRewriteMaps
 {

src/etc/adminhtml/system.xml

@@ -1,23 +1,24 @@
 <?xml version="1.0" ?>
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
-	<system>
-		<section id="catalog">
-			<group id="seo">
-				<field id="rewrite_maps_generation_enabled" showInDefault="1" showInStore="1" showInWebsite="1"
-                       sortOrder="500" translate="label" type="select">
-					<label>Enable Rewrite Maps Generation</label>
-					<comment>
-						<![CDATA[Enables the generation of rewrite maps files from the Magento UrlRewrites.
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="catalog">
+            <group id="seo">
+                <field id="rewrite_maps_generation_enabled" showInDefault="1" sortOrder="500" translate="label"
+                       type="select">
+                    <label>Enable Rewrite Maps Generation</label>
+                    <comment>
+                        <![CDATA[Enables the generation of rewrite maps files from the Magento UrlRewrites.
 						The files are saved under
 						path_to_magento/var/rewrite_map/map/rewrite-map-[REDIRECT_TYPE]-store-[STORE_ID].txt]]>
-					</comment>
+                    </comment>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
-				</field>
-				<field id="rewrite_maps_generation_cron_schedule" showInDefault="1" showInStore="1" showInWebsite="1"
-					   sortOrder="510" translate="label" type="text">
-					<label>Rewrite Maps Generation Cron Schedule</label>
-				</field>
-			</group>
-		</section>
-	</system>
+                </field>
+                <field id="rewrite_maps_generation_cron_schedule" showInDefault="1" sortOrder="510" translate="label"
+                       type="text">
+                    <label>Rewrite Maps Generation Cron Schedule</label>
+                </field>
+            </group>
+        </section>
+    </system>
 </config>

tests/integration/RewriteMapRepositoryTest.php

@@ -6,7 +6,6 @@
 use IntegerNet\RewriteMap\Model\RewriteMapRepository;
 use Magento\Store\Api\StoreRepositoryInterface;
 use Magento\TestFramework\Helper\Bootstrap;
-use Magento\UrlRewrite\Model\OptionProvider;
 use PHPUnit\Framework\TestCase;
 
 /**