deblan-mirror/editor.js
deblan-mirror/editor.js
1
0
Fork 0
mirror of https://github.com/codex-team/editor.js synced 2026-03-16 15:45:47 +01:00
Code Issues Projects Releases Wiki Activity

update request

Browse source
This commit is contained in:
Murod Khaydarov 2017-12-26 20:02:37 +03:00
commit 75ba227495
7 changed files with 242 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

184
build/codex-editor.js
View file

@ -302,6 +302,19 @@ var Util = function () {
return Object.keys(object).length === 0 && object.constructor === Object;
}
/**
* Check if passed object is a Promise
* @param {*} object - object to check
* @return {Boolean}
*/
}, {
key: 'isPromise',
value: function isPromise(object) {
return Promise.resolve(object) === object;
}
}]);
return Util;
@ -466,7 +479,7 @@ module.exports = exports['default'];
/***/ (function(module, exports, __webpack_require__) {
"use strict";
/* WEBPACK VAR INJECTION */(function($) {
/* WEBPACK VAR INJECTION */(function($, _) {
Object.defineProperty(exports, "__esModule", {
value: true
@ -486,18 +499,25 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
*
*/
/**
* @classdesc Abstract Block class that contains block information, tool and tool class instance
*
* @property this.tool - Tool instance
* @property this.html - Returns HTML content of plugin
* @property this.firstLevelBlock - Div element that wraps block content with plugin content. Has `ce-block` CSS class
* @property this.blockContent - Div element that wraps plugins content. Has `ce-block__content` CSS class
* @property this.pluginsContent - HTML content that returns Tool's render function
*/
var Block = function () {
/**
* @constructor
*
* @param {Object} tool — current block plugin`s instance
*/
function Block(tool) {
_classCallCheck(this, Block);
this.tool = tool;
this._html = this.compose();
}
@ -513,20 +533,18 @@ var Block = function () {
/**
* Make default block wrappers and put tool`s content there
*
* @returns {HTMLDivElement}
* @private
*/
value: function compose() {
var wrapper = $.make('div', Block.CSS.wrapper),
content = $.make('div', Block.CSS.content),
pluginsContent = this.tool.render();
this.firstLevelBlock = $.make('div', Block.CSS.wrapper);
this.blockContent = $.make('div', Block.CSS.content);
this.pluginsContent = this.tool.render();
content.appendChild(pluginsContent);
wrapper.appendChild(content);
this.blockContent.appendChild(this.pluginsContent);
this.firstLevelBlock.appendChild(this.blockContent);
return wrapper;
return this.firstLevelBlock;
}
/**
@ -552,9 +570,69 @@ var Block = function () {
}
/**
* Get block`s HTML
* Get Block`s HTML
* @returns {HTMLElement}
*/
}, {
key: 'extractData',
/**
* Get Block's JSON data
* @return {Object}
*/
value: function extractData() {
var self = this;
return new Promise(function (resolve) {
var extractedBlock = self.tool.save(self.pluginsContent);
if (_.isPromise(extractedBlock)) {
extractedBlock.then(self.validateData).then(resolve).catch(function (error) {
_.log('Saving proccess for ' + this.tool.name + ' tool failed due to the ' + error, 'log', 'red');
});
} else {
resolve(extractedBlock);
}
});
}
/**
* Uses Tool's validation method to validate output data
* @param {Object} data
*
* @returns {HTMLDivElement}
* @returns {Boolean} valid
*/
}, {
key: 'validateData',
value: function validateData(data) {
var isValid = true;
if (this.tool.validate && this.tool.validate instanceof Function) {
isValid = this.tool.validate(data);
}
if (!isValid) {
return false;
}
return data;
}
/**
* Check block for emptiness
*
* @return {Boolean}
*/
}, {
@ -565,31 +643,16 @@ var Block = function () {
}
/**
* Get block's JSON data
* @return {{}}
*
* @return {Object}
*/
}, {
key: 'data',
get: function get() {
var outputData = this.tool.save();
if (this.tool.validate(outputData)) {
return outputData;
} else {
return {};
}
return this.extractData();
}
/**
* Check block for emptiness
*
* @return {Boolean}
*/
}, {
key: 'isEmpty',
get: function get() {
@ -665,7 +728,7 @@ var Block = function () {
Block.displayName = 'Block';
exports.default = Block;
module.exports = exports['default'];
/* WEBPACK VAR INJECTION */}.call(exports, __webpack_require__(2)))
/* WEBPACK VAR INJECTION */}.call(exports, __webpack_require__(2), __webpack_require__(1)))
/***/ }),
/* 4 */
@ -2471,7 +2534,7 @@ var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;(function (roo
/***/ (function(module, exports, __webpack_require__) {
"use strict";
/* WEBPACK VAR INJECTION */(function(Module, _) {
/* WEBPACK VAR INJECTION */(function(Module) {
Object.defineProperty(exports, "__esModule", {
value: true
@ -2489,16 +2552,31 @@ function _inherits(subClass, superClass) { if (typeof superClass !== "function"
* Codex Editor Saver
*
* @module Saver
*
* @author Codex Team
* @version 2.0.0
*/
/**
* @typedef {Object} SavedData
* @property {Date} time - saving proccess time
* @property {Object} items - extracted data
* @property {String} version - CodexEditor version
*/
/**
* @classdesc This method reduces all blocks asyncronically and calls Block's save method to extract data
*
* Saver class properties:
* @property {Element} html - Editor HTML content
* @property {String} json - Editor JSON output
*/
var Saver = function (_Module) {
_inherits(Saver, _Module);
/**
* @constructor
* @param {EditorConfig} config
* @param config
*/
function Saver(_ref) {
var config = _ref.config;
@ -2513,6 +2591,12 @@ var Saver = function (_Module) {
return _this;
}
/**
* Composes new chain of Promises to fire them alternatelly
* @return {SavedData}
*/
_createClass(Saver, [{
key: "save",
value: function save() {
@ -2523,31 +2607,27 @@ var Saver = function (_Module) {
blocks.forEach(function (block) {
chainData.push({
function: function _function() {
return _this2.saveBlock(block);
}
});
chainData.push(block.data);
});
return _.sequence(chainData).then(function () {
return _this2.makeOutput();
return Promise.all(chainData).then(function (allExtractedData) {
return _this2.makeOutput(allExtractedData);
});
}
}, {
key: "saveBlock",
value: function saveBlock(block) {
this.blocksData.push(block.data);
return Promise.resolve();
}
/**
* Creates output object with saved data, time and version of editor
* @param {Object} allExtractedData
* @return {SavedData}
*/
}, {
key: "makeOutput",
value: function makeOutput() {
value: function makeOutput(allExtractedData) {
return this.output = {
return {
time: +new Date(),
data: this.blocksData,
items: allExtractedData,
version: "2.0.0"
};
}
@ -2719,7 +2799,7 @@ var Saver = function (_Module) {
Saver.displayName = "Saver";
exports.default = Saver;
module.exports = exports["default"];
/* WEBPACK VAR INJECTION */}.call(exports, __webpack_require__(0), __webpack_require__(1)))
/* WEBPACK VAR INJECTION */}.call(exports, __webpack_require__(0)))
/***/ }),
/* 14 */

2
build/codex-editor.js.map
View file

File diff suppressed because one or more lines are too long

24
example/example.html
View file

@ -73,18 +73,18 @@
},
data: {
items: [
// {
// type : 'text',
// data : {
// text : 'Привет от CodeX'
// }
// },
// {
// type : 'text',
// data : {
// text : 'Пишите нам на team@ifmo.su'
// }
// },
{
type : 'text',
data : {
text : 'Привет от CodeX'
}
},
{
type : 'text',
data : {
text : 'Пишите нам на team@ifmo.su'
}
},
]
}
});

2
example/plugins/text/text.js
View file

@ -105,7 +105,7 @@ class Text {
* Get plugin`s element HTMLDivElement
* @returns {HTMLDivElement} Plugin`s element
*/
save() {
save(block) {
return this.data;

83
src/components/block.js
View file

@ -8,17 +8,24 @@
*
*/
/**
* @classdesc Abstract Block class that contains block information, tool and tool class instance
*
* @property this.tool - Tool instance
* @property this.html - Returns HTML content of plugin
* @property this.firstLevelBlock - Div element that wraps block content with plugin content. Has `ce-block` CSS class
* @property this.blockContent - Div element that wraps plugins content. Has `ce-block__content` CSS class
* @property this.pluginsContent - HTML content that returns Tool's render function
*/
export default class Block {
/**
* @constructor
*
* @param {Object} tool — current block plugin`s instance
*/
constructor(tool) {
this.tool = tool;
this._html = this.compose();
}
@ -39,20 +46,18 @@ export default class Block {
/**
* Make default block wrappers and put tool`s content there
*
* @returns {HTMLDivElement}
* @private
*/
compose() {
let wrapper = $.make('div', Block.CSS.wrapper),
content = $.make('div', Block.CSS.content),
pluginsContent = this.tool.render();
this.firstLevelBlock = $.make('div', Block.CSS.wrapper);
this.blockContent = $.make('div', Block.CSS.content);
this.pluginsContent = this.tool.render();
content.appendChild(pluginsContent);
wrapper.appendChild(content);
this.blockContent.appendChild(this.pluginsContent);
this.firstLevelBlock.appendChild(this.blockContent);
return wrapper;
return this.firstLevelBlock;
}
@ -89,29 +94,73 @@ export default class Block {
}
/**
* Get Block's JSON data
*
* @return {Object}
*/
get data() {
let outputData = this.tool.save();
return this.extractData();
if (this.tool.validate && this.tool.validate instanceof Function ) {
}
if ( this.tool.validate(outputData) ) {
/**
* Get Block's JSON data
* @return {Object}
*/
extractData() {
return outputData;
let self = this;
return new Promise(function (resolve) {
let extractedBlock = self.tool.save(self.pluginsContent);
if (_.isPromise(extractedBlock)) {
extractedBlock
.then(self.validateData)
.then(resolve)
.catch(function (error) {
_.log(`Saving proccess for ${this.tool.name} tool failed due to the ${error}`, 'log', 'red');
});
} else {
_.log("Data %s, doesn't pass the validation, tool %s", outputData. this.tool.name );
resolve(extractedBlock);
}
});
}
/**
* Uses Tool's validation method to validate output data
* @param {Object} data
*
* @returns {Boolean} valid
*/
validateData(data) {
let isValid = true;
if (this.tool.validate && this.tool.validate instanceof Function) {
isValid = this.tool.validate(data);
}
return outputData;
if (!isValid) {
return false;
}
return data;
}
/**

44
src/components/modules/saver.js
View file

@ -7,6 +7,15 @@
*/
/**
* @typedef {Object} SavedData
* @property {Date} time - saving proccess time
* @property {Object} items - extracted data
* @property {String} version - CodexEditor version
*/
/**
* @classdesc This method reduces all blocks asyncronically and calls Block's save method to extract data
*
* Saver class properties:
* @property {Element} html - Editor HTML content
* @property {String} json - Editor JSON output
@ -28,8 +37,8 @@ export default class Saver extends Module {
}
/**
* @todo need documentation
* @return {Promise.<TResult>|*}
* Composes new chain of Promises to fire them alternatelly
* @return {SavedData}
*/
save() {
@ -38,30 +47,27 @@ export default class Saver extends Module {
blocks.forEach((block) => {
chainData.push({
function: () => this.saveBlock(block)
});
chainData.push(block.data);
});
return _.sequence(chainData)
.then(() => this.makeOutput());
return Promise.all(chainData)
.then((allExtractedData) => this.makeOutput(allExtractedData));
}
saveBlock(block) {
/**
* Creates output object with saved data, time and version of editor
* @param {Object} allExtractedData
* @return {SavedData}
*/
makeOutput(allExtractedData) {
this.blocksData.push(block.data);
return Promise.resolve();
}
makeOutput() {
return this.output = {
time: +new Date(),
data : this.blocksData,
version: VERSION,
return {
time : +new Date(),
items : allExtractedData,
version : VERSION,
};
}

11
src/components/utils.js
View file

@ -146,4 +146,15 @@ export default class Util {
}
/**
* Check if passed object is a Promise
* @param {*} object - object to check
* @return {Boolean}
*/
static isPromise(object) {
return Promise.resolve(object) === object;
}
};