Merge #61

61: Pretty configuration options r=torkleyy a=kvark

Fixes #58
~~BREAKING CHANGE~~

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ron"
-version = "0.1.3"
+version = "0.1.4"
 license = "MIT/Apache-2.0"
 keywords = ["parser", "serde", "serialization"]
 authors = [
@@ -18,8 +18,7 @@ exclude = ["bors.toml", ".travis.yml"]
 name = "ron"
 
 [dependencies]
-serde = "1"
+serde = { version = "1", features = ["serde_derive"] }
 
 [dev-dependencies]
-serde_derive = "1"
 serde_json = "1"

examples/decode.rs

@@ -1,6 +1,6 @@
 extern crate ron;
 #[macro_use]
-extern crate serde_derive;
+extern crate serde;
 
 use std::collections::HashMap;
 

examples/decode_file.rs

@@ -1,6 +1,6 @@
 extern crate ron;
 #[macro_use]
-extern crate serde_derive;
+extern crate serde;
 
 use std::collections::HashMap;
 use std::fs::File;

examples/encode.rs

@@ -1,21 +1,25 @@
 extern crate ron;
 #[macro_use]
-extern crate serde_derive;
+extern crate serde;
 
 use std::collections::HashMap;
+use std::default::Default;
 use std::fs::File;
 
-use ron::ser::pretty::to_string;
+use ron::ser::{PrettyConfig, to_string_pretty};
 
 #[derive(Serialize)]
 struct Config {
-    boolean: bool,
-    float: f32,
+    float: (f32, f64),
+    tuple: TupleStruct,
     map: HashMap<u8, char>,
     nested: Nested,
     var: Variant,
 }
 
+#[derive(Serialize)]
+struct TupleStruct((), bool);
+
 #[derive(Serialize)]
 enum Variant {
     A(u8, &'static str),
@@ -33,16 +37,22 @@ fn main() {
 
     let mut file = File::create("config.ron").expect("Failed to create file");
 
-    let s = to_string(&Config {
-        boolean: false,
-        float: 2.18,
+    let data = Config {
+        float: (2.18, -1.1),
+        tuple: TupleStruct((), false),
         map: HashMap::from_iter(vec![(0, '1'), (1, '2'), (3, '5'), (8, '1')]),
         nested: Nested {
             a: "Hello from \"RON\"".to_string(),
             b: 'b',
         },
         var: Variant::A(!0, ""),
-    }).expect("Serialization failed");
+    };
+
+    let pretty = PrettyConfig {
+        separate_tuple_members: true,
+        .. PrettyConfig::default()
+    };
+    let s = to_string_pretty(&data, pretty).expect("Serialization failed");
 
     file.write(s.as_bytes()).expect("Failed to write data to file");
 }

src/lib.rs

@@ -57,10 +57,8 @@ Serializing / Deserializing is as simple as calling `to_string` / `from_str`.
 
 !*/
 
-extern crate serde;
-#[cfg(test)]
 #[macro_use]
-extern crate serde_derive;
+extern crate serde;
 
 pub mod de;
 pub mod ser;

src/ser/mod.rs

@@ -1,18 +1,13 @@
 use std::error::Error as StdError;
+use std::result::Result as StdResult;
 use std::fmt::{Display, Formatter, Result as FmtResult};
 
 use serde::ser::{self, Serialize};
 
+#[deprecated(since="0.1.4", note="please use `to_string_pretty` with `PrettyConfig::default()` instead")]
 pub mod pretty;
-
 mod value;
 
-#[cfg(not(target_os = "windows"))]
-const NEWLINE: &str = "\n";
-
-#[cfg(target_os = "windows")]
-const NEWLINE: &str = "\r\n";
-
 /// Serializes `value` and returns it as string.
 ///
 /// This function does not generate any newlines or nice formatting;
@@ -29,8 +24,21 @@ pub fn to_string<T>(value: &T) -> Result<String>
     Ok(s.output)
 }
 
+/// Serializes `value` in the recommended RON layout in a pretty way.
+pub fn to_string_pretty<T>(value: &T, config: PrettyConfig) -> Result<String>
+    where T: Serialize
+{
+    let mut s = Serializer {
+        output: String::new(),
+        pretty: Some((config, Pretty { indent: 0 })),
+        struct_names: false,
+    };
+    value.serialize(&mut s)?;
+    Ok(s.output)
+}
+
 /// Serialization result.
-pub type Result<T> = ::std::result::Result<T, Error>;
+pub type Result<T> = StdResult<T, Error>;
 
 /// Serialization error.
 #[derive(Clone, Debug, PartialEq)]
@@ -61,38 +69,69 @@ impl StdError for Error {
     }
 }
 
+/// Pretty serializer state
 struct Pretty {
     indent: usize,
 }
 
+/// Pretty serializer configuration
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct PrettyConfig {
+    /// New line string
+    pub new_line: String,
+    /// Indentation string
+    pub indentor: String,
+    /// Separate tuple members with indentation
+    pub separate_tuple_members: bool,
+}
+
+impl Default for PrettyConfig {
+    fn default() -> Self {
+        PrettyConfig {
+            #[cfg(not(target_os = "windows"))]
+            new_line: "\n".to_string(),
+            #[cfg(target_os = "windows")]
+            new_line: "\r\n".to_string(),
+            indentor: "    ".to_string(),
+            separate_tuple_members: false,
+        }
+    }
+}
+
 /// The RON serializer.
 ///
 /// You can just use `to_string` for deserializing a value.
 /// If you want it pretty-printed, take a look at the `pretty` module.
 pub struct Serializer {
     output: String,
-    pretty: Option<Pretty>,
+    pretty: Option<(PrettyConfig, Pretty)>,
     struct_names: bool,
 }
 
 impl Serializer {
+    fn separate_tuple_members(&self) -> bool {
+        self.pretty.as_ref()
+            .map(|&(ref config, _)| config.separate_tuple_members)
+            .unwrap_or(false)
+    }
+
     fn start_indent(&mut self) {
-        if let Some(ref mut pretty) = self.pretty {
+        if let Some((ref config, ref mut pretty)) = self.pretty {
             pretty.indent += 1;
-            self.output += NEWLINE;
+            self.output += &config.new_line;
         }
     }
 
     fn indent(&mut self) {
-        if let Some(ref pretty) = self.pretty {
-            self.output.extend((0..pretty.indent * 4).map(|_| " "));
+        if let Some((ref config, ref pretty)) = self.pretty {
+            self.output.extend((0..pretty.indent).map(|_| config.indentor.as_str()));
         }
     }
 
     fn end_indent(&mut self) {
-        if let Some(ref mut pretty) = self.pretty {
+        if let Some((ref config, ref mut pretty)) = self.pretty {
             pretty.indent -= 1;
-            self.output.extend((0..pretty.indent * 4).map(|_| " "));
+            self.output.extend((0..pretty.indent).map(|_| config.indentor.as_str()));
         }
     }
 }
@@ -256,7 +295,9 @@ impl<'a> ser::Serializer for &'a mut Serializer {
     {
         self.output += variant;
         self.output += "(";
+
         value.serialize(&mut *self)?;
+
         self.output += ")";
         Ok(())
     }
@@ -272,6 +313,10 @@ impl<'a> ser::Serializer for &'a mut Serializer {
     fn serialize_tuple(self, _: usize) -> Result<Self::SerializeTuple> {
         self.output += "(";
 
+        if self.separate_tuple_members() {
+            self.start_indent();
+        }
+
         Ok(self)
     }
 
@@ -297,6 +342,10 @@ impl<'a> ser::Serializer for &'a mut Serializer {
         self.output += variant;
         self.output += "(";
 
+        if self.separate_tuple_members() {
+            self.start_indent();
+        }
+
         Ok(self)
     }
 
@@ -351,8 +400,8 @@ impl<'a> ser::SerializeSeq for &'a mut Serializer {
         value.serialize(&mut **self)?;
         self.output += ",";
 
-        if self.pretty.is_some() {
-            self.output += NEWLINE;
+        if let Some((ref config, _)) = self.pretty {
+            self.output += &config.new_line;
         }
 
         Ok(())
@@ -373,20 +422,28 @@ impl<'a> ser::SerializeTuple for &'a mut Serializer {
     fn serialize_element<T>(&mut self, value: &T) -> Result<()>
         where T: ?Sized + Serialize
     {
+        if self.separate_tuple_members() {
+            self.indent();
+        }
+
         value.serialize(&mut **self)?;
         self.output += ",";
 
-        if self.pretty.is_some() {
-            self.output += " ";
+        if let Some((ref config, _)) = self.pretty {
+            self.output += if self.separate_tuple_members() { &config.new_line } else { " " };
         }
 
         Ok(())
     }
 
     fn end(self) -> Result<()> {
         if self.pretty.is_some() {
-            self.output.pop();
-            self.output.pop();
+            if self.separate_tuple_members() {
+                self.end_indent();
+            } else {
+                self.output.pop();
+                self.output.pop();
+            }
         }
 
         self.output += ")";
@@ -450,8 +507,8 @@ impl<'a> ser::SerializeMap for &'a mut Serializer {
         value.serialize(&mut **self)?;
         self.output += ",";
 
-        if self.pretty.is_some() {
-            self.output += NEWLINE;
+        if let Some((ref config, _)) = self.pretty {
+            self.output += &config.new_line;
         }
 
         Ok(())
@@ -484,8 +541,8 @@ impl<'a> ser::SerializeStruct for &'a mut Serializer {
         value.serialize(&mut **self)?;
         self.output += ",";
 
-        if self.pretty.is_some() {
-            self.output += NEWLINE;
+        if let Some((ref config, _)) = self.pretty {
+            self.output += &config.new_line;
         }
 
         Ok(())

src/ser/pretty.rs

@@ -1,18 +1,14 @@
-//! Provides pretty serialization with `to_string`.
+//! Provides default pretty serialization with `to_string`.
 
-use super::{Pretty, Result, Serializer};
+use super::{Result, to_string_pretty};
 
 use serde::ser::Serialize;
+use std::default::Default;
 
-/// Serializes `value` in the recommended RON layout.
+/// Serializes `value` in the recommended RON layout with
+/// default pretty configuration.
 pub fn to_string<T>(value: &T) -> Result<String>
     where T: Serialize
 {
-    let mut s = Serializer {
-        output: String::new(),
-        pretty: Some(Pretty { indent: 0 }),
-        struct_names: false,
-    };
-    value.serialize(&mut s)?;
-    Ok(s.output)
+    to_string_pretty(value, Default::default())
 }

tests/roundtrip.rs

@@ -1,6 +1,6 @@
 extern crate ron;
 #[macro_use]
-extern crate serde_derive;
+extern crate serde;
 
 use std::collections::HashMap;