1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
use std::{collections::HashMap, fmt::Write};
use stepflow_base::{ObjectStoreFiltered, IdError};
use stepflow_data::{StateDataFiltered, var::{Var, VarId, StringVar, EmailVar, BoolVar}, value::StringValue};
use super::{ActionResult, Action, ActionId, Step, ActionError};
use crate::{render_template, EscapedString, HtmlEscapedString};


/// Configuration for [`HtmlFormAction`]
///
/// Customize the output of [`HtmlFormAction`] with these parameters. The templates can use `{{name}}` as a placeholder for the [`Var`] name.
///
/// ```
/// # use stepflow_action::HtmlFormConfig;
/// let mut html_form_config: HtmlFormConfig = Default::default();
/// html_form_config.stringvar_html_template = "<textarea name='{{name}}'></textarea>".to_owned();
/// ```
// Someday we should have a HtmlFormTag trait that any var can implement and then call that for their tag. not able until we can cast a Var trait to a HtmlFormTag trait
#[derive(Debug)]
pub struct HtmlFormConfig {
  /// HTML template for [`StringVar`] 
  pub stringvar_html_template: String,

  /// HTML template for [`EmailVar`] 
  pub emailvar_html_template: String,

  /// HTML template for [`BoolVar`] 
  pub boolvar_html_template: String,

  /// Optional HTML template inserted before any field
  /// For example, you can output a label for every field with:
  /// ```
  /// # use stepflow_action::HtmlFormConfig;
  /// # let mut html_form_config: HtmlFormConfig = Default::default();
  /// html_form_config.prefix_html_template = Some("<label for='{{name}}'>{{name}}</label>".to_owned());
  /// ```
  pub prefix_html_template: Option<String>,

  /// HTML tag that will wrap the prefix and field templates.
  /// For example, you can wrap every field + label with a div:
  /// ```
  /// # use stepflow_action::HtmlFormConfig;
  /// # let mut html_form_config: HtmlFormConfig = Default::default();
  /// html_form_config.wrap_tag = Some("div".to_owned());
  /// ```

  pub wrap_tag: Option<String>, // ie. wrap entire element in a <div></div>
}

impl HtmlFormConfig {
  fn format_html_template(tag_template: &HtmlEscapedString, name_escaped: &HtmlEscapedString) -> String {
    let mut params = HashMap::new();
    params.insert("name", name_escaped);
    render_template::<&HtmlEscapedString>(&tag_template, params)
  }

  fn valid_wraptag(&self) -> Option<&String> {
    if let Some(wrap_tag) = &self.wrap_tag {
      if !wrap_tag.is_empty() {
        return Some(wrap_tag);
      }
    }
    None
  }

  fn format_input_template(&self, html_template: &String, name_escaped: &HtmlEscapedString) -> Result<String, std::fmt::Error> {
    let mut html = String::with_capacity(html_template.len() + name_escaped.len()); // rough guss

    // write the head of the wrap
    if let Some(wrap_tag) = self.valid_wraptag() {
      if !wrap_tag.is_empty() {
        write!(html, "<{}>", wrap_tag)?;
      }
    }

    // write the prefix
    if let Some(prefix_html_template) = &self.prefix_html_template {
      let prefix_html = Self::format_html_template(&HtmlEscapedString::already_escaped(prefix_html_template.to_owned()), name_escaped);
      html.write_str(&prefix_html[..])?;
    }

    // write the tag
    let input_html = Self::format_html_template(&HtmlEscapedString::already_escaped(html_template.to_owned()), name_escaped);
    html.write_str(&input_html[..])?;

    // write the tail of the wrap
    if let Some(wrap_tag) = self.valid_wraptag() {
      write!(html, "</{}>", wrap_tag)?;
    }
  

    Ok(html)
  }
}

impl Default for HtmlFormConfig {
    fn default() -> Self {
        HtmlFormConfig {
          stringvar_html_template: "<input name='{{name}}' type='text' />".to_owned(),
          emailvar_html_template: "<input name='{{name}}' type='email' />".to_owned(),
          boolvar_html_template: "<input name='{{name}}' type='checkbox' />".to_owned(),
          prefix_html_template: None,
          wrap_tag: None,
        }
    }
}


/// Action to generate an HTML form for a [`Step`]
///
/// The action looks iterates through all the outputs of the current Step and generates HTML based on the [`HtmlFormConfig`].
/// The HTML is returned as a string in the [`ActionResult::StartWith`] result
#[derive(Debug)]
pub struct HtmlFormAction {
  id: ActionId,
  html_config: HtmlFormConfig,
}

impl HtmlFormAction {
  /// Create a new HtmlFormAction
  pub fn new(id: ActionId, html_config: HtmlFormConfig) -> Self {
    HtmlFormAction {
      id,
      html_config,
    }
  }
}

impl Action for HtmlFormAction {
  fn id(&self) -> &ActionId {
    &self.id
  }

  fn boxed(self) -> Box<dyn Action + Sync + Send> {
    Box::new(self)
  }

  fn start(&mut self, step: &Step, _step_name: Option<&str>, _step_data: &StateDataFiltered, vars: &ObjectStoreFiltered<Box<dyn Var + Send + Sync>, VarId>)
    -> Result<ActionResult, ActionError>
  {
    const AVG_NAME_LEN: usize = 5;
    let mut html = String::with_capacity(step.get_output_vars().len() * (self.html_config.stringvar_html_template.len() + AVG_NAME_LEN));
    for var_id in step.get_output_vars().iter() {
      let name = vars.name_from_id(var_id).ok_or_else(|| ActionError::VarId(IdError::IdHasNoName(var_id.clone())))?;
      let name_escaped = HtmlEscapedString::from_unescaped(&(name.to_string())[..]);

      let var = vars.get(var_id).ok_or_else(|| ActionError::VarId(IdError::IdMissing(var_id.clone())))?;
      let html_template;
      if var.is::<StringVar>() {
        html_template = &self.html_config.stringvar_html_template;
      } else if var.is::<EmailVar>() {
        html_template = &self.html_config.emailvar_html_template;
      } else if var.is::<BoolVar>() {
        html_template = &self.html_config.boolvar_html_template;
      } else {
        // perhaps panic when in debug? 
        // maybe in the future we should ask variables to support a trait that gets their HTML format
        return Err(ActionError::VarId(IdError::IdUnexpected(var_id.clone())));
      }

      self.html_config
        .format_input_template(html_template, &name_escaped)
        .and_then(|input_html| html.write_str(&input_html[..]))
        .map_err(|_e| ActionError::Other)?;
    }

    let stringval = StringValue::try_new(html).map_err(|_e| ActionError::Other)?;
    Ok(ActionResult::StartWith(stringval.boxed()))
  }
}



#[cfg(test)]
mod tests {
  use std::collections::HashSet;
  use super::{HtmlEscapedString, EscapedString, HtmlFormConfig, HtmlFormAction};
  use stepflow_base::{ObjectStore, ObjectStoreFiltered};
  use stepflow_data::{StateData, StateDataFiltered, var::{Var, VarId, EmailVar, StringVar}, value::StringValue};
  use stepflow_step::{Step, StepId};
  use stepflow_test_util::test_id;
  use super::super::{ActionResult, Action, ActionId};

  #[test]
  fn html_format_input() {
    let mut html_config: HtmlFormConfig = Default::default();
    html_config.stringvar_html_template = "s({{name}},{{name}})".to_owned();
    html_config.emailvar_html_template = "e({{name}},{{name}})".to_owned();

    // simple case
    let escaped_n = HtmlEscapedString::from_unescaped("n");
    let formatted = html_config.format_input_template(&html_config.stringvar_html_template, &escaped_n).unwrap();
    assert_eq!(formatted, "s(n,n)");

    // add prefix
    html_config.prefix_html_template = Some("p({{name}})".to_owned());
    let formatted_prefix = html_config.format_input_template(&html_config.stringvar_html_template, &escaped_n).unwrap();
    assert_eq!(formatted_prefix, "p(n)s(n,n)");

    // add wrap
    html_config.wrap_tag = Some("div".to_owned());
    let wrapped_prefix = html_config.format_input_template(&html_config.stringvar_html_template, &escaped_n).unwrap();
    assert_eq!(wrapped_prefix, "<div>p(n)s(n,n)</div>");

    // empty wrap
    html_config.wrap_tag = Some(String::new());
    let wrapped_empty = html_config.format_input_template(&html_config.stringvar_html_template, &escaped_n).unwrap();
    assert_eq!(wrapped_empty, "p(n)s(n,n)");
  }

  #[test]
  fn simple_form() {
    let var1 = StringVar::new(test_id!(VarId));
    let var2 = EmailVar::new(test_id!(VarId));
    let var_ids = vec![var1.id().clone(), var2.id().clone()];
    let step = Step::new(StepId::new(4), None, var_ids.clone());

    let state_data = StateData::new();
    let var_filter = var_ids.iter().map(|id| id.clone()).collect::<HashSet<_>>();
    let step_data_filtered = StateDataFiltered::new(&state_data, var_filter.clone());

    let mut var_store: ObjectStore<Box<dyn Var + Send + Sync>, VarId> = ObjectStore::new();
    var_store.register_named("var 1", var1.boxed()).unwrap();
    var_store.register_named("var 2", var2.boxed()).unwrap();

    let var_store_filtered = ObjectStoreFiltered::new(&var_store, var_filter);

    let mut exec = HtmlFormAction::new(test_id!(ActionId), Default::default());
    let action_result = exec.start(&step, None, &step_data_filtered, &var_store_filtered).unwrap();
    if let ActionResult::StartWith(html) = action_result {
      let html = html.downcast::<StringValue>().unwrap().val();
      assert_eq!(html, "<input name='var&#x20;1' type='text' /><input name='var&#x20;2' type='email' />");
    } else {
      panic!("Did not get startwith value");
    }

    // customize the tags
    let mut html_config: HtmlFormConfig = Default::default();
    html_config.prefix_html_template = Some("p({{name}})".to_owned());
    html_config.stringvar_html_template = "l({{name}})s({{name}})".to_owned();
    html_config.emailvar_html_template = "l({{name}})e({{name}})".to_owned();
    let mut custom_exec = HtmlFormAction::new(test_id!(ActionId), html_config);
    let custom_result = custom_exec.start(&step, None, &step_data_filtered, &var_store_filtered).unwrap();
    if let ActionResult::StartWith(html) = custom_result {
      let html = html.downcast::<StringValue>().unwrap().val();
      assert_eq!(html, "p(var&#x20;1)l(var&#x20;1)s(var&#x20;1)p(var&#x20;2)l(var&#x20;2)e(var&#x20;2)");
    } else {
      panic!("Did not get startwith value");
    }
  }

}