Chris@0: <?php
Chris@0: 
Chris@0: namespace DrupalCodeGenerator;
Chris@0: 
Chris@0: use Symfony\Component\Console\Question\Question;
Chris@0: 
Chris@0: /**
Chris@0:  * Helper methods for code generators.
Chris@0:  */
Chris@0: class Utils {
Chris@0: 
Chris@5:   use LegacyUtilsTrait;
Chris@5: 
Chris@0:   /**
Chris@0:    * Creates default plugin ID.
Chris@0:    */
Chris@0:   public static function defaultPluginId(array $vars) {
Chris@0:     return $vars['machine_name'] . '_' . self::human2machine($vars['plugin_label']);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Transforms a machine name to human name.
Chris@0:    */
Chris@0:   public static function machine2human($machine_name) {
Chris@0:     return ucfirst(trim(str_replace('_', ' ', $machine_name)));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Transforms a human name to machine name.
Chris@0:    */
Chris@0:   public static function human2machine($human_name) {
Chris@0:     return trim(preg_replace(
Chris@0:       ['/^[0-9]+/', '/[^a-z0-9_]+/'],
Chris@0:       '_',
Chris@0:       strtolower($human_name)
Chris@0:     ), '_');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@4:    * Transforms a camelized sting to machine name.
Chris@4:    */
Chris@4:   public static function camel2machine($input) {
Chris@4:     return self::human2machine(preg_replace('/[A-Z]/', ' \0', $input));
Chris@4:   }
Chris@4: 
Chris@4:   /**
Chris@0:    * Camelize a string.
Chris@0:    */
Chris@0:   public static function camelize($string, $upper_camel = TRUE) {
Chris@0:     $output = preg_replace('/([^A-Z])([A-Z])/', '$1 $2', $string);
Chris@0:     $output = strtolower($output);
Chris@0:     $output = preg_replace('/[^a-z0-9]/', ' ', $output);
Chris@0:     $output = trim($output);
Chris@0:     $output = ucwords($output);
Chris@0:     $output = str_replace(' ', '', $output);
Chris@0:     return $upper_camel ? $output : lcfirst($output);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Machine name validator.
Chris@0:    */
Chris@0:   public static function validateMachineName($value) {
Chris@0:     if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $value)) {
Chris@0:       throw new \UnexpectedValueException('The value is not correct machine name.');
Chris@0:     }
Chris@0:     return $value;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Class name validator.
Chris@0:    *
Chris@0:    * @see http://php.net/manual/en/language.oop5.basic.php
Chris@0:    */
Chris@0:   public static function validateClassName($value) {
Chris@0:     if (!preg_match('/^[A-Z][a-zA-Z0-9]+$/', $value)) {
Chris@0:       throw new \UnexpectedValueException('The value is not correct class name.');
Chris@0:     }
Chris@0:     return $value;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@4:    * Service name validator.
Chris@4:    */
Chris@4:   public static function validateServiceName($value) {
Chris@4:     if ($value !== '' && !preg_match('/^[a-z][a-z0-9_\.]*[a-z0-9]$/', $value)) {
Chris@4:       throw new \UnexpectedValueException('The value is not correct service name.');
Chris@4:     }
Chris@4:     return $value;
Chris@4:   }
Chris@4: 
Chris@4:   /**
Chris@0:    * Required value validator.
Chris@0:    */
Chris@0:   public static function validateRequired($value) {
Chris@0:     // FALSE is not considered as empty value because question helper use
Chris@0:     // it as negative answer on confirmation questions.
Chris@0:     if ($value === NULL || $value === '') {
Chris@0:       throw new \UnexpectedValueException('The value is required.');
Chris@0:     }
Chris@0:     return $value;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@5:    * Returns a validator for allowed options.
Chris@0:    *
Chris@5:    * @param array $options
Chris@5:    *   Allowed values.
Chris@5:    *
Chris@5:    * @return callable
Chris@5:    *   Question validator.
Chris@0:    */
Chris@5:   public static function getOptionsValidator(array $options) {
Chris@5:     return function ($value) use ($options) {
Chris@5:       if (!in_array($value, $options)) {
Chris@5:         $options_formatted = implode(', ', $options);
Chris@5:         $error_message = sprintf('The value should be one of the following: %s.', $options_formatted);
Chris@5:         throw new \UnexpectedValueException($error_message);
Chris@0:       }
Chris@5:       return $value;
Chris@5:     };
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns default questions for module generators.
Chris@0:    *
Chris@0:    * @return \Symfony\Component\Console\Question\Question[]
Chris@5:    *   Array of module questions.
Chris@0:    */
Chris@5:   public static function moduleQuestions() {
Chris@0:     $questions['name'] = new Question('Module name');
Chris@0:     $questions['name']->setValidator([Utils::class, 'validateRequired']);
Chris@0:     $questions['machine_name'] = new Question('Module machine name');
Chris@0:     $questions['machine_name']->setValidator([Utils::class, 'validateMachineName']);
Chris@0:     return $questions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns default questions for plugin generators.
Chris@0:    *
Chris@0:    * @return \Symfony\Component\Console\Question\Question[]
Chris@5:    *   Array of plugin questions.
Chris@0:    */
Chris@5:   public static function pluginQuestions($class_suffix = '') {
Chris@0:     $questions['plugin_label'] = new Question('Plugin label', 'Example');
Chris@0:     $questions['plugin_label']->setValidator([Utils::class, 'validateRequired']);
Chris@0:     $questions['plugin_id'] = new Question('Plugin ID', [Utils::class, 'defaultPluginId']);
Chris@0:     $questions['plugin_id']->setValidator([Utils::class, 'validateMachineName']);
Chris@5:     $questions['class'] = static::pluginClassQuestion($class_suffix);
Chris@0:     return $questions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@5:    * Creates plugin class question.
Chris@5:    */
Chris@5:   public static function pluginClassQuestion($suffix = '') {
Chris@5:     $default_class = function ($vars) use ($suffix) {
Chris@5:       $unprefixed_plugin_id = preg_replace('/^' . $vars['machine_name'] . '_/', '', $vars['plugin_id']);
Chris@5:       return Utils::camelize($unprefixed_plugin_id) . $suffix;
Chris@5:     };
Chris@5:     return new Question('Plugin class', $default_class);
Chris@5:   }
Chris@5: 
Chris@5:   /**
Chris@0:    * Returns extension root.
Chris@0:    *
Chris@0:    * @return string|bool
Chris@0:    *   Extension root directory or false if it was not found.
Chris@0:    */
Chris@0:   public static function getExtensionRoot($directory) {
Chris@0:     $extension_root = FALSE;
Chris@0:     for ($i = 1; $i <= 5; $i++) {
Chris@0:       $info_file = $directory . '/' . basename($directory) . '.info';
Chris@4:       if ((file_exists($info_file) && basename($directory) !== 'drush') || file_exists($info_file . '.yml')) {
Chris@0:         $extension_root = $directory;
Chris@0:         break;
Chris@0:       }
Chris@0:       $directory = dirname($directory);
Chris@0:     }
Chris@0:     return $extension_root;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Removes a given number of lines from the beginning of the string.
Chris@0:    */
Chris@0:   public static function removeHeader($content, $header_size) {
Chris@0:     return implode("\n", array_slice(explode("\n", $content), $header_size));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Return the user's home directory.
Chris@0:    */
Chris@0:   public static function getHomeDirectory() {
Chris@0:     return isset($_SERVER['HOME']) ? $_SERVER['HOME'] : getenv('HOME');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Replaces all tokens in a given string with appropriate values.
Chris@0:    *
Chris@0:    * @param string $text
Chris@0:    *   A string potentially containing replaceable tokens.
Chris@0:    * @param array $data
Chris@0:    *   An array where keys are token names and values are replacements.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   Text with tokens replaced.
Chris@0:    */
Chris@5:   public static function replaceTokens($text, array $data) {
Chris@0:     $tokens = [];
Chris@0:     foreach ($data as $var_name => $var) {
Chris@0:       if (is_string($var)) {
Chris@0:         $tokens['{' . $var_name . '}'] = $var;
Chris@0:       }
Chris@0:     }
Chris@0:     return str_replace(array_keys($tokens), array_values($tokens), $text);
Chris@0:   }
Chris@0: 
Chris@4:   /**
Chris@4:    * Pluralizes a noun.
Chris@4:    *
Chris@4:    * @param string $string
Chris@4:    *   A noun to pluralize.
Chris@4:    *
Chris@4:    * @return string
Chris@4:    *   The pluralized noun.
Chris@4:    */
Chris@4:   public static function pluralize($string) {
Chris@4:     switch (substr($string, -1)) {
Chris@4:       case 'y':
Chris@4:         return substr($string, 0, -1) . 'ies';
Chris@4: 
Chris@4:       case 's':
Chris@4:         return $string . 'es';
Chris@4: 
Chris@4:       default:
Chris@4:         return $string . 's';
Chris@4:     }
Chris@4:   }
Chris@4: 
Chris@4:   /**
Chris@4:    * Prepares choices.
Chris@4:    *
Chris@4:    * @param array $raw_choices
Chris@4:    *   The choices to be prepared.
Chris@4:    *
Chris@4:    * @return array
Chris@4:    *   The prepared choices.
Chris@4:    */
Chris@4:   public static function prepareChoices(array $raw_choices) {
Chris@4:     // The $raw_choices can be an associative array.
Chris@4:     $choices = array_values($raw_choices);
Chris@4:     // Start choices list form '1'.
Chris@4:     array_unshift($choices, NULL);
Chris@4:     unset($choices[0]);
Chris@4:     return $choices;
Chris@4:   }
Chris@4: 
Chris@0: }