distrib-ruby 0.0.4

Distrib helps you distribute your software.
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

// This is free and unencumbered software released into the public domain.

use alloc::{
    collections::BTreeMap,
    string::{String, ToString},
    vec,
    vec::Vec,
};
use indexmap::IndexMap;

pub type Gemspec = Specification;

#[cfg(all(feature = "alloc", feature = "serde"))]
pub type Map<K, V = serde_json::Value> = IndexMap<K, V>;

/// The package information for a gem, typically defined in a `.gemspec` file.
///
/// This is the tag `!ruby/object:Gem::Specification` in YAML.
///
/// Note that we (pedantically) distinguish between `Option<Vec<T>` and
/// `Vec<T>` so as to indicate whether the property was unset or set to empty
/// the input specification file.
///
/// See: <https://guides.rubygems.org/specification-reference/>
#[cfg_attr(feature = "serde", serde_with::serde_as)]
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct Specification<T = Metadata> {
    /// See: <https://guides.rubygems.org/specification-reference/#authors=>
    #[cfg_attr(feature = "serde", serde(alias = "author"))]
    #[cfg_attr(feature = "serde", serde_as(as = "OneOrMany<_, PreferMany>"))]
    pub authors: Vec<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#bindir>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub bindir: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#cert_chain>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub cert_chain: Option<Vec<String>>,

    /// See: <https://guides.rubygems.org/specification-reference/#add_dependency>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub dependencies: Option<Vec<Dependency>>,

    /// See: <https://guides.rubygems.org/specification-reference/#description>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub description: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#email>
    #[cfg_attr(
        feature = "serde",
        serde(alias = "emails", skip_serializing_if = "Vec::is_empty")
    )]
    #[cfg_attr(feature = "serde", serde_as(as = "OneOrMany<_, PreferOne>"))]
    pub email: Vec<String>, // TODO: Option<Vec<String>>

    /// See: <https://guides.rubygems.org/specification-reference/#executables>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub executables: Option<Vec<String>>,

    /// See: <https://guides.rubygems.org/specification-reference/#extensions>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub extensions: Option<Vec<String>>,

    /// See: <https://guides.rubygems.org/specification-reference/#extensions_dir>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub extensions_dir: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#extra_rdoc_files>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub extra_rdoc_files: Option<Vec<String>>,

    /// See: <https://guides.rubygems.org/specification-reference/#files>
    pub files: Vec<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#homepage>
    pub homepage: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#licenses=>
    #[cfg_attr(
        feature = "serde",
        serde(alias = "license", skip_serializing_if = "Vec::is_empty")
    )]
    #[cfg_attr(feature = "serde", serde_as(as = "OneOrMany<_, PreferMany>"))]
    pub licenses: Vec<String>, // TODO: Option<Vec<String>>

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub metadata: Option<T>,

    /// See: <https://guides.rubygems.org/specification-reference/#name>
    pub name: String,

    /// See: <https://guides.rubygems.org/specification-reference/#platform=>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub platform: Option<Platform>,

    /// See: <https://guides.rubygems.org/specification-reference/#post_install_message>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub post_install_message: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#rdoc_options>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub rdoc_options: Option<Vec<String>>,

    /// See: <https://guides.rubygems.org/specification-reference/#require_paths=>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub require_paths: Option<Vec<String>>,

    /// See: <https://guides.rubygems.org/specification-reference/#required_ruby_version>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub required_ruby_version: Option<Requirement>,

    /// See: <https://guides.rubygems.org/specification-reference/#required_rubygems_version>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub required_rubygems_version: Option<Requirement>,

    /// See: <https://guides.rubygems.org/specification-reference/#requirements>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub requirements: Option<Vec<String>>,

    /// See: <https://guides.rubygems.org/specification-reference/#rubygems_version>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub rubygems_version: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#signing_key>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub signing_key: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#summary>
    pub summary: String,

    /// See: <https://guides.rubygems.org/specification-reference/#version>
    pub version: Version,
}

#[cfg(all(feature = "serde"))]
impl<T: serde::Serialize> Specification<T> {
    pub fn try_to_string(&self) -> Result<String, serde_norway::Error> {
        serde_norway::to_string(self)
    }
}

/// !ruby/object:Gem::Dependency
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct Dependency {
    pub name: String,
    pub r#type: String,
    pub prerelease: bool,
    pub requirement: Requirement,
    pub version_requirements: Requirement,
}

impl Dependency {
    pub fn development(name: impl Into<String>, requirement: (&str, &str)) -> Self {
        let requirement = Requirement::from(requirement);
        Self::new(name, "development", false, requirement.clone(), requirement)
    }

    pub fn new(
        name: impl Into<String>,
        r#type: impl Into<String>,
        prerelease: bool,
        requirement: Requirement,
        version_requirements: Requirement,
    ) -> Self {
        Self {
            name: name.into(),
            r#type: r#type.into(),
            prerelease,
            requirement,
            version_requirements,
        }
    }
}

/// `!ruby/object:Gem::Requirement`
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct Requirement {
    pub requirements: Vec<(String, Version)>,
}

impl From<(&str, &str)> for Requirement {
    fn from((input0, input1): (&str, &str)) -> Self {
        From::from((input0.to_string(), input1.to_string()))
    }
}

impl From<(String, String)> for Requirement {
    fn from((input0, input1): (String, String)) -> Self {
        From::from((input0, Version::from(input1)))
    }
}

impl From<(String, Version)> for Requirement {
    fn from((input0, input1): (String, Version)) -> Self {
        Self {
            requirements: vec![(input0, input1)],
        }
    }
}

/// `!ruby/object:Gem::Version`
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct Version {
    pub version: String,
}

impl From<String> for Version {
    fn from(version: String) -> Self {
        Self { version }
    }
}

#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(
    feature = "serde",
    serde(rename_all(serialize = "lowercase", deserialize = "lowercase"))
)]
pub enum Platform {
    #[default]
    Ruby,
    Current,
    #[cfg_attr(feature = "serde", serde(untagged))]
    Other(String),
}

/// See: <https://guides.rubygems.org/specification-reference/#metadata>
#[derive(Clone, Debug, Default, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct Metadata {
    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub bug_tracker_uri: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub changelog_uri: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub documentation_uri: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub funding_uri: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub homepage_uri: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub mailing_list_uri: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub source_code_uri: Option<String>,

    /// See: <https://guides.rubygems.org/specification-reference/#metadata>
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub wiki_uri: Option<String>,

    #[cfg(all(feature = "alloc", feature = "serde"))]
    #[cfg_attr(
        feature = "serde",
        serde(flatten, skip_serializing_if = "Map::is_empty")
    )]
    pub other: Map<String>,
}