Merge pull request 'Implement a caching mechanism' (#26) from feature/cache into master

Reviewed-on: #26

.env

@@ -0,0 +1,2 @@
+APP_ENV=prod
+APP_DEBUG=false

.gitignore

@@ -1,4 +1,5 @@
 /vendor/
 .idea
-database.sqlite
+*.sqlite
 var/cache/
+.env.local

Dockerfile

@@ -1,13 +1,15 @@
 FROM php:8.3-cli
 
 WORKDIR /usr/src/app
-
+ENV PHP_MEMORY_LIMIT=1500M
+RUN echo "memory_limit=1500M" > /usr/local/etc/php/conf.d/memory-limit.ini
 RUN apt-get update && apt-get install -y \
     git \
     unzip \
+    libicu-dev \
     libzip-dev
 
-RUN docker-php-ext-install zip
+RUN docker-php-ext-install zip intl
 
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 

README.md

@@ -14,12 +14,20 @@
 
 1. Cd into project directory
 2. Run `git pull`
-3. Start and build image in one go with command: `docker compose up -d --build --force-recreate`
+3. Refresh cache on production by removing cache directory: `rm -rf var/cache`
+4. Start and build image in one go with command: `docker compose up -d --build --force-recreate`
+
+## Bonus 
+
+### Install composer package
+
+1. Run `bin/composer require vendor/package-name`
+
 
 ## Running Cron
 
 For now only way of running `app:scrape` command on schedule is to use host crontab.
-1. Run `crontab -e` command to edit host crontab job file
+1. Run `crontab -e` command to edit a host crontab job file
 2. Add a new line with e.g. line like this `0 1 * * * cd /var/project/directory/ && docker compose exec php-app php console.php app:scrape`
 3. Save and exit file editor. Cron will execute `app:scrape` once per day.
 

bin/bash

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+bin/cli bash

bin/cacheclean

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+bin/cli rm -rf var/cache

bin/cli

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+[ -z "$1" ] && echo "Please specify a CLI command (ex. ls)" && exit
+docker compose exec php-app "$@"

bin/composer

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+[ -z "$1" ] && echo "Please specify a Composer command (ex. install)" && exit
+bin/cli composer "$@"

bin/update

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+echo "Updating project"
+git pull origin master
+bin/cli rm -rf var/cache
+echo "Project updated"

composer.json

@@ -1,7 +1,6 @@
 {
     "require": {
         "guzzlehttp/guzzle": "^7.0",
-        "symfony/var-dumper": "^7.0",
         "illuminate/database": "11.26.0.0",
         "ext-json": "*",
         "symfony/console": "^7.0",
@@ -9,11 +8,19 @@
         "laravel/serializable-closure": "^1.3",
         "symfony/http-kernel": "^7.1",
         "symfony/framework-bundle": "^7.1",
-        "symfony/twig-bundle": "^7.1"
+        "symfony/twig-bundle": "^7.1",
+        "symfony/dotenv": "^7.1",
+        "twig/intl-extra": "^3.13",
+        "twig/extra-bundle": "^3.13",
+        "symfony/cache": "^7.2",
+        "twig/cache-extra": "^3.21"
     },
     "autoload": {
         "psr-4": {
             "Krzysiej\\RyobiCrawler\\": "src/"
         }
+    },
+    "require-dev": {
+        "symfony/var-dumper": "^7.1"
     }
 }

console.php

@@ -2,18 +2,16 @@
 
 include_once 'vendor/autoload.php';
 
-use Krzysiej\RyobiCrawler\Command\Migrate;
+use Krzysiej\RyobiCrawler\Kernel;
-use Krzysiej\RyobiCrawler\Command\ScrapeWebsite;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
-
-use Symfony\Component\Console\Application;
 
 if (php_sapi_name() !== 'cli') {
     header('Location: browser.php');
     echo 'Execute this script in cli only';
     exit;
 }
-
+$kernel = new Kernel('dev', true);
-$application = new Application('Ryobi website scraper application', '1.1.1');
+$application = new Application($kernel);
-$application->add(new ScrapeWebsite());
+$application->setName('Ryobi website scraper application');
-$application->add(new Migrate());
+$application->setVersion('1.2.0');
 $application->run();

index.php

@@ -1,44 +1,14 @@
 <?php
 
-use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
+use Krzysiej\RyobiCrawler\Kernel;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Kernel as BaseKernel;
-use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 
 require 'vendor/autoload.php';
 
-class Kernel extends BaseKernel
+(new Dotenv())->bootEnv(__DIR__.'/.env');
-{
-    use MicroKernelTrait;
 
-    public function registerBundles(): iterable
+$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
-    {
-        return [
-            new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
-            new Symfony\Bundle\TwigBundle\TwigBundle()
-        ];
-    }
-
-    protected function configureContainer(ContainerConfigurator $container): void
-    {
-        $container->extension('framework', [
-            'secret' => 'S0ME_SECRET'
-        ]);
-        $container->services()
-            ->load('Krzysiej\\RyobiCrawler\\Controller\\', __DIR__.'/src/Controller/*')
-            ->autowire()
-            ->autoconfigure()
-        ;
-    }
-
-    protected function configureRoutes(RoutingConfigurator $routes): void
-    {
-        $routes->import(__DIR__.'/src/Controller/', 'attribute');
-    }
-}
-
-$kernel = new Kernel('prod', false);
 $request = Request::createFromGlobals();
 $response = $kernel->handle($request);
 $response->send();

index_old.php

@@ -1,48 +0,0 @@
-<?php
-
-include_once 'vendor/autoload.php';
-
-use Krzysiej\RyobiCrawler\Controller\CategoryController;
-use Krzysiej\RyobiCrawler\Controller\IndexController;
-use Krzysiej\RyobiCrawler\Controller\ProductController;
-use Krzysiej\RyobiCrawler\Controller\PromosController;
-use Krzysiej\RyobiCrawler\Controller\SearchController;
-use Krzysiej\RyobiCrawler\Controller\StarController;
-use Symfony\Component\Routing\Matcher\UrlMatcher;
-use Symfony\Component\Routing\RequestContext;
-use Symfony\Component\Routing\Route;
-use Symfony\Component\Routing\RouteCollection;
-
-if (!file_exists('database.sqlite')) {
-    exit('Database file <code>database.sqlite</code> missing. Run docker compose <blockquote>docker compose exec php-app php index.php app:migrate</blockquote> to create it.');
-}
-$productRoute = new Route('/product/{product_id<\d+>}', ['_controller' => ProductController::class]);
-$searchRoute = new Route('/?search={search_term}', ['_controller' => SearchController::class]);
-$categoryRoute = new Route('/category/{category_name}', ['_controller' => CategoryController::class]);
-$starRoute = new Route('/star/{product_id}', ['_controller' => StarController::class]);
-$promosRoute = new Route('/promos', ['_controller' => PromosController::class]);
-$indexRoute = new Route('/', ['_controller' => IndexController::class]);
-$routes = new RouteCollection();
-
-$routes->add('product_show', $productRoute);
-$routes->add('search_show', $searchRoute);
-$routes->add('category_show', $categoryRoute);
-$routes->add('start_show', $starRoute);
-$routes->add('promos_show', $promosRoute);
-$routes->add('index_show', $indexRoute);
-
-$context = new RequestContext();
-$matcher = new UrlMatcher($routes, $context);
-try {
-    $parameters = $matcher->match($_SERVER['REQUEST_URI']);
-} catch (Exception $e) {
-    die($e->getMessage());
-}
-
-match ($parameters['_controller']) {
-    SearchController::class => (new $parameters['_controller']())($parameters['search_term']),
-    CategoryController::class => (new $parameters['_controller']())($parameters['category_name']),
-    ProductController::class, StarController::class => (new $parameters['_controller']())($parameters['product_id']),
-    PromosController::class, IndexController::class => (new $parameters['_controller']())(),
-    default => throw new Exception('Route not found')
-};

src/Command/CacheWarmCommand.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Krzysiej\RyobiCrawler\Command;
+
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\HttpFoundation\Request;
+use Illuminate\Database\Capsule\Manager as Capsule;
+use Krzysiej\RyobiCrawler\Models\Product;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Twig\Environment;
+
+#[AsCommand(name: 'app:cache:warm-twig', description: '')]
+class CacheWarmCommand extends Command
+{
+    public function __construct(
+        private Environment $twig,
+        private RequestStack $requestStack,
+        private FilesystemAdapter $cache,
+    ) {
+        parent::__construct();
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->cache->clear();
+
+        $capsule = new Capsule;
+        $capsule->addConnection([
+            'driver' => 'sqlite',
+            'database' => __DIR__ . '/../../database.sqlite',
+        ]);
+        $capsule->setAsGlobal();
+        $capsule->bootEloquent();
+
+        $progress = new ProgressBar($output);
+        $progress->start();
+        $products = Product::with([
+            'price' => fn($query) => $query->orderBy('created_at', 'desc'),
+            'stock' => fn($query) => $query->orderBy('created_at', 'desc'),
+        ])->get();
+        $progress->setMaxSteps(count($products));
+
+        $request = Request::create('/cache-warm');
+        $this->requestStack->push($request);
+
+        foreach ($products as $product) {
+            $priceList = $product->price()->pluck('price');
+            $stockList = $product->stock()->pluck('stock');
+            $priceDates = $product->price()->pluck('created_at')->map(fn($date) => $date->format('Y-m-d'))->toArray();
+            $stockDates = $product->stock()->pluck('created_at')->map(fn($date) => $date->format('Y-m-d'))->toArray();
+            $this->twig->render('product.html.twig', [
+                'product' => $product,
+                'price_list' => $this->prepareChartData($priceDates, $priceList),
+                'stock_list' => $this->prepareChartData($stockDates, $stockList),
+                'price_dates' => implode("','", $priceDates),
+            ]);
+            $progress->advance();
+        }
+
+        $progress->finish();
+        $output->writeln('');
+        $output->writeln('DONE');
+
+        return Command::SUCCESS;
+    }
+
+    private function prepareChartData($set1, $set2): string
+    {
+        $data = [];
+        foreach ($set1 as $key => $value) {
+            $data[] = ['x' => $value, 'y' => $set2[$key]];
+        }
+        $stringData = json_encode($data);
+
+        return str_replace(['"x"', '"y"'], ['x', 'y'], $stringData);
+    }
+}

src/Command/Migrate.php

@@ -51,7 +51,6 @@ class Migrate extends Command
                 $table->string('name');
                 $table->integer('skuID')->unique();
                 $table->integer('availableQuantity');
-                $table->integer('stock');
                 $table->json('categories');
                 $table->string('image');
                 $table->string('subTitle');

src/Command/ScrapeWebsite.php

@@ -40,7 +40,6 @@ class ScrapeWebsite extends Command
         $products = $this->getProducts();
         $progress->setMaxSteps(count($products));
         foreach ($products as $product) {
-            //dd($product);
             $this->saveProduct($product);
             $progress->advance();
         }
@@ -69,7 +68,7 @@ class ScrapeWebsite extends Command
                 $products = array_merge($products, $responseObject->products);
                 $page++;
                 $canLoadMore = $responseObject->canLoadMore;
-            } catch (GuzzleException $e) {
+            } catch (GuzzleException) {
                 return $products;
             }
         } while ($canLoadMore);
@@ -81,18 +80,17 @@ class ScrapeWebsite extends Command
     {
         /** @var Product $productModel */
         $productModel = Product::firstOrNew(['skuID' => $product->skuID]);
-        //dd($productModel);
 
         $productModel->skuID = $product->skuID;
         $productModel->name = $product->name;
         $productModel->availableQuantity = $product->availableQuantity;
-        $productModel->stock = $product->stock;
         $productModel->categories = $product->categories;
         $productModel->image = $product->image;
         $productModel->subTitle = $product->subTitle;
         $productModel->variantCode = $product->variantCode;
         $productModel->modelCode = $product->modelCode;
         $productModel->url = $product->url;
+        $productModel->touch('updated_at');
         $productModel->save();
         $priceExists = $productModel->price()->whereRaw("strftime('%Y-%m-%d', created_at) = ?", [date('Y-m-d')])->exists();
 

src/Controller/BaseController.php

@@ -3,6 +3,7 @@
 namespace Krzysiej\RyobiCrawler\Controller;
 
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Twig\Environment;
 use Illuminate\Database\Capsule\Manager as Capsule;
 
@@ -10,7 +11,7 @@ class BaseController extends AbstractController
 {
     protected Environment $twig;
 
-    public function __construct()
+    public function __construct(protected FilesystemAdapter $cache)
     {
         $capsule = new Capsule;
         $capsule->addConnection(['driver' => 'sqlite', 'database' => __DIR__ . '/../../database.sqlite']);

src/Controller/CategoryController.php

@@ -11,13 +11,19 @@ final class CategoryController extends BaseController
     #[Route('/category/{category}', name: 'app_category')]
     public function __invoke(string $category): Response
     {
+        if($this->cache->getItem('list_category_'.$category)->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'category_'.$category]);
+        }
+
         $products = Product::with('price')
             ->selectRaw('products.*')
+            ->distinct('products.id')
             ->fromRaw('products, json_each(products.categories)')
             ->whereRaw('json_each.value = ?', [$category])
             ->orderByDesc('starred')
             ->orderByDesc('created_by')
             ->get();
-        return $this->render('productList.html.twig', ['products' => $products]);
+
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'category_'.$category]);
     }
 }

src/Controller/DiscontinuedController.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Krzysiej\RyobiCrawler\Controller;
+
+use Krzysiej\RyobiCrawler\Models\Product;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+use function Symfony\Component\Clock\now;
+
+final class DiscontinuedController extends BaseController
+{
+    #[Route('/discontinued', name: 'app_discontinued')]
+    public function __invoke(): Response
+    {
+        if($this->cache->getItem('list_discontinued')->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'discontinued']);
+        }
+
+        $products = Product::where('updated_at', '<', now()->format('Y-m-d'))
+            ->orderByDesc('starred')
+            ->orderByDesc('created_by')
+            ->with(['currentPrice'])
+            ->get();
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'discontinued']);
+    }
+}

src/Controller/IndexController.php

@@ -11,7 +11,14 @@ final class IndexController extends BaseController
     #[Route('/', name: 'app_home')]
     public function __invoke(): Response
     {
-        $products = Product::with('price')->orderByDesc('starred')->orderByDesc('created_by')->get();
+        if($this->cache->getItem('list_all')->isHit()) {
-        return $this->render('productList.html.twig', ['products' => $products]);
+            return $this->render('productList.html.twig', ['listType' => 'all']);
+        }
+        $products = Product::with(['currentStock', 'price'])
+            ->orderByDesc('starred')
+            ->orderByDesc('created_by')
+            ->get();
+
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'all']);
     }
 }

src/Controller/NewController.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Krzysiej\RyobiCrawler\Controller;
+
+use Illuminate\Database\Eloquent\Builder;
+use Krzysiej\RyobiCrawler\Models\Product;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+use function Symfony\Component\Clock\now;
+
+final class NewController extends BaseController
+{
+    #[Route('/new', name: 'app_new')]
+    public function __invoke(): Response
+    {
+        if($this->cache->getItem('list_new')->isHit()) {
+            return $this->render('productList.html.twig', ['listType' => 'new']);
+        }
+
+        $products = Product::where('created_at', '>', now()->modify('-30 days')->format('Y-m-d'))
+            ->orderByDesc('starred')
+            ->orderByDesc('created_by')
+            ->with(['currentPrice'])
+            ->get();
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'new']);
+    }
+}

src/Controller/ProductController.php

@@ -2,8 +2,8 @@
 
 namespace Krzysiej\RyobiCrawler\Controller;
 
-use Illuminate\Support\ItemNotFoundException;
 use Krzysiej\RyobiCrawler\Models\Product;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 use Twig\Error\LoaderError;
@@ -20,16 +20,37 @@ final class ProductController extends BaseController
     #[Route('/product/{productId<\d+>}', name: 'app_product')]
     public function __invoke(int $productId): Response
     {
-        $product = Product::with([
+        if($this->cache->getItem('product'.$productId)->isHit()) {
-            'price' => fn($query) => $query->orderBy('created_at', 'desc')
+            return $this->render('product.html.twig', ['product' => ['id' => $productId]]);
-        ])->find($productId);
-
-        if(null === $product) {
-            throw $this->createNotFoundException('Product not found');
         }
 
-        $priceList = $product->price()->pluck('price')->implode(',');
+        $product = Product::with([
-        $priceDates = $product->price()->pluck('created_at')->map(fn($date) => $date->format('Y-m-d'))->implode("','");
+            'price' => fn($query) => $query->orderBy('created_at', 'desc'),
-        return $this->render('product.html.twig', ['product' => $product, 'price_list' => $priceList, 'price_dates' => $priceDates]);
+            'stock' => fn($query) => $query->orderBy('created_at', 'desc'),
+        ])->find($productId);
+        if (null === $product) {
+            throw $this->createNotFoundException('Product not found');
+        }
+        $priceList = $product->price()->pluck('price');
+        $stockList = $product->stock()->pluck('stock');
+        $priceDates = $product->price()->pluck('created_at')->map(fn($date) => $date->format('Y-m-d'))->toArray();
+        $stockDates = $product->stock()->pluck('created_at')->map(fn($date) => $date->format('Y-m-d'))->toArray();
+
+        return $this->render('product.html.twig', [
+            'product' => $product,
+            'price_list' => $this->prepareChartData($priceDates, $priceList),
+            'stock_list' => $this->prepareChartData($stockDates, $stockList),
+            'price_dates' => implode("','", $priceDates),
+        ]);
+    }
+
+    private function prepareChartData($set1, $set2): string
+    {
+        $data = [];
+        foreach ($set1 as $key => $value) {
+            $data[] = ['x' => $value, 'y' => $set2[$key]];
+        }
+        $stringData = json_encode($data);
+        return str_replace(['"x"', '"y"'], ['x', 'y'], $stringData);
     }
 }

src/Controller/PromosController.php

@@ -12,7 +12,15 @@ final class PromosController extends BaseController
     #[Route('/promos', name: 'app_promos')]
     public function __invoke(): Response
     {
-        $products = Product::whereHas('currentPrice', fn(Builder $query) => $query->whereColumn('price', '<', 'productStandardPrice'))->with(['currentPrice'])->get();
+        if($this->cache->getItem('list_promos')->isHit()) {
-        return $this->render('productList.html.twig', ['products' => $products]);
+            return $this->render('productList.html.twig', ['listType' => 'promos']);
+        }
+
+        $products = Product::whereHas('currentPrice', fn(Builder $query) => $query->whereColumn('price', '<', 'productStandardPrice'))
+            ->orderByDesc('starred')
+            ->orderByDesc('created_by')
+            ->with(['currentPrice'])
+            ->get();
+        return $this->render('productList.html.twig', ['products' => $products, 'listType' => 'promos']);
     }
 }

src/Controller/SearchController.php

@@ -13,7 +13,6 @@ final class SearchController extends BaseController
     public function __invoke(Request $request): Response
     {
         $search = $request->query->get('search');
-        //dd();
         $products = Product::with('price')
             ->orWhere([['name', 'like', "%$search%"]])
             ->orWhere([['subTitle', 'like', "%$search%"]])->get();

src/Kernel.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Krzysiej\RyobiCrawler;
+
+use Krzysiej\RyobiCrawler\Twig\AppExtension;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
+use Symfony\Bundle\TwigBundle\TwigBundle;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpKernel\Kernel as BaseKernel;
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+use Twig\Extra\Cache\CacheExtension;
+use Twig\Extra\Cache\CacheRuntime;
+use Twig\Extra\TwigExtraBundle\TwigExtraBundle;
+
+class Kernel extends BaseKernel
+{
+    use MicroKernelTrait;
+
+    public function registerBundles(): iterable
+    {
+        return [
+            new FrameworkBundle(),
+            new TwigBundle(),
+            new TwigExtraBundle(),
+        ];
+    }
+
+    protected function configureContainer(ContainerConfigurator $container): void
+    {
+        $container->extension('framework', [
+            'secret' => 'S0ME_SECRET'
+        ]);
+        $services = $container->services()->defaults()->autowire()->autoconfigure();
+        $services->load('Krzysiej\\RyobiCrawler\\Controller\\', __DIR__ . '/Controller/*');
+        $services->load('Krzysiej\\RyobiCrawler\\Command\\', __DIR__ . '/Command/*')->tag('console.command');
+        $services->set('twig.extension.cache', AppExtension::class)->tag('twig.extension');
+        $services->set(CacheExtension::class)->tag('twig.extension');
+        $services->set(FilesystemAdapter::class)->args([
+                '',      // namespace
+                0,       // default lifetime
+                __DIR__ . '/../var/cache/twig_blocks'  // custom path
+            ]);
+        $services->set('twig.runtime.cache', CacheRuntime::class)->args([new Reference(FilesystemAdapter::class)])->tag('twig.runtime');
+    }
+
+    protected function configureRoutes(RoutingConfigurator $routes): void
+    {
+        $routes->import(__DIR__ . '/Controller/', 'attribute');
+    }
+}

src/Models/Product.php

@@ -7,11 +7,12 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 
+use function Symfony\Component\Clock\now;
+
 /**
  * @property integer $skuID
  * @property string $name
  * @property integer $availableQuantity
- * @property integer $stock
  * @property string[] $categories
  * @property string $image
  * @property string $subTitle
@@ -32,7 +33,7 @@ class Product extends Model
 
     public function isStarred(): bool
     {
-        return (bool) $this->starred;
+        return (bool)$this->starred;
     }
 
     public function currentPrice(): HasOne
@@ -45,6 +46,13 @@ class Product extends Model
         return $this->hasMany(Stock::class);
     }
 
+    public function currentStock(): HasOne
+    {
+        return $this->stock()->one()->ofMany()->withDefault(function (Stock $stock) {
+            $stock->stock = 0;
+        });
+    }
+
     public function toggleStarred(): self
     {
         $this->starred = !$this->starred;
@@ -59,4 +67,13 @@ class Product extends Model
             set: fn(array $value) => json_encode($value),
         );
     }
+
+    public function isDiscontinued(): bool
+    {
+        return $this->updated_at->format('Y-m-d') < now()->format('Y-m-d');
+    }
+    public function isNew(): bool
+    {
+        return $this->created_at->format('Y-m-d') > now()->modify('-30 days')->format('Y-m-d');
+    }
 }

src/Twig/AppExtension.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Krzysiej\RyobiCrawler\Twig;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Krzysiej\RyobiCrawler\Models\Price;
+use Krzysiej\RyobiCrawler\Models\Product;
+use Krzysiej\RyobiCrawler\Models\Stock;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFilter;
+use Twig\TwigFunction;
+
+use function Symfony\Component\Clock\now;
+
+class AppExtension extends AbstractExtension
+{
+    public function getFunctions(): array
+    {
+        return [
+            new TwigFunction('promosCount', [$this, 'promosCount']),
+            new TwigFunction('allCount', [$this, 'allCount']),
+            new TwigFunction('newCount', [$this, 'newCount']),
+            new TwigFunction('discontinuedCount', [$this, 'discontinuedCount']),
+        ];
+    }
+
+    public function getFilters(): array
+    {
+        return [
+            new TwigFilter('findByCreatedAtDate', [$this, 'findByCreatedAtDate']),
+        ];
+    }
+    public function allCount(): int
+    {
+        return Product::count();
+    }
+
+    public function promosCount(): int
+    {
+        return Product::whereHas('currentPrice', fn(Builder $query) => $query->whereColumn('price', '<', 'productStandardPrice'))->count();
+    }
+
+    public function newCount(): int
+    {
+        return Product::where('created_at', '>', now()->modify('-30 days')->format('Y-m-d'))->count();
+    }
+
+    public function discontinuedCount(): int
+    {
+        return Product::where('updated_at', '<', now()->format('Y-m-d'))->count();
+    }
+
+    public function findByCreatedAtDate(Collection $items, string $date): Stock|Price|null
+    {
+        return $items->first(fn($item) => str_starts_with($item->created_at, $date));
+    }
+}

templates/js/script.js

@@ -0,0 +1,4 @@
+(function() {
+    const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
+    const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl))
+})();

templates/product.html.twig

@@ -1,74 +1,90 @@
 {% extends "template.html.twig" %}
 
 {% block content %}
-    <table class='table table-hover'>
+{% cache 'product' ~ product.id %}
-        <tr>
+    <div class="table-responsive">
-            <td class="align-middle font-weight-bold h3"><a class="text-warning text-decoration-none"
+        <table class='table table-hover'>
-                                                            href="{{ path('app_star', {'productId': product.id}) }}">{% if product.starred %}★{% else %} ☆ {% endif %}</a></td>
+            <tr>
-            <td><img src='{{ product.image }}&width=150' class='border rounded p-1' alt='{{ product.name }}'/></td>
+                <td class="align-middle font-weight-bold h3"><a class="text-warning text-decoration-none"
-            <td><a href='{{ path('app_home') }}/product/{{ product.id }}' class="text-decoration-none">{{ product.name }}</a></td>
+                                                                href="{{ path('app_star', {'productId': product.id}) }}">{% if product.starred %}★{% else %} ☆ {% endif %}</a></td>
-            <td>{{ product.subTitle }}</td>
+                <td><img src='{{ product.image }}&width=150' class='border rounded p-1' alt='{{ product.name }}'/></td>
-            <td>
+                <td>
-                <ul class='nav'>
+                    <a href='{{ path('app_product', {'productId': product.id}) }}' class="text-decoration-none">{{ product.name }}</a>
-                    {% for category in product.categories %}
+                    <span class="badge text-bg-light">{{ product.subTitle }}</span>
-                        <li class="nav-item"><a class="nav-link" href="{{ path('app_category', {'category': category}) }}"> {{ category }} </a></li>
+                </td>
-                    {% endfor %}
+                <td>
-                </ul>
+                    <nav aria-label="breadcrumb" style="--bs-breadcrumb-divider: '>';">
-            </td>
+                        <ol class="breadcrumb">
-            <td><a href='https://pl.ryobitools.eu/{{ product.url }}'>link</a></td>
+                            {% for category in product.categories %}
-        </tr>
+                                <li class="breadcrumb-item" aria-current="page"><a class="breadcrumb-item text-decoration-none"
-        <tr>
+                                                                                   href="{{ path('app_category', {'category': category}) }}">{{ category }}</a></li>
-            <td colspan="4">
+                            {% endfor %}
-                <div style="width: 800px;">
+                        </ol>
-                    <canvas id="price"></canvas>
+                    </nav>
-                </div>
+                </td>
-            </td>
+                <td><a href='https://pl.ryobitools.eu/{{ product.url }}'>link</a></td>
-        </tr>
+            </tr>
-        <tr>
+            <tr>
-            <td colspan="4">
+                <td colspan="5">
-                <table class='table table-hover table-sm mb-0'>
+                    <div style="width: 800px;">
-                    <thead>
+                        <canvas id="price"></canvas>
-                    <tr>
+                    </div>
-                        <th>price</th>
+                </td>
-                        <th>lowest product price in 30 days</th>
+            </tr>
-                        <th colspan='2'>standard price</th>
+            <tr>
-                    </tr>
+                <td colspan="5">
-                    </thead>
+                    <table class='table table-hover table-sm mb-0'>
-                    {% for price in product.price %}
+                        <thead>
                         <tr>
-                            <td>{{ price.price }}</td>
+                            <th>price</th>
-                            <td>{{ price.lowestProductPrice30Days }}</td>
+                            <th>lowest product price in 30 days</th>
-                            <td>{{ price.productStandardPrice }}</td>
+                            <th colspan='2'>standard price</th>
-                            <td>{{ price.created_at }}</td>
+                            <th>Stock</th>
                         </tr>
-                    {% endfor %}
+                        </thead>
-                </table>
+                        {% for price in product.price %}
-            </td>
+                            <tr>
-        </tr>
+                                <td>{{ price.price | format_currency('PLN', {}, 'pl') }}</td>
-    </table>
+                                <td>{{ price.lowestProductPrice30Days | format_currency('PLN', {}, 'pl') }}</td>
+                                <td>{{ price.productStandardPrice | format_currency('PLN', {}, 'pl') }}</td>
+                                <td>{{ price.created_at }}</td>
+                                <td>{{ (product.stock | findByCreatedAtDate(price.created_at | slice(0,10))).stock ?? '' }}</td>
+                            </tr>
+                        {% endfor %}
+                    </table>
+                </td>
+            </tr>
+        </table>
+    </div>
     <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
 
     <script>
-        const ctx = document.getElementById('price');
+        const ctx = document.getElementById('price').getContext('2d');
 
         new Chart(ctx, {
             type: 'line',
             data: {
                 labels: ['{{ price_dates|raw }}'],
-                datasets: [{
+                datasets: [
-                    label: 'Price (PLN)',
+                    {
-                    data: [{{ price_list }}],
+                        label: 'Price (PLN)',
-                    borderWidth: 1
+                        data: {{ price_list|raw }},
-                }]
+                        yAxisID: 'yPrice',
+                        tension: 0.1,
+                        borderWidth: 1
+                    },
+                    {
+                        label: 'Stock (units)',
+                        data: {{ stock_list|raw }},
+                        yAxisID: 'yStock',
+                        tension: 0.1,
+                        borderWidth: 1
+                    }
+                ]
             },
             options: {
+                responsive: true,
                 animation: false,
-                plugins: {
-                    title: {
-                        display: true,
-                        text: 'Price in time'
-                    },
-                },
                 scales: {
                     x: {
                         title: {
@@ -76,16 +92,44 @@
                             text: 'Date'
                         }
                     },
-                    y: {
+                    yPrice: {
+                        type: 'linear',
+                        position: 'left',
                         beginAtZero: true,
                         title: {
                             display: true,
-                            text: 'Price'
+                            text: 'Price (PLN)'
+                        },
+                        grid: {
+                            drawOnChartArea: false
+                        }
+                    },
+                    yStock: {
+                        type: 'linear',
+                        position: 'right',
+                        beginAtZero: true,
+                        title: {
+                            display: true,
+                            text: 'Stock (units)'
+                        },
+                        grid: {
+                            drawOnChartArea: false
                         }
                     }
+                },
+                plugins: {
+                    legend: {
+                        display: true,
+                        position: 'top'
+                    },
+                    title: {
+                        display: true,
+                        text: 'Price and Stock in time'
+                    },
                 }
             }
         });
     </script>
+{% endcache %}
 {% endblock %}
 

templates/productList.html.twig

@@ -1,35 +1,62 @@
 {% extends "template.html.twig" %}
 
 {% block content %}
+{% cache 'list_' ~ listType %}
+<div class="table-responsive">
     <table class='table table-hover'>
         <thead>
         <tr>
             <th></th>
             <th></th>
             <th>Name</th>
-            <th>Code</th>
             <th>Categories</th>
             <th></th>
             <th>Price</th>
+            <th></th>
         </tr>
         </thead>
         {% for product in products %}
             <tr>
-                <td class="align-middle font-weight-bold h3"><a class="text-warning text-decoration-none" href="{{ path('app_star', {'productId': product.id}) }}">{% if product.starred == true %}★{% else %} ☆ {% endif %}</a></td>
+                <td class="align-middle font-weight-bold h3"><a class="text-warning text-decoration-none"
-                <td class="align-middle" style="width: 120px;"><img src='{{ product.image }}&width=70' class='border rounded p-1' alt='{{ product.name }}'/></td>
+                                                                href="{{ path('app_star', {'productId': product.id}) }}">{% if product.starred == true %}★{% else %} ☆ {% endif %}</a></td>
-                <td class="align-middle"><a href='{{ path('app_product', {'productId': product.id}) }}' class="text-decoration-none">{{ product.name }}</a></td>
+                <td class="align-middle" style="width: 120px;"><img src='{{ product.image }}&width=70' class='img-thumbnail' alt='{{ product.name }}'/></td>
-                <td class="align-middle">{{ product.subTitle }}</td>
                 <td class="align-middle">
-                    <ul class='nav'>
+                    <a href='{{ path('app_product', {'productId': product.id}) }}' class="text-decoration-none">{{ product.name }}</a>
-                        {% for category in product.categories %}
+                    {% if product.currentStock.stock > 0 %}
-                            <li class="nav-item"><a class="nav-link" href="{{ path('app_category', {'category': category}) }}"> {{ category }} </a></li>
+                        <span class="badge text-bg-light">stock: {{ product.currentStock.stock }}</span>
-                        {% endfor %}
+                    {% else %}
-                    </ul>
+                        <span class="badge text-bg-warning">out of stock</span>
+                    {% endif %}
+                    {% if product.isDiscontinued() %}
+                        <span class="badge text-bg-secondary"  data-bs-toggle="tooltip" data-bs-title="Last update: {{ product.updated_at }}">is discontinued</span>
+                    {% endif %}
+                    {% if product.isNew() %}
+                        <span class="badge text-bg-success">is new</span>
+                    {% endif %}
+                    <span class="badge text-bg-light">{{ product.subTitle }}</span>
+                </td>
+                <td class="align-middle">
+                    <nav aria-label="breadcrumb" style="--bs-breadcrumb-divider: '>';" >
+                        <ol class="breadcrumb">
+                            {% for category in product.categories %}
+                                <li class="breadcrumb-item" aria-current="page"><a class="breadcrumb-item text-decoration-none"  href="{{ path('app_category', {'category': category}) }}">{{ category }}</a></li>
+                            {%  endfor %}
+                        </ol>
+                    </nav>
                 </td>
                 <td class="align-middle"><a href='https://pl.ryobitools.eu/{{ product.url }}'>link</a></td>
-                <td class="align-middle">{{ product.price.last.price }}</td>
+                <td class="align-middle">{{ product.price.last.price | format_currency('PLN', {}, 'pl') }}</td>
-                <td class="align-middle">{% if product.price.last.price != product.price.last.productStandardPrice %}<span class="text-decoration-line-through text-warning">{{ product.price.last.productStandardPrice }}</span> <span class="text-success">{{ ((1 - product.price.last.price / product.price.last.productStandardPrice)*100)|number_format(0) }}%</span>{% else %}{% endif %}</td>
+                <td class="align-middle">
+                    <div class="d-flex flex-row">
+                        {% if product.price.last.price != product.price.last.productStandardPrice %}<span
+                                class="badge text-bg-warning text-decoration-line-through flex-fill">{{ product.price.last.productStandardPrice | format_currency('PLN', {}, 'pl') }}</span>&nbsp;<span
+                                class="badge text-bg-success flex-fill">{{ ((1 - product.price.last.price / product.price.last.productStandardPrice)*100)|number_format(0) }}%</span>
+                        {% endif %}
+                    </div>
+                </td>
             </tr>
         {% endfor %}
     </table>
+</div>
+{% endcache %}
 {% endblock %}

templates/template.html.twig

@@ -5,8 +5,8 @@
     <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
     <meta http-equiv="X-UA-Compatible" content="ie=edge">
     <title>Ryobi crawler</title>
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
+    <link href="/templates/css/bootstrap.min.css" rel="stylesheet" />
-          crossorigin="anonymous"/>
+    <script src="/templates/js/script.js" defer></script>
 </head>
 <body>
 <nav class="navbar navbar-expand-lg sticky-top bg-body-tertiary border-bottom border-secondary border-1">
@@ -17,20 +17,35 @@
             <span class="navbar-toggler-icon"></span>
         </button>
         <div class="collapse navbar-collapse" id="navbarNav">
-            <ul class="navbar-nav">
+            <ul class="navbar-nav me-auto mb-2 mb-lg-0">
-                <li class="nav-item">
+                {% cache "menu_count" %}
-                    <a class="nav-link active" aria-current="page" href="{{ path('app_promos') }}">Promos</a>
+                    <li class="nav-item">
-                </li>
+                        <a class="nav-link {% if app.request.pathinfo == path('app_home') %}active shadow-sm bg-body rounded{% endif %}" aria-current="page" href="{{ path('app_home') }}">All products <span class="badge text-bg-secondary">{{ allCount() }}</span></a>
+                    </li>
+                    <li class="nav-item">
+                        <a class="nav-link {% if app.request.pathinfo == path('app_promos') %}active shadow-sm bg-body rounded{% endif %}" aria-current="page" href="{{ path('app_promos') }}">Promos <span class="badge text-bg-secondary">{{ promosCount() }}</span></a>
+                    </li>
+                    <li class="nav-item">
+                        <a class="nav-link {% if app.request.pathinfo == path('app_new') %}active shadow-sm bg-body rounded{% endif %}" aria-current="page" href="{{ path('app_new') }}">New in last 30 days <span class="badge text-bg-secondary">{{ newCount() }}</span></a>
+                    </li>
+                    <li class="nav-item">
+                        <a class="nav-link {% if app.request.pathinfo == path('app_discontinued') %}active shadow-sm bg-body rounded{% endif %}" aria-current="page" href="{{ path('app_discontinued') }}">Discontinued <span class="badge text-bg-secondary">{{ discontinuedCount() }}</span></a>
+                    </li>
+                {% endcache %}
             </ul>
+
+            <form class="form-floating d-flex col-lg-6 col-sm-8" role="search" action="{{ path('app_search') }}">
+                <input class="form-control me-2 form-control-sm" type="search" id="floatingInputValue" name="search" placeholder="Search term eg. 36v or RCS18X" value="{{ search|default('') }}">
+                <button class="btn btn-outline-success" type="submit">Search</button>
+                <label for="floatingInputValue">Search term eg. 36v or RCS18X</label>
+            </form>
         </div>
     </div>
 
-    <form class="d-flex w-50" role="search" action="{{ path('app_search') }}">
-        <input class="form-control me-2" type="search" name="search" placeholder="Search term eg. 36v or RCS18X" value="{{ search|default('') }}" aria-label="Search">
-        <button class="btn btn-outline-success" type="submit">Search</button>
-    </form>
 </nav>
 {% block content %}{% endblock %}
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
+
 </body>
 </html>