patent 0.7.0

A prior-art search for your code ideas — has this dev tool already been shipped?
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Packagist source — `GET https://packagist.org/search.json?q=`.
//!
//! Packagist is the main PHP/Composer package registry. Its search endpoint
//! returns clean JSON, so this mirrors the crates.io / npm adapters.

use serde::Deserialize;

use super::SourceAdapter;
use crate::model::{Match, Query, Source};
use crate::Result;

/// Default Packagist host. Overridable in tests via [`Packagist::with_base_url`].
const DEFAULT_BASE_URL: &str = "https://packagist.org";

/// Searches the Packagist (PHP/Composer) registry.
#[derive(Debug, Clone)]
pub struct Packagist {
    client: reqwest::Client,
    base_url: String,
}

impl Packagist {
    /// Construct against the live Packagist host.
    pub fn new(client: reqwest::Client) -> Self {
        Self::with_base_url(client, DEFAULT_BASE_URL.to_string())
    }

    /// Construct against an arbitrary base URL (used by tests to point at a mock
    /// server). `base_url` should have no trailing slash.
    pub fn with_base_url(client: reqwest::Client, base_url: String) -> Self {
        Self { client, base_url }
    }
}

/// Top-level shape of the Packagist search response.
#[derive(Debug, Deserialize)]
struct SearchResponse {
    results: Vec<PackageHit>,
}

/// A single package in the `results` array. Only the fields we surface are
/// decoded.
#[derive(Debug, Deserialize)]
struct PackageHit {
    name: String,
    #[serde(default)]
    description: Option<String>,
    /// The Packagist package page; Packagist returns this as an absolute URL.
    #[serde(default)]
    url: Option<String>,
    /// Total install count; the primary popularity signal.
    #[serde(default)]
    downloads: Option<u64>,
    /// Stars ("favers"); used as a fallback when downloads are absent or zero.
    #[serde(default)]
    favers: Option<u64>,
}

#[async_trait::async_trait]
impl SourceAdapter for Packagist {
    fn id(&self) -> Source {
        Source::Packagist
    }

    async fn search(&self, query: &Query) -> Result<Vec<Match>> {
        let url = format!("{}/search.json", self.base_url);
        let q = query.keywords.join(" ");

        let response = self
            .client
            .get(&url)
            .query(&[("q", q.as_str()), ("per_page", "15")])
            .send()
            .await?
            .error_for_status()?;

        let body: SearchResponse = response.json().await?;

        Ok(body
            .results
            .into_iter()
            .map(|p| {
                // popularity = downloads, falling back to favers; never zero.
                let popularity = p
                    .downloads
                    .filter(|&d| d > 0)
                    .or_else(|| p.favers.filter(|&f| f > 0));
                Match {
                    url: p
                        .url
                        .unwrap_or_else(|| format!("{}/packages/{}", self.base_url, p.name)),
                    name: p.name,
                    source: Source::Packagist,
                    description: p.description.unwrap_or_default(),
                    popularity,
                    similarity: 0.0,
                }
            })
            .collect())
    }
}