Trim matches

.travis.yml

@@ -1,8 +1,34 @@
+sudo: false
+dist: trusty
 language: rust
-rust:
-- stable
-- beta
-- nightly
-script:
-- cargo build --verbose
-- cargo test --verbose
+
+cache:
+- cargo
+
+before_cache:
+- rm -r $TRAVIS_BUILD_DIR/target/debug
+
+jobs:
+  include:
+  - os: linux
+    rust: stable
+  - os: linux
+    rust: beta
+  - os: linux
+    rust: nightly
+
+  # deploy
+  - stage: publish
+    os: linux
+    rust: stable
+    env:
+    # CARGO_TOKEN
+    - secure: "IPm2lHXAtXUY8pJtUMRV+jgLSCPKRJQyP3ax5aUhyaGlR83w4krEOcIpqQgu5a4rgw3SZUjDhxQMsRbzRZIehU+C3u2LTDpn0yycPnGmFRKVqnoS5dHdFMQ6IKLDZQK99MFZ/vMThipImnS9WFm2D1X/8XS31Mpn81Y7o54rIHk="
+    install: true
+    script: true
+
+    deploy:
+    - provider: script
+      script: 'cargo publish --verbose --token=$CARGO_TOKEN'
+      on:
+        tags: true

Cargo.toml

@@ -3,20 +3,21 @@
 name = "quire"
 description = "A YAML-based configuration parsing library"
 license = "MIT/Apache-2.0"
-readme = "README.rst"
+readme = "README.md"
 keywords = ["config", "yaml", "parser"]
 homepage = "http://github.com/tailhook/rust-quire"
-version = "0.2.3"
+categories = ["config"]
+version = "0.4.1"
 authors = ["[email protected]"]
 
 [dependencies]
-rustc-serialize = "0.3"
-quick-error = "1.0.0"
-regex = "0.1.80"
-humantime = "1.0.0"
-num-traits = "0.1.36"
+quick-error = "1.2.0"
+num-traits = "0.2.5"
 humannum = "0.1.0"
 serde = "1.0.10"
 
 [dev-dependencies]
 serde_derive = "1.0.10"
+serde_json = "1.0.2"
+serde-transcode = "1.0.0"
+serde-humantime = "0.1.1"

README.rst → README.md

@@ -1,18 +1,19 @@
-==========
 Rust Quire
 ==========
 
-:Status: Beta
+*Status: Beta*
 
 
-The ``rust-quire`` is a Rust_ port for quire_ configuration parsing library.
-It also contains YAML_ parser (however, it tuned for configuration parsing
-rather than generic YAML parser, e.g. it assumes YAML always fits memory).
+The ``rust-quire`` is a [Rust][1] port for [quire][2] configuration parsing
+library.  It also contains [YAML][3] parser (however, it tuned for
+configuration parsing rather than generic YAML parser, e.g. it assumes YAML
+always fits memory).
 
+See `doc/` for additional information.
 
-.. _quire: http://github.com/tailhook/quire
-.. _YAML: http://yaml.org
-.. _Rust: http://rust-lang.org
+[1]: http://github.com/tailhook/quire
+[2]: http://yaml.org
+[3]: http://rust-lang.org
 
 
 License

bulk.yaml

@@ -0,0 +1,15 @@
+minimum-bulk: v0.4.5
+
+versions:
+
+- file: Cargo.toml
+  block-start: ^\[package\]
+  block-end: ^\[.*\]
+  regex: ^version\s*=\s*"(\S+)"
+
+- file: doc/conf.py
+  regex: ^version\s*=\s*'(\S+)'
+  partial-version: ^\d+\.\d+
+
+- file: doc/conf.py
+  regex: ^release\s*=\s*'(\S+)'

doc/README.md

@@ -0,0 +1,11 @@
+doc/
+====
+
+In this directory documentation in [sphinx-doc][1] format.
+
+Type `make html` to get HTML generated. Expect to get errors
+when *sphinx-doc* is not installed on your system.
+
+With `make` you get a list of possible output formats.
+
+[1]: http://www.sphinx-doc.org/

doc/conf.py

@@ -42,16 +42,16 @@
 
 # General information about the project.
 project = 'Quire'
-copyright = '2013, Paul Colomiets'
+copyright = '2013-2019, Paul Colomiets'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '2.0'
+version = '0.4'
 # The full version, including alpha/beta/rc tags.
-release = '2.0-beta1'
+release = '0.4.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/index.rst

@@ -20,6 +20,7 @@ Contents:
     :maxdepth: 2
 
     user
+    programmer
 
 .. _Yaml: http://yaml.org
 

doc/programmer.rst

@@ -0,0 +1,44 @@
+
+================
+Programmer Guide
+================
+
+As a programmer you are looking for source code.
+You found it, here it is.
+
+.. literalinclude:: ../examples/simple.rs
+    :language: rust
+
+
+Key link
+========
+
+The key link between configuration file
+and the executable programm that you are writen
+is the configuration ``struct``.
+
+In the demo source code is that struct named *Config*
+and is *cfg* a variable of type Config.
+
+
+config.yaml
+===========
+
+Nothing of ``Config`` or ``cfg`` needs to be in the YAML.
+But the field names **must**.
+
+Here the *.yaml* that goes with the above example source code.
+
+
+.. literalinclude:: ../examples/config.yaml
+    :language: yaml
+
+
+See also
+========
+
+The documentation of `serde <https://serde.rs/>`_.
+
+Our ``examples`` directory.
+
+`Reverse dependencies <https://crates.io/crates/quire/reverse_dependencies>`_.

doc/user.rst

@@ -190,7 +190,7 @@ node that contains tag. For example:
 .. code-block:: yaml
 
     # config.yaml
-    items: !Include items.yaml
+    items: !*Include items.yaml
 
 .. code-block:: yaml
 
@@ -209,6 +209,89 @@ Is equivalent of:
    - banana
 
 
+.. _include-seq:
+
+Include Sequences of Files
+--------------------------
+
+The ``!*IncludeSeq`` tag includes files matched by glob as a sequence:
+
+.. code-block:: yaml
+
+   items: !*IncludeSeq "fruits/*.yaml"
+
+Can be parsed as:
+
+.. code-block:: yaml
+
+   items:
+   - apple
+   - banana
+   - cherry
+
+This depends on the exact application, but usually files returned by `glob`
+are sorted in alphabetical order. All the power of globs is supported, so you
+can do:
+
+.. code-block:: yaml
+
+   items: !*IncludeSeq "files/**/*.yaml"
+
+Another trick is merge multiple files, each with it's own set of keys into
+a single one (see map-merge_ below):
+
+.. code-block:: yaml
+
+   # file1.yaml
+   key1: 1
+   key2: 2
+   # file2.yaml
+   key3: 3
+   key4: 4
+   # main.yaml
+   <<: !*IncludeSeq "configs/*.yaml"
+
+This results into the following config:
+
+.. code-block:: yaml
+
+   key1: 1
+   key2: 2
+   key3: 3
+   key4: 4
+
+Note: merging is not recursive, i.e. top level keys are considered as a whole,
+even if they are dicts.
+
+
+.. _include-map:
+
+Include Mapping from Files
+--------------------------
+
+The ``!*IncludeMap`` tag works similarly to ``!*IncludeSeq`` but requires to
+mark part of a name used as a key. For example:
+
+.. code-block:: yaml
+
+   items: !*IncludeMap "fruits/(*).yaml"
+
+Might result into the folowing:
+
+.. code-block:: yaml
+
+   items:
+     apple: { color: orange }
+     banana: { color: yellow }
+     cherry: { color: red }
+
+You can parenthesize any part as well as a whole path:
+
+.. code-block:: yaml
+
+   files: !*IncludeMap "(**/*.yaml)"
+
+
 .. _map-merge:
 
 Merging Mappings

examples/README.text

@@ -0,0 +1,10 @@
+
+Run
+  cargo build --examples
+anywhere to get examples been compiled.
+
+For
+  cargo run --example simple
+be in the top directory of the project.
+That is for having the correct start point
+to get path to config.yaml right.

examples/config.yaml

@@ -0,0 +1,8 @@
+#
+---
+item1:  foo
+# comment
+item2:  bar
+_item3:  underscore used to comment out a keyword
+...
+# l l

examples/simple.rs

@@ -0,0 +1,31 @@
+extern crate quire;
+#[macro_use] extern crate serde_derive;
+use quire::{parse_config, Options};
+use quire::validate::{Structure, Scalar};
+
+#[derive(Deserialize)]
+#[allow(dead_code)]
+struct Config {
+    item1: String,
+    item2: Option<String>,
+}
+
+fn validator() -> Structure<'static> {
+    Structure::new()
+    .member("item1", Scalar::new())
+    .member("item2", Scalar::new().optional())
+}
+
+fn work(cfg: &Config) {
+    println!("item1 is {}.", cfg.item1);
+    //intln!("item2 is {}.", cfg.item2);
+    // hey, this is just demonstration code ...
+}
+
+fn main() {
+    let cfg: Config;
+    cfg = parse_config("examples/config.yaml",
+                       &validator(), &Options::default())
+        .expect("valid config");
+    work(&cfg)
+}

src/ast.rs

@@ -8,7 +8,7 @@ use std::collections::BTreeMap;
 use super::tokenizer::Pos;
 use super::errors::{Error, ErrorCollector};
 use super::parser::Node as P;
-use super::parser::{Directive, Node, Document};
+use super::parser::{Node, Document};
 use super::tokenizer::TokenType as T;
 use self::Ast::*;
 use self::NullKind::*;
@@ -118,7 +118,6 @@ impl Ast {
 
 struct Context<'a, 'b: 'a> {
     options: &'a Options<'b>,
-    directives: Vec<Directive<'a>>,
     err: &'a ErrorCollector,
 }
 
@@ -179,6 +178,14 @@ impl<'a, 'b: 'a> Context<'a, 'b> {
                 return self.options.include(&tok.start,
                     &Include::File { filename: val }, self.err);
             }
+            P::Scalar(Some("!*IncludeSeq"), _anch, ref val, ref tok) => {
+                return self.options.include(&tok.start,
+                    &Include::Sequence { pattern: val }, self.err);
+            }
+            P::Scalar(Some("!*IncludeMap"), _anch, ref val, ref tok) => {
+                return self.options.include(&tok.start,
+                    &Include::Mapping { pattern: val }, self.err);
+            }
             P::Scalar(ref tag, _, ref val, ref tok) => {
                 let pos = tok.start.clone();
                 let tag = self.string_to_tag(&pos, tag);
@@ -371,7 +378,6 @@ impl<'a, 'b: 'a> Context<'a, 'b> {
 pub fn process(opt: &Options, doc: Document, err: &ErrorCollector) -> Ast {
     let mut ctx = Context {
         options: opt,
-        directives: doc.directives,
         err: err,
     };
     return ctx.process(&doc.root);