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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
use std::cmp::Ordering;
use std::error::Error;
use std::fmt::{self, Formatter};
use std::hash::Hash;
use std::hash;
use std::sync::Arc;
use regex::Regex;
use rustc_serialize::{Encodable, Encoder, Decodable, Decoder};
use semver;
use util::{CargoResult, CargoError, short_hash, ToSemver};
use core::source::SourceId;
#[derive(Clone, Debug)]
pub struct PackageId {
inner: Arc<PackageIdInner>,
}
#[derive(PartialEq, PartialOrd, Eq, Ord, Debug)]
struct PackageIdInner {
name: String,
version: semver::Version,
source_id: SourceId,
}
impl Encodable for PackageId {
fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
let source = self.inner.source_id.to_url();
let encoded = format!("{} {} ({})", self.inner.name, self.inner.version,
source);
encoded.encode(s)
}
}
impl Decodable for PackageId {
fn decode<D: Decoder>(d: &mut D) -> Result<PackageId, D::Error> {
let string: String = try!(Decodable::decode(d));
let regex = Regex::new(r"^([^ ]+) ([^ ]+) \(([^\)]+)\)$").unwrap();
let captures = regex.captures(&string).expect("invalid serialized PackageId");
let name = captures.at(1).unwrap();
let version = captures.at(2).unwrap();
let url = captures.at(3).unwrap();
let version = semver::Version::parse(version).ok().expect("invalid version");
let source_id = SourceId::from_url(url);
Ok(PackageId {
inner: Arc::new(PackageIdInner {
name: name.to_string(),
version: version,
source_id: source_id,
}),
})
}
}
impl Hash for PackageId {
fn hash<S: hash::Hasher>(&self, state: &mut S) {
self.inner.name.hash(state);
self.inner.version.hash(state);
self.inner.source_id.hash(state);
}
}
impl PartialEq for PackageId {
fn eq(&self, other: &PackageId) -> bool {
(*self.inner).eq(&*other.inner)
}
}
impl PartialOrd for PackageId {
fn partial_cmp(&self, other: &PackageId) -> Option<Ordering> {
(*self.inner).partial_cmp(&*other.inner)
}
}
impl Eq for PackageId {}
impl Ord for PackageId {
fn cmp(&self, other: &PackageId) -> Ordering {
(*self.inner).cmp(&*other.inner)
}
}
#[derive(Clone, Debug, PartialEq)]
pub enum PackageIdError {
InvalidVersion(String),
InvalidNamespace(String)
}
impl Error for PackageIdError {
fn description(&self) -> &str { "failed to parse package id" }
}
impl fmt::Display for PackageIdError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
PackageIdError::InvalidVersion(ref v) => {
write!(f, "invalid version: {}", *v)
}
PackageIdError::InvalidNamespace(ref ns) => {
write!(f, "invalid namespace: {}", *ns)
}
}
}
}
impl CargoError for PackageIdError {
fn is_human(&self) -> bool { true }
}
impl From<PackageIdError> for Box<CargoError> {
fn from(t: PackageIdError) -> Box<CargoError> { Box::new(t) }
}
#[derive(PartialEq, Eq, Hash, Clone, RustcEncodable, Debug)]
pub struct Metadata {
pub metadata: String,
pub extra_filename: String
}
impl PackageId {
pub fn new<T: ToSemver>(name: &str, version: T,
sid: &SourceId) -> CargoResult<PackageId> {
let v = try!(version.to_semver().map_err(PackageIdError::InvalidVersion));
Ok(PackageId {
inner: Arc::new(PackageIdInner {
name: name.to_string(),
version: v,
source_id: sid.clone(),
}),
})
}
pub fn name(&self) -> &str { &self.inner.name }
pub fn version(&self) -> &semver::Version { &self.inner.version }
pub fn source_id(&self) -> &SourceId { &self.inner.source_id }
pub fn generate_metadata(&self) -> Metadata {
let metadata = short_hash(self);
let extra_filename = format!("-{}", metadata);
Metadata { metadata: metadata, extra_filename: extra_filename }
}
pub fn with_precise(&self, precise: Option<String>) -> PackageId {
PackageId {
inner: Arc::new(PackageIdInner {
name: self.inner.name.to_string(),
version: self.inner.version.clone(),
source_id: self.inner.source_id.with_precise(precise),
}),
}
}
}
impl Metadata {
pub fn mix<T: Hash>(&mut self, t: &T) {
let new_metadata = short_hash(&(&self.metadata, t));
self.extra_filename = format!("-{}", new_metadata);
self.metadata = new_metadata;
}
}
impl fmt::Display for PackageId {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
try!(write!(f, "{} v{}", self.inner.name, self.inner.version));
if !self.inner.source_id.is_default_registry() {
try!(write!(f, " ({})", self.inner.source_id));
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::PackageId;
use core::source::SourceId;
use sources::RegistrySource;
use util::ToUrl;
#[test]
fn invalid_version_handled_nicely() {
let loc = RegistrySource::default_url().to_url().unwrap();
let repo = SourceId::for_registry(&loc);
assert!(PackageId::new("foo", "1.0", &repo).is_err());
assert!(PackageId::new("foo", "1", &repo).is_err());
assert!(PackageId::new("foo", "bar", &repo).is_err());
assert!(PackageId::new("foo", "", &repo).is_err());
}
}