eco 0.4.0

A tool for reasoning about breaking changes in Rust ecosystems
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
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

//! Dependency info.

use range::Range;
use piston_meta::{ json, MetaData };

use std::sync::Arc;
use std::io::{ self, Write };

/// Writes the dependency info.
pub fn write<W: Write>(
    package_data: &[Package],
    w: &mut W
) -> Result<(), io::Error> {
    try!(writeln!(w, "{{"));
    let n0 = package_data.len();
    for (i0, package) in package_data.iter().enumerate() {
        // Package name.
        try!(write!(w, " "));
        try!(json::write_string(w, &package.name));
        try!(writeln!(w, ": {{"));

        // Version.
        try!(write!(w, "  \"version\": "));
        try!(json::write_string(w, &package.version));
        try!(writeln!(w, ","));

        // Dependencies.
        try!(writeln!(w, "  \"dependencies\": {{"));
        let n1 = package.dependencies.len();
        for (i1, dependency) in package.dependencies.iter().enumerate() {
            try!(write!(w, "   "));
            try!(json::write_string(w, &dependency.name));
            try!(writeln!(w, ": {{"));
            // Version.
            try!(write!(w, "    \"version\": "));
            try!(json::write_string(w, &dependency.version));
            try!(writeln!(w, ""));
            try!(write!(w, "   }}"));
            if i1 + 1 != n1 {
                try!(writeln!(w, ","));
            } else {
                try!(writeln!(w, ""));
            }
        }
        try!(writeln!(w, "  }},"));

        // Dev dependencies.
        try!(writeln!(w, "  \"dev-dependencies\": {{"));
        let n1 = package.dev_dependencies.len();
        for (i1, dependency) in package.dev_dependencies.iter().enumerate() {
            try!(write!(w, "   "));
            try!(json::write_string(w, &dependency.name));
            try!(writeln!(w, ": {{"));
            // Version.
            try!(write!(w, "    \"version\": "));
            try!(json::write_string(w, &dependency.version));
            try!(writeln!(w, ""));
            try!(write!(w, "   }}"));
            if i1 + 1 != n1 {
                try!(writeln!(w, ","));
            } else {
                try!(writeln!(w, ""));
            }
        }
        try!(writeln!(w, "  }}"));

        // End package.
        try!(write!(w, " }}"));
        if i0 + 1 != n0 {
            try!(writeln!(w, ","));
        } else {
            try!(writeln!(w, ""));
        }
    }
    try!(writeln!(w, "}}"));
    Ok(())
}

/// Converts from meta data to dependency information.
pub fn convert(
    mut data: &[(Range, MetaData)],
    ignored: &mut Vec<Range>
) -> Result<Vec<Package>, ()> {
    use piston_meta::bootstrap::update;

    let mut offset = 0;
    let mut res = vec![];
    loop {
        if let Ok((range, package)) = Package::from_meta_data(data, offset, ignored) {
            update(range, &mut data, &mut offset);
            res.push(package);
        } else if offset < data.len() {
            return Err(());
        } else {
            break;
        }
    }
    Ok(res)
}

/// Stores package information.
pub struct Package {
    /// The package name.
    pub name: Arc<String>,
    /// The version.
    pub version: Arc<String>,
    /// Dependencies.
    pub dependencies: Vec<Dependency>,
    /// Dev dependencies.
    pub dev_dependencies: Vec<Dependency>,
}

impl Package {
    /// Converts from meta data.
    pub fn from_meta_data(
        mut data: &[(Range, MetaData)],
        mut offset: usize,
        ignored: &mut Vec<Range>
    ) -> Result<(Range, Package), ()> {
        use piston_meta::bootstrap::*;

        let start_offset = offset;
        let node = "package";
        let start_range = try!(start_node(node, data, offset));
        update(start_range, &mut data, &mut offset);

        let mut name: Option<Arc<String>> = None;
        let mut version: Option<Arc<String>> = None;
        let mut dependencies = vec![];
        let mut dev_dependencies = vec![];
        loop {
            if let Ok(range) = end_node(node, data, offset) {
                update(range, &mut data, &mut offset);
                break;
            } else if let Ok((range, val)) = meta_string("name", data, offset) {
                update(range, &mut data, &mut offset);
                name = Some(val);
            } else if let Ok((range, val)) = meta_string("version", data, offset) {
                update(range, &mut data, &mut offset);
                version = Some(val);
            } else if let Ok((range, dependency)) = Dependency::from_meta_data("dependency", data, offset, ignored) {
                update(range, &mut data, &mut offset);
                dependencies.push(dependency);
            } else if let Ok((range, dev_dependency)) = Dependency::from_meta_data("dev_dependency", data, offset, ignored) {
                update(range, &mut data, &mut offset);
                dev_dependencies.push(dev_dependency);
            } else {
                let range = ignore(data, offset);
                update(range, &mut data, &mut offset);
                ignored.push(range);
            }
        }

        let name = try!(name.ok_or(()));
        let version = try!(version.ok_or(()));
        Ok((Range::new(start_offset, offset - start_offset), Package {
            name: name,
            version: version,
            dependencies: dependencies,
            dev_dependencies: dev_dependencies,
        }))
    }
}

/// Stores dependency information.
pub struct Dependency {
    /// The package name.
    pub name: Arc<String>,
    /// The semver version of the library.
    pub version: Arc<String>,
}

impl Dependency {
    /// Converts from meta data.
    pub fn from_meta_data(
        node: &str,
        mut data: &[(Range, MetaData)],
        mut offset: usize,
        ignored: &mut Vec<Range>
    ) -> Result<(Range, Dependency), ()> {
        use piston_meta::bootstrap::*;

        let start_offset = offset;
        let start_range = try!(start_node(node, data, offset));
        update(start_range, &mut data, &mut offset);

        let mut name: Option<Arc<String>> = None;
        let mut version: Option<Arc<String>> = None;
        loop {
            if let Ok(range) = end_node(node, data, offset) {
                update(range, &mut data, &mut offset);
                break;
            } else if let Ok((range, val)) = meta_string("name", data, offset) {
                update(range, &mut data, &mut offset);
                name = Some(val);
            } else if let Ok((range, val)) = meta_string("version", data, offset) {
                update(range, &mut data, &mut offset);
                version = Some(val);
            } else {
                let range = ignore(data, offset);
                update(range, &mut data, &mut offset);
                ignored.push(range);
            }
        }

        let name = try!(name.ok_or(()));
        let version = try!(version.ok_or(()));
        Ok((Range::new(start_offset, offset - start_offset), Dependency {
            name: name,
            version: version
        }))
    }
}