Changeset 19273

Timestamp:

06/15/09 14:47:22 (9 months ago)

Author:

fabien

Message:

[1.3] enhanced the generate:project task and plugin installation

• You can now ask symfony to generate a project without any ORM (--orm=none)
  
• You can enable/disable a plugin from an installer (enablePlugin(), disablePlugin())
  
• Plugins are now disabled by default for new projects
  
  • the plugin:install task enable the installed plugins
    
  • the plugin:unintall task disable the uninstalled plugins
    

Files:

• branches/1.3/WHATS_NEW (modified) (2 diffs)
• branches/1.3/lib/autoload/sfCoreAutoload.class.php (modified) (2 diffs)
• branches/1.3/lib/plugin/sfSymfonyPluginManager.class.php (modified) (3 diffs)
• branches/1.3/lib/plugins/sfDoctrinePlugin/config/installer.php (modified) (1 diff)
• branches/1.3/lib/plugins/sfPropelPlugin/config/installer.php (modified) (1 diff)
• branches/1.3/lib/task/generator/sfGenerateProjectTask.class.php (modified) (3 diffs)
• branches/1.3/lib/task/generator/skeleton/project/config/ProjectConfiguration.class.php (modified) (1 diff)
• branches/1.3/lib/task/plugin/sfPluginBaseTask.class.php (modified) (1 diff)
• branches/1.3/lib/task/sfBaseTask.class.php (modified) (2 diffs)
• branches/1.3/lib/task/sfCommandApplicationTask.class.php (modified) (1 diff)
• branches/1.3/lib/util/sfClassManipulator.class.php (added)
• branches/1.3/test/unit/util/sfClassManipulatorTest.php (added)

branches/1.3/WHATS_NEW

@@ -261 +261 @@
-    $ php /path/to/symfony generate:project foo --orm=Propel
-
+If you don't want to use Propel or Doctrine, you can pass `none` to the
+`--orm` option:
+
+  $ php /path/to/symfony generate:project foo --orm=none
+
-The new `--installer` option allows you to pass a PHP script that can further
-customize the newly created project. The script is executed in the context of
-the task, and so can use any of its methods. The more useful ones are the
-following: `installDir()`, `runTask()`, `ask()`, `askConfirmation()`,
-and `reloadTasks
+`reloadTasks()`, `enablePlugin()`, and `disablePlugin
-
-More information can be found in this
@@ -357 +362 @@
-`sfCultureInfo->sortArray()` can be used for that.
-
+Plugins
+-------
+
+Before symfony 1.3, all plugins were enabled by default, except for the
+`sfDoctrinePlugin` and the `sfCompat10Plugin` ones:
+
+    [php]
+    class ProjectConfiguration extends sfProjectConfiguration
+    {
+      public function setup()
+      {
+        // for compatibility / remove and enable only the plugins you want
+        $this->enableAllPluginsExcept(array('sfDoctrinePlugin', 'sfCompat10Plugin'));
+      }
+    }
+
+For freshly created projects with symfony 1.3, plugins must be explicitly
+enabled in the `ProjectConfiguration` class to be able to use them:
+
+    [php]
+    class ProjectConfiguration extends sfProjectConfiguration
+    {
+      public function setup()
+      {
+        $this->enablePlugins('sfDoctrinePlugin');
+      }
+    }
+
+The `plugin:install` task automatically enables the plugin(s) it installs (and
+`plugin:uninstall` disable them). If you install a plugin via Subversion, you
+still need to enable it by hand.
+
+If you want to use a core-plugin, like `sfProtoculousPlugin` or
+`sfCompat10Plugin`, you just need to add the corresponding `enablePlugins()`
+statement in the `ProjectConfiguration` class.
+
+>**NOTE**
+>If you upgrade a project from 1.2, the old behavior will still be
+>active as the upgrade task does not change the `ProjectConfiguration`
+>file. The behavior change is only for new symfony 1.3 projects.

branches/1.3/lib/autoload/sfCoreAutoload.class.php

@@ -377 +377 @@
-    'sfcachecleartask' => 'task/cache/sfCacheClearTask.class.php',
-    'sfconfigureauthortask' => 'task/configure/sfConfigureAuthorTask.class.php',
-    'sfconfiguredatabasetask' => 'task/configure/sfConfigureDatabaseTask.class.php',
-    'sfgenerateapptask' => 'task/generator/sfGenerateAppTask.class.php',
-    'sfgeneratemoduletask' => 'task/generator/sfGenerateModuleTask.class.php',
@@ -429 +428 @@
-    'sfbrowserbase' => 'util/sfBrowserBase.class.php',
-    'sfcallable' => 'util/sfCallable.class.php',
+    'sfclassmanipulator' => 'util/sfClassManipulator.class.php',
-    'sfcontext' => 'util/sfContext.class.php',
-    'sfdomcssselector' => 'util/sfDomCssSelector.class.php',

branches/1.3/lib/plugin/sfSymfonyPluginManager.class.php

@@ -56 +56 @@
-
-    // register callbacks to manage web content
-
-
+
+
+
-  }
-
@@ -104 +105 @@
-
-  /**
+   * Enables a plugin in the ProjectConfiguration class.
+   *
+   * @param string $plugin The name of the plugin
+   */
+  public function enablePlugin($plugin)
+  {
+    if (!$this->environment->getOption('config_dir'))
+    {
+      throw new sfPluginException('You must provide a "config_dir" option.');
+    }
+
+    $manipulator = sfClassManipulator::fromFile($this->environment->getOption('config_dir').'/ProjectConfiguration.class.php');
+    $manipulator->wrapMethod('setup', '', sprintf('$this->enablePlugins(\'%s\');', $plugin));
+    $manipulator->save();
+  }
+
+  /**
+   * Disables a plugin in the ProjectConfiguration class.
+   *
+   * @param string $plugin The name of the plugin
+   */
+  protected function disablePlugin($plugin)
+  {
+    if (!$this->environment->getOption('config_dir'))
+    {
+      throw new sfPluginException('You must provide a "config_dir" option.');
+    }
+
+    $file = $this->environment->getOption('config_dir').'/ProjectConfiguration.class.php';
+    $source = file_get_contents($file);
+
+    $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(([^\)]+), *\'%s\'([^\)]*)\)\)#', $plugin), '$this->enablePlugins(array($1$2))', $source);
+    $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(\'%s\', *([^\)]*)\)\)#', $plugin), '$this->enablePlugins(array($1))', $source);
+    $source = preg_replace(sprintf('# *\$this\->enablePlugins\(\'%s\'\); *\n?#', $plugin), '', $source);
+    $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(\'%s\'\)\); *\n?#', $plugin), '', $source);
+    $source = preg_replace(sprintf('# *\$this\->enablePlugins\(array\(\)\); *\n?#', $plugin), '', $source);
+
+    file_put_contents($file, $source);
+  }
+
+  /**
-   * Listens to the plugin.post_install event.
-   *
-   * @param sfEvent $event An sfEvent instance
-   */
-
-
-
-
+
+
+
+
+
-  }
-
@@ -119 +162 @@
-   * @param sfEvent $event An sfEvent instance
-   */
-L
+l
-  {
-    $this->uninstallWebContent($event['plugin']);
+  }
+
+  public function listenToPluginPostUnintall(sfEvent $event)
+  {
+    $this->disablePlugin($event['plugin']);
-  }
-

branches/1.3/lib/plugins/sfDoctrinePlugin/config/installer.php

@@ -2 +2 @@
-
-$this->installDir(dirname(__FILE__).'/skeleton');
+$this->enablePlugin('sfDoctrinePlugin');
+$this->reloadTasks();

branches/1.3/lib/plugins/sfPropelPlugin/config/installer.php

@@ -2 +2 @@
-
-$this->installDir(dirname(__FILE__).'/skeleton');
+$this->enablePlugin('sfPropelPlugin');
+$this->reloadTasks();

branches/1.3/lib/task/generator/sfGenerateProjectTask.class.php

@@ -65 +65 @@
-  [./symfony generate:project blog --orm=Propel|INFO]
-
+If you don't want to use an ORM, pass [none|INFO] to [--orm|INFO] option:
+
+  [./symfony generate:project blog --orm=none|INFO]
+
-You can also pass the [--installer|INFO] option to further customize the
-project:
@@ -82 +86 @@
-    }
-
-
-
-
-
-
+
+
+
+
-
-    $this->arguments = $arguments;
-    $this->options = $options;
-
+    // create basic project structure
+    $this->installDir(dirname(__FILE__).'/skeleton/project');
+
+    // update ProjectConfiguration class (use a relative path when the symfony core is nested within the project)
+    $symfonyCoreAutoload = 0 === strpos(sfConfig::get('sf_symfony_lib_dir'), sfConfig::get('sf_root_dir')) ?
+      sprintf('dirname(__FILE__).\'/..%s/autoload/sfCoreAutoload.class.php\'', str_replace(sfConfig::get('sf_root_dir'), '', sfConfig::get('sf_symfony_lib_dir'))) :
+      var_export(sfConfig::get('sf_symfony_lib_dir').'/autoload/sfCoreAutoload.class.php', true);
+
+    $this->replaceTokens(array(sfConfig::get('sf_config_dir')), array('SYMFONY_CORE_AUTOLOAD' => $symfonyCoreAutoload));
+
+    $this->tokens = array(
+      'ORM'          => $this->options['orm'],
+      'PROJECT_NAME' => $this->arguments['name'],
+      'PROJECT_DIR'  => sfConfig::get('sf_root_dir'),
+    );
+
-    $this->replaceTokens();
+
+    // execute the choosen ORM installer script
+    if ('none' !== $options['orm'])
+    {
+      include dirname(__FILE__).'/../../plugins/sf'.ucfirst(strtolower($options['orm'])).'Plugin/config/installer.php';
+    }
-
-    // execute a custom installer
@@ -108 +133 @@
-    $this->replaceTokens();
-  }
-
-  /**
-   * Executes another task in the context of the current one.
-   *
-   * @param  string  $name      The name of the task to execute
-   * @param  array   $arguments An array of arguments to pass to the task
-   * @param  array   $options   An array of options to pass to the task
-   *
-   * @return Boolean The returned value of the task run() method
-   */
-  protected function runTask($name, $arguments = array(), $options = array())
-  {
-    if (is_null($this->commandApplication))
-    {
-      throw new LogicException('No command application associated with this task yet.');
-    }
-
-    $task = $this->commandApplication->getTaskToExecute($name);
-    $task->setCommandApplication($this->commandApplication);
-
-    return $task->run($arguments, $options);
-  }
-
-  /**
-   * Mirrors a directory structure inside the created project.
-   *
-   * @param string   $dir    The directory to mirror
-   * @param sfFinder $finder A sfFinder instance to use for the mirroring
-   */
-  protected function installDir($dir, $finder = null)
-  {
-    if (is_null($finder))
-    {
-      $finder = sfFinder::type('any')->discard('.sf');
-    }
-
-    $this->getFilesystem()->mirror($dir, sfConfig::get('sf_root_dir'), $finder);
-  }
-
-  /**
-   * Replaces tokens in files contained in a given directory.
-   *
-   * If you don't pass a directory, it will replace in the config/ and lib/ directory.
-   *
-   * @param array $dirs   An array of directory where to do the replacement
-   * @param array $tokens An array of tokens to use
-   */
-  protected function replaceTokens($dirs = array(), $tokens = array())
-  {
-    if (!$dirs)
-    {
-      $dirs = array(sfConfig::get('sf_config_dir'), sfConfig::get('sf_lib_dir'));
-    }
-
-    // update ProjectConfiguration class (use a relative path when the symfony core is nested within the project)
-    $symfonyCoreAutoload = 0 === strpos(sfConfig::get('sf_symfony_lib_dir'), sfConfig::get('sf_root_dir')) ?
-      sprintf('dirname(__FILE__).\'/..%s/autoload/sfCoreAutoload.class.php\'', str_replace(sfConfig::get('sf_root_dir'), '', sfConfig::get('sf_symfony_lib_dir'))) :
-      var_export(sfConfig::get('sf_symfony_lib_dir').'/autoload/sfCoreAutoload.class.php', true);
-
-    $tokens = array_merge(array(
-      'ORM'                   => $this->options['orm'],
-      'OTHER_ORM'             => 'Doctrine' == $this->options['orm'] ? 'Propel' : 'Doctrine',
-      'PROJECT_NAME'          => $this->arguments['name'],
-      'PROJECT_DIR'           => sfConfig::get('sf_root_dir'),
-      'SYMFONY_CORE_AUTOLOAD' => $symfonyCoreAutoload,
-    ), $tokens);
-
-    $this->getFilesystem()->replaceTokens(sfFinder::type('file')->prune('vendor')->in($dirs), '##', '##', $tokens);
-  }
-
-  /**
-   * Reloads tasks.
-   *
-   * Useful when you install plugins with tasks and if you want to use them with the runTask() method.
-   */
-  protected function reloadTasks()
-  {
-    $this->configuration = $this->createConfiguration(null, null);
-
-    $this->commandApplication->clearTasks();
-    $this->commandApplication->loadTasks($this->configuration);
-
-    $tasks = array();
-    foreach (get_declared_classes() as $class)
-    {
-      $r = new Reflectionclass($class);
-      if ($r->isSubclassOf('sfTask') && !$r->isAbstract() && false === strpos($class, 'Doctrine' == $this->options['orm'] ? 'Propel' : 'Doctrine'))
-      {
-        $tasks[] = new $class($this->dispatcher, $this->formatter);
-      }
-    }
-
-    $this->commandApplication->registerTasks($tasks);
-  }
-}

branches/1.3/lib/task/generator/skeleton/project/config/ProjectConfiguration.class.php

@@ -8 +8 @@
-  public function setup()
-  {
-    // for compatibility / remove and enable only the plugins you want
-    $this->enableAllPluginsExcept(array('sf##OTHER_ORM##Plugin', 'sfCompat10Plugin'));
-  }
-}

branches/1.3/lib/task/plugin/sfPluginBaseTask.class.php

@@ -19 +19 @@
-abstract class sfPluginBaseTask extends sfBaseTask
-{
-  private
-   $pluginManager = null;
-
-  public function getPluginManager()
-  {
-    if (is_null($this->pluginManager))
-    {
-      $environment = new sfPearEnvironment($this->dispatcher, array(
-        'plugin_dir' => sfConfig::get('sf_plugins_dir'),
-        'cache_dir'  => sfConfig::get('sf_cache_dir').'/.pear',
-        'web_dir'    => sfConfig::get('sf_web_dir'),
-      ));
-
-      $this->pluginManager = new sfSymfonyPluginManager($this->dispatcher, $environment);
-    }
-
-    return $this->pluginManager;
-  }
-}

branches/1.3/lib/task/sfBaseTask.class.php

@@ -20 +20 @@
-{
-  protected
-
+
+
-
-  /**
@@ -205 +206 @@
-    sfSimpleAutoload::getInstance(sfConfig::get('sf_cache_dir').'/project_autoload.cache')->reload();
-  }
+
+  /**
+   * Mirrors a directory structure inside the created project.
+   *
+   * @param string   $dir    The directory to mirror
+   * @param sfFinder $finder A sfFinder instance to use for the mirroring
+   */
+  protected function installDir($dir, $finder = null)
+  {
+    if (is_null($finder))
+    {
+      $finder = sfFinder::type('any')->discard('.sf');
+    }
+
+    $this->getFilesystem()->mirror($dir, sfConfig::get('sf_root_dir'), $finder);
+  }
+
+  /**
+   * Replaces tokens in files contained in a given directory.
+   *
+   * If you don't pass a directory, it will replace in the config/ and lib/ directory.
+   *
+   * You can define global tokens by defining the $this->tokens property.
+   *
+   * @param array $dirs   An array of directory where to do the replacement
+   * @param array $tokens An array of tokens to use
+   */
+  protected function replaceTokens($dirs = array(), $tokens = array())
+  {
+    if (!$dirs)
+    {
+      $dirs = array(sfConfig::get('sf_config_dir'), sfConfig::get('sf_lib_dir'));
+    }
+
+    $tokens = array_merge(isset($this->tokens) ? $this->tokens : array(), $tokens);
+
+    $this->getFilesystem()->replaceTokens(sfFinder::type('file')->prune('vendor')->in($dirs), '##', '##', $tokens);
+  }
+
+  /**
+   * Reloads tasks.
+   *
+   * Useful when you install plugins with tasks and if you want to use them with the runTask() method.
+   */
+  protected function reloadTasks()
+  {
+    if (is_null($this->commandApplication))
+    {
+      return;
+    }
+
+    $this->configuration = $this->createConfiguration(null, null);
+
+    $this->commandApplication->clearTasks();
+    $this->commandApplication->loadTasks($this->configuration);
+
+    $disabledPluginsRegex = sprintf('#^(%s)#', implode('|', array_diff($this->configuration->getAllPluginPaths(), $this->configuration->getPluginPaths())));
+    $tasks = array();
+    foreach (get_declared_classes() as $class)
+    {
+      $r = new Reflectionclass($class);
+      if ($r->isSubclassOf('sfTask') && !$r->isAbstract() && !preg_match($disabledPluginsRegex, $r->getFileName()))
+      {
+        $tasks[] = new $class($this->dispatcher, $this->formatter);
+      }
+    }
+
+    $this->commandApplication->registerTasks($tasks);
+  }
+
+  /**
+   * Enables a plugin in the ProjectConfiguration class.
+   *
+   * @param string $plugin The name of the plugin
+   */
+  protected function enablePlugin($plugin)
+  {
+    $this->getPluginManager()->enablePlugin($plugin);
+  }
+
+  /**
+   * Disables a plugin in the ProjectConfiguration class.
+   *
+   * @param string $plugin The name of the plugin
+   */
+  protected function disablePlugin($plugin)
+  {
+    $this->getPluginManager()->disablePlugin($plugin);
+  }
+
+  /**
+   * Returns a plugin manager instance.
+   *
+   * @return sfSymfonyPluginManager A sfSymfonyPluginManager instance
+   */
+  protected function getPluginManager()
+  {
+    if (is_null($this->pluginManager))
+    {
+      $environment = new sfPearEnvironment($this->dispatcher, array(
+        'plugin_dir' => sfConfig::get('sf_plugins_dir'),
+        'cache_dir'  => sfConfig::get('sf_cache_dir').'/.pear',
+        'web_dir'    => sfConfig::get('sf_web_dir'),
+        'config_dir' => sfConfig::get('sf_config_dir'),
+      ));
+
+      $this->pluginManager = new sfSymfonyPluginManager($this->dispatcher, $environment);
+    }
+
+    return $this->pluginManager;
+  }
-}

branches/1.3/lib/task/sfCommandApplicationTask.class.php

@@ -53 +53 @@
-    }
-  }
+
+  /**
+   * Executes another task in the context of the current one.
+   *
+   * @param  string  $name      The name of the task to execute
+   * @param  array   $arguments An array of arguments to pass to the task
+   * @param  array   $options   An array of options to pass to the task
+   *
+   * @return Boolean The returned value of the task run() method
+   */
+  protected function runTask($name, $arguments = array(), $options = array())
+  {
+    if (is_null($this->commandApplication))
+    {
+      throw new LogicException('No command application associated with this task yet.');
+    }
+
+    $task = $this->commandApplication->getTaskToExecute($name);
+    $task->setCommandApplication($this->commandApplication);
+
+    return $task->run($arguments, $options);
+  }
-}