OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-12-22 15:13:59 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added new crawlable flag to Short URLs

Browse Source
This commit is contained in:
Alejandro Celaya 2021-05-22 07:35:47 +02:00
parent 2e6b3c0561
commit 348e34d52e
10 changed files with 74 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
data/migrations/Version20210522051601.php Normal file
View File

@ -0,0 +1,26 @@
<?php
declare(strict_types=1);
namespace ShlinkMigrations;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\DBAL\Types\Types;
use Doctrine\Migrations\AbstractMigration;
final class Version20210522051601 extends AbstractMigration
{
public function up(Schema $schema): void
{
$shortUrls = $schema->getTable('short_urls');
$this->skipIf($shortUrls->hasColumn('crawlable'));
$shortUrls->addColumn('crawlable', Types::BOOLEAN, ['default' => false]);
}
public function down(Schema $schema): void
{
$shortUrls = $schema->getTable('short_urls');
$this->skipIf(! $shortUrls->hasColumn('crawlable'));
$shortUrls->dropColumn('crawlable');
}
}

5
module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.ShortUrl.php
View File

@ -95,4 +95,9 @@ return static function (ClassMetadata $metadata, array $emConfig): void {
->columnName('title_was_auto_resolved')
->option('default', false)
->build();
$builder->createField('crawlable', Types::BOOLEAN)
->columnName('crawlable')
->option('default', false)
->build();
};

10
module/Core/src/Entity/ShortUrl.php
View File

@ -42,6 +42,7 @@ class ShortUrl extends AbstractEntity
private ?ApiKey $authorApiKey = null;
private ?string $title = null;
private bool $titleWasAutoResolved = false;
private bool $crawlable = false;
private function __construct()
{
@ -78,6 +79,7 @@ class ShortUrl extends AbstractEntity
$instance->authorApiKey = $meta->getApiKey();
$instance->title = $meta->getTitle();
$instance->titleWasAutoResolved = $meta->titleWasAutoResolved();
$instance->crawlable = $meta->isCrawlable();
return $instance;
}
@ -200,6 +202,11 @@ class ShortUrl extends AbstractEntity
return $this->title;
}
public function crawlable(): bool
{
return $this->crawlable;
}
public function update(
ShortUrlEdit $shortUrlEdit,
?ShortUrlRelationResolverInterface $relationResolver = null
@ -220,6 +227,9 @@ class ShortUrl extends AbstractEntity
$relationResolver = $relationResolver ?? new SimpleShortUrlRelationResolver();
$this->tags = $relationResolver->resolveTags($shortUrlEdit->tags());
}
if ($shortUrlEdit->crawlableWasProvided()) {
$this->crawlable = $shortUrlEdit->crawlable();
}
if (
$this->title === null
|| $shortUrlEdit->titleWasProvided()

14
module/Core/src/Model/ShortUrlEdit.php
View File

@ -30,6 +30,8 @@ final class ShortUrlEdit implements TitleResolutionModelInterface
private ?string $title = null;
private bool $titleWasAutoResolved = false;
private ?bool $validateUrl = null;
private bool $crawlablePropWasProvided = false;
private bool $crawlable = false;
private function __construct()
{
@ -61,6 +63,7 @@ final class ShortUrlEdit implements TitleResolutionModelInterface
$this->maxVisitsPropWasProvided = array_key_exists(ShortUrlInputFilter::MAX_VISITS, $data);
$this->tagsPropWasProvided = array_key_exists(ShortUrlInputFilter::TAGS, $data);
$this->titlePropWasProvided = array_key_exists(ShortUrlInputFilter::TITLE, $data);
$this->crawlablePropWasProvided = array_key_exists(ShortUrlInputFilter::CRAWLABLE, $data);
$this->longUrl = $inputFilter->getValue(ShortUrlInputFilter::LONG_URL);
$this->validSince = parseDateField($inputFilter->getValue(ShortUrlInputFilter::VALID_SINCE));
@ -69,6 +72,7 @@ final class ShortUrlEdit implements TitleResolutionModelInterface
$this->validateUrl = getOptionalBoolFromInputFilter($inputFilter, ShortUrlInputFilter::VALIDATE_URL);
$this->tags = $inputFilter->getValue(ShortUrlInputFilter::TAGS);
$this->title = $inputFilter->getValue(ShortUrlInputFilter::TITLE);
$this->crawlable = $inputFilter->getValue(ShortUrlInputFilter::CRAWLABLE);
}
public function longUrl(): ?string
@ -162,4 +166,14 @@ final class ShortUrlEdit implements TitleResolutionModelInterface
{
return $this->validateUrl;
}
public function crawlable(): bool
{
return $this->crawlable;
}
public function crawlableWasProvided(): bool
{
return $this->crawlablePropWasProvided;
}
}

7
module/Core/src/Model/ShortUrlMeta.php
View File

@ -31,6 +31,7 @@ final class ShortUrlMeta implements TitleResolutionModelInterface
private array $tags = [];
private ?string $title = null;
private bool $titleWasAutoResolved = false;
private bool $crawlable = false;
private function __construct()
{
@ -80,6 +81,7 @@ final class ShortUrlMeta implements TitleResolutionModelInterface
$this->apiKey = $inputFilter->getValue(ShortUrlInputFilter::API_KEY);
$this->tags = $inputFilter->getValue(ShortUrlInputFilter::TAGS);
$this->title = $inputFilter->getValue(ShortUrlInputFilter::TITLE);
$this->crawlable = $inputFilter->getValue(ShortUrlInputFilter::CRAWLABLE);
}
public function getLongUrl(): string
@ -188,4 +190,9 @@ final class ShortUrlMeta implements TitleResolutionModelInterface
return $copy;
}
public function isCrawlable(): bool
{
return $this->crawlable;
}
}

1
module/Core/src/ShortUrl/Transformer/ShortUrlDataTransformer.php
View File

@ -35,6 +35,7 @@ class ShortUrlDataTransformer implements DataTransformerInterface
'meta' => $this->buildMeta($shortUrl),
'domain' => $shortUrl->getDomain(),
'title' => $shortUrl->title(),
'crawlable' => $shortUrl->crawlable(),
];
}

3
module/Core/src/Validation/ShortUrlInputFilter.php
View File

@ -32,6 +32,7 @@ class ShortUrlInputFilter extends InputFilter
public const API_KEY = 'apiKey';
public const TAGS = 'tags';
public const TITLE = 'title';
public const CRAWLABLE = 'crawlable';
private function __construct(array $data, bool $requireLongUrl)
{
@ -105,5 +106,7 @@ class ShortUrlInputFilter extends InputFilter
$this->add($this->createTagsInput(self::TAGS, false));
$this->add($this->createInput(self::TITLE, false));
$this->add($this->createBooleanInput(self::CRAWLABLE, false));
}
}

1
module/Core/test/Mercure/MercureUpdatesGeneratorTest.php
View File

@ -59,6 +59,7 @@ class MercureUpdatesGeneratorTest extends TestCase
],
'domain' => null,
'title' => $title,
'crawlable' => false,
],
'visit' => [
'referer' => '',

6
module/Rest/test-api/Action/ListShortUrlsTest.php
View File

@ -26,6 +26,7 @@ class ListShortUrlsTest extends ApiTestCase
],
'domain' => null,
'title' => 'My cool title',
'crawlable' => true,
];
private const SHORT_URL_DOCS = [
'shortCode' => 'ghi789',
@ -41,6 +42,7 @@ class ListShortUrlsTest extends ApiTestCase
],
'domain' => null,
'title' => null,
'crawlable' => false,
];
private const SHORT_URL_CUSTOM_SLUG_AND_DOMAIN = [
'shortCode' => 'custom-with-domain',
@ -56,6 +58,7 @@ class ListShortUrlsTest extends ApiTestCase
],
'domain' => 'some-domain.com',
'title' => null,
'crawlable' => false,
];
private const SHORT_URL_META = [
'shortCode' => 'def456',
@ -73,6 +76,7 @@ class ListShortUrlsTest extends ApiTestCase
],
'domain' => null,
'title' => null,
'crawlable' => false,
];
private const SHORT_URL_CUSTOM_SLUG = [
'shortCode' => 'custom',
@ -88,6 +92,7 @@ class ListShortUrlsTest extends ApiTestCase
],
'domain' => null,
'title' => null,
'crawlable' => false,
];
private const SHORT_URL_CUSTOM_DOMAIN = [
'shortCode' => 'ghi789',
@ -105,6 +110,7 @@ class ListShortUrlsTest extends ApiTestCase
],
'domain' => 'example.com',
'title' => null,
'crawlable' => false,
];
/**

1
module/Rest/test-api/Fixtures/ShortUrlsFixture.php
View File

@ -35,6 +35,7 @@ class ShortUrlsFixture extends AbstractFixture implements DependentFixtureInterf
'longUrl' => 'https://shlink.io',
'tags' => ['foo'],
'title' => 'My cool title',
'crawlable' => true,
]), $relationResolver),
'2018-05-01',
);