10 Commits
1.2.1 ... 2.0.0

Author SHA1 Message Date
LightAir
83f2045b23 Изменение версии пакета 2021-08-29 02:25:18 +03:00
LightAir
01aa654b03 Рефакторинг. Дорабавление новых опций. 2021-08-29 02:19:59 +03:00
Nikita Kornilov
c676a924b0 Add support for image captions. (#7)
* Add support for image caption.

* Add support for image_caption prop.
2021-08-28 23:26:26 +03:00
LightAir
7aceeeaa36 Возврат covearge 2021-06-09 22:45:40 +03:00
LightAir
9cccd65768 Обновление версии пакета 2021-06-09 22:27:19 +03:00
LightAir
812a429d9b Удаление лишних dev пакетов. Удаление dev пакетов с уязвимостями 2021-06-09 22:17:08 +03:00
LightAir
15c9715cee Merge pull request #6 from Armanio/patch-1
chore(docs): typo fix in readme
2021-06-04 21:47:12 +03:00
Arman
816b6b5690 chore(docs): typo fix in readme 2021-06-04 15:17:36 +03:00
LightAir
ef90f974bd Изменение тестов 2020-12-15 22:51:02 +03:00
LightAir
8aa086865d Изменение тестов 2020-12-15 22:47:51 +03:00
16 changed files with 358 additions and 297 deletions

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"
}
}

View File

@@ -1,6 +1,37 @@
'use strict';
const xml = require('xml');
const baseXml = require('xml');
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);
});
}
}
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
@@ -9,7 +40,7 @@ const xml = require('xml');
* @param array
* @param data
*/
function pushIfConditionTrue(condition, array, data) {
pushIfConditionTrue(condition, array, data) {
if (condition) {
array.push(data);
}
@@ -20,8 +51,8 @@ function pushIfConditionTrue(condition, array, data) {
* @param itemValues
* @param relatedInfinity
*/
function addRelated(related, itemValues, relatedInfinity) {
let relatedResult = related.map(function (rel) {
addRelated(related, itemValues, relatedInfinity) {
const relatedResult = related.map(function (rel) {
return {
link: [{
_attr: {
@@ -38,14 +69,14 @@ function addRelated(related, itemValues, relatedInfinity) {
});
}
pushIfConditionTrue(related, itemValues, {'yandex:related': relatedResult});
this.pushIfConditionTrue(related, itemValues, {'yandex:related': relatedResult});
}
/**
* @param item
* @param itemValues
*/
function pushGoals(item, itemValues) {
pushGoals(item, itemValues) {
if (item.goals.length > 0) {
item.goals.forEach(goal => itemValues.push({
'turbo:goal': {
@@ -60,42 +91,74 @@ function pushGoals(item, itemValues) {
}
}
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
*/
function items(items, channel) {
itemsProcessing(items, channel) {
const self = this;
items.forEach(function (item) {
let itemValues = [];
const 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});
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});
let img = '', menu = '';
const fullContent = `<header>${self.getImageContent(item)}<h1>${item.title}</h1>${self.getSubheading(item)}${self.getMenu(item)}${self.getBreadcrumbs(item)}</header>${item.content}`;
if (item.image_url) {
img = '<figure><img src="' + item.image_url + '" /></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);
self.pushGoals(item, itemValues);
itemValues.push({'turbo:content': {_cdata: fullContent}});
if (typeof item.related !== 'undefined') {
addRelated(item.related, itemValues, item.relatedfinity);
self.addRelated(item.related, itemValues, item.relatedInfinity);
}
channel.push({item: itemValues});
@@ -103,21 +166,22 @@ function items(items, channel) {
}
/**
* @param data
* @param options
*
* @returns {{rss: *[]}}
*/
function generateXML(data) {
generateXML(options) {
let channel = [];
const 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});
channel.push({title: {_cdata: options.title}});
channel.push({link: options.link});
channel.push({description: {_cdata: options.description}});
channel.push({language: options.language});
items(data.items, channel);
this.itemsProcessing(options.items, channel);
let _attr = {
const _attr = {
'xmlns:yandex': 'http://news.yandex.ru',
'xmlns:media': 'http://search.yahoo.com/mrss/',
'xmlns:turbo': 'http://turbo.yandex.ru',
@@ -136,49 +200,26 @@ function generateXML(data) {
* @param data
* @returns {*}
*/
function itemData(data) {
itemData(data) {
return {
title: data.title || '',
description: data.description || '',
image_url: data.image_url,
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,
menu: data.menu || [],
breadcrumbs: data.breadcrumbs || [],
related: data.related,
relatedfinity: data.relatedfinity || false,
relatedInfinity: data.relatedInfinity || 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;

View File

@@ -1,6 +1,6 @@
{
"name": "turbo-rss",
"version": "1.2.1",
"version": "2.0.0",
"description": "RSS based, feed generator for Yandex turbo",
"keywords": [
"yandex",
@@ -10,7 +10,7 @@
],
"main": "lib/index",
"scripts": {
"test": "tape test --tap | tap-difflet",
"test": "tape test --tap | tap-min",
"coverage": "istanbul cover tape test -- -R spec"
},
"homepage": "https://github.com/LightAir/turbo-rss",
@@ -56,27 +56,12 @@
"xml": "1.0.1"
},
"devDependencies": {
"eslint": "^4.19.1",
"folderify": "^1.1.0",
"grunt": "^0.4.5",
"grunt-cli": "^0.1.13",
"grunt-contrib-jshint": "^0.11.3",
"grunt-release": "^0.13.0",
"grunt-templates-dylang": "^1.0.10",
"eslint": "^7.28.0",
"include-folder": "^1.0.0",
"load-grunt-tasks": "^3.3.0",
"mockdate": "^1.0.3",
"prova": "^2.1.2",
"q": "^1.4.1",
"tap-difflet": "^0.4.0",
"tape": "^4.2.1",
"time-grunt": "^1.2.1",
"xml2js": "^0.4.12"
},
"browserify": {
"transform": [
"folderify"
]
"mockdate": "^3.0.5",
"q": "^1.5.1",
"tap-min": "~2.0.0",
"tape": "^5.2.2"
},
"license": "MIT"
}

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 должен содержать массив объектов со следующими опциями:
@@ -97,7 +107,7 @@ feed.item({
}, {
link: 'http://example.com/about',
text: 'О сайте'
}]
}],
related: [{
link: 'http://example.com/related/post1',
image_url: 'http://example.com/i/img1.jpg',

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>

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>

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>

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>

View File

@@ -1,60 +1,65 @@
/*
* use npm test to run tests
*/
const test = require('tape');
const TR = require('..');
const includeFolder = require('include-folder');
const expectedOutput = includeFolder(__dirname + '/expectedOutput', /.*\.xml$/);
require('mockdate').set('Wed, 10 Dec 2014 19:04:57 GMT');
test('empty feed', function (t) {
t.plan(2);
let feed = new TR();
t.equal(feed.xml(), expectedOutput.default.trim());
feed.item();
t.equal(feed.xml(), expectedOutput.defaultOneItem.trim());
});
test('default item', function (t) {
t.plan(1);
let feed = new TR({
const baseOptions = {
title: 'title',
description: 'description',
link: 'http://example.com/rss.xml',
site_url: 'http://example.com'
};
const relatedOptions = [{
link: 'http://example.com/related/post1',
image_url: 'http://example.com/i/img1.jpg',
text: 'related link text 1'
}, {
link: 'http://example.com/related/post2',
image_url: 'http://example.com/i/img2.jpg',
text: 'related link text 2'
}];
require('mockdate').set('Wed, 10 Dec 2014 19:04:57 GMT');
test('empty feed', function (t) {
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);
const feed = new TR(baseOptions);
feed.item({});
t.equal(feed.xml(), expectedOutput.defaultItem.trim());
});
test('default item turbo false', function (t) {
t.plan(1);
let feed = new TR({
title: 'title',
description: 'description',
link: 'http://example.com/rss.xml',
site_url: 'http://example.com',
});
feed.item({
turboEnabled: false
});
t.equal(feed.xml(), expectedOutput.defaultItemTurboFalse.trim());
});
test('related item', function (t) {
t.plan(1);
let feed = new TR({
title: 'title',
description: 'description',
link: 'http://example.com/rss.xml',
site_url: 'http://example.com'
});
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@@ -64,15 +69,7 @@ test('related item', function (t) {
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: [{
link: 'http://example.com/related/post1',
image_url: 'http://example.com/i/img1.jpg',
text: 'related link text 1'
}, {
link: 'http://example.com/related/post2',
image_url: 'http://example.com/i/img2.jpg',
text: 'related link text 2'
}]
related: relatedOptions
});
t.equal(feed.xml(), expectedOutput.relatedItem.trim());
@@ -80,12 +77,7 @@ test('related item', function (t) {
test('related item', function (t) {
t.plan(1);
let feed = new TR({
title: 'title',
description: 'description',
link: 'http://example.com/rss.xml',
site_url: 'http://example.com'
});
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@@ -94,16 +86,8 @@ test('related item', function (t) {
author: 'LightAir',
date: 'May 27, 2018 00:00 AM',
content: '<p>hello</p>',
relatedfinity: true,
related: [{
link: 'http://example.com/related/post1',
image_url: 'http://example.com/i/img1.jpg',
text: 'related link text 1'
}, {
link: 'http://example.com/related/post2',
image_url: 'http://example.com/i/img2.jpg',
text: 'related link text 2'
}]
relatedInfinity: true,
related: relatedOptions
});
t.equal(feed.xml(), expectedOutput.relatedItemInfinity.trim());
@@ -111,12 +95,7 @@ test('related item', function (t) {
test('menu', function (t) {
t.plan(1);
let feed = new TR({
title: 'title',
description: 'description',
link: 'http://example.com/rss.xml',
site_url: 'http://example.com'
});
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@@ -125,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: 'Главная',
@@ -133,15 +112,7 @@ test('menu', function (t) {
link: 'http://example.com/about',
text: 'О сайте',
}],
related: [{
link: 'http://example.com/related/post1',
image_url: 'http://example.com/i/img1.jpg',
text: 'related link text 1'
}, {
link: 'http://example.com/related/post2',
image_url: 'http://example.com/i/img2.jpg',
text: 'related link text 2'
}]
related: relatedOptions
});
feed.item({});
@@ -151,12 +122,7 @@ test('menu', function (t) {
test('goals', function (t) {
t.plan(1);
let feed = new TR({
title: 'title',
description: 'description',
link: 'http://example.com/rss.xml',
site_url: 'http://example.com'
});
const feed = new TR(baseOptions);
feed.item({
title: 'item title',
@@ -166,22 +132,71 @@ test('goals', function (t) {
date: 'May 27, 2018 00:00 AM',
menu: '<a href="http://example.com/page1.html">Текст ссылки</a> <a href="http://example.com/page2.html">Текст ссылки</a>',
goals: [{
type: "yandex",
id: "turbo-goal-id",
counter_id: "12345",
name: "order",
type: 'yandex',
id: 'turbo-goal-id',
counter_id: '12345',
name: 'order',
}],
content: '<p>hello</p>',
related: [{
link: 'http://example.com/related/post1',
image_url: 'http://example.com/i/img1.jpg',
text: 'related link text 1'
}, {
link: 'http://example.com/related/post2',
image_url: 'http://example.com/i/img2.jpg',
text: 'related link text 2'
}]
related: relatedOptions
});
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());
});