Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature seed command #3234

Merged
merged 12 commits into from
Jul 10, 2020
174 changes: 174 additions & 0 deletions system/Commands/Database/CreateSeeder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<?php
/**
* CodeIgniter
*
* An open source application development framework for PHP
*
* This content is released under the MIT License (MIT)
*
* Copyright (c) 2014-2019 British Columbia Institute of Technology
* Copyright (c) 2019-2020 CodeIgniter Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
* @author CodeIgniter Dev Team
* @copyright 2019-2020 CodeIgniter Foundation
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 4.0.0
* @filesource
*/

namespace CodeIgniter\Commands\Database;

use CodeIgniter\CLI\BaseCommand;
use CodeIgniter\CLI\CLI;
use Config\Services;

/**
* Creates a new seeder file.
*
* @package CodeIgniter\Commands
*/
class CreateSeeder extends BaseCommand
{
/**
* The group the command is lumped under
* when listing commands.
*
* @var string
*/
protected $group = 'Database';
abilioposada marked this conversation as resolved.
Show resolved Hide resolved

/**
* The Command's name
*
* @var string
*/
protected $name = 'db:seed:create';

/**
* the Command's short description
*
* @var string
*/
protected $description = 'Creates a new seeder file.';

/**
* the Command's usage
*
* @var string
*/
protected $usage = 'db:seed:create [seeder_name] [options]';

/**
* the Command's Arguments
*
* @var array
*/
protected $arguments = [
'seeder_name' => 'The seeder file name',
];

/**
* the Command's Options
*
* @var array
*/
protected $options = [
'-n' => 'Set seeder namespace',
];

/**
* Creates a new migration file with the current timestamp.
*
* @param array $params
*/
public function run(array $params = [])
{
helper('inflector');

$name = array_shift($params);

if (empty($name))
{
$name = CLI::prompt(lang('Seed.nameFile'));
}

if (empty($name))
abilioposada marked this conversation as resolved.
Show resolved Hide resolved
{
CLI::error(lang('Seed.badName'));
return;
}

$ns = $params['-n'] ?? CLI::getOption('n');
$homepath = APPPATH;

if (! empty($ns))
{
// Get all namespaces
$namespaces = Services::autoloader()->getNamespace();

foreach ($namespaces as $namespace => $path)
{
if ($namespace === $ns)
{
$homepath = realpath(reset($path));
abilioposada marked this conversation as resolved.
Show resolved Hide resolved
break;
}
}
}
else
{
$ns = 'App';
abilioposada marked this conversation as resolved.
Show resolved Hide resolved
}

// full path
$path = $homepath . '/Database/Seeds/' . $name . '.php';
abilioposada marked this conversation as resolved.
Show resolved Hide resolved

// Class name should be pascal case now (camel case with upper first letter)
$name = pascalize($name);

$template = <<<EOD
<?php namespace $ns\DataBase\Seeds;

abilioposada marked this conversation as resolved.
Show resolved Hide resolved
use CodeIgniter\DataBase\Seeder;

abilioposada marked this conversation as resolved.
Show resolved Hide resolved
class {name} extends Seeder
{
public function run()
{
//
}
}

EOD;
$template = str_replace('{name}', $name, $template);

helper('filesystem');
if (! write_file($path, $template))
{
CLI::error(lang('Seed.writeError', [$path]));
return;
}

CLI::write('Created file: ' . CLI::color(str_replace($homepath, $ns, $path), 'green'));
abilioposada marked this conversation as resolved.
Show resolved Hide resolved
}
}
22 changes: 22 additions & 0 deletions system/Language/en/Seed.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?php

/**
* Seed language strings.
*
* @package CodeIgniter
* @author CodeIgniter Dev Team
* @copyright 2019-2020 CodeIgniter Foundation
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 4.0.0
* @filesource
*
* @codeCoverageIgnore
*/

return [
// Seed command
'nameFile' => 'Name the seeder file',
'badName' => 'You must provide a seeder file name.',
'writeError' => 'Error trying to create {0} file, check if the directory is writable.',
];