Add support to store xpaths as string (#18)

There was a bug that avoid users to set xpaths as a simple string like '//div'. Now you don't need to use ['//div'] for single xpaths.

Author: joskfg

Diff for: src/Scraper/Application/XpathFinder.php

@@ -7,6 +7,7 @@
 use GuzzleHttp\Exception\RequestException;
 use Illuminate\Support\Facades\Log;
 use Softonic\LaravelIntelligentScraper\Scraper\Exceptions\MissingXpathValueException;
+use Softonic\LaravelIntelligentScraper\Scraper\Models\Configuration;
 
 class XpathFinder
 {
@@ -26,6 +27,12 @@ public function __construct(GoutteClient $client, VariantGenerator $variantGener
         $this->variantGenerator = $variantGenerator;
     }
 
+    /**
+     * @param string          $url
+     * @param Configuration[] $configs
+     *
+     * @return array
+     */
     public function extract(string $url, $configs): array
     {
         $crawler = $this->getCrawler($url);

Diff for: src/Scraper/Listeners/Scrape.php

@@ -3,6 +3,7 @@
 namespace Softonic\LaravelIntelligentScraper\Scraper\Listeners;
 
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Support\Collection;
 use Psr\Log\LoggerInterface;
 use Softonic\LaravelIntelligentScraper\Scraper\Application\XpathFinder;
 use Softonic\LaravelIntelligentScraper\Scraper\Events\InvalidConfiguration;
@@ -52,12 +53,7 @@ public function handle(ScrapeRequest $scrapeRequest)
         }
     }
 
-    /**
-     * @param ScrapeRequest $scrapeRequest
-     *
-     * @return mixed
-     */
-    private function loadConfiguration(ScrapeRequest $scrapeRequest)
+    private function loadConfiguration(ScrapeRequest $scrapeRequest): Collection
     {
         $this->logger->info("Loading scrapping configuration for type '$scrapeRequest->type'");
 
@@ -69,15 +65,11 @@ private function loadConfiguration(ScrapeRequest $scrapeRequest)
         return $config;
     }
 
-    /**
-     * @param ScrapeRequest $scrapeRequest
-     * @param               $config
-     */
-    private function extractData(ScrapeRequest $scrapeRequest, $config): void
+    private function extractData(ScrapeRequest $scrapeRequest, Collection $config): void
     {
         $this->logger->info("Extracting data from $scrapeRequest->url for type '$scrapeRequest->type'");
 
-        list('data' => $data, 'variant' => $variant) = $this->xpathFinder->extract($scrapeRequest->url, $config);
+        ['data' => $data, 'variant' => $variant] = $this->xpathFinder->extract($scrapeRequest->url, $config);
         event(new Scraped($scrapeRequest, $data, $variant));
     }
 }

Diff for: src/Scraper/Listeners/ScrapeFailedListener.php

@@ -2,8 +2,8 @@
 
 namespace Softonic\LaravelIntelligentScraper\Scraper\Listeners;
 
-use Softonic\LaravelIntelligentScraper\Scraper\Events\ScrapeFailed;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Softonic\LaravelIntelligentScraper\Scraper\Events\ScrapeFailed;
 
 class ScrapeFailedListener implements ShouldQueue
 {

Diff for: src/Scraper/Listeners/ScrapedListener.php

@@ -2,8 +2,8 @@
 
 namespace Softonic\LaravelIntelligentScraper\Scraper\Listeners;
 
-use Softonic\LaravelIntelligentScraper\Scraper\Events\Scraped;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Softonic\LaravelIntelligentScraper\Scraper\Events\Scraped;
 
 class ScrapedListener implements ShouldQueue
 {

Diff for: src/Scraper/Models/Configuration.php

@@ -38,6 +38,11 @@ class Configuration extends Model
         'xpaths',
     ];
 
+    public function getXpathsAttribute($xpaths): array
+    {
+        return (array) $this->castAttribute('xpaths', $xpaths);
+    }
+
     public function scopeWithType($query, string $type)
     {
         return $query->where('type', $type);

Diff for: tests/Unit/Scraper/Repositories/ConfigurationTest.php

@@ -121,10 +121,10 @@ public function whenRecalculateItShouldStoreTheNewXpaths()
 
         $this->assertEquals($configs[0]['name'], 'title');
         $this->assertEquals($configs[0]['type'], 'post');
-        $this->assertEquals($configs[0]['xpaths'], '//*[@id="title"]');
+        $this->assertEquals($configs[0]['xpaths'][0], '//*[@id="title"]');
         $this->assertEquals($configs[1]['name'], 'author');
         $this->assertEquals($configs[1]['type'], 'post');
-        $this->assertEquals($configs[1]['xpaths'], '//*[@id="author"]');
+        $this->assertEquals($configs[1]['xpaths'][0], '//*[@id="author"]');
     }
 
     /**