Merge pull request #14 from VSEphpbb/updates-fixes

General fixes and updates for the Skeleton

Author: michaelcullum

config/skeletons.yml

@@ -32,7 +32,7 @@ services:
             - 'acp'
             - true
             - []
-            - ['acp/main_info.php', 'acp/main_module.php', 'adm/style/demo_body.html', 'language/en/info_acp_demo.php']
+            - ['acp/main_info.php', 'acp/main_module.php', 'adm/style/acp_demo_body.html', 'language/en/info_acp_demo.php']
         tags:
             - { name: phpbb.skeleton.ext.skeleton }
 
@@ -42,7 +42,7 @@ services:
             - 'migration'
             - true
             - []
-            - ['migrations/release_1_0_0.php', 'migrations/release_1_0_1.php']
+            - ['migrations/install_module.php', 'migrations/install_user_schema.php']
         tags:
             - { name: phpbb.skeleton.ext.skeleton }
 
@@ -66,13 +66,23 @@ services:
         tags:
             - { name: phpbb.skeleton.ext.skeleton }
 
+    phpbb.skeleton.ext.skeleton.ext:
+        class: phpbb\skeleton\skeleton
+        arguments:
+            - 'ext'
+            - true
+            - []
+            - ['ext.php']
+        tags:
+            - { name: phpbb.skeleton.ext.skeleton }
+
     phpbb.skeleton.ext.skeleton.tests:
         class: phpbb\skeleton\skeleton
         arguments:
             - 'tests'
             - true
             - []
-            - ['tests/controller/main_test.php', 'tests/dbal/fixtures/config.xml', 'tests/dbal/simple_test.php', 'tests/functional/demo_test.php', 'tests/mock/controller_helper.php', 'tests/mock/template.php', 'tests/mock/user.php', 'phpunit.xml.dist']
+            - ['tests/controller/main_test.php', 'tests/dbal/fixtures/config.xml', 'tests/dbal/simple_test.php', 'tests/functional/demo_test.php', 'phpunit.xml.dist']
         tags:
             - { name: phpbb.skeleton.ext.skeleton }
 

console/create.php

@@ -59,9 +59,9 @@ protected function configure()
 	}
 
 	/**
-	* Executes the command config:delete.
+	* Executes the command extension:create.
 	*
-	* Removes a configuration option
+	* Creates an extension skeleton
 	*
 	* @param InputInterface  $input  An InputInterface instance
 	* @param OutputInterface $output An OutputInterface instance
@@ -70,16 +70,28 @@ protected function configure()
 	* @see \phpbb\config\config::delete()
 	*/
 	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$this->packager->create_extension($this->data);
+
+		$output->writeln($this->user->lang('EXTENSION_CLI_SKELETON_SUCCESS'));
+	}
+
+	/**
+	 * Interacts with the user.
+	 *
+	 * @param InputInterface  $input  An InputInterface instance
+	 * @param OutputInterface $output An OutputInterface instance
+	 */
+	protected function interact(InputInterface $input, OutputInterface $output)
 	{
 		/** @var DialogHelper $dialog */
 		$dialog = $this->getHelper('dialog');
 
+		$output->writeln($this->user->lang('SKELETON_CLI_COMPOSER_QUESTIONS'));
 		$this->get_composer_data($dialog, $output);
-		$this->get_component_data($dialog, $output);
 
-		$this->packager->create_extension($this->data);
-
-		$output->writeln($this->user->lang('EXTENSION_SKELETON_SUCCESS'));
+		$output->writeln($this->user->lang('SKELETON_CLI_COMPONENT_QUESTIONS'));
+		$this->get_component_data($dialog, $output);
 	}
 
 	/**
@@ -96,7 +108,7 @@ protected function get_composer_data(DialogHelper $dialog, OutputInterface $outp
 
 		$num_authors = $dialog->askAndValidate(
 			$output,
-			$this->user->lang('SKELETON_QUESTION_NUM_AUTHORS'),
+			$this->user->lang('SKELETON_QUESTION_NUM_AUTHORS') . $this->user->lang('COLON'),
 			array($this->validator, 'validate_num_authors'),
 			false,
 			1
@@ -152,7 +164,7 @@ protected function get_user_input(DialogHelper $dialog, OutputInterface $output,
 		{
 			$return_value = $dialog->askAndValidate(
 				$output,
-				$this->user->lang('SKELETON_QUESTION_' . strtoupper($value)),
+				$this->user->lang('SKELETON_QUESTION_' . strtoupper($value)) . $this->user->lang('COLON'),
 				array($this->validator, 'validate_' . $value),
 				false,
 				$default
@@ -162,15 +174,15 @@ protected function get_user_input(DialogHelper $dialog, OutputInterface $output,
 		{
 			$return_value = $dialog->askConfirmation(
 				$output,
-				$this->user->lang('SKELETON_QUESTION_' . strtoupper($value)),
+				$this->user->lang('SKELETON_QUESTION_' . strtoupper($value)) . $this->user->lang('COLON'),
 				$default
 			);
 		}
 		else
 		{
 			$return_value = $dialog->ask(
 				$output,
-				$this->user->lang('SKELETON_QUESTION_' . strtoupper($value)),
+				$this->user->lang('SKELETON_QUESTION_' . strtoupper($value)) . $this->user->lang('COLON'),
 				$default
 			);
 		}

controller/main.php

@@ -149,9 +149,8 @@ public function handle()
 		foreach ($components as $component => $details)
 		{
 			$this->template->assign_block_vars('component', array(
-				'NAME'			=> $component,
+				'NAME'			=> 'component_' . $component,
 				'DESC'			=> $this->user->lang('SKELETON_QUESTION_COMPONENT_' . strtoupper($component) . '_UI'),
-				'DESC_EXPLAIN'	=> isset($this->user->lang['SKELETON_QUESTION_COMPONENT_' . strtoupper($component) . '_EXPLAIN']) ? $this->user->lang('SKELETON_QUESTION_COMPONENT_' . strtoupper($component) . '_EXPLAIN') : '',
 				'VALUE'			=> $this->request->variable('component_' . $component, $details['default']),
 			));
 

event/main_listener.php

@@ -26,8 +26,8 @@ class main_listener implements EventSubscriberInterface
 	static public function getSubscribedEvents()
 	{
 		return array(
-			'core.user_setup'						=> 'load_language_on_setup',
-			'core.page_header'						=> 'add_page_header_link',
+			'core.user_setup'	=> 'load_language_on_setup',
+			'core.page_header'	=> 'add_page_header_link',
 		);
 	}
 

ext.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ *
+ * @package phpBB Extension - Acme Demo
+ * @copyright (c) 2013 phpBB Group
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+ *
+ */
+namespace phpbb\skeleton;
+
+/**
+ * Class ext
+ *
+ * It is recommended to remove this file from
+ * an extension if it is not going to be used.
+ */
+class ext extends \phpbb\extension\base
+{
+	/**
+	 * Check whether or not the extension can be enabled.
+	 * The current phpBB version should meet or exceed
+	 * the minimum version required by this extension:
+	 *
+	 * Requires phpBB 3.1.4
+	 *
+	 * @return bool
+	 * @access public
+	 */
+	public function is_enableable()
+	{
+		return phpbb_version_compare(PHPBB_VERSION, '3.1.4', '>=');
+	}
+}
+

helper/packager.php

@@ -208,7 +208,7 @@ public function create_zip($data)
 		{
 			$zip_archive->addFile(
 				$file->getRealPath(),
-				$file->getRelativePath() . '/' . $file->getFilename()
+				"{$data['extension']['vendor_name']}/{$data['extension']['extension_name']}/" . $file->getRelativePath() . '/' . $file->getFilename()
 			);
 		}
 

language/en/common.php

@@ -22,31 +22,34 @@
 }
 
 $lang = array_merge($lang, array(
-	'CLI_DESCRIPTION_SKELETON_CREATE'	=> 'A console command to create a basic extension',
+	'CLI_DESCRIPTION_SKELETON_CREATE'	=> 'Create a basic skeleton extension',
 	'PHPBB_SKELETON_EXT'				=> 'Create skeleton extension',
-	'EXTENSION_SKELETON_SUCCESS'		=> 'Extension created successfully',
+
+	'EXTENSION_CLI_SKELETON_SUCCESS'	=> "<info>Extension created successfully.\nCopy the extension from `store/tmp-ext/` into the `ext/` folder.</info>",
+	'SKELETON_CLI_COMPOSER_QUESTIONS'	=> '<comment>Enter the composer.json details (hit enter to leave an option empty)</comment>',
+	'SKELETON_CLI_COMPONENT_QUESTIONS'	=> '<comment>Choose the components you’d like installed. Default: y; [y/n]</comment>',
 
 	'SKELETON_ADD_AUTHOR'						=> 'Add author',
 	'SKELETON_QUESTION_VENDOR_NAME'				=> 'Please enter the vendor name',
 	'SKELETON_QUESTION_VENDOR_NAME_UI'			=> 'Vendor name',
 	'SKELETON_QUESTION_VENDOR_NAME_EXPLAIN'		=> 'Starting with a letter, letters and numbers only',
-	'SKELETON_QUESTION_EXTENSION_DISPLAY_NAME'	=> 'Please enter the display (readable) name of your extension',
+	'SKELETON_QUESTION_EXTENSION_DISPLAY_NAME'	=> 'Please enter the display (readable) name of the extension',
 	'SKELETON_QUESTION_EXTENSION_DISPLAY_NAME_UI'	=> 'Display (readable) extension name',
-	'SKELETON_QUESTION_EXTENSION_NAME'			=> 'Please enter the folder name of your extension',
-	'SKELETON_QUESTION_EXTENSION_NAME_UI'			=> 'Folder name',
+	'SKELETON_QUESTION_EXTENSION_NAME'			=> 'Please enter the folder (package) name of the extension',
+	'SKELETON_QUESTION_EXTENSION_NAME_UI'		=> 'Folder (package) name',
 	'SKELETON_QUESTION_EXTENSION_NAME_EXPLAIN'	=> 'Starting with a letter, letters and numbers only',
-	'SKELETON_QUESTION_EXTENSION_DESCRIPTION'	=> 'Please enter the Description of your extension',
+	'SKELETON_QUESTION_EXTENSION_DESCRIPTION'	=> 'Please enter the Description of the extension',
 	'SKELETON_QUESTION_EXTENSION_DESCRIPTION_UI'=> 'Description',
-	'SKELETON_QUESTION_EXTENSION_VERSION'		=> 'Please enter the version of your extension',
+	'SKELETON_QUESTION_EXTENSION_VERSION'		=> 'Please enter the version of the extension',
 	'SKELETON_QUESTION_EXTENSION_VERSION_UI'	=> 'Version',
 	'SKELETON_QUESTION_EXTENSION_VERSION_EXPLAIN'	=> 'e.g. 1.0.0-dev',
-	'SKELETON_QUESTION_EXTENSION_HOMEPAGE'		=> 'Please enter the homepage of your extension',
-	'SKELETON_QUESTION_EXTENSION_HOMEPAGE_UI'	=> 'Homepage of your extension',
-	'SKELETON_QUESTION_EXTENSION_TIME'			=> 'Please enter the date of your extension',
-	'SKELETON_QUESTION_EXTENSION_TIME_UI'		=> 'Date of your extension',
+	'SKELETON_QUESTION_EXTENSION_HOMEPAGE'		=> 'Please enter the homepage of the extension',
+	'SKELETON_QUESTION_EXTENSION_HOMEPAGE_UI'	=> 'Homepage of the extension',
+	'SKELETON_QUESTION_EXTENSION_TIME'			=> 'Please enter the date of the extension',
+	'SKELETON_QUESTION_EXTENSION_TIME_UI'		=> 'Date of the extension',
 	'SKELETON_QUESTION_EXTENSION_TIME_EXPLAIN'	=> 'YYYY-MM-DD, default: today',
 
-	'SKELETON_QUESTION_NUM_AUTHORS'				=> 'How many authors does your extension have',
+	'SKELETON_QUESTION_NUM_AUTHORS'				=> 'How many authors does the extension have',
 	'SKELETON_QUESTION_NUM_AUTHORS_EXPLAIN'		=> 'default: 1',
 
 	'SKELETON_QUESTION_AUTHOR_NAME'			=> 'Please enter the author name',
@@ -59,43 +62,41 @@
 	'SKELETON_QUESTION_AUTHOR_ROLE'			=> 'Please enter the author role',
 	'SKELETON_QUESTION_AUTHOR_ROLE_UI'		=> 'Author role',
 
-	'SKELETON_QUESTION_PHP_VERSION'					=> 'Please enter the php requirement of your extension',
-	'SKELETON_QUESTION_PHP_VERSION_UI'				=> 'php requirement of your extension',
-	'SKELETON_QUESTION_PHP_VERSION_EXPLAIN'			=> 'default: >=5.3.3',
-	'SKELETON_QUESTION_PHPBB_VERSION_MIN'			=> 'Please enter the minimum phpBB requirement of your extension',
-	'SKELETON_QUESTION_PHPBB_VERSION_MIN_UI'		=> 'Minimum phpBB requirement of your extension',
-	'SKELETON_QUESTION_PHPBB_VERSION_MIN_EXPLAIN'	=> 'default: >=3.1.4',
-	'SKELETON_QUESTION_PHPBB_VERSION_MAX'			=> 'Please enter the maximum phpBB requirement of your extension',
-	'SKELETON_QUESTION_PHPBB_VERSION_MAX_UI'		=> 'Maximum phpBB requirement of your extension',
-	'SKELETON_QUESTION_PHPBB_VERSION_MAX_EXPLAIN'	=> 'default: <3.2.0@dev',
+	'SKELETON_QUESTION_PHP_VERSION'					=> 'Please enter the PHP requirement of the extension',
+	'SKELETON_QUESTION_PHP_VERSION_UI'				=> 'PHP requirement of the extension',
+	'SKELETON_QUESTION_PHP_VERSION_EXPLAIN'			=> 'default: &gt;=5.3.3',
+	'SKELETON_QUESTION_PHPBB_VERSION_MIN'			=> 'Please enter the minimum phpBB requirement of the extension',
+	'SKELETON_QUESTION_PHPBB_VERSION_MIN_UI'		=> 'Minimum phpBB requirement of the extension',
+	'SKELETON_QUESTION_PHPBB_VERSION_MIN_EXPLAIN'	=> 'default: &gt;=3.1.4',
+	'SKELETON_QUESTION_PHPBB_VERSION_MAX'			=> 'Please enter the maximum phpBB requirement of the extension',
+	'SKELETON_QUESTION_PHPBB_VERSION_MAX_UI'		=> 'Maximum phpBB requirement of the extension',
+	'SKELETON_QUESTION_PHPBB_VERSION_MAX_EXPLAIN'	=> 'default: &lt;3.2.0@dev',
 
-	'SKELETON_QUESTION_COMPONENT_PHPLISTENER'		=> 'Should we add a sample for php listeners',
-	'SKELETON_QUESTION_COMPONENT_PHPLISTENER_UI'	=> 'php listeners',
-	'SKELETON_QUESTION_COMPONENT_PHPLISTENER_EXPLAIN'	=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER'		=> 'Should we add a sample for styles listeners',
+	'SKELETON_QUESTION_COMPONENT_PHPLISTENER'		=> 'Create sample PHP listeners?',
+	'SKELETON_QUESTION_COMPONENT_PHPLISTENER_UI'	=> 'PHP listeners',
+	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER'		=> 'Create sample styles listeners?',
 	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER_UI'	=> 'Styles listeners',
-	'SKELETON_QUESTION_COMPONENT_HTMLLISTENER_EXPLAIN'	=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_ACP'				=> 'Should we add a sample for a administration module',
+	'SKELETON_QUESTION_COMPONENT_ACP'				=> 'Create a sample ACP administration module?',
 	'SKELETON_QUESTION_COMPONENT_ACP_UI'			=> 'Administration module (ACP)',
-	'SKELETON_QUESTION_COMPONENT_ACP_EXPLAIN'		=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_MIGRATION'			=> 'Should we add a sample for a database migration',
+	'SKELETON_QUESTION_COMPONENT_MIGRATION'			=> 'Create sample database migrations?',
 	'SKELETON_QUESTION_COMPONENT_MIGRATION_UI'		=> 'Database migration',
-	'SKELETON_QUESTION_COMPONENT_MIGRATION_EXPLAIN'	=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_SERVICE'			=> 'Should we add a sample for a service',
+	'SKELETON_QUESTION_COMPONENT_SERVICE'			=> 'Create a sample service?',
 	'SKELETON_QUESTION_COMPONENT_SERVICE_UI'		=> 'Service',
-	'SKELETON_QUESTION_COMPONENT_SERVICE_EXPLAIN'	=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_CONTROLLER'		=> 'Should we add a sample for a controller',
+	'SKELETON_QUESTION_COMPONENT_CONTROLLER'		=> 'Create a sample controller?',
 	'SKELETON_QUESTION_COMPONENT_CONTROLLER_UI'		=> 'Controller (frontpage)',
-	'SKELETON_QUESTION_COMPONENT_CONTROLLER_EXPLAIN'=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_TESTS'				=> 'Should we add a sample for a phpunit tests',
-	'SKELETON_QUESTION_COMPONENT_TESTS_UI'			=> 'phpunit tests',
-	'SKELETON_QUESTION_COMPONENT_TESTS_EXPLAIN'		=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_TRAVIS'			=> 'Should we add a sample for test execution on Travis CI',
-	'SKELETON_QUESTION_COMPONENT_TRAVIS_UI'			=> 'Test execution on Travis CI',
-	'SKELETON_QUESTION_COMPONENT_TRAVIS_EXPLAIN'	=> 'default: y; [y/n]',
-	'SKELETON_QUESTION_COMPONENT_BUILD'				=> 'Should we add a sample script to building packages for the customisation database',
-	'SKELETON_QUESTION_COMPONENT_BUILD_UI'			=> 'Script to building packages for the customisation database',
-	'SKELETON_QUESTION_COMPONENT_BUILD_EXPLAIN'		=> 'default: n; [y/n]',
+	'SKELETON_QUESTION_COMPONENT_EXT'				=> 'Create a sample ext.php?',
+	'SKELETON_QUESTION_COMPONENT_EXT_UI'			=> 'Extension base (ext.php)',
+	'SKELETON_QUESTION_COMPONENT_TESTS'				=> 'Create sample PHPUnit tests?',
+	'SKELETON_QUESTION_COMPONENT_TESTS_UI'			=> 'PHPUnit tests',
+	'SKELETON_QUESTION_COMPONENT_TRAVIS'			=> 'Create a sample for test execution on Travis-CI?',
+	'SKELETON_QUESTION_COMPONENT_TRAVIS_UI'			=> 'Test execution on Travis-CI',
+	'SKELETON_QUESTION_COMPONENT_BUILD'				=> 'Create a sample script to build packages for the customisation database?',
+	'SKELETON_QUESTION_COMPONENT_BUILD_UI'			=> 'Script to build packages for the customisation database',
+
+	'SKELETON_TITLE_EXTENSION_INFO'		=> 'Extension packaging',
+	'SKELETON_TITLE_AUTHOR_INFO'		=> 'Authors',
+	'SKELETON_TITLE_REQUIREMENT_INFO'	=> 'Requirements',
+	'SKELETON_TITLE_COMPONENT_INFO'		=> 'Components',
 
 	'SKELETON_INVALID_EXTENSION_NAME'	=> 'The extension name you provided is invalid',
 	'SKELETON_INVALID_EXTENSION_TIME'	=> 'The extension date you provided is invalid',

skeleton/.travis.yml.tpl

@@ -1,3 +1,5 @@
+sudo: required
+
 language: php
 
 matrix:

skeleton/acp/main_info.php.tpl

@@ -20,9 +20,12 @@ class main_info
 		return array(
 			'filename'	=> '\{EXTENSION.vendor_name}\{EXTENSION.extension_name}\acp\main_module',
 			'title'		=> 'ACP_DEMO_TITLE',
-			'version'	=> '1.0.0',
 			'modes'		=> array(
-				'settings'	=> array('title' => 'ACP_DEMO', 'auth' => 'ext_{EXTENSION.vendor_name}/{EXTENSION.extension_name} && acl_a_board', 'cat' => array('ACP_DEMO_TITLE')),
+				'settings'	=> array(
+					'title'	=> 'ACP_DEMO',
+					'auth'	=> 'ext_{EXTENSION.vendor_name}/{EXTENSION.extension_name} && acl_a_board',
+					'cat'	=> array('ACP_DEMO_TITLE')
+				),
 			),
 		);
 	}

skeleton/acp/main_module.php.tpl

@@ -19,10 +19,10 @@ class main_module
 
 	function main($id, $mode)
 	{
-		global $user, $template, $request, $config;
+		global $config, $request, $template, $user;
 
 		$user->add_lang('acp/common');
-		$this->tpl_name = 'demo_body';
+		$this->tpl_name = 'acp_demo_body';
 		$this->page_title = $user->lang('ACP_DEMO_TITLE');
 		add_form_key('acme/demo');