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@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@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@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@0:    * Returns normalized file path.
Chris@0:    *
Chris@0:    * @codeCoverageIgnore
Chris@0:    * @deprecated
Chris@0:    */
Chris@0:   public static function normalizePath($path) {
Chris@0:     $parts = [];
Chris@0:     $path = str_replace('\\', '/', $path);
Chris@0:     $path = preg_replace('/\/+/', '/', $path);
Chris@0:     $segments = explode('/', $path);
Chris@0:     foreach ($segments as $segment) {
Chris@0:       if ($segment != '.') {
Chris@0:         $test = array_pop($parts);
Chris@0:         if (is_null($test)) {
Chris@0:           $parts[] = $segment;
Chris@0:         }
Chris@0:         elseif ($segment == '..') {
Chris@0:           if ($test == '..') {
Chris@0:             $parts[] = $test;
Chris@0:           }
Chris@0:           if ($test == '..' || $test == '') {
Chris@0:             $parts[] = $segment;
Chris@0:           }
Chris@0:         }
Chris@0:         else {
Chris@0:           $parts[] = $test;
Chris@0:           $parts[] = $segment;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:     return implode('/', $parts);
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@0:    *   Array of default questions.
Chris@0:    */
Chris@0:   public static function defaultQuestions() {
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@0:    *   Array of default questions.
Chris@0:    */
Chris@0:   public static function defaultPluginQuestions() {
Chris@0:     $questions = Utils::defaultQuestions();
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@0:     return $questions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
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@0:       if (file_exists($info_file) || 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@0:   public static function tokenReplace($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@0: }