-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add PUB popularity badge * update PUB popularity badge * update PUB popularity badge Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
- Loading branch information
1 parent
4c8a724
commit 3e2c9b2
Showing
2 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
import Joi from 'joi' | ||
import { floorCount } from '../color-formatters.js' | ||
import { BaseJsonService } from '../index.js' | ||
|
||
const documentation = `<p>A measure of how many developers use a package, providing insight into what other developers are using.</p>` | ||
|
||
const keywords = ['dart', 'flutter'] | ||
|
||
const schema = Joi.object({ | ||
popularityScore: Joi.number().min(0).max(1).required(), | ||
}).required() | ||
|
||
const title = 'Pub Popularity' | ||
|
||
export default class PubPopularity extends BaseJsonService { | ||
static category = 'rating' | ||
|
||
static route = { base: 'pub/popularity', pattern: ':packageName' } | ||
|
||
static examples = [ | ||
{ | ||
title, | ||
keywords, | ||
documentation, | ||
namedParams: { packageName: 'analysis_options' }, | ||
staticPreview: this.render({ popularityScore: 0.9 }), | ||
}, | ||
] | ||
|
||
static defaultBadgeData = { label: 'popularity' } | ||
|
||
static render({ popularityScore }) { | ||
const roundedScore = Math.round(popularityScore * 100) | ||
return { | ||
label: 'popularity', | ||
message: `${roundedScore}%`, | ||
color: floorCount(roundedScore, 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 popularityScore = score.popularityScore | ||
return this.constructor.render({ popularityScore }) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
import { isIntegerPercentage } from '../test-validators.js' | ||
import { createServiceTester } from '../tester.js' | ||
|
||
export const t = await createServiceTester() | ||
|
||
t.create('pub popularity (valid)').get('/analysis_options.json').expectBadge({ | ||
label: 'popularity', | ||
message: isIntegerPercentage, | ||
}) | ||
|
||
t.create('pub popularity (not found)') | ||
.get('/analysisoptions.json') | ||
.expectBadge({ | ||
label: 'popularity', | ||
message: 'not found', | ||
color: 'red', | ||
}) | ||
|
||
t.create('pub popularity (invalid)').get('/analysis-options.json').expectBadge({ | ||
label: 'popularity', | ||
message: 'invalid', | ||
color: 'lightgrey', | ||
}) |