eliminate workspace (#72)

Moves the exile crate up to the top level of the git repository and
eliminates the cargo workspace. The xtest and xdoc crates are now gone.
This closes #71

.github/workflows/test.yaml

@@ -2,7 +2,7 @@ name: exile ci
 
 on:
   push:
-    branches: [ 'master', '*develop*', 'testgen' ]
+    branches: [ 'master' ]
   pull_request:
     branches: [ '*' ]
 
@@ -14,9 +14,6 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - run: rustup update stable
-      - run: cargo clippy -- --version && cargo fmt -- --version
-      - run: cargo fmt -- --check
-      - run: cargo clippy --locked -- -D warnings
-      - run: cargo clippy --tests --locked -- -D warnings
-      - run: cargo test --all-features
-      - run: cargo build --package exile --lib
+      - run: export EXILE_GENERATE_README=yes && make check
+      - name: assert git is clean
+        run: git diff --quiet && [[ -z $(git status -s) ]]

.github/workflows/testgen.yaml

@@ -2,7 +2,7 @@ name: testgen
 
 on:
   push:
-    branches: [ 'master', 'testgen', '*develop*' ]
+    branches: [ 'master' ]
   pull_request:
     branches: [ '*' ]
 

CHANGELOG.md

@@ -6,16 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Currently we are using v0.0.x where every version can and will contain breaking changes.
 
-## [Unreleased]
+## [v0.0.2] - 2020-11-15
 ### Added
 - Support for single-quoted attributes [#58]
 - `exile::load` for loading files [#58]
+- A lot of work on generating test cases with Java [#67], [#70], [#72]
+
 
 ### Changed
 - The `xdoc` `Version` and `Encoding` enums were weird, changed to remove `None` [#59]
+- Added some mutating functions to `Document`, `Element`, and maybe others
+- Eliminated the `xdoc` and `xtest` crates [#67], [#70], [#72]
 
 [#58]: https://github.com/webern/exile/pull/58
 [#59]: https://github.com/webern/exile/pull/59
+[#67]: https://github.com/webern/exile/pull/67
+[#70]: https://github.com/webern/exile/pull/70
+[#72]: https://github.com/webern/exile/pull/72
 
 ## [v0.0.1] - 2020-07-18
 ### Added
@@ -47,6 +54,7 @@ Currently we are using v0.0.x where every version can and will contain breaking
 
 <!-- version diff links -->
 [Unreleased]: https://github.com/webern/exile/compare/v0.0.1...HEAD
+[v0.0.2]: https://github.com/webern/exile/compare/v0.0.1...v0.0.2
 [v0.0.1]: https://github.com/webern/exile/compare/v0.0.0...v0.0.1
 [v0.0.0]: https://github.com/webern/exile/releases/tag/v0.0.0
 [30175b0]: https://github.com/webern/exile/compare/dd000e2..30175b0

Cargo.toml

@@ -1,5 +1,17 @@
-[workspace]
+[package]
+name = "exile"
+description = "Nacent XML DOM Library"
+authors = ["Matthew James Briggs <[email protected]>"]
+categories = ["encoding", "parser-implementations", "parsing"]
+edition = "2018"
+exclude = ["tests/"]
+keywords = ["xml"]
+license = "MIT OR Apache-2.0"
+readme = "README.md"
+repository = "https://github.com/webern/exile/"
+version = "0.0.2"
 
-members = [
-    "exile"
-]
+[dependencies]
+
+[build-dependencies]
+cargo-readme = "3.2.0"

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean testgen
+.PHONY: clean testgen check
 
 ## data/w3cdata: creates the data directory by pulling testdata from dockerhub
 data/w3cdata:
@@ -20,3 +20,12 @@ testgen: testdata
 clean:
 	rm -rf data && \
 	rm -rf target
+
+check:
+	cargo clippy -- --version && cargo fmt -- --version && \
+	cargo fmt -- --check && \
+	cargo clippy --locked -- -D warnings && \
+	cargo clippy --tests --locked -- -D warnings && \
+	cargo test --all-features && \
+	cargo build --all-features --lib
+

README.md

@@ -6,9 +6,23 @@ Current version: 0.0.2
 
 `exile` is a Rust library for reading and writing XML.
 
-The goal is to provide a useful abstraction over XML with DOM-like structs.
-The state of the library is 'pre-alpha'
-See the GitHub issues and [milestones](https://github.com/webern/exile/milestones) for work planned.
+The goal, at least initially, is to provide an abstract syntax tree of an XML file.
+As such, this is a Exile is a dom parser and loads the complete contents of the document into memory.
+
+Currently supported:
+- Elements
+- Attributes
+- Text Nodes
+- Processing Instructions
+- UTF-8
+
+Not Supported:
+- Entities
+- Entity References
+- Doctypes
+- Comment Parsing
+- Other Encodings
+- Whitespace Preservation
 
 ## Example
 
@@ -51,28 +65,4 @@ The program above prints:
 <my_root foo="bar">
   <my_child>Hello World!</my_child>
 </my_root>
-```
-
-## Crates
-
-Development is setup as a cargo workspace with three crates.
-
-  * `xdoc` is the root dependency and contains structs that represent an XML document
-  * `xtest` contains test files and helper functions for loading them.
-  * `exile` is the public-facing crate and includes the parser.
-
-## Work to Do
-
-Current status is 'pre-mvp'. v0.0.0 will be able to parse basic XML documents into DOM-like
-structures and serialize them back.
-
- * [x] [MVP]
- * [ ] [Conformance]
- * [ ] [Interface]
-
-[Issues not assigned to a milestone]
-
-[MVP]: https://github.com/webern/exile/milestone/1
-[Conformance]: https://github.com/webern/exile/milestone/3
-[Interface]: https://github.com/webern/exile/milestone/2
-[Issues not assigned to a milestone]: https://github.com/webern/exile/issues?q=is%3Aissue+is%3Aopen+no%3Amilestone
+```

exile/build.rs → build.rs

@@ -29,13 +29,6 @@ fn generate_readme() {
         true,  // indent headings
     )
     .unwrap();
-    let this_readme_path = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("README.md");
     let mut readme = File::create("README.md").unwrap();
     readme.write_all(content.as_bytes()).unwrap();
-    let top_readme_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-        .join("..")
-        .join("README.md");
-    if env::var_os("EXILE_GENERATE_TOP_README").is_some() {
-        std::fs::copy(&this_readme_path, &top_readme_path).unwrap();
-    }
 }