Add InfluxDbWriteable procedural derive macro (#23)

* cargo workspace

* introduce InfluxDbWriteable

* basic derive stuff

* first writeable derive attempt

* add test for the ci to run

* add derive feature in travis

* update version to 0.0.5

* fix some stuff

* fix failing doc test

* no default features, run tests with all features

* typo

* remove some warnings

* cargo fmt

* cargo readme

* cargo readme is incompetent

* Fix build hopefully

* Debug CI

* Debug Ci 2

* Debug Ci 3

* Debug Ci 4

* Debug Ci 5

* Stop using cargo-travis

* Do stuff

* tidy up

* Test both crates

* remove an `&`

* travis närvt

* first attempt at tags

* specify the attributes

* add usefull derives to Timestamp

* the world is a brocken

* that merge went well .....

* Refactor Tests

* fix derp

* Painstakingly fix tests and make chrono a required dependency

* Fix lint warning

* Update README

* More fixes

* apply @Empty2k12's suggestions && fix compile issue with no features

* proper difference between field and tag

* introduce krate method

* progress

* add field / tag test

* cosmetic updates

* fixed

* fix clippy and fmt

Co-authored-by: Gero Gerke <11deutron11@gmail.com>

Author: msrd0

.travis.yml

@@ -51,8 +51,13 @@ matrix:
           script:
               - bash auxiliary/check_readme_consistency.sh
 
-script: |
-    export RUST_BACKTRACE=1 &&
-    cargo build &&
-    cargo test --all-features &&
-    cargo doc --no-deps
+script:
+    - export RUST_BACKTRACE=1
+    - cd influxdb
+    - cargo build
+    - cargo test --all --all-features
+    - cargo doc --no-deps
+    - cd ../influxdb_derive
+    - cargo build
+    - cargo test --all --all-features
+    - cargo doc --no-deps

Cargo.toml

@@ -1,36 +1,8 @@
-[package]
-name = "influxdb"
-version = "0.0.6"
-authors = ["Gero Gerke <11deutron11@gmail.com>"]
-edition = "2018"
-description = "InfluxDB Driver for Rust"
-keywords = ["influxdb", "database", "influx"]
-license = "MIT"
-readme = "README.md"
-include = ["src/**/*", "tests/**/*", "Cargo.toml", "LICENSE"]
-repository = "https://github.com/Empty2k12/influxdb-rust"
+# -*- eval: (cargo-minor-mode 1) -*-
 
-[badges]
-travis-ci = { repository = "Empty2k12/influxdb-rust", branch = "master" }
+[workspace]
+members = ["influxdb", "influxdb_derive"]
 
-[dependencies]
-chrono = { version = "0.4.10", optional = true }
-failure = "0.1.6"
-futures = "0.3.4"
-reqwest = { version = "0.10.1", features = ["json"] }
-serde = { version = "1.0.104", features = ["derive"], optional = true }
-serde_json = { version = "1.0.46", optional = true }
-regex = "1.3.4"
-lazy_static = "1.4.0"
-
-# This is a temporary work around to fix a Failure-derive compilation error
-# Should be removed when https://github.com/Empty2k12/influxdb-rust/issues/48 is being done
-quote = "=1.0.2"
-
-[features]
-use-serde = ["serde", "serde_json"]
-chrono_timestamps = ["chrono"]
-default = ["use-serde"]
-
-[dev-dependencies]
-tokio = { version =  "0.2.11", features = ["macros"] }
+[patch.crates-io]
+influxdb = { path = "./influxdb" }
+influxdb_derive = { path = "./influxdb_derive" }

README.md

@@ -39,13 +39,12 @@ Pull requests are always welcome. See [Contributing](https://github.com/Empty2k1
 -   Optional Serde Support for Deserialization
 -   Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
 -   Authenticated and Unauthenticated Connections
--   Optional conversion between `Timestamp` and `Chrono::DateTime<Utc>` via `chrono_timestamps` compilation feature
 -   `async`/`await` support
+-   `#[derive(InfluxDbWriteable)]` Derive Macro for Writing / Reading into Structs
 
 ### Planned Features
 
 -   Read Query Builder instead of supplying raw queries
--   `#[derive(InfluxDbReadable)]` and `#[derive(InfluxDbWriteable)]` proc macros
 
 ## Quickstart
 
@@ -59,6 +58,7 @@ For an example with using Serde deserialization, please refer to [serde_integrat
 
 ```rust
 use influxdb::{Client, Query, Timestamp};
+use influxdb::InfluxDbWriteable;
 
 // Create a Client with URL `http://localhost:8086`
 // and database name `test`
@@ -67,7 +67,7 @@ let client = Client::new("http://localhost:8086", "test");
 // Let's write something to InfluxDB. First we're creating a
 // WriteQuery to write some data.
 // This creates a query which writes a new measurement into a series called `weather`
-let write_query = Query::write_query(Timestamp::Now, "weather")
+let write_query = Timestamp::Now.into_query("weather")
     .add_field("temperature", 82);
 
 // Submit the query to InfluxDB.

auxiliary/check_readme_consistency.sh

@@ -1,6 +1,6 @@
-#!/usr/bin/bash
+#!/bin/bash
 
-cargo readme > README.md.expected
+cargo readme -r influxdb -t ../README.tpl > README.md.expected
 
 diff README.md README.md.expected
 
@@ -9,6 +9,6 @@ then
     echo 'README.md is up to date!'
     exit 0
 else
-    echo 'README.md out of date. Run "cargo readme > README.md" and commit again.'
+    echo 'README.md out of date. Run "cargo readme -r influxdb -t ../README.tpl > README.md" and commit again.'
     exit 1
-fi
+fi

influxdb/Cargo.toml

@@ -0,0 +1,35 @@
+# -*- eval: (cargo-minor-mode 1) -*-
+
+[package]
+name = "influxdb"
+version = "0.0.6"
+authors = ["Gero Gerke <11deutron11@gmail.com>"]
+edition = "2018"
+description = "InfluxDB Driver for Rust"
+keywords = ["influxdb", "database", "influx"]
+license = "MIT"
+readme = "README.md"
+include = ["src/**/*", "tests/**/*", "Cargo.toml", "LICENSE"]
+repository = "https://github.com/Empty2k12/influxdb-rust"
+
+[badges]
+travis-ci = { repository = "Empty2k12/influxdb-rust", branch = "master" }
+
+[dependencies]
+chrono = { version = "0.4.10", features = ["serde"] } 
+failure = "0.1.6"
+futures = "0.3.4"
+influxdb_derive = { version = "0.0.1", optional = true }
+reqwest = { version = "0.10.1", features = ["json"] }
+serde = { version = "1.0.104", features = ["derive"], optional = true }
+serde_json = { version = "1.0.46", optional = true }
+regex = "1.3.4"
+lazy_static = "1.4.0"
+
+[features]
+use-serde = ["serde", "serde_json"]
+default = ["use-serde"]
+derive = ["influxdb_derive"]
+
+[dev-dependencies]
+tokio = { version =  "0.2.11", features = ["macros"] }

influxdb/LICENSE

@@ -0,0 +1 @@
+../LICENSE

influxdb/README.md

@@ -0,0 +1 @@
+../README.md

src/client/mod.rs influxdb/src/client/mod.rs

@@ -162,11 +162,13 @@ impl Client {
     ///
     /// ```rust,no_run
     /// use influxdb::{Client, Query, Timestamp};
+    /// use influxdb::InfluxDbWriteable;
     ///
     /// # #[tokio::main]
     /// # async fn main() -> Result<(), failure::Error> {
     /// let client = Client::new("http://localhost:8086", "test");
-    /// let query = Query::write_query(Timestamp::Now, "weather")
+    /// let query = Timestamp::Now
+    ///     .into_query("weather")
     ///     .add_field("temperature", 82);
     /// let results = client.query(&query).await?;
     /// # Ok(())

src/error.rs influxdb/src/error.rs

@@ -10,13 +10,12 @@
 //! -   Optional Serde Support for Deserialization
 //! -   Running multiple queries in one request (e.g. `SELECT * FROM weather_berlin; SELECT * FROM weather_london`)
 //! -   Authenticated and Unauthenticated Connections
-//! -   Optional conversion between `Timestamp` and `Chrono::DateTime<Utc>` via `chrono_timestamps` compilation feature
 //! -   `async`/`await` support
+//! -   `#[derive(InfluxDbWriteable)]` Derive Macro for Writing / Reading into Structs
 //!
 //! ## Planned Features
 //!
 //! -   Read Query Builder instead of supplying raw queries
-//! -   `#[derive(InfluxDbReadable)]` and `#[derive(InfluxDbWriteable)]` proc macros
 //!
 //! # Quickstart
 //!
@@ -30,6 +29,7 @@
 //!
 //! ```rust,no_run
 //! use influxdb::{Client, Query, Timestamp};
+//! use influxdb::InfluxDbWriteable;
 //!
 //! # #[tokio::main]
 //! # async fn main() {
@@ -40,7 +40,7 @@
 //! // Let's write something to InfluxDB. First we're creating a
 //! // WriteQuery to write some data.
 //! // This creates a query which writes a new measurement into a series called `weather`
-//! let write_query = Query::write_query(Timestamp::Now, "weather")
+//! let write_query = Timestamp::Now.into_query("weather")
 //!     .add_field("temperature", 82);
 //!
 //! // Submit the query to InfluxDB.
@@ -83,7 +83,7 @@ pub use error::Error;
 pub use query::{
     read_query::ReadQuery,
     write_query::{Type, WriteQuery},
-    Query, QueryType, QueryTypes, Timestamp, ValidQuery,
+    InfluxDbWriteable, Query, QueryType, QueryTypes, Timestamp, ValidQuery,
 };
 
 #[cfg(feature = "use-serde")]

src/integrations/serde_integration.rs influxdb/src/integrations/serde_integration.rs

@@ -8,12 +8,13 @@ lazy_static! {
     pub static ref COMMAS_SPACES: Regex = Regex::new("[, ]").unwrap();
     pub static ref COMMAS_SPACES_EQUALS: Regex = Regex::new("[, =]").unwrap();
     pub static ref QUOTES_SLASHES: Regex = Regex::new(r#"["\\]"#).unwrap();
+    pub static ref SLASHES: Regex = Regex::new(r#"(\\|,| |=|")"#).unwrap();
 }
 
 pub enum LineProtoTerm<'a> {
     Measurement(&'a str), // escape commas, spaces
     TagKey(&'a str),      // escape commas, equals, spaces
-    TagValue(&'a str),    // escape commas, equals, spaces
+    TagValue(&'a Type),   // escape commas, equals, spaces
     FieldKey(&'a str),    // escape commas, equals, spaces
     FieldValue(&'a Type), // escape quotes, backslashes + quote
 }
@@ -23,8 +24,9 @@ impl LineProtoTerm<'_> {
         use LineProtoTerm::*;
         match self {
             Measurement(x) => Self::escape_any(x, &*COMMAS_SPACES),
-            TagKey(x) | TagValue(x) | FieldKey(x) => Self::escape_any(x, &*COMMAS_SPACES_EQUALS),
+            TagKey(x) | FieldKey(x) => Self::escape_any(x, &*COMMAS_SPACES_EQUALS),
             FieldValue(x) => Self::escape_field_value(x),
+            TagValue(x) => Self::escape_tag_value(x),
         }
     }
 
@@ -42,7 +44,25 @@ impl LineProtoTerm<'_> {
             Float(v) => v.to_string(),
             SignedInteger(v) => format!("{}i", v),
             UnsignedInteger(v) => format!("{}i", v),
-            Text(v) => format!("\"{}\"", Self::escape_any(v, &*QUOTES_SLASHES)),
+            Text(v) => format!(r#""{}""#, Self::escape_any(v, &*SLASHES)),
+        }
+    }
+
+    fn escape_tag_value(v: &Type) -> String {
+        use Type::*;
+        match v {
+            Boolean(v) => {
+                if *v {
+                    "true"
+                } else {
+                    "false"
+                }
+            }
+            .to_string(),
+            Float(v) => format!(r#""{}""#, v.to_string()),
+            SignedInteger(v) => format!(r#""{}""#, v),
+            UnsignedInteger(v) => format!(r#""{}""#, v),
+            Text(v) => format!(r#""{}""#, Self::escape_any(v, &*SLASHES)),
         }
     }
 
@@ -58,6 +78,23 @@ mod test {
 
     #[test]
     fn test() {
+        assert_eq!(
+            TagValue(&Type::Text("this is my special string".into())).escape(),
+            r#""this\ is\ my\ special\ string""#
+        );
+        assert_eq!(
+            TagValue(&Type::Text("a tag w=i th == tons of escapes".into())).escape(),
+            r#""a\ tag\ w\=i\ th\ \=\=\ tons\ of\ escapes""#
+        );
+        assert_eq!(
+            TagValue(&Type::Text("no_escapes".into())).escape(),
+            r#""no_escapes""#
+        );
+        assert_eq!(
+            TagValue(&Type::Text("some,commas,here".into())).escape(),
+            r#""some\,commas\,here""#
+        );
+
         assert_eq!(Measurement(r#"wea", ther"#).escape(), r#"wea"\,\ ther"#);
         assert_eq!(TagKey(r#"locat\ ,=ion"#).escape(), r#"locat\\ \,\=ion"#);
 
@@ -75,14 +112,14 @@ mod test {
         assert_eq!(FieldValue(&Type::Text("\"".into())).escape(), r#""\"""#);
         assert_eq!(
             FieldValue(&Type::Text(r#"locat"\ ,=ion"#.into())).escape(),
-            r#""locat\"\\ ,=ion""#
+            r#""locat\"\\\ \,\=ion""#
         );
     }
 
     #[test]
     fn test_empty_tag_value() {
         // InfluxDB doesn't support empty tag values. But that's a job
         // of a calling site to validate an entire write request.
-        assert_eq!(TagValue("").escape(), "");
+        assert_eq!(TagValue(&Type::Text("".into())).escape(), r#""""#);
     }
 }