add [PUB] points badge (#7918)

* add PUB points badge

* update PUB points badge

* update PUB points badge

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
This commit is contained in:
Jeevan Chandra Joshi
2022-05-08 19:21:42 +05:30
committed by GitHub
parent 3e2c9b20e0
commit 377a0362a7
2 changed files with 78 additions and 0 deletions

View File

@@ -0,0 +1,55 @@
import Joi from 'joi'
import { floorCount } from '../color-formatters.js'
import { BaseJsonService } from '../index.js'
import { nonNegativeInteger } from '../validators.js'
const documentation = `<p>A measure of quality. This includes several dimensions of quality such as code style, platform support, and maintainability.</p>`
const keywords = ['dart', 'flutter']
const schema = Joi.object({
grantedPoints: nonNegativeInteger,
maxPoints: nonNegativeInteger,
}).required()
const title = 'Pub Points'
export default class PubPoints extends BaseJsonService {
static category = 'rating'
static route = { base: 'pub/points', pattern: ':packageName' }
static examples = [
{
title,
keywords,
documentation,
namedParams: { packageName: 'analysis_options' },
staticPreview: this.render({ grantedPoints: 120, maxPoints: 130 }),
},
]
static defaultBadgeData = { label: 'points' }
static render({ grantedPoints, maxPoints }) {
return {
label: 'points',
message: `${grantedPoints}/${maxPoints}`,
color: floorCount((grantedPoints / maxPoints) * 100, 40, 60, 80),
}
}
async fetch({ packageName }) {
return this._requestJson({
schema,
url: `https://pub.dev/api/packages/${packageName}/score`,
})
}
async handle({ packageName }) {
const score = await this.fetch({ packageName })
const grantedPoints = score.grantedPoints
const maxPoints = score.maxPoints
return this.constructor.render({ grantedPoints, maxPoints })
}
}

View File

@@ -0,0 +1,23 @@
import Joi from 'joi'
import { createServiceTester } from '../tester.js'
export const t = await createServiceTester()
t.create('pub points (valid)')
.get('/analysis_options.json')
.expectBadge({
label: 'points',
message: Joi.string().regex(/^\d+\/130$/),
})
t.create('pub points (not found)').get('/analysisoptions.json').expectBadge({
label: 'points',
message: 'not found',
color: 'red',
})
t.create('pub points (invalid)').get('/analysis-options.json').expectBadge({
label: 'points',
message: 'invalid',
color: 'lightgrey',
})