Rewrite [pypi]; affects [npm] (#1922)

badges · Aug 27, 2018 · 302c860 · 302c860
1 parent 78bb890
commit 302c860
Show file tree

Hide file tree

Showing 25 changed files with 691 additions and 273 deletions.
diff --git a/lib/all-badge-examples.js b/lib/all-badge-examples.js
@@ -614,21 +614,6 @@ const allBadgeExamples = [
         title: 'PowerShell Gallery',
         previewUri: '/powershellgallery/dt/ACMESharp.svg',
       },
-      {
-        title: 'PyPI',
-        previewUri: '/pypi/dm/Django.svg',
-        keywords: ['python'],
-      },
-      {
-        title: 'PyPI',
-        previewUri: '/pypi/dw/Django.svg',
-        keywords: ['python'],
-      },
-      {
-        title: 'PyPI',
-        previewUri: '/pypi/dd/Django.svg',
-        keywords: ['python'],
-      },
       {
         title: 'Conda',
         previewUri: '/conda/dn/conda-forge/python.svg',
@@ -1048,11 +1033,6 @@ const allBadgeExamples = [
         title: 'Bower',
         previewUri: '/bower/l/bootstrap.svg',
       },
-      {
-        title: 'PyPI - License',
-        previewUri: '/pypi/l/Django.svg',
-        keywords: ['python', 'pypi'],
-      },
       {
         title: 'Hex.pm',
         previewUri: '/hexpm/l/plug.svg',
@@ -1222,9 +1202,14 @@ const allBadgeExamples = [
     },
     examples: [
       {
-        title: 'PyPI',
-        previewUri: '/pypi/v/nine.svg',
-        keywords: ['python'],
+        title: 'npm bundle size (minified)',
+        previewUri: '/bundlephobia/min/react.svg',
+        keywords: ['node'],
+      },
+      {
+        title: 'npm bundle size (minified + gzip)',
+        previewUri: '/bundlephobia/minzip/react.svg',
+        keywords: ['node'],
       },
       {
         title: 'Conda',
@@ -1552,24 +1537,8 @@ const allBadgeExamples = [
     },
     examples: [
       {
-        title: 'PyPI - Wheel',
-        previewUri: '/pypi/wheel/Django.svg',
-        keywords: ['python', 'pypi'],
-      },
-      {
-        title: 'PyPI - Format',
-        previewUri: '/pypi/format/Django.svg',
-        keywords: ['python', 'pypi'],
-      },
-      {
-        title: 'PyPI - Implementation',
-        previewUri: '/pypi/implementation/Django.svg',
-        keywords: ['python', 'pypi'],
-      },
-      {
-        title: 'PyPI - Status',
-        previewUri: '/pypi/status/Django.svg',
-        keywords: ['python', 'pypi'],
+        title: 'VersionEye',
+        previewUri: '/versioneye/d/ruby/rails.svg',
       },
       {
         title: 'Wheelmap',

diff --git a/lib/deprecation-helpers.js b/lib/deprecation-helpers.js
@@ -2,6 +2,7 @@
 
 const { makeBadgeData, setBadgeColor } = require('./badge-data')
 const { deprecatedServices } = require('./deprecated-services')
+const { Deprecated } = require('../services/errors')
 
 const isDeprecated = function(
   service,
@@ -21,7 +22,14 @@ const getDeprecatedBadge = function(label, data) {
   return badgeData
 }
 
+function enforceDeprecation(effectiveDate) {
+  if (Date.now() >= effectiveDate.getTime()) {
+    throw new Deprecated()
+  }
+}
+
 module.exports = {
   isDeprecated,
   getDeprecatedBadge,
+  enforceDeprecation,
 }
diff --git a/lib/licenses.js b/lib/licenses.js
@@ -1,4 +1,7 @@
 'use strict'
+
+const { toArray } = require('./badge-data')
+
 const licenseTypes = {
   // permissive licenses - not public domain and not copyleft
   permissive: {
@@ -59,4 +62,21 @@ const defaultLicenseColor = 'lightgrey'
 const licenseToColor = spdxId =>
   licenseToColorMap[spdxId] || defaultLicenseColor
 
-module.exports = { licenseToColor }
+function renderLicenseBadge({ license, licenses }) {
+  if (licenses === undefined) {
+    licenses = toArray(license)
+  }
+
+  if (licenses.length === 0) {
+    return { message: 'missing', color: 'red' }
+  }
+
+  return {
+    message: licenses.join(', '),
+    // TODO This does not provide a color when more than one license is
+    // present. Probably that should be fixed.
+    color: licenseToColor(licenses),
+  }
+}
+
+module.exports = { licenseToColor, renderLicenseBadge }
diff --git a/lib/licenses.spec.js b/lib/licenses.spec.js
@@ -1,7 +1,7 @@
 'use strict'
 
-const { test, given } = require('sazerac')
-const { licenseToColor } = require('./licenses')
+const { test, given, forCases } = require('sazerac')
+const { licenseToColor, renderLicenseBadge } = require('./licenses')
 
 describe('license helpers', function() {
   test(licenseToColor, () => {
@@ -11,4 +11,26 @@ describe('license helpers', function() {
     given('unknown-license').expect('lightgrey')
     given(null).expect('lightgrey')
   })
+
+  test(renderLicenseBadge, () => {
+    forCases([
+      given({ license: undefined }),
+      given({ licenses: [] }),
+      given({}),
+    ]).expect({
+      message: 'missing',
+      color: 'red',
+    })
+    forCases([
+      given({ license: 'WTFPL' }),
+      given({ licenses: ['WTFPL'] }),
+    ]).expect({
+      message: 'WTFPL',
+      color: '7cd958',
+    })
+    given({ licenses: ['MPL-2.0', 'MIT'] }).expect({
+      message: 'MPL-2.0, MIT',
+      color: 'lightgrey',
+    })
+  })
 })
diff --git a/lib/version.js b/lib/version.js
@@ -8,6 +8,8 @@
 'use strict'
 
 const semver = require('semver')
+const { addv } = require('./text-formatters')
+const { version: versionColor } = require('./color-formatters')
 
 // Given a list of versions (as strings), return the latest version.
 // Return undefined if no version could be found.
@@ -139,10 +141,19 @@ function rangeStart(v) {
   return range.set[0][0].semver.version
 }
 
+function renderVersionBadge({ version, tag, defaultLabel }) {
+  return {
+    label: tag ? `${defaultLabel}@${tag}` : undefined,
+    message: addv(version),
+    color: versionColor(version),
+  }
+}
+
 module.exports = {
   latest,
   listCompare,
   slice,
   minor,
   rangeStart,
+  renderVersionBadge,
 }
diff --git a/lib/version.spec.js b/lib/version.spec.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const { test, given } = require('sazerac')
-const { latest, slice, rangeStart } = require('./version')
+const { latest, slice, rangeStart, renderVersionBadge } = require('./version')
 const includePre = true
 
 describe('Version helpers', function() {
@@ -119,4 +119,17 @@ describe('Version helpers', function() {
   test(rangeStart, () => {
     given('^2.4.7').expect('2.4.7')
   })
+
+  test(renderVersionBadge, () => {
+    given({ version: '1.2.3' }).expect({
+      label: undefined,
+      message: 'v1.2.3',
+      color: 'blue',
+    })
+    given({ version: '1.2.3', tag: 'next', defaultLabel: 'npm' }).expect({
+      label: 'npm@next',
+      message: 'v1.2.3',
+      color: 'blue',
+    })
+  })
 })