t/5: Introducing the CKEDITOR namespace, the AMD API and the Builder.

LICENSE.md

@@ -24,6 +24,15 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource
 with their express permission.
 
+(Ignore this line: %REMOVE_START%)
+
+Software available at our [repository](https://github.com/ckeditor/ckeditor5) and developer version only:
+
+ - RequireJS (lib/requirejs) <br>
+   Licensed under the terms of the MIT or new BSD license. <br>
+   Copyright (c) 2010-2014, The Dojo Foundation All Rights Reserved.
+
+(Ignore this line: %REMOVE_END%)
 Trademarks
 ----------
 

ckeditor.js

@@ -0,0 +1,105 @@
+/**
+ * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* global requirejs, define, require, window, document, location */
+
+'use strict';
+
+// This file is shared by the dev and release versions of CKEditor. It bootstraps the API.
+
+( function( root ) {
+	var CKEDITOR = root.CKEDITOR = {
+		/**
+		 * The full URL for the CKEditor installation directory.
+		 *
+		 * It is possible to manually provide the base path by setting a global variable named `CKEDITOR_BASEPATH`. This
+		 * global variable must be set **before** the editor script loading.
+		 *
+		 *		alert( CKEDITOR.basePath ); // e.g. 'http://www.example.com/ckeditor/'
+		 *
+		 * @property {String}
+		 */
+		basePath: getBasePath(),
+
+		/**
+		 * Defines an AMD module.
+		 *
+		 * See https://github.com/ckeditor/ckeditor5-design/wiki/AMD for more details about our AMD API.
+		 *
+		 * @method
+		 * @member CKEDITOR
+		 */
+		define: define,
+
+		/**
+		 * Retrieves one or more AMD modules.
+		 *
+		 * Note that the CKEditor AMD API does not download modules on demand so be sure to have their relative scripts
+		 * available in the page.
+		 *
+		 * See https://github.com/ckeditor/ckeditor5-design/wiki/AMD for more details about our AMD API.
+		 *
+		 * @method
+		 * @member CKEDITOR
+		 */
+		require: require
+	};
+
+	requirejs.config( {
+		// Modules are generally relative to the core project.
+		baseUrl: CKEDITOR.basePath + 'node_modules/ckeditor5-core/src/',
+
+		// These configurations will make no difference in the build version because the following paths will be
+		// already defined there.
+		paths: {
+			// Hide the core "ckeditor" under a different name.
+			'ckeditor-core': CKEDITOR.basePath + 'node_modules/ckeditor5-core/src/ckeditor',
+
+			// The dev version overrides for the "ckeditor" module. This is empty on release.
+			'ckeditor-dev': CKEDITOR.basePath + 'src/ckeditor-dev'
+		}
+	} );
+
+	// Define a new "ckeditor" module, which overrides the core one with the above and the dev stuff.
+	define( 'ckeditor', [ 'ckeditor-core', 'ckeditor-dev', 'utils' ], function( core, dev, utils ) {
+		utils.extend( core, root.CKEDITOR, ( dev || {} ) );
+		root.CKEDITOR = core;
+
+		return core;
+	} );
+
+	function getBasePath() {
+		if ( window.CKEDITOR_BASEPATH ) {
+			return window.CKEDITOR_BASEPATH;
+		}
+
+		var scripts = document.getElementsByTagName( 'script' );
+
+		var basePathSrcPattern = /(^|.*[\\\/])ckeditor\.js(?:\?.*|;.*)?$/i;
+
+		var path;
+
+		// Find the first script that src matches ckeditor.js.
+		[].some.call( scripts, function( script ) {
+			var match = script.src.match( basePathSrcPattern );
+
+			if ( match ) {
+				path = match[ 1 ];
+
+				return true;
+			}
+		} );
+
+		if ( path.indexOf( ':/' ) == -1 && path.slice( 0, 2 ) != '//' ) {
+			if ( path.indexOf( '/' ) === 0 ) {
+				path = location.href.match( /^.*?:\/\/[^\/]*/ )[ 0 ] + path;
+			} else {
+				path = location.href.match( /^[^\?]*\/(?:)/ )[ 0 ] + path;
+			}
+		}
+
+		return path;
+	}
+} )( window );

dev/tasks/build.js

@@ -0,0 +1,158 @@
+/**
+ * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* jshint node: true */
+
+'use strict';
+
+module.exports = function( grunt ) {
+	grunt.registerTask( 'build', 'Build a release out of the current development code.', function() {
+		var done = this.async();
+		module.exports.build( done );
+	} );
+};
+
+// Exports the build method so it can be used from plain node code as well.
+module.exports.build = function( done ) {
+	var target = 'build';
+	var tmp = 'tmp';
+	var stepCounter = 0;
+
+	var tasks = [
+		[ cleanup, 'Cleaning the "' + target + '" directory...' ],
+		[ copyToTmp, 'Copying source files for manipulation...' ],
+		[ removeAmdNamespace, 'AMD cleanup...' ],
+		[ optimize, 'Creating the optimized code...' ],
+		[ cleanupTmp, 'Removing the "' + tmp + '" directory...' ]
+	];
+
+	runNext();
+
+	function runNext() {
+		var next = tasks.shift();
+
+		if ( next ) {
+			stepCounter++;
+			console.log( stepCounter + '. ' + next[ 1 ] );
+			next[ 0 ]( runNext );
+		} else {
+			if ( done ) {
+				done();
+			}
+		}
+	}
+
+	function cleanup( callback ) {
+		var del = require( 'del' );
+		del.sync( target );
+		del.sync( tmp );
+
+		return callback();
+	}
+
+	function copyToTmp( callback ) {
+		var ncp = require( 'ncp' ).ncp;
+		var path = require( 'path' );
+		var fs = require( 'fs' );
+
+		var deps = JSON.parse( fs.readFileSync( 'package.json', 'utf8' ) ).dependencies;
+
+		var toCopy = Object.keys( deps ).filter( function( name ) {
+				return name.indexOf( 'ckeditor5-' ) === 0;
+			} );
+
+		if ( !fs.existsSync( tmp ) ) {
+			fs.mkdirSync( tmp );
+		}
+
+		function copy() {
+			var module = toCopy.shift();
+
+			if ( !module ) {
+				return callback();
+			}
+
+			var dest = path.join( tmp + '/', module );
+
+			if ( !fs.existsSync( dest ) ) {
+				fs.mkdirSync( dest );
+			}
+
+			// Copy the "src" directory only.
+			ncp( path.join( 'node_modules', module, 'src' ), path.join( dest, 'src' ), {
+				dereference: true
+			}, function( err ) {
+				if ( err ) {
+					throw( err );
+				}
+
+				copy();
+			} );
+		}
+
+		copy();
+	}
+
+	function removeAmdNamespace( callback ) {
+		var replace = require( 'replace' );
+
+		replace( {
+			regex: /^\s*CKEDITOR\.(define|require)/mg,
+			replacement: '$1',
+			paths: [ 'tmp' ],
+			recursive: true,
+			silent: true
+		} );
+
+		callback();
+	}
+
+	function optimize( callback ) {
+		var requirejs = require( 'requirejs' );
+
+		var config = {
+			out: target + '/ckeditor.js',
+
+			baseUrl: tmp + '/ckeditor5-core/src/',
+			paths: {
+				'ckeditor': '../../../ckeditor',
+				'ckeditor-dev': '../../../src/ckeditor-dev',
+				'ckeditor-core': 'ckeditor'
+//				depTree: '../../../lib/depTree',
+//				plugins: '../../../lib/plugins'
+			},
+
+//			include: ['depTree', 'ckeditor' ].concat( getPlugins() ),
+			include: [ 'ckeditor' ],
+			stubModules: [ 'ckeditor-dev' ],
+
+//			onBuildWrite: replacePaths,
+//			optimize: 'none',
+			optimize: 'uglify2',
+			//uglify2: {
+			//	output: {
+			//		beautify: true
+			//	},
+			//	mangle: false
+			//},
+			preserveLicenseComments: false,
+			wrap: {
+				startFile: [ 'dev/tasks/build/start.frag', require.resolve( 'almond' ) ],
+				endFile: 'dev/tasks/build/end.frag'
+			}
+		};
+
+		requirejs.optimize( config, function() {
+			callback();
+		} );
+	}
+
+	function cleanupTmp( callback ) {
+		var del = require( 'del' );
+		del.sync( tmp );
+
+		return callback();
+	}
+};

dev/tasks/build/end.frag

@@ -0,0 +1,4 @@
+/************************ end.frag START */
+
+	return require( 'ckeditor' );
+} );

dev/tasks/build/start.frag

@@ -0,0 +1,13 @@
+( function ( root, factory ) {
+	// Register the CKEDITOR global.
+	root.CKEDITOR = factory();
+
+	// Make the build an AMD module.
+	if ( typeof define == 'function' && define.amd ) {
+		define( [], function() {
+			return root.CKEDITOR;
+		} );
+	}
+} )( this, function () {
+
+/************************ start.frag END */

gruntfile.js

@@ -9,6 +9,7 @@ module.exports = function( grunt ) {
 	// Files that will be ignored by the "jscs" and "jshint" tasks.
 	var ignoreFiles = [
 		// Automatically loaded from .gitignore. Add more if necessary.
+		'lib/**'
 	];
 
 	// Basic configuration which will be overloaded by the tasks.