Skip to content

Commit

Permalink
Merge pull request #730 from hydephp/refactor-make-publication-command
Browse files Browse the repository at this point in the history 
Refactor the make publication command and add more tests for it
  • Loading branch information
@caendesilva
caendesilva authored Dec 4, 2022
2 parents 0c44d9d + eeacf9b commit 0207c7a
Show file tree
Hide file tree
Showing 4 changed files with 222 additions and 110 deletions.
231 changes: 137 additions & 94 deletions packages/framework/src/Console/Commands/MakePublicationTypeCommand.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,24 @@

namespace Hyde\Console\Commands;

use function array_flip;
use function array_keys;
use function array_merge;
use function file_exists;
use Hyde\Console\Commands\Interfaces\CommandHandleInterface;
use Hyde\Console\Concerns\ValidatingCommand;
use Hyde\Framework\Actions\CreatesNewPublicationType;
use Hyde\Framework\Features\Publications\Models\PublicationFieldType;
use Hyde\Framework\Features\Publications\PublicationService;
use Illuminate\Support\Str;
use InvalidArgumentException;
use function is_dir;
use LaravelZero\Framework\Commands\Command;
use Rgasch\Collection\Collection;
use function scandir;
use function strtolower;
use function trim;
use function ucfirst;

/**
* Hyde Command to create a new publication type.
Expand Down Expand Up @@ -43,49 +53,14 @@ public function safeHandle(): int

$fields = $this->captureFieldsDefinitions();

$this->output->writeln('<bg=magenta;fg=white>Choose the default field you wish to sort by:</>');
$this->line(' 0: dateCreated (meta field)');
$offset = 0;
foreach ($fields as $k => $v) {
$offset = $k + 1;
$this->line(" $offset: $v[name]");
}
$selected = (int) $this->askWithValidation('selected', "Sort field (0-$offset)", ['required', 'integer', "between:0,$offset"], 0);
$sortField = $selected ? $fields[$selected - 1]['name'] : '__createdAt';

$this->output->writeln('<bg=magenta;fg=white>Choose the default sort direction:</>');
$this->line(' 1 - Ascending (oldest items first if sorting by dateCreated)');
$this->line(' 2 - Descending (newest items first if sorting by dateCreated)');
$selected = (int) $this->askWithValidation('selected', 'Sort field (1-2)', ['required', 'integer', 'between:1,2'], 2);
$sortDirection = match ($selected) {
1 => 'ASC',
2 => 'DESC',
};

$pageSize = (int) $this->askWithValidation(
'pageSize',
'Enter the pageSize (0 for no limit)',
['required', 'integer', 'between:0,100'],
25
);
$prevNextLinks = (bool) $this->askWithValidation(
'prevNextLinks',
'Generate previous/next links in detail view (y/n)',
['required', 'string', 'in:y,n'],
'y'
);
$sortField = $this->getSortField($fields);

$this->output->writeln('<bg=magenta;fg=white>Choose a canonical name field (the values of this field have to be unique!):</>');
$fieldNames = [];
foreach ($fields as $k => $v) {
if ($v->type != 'image' && $v->type != 'tag') {
$fieldNames[] = $v->name;
$offset = $k + 1;
$this->line(" $offset: $v->name");
}
}
$selected = (int) $this->askWithValidation('selected', "Canonical field (1-$offset)", ['required', 'integer', "between:1,$offset"], 1);
$canonicalField = $fieldNames[$selected - 1];
$sortDirection = $this->getSortDirection();

$pageSize = $this->getPageSize();
$prevNextLinks = $this->getPrevNextLinks();

$canonicalField = $this->getCanonicalField($fields);

$creator = new CreatesNewPublicationType($title, $fields, $canonicalField, $sortField, $sortDirection, $pageSize, $prevNextLinks, $this->output);
$creator->create();
Expand All @@ -104,71 +79,139 @@ protected function captureFieldsDefinitions(): Collection
$this->line('');
$this->output->writeln("<bg=cyan;fg=white>Field #$count:</>");

$field = Collection::create();
$fieldData = [];
do {
$field->name = Str::kebab(trim($this->askWithValidation('name', 'Field name', ['required'])));
$duplicate = $fields->where('name', $field->name)->count();
if ($duplicate) {
$this->error("Field name [$field->name] already exists!");
}
$fieldData['name'] = Str::kebab(trim($this->askWithValidation('name', 'Field name', ['required'])));
$duplicate = $this->checkIfFieldIsDuplicate($fields, $fieldData['name']);
} while ($duplicate);

$this->line('Field type:');
$this->line(' 1 - String');
$this->line(' 2 - Boolean ');
$this->line(' 3 - Integer');
$this->line(' 4 - Float');
$this->line(' 5 - Datetime (YYYY-MM-DD (HH:MM:SS))');
$this->line(' 6 - URL');
$this->line(' 7 - Array');
$this->line(' 8 - Text');
$this->line(' 9 - Local Image');
$this->line(' 10 - Tag (select value from list)');
$type = (int) $this->askWithValidation('type', 'Field type (1-10)', ['required', 'integer', 'between:1,10'], 1);
$type = $this->getFieldType();

if ($type < 10) {
do {
$field->min = trim($this->askWithValidation('min', 'Min value (for strings, this refers to string length)', ['required', 'string'], 0));
$field->max = trim($this->askWithValidation('max', 'Max value (for strings, this refers to string length)', ['required', 'string'], 0));
$lengthsValid = true;
if ($field->max < $field->min) {
$lengthsValid = false;
$this->output->warning('Field length [max] must be [>=] than [min]');
}
$fieldData['min'] = trim($this->askWithValidation('min', 'Min value (for strings, this refers to string length)', ['required', 'string'], 0));
$fieldData['max'] = trim($this->askWithValidation('max', 'Max value (for strings, this refers to string length)', ['required', 'string'], 0));
$lengthsValid = $this->validateLengths($fieldData['min'], $fieldData['max']);
} while (! $lengthsValid);
} else {
$allTags = PublicationService::getAllTags();
$offset = 1;
foreach ($allTags as $k=>$v) {
$this->line(" $offset - $k");
$offset++;
}
$offset--; // The above loop overcounts by 1
$selected = $this->askWithValidation('tagGroup', 'Tag Group', ['required', 'integer', "between:1,$offset"], 0);
$field->tagGroup = $allTags->keys()->{$selected - 1};
$field->min = 0;
$field->max = 0;
$fieldData = $this->getFieldDataForTag($fieldData);
}
$addAnother = $this->askWithValidation('addAnother', '<bg=magenta;fg=white>Add another field (y/n)</>', ['required', 'string', 'in:y,n'], 'y');
$addAnother = $this->askWithValidation('addAnother', '<bg=magenta;fg=white>Add another field (y/n)</>', ['required', 'string', 'in:y,n'], 'n');

// map field choice to actual field type
$field->type = match ($type) {
1 => 'string',
2 => 'boolean',
3 => 'integer',
4 => 'float',
5 => 'datetime',
6 => 'url',
7 => 'array',
8 => 'text',
9 => 'image',
10 => 'tag',
};

$fields->add($field);
$fieldData['type'] = PublicationFieldType::TYPES[$type];

$fields->add(PublicationFieldType::fromArray($fieldData));
$count++;
} while (strtolower($addAnother) != 'n');
} while (strtolower($addAnother) !== 'n');

return $fields;
}

protected function getFieldType(): int
{
$options = PublicationFieldType::TYPES;
foreach ($options as $key => $value) {
$options[$key] = ucfirst($value);
}
$options[5] = 'Datetime (YYYY-MM-DD (HH:MM:SS))';
$options[6] = 'URL';
$options[9] = 'Local Image';
$options[10] = 'Tag (select value from list)';

return (int) $this->choice('Field type', $options, 1) + 1;
}

protected function getSortField(Collection $fields): string
{
$options = array_merge(['dateCreated (meta field)'], $fields->pluck('name')->toArray());

$selected = $this->choice('Choose the default field you wish to sort by', $options, 'dateCreated (meta field)');

return $selected === 'dateCreated (meta field)' ? '__createdAt' : $options[(array_flip($options)[$selected])];
}

protected function getSortDirection(): string
{
$options = [
'Ascending (oldest items first if sorting by dateCreated)' => 'ASC',
'Descending (newest items first if sorting by dateCreated)' => 'DESC',
];

return $options[$this->choice('Choose the default sort direction', array_keys($options), 'Ascending (oldest items first if sorting by dateCreated)')];
}

protected function getPageSize(): int
{
return (int) $this->askWithValidation(
'pageSize',
'Enter the pageSize (0 for no limit)',
['required', 'integer', 'between:0,100'],
25
);
}

protected function getPrevNextLinks(): bool
{
return (bool) $this->askWithValidation(
'prevNextLinks',
'Generate previous/next links in detail view (y/n)',
['required', 'string', 'in:y,n'],
'y'
);
}

protected function getCanonicalField(Collection $fields): string
{
$options = $fields->reject(function (PublicationFieldType $field): bool {
// Temporary verbose check to see code coverage
if ($field->type === 'image') {
return true;
} elseif ($field->type === 'tag') {
return true;
} else {
return false;
}
})->pluck('name');

return $this->choice('Choose a canonical name field (the values of this field have to be unique!)', $options->toArray(), $options->first());
}

protected function validateLengths(string $min, string $max): bool
{
if ($max < $min) {
$this->error('Field length [max] cannot be less than [min]');

return false;
}

return true;
}

protected function getFieldDataForTag(array $fieldData): array
{
$allTags = PublicationService::getAllTags();
$offset = 1;
foreach ($allTags as $k => $v) {
$this->line(" $offset - $k");
$offset++;
}
$offset--; // The above loop overcounts by 1
$selected = $this->askWithValidation('tagGroup', 'Tag Group', ['required', 'integer', "between:1,$offset"], 0);
$fieldData['tagGroup'] = $allTags->keys()->{$selected - 1};
$fieldData['min'] = 0;
$fieldData['max'] = 0;

return $fieldData;
}

protected function checkIfFieldIsDuplicate(Collection $fields, $name): bool
{
$duplicate = $fields->where('name', $name)->count();
if ($duplicate) {
$this->error("Field name [$name] already exists!");
}

return (bool) $duplicate;
}
}
14 changes: 13 additions & 1 deletion packages/framework/src/Framework/Features/Publications/Models/PublicationFieldType.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,19 @@ class PublicationFieldType implements SerializableContract
{
use Serializable;

public final const TYPES = ['string', 'boolean', 'integer', 'float', 'datetime', 'url', 'array', 'text', 'image', 'tag'];
public final const TYPES = [
1 => 'string',
2 => 'boolean',
3 => 'integer',
4 => 'float',
5 => 'datetime',
6 => 'url',
7 => 'array',
8 => 'text',
9 => 'image',
10 => 'tag',
];

public final const DEFAULT_RULES = [
'string' => ['required', 'string', 'between'],
'boolean' => ['required', 'boolean'],
Expand Down
Loading

0 comments on commit 0207c7a

Please sign in to comment.