Merge branch 'publish-abnf-to-pest'

4 files changed, 72 insertions, 15 deletions

diff --git a/Cargo.lock b/Cargo.lock
index 448865e..097dd89 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2,17 +2,18 @@
 # It is not intended for manual editing.
 [[package]]
 name = "abnf"
-version = "0.1.1"
-source = "git+https://github.com/Nadrieril/abnf#aaa09ce40f5356daec5618b358be1c8b6e9b05d8"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
  "nom 4.2.3 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "abnf_to_pest"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
- "abnf 0.1.1 (git+https://github.com/Nadrieril/abnf)",
+ "abnf 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
+ "indexmap 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)",
  "itertools 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "pretty 0.5.2 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
@@ -92,7 +93,7 @@ dependencies = [
 name = "dhall_generated_parser"
 version = "0.1.0"
 dependencies = [
- "abnf_to_pest 0.1.0",
+ "abnf_to_pest 0.1.1",
  "pest 2.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "pest_generator 2.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "quote 0.6.12 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -150,6 +151,11 @@ name = "improved_slice_patterns"
 version = "1.0.1"
 
 [[package]]
+name = "indexmap"
+version = "1.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
 name = "itertools"
 version = "0.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -405,7 +411,7 @@ version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [metadata]
-"checksum abnf 0.1.1 (git+https://github.com/Nadrieril/abnf)" = "<none>"
+"checksum abnf 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "3cd52ccec58f8b39e3b25620953fd8dfbdcf932b50907b29d577cf1dd12477b6"
 "checksum ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ee49baf6cb617b853aa8d93bf420db2383fab46d314482ca2803b40d5fde979b"
 "checksum arrayref 0.3.5 (registry+https://github.com/rust-lang/crates.io-index)" = "0d382e583f07208808f6b1249e60848879ba3543f57c32277bf52d69c2f0f0ee"
 "checksum block-buffer 0.3.3 (registry+https://github.com/rust-lang/crates.io-index)" = "a076c298b9ecdb530ed9d967e74a6027d6a7478924520acddcddc24c1c8ab3ab"
@@ -419,6 +425,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 "checksum fake-simd 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "e88a8acf291dafb59c2d96e8f59828f3838bb1a70398823ade51a84de6a6deed"
 "checksum generic-array 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ef25c5683767570c2bbd7deba372926a55eaae9982d7726ee2a1050239d45b9d"
 "checksum half 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)" = "9353c2a89d550b58fa0061d8ed8d002a7d8cdf2494eb0e432859bd3a9e543836"
+"checksum indexmap 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)" = "7e81a7c05f79578dbc15793d8b619db9ba32b4577003ef3af1a91c416798c58d"
 "checksum itertools 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)" = "5b8467d9c1cebe26feb08c640139247fac215782d35371ade9a2136ed6085358"
 "checksum kernel32-sys 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)" = "7507624b29483431c0ba2d82aece8ca6cdba9382bff4ddd0f7490560c056098d"
 "checksum maplit 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)" = "08cbb6b4fef96b6d77bfc40ec491b1690c779e77b05cd9f07f787ed376fd4c43"
diff --git a/abnf_to_pest/Cargo.toml b/abnf_to_pest/Cargo.toml
index ff4dc01..9573c67 100644
--- a/abnf_to_pest/Cargo.toml
+++ b/abnf_to_pest/Cargo.toml
@@ -1,14 +1,19 @@
 [package]
 name = "abnf_to_pest"
-version = "0.1.0"
+version = "0.1.1"  # remember to update html_root_url
 authors = ["Nadrieril <nadrieril@users.noreply.github.com>"]
-license = "BSD-2-Clause"
+license = "MIT OR Apache-2.0"
 edition = "2018"
+description = "A tiny crate that helps convert ABNF grammars to pest"
+readme = "README.md"
+repository = "https://github.com/Nadrieril/dhall-rust"
+documentation = "https://docs.rs/abnf_to_pest"
 
 [lib]
 doctest = false
 
 [dependencies]
-abnf = { git = "https://github.com/Nadrieril/abnf" }
+abnf = "0.1.2"
+indexmap = "1.0.2"
 itertools = "0.8.0"
 pretty = "0.5.2"
diff --git a/abnf_to_pest/README.md b/abnf_to_pest/README.md
new file mode 100644
index 0000000..466cf70
--- /dev/null
+++ b/abnf_to_pest/README.md
@@ -0,0 +1,22 @@
+# `abnf_to_pest`
+
+A tiny crate that helps convert ABNF grammars to [pest][pest].
+
+[pest]: https://pest.rs
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0
+   (http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license
+   (http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions
diff --git a/abnf_to_pest/src/lib.rs b/abnf_to_pest/src/lib.rs
index 1b8fc9c..625798b 100644
--- a/abnf_to_pest/src/lib.rs
+++ b/abnf_to_pest/src/lib.rs
@@ -1,6 +1,25 @@
-#![allow(clippy::implicit_hasher, clippy::or_fun_call)]
+#![doc(html_root_url = "https://docs.rs/abnf_to_pest/0.1.1")]
 
 //! A tiny crate that helps convert ABNF grammars to [pest][pest].
+//!
+//! Example usage:
+//! ```
+//! let abnf_path = "src/grammar.abnf";
+//! let pest_path = "src/grammar.pest";
+//!
+//! let mut file = File::open(abnf_path)?;
+//! let mut data = Vec::new();
+//! file.read_to_end(&mut data)?;
+//! data.push('\n' as u8);
+//!
+//! let mut rules = abnf_to_pest::parse_abnf(&data)?;
+//! rules.remove("some_inconvenient_rule");
+//!
+//! let mut file = File::create(pest_path)?;
+//! writeln!(&mut file, "{}", render_rules_to_pest(rules).pretty(80))?;
+//! ```
+//!
+//! [pest]: https://pest.rs
 
 use abnf::abnf::Rule;
 pub use abnf::abnf::{
@@ -8,7 +27,7 @@ pub use abnf::abnf::{
 };
 use itertools::Itertools;
 use pretty::{BoxDoc, Doc};
-use std::collections::HashMap;
+use indexmap::map::IndexMap;
 
 trait Pretty {
     fn pretty(&self) -> Doc<'static, BoxDoc<'static, ()>>;
@@ -40,7 +59,7 @@ impl Pretty for Repetition {
             self.repeat
                 .as_ref()
                 .map(Repeat::pretty)
-                .unwrap_or(Doc::nil()),
+                .unwrap_or_else(Doc::nil),
         )
     }
 }
@@ -93,6 +112,10 @@ impl Pretty for Range {
     }
 }
 
+/// Escape the rule name to be a valid Rust identifier.
+///
+/// Replaces e.g. `if` with `if_`, and `rule-name` with `rule_name`.
+/// Also changes `whitespace` to `whitespace_` because of https://github.com/pest-parser/pest/pull/374
 pub fn escape_rulename(x: &str) -> String {
     let x = x.replace("-", "_");
     if x == "if"
@@ -110,8 +133,8 @@ pub fn escape_rulename(x: &str) -> String {
     }
 }
 
-fn format_char(x: usize) -> String {
-    if x <= usize::from(u8::max_value()) {
+fn format_char(x: u32) -> String {
+    if x <= u32::from(u8::max_value()) {
         let x: u8 = x as u8;
         if x.is_ascii_graphic() {
             let x: char = x as char;
@@ -146,7 +169,7 @@ impl Pretty for (String, PestyRule) {
 /// Parse an abnf file. Returns a map of rules.
 pub fn parse_abnf(
     data: &[u8],
-) -> Result<HashMap<String, PestyRule>, std::io::Error> {
+) -> Result<IndexMap<String, PestyRule>, std::io::Error> {
     let make_err =
         |e| std::io::Error::new(std::io::ErrorKind::Other, format!("{}", e));
     let rules: Vec<Rule> =