Tidy up folder structure (#85)

* reconfigure folder structure

* disambiguate import and fix feature gating

Author: mfreeborn

plotly/src/common/color.rs

@@ -479,6 +479,7 @@ mod tests {
         );
     }
 
+    #[test]
     fn color_from_f64() {
         assert_eq!(1.54.to_color(), ColorWrapper::F(1.54));
         assert_eq!(0.1.to_color(), ColorWrapper::F(0.1));

plotly/src/common/mod.rs

@@ -1,10 +1,9 @@
-use serde::{Serialize, Serializer};
-
 pub mod color;
 
+use serde::{Serialize, Serializer};
+
 use crate::common::color::ColorWrapper;
-use crate::private::NumOrString;
-use crate::private::{self, NumOrStringCollection};
+use crate::private;
 use color::Color;
 
 #[derive(Serialize, Clone, Debug)]
@@ -688,7 +687,7 @@ impl Gradient {
 pub struct TickFormatStop {
     enabled: bool,
     #[serde(skip_serializing_if = "Option::is_none", rename = "dtickrange")]
-    dtick_range: Option<NumOrStringCollection>,
+    dtick_range: Option<private::NumOrStringCollection>,
     #[serde(skip_serializing_if = "Option::is_none")]
     value: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -710,7 +709,7 @@ impl TickFormatStop {
         self
     }
 
-    pub fn dtick_range<V: Into<NumOrString> + Clone>(mut self, range: Vec<V>) -> Self {
+    pub fn dtick_range<V: Into<private::NumOrString> + Clone>(mut self, range: Vec<V>) -> Self {
         self.dtick_range = Some(range.into());
         self
     }

plotly/src/layout.rs renamed to plotly/src/layout/mod.rs

@@ -1,3 +1,5 @@
+pub mod themes;
+
 use serde::{Serialize, Serializer};
 use std::borrow::Cow;
 

plotly/src/themes.rs renamed to plotly/src/layout/themes.rs

@@ -2,61 +2,38 @@
 //!
 //! A plotting library for Rust powered by [Plotly.js](https://plot.ly/javascript/).
 #![recursion_limit = "256"] // lets us use a large serde_json::json! macro for testing crate::layout::Axis
-#![allow(dead_code)]
 extern crate askama;
 extern crate rand;
 extern crate serde;
 
+#[cfg(feature = "plotly_ndarray")]
 pub mod ndarray;
 
 #[cfg(feature = "wasm")]
 pub mod bindings;
 
+pub mod common;
 pub mod configuration;
 pub mod layout;
 pub mod plot;
+mod traces;
 
-pub mod themes;
-
-pub mod bar;
-pub mod box_plot;
-pub mod candlestick;
-pub mod common;
-pub mod contour;
-pub mod heat_map;
-pub mod histogram;
-pub mod ohlc;
-pub mod sankey;
-pub mod scatter;
-pub mod scatter_polar;
-pub mod surface;
-
-pub use crate::configuration::Configuration;
-pub use crate::layout::Layout;
-pub use crate::plot::ImageFormat;
-pub use crate::plot::Plot;
-
-pub use crate::bar::Bar;
-pub use crate::box_plot::BoxPlot;
-pub use crate::candlestick::Candlestick;
-pub use crate::contour::Contour;
-pub use crate::heat_map::HeatMap;
-pub use crate::histogram::Histogram;
-pub use crate::ohlc::Ohlc;
-pub use crate::sankey::Sankey;
-pub use crate::scatter::Scatter;
-pub use crate::scatter_polar::ScatterPolar;
-pub use crate::surface::Surface;
-
-pub use crate::common::color::NamedColor;
-pub use crate::common::color::Rgb;
-pub use crate::common::color::Rgba;
+pub use common::color::{NamedColor, Rgb, Rgba};
+pub use configuration::Configuration;
+pub use layout::Layout;
+pub use plot::{ImageFormat, Plot, Trace};
 
-pub use crate::plot::Trace;
+// Bring the different trace types into the top-level scope
+pub use traces::{
+    Bar, BoxPlot, Candlestick, Contour, HeatMap, Histogram, Ohlc, Sankey, Scatter, ScatterPolar,
+    Surface,
+};
+// Also provide easy access to modules which contain additional trace-specific types
+pub use traces::{box_plot, contour, histogram, sankey, surface};
 
 #[cfg(feature = "plotly_ndarray")]
 pub use crate::ndarray::ArrayTraces;
 
 // Not public API.
 #[doc(hidden)]
-pub mod private;
+mod private;

plotly/src/lib.rs

@@ -6,7 +6,6 @@ use dyn_clone::DynClone;
 use erased_serde::Serialize as ErasedSerialize;
 use rand::{thread_rng, Rng};
 use serde::Serialize;
-use std::env;
 use std::fs::File;
 use std::io::Write;
 use std::path::Path;
@@ -139,6 +138,7 @@ pub struct Plot {
     remote_plotly_js: bool,
 }
 
+#[cfg(not(feature = "wasm"))]
 const DEFAULT_HTML_APP_NOT_FOUND: &str = r#"Could not find default application for HTML files.
 Consider using the `to_html` method to save the plot instead. If using the `kaleido` feature the
 `save` method can be used to produce a static image in one of the following formats:
@@ -220,6 +220,8 @@ impl Plot {
     /// in the /tmp directory.
     #[cfg(not(feature = "wasm"))]
     pub fn show(&self) {
+        use std::env;
+
         let rendered = self.render(false, "", 0, 0);
         let rendered = rendered.as_bytes();
         let mut temp = env::temp_dir();
@@ -251,6 +253,8 @@ impl Plot {
     /// To save the resulting png right-click on the resulting image and select `Save As...`.
     #[cfg(not(feature = "wasm"))]
     pub fn show_png(&self, width: usize, height: usize) {
+        use std::env;
+
         let rendered = self.render(true, "png", width, height);
         let rendered = rendered.as_bytes();
         let mut temp = env::temp_dir();
@@ -281,6 +285,8 @@ impl Plot {
     /// To save the resulting png right-click on the resulting image and select `Save As...`.
     #[cfg(not(feature = "wasm"))]
     pub fn show_jpeg(&self, width: usize, height: usize) {
+        use std::env;
+
         let rendered = self.render(true, "jpg", width, height);
         let rendered = rendered.as_bytes();
         let mut temp = env::temp_dir();
@@ -472,7 +478,7 @@ impl Plot {
             .expect("Invalid JSON structure - expected a top-level Object")
     }
 
-    #[cfg(target_os = "linux")]
+    #[cfg(all(target_os = "linux", not(feature = "wasm")))]
     fn show_with_default_app(temp_path: &str) {
         use std::process::Command;
         Command::new("xdg-open")
@@ -481,7 +487,7 @@ impl Plot {
             .expect(DEFAULT_HTML_APP_NOT_FOUND);
     }
 
-    #[cfg(target_os = "macos")]
+    #[cfg(all(target_os = "macos", not(feature = "wasm")))]
     fn show_with_default_app(temp_path: &str) {
         use std::process::Command;
         Command::new("open")
@@ -490,7 +496,7 @@ impl Plot {
             .expect(DEFAULT_HTML_APP_NOT_FOUND);
     }
 
-    #[cfg(target_os = "windows")]
+    #[cfg(all(target_os = "windows", not(feature = "wasm")))]
     fn show_with_default_app(temp_path: &str) {
         use std::process::Command;
         Command::new("cmd")

plotly/src/ndarray/mod.rs renamed to plotly/src/ndarray.rs

@@ -1,6 +1,7 @@
-use crate::common::color::{Color, ColorWrapper};
 use serde::Serialize;
 
+use crate::common::color::{Color, ColorWrapper};
+
 #[cfg(feature = "plotly_ndarray")]
 use crate::ndarray::ArrayTraces;
 #[cfg(feature = "plotly_ndarray")]
@@ -20,19 +21,6 @@ pub fn to_color_array<C: Color>(v: Vec<C>) -> Vec<ColorWrapper> {
     sv
 }
 
-pub fn is_valid_color_array(a: &[ColorWrapper]) -> bool {
-    let mut sv: Vec<String> = Vec::new();
-    let mut fv: Vec<f64> = Vec::new();
-    for e in a.iter() {
-        match e {
-            ColorWrapper::F(n) => fv.push(*n),
-            ColorWrapper::S(s) => sv.push(s.clone()),
-        }
-    }
-
-    !sv.is_empty() && !fv.is_empty()
-}
-
 #[derive(Serialize, Clone, Debug, PartialEq)]
 #[serde(untagged)]
 pub enum NumOrString {