Публикация в npmjs версии 1.0.7

Добавлена опция relatedfinity для формирования непрерывной ленты статей
Добавление codeclimate
2026-02-04 12:06:20 +00:00 · 2018-05-30 14:56:56 +03:00 · 2018-05-30 14:53:25 +03:00 · 2018-05-30 14:13:01 +03:00 · 2018-05-30 13:55:05 +03:00 · 2018-05-30 12:18:15 +03:00
13 changed files with 224 additions and 126 deletions
--- a/.codeclimate.yml
+++ b/.codeclimate.yml
@@ -0,0 +1,5 @@
+plugins:
+  eslint:
+    enabled: true
+    config:
+      config: .eslintrc.json
--- a/.editorconfig
+++ b/.editorconfig
@@ -1,16 +0,0 @@
-# Get the plugin for your editor and your
-# tab settings will be set automatically.
-# http://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with no newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = false
-
-# Indentation override for all JS under lib directory
-[*.js]
-indent_style = space
-indent_size = 4
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -0,0 +1,28 @@
+{
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "sourceType": "module"
+    },
+    "rules": {
+        "indent": [
+            "error",
+            4
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ]
+    }
+}
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 node_modules
 package-lock.json
 *.log
+coverage/
--- a/.jshintrc
+++ b/.jshintrc
@@ -1,14 +0,0 @@
-{
-  "esversion":6,
-  "curly": true,
-  "eqeqeq": true,
-  "immed": true,
-  "latedef": true,
-  "newcap": true,
-  "noarg": true,
-  "sub": true,
-  "undef": true,
-  "boss": true,
-  "eqnull": true,
-  "node": true
-}
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,11 +1,21 @@
 language: node_js
 sudo: false
+addons:
+  code_climate:
+    repo_token:
+      secure: "Lz3KeRxbJ877gDe0kWNdAg3erDe4TVruP98Xes18N13H8XGyIdWs2GnJiRHHS831tCd3yYu5F643xNXJuQ3omWikvRVr0lu57yBdJVg0dhJwjEnP85DRIU3YmGAe4Ua5qNoMlhZMyZwL6TTHWt30SZ2NK/HmYOr+fI0/H8OTWtrxcMlwYYZkbmhllGAYWnXnZCOCHuIcio7L21pEX/PXtrQMTVNFuebT2Q8GihjoW00KeH8z4t7E+a7MFb427dX7MRYGHHGuu2dAUoDI/P5tz7FIQg83Uz4Jmnzh34Wc9uYLd5lTcRc6Mb7mOVHXO9ZLoVtxE7gB+apN+NkzhPhZjQToyvypwyzUZiHV9xtYj9abUuU5vXEdGTA4+KEy7iM25r7U1cqsVVWsXBckpEpprlvJ2FQbbajP9PZpvnSwFmbPDGFJf2uPs07xtav1F6fpAU9zSg8J+iagS9grmCccNcs4TrExWRCFLRupN2AC9SeLWCb2ux+3IMuqwNkJiiWYNzLMOHru2kxFGgc7+wd3bzREbgZJbYUHCmVchHVcUT2/dn240mSVnLoemP1z91VdxbUN3EwR0Hcp5LnTMqCSQ880QUmFjDFnd0huKXKrKrr61na/wVoUDrcQGg/DKgvGcDm6CqzeHfSM9EHqwbbYx4cZn36ZA1nDiNTMLSxHhn0="
+script: npm run coverage
+before_script:
+  - export TZ=Europe/Moscow
+  - date
+  - npm install codeclimate-test-reporter istanbul -g
+after_script:
+  - codeclimate-test-reporter < ./coverage/lcov.info
 matrix:
  include:
-    - node_js: '0.10'
+    - node_js: '8.11.2'
      before_install: npm -g i npm@2
-    - node_js: '0.12'
+    - node_js: '6.11.2'
      before_install: npm -g i npm@2
-    - node_js: '4'
+    - node_js: '10.2.1'
      before_install: npm -g i npm@2
-
--- a/Gruntfile.js
+++ b/Gruntfile.js
@@ -1,51 +0,0 @@
-'use strict';
-
-module.exports = function(grunt) {
-
-    /**
-     * grunt release or grunt release:patch increment the patch number
-     * grunt release:minor increments the minor version number
-     * grunt release:major increments the major version number
-     *
-
-     * grunt readme to generate the readme (you might need to do grunt repos first)
-     */
-
-
-    require('time-grunt')(grunt);
-
-    grunt.initConfig({
-        jshint: {
-            options: {
-                jshintrc: '.jshintrc'
-            },
-            all: [
-                'Gruntfile.js',
-                'lib/**/*.js',
-                'test/**/*.js'
-            ]
-        },
-        release: {
-            github: {
-                repo: 'dylang/node-rss',
-                accessTokenVar: 'GITHUB_ACCESS_TOKEN'
-            }
-        }
-    });
-
-    require('load-grunt-tasks')(grunt);
-
-    grunt.registerTask('lint', [
-        'jshint'
-    ]);
-
-    grunt.registerTask('default', [
-        'lint'
-    ]);
-
-    grunt.registerTask('pre-publish', [
-        'lint',
-        'repos',
-        'readme'
-    ]);
-};
--- a/lib/index.js
+++ b/lib/index.js
@@ -2,31 +2,57 @@

 const xml = require('xml');

-function ifTruePush(bool, array, data) {
-    if (bool) {
+/**
+ * Check first argument. If true - push last argument to second argument
+ * @param condition
+ * @param array
+ * @param data
+ */
+function ifTruePush(condition, array, data) {
+    if (condition) {
        array.push(data);
    }
 }

-function generateXML(data) {
+/**
+ * @param related
+ * @param itemValues
+ * @param relatedfinity
+ */
+function addRelated(related, itemValues, relatedfinity) {
+    let relatedResult = related.map(function (rel) {
+        return {
+            link: [{
+                _attr: {
+                    'url': rel.link,
+                    'img': rel.image_url
+                }
+            }, rel.text]
+        };
+    });

-    let channel = [];
+    if (relatedfinity) {
+        relatedResult.push({
+            _attr: {'type': 'infinity'}
+        });
+    }

-    channel.push({title: {_cdata: data.title}});
-    channel.push({link: data.link || 'http://github.com/LightAir/turbo-rss'});
-    channel.push({description: {_cdata: data.description || data.title}});
-    channel.push({language: 'ru'});
-
-    data.items.forEach(function (item) {
+    ifTruePush(related, itemValues, {'yandex:related': relatedResult});
+}

+/**
+ * Items processing
+ * @param items
+ * @param channel
+ */
+function items(items, channel) {
+    items.forEach(function (item) {
        let item_values = [];
-
        item_values.push({_attr: {'turbo': 'true'}});
-
        item_values.push({link: item.url});
        item_values.push({'turbo:source': item.url});

-        ifTruePush(item.date, item_values, {pubDate: new Date(item.date).toGMTString()});
+        ifTruePush(item.date, item_values, {pubDate: new Date(item.date).toUTCString()});
        ifTruePush(item.author, item_values, {author: item.author});

        let img = '';
@@ -43,9 +69,29 @@ function generateXML(data) {
        let fullContent = '<header>' + img + ' <h1>' + item.title + '</h1>' + menu + '</header>' + item.content;

        item_values.push({'turbo:content': {_cdata: fullContent}});
-        channel.push({item: item_values});

+        if (typeof item.related !== 'undefined') {
+            addRelated(item.related, item_values, item.relatedfinity);
+        }
+
+        channel.push({item: item_values});
    });
+}
+
+/**
+ * @param data
+ * @returns {{rss: *[]}}
+ */
+function generateXML(data) {
+
+    let channel = [];
+
+    channel.push({title: {_cdata: data.title}});
+    channel.push({link: data.link || 'http://github.com/LightAir/turbo-rss'});
+    channel.push({description: {_cdata: data.description || data.title}});
+    channel.push({language: 'ru'});
+
+    items(data.items, channel);

    let _attr = {
        'xmlns:yandex': 'http://news.yandex.ru',
@@ -62,6 +108,12 @@ function generateXML(data) {
    };
 }

+/**
+ * Base function
+ * @param options
+ * @param items
+ * @constructor
+ */
 function YTurbo(options, items) {
    options = options || {};

@@ -70,17 +122,19 @@ function YTurbo(options, items) {
    this.link = options.link;
    this.items = items || [];

-    this.item = function (options) {
-        options = options || {};
+    this.item = function (data) {
+        data = data || {};
        let item = {
-            title: options.title || 'No title',
-            description: options.description || '',
-            image_url: options.image_url,
-            url: options.url,
-            author: options.author,
-            date: options.date || options.pubDate,
-            content: options.content,
-            menu: options.menu
+            title: data.title || 'No title',
+            description: data.description || '',
+            image_url: data.image_url,
+            url: data.url,
+            author: data.author,
+            date: data.date || data.pubDate,
+            content: data.content,
+            menu: data.menu,
+            related: data.related,
+            relatedfinity: data.relatedfinity || false,
        };

        this.items.push(item);
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "turbo-rss",
-  "version": "1.0.4",
+  "version": "1.0.7",
  "description": "RSS based, feed generator for Yandex turbo",
  "keywords": [
    "yandex",
@@ -11,8 +11,7 @@
  "main": "lib/index",
  "scripts": {
    "test": "tape test --tap | tap-difflet",
-    "lint": "grunt lint",
-    "test:browser": "prova -b"
+    "coverage": "istanbul cover tape test -- -R spec"
  },
  "homepage": "https://github.com/LightAir/turbo-rss",
  "author": {
@@ -56,6 +55,7 @@
    "xml": "1.0.1"
  },
  "devDependencies": {
+    "eslint": "^4.19.1",
    "folderify": "^1.1.0",
    "grunt": "^0.4.5",
    "grunt-cli": "^0.1.13",
--- a/readme.md
+++ b/readme.md
@@ -2,10 +2,11 @@

 ## turbo-rss

+[![Maintainability](https://api.codeclimate.com/v1/badges/6525d2aabf20185b68b6/maintainability)](https://codeclimate.com/github/LightAir/turbo-rss/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/6525d2aabf20185b68b6/test_coverage)](https://codeclimate.com/github/LightAir/turbo-rss/test_coverage)
 [![Build Status](https://travis-ci.org/LightAir/turbo-rss.svg)](https://travis-ci.org/LightAir/turbo-rss)
-![npm](https://img.shields.io/npm/v/npm.svg)
-![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg)
-
+[![npm](https://img.shields.io/badge/npm%20package-1.0.7-blue.svg?longCache=true&style=flat)](https://www.npmjs.com/package/turbo-rss)
+![license](https://img.shields.io/packagist/l/doctrine/orm.svg?longCache=true&style=flat)

 >Генератор RSS разметки для сервиса Турбо-страницы

@@ -44,8 +45,17 @@ feed.item(itemOptions);
 * `author` _optional_  **string**  Автор статьи, размещенной на странице.
 * `date` **string** Время публикации контента на сайте источника.
 * `content` **string** Содержимое страницы
+ * `related` _optional_ **array** Аффилированные ссылки `yandex:related` в конце статьи.
+ * `relatedfinity` _optional_  **bool** Непрерывная лента статей
 
- *Будет добавлено в новых версиях turbo:source, turbo:topic, yandex:related, menu, pubDate как алиас date*
+ *Будет добавлено в новых версиях turbo:source, turbo:topic, menu, pubDate как алиас date*
+ 
+###### related array
+  related должен содержать массив объектов со следующими опциями:
+  
+  * `link` **string** ссылка на статью'
+  * `image_url` **string** ссылка на изображение к статье
+  * `text` **string** текст ссылки
 
 ##### Получение XML

@@ -73,7 +83,16 @@ feed.item({
    url: 'http://example.com/article4?this&that',
    author: 'LightAir',
    date: 'May 27, 2012',
-    content: '<p>hello</p>'
+    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'
+    }]
 });

 // cache the xml to send to clients
--- a/test/expectedOutput/relatedItem.xml
+++ b/test/expectedOutput/relatedItem.xml
@@ -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><turbo:source>http://example.com/article4?this&amp;that</turbo:source><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/page1.html">Текст ссылки</a> <a href="http://example.com/page2.html">Текст ссылки</a></menu></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>
--- a/test/expectedOutput/relatedItemInfinity.xml
+++ b/test/expectedOutput/relatedItemInfinity.xml
@@ -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><turbo:source>http://example.com/article4?this&amp;that</turbo:source><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>
--- a/test/index.js
+++ b/test/index.js
@@ -1,27 +1,25 @@
 // prova is a wrapper for tape
 // use npm run test:browser to run tests in a browser
-var test = require('tape');
+const test = require('tape');

-var YTurbo = require('..');
+const YTurbo = require('..');

-var includeFolder = require('include-folder');
-var expectedOutput = includeFolder(__dirname + '/expectedOutput', /.*\.xml$/);
+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);
-    var feed = new YTurbo();
+    let feed = new YTurbo();
    t.equal(feed.xml(), expectedOutput.default.trim());
    feed.item();
    t.equal(feed.xml(), expectedOutput.defaultOneItem.trim());
 });

 test('default item', function(t) {
-
    t.plan(1);
-
-    var feed = new YTurbo({
+    let feed = new YTurbo({
        title: 'title',
        description: 'description',
        link: 'http://example.com/rss.xml',
@@ -32,3 +30,65 @@ test('default item', function(t) {

    t.equal(feed.xml(), expectedOutput.defaultItem.trim());
 });
+
+test('related item', function(t) {
+    t.plan(1);
+    let feed = new YTurbo({
+        title: 'title',
+        description: 'description',
+        link: 'http://example.com/rss.xml',
+        site_url: 'http://example.com'
+    });
+
+    feed.item({
+        title:  'item title',
+        image_url: 'http://example.com/example.png',
+        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: [{
+            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'
+        }]
+    });
+
+    t.equal(feed.xml(), expectedOutput.relatedItem.trim());
+});
+
+test('related item', function(t) {
+    t.plan(1);
+    let feed = new YTurbo({
+        title: 'title',
+        description: 'description',
+        link: 'http://example.com/rss.xml',
+        site_url: 'http://example.com'
+    });
+
+    feed.item({
+        title:  'item title',
+        image_url: 'http://example.com/example.png',
+        url: 'http://example.com/article4?this&that',
+        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'
+        }]
+    });
+
+    t.equal(feed.xml(), expectedOutput.relatedItemInfinity.trim());
+});
Author	SHA1	Message	Date
la	8645a88b01	Публикация в npmjs версии 1.0.7	2018-05-30 14:56:56 +03:00
la	c65b6ccc12	Добавлена опция relatedfinity для формирования непрерывной ленты статей	2018-05-30 14:53:25 +03:00
la	4b0f033aa9	Добавление codeclimate	2018-05-30 14:13:01 +03:00
la	86678c6448	Добавление codeclimate	2018-05-30 13:55:05 +03:00
la	83c8380108	add new version	2018-05-30 12:18:15 +03:00
la	c76f5a522f	cleaning repo	2018-05-30 12:17:22 +03:00
la	415afbc2e3	add bages	2018-05-30 11:29:09 +03:00
la	6819999a2e	Code climate	2018-05-30 11:12:37 +03:00
la	4ddd19e269	Проблема с времнем	2018-05-29 15:54:25 +03:00
la	2a4e3c5083	Изменены версии nodejs для travis	2018-05-29 14:35:32 +03:00
la	b7f6667798	Изменён способ добавления аттрибутов на правильный	2018-05-29 14:24:33 +03:00
la	e1516f9e1b	update readme	2018-05-29 13:19:09 +03:00
la	44d345ac6b	add eslint	2018-05-29 13:13:54 +03:00
LightAir	c5a9e4b5fd	Merge pull request #2 from jahglow/master corrected readme, ++patch	2018-05-29 11:01:54 +03:00
la	97e23fe031	Стилизация. Добавление теста для related	2018-05-29 11:00:33 +03:00
Ivan Pilyugin (aka Archer)	a4b18cde97	added yandex:related	2018-05-29 10:35:37 +03:00
Ivan Pilyugin (aka Archer)	1dca86ab85	corrected readme for yandex:related	2018-05-29 10:34:55 +03:00
Ivan Pilyugin (aka Archer)	8b4ec85bcf	Merge pull request #1 from LightAir/master Merge pull request #1 from jahglow/master	2018-05-29 10:32:52 +03:00
LightAir	b02eaab7e6	Merge pull request #1 from jahglow/master Базовая поддержка yandex:related	2018-05-29 10:07:16 +03:00
Ivan Pilyugin (aka Archer)	10e74b0a1b	yandex:related image renamed to image_url for naming consistency	2018-05-29 10:04:50 +03:00
Ivan Pilyugin (aka Archer)	c47a6d3d0f	Update readme.md added description to yandex:related	2018-05-29 10:03:41 +03:00
Ivan Pilyugin (aka Archer)	365abd5592	added yandex:related support	2018-05-29 09:58:53 +03:00
				`@@ -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&that</link><turbo:source>http://example.com/article4?this&that</turbo:source><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/page1.html">Текст ссылки</a> <a href="http://example.com/page2.html">Текст ссылки</a></menu></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>