[JetBrains] Plugin version badge #1164

ice1000 · 2017-10-12T19:00:44Z

It should be look like:

I don't have a node.js local environment. If test fail please do tell me.

ice1000 · 2017-10-12T19:01:45Z

Related issue #1162

platan · 2017-10-12T19:08:11Z

server.js

@@ -6577,6 +6577,48 @@ cache(function(data, match, sendBadge, request) {
  });
 }));

+// JetBrains Plugins repository version integration
+camp.route(/^\/jetbrains\/plugin\/(v)\/([^\/]+)\.(svg|png|gif|jpg|json)$/,


Most of the code is identical with code from downloads badge (cause we are using the same API resource). Maybe we should have one function handling this?

So how to do that? This is the first day I use JavaScript to develop 😢

We can have one camp.route with (d|v). switch statement should be put after checking if plugin is not found. Then handle d and v in this switch. You can use "Packagist integration" as a reference.

platan · 2017-10-12T19:09:01Z

server.js

+            return sendBadge(format, badgeData);
+          }
+          var version = data['plugin-repository'].category[0]["idea-plugin"][0].version[0];
+          badgeData.text[1] = metric(downloads);


There is no downloads variable in this function.

platan · 2017-10-12T19:09:44Z

server.js

+
+      try {
+        switch (type) {
+        case 'd':


We have jetbrains/plugin/v in path.

platan · 2017-10-12T19:11:50Z

service-tests/jetbrains.js

 t.create('downloads (plugin id from plugin.xml)')
  .get('/plugin/d/org.intellij.scala.json')
  .expectJSONTypes(Joi.object().keys({ name: 'downloads', value: isMetric }));

+t.create('downloads (plugin id from plugin.xml)(v)')


Maybe version (plugin id from plugin.xml)?

platan · 2017-10-12T19:12:31Z

service-tests/jetbrains.js

 module.exports = t;

 t.create('downloads (number as a plugin id)')
  .get('/plugin/d/7495.json')
  .expectJSONTypes(Joi.object().keys({ name: 'downloads', value: isMetric }));

+t.create('jetbrains plugin (number as a plugin id)(v)')


Maybe version (number as a plugin id)?

platan · 2017-10-12T19:13:13Z

service-tests/jetbrains.js

 t.create('downloads (user friendly plugin id)')
  .get('/plugin/d/1347-scala.json')
  .expectJSONTypes(Joi.object().keys({ name: 'downloads', value: isMetric }));

+t.create('downloads (user friendly plugin id)(v)')


What do you think about version (user friendly plugin id)

Ahhh.... Wait a minute

platan · 2017-10-12T19:13:56Z

service-tests/jetbrains.js

 t.create('unknown plugin')
  .get('/plugin/d/unknown-plugin.json')
  .expectJSON({ name: 'downloads', value: 'not found' });

+t.create('unknown plugin(v)')


What do you think about version for unknown plugin?

ice1000 · 2017-10-12T19:20:18Z

Why do the tests fail? I think the production code and test code for version is nearly the same as download, but why it fails...

ice1000 · 2017-10-12T19:24:59Z

@platan What about the newest version?

fixed: download -> version
fixed: d -> v

platan · 2017-10-12T20:00:25Z

Build results can be found here https://travis-ci.org/badges/shields/jobs/287207493.
This test failed: 1) JetBrains plugin/version missing required XML attribute(v)
Version is in a separate element, so you do not this test for missing downloads attribute.

platan · 2017-10-12T20:01:43Z

service-tests/jetbrains.js

@@ -93,6 +154,32 @@ t.create('missing required XML attribute')
                 })
  .expectJSON({ name: 'downloads', value: 'invalid' });

+t.create('missing required XML attribute(v)')


You do not need this test. Version value is in version element.

Fixed. How is that now?

ice1000 · 2017-10-12T20:28:05Z

CI check done. Please check and merge. Maybe you need squash and merge? 😉

paulmelnikow · 2017-10-12T20:37:33Z

server.js

+cache(function(data, match, sendBadge, request) {
+  var pluginId = match[2];
+  var type = match[1];
+  var format = match[3];


Since you're not doing anything with type, you can remove it as a capture group in the regular expression. Just remove the parentheses around it. Then change match[2] to match[1] and change match[3] to match[2].

See #1164 (comment)

paulmelnikow · 2017-10-12T20:37:33Z

server.js

+      }
+
+      try {
+        switch (type) {


Since there is only one case you do not need the switch statement at all.

@paulmelnikow maybe you didn't see my comments (they are under "show outdated" right know).
I suggested:
"Most of the code is identical with code from downloads badge (cause we are using the same API resource). Maybe we should have one function handling this?" and "We can have one camp.route with (d|v). switch statement should be put after checking if plugin is not found. Then handle d and v in this switch. You can use "Packagist integration" as a reference."

What do you think about this?

I see what you mean. Yes, I agree. Combining this into one route seems like a much better approach.

So should I do this?

Nevermind. I've done this.

paulmelnikow · 2017-10-12T20:37:33Z

service-tests/jetbrains.js


-const t = new ServiceTester({ id: 'jetbrains', title: 'JetBrains plugin' });
+const t = new ServiceTester({ id: 'jetbrains', title: 'JetBrains plugin/version' });


Rather than keep updating this, you can just call it 'JetBrains'.

paulmelnikow · 2017-10-12T20:37:33Z

service-tests/jetbrains.js

@@ -3,31 +3,53 @@
 const Joi = require('joi');
 const ServiceTester = require('./runner/service-tester');
 const { isMetric } = require('./helpers/validators');
+const { isSemver } = require('./helpers/validators');


const { isMetric, isSemver } = require('./helpers/validators');

paulmelnikow · 2017-10-12T20:37:33Z

service-tests/jetbrains.js

+t.create('version (number as a plugin id)')
+  .get('/plugin/v/7495.json')
+  .expectJSONTypes(Joi.object().keys({ name: 'jetbrains plugin', value: isSemver }));
+


Thanks for all the great tests! Instead of interspersing these with the download tests, could you keep all the download tests together followed by all the version tests? They're a lot easier to follow that way.

ice1000 · 2017-10-12T21:11:48Z

squash and merge? 😉

paulmelnikow · 2017-10-12T21:55:04Z

Yeah, nice!!

paulmelnikow · 2017-10-12T21:56:20Z

Also, thanks for your reviewing @platan, much appreciated!

ice1000 · 2017-10-13T01:01:30Z

https://img.shields.io/jetbrains/plugin/v/9630-a8translate.svg

Hmm, seems 404. @paulmelnikow How long will it take to see it work?

paulmelnikow · 2017-10-13T01:12:42Z

Until the next deploy. Shouldn't be too long, though it's entirely outside my control so I don't have a specific ETA.

You could keep an eye on this to see when it happens: https://github.com/badges/shields/commits/gh-pages

ice1000 · 2017-10-13T02:13:23Z

Thank you! @paulmelnikow 👍

ice1000 · 2017-10-13T03:08:50Z

@paulmelnikow Sorry for bothering but I forgot to add this badge to the front page. Can you do it for me? 😢

paulmelnikow · 2017-10-13T03:51:57Z

Ah, shoot, sorry I missed that. Feel free to open another PR.

Close badges#1162

This reverts commit 003c44c.

Tesla Ice Zhang added 2 commits Oct 12, 2017

add JetBrains Plugin repo version

1c39dbc

add tests for jetbrains plugin version

Loading status checks…

ccb8b45

ice1000 mentioned this pull request Oct 12, 2017

[Request] Version badge for JetBrains Plugin #1162

Closed

paulmelnikow added the service-badge label Oct 12, 2017

platan reviewed Oct 12, 2017

View changes

server.js Outdated

try {

switch (type) {

case 'd':

This comment has been minimized.

Sign in to view

platan Oct 12, 2017
Member

We have jetbrains/plugin/v in path.

This comment has been minimized.

Sign in to view

ice1000 Oct 12, 2017
Author Contributor

Fixed

Update server.js

Loading status checks…

ecbbedb

platan reviewed Oct 12, 2017

View changes

Tesla Ice Zhang added 2 commits Oct 12, 2017

replace `d` with `v`

Loading status checks…

c7cf5b5

Update test info

Loading status checks…

b2520f0

platan reviewed Oct 12, 2017

View changes

Tesla Ice Zhang added 3 commits Oct 12, 2017

Fix

fca33fa

Merge branch 'master' into master

Loading status checks…

4476315

Suppress warnings

Loading status checks…

63b05f0

paulmelnikow reviewed Oct 12, 2017

View changes

Tesla Ice Zhang added 2 commits Oct 12, 2017

Resort tests

Loading status checks…

598c0bb

Reuse codes

Loading status checks…

11d6af8

paulmelnikow merged commit 8e180a0 into badges:master Oct 12, 2017
1 check passed

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

ice1000 mentioned this pull request Oct 21, 2017

Add JetBrains plugin version to the front page #1197

Merged

peter-gribanov added a commit to peter-gribanov/shields that referenced this pull request Nov 7, 2017

[JetBrains] Plugin version badge (badges#1164)

003c44c

Close badges#1162

peter-gribanov added a commit to peter-gribanov/shields that referenced this pull request Nov 8, 2017

Revert "[JetBrains] Plugin version badge (badges#1164)"

7047d0b

This reverts commit 003c44c.


		const t = new ServiceTester({ id: 'jetbrains', title: 'JetBrains plugin' });
		const t = new ServiceTester({ id: 'jetbrains', title: 'JetBrains plugin/version' });

badges / shields

Sponsor badges/shields

[JetBrains] Plugin version badge #1164

[JetBrains] Plugin version badge #1164

Conversation

ice1000 commented Oct 12, 2017

ice1000 commented Oct 12, 2017

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

ice1000 commented Oct 12, 2017

ice1000 commented Oct 12, 2017

platan commented Oct 12, 2017

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 • edited Author Contributor

ice1000 commented Oct 12, 2017

This comment has been minimized.

paulmelnikow Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

paulmelnikow Oct 12, 2017 Member

This comment has been minimized.

platan Oct 12, 2017 Member

This comment has been minimized.

paulmelnikow Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

paulmelnikow Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

paulmelnikow Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

This comment has been minimized.

paulmelnikow Oct 12, 2017 Member

This comment has been minimized.

ice1000 Oct 12, 2017 Author Contributor

ice1000 commented Oct 12, 2017

paulmelnikow commented Oct 12, 2017

paulmelnikow commented Oct 12, 2017

ice1000 commented Oct 13, 2017

paulmelnikow commented Oct 13, 2017 • edited

ice1000 commented Oct 13, 2017

ice1000 commented Oct 13, 2017

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

platan Oct 12, 2017
Member

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

ice1000 Oct 12, 2017
Author Contributor

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

platan Oct 12, 2017
Member

ice1000 Oct 12, 2017 •

edited

Author Contributor

paulmelnikow Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

paulmelnikow Oct 12, 2017
Member

platan Oct 12, 2017
Member

paulmelnikow Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

ice1000 Oct 12, 2017
Author Contributor

paulmelnikow Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

paulmelnikow Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

paulmelnikow Oct 12, 2017
Member

ice1000 Oct 12, 2017
Author Contributor

paulmelnikow commented Oct 13, 2017 •

edited