lightair/turbo-rss
1
0
Fork 0
mirror of https://github.com/LightAir/turbo-rss.git synced 2025-12-17 14:27:53 +00:00
Code Issues Projects Releases Wiki Activity

Рефакторинг. Дорабавление новых опций.

Browse Source
This commit is contained in:
LightAir 2021-08-29 02:19:59 +03:00
parent c676a924b0
commit 01aa654b03
15 changed files with 324 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.eslintrc.json
View File

@ -23,6 +23,12 @@
"semi": [
"error",
"always"
]
],
"no-var": "error",
"no-multi-spaces": "error",
"space-in-parens": "error",
"no-multiple-empty-lines": "error",
"prefer-const": "error",
"no-use-before-define": "error"
}
}

381
lib/index.js
View File

@ -1,186 +1,225 @@
'use strict';
const xml = require('xml');
const baseXml = require('xml');
/**
* Check first argument. If true - push last argument to second argument
*
* @param condition
* @param array
* @param data
*/
function pushIfConditionTrue(condition, array, data) {
if (condition) {
array.push(data);
class TR {
constructor(options, items) {
options = options || {};
this.title = options.title || '';
this.link = options.link || '';
this.description = options.description || '';
this.language = options.language || 'ru';
this.items = [];
if (Array.isArray(items) && items.length > 0) {
const self = this;
items.forEach(function (item) {
self.item(item);
});
}
}
}
/**
* @param related
* @param itemValues
* @param relatedInfinity
*/
function addRelated(related, itemValues, relatedInfinity) {
let relatedResult = related.map(function (rel) {
return {
link: [{
_attr: {
'url': rel.link,
'img': rel.image_url
xml() {
return baseXml(this.generateXML(this));
}
item(data) {
data = data || {};
this.items.push(
this.itemData(data)
);
return this;
}
/**
* Check first argument. If true - push last argument to second argument
*
* @param condition
* @param array
* @param data
*/
pushIfConditionTrue(condition, array, data) {
if (condition) {
array.push(data);
}
}
/**
* @param related
* @param itemValues
* @param relatedInfinity
*/
addRelated(related, itemValues, relatedInfinity) {
const relatedResult = related.map(function (rel) {
return {
link: [{
_attr: {
'url': rel.link,
'img': rel.image_url
}
}, rel.text]
};
});
if (relatedInfinity) {
relatedResult.push({
_attr: {'type': 'infinity'}
});
}
this.pushIfConditionTrue(related, itemValues, {'yandex:related': relatedResult});
}
/**
* @param item
* @param itemValues
*/
pushGoals(item, itemValues) {
if (item.goals.length > 0) {
item.goals.forEach(goal => itemValues.push({
'turbo:goal': {
_attr: {
type: goal.type || 'yandex',
'turbo-goal-id': goal.id,
name: goal.name,
id: goal.counter_id,
}
}
}, rel.text]
};
});
}));
}
}
if (relatedInfinity) {
relatedResult.push({
_attr: {'type': 'infinity'}
getImageContent(item) {
if (item.image_url.length > 0) {
let imageCaption = '';
if (item.image_caption.length > 0) {
imageCaption = `<figcaption>${item.image_caption}</figcaption>`;
}
return `<figure><img src="${item.image_url}" />${imageCaption}</figure>`;
}
return '';
}
getSubheading(item) {
if (item.subheading.length > 0) {
return `<h2>${item.subheading}</h2>`;
}
return '';
}
getLinksString(links) {
return links.map(function (item) {
return `<a href="${item.link}">${item.text}</a>`;
}).join('');
}
getMenu(item) {
if (Array.isArray(item.menu) && item.menu.length > 0) {
return `<menu>${this.getLinksString(item.menu)}</menu>`;
}
return '';
}
getBreadcrumbs(item) {
if (Array.isArray(item.breadcrumbs) && item.breadcrumbs.length > 0) {
return `<div data-block="breadcrumblist">${this.getLinksString(item.breadcrumbs)}</div>`;
}
return '';
}
/**
* Items processing
* @param items
* @param channel
*/
itemsProcessing(items, channel) {
const self = this;
items.forEach(function (item) {
const itemValues = [];
itemValues.push({_attr: {'turbo': item.turboEnabled ? 'true' : 'false'}});
itemValues.push({link: item.url});
self.pushIfConditionTrue(item.turboSource, itemValues, {'turbo:source': item.turboSource});
self.pushIfConditionTrue(item.turboTopic, itemValues, {'turbo:topic': item.turboTopic});
self.pushIfConditionTrue(item.date, itemValues, {pubDate: new Date(item.date).toUTCString()});
self.pushIfConditionTrue(item.author, itemValues, {author: item.author});
const fullContent = `<header>${self.getImageContent(item)}<h1>${item.title}</h1>${self.getSubheading(item)}${self.getMenu(item)}${self.getBreadcrumbs(item)}</header>${item.content}`;
self.pushGoals(item, itemValues);
itemValues.push({'turbo:content': {_cdata: fullContent}});
if (typeof item.related !== 'undefined') {
self.addRelated(item.related, itemValues, item.relatedInfinity);
}
channel.push({item: itemValues});
});
}
pushIfConditionTrue(related, itemValues, {'yandex:related': relatedResult});
}
/**
* @param options
*
* @returns {{rss: *[]}}
*/
generateXML(options) {
/**
* @param item
* @param itemValues
*/
function pushGoals(item, itemValues) {
if (item.goals.length > 0) {
item.goals.forEach(goal => itemValues.push({
'turbo:goal': {
_attr: {
type: goal.type || 'yandex',
'turbo-goal-id': goal.id,
name: goal.name,
id: goal.counter_id,
}
}
}));
const channel = [];
channel.push({title: {_cdata: options.title}});
channel.push({link: options.link});
channel.push({description: {_cdata: options.description}});
channel.push({language: options.language});
this.itemsProcessing(options.items, channel);
const _attr = {
'xmlns:yandex': 'http://news.yandex.ru',
'xmlns:media': 'http://search.yahoo.com/mrss/',
'xmlns:turbo': 'http://turbo.yandex.ru',
version: '2.0'
};
return {
rss: [
{_attr: _attr},
{channel: channel}
]
};
}
/**
* @param data
* @returns {*}
*/
itemData(data) {
return {
title: data.title || '', // h1
subheading: data.subheading || '', // h2
image_url: data.image_url || '',
image_caption: data.image_caption || '',
url: data.url || data.link,
author: data.author,
date: data.date || data.pubDate,
content: data.content,
menu: data.menu || [],
breadcrumbs: data.breadcrumbs || [],
related: data.related,
relatedInfinity: data.relatedInfinity || false,
turboSource: data.turboSource || '',
turboTopic: data.turboTopic || '',
goals: data.goals || [],
turboEnabled: data.turboEnabled !== undefined ? data.turboEnabled : true,
};
}
}
/**
* Items processing
* @param items
* @param channel
*/
function items(items, channel) {
items.forEach(function (item) {
let itemValues = [];
itemValues.push({_attr: {'turbo': item.turboEnabled ? 'true' : 'false'}});
itemValues.push({link: item.url});
pushIfConditionTrue(item.turboSource, itemValues, {'turbo:source': item.turboSource});
pushIfConditionTrue(item.turboTopic, itemValues, {'turbo:topic': item.turboTopic});
pushIfConditionTrue(item.date, itemValues, {pubDate: new Date(item.date).toUTCString()});
pushIfConditionTrue(item.author, itemValues, {author: item.author});
let img = '', menu = '';
if (item.image_url) {
if (!item.image_caption) img = '<figure><img src="' + item.image_url + '" /></figure>';
else img = '<figure><img src="' + item.image_url + '" /><figcaption>' + item.image_caption + '</figcaption></figure>';
}
if (Array.isArray(item.menu)) {
menu = '<menu>' + item.menu.map(function (item) {
return '<a href="' + item.link + '">' + item.text + '</a>';
}).join('') + '</menu>';
}
let fullContent = '<header>' + img + ' <h1>' + item.title + '</h1>' + menu + '</header>' + item.content;
pushGoals(item, itemValues);
itemValues.push({'turbo:content': {_cdata: fullContent}});
if (typeof item.related !== 'undefined') {
addRelated(item.related, itemValues, item.relatedfinity);
}
channel.push({item: itemValues});
});
}
/**
* @param data
* @returns {{rss: *[]}}
*/
function generateXML(data) {
let channel = [];
channel.push({title: {_cdata: data.title}});
channel.push({link: data.link});
channel.push({description: {_cdata: data.description || data.title}});
channel.push({language: data.language});
items(data.items, channel);
let _attr = {
'xmlns:yandex': 'http://news.yandex.ru',
'xmlns:media': 'http://search.yahoo.com/mrss/',
'xmlns:turbo': 'http://turbo.yandex.ru',
version: '2.0'
};
return {
rss: [
{_attr: _attr},
{channel: channel}
]
};
}
/**
* @param data
* @returns {*}
*/
function itemData(data) {
return {
title: data.title || '',
description: data.description || '',
image_url: data.image_url,
image_caption: data.image_caption,
url: data.url || data.link,
author: data.author,
date: data.date || data.pubDate,
content: data.content,
menu: data.menu,
related: data.related,
relatedfinity: data.relatedfinity || false,
turboSource: data.turboSource || '',
turboTopic: data.turboTopic || '',
goals: data.goals || [],
turboEnabled: data.turboEnabled !== undefined ? data.turboEnabled: true,
};
}
/**
* Base function
* @param options
* @param items
* @constructor
*/
function TR(options, items) {
options = options || {};
this.title = options.title || '';
this.link = options.link || '';
this.description = options.description || '';
this.language = options.language || 'ru';
this.items = items || [];
this.item = function (data) {
data = data || {};
this.items.push(itemData(data));
return this;
};
this.xml = function () {
return xml(generateXML(this));
};
}
module.exports = TR;

14
readme.md
View File

@ -35,24 +35,34 @@ feed.item(itemOptions);
##### itemOptions
* `title` **string** Заголовок страницы.
* `subheading` _optional_ **string** Подзаголовок страницы.
* `image_url` _optional_ **url string** Адрес изображения, которое используется в качестве обложки. Изображение может быть в любом формате.
* `image_caption` _optional_ **string** Подпись к изображению обложки.
* `link` **url string** URL страницы сайта, для которой нужно сформировать Турбо-страницу.
* `author` _optional_ **string** Автор статьи, размещенной на странице.
* `date` или `pubDate` **string** Время публикации контента на сайте источника. Передается в формате RFC-822.
* `content` **string** Содержимое страницы
* `menu` _optional_ **array** Внимание! Меню будет отображаться только в том случае, если в настройках на странице Яндекс Вебмастер -> Турбо-страницы -> Настройки, содержимое 'Меню Турбо-страниц' пустое!
* `breadcrumbs` _optional_ **array** Навигационная ссылка https://yandex.ru/dev/turbo/doc/rss/elements/header.html#breadcrumbs
* `related` _optional_ **array** Аффилированные ссылки `yandex:related` в конце статьи. Вы можете разместить ссылки на другие ресурсы или настроить отображение непрерывной ленты статей, реализованной, например с помощью AJAX.
* `relatedfinity` _optional_ **bool** Непрерывная лента статей
* `relatednfinity` _optional_ **bool** Непрерывная лента статей (Параметр был переименован из relatedfinity)
* `turboSource` _optional_ **string** URL страницы-источника, который можно передать в Яндекс.Метрику.
* `turboTopic` _optional_ **string** Заголовок страницы, который можно передать в Яндекс.Метрику.
* `goals` _optional_ **array** массив типа: { _id_ - внутренний идентификатор цели (turbo-goal-id), _name_ - имя цели, _counter_id_ - id счётчика яндекс-метрики }
* `turboEnabled`_optional_ **bool** Принудительная установка атрибута "turbo". По умолчанию true. Установка в false позволит скрыть отображение турбо-страницы
###### menu array
menu должен содержать массив объектов со следующими опциями:
* `link` **url string** ссылка
* `text` **string** текст ссылки. не должен содержать html
###### breadcrumbs array
Один элемент хлебных крошек должен содержать массив объектов со следующими опциями:
* `link` **url string** ссылка
* `text` **string** текст ссылки (не должен содержать html)
###### related array
related должен содержать массив объектов со следующими опциями:

1
test/expectedOutput/breadcrumbs.xml Normal file
View File

@ -0,0 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>https://example.com/soups/with-potatoes/</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="https://example.com/example.png" /></figure><h1>Суп с картофелем</h1><div data-block="breadcrumblist"><a href="https://example.com/">Главная</a><a href="https://example.com/soups/">Супы</a><a href="https://example.com/soups/with-potatoes/">Суп с картофелем</a></div></header><p>Для приготовления супа с картофелем, возьмите</p>]]></turbo:content></item></channel></rss>

2
test/expectedOutput/defaultItem.xml
View File

@ -1 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link></link><turbo:content><![CDATA[<header> <h1></h1></header>undefined]]></turbo:content></item></channel></rss>
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link></link><turbo:content><![CDATA[<header><h1></h1></header>undefined]]></turbo:content></item></channel></rss>

2
test/expectedOutput/defaultItemTurboFalse.xml
View File

@ -1 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="false"><link></link><turbo:content><![CDATA[<header> <h1></h1></header>undefined]]></turbo:content></item></channel></rss>
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="false"><link></link><turbo:content><![CDATA[<header><h1></h1></header>undefined]]></turbo:content></item></channel></rss>

2
test/expectedOutput/defaultOneItem.xml
View File

@ -1 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title/><link></link><description/><language>ru</language><item turbo="true"><link></link><turbo:content><![CDATA[<header> <h1></h1></header>undefined]]></turbo:content></item></channel></rss>
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title/><link></link><description/><language>ru</language><item turbo="true"><link></link><turbo:content><![CDATA[<header><h1></h1></header>undefined]]></turbo:content></item></channel></rss>

1
test/expectedOutput/defaultTwoItem.xml Normal file
View File

@ -0,0 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title/><link></link><description/><language>ru</language><item turbo="true"><link></link><turbo:content><![CDATA[<header><h1></h1></header>undefined]]></turbo:content></item><item turbo="true"><link></link><turbo:content><![CDATA[<header><h1></h1></header>undefined]]></turbo:content></item></channel></rss>

2
test/expectedOutput/goal.xml
View File

@ -1 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>vvm.space</author><turbo:goal type="yandex" turbo-goal-id="turbo-goal-id" name="order" id="12345"/><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure> <h1>item title</h1></header><p>hello</p>]]></turbo:content><yandex:related><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item></channel></rss>
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>vvm.space</author><turbo:goal type="yandex" turbo-goal-id="turbo-goal-id" name="order" id="12345"/><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure><h1>item title</h1></header><p>hello</p>]]></turbo:content><yandex:related><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item></channel></rss>

1
test/expectedOutput/imageCaption.xml Normal file
View File

@ -0,0 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /><figcaption>this is image caption</figcaption></figure><h1>item title</h1></header><p>hello</p>]]></turbo:content><yandex:related><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item></channel></rss>

2
test/expectedOutput/menu.xml
View File

@ -1 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure> <h1>item title</h1><menu><a href="http://example.com/">Главная</a><a href="http://example.com/about">О сайте</a></menu></header><p>hello</p>]]></turbo:content><yandex:related type="infinity"><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item><item turbo="true"><link></link><turbo:content><![CDATA[<header> <h1></h1></header>undefined]]></turbo:content></item></channel></rss>
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure><h1>item title</h1><menu><a href="http://example.com/">Главная</a><a href="http://example.com/about">О сайте</a></menu></header><p>hello</p>]]></turbo:content><yandex:related type="infinity"><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item><item turbo="true"><link></link><turbo:content><![CDATA[<header><h1></h1></header>undefined]]></turbo:content></item></channel></rss>

2
test/expectedOutput/relatedItem.xml
View File

@ -1 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure> <h1>item title</h1></header><p>hello</p>]]></turbo:content><yandex:related><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item></channel></rss>
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure><h1>item title</h1></header><p>hello</p>]]></turbo:content><yandex:related><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item></channel></rss>

2
test/expectedOutput/relatedItemInfinity.xml
View File

@ -1 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure> <h1>item title</h1></header><p>hello</p>]]></turbo:content><yandex:related type="infinity"><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item></channel></rss>
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link>http://example.com/article4?this&amp;that</link><pubDate>Sat, 26 May 2018 21:00:00 GMT</pubDate><author>LightAir</author><turbo:content><![CDATA[<header><figure><img src="http://example.com/example.png" /></figure><h1>item title</h1></header><p>hello</p>]]></turbo:content><yandex:related type="infinity"><link url="http://example.com/related/post1" img="http://example.com/i/img1.jpg">related link text 1</link><link url="http://example.com/related/post2" img="http://example.com/i/img2.jpg">related link text 2</link></yandex:related></item></channel></rss>

1
test/expectedOutput/subheading.xml Normal file
View File

@ -0,0 +1 @@
<rss xmlns:yandex="http://news.yandex.ru" xmlns:media="http://search.yahoo.com/mrss/" xmlns:turbo="http://turbo.yandex.ru" version="2.0"><channel><title><![CDATA[title]]></title><link>http://example.com/rss.xml</link><description><![CDATA[description]]></description><language>ru</language><item turbo="true"><link></link><turbo:content><![CDATA[<header><h1>item title</h1><h2>Subheading</h2></header>undefined]]></turbo:content></item></channel></rss>

94
test/index.js
View File

@ -24,16 +24,33 @@ const relatedOptions = [{
require('mockdate').set('Wed, 10 Dec 2014 19:04:57 GMT');
test('empty feed', function (t) {
t.plan(2);
let feed = new TR();
t.plan(3);
const feed = new TR();
t.equal(feed.xml(), expectedOutput.default.trim());
feed.item();
t.equal(feed.xml(), expectedOutput.defaultOneItem.trim());
feed.item();
t.equal(feed.xml(), expectedOutput.defaultTwoItem.trim());
});
test('empty feed constructor', function (t) {
t.plan(1);
const feed = new TR(
{},
[{}, {}]
);
t.equal(feed.xml(), expectedOutput.defaultTwoItem.trim());
});
test('default item', function (t) {
t.plan(1);
let feed = new TR(baseOptions);
const feed = new TR(baseOptions);
feed.item({});
@ -42,7 +59,7 @@ test('default item', function (t) {
test('related item', function (t) {
t.plan(1);
let feed = new TR(baseOptions);
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@ -60,7 +77,7 @@ test('related item', function (t) {
test('related item', function (t) {
t.plan(1);
let feed = new TR(baseOptions);
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@ -69,7 +86,7 @@ test('related item', function (t) {
author: 'LightAir',
date: 'May 27, 2018 00:00 AM',
content: '<p>hello</p>',
relatedfinity: true,
relatedInfinity: true,
related: relatedOptions
});
@ -78,7 +95,7 @@ test('related item', function (t) {
test('menu', function (t) {
t.plan(1);
let feed = new TR(baseOptions);
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@ -87,7 +104,7 @@ test('menu', function (t) {
author: 'LightAir',
date: 'May 27, 2018 00:00 AM',
content: '<p>hello</p>',
relatedfinity: true,
relatedInfinity: true,
menu: [{
link: 'http://example.com/',
text: 'Главная',
@ -103,9 +120,9 @@ test('menu', function (t) {
t.equal(feed.xml(), expectedOutput.menu.trim());
});
test('goals', function (t) {
test('goals', function (t) {
t.plan(1);
let feed = new TR(baseOptions);
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@ -126,3 +143,60 @@ test('goals', function (t) {
t.equal(feed.xml(), expectedOutput.goal.trim());
});
test('image caption', function (t) {
t.plan(1);
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
image_url: 'http://example.com/example.png',
image_caption: 'this is image caption',
url: 'http://example.com/article4?this&that',
author: 'LightAir',
date: 'May 27, 2018 00:00 AM',
menu: '<a href="http://example.com/page1.html">Текст ссылки</a> <a href="http://example.com/page2.html">Текст ссылки</a>',
content: '<p>hello</p>',
related: relatedOptions
});
t.equal(feed.xml(), expectedOutput.imageCaption.trim());
});
test('subheading', function (t) {
t.plan(1);
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
subheading: 'Subheading',
});
t.equal(feed.xml(), expectedOutput.subheading.trim());
});
test('breadcrumbs', function (t) {
t.plan(1);
const feed = new TR(baseOptions);
feed.item({
title: 'Суп с картофелем',
image_url: 'https://example.com/example.png',
breadcrumbs: [{
link: 'https://example.com/',
text: 'Главная',
}, {
link: 'https://example.com/soups/',
text: 'Супы',
}, {
link: 'https://example.com/soups/with-potatoes/',
text: 'Суп с картофелем'
}],
url: 'https://example.com/soups/with-potatoes/',
author: 'LightAir',
date: 'May 27, 2018 00:00 AM',
content: '<p>Для приготовления супа с картофелем, возьмите</p>'
});
t.equal(feed.xml(), expectedOutput.breadcrumbs.trim());
});