we need tests!

Author: lbarulski

AssetsBundle/DependencyInjection/Configuration.php

@@ -16,32 +16,26 @@ class Configuration implements ConfigurationInterface
      */
     public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
-        $rootNode = $treeBuilder->root('docplanner_assets');
+        $treeBuilder = new TreeBuilder;
+        $nodeBuilder = $treeBuilder->root('docplanner_assets')->children();
 
-        $nodeBuilder = $rootNode->children();
-        $this->addBaseNode($nodeBuilder)
-            ->addNode($nodeBuilder, 'style')
-            ->addNode($nodeBuilder, 'script');
-
-        // Here you should define the parameters that are allowed to
-        // configure your bundle. See the documentation linked above for
-        // more information on that topic.
+        $this->addOptions($nodeBuilder)
+              ->addTypes($nodeBuilder);
 
         return $treeBuilder;
     }
 
     /**
      * @param NodeBuilder $node
-     * @param string      $name
      *
      * @return $this
      */
-    public function addNode(NodeBuilder $node, $name)
+    public function addTypes(NodeBuilder $node)
     {
         // @formatter:off
         /** @noinspection PhpUndefinedMethodInspection */
-        $node->arrayNode($name)
+        $node->arrayNode('types')
+                ->prototype('array')
                 ->addDefaultsIfNotSet()
                 ->children()
                     ->arrayNode('assets')
@@ -76,8 +70,9 @@ public function addNode(NodeBuilder $node, $name)
                         ->end()
                     ->end()
                 ->end()
-            ->end();
-            // @formatter:on
+            ->end()
+        ->end();
+        // @formatter:on
 
         return $this;
     }
@@ -87,20 +82,19 @@ public function addNode(NodeBuilder $node, $name)
      *
      * @return $this
      */
-    private function addBaseNode(NodeBuilder $nodeBuilder)
+    private function addOptions(NodeBuilder $nodeBuilder)
     {
         // @formatter:off
         /** @noinspection PhpUndefinedMethodInspection */
-        $nodeBuilder->arrayNode('base')
+        $nodeBuilder->scalarNode('use_revisions')
+                        ->defaultTrue()
+                    ->end()
+                    ->scalarNode('base_host')
                         ->isRequired()
-                        ->children()
-                            ->scalarNode('host')
-                                ->isRequired()
-                            ->end()
-                            ->scalarNode('path')
-                                ->isRequired()
-                            ->end()
-                            ->end();
+                    ->end()
+                    ->scalarNode('base_path')
+                        ->isRequired()
+                    ->end();
         // @formatter:on
 
         return $this;

AssetsBundle/DependencyInjection/DocplannerAssetsExtension.php

@@ -21,18 +21,34 @@ public function load(array $configs, ContainerBuilder $container)
 		$configuration = new Configuration();
 		$config        = $this->processConfiguration($configuration, $configs);
 
-		foreach (['style', 'script'] as $type)
+		foreach ($config['types'] as &$typeConfig)
 		{
-			foreach ($config[$type]['assets'] as $assetName => &$asset)
+			foreach ($typeConfig['assets'] as $assetName => &$asset)
 			{
 				$src = trim($asset['src']);
-				$isNetworkResource = false;
 				if (0 === strpos($src, '//') || false !== filter_var($src, FILTER_VALIDATE_URL))
 				{
-					$isNetworkResource = true;
+					$url = $asset['src'];
+					$path = null;
+				}
+				else
+				{
+					$url = $config['base_host'] . $asset['src'];
+					$path = $config['base_path'] . $asset['src'];
+
+					if (false === file_exists($path))
+					{
+						throw new \RuntimeException(sprintf('File "%s" not found(asset "%s")!', $path, $assetName));
+					}
+
+					if ($config['use_revisions'])
+					{
+						$url .= '?' . crc32(file_get_contents($path));
+					}
 				}
 
-				$asset['remote'] = $isNetworkResource;
+				$asset['url'] = $url;
+				$asset['path'] = $path;
 			}
 		}
 

AssetsBundle/Resources/config/services.yml

@@ -2,6 +2,8 @@ parameters:
     docplanner_assets_bundle.twig.assets.class:           Docplanner\AssetsBundle\Twig\AssetsExtension
     docplanner_assets_bundle.service.assets_loader.class: Docplanner\AssetsBundle\Service\AssetsLoader
     docplanner_assets.service.assets_picker.class:        Docplanner\AssetsBundle\Service\AssetsPicker
+    docplanner_assets.service.assets_repository.class:    Docplanner\AssetsBundle\Service\AssetsRepository
+    docplanner_assets.service.assets_provider.class:      Docplanner\AssetsBundle\Service\AssetsProvider
 
 services:
     docplanner_assets_bundle.twig.assets:
@@ -12,18 +14,16 @@ services:
 
     docplanner_assets_bundle.service.assets_loader:
         class: %docplanner_assets_bundle.service.assets_loader.class%
-        arguments: [ @docplanner_assets.service.assets_picker ]
+        arguments: [ @docplanner_assets.service.assets_provider ]
 
     docplanner_assets.service.assets_picker:
         class: %docplanner_assets.service.assets_picker.class% 
         arguments: [ @request_stack, %docplanner_assets.config% ]
 
     docplanner_assets.service.assets_repository:
-        class: Docplanner\AssetsBundle\Service\AssetsRepository
-        arguments: [ %docplanner_assets.config%, %kernel.cache_dir% ]
+        class: %docplanner_assets.service.assets_repository.class%
+        arguments: [ %docplanner_assets.config% ]
 
-    docplanner_assets.service.revision_warmer:
-        class: Docplanner\AssetsBundle\Service\RevisionWarmer
-        arguments: [ @docplanner_assets.service.assets_repository, %docplanner_assets.config% ]
-        tags:
-            - { name: kernel.cache_warmer }
+    docplanner_assets.service.assets_provider:
+        class: %docplanner_assets.service.assets_provider.class%
+        arguments: [ @docplanner_assets.service.assets_repository, @docplanner_assets.service.assets_picker ]

AssetsBundle/Service/AssetsLoader.php

@@ -2,82 +2,38 @@
 
 namespace Docplanner\AssetsBundle\Service;
 
-use Docplanner\AssetsBundle\IO\Asset;
-
 class AssetsLoader
 {
-
-	/** @var AssetsPicker $assetsPicker */
-	private $asstsPicker;
-
-	/**
-	 * @param AssetsPicker $assetsPicker
-	 */
-	public function __construct(AssetsPicker $assetsPicker)
-	{
-		$this->asstsPicker = $assetsPicker;
-	}
+	/** @var AssetsProvider */
+	private $assetsProvider;
 
 	/**
-	 * @param bool|false $isInline
-	 *
-	 * @return string
+	 * @param AssetsProvider $assetsProvider
 	 */
-	public function renderScript($isInline = false)
+	public function __construct(AssetsProvider $assetsProvider)
 	{
-		$assets = $this->asstsPicker->pickScriptAssets();
-		$mask   = $isInline ? '<script>%s</script>' : '<script src="%s"></script>';
-
-		return $this->render($mask, $assets, $isInline);
+		$this->assetsProvider = $assetsProvider;
 	}
 
 	/**
-	 * @param bool|false $isInline
+	 * @param string $type
+	 * @param bool   $inline
 	 *
-	 * @return string
+	 * @return string[]
 	 */
-	public function renderStyle($isInline = false)
+	public function assets($type, $inline = false)
 	{
-		$assets = $this->asstsPicker->pickStyleAssets();
-		$mask   = $isInline ? '<style>%s</style>' : '<link rel="stylesheet" type="text/css" href="%s">';
-
-		return $this->render($mask, $assets, $isInline);
-	}
-
-	/**
-	 * @param String  $mask
-	 * @param Asset[] $assets
-	 * @param boolean $isInline
-	 *
-	 * @return string
-	 */
-	private function render($mask, $assets, $isInline)
-	{
-		$ret = '';
-
-		if (!$isInline)
+		$result = [];
+		foreach ($this->assetsProvider->getAssets($type) as $assetName => $asset)
 		{
-			foreach ($assets as $asset)
+			if ($inline !== $asset->isInline())
 			{
-				$ret .= sprintf($mask, $asset->getUrl());
-			}
-		}
-		else
-		{
-			foreach ($assets as $asset)
-			{
-				if ($asset->isInline())
-				{
-					$ret .= file_get_contents($asset->getPath() ?: $asset->getUrl());
-				}
+				continue;
 			}
 
-			if ($ret)
-			{
-				$ret = sprintf($mask, $ret);
-			}
+			$result[$assetName] = $inline ? file_get_contents($asset->getPath()) : $asset->getUrl();
 		}
 
-		return $ret;
+		return $result;
 	}
 }

AssetsBundle/Service/AssetsPicker.php

@@ -22,43 +22,32 @@ class AssetsPicker
 	private $config;
 
 	/**
-	 * @param RequestStack $requestStack
-	 * @param array        $config
+	 * @param RequestStack     $requestStack
+	 * @param array            $config
 	 */
 	public function __construct(RequestStack $requestStack, array $config)
 	{
 		$this->requestStack = $requestStack;
 		$this->config       = $config;
 	}
 
-	/**
-	 * @return Asset[]
-	 */
-	public function pickStyleAssets()
-	{
-		return $this->getAssets('style');
-	}
-
-	/**
-	 * @return Asset[]
-	 */
-	public function pickScriptAssets()
-	{
-		return $this->getAssets('script');
-	}
-
 	/**
 	 * @param string $type
 	 *
 	 * @return string[] - asset names
 	 */
-	private function pickAssets($type)
+	public function pickAssets($type)
 	{
+		if (false === array_key_exists($type, $this->config['types']))
+		{
+			throw new \LogicException(sprintf('Type "%s" is not defined!', $type));
+		}
+
 		$route = $this->requestStack->getMasterRequest()->get('_route');
 
 		$defaults = [];
 		$picked = [];
-		foreach ($this->config[$type]['groups'] as $groupName => $group)
+		foreach ($this->config['types'][$type]['groups'] as $groupName => $group)
 		{
 			if (is_array($group['routes']) && in_array($route, $group['routes']))
 			{
@@ -82,27 +71,4 @@ private function pickAssets($type)
 
 		return $picked;
 	}
-
-	/**
-	 * @param string $type
-	 *
-	 * @return Asset[]
-	 */
-	private function getAssets($type)
-	{
-		$assets = [];
-		foreach ($this->pickAssets($type) as $asset)
-		{
-			if (false === array_key_exists($asset, $this->config[$type]['assets']))
-			{
-				throw new \RuntimeException(sprintf('Asset "%s" not found', $asset));
-			}
-
-			$assetConfig = $this->config[$type]['assets'][$asset];
-
-			$assets[] = new Asset($assetConfig['src'], $assetConfig['inline']);
-		}
-
-		return $assets;
-	}
 }

AssetsBundle/Service/AssetsProvider.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Author: Łukasz Barulski
+ * Date: 19.09.15 11:01
+ */
+
+namespace Docplanner\AssetsBundle\Service;
+
+use Docplanner\AssetsBundle\IO\Asset;
+
+class AssetsProvider
+{
+	/** @var AssetsRepository */
+	private $assetsRepository;
+
+	/** @var AssetsPicker */
+	private $assetsPicker;
+
+	/**
+	 * @param AssetsRepository $assetsRepository
+	 * @param AssetsPicker     $assetsPicker
+	 */
+	public function __construct(AssetsRepository $assetsRepository, AssetsPicker $assetsPicker)
+	{
+		$this->assetsRepository = $assetsRepository;
+		$this->assetsPicker     = $assetsPicker;
+	}
+
+	/**
+	 * @param string $type
+	 *
+	 * @return Asset[]
+	 */
+	public function getAssets($type)
+	{
+		$chosenAssets = $this->assetsPicker->pickAssets($type);
+		if ([] === $chosenAssets)
+		{
+			return [];
+		}
+
+		$assets = [];
+		foreach ($chosenAssets as $asset)
+		{
+			$assets[$asset] = $this->assetsRepository->getAsset($type, $asset);
+		}
+
+		return $assets;
+	}
+}