Struct dilla_renderer::attribute::Attribute

pub struct Attribute {
    attrs: IndexMap<String, Vec<String>>,
}

An Attribute support data to generate HTML attribute markup. @todo IndexMap is needed to ensure working test, as it can have a performance impact this could switch only for tests.

Fields

attrs: IndexMap<String, Vec<String>>

Implementations

impl Attribute

pub fn new() -> Self

pub fn get_attr(&self, name: &str) -> &[String]

Returns a slice reference to the attribute values for the given name.

If the attribute does not exist, returns an empty slice.

Arguments

• name - The name of the attribute to retrieve

Returns

A slice reference to the attribute values, or empty slice if not found.

Examples

use dilla_renderer::attribute::Attribute;

let mut attribute = Attribute::new();
attribute.add_attr("class", vec!["foo", "bar"]);

let empty = attribute.get_attr("unknown");
assert!(empty.is_empty());

let class = attribute.get_attr("class");
assert_eq!(class, &["foo", "bar"]);

pub fn build_scoped(&mut self, data: &Map<String, Value>)

Build and update HTML attributes based on data, scoped properties.

This function takes data, collect scoped properties, and combines them to generate a final set of HTML attributes. It specifically handles classes, styles, and other attributes.

Arguments

• data - A reference to a JSON-like data structure (serde_json::Map) that contain attribute information from Payload.

Examples

use dilla_renderer::attribute::Attribute;
use serde_json::{json, Map};

let mut attribute = Attribute::new();
let mut data = Map::new();

data.insert(
  format!("@styles"),
  json!(["style-1", "style-2"]),
);
data.insert(
  format!("@local_variables"),
  json!({"var-1": "#222", "var-2": "#333"}),
);

attribute.build_scoped(&data);

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_attribute("style".into()));
assert!(attribute.has_class("style-1".into()));
assert!(attribute.has_class("style-2".into()));
attribute.remove_attr_by_name("class");
assert_eq!(attribute.to_string(), " style=\"--var-1: #222; --var-2: #333;\"");

Returns

A modified Attribute object with updated HTML attributes.

pub fn build_attributes(&mut self, attributes: &Value)

Process the HTML attributes based on the provided data.

This function extracts and processes the HTML attributes from the given data. It handles class, style, and other attributes from the data payload.

Arguments

• data - A reference to a serde_json::Map containing the attribute information.

Examples

use dilla_renderer::attribute::Attribute;
use serde_json::{json, Map, Value};

let mut attribute = Attribute::new();
let mut attr = json!({
  "class": ["foo", "bar"],
  "style": "color: blue;",
  "data": "foo",
  "data-bool": true,
  "data-num": 56
});

attribute.build_attributes(&attr);

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_class("foo".into()));
assert!(attribute.has_class("bar".into()));

attribute.remove_attr_by_name("class");
assert_eq!(attribute.to_string(), " data-num=\"56\" style=\"color: blue;\" data=\"foo\" data-bool=\"true\"");

Returns

A modified Attribute object with updated HTML attributes.

pub fn add_attr( &mut self, name: &str, values: impl IntoIterator<Item = impl AsRef<str>> )

Add attributes by name and value. This is used in context of element and internally in this Attribute.

Arguments

• name - A string slice that represents the name of the attribute.
• values - An iterable representing the attributes to be added.

Examples

use dilla_renderer::attribute::Attribute;

let mut attribute = Attribute::new();
attribute.add_attr("class", vec!["foo", "bar"]);

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_class("foo".into()));
assert!(attribute.has_class("bar".into()));
assert!(!attribute.has_class("other".into()));
assert!(!attribute.has_class("unknown".into()));

pub fn add_attrs_from_jinja(&mut self, values: &Value)

Adds attributes from a minijinja::value::Value.

This method takes a Value object, which is expected to be an iterable, and loops through each key-value pair. For each key-value pair, it attempts to retrieve the name and values of the attribute. If successful, it calls the add_attr_from_jinja method to add the attribute to the Attribute object.

Arguments

• values - A minijinja::value::Value representing the attributes to be added.

Examples

use dilla_renderer::attribute::Attribute;
use minijinja::value::Value;

let mut attribute = Attribute::new();
let jinja_attrs = Value::from_iter(vec![
  ("class", Value::from_iter(vec!["foo", "bar"])),
  ("data-id", Value::from("123")),
]);
attribute.add_attrs_from_jinja(&jinja_attrs);

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_class("foo".into()));
assert!(attribute.has_class("bar".into()));
assert!(!attribute.has_class("other".into()));
assert!(attribute.has_attribute("data-id".into()));
assert!(!attribute.has_attribute("unknown".into()));

pub fn add_attr_from_jinja(&mut self, name: &str, values: Value)

Add attributes by name from a minijinja::value::Value. This is used in context of filters |add_class and |set_attribute

Arguments

• name - A string slice that represents the name of the attribute.
• values - A minijinja::value::Value representing the attributes to be added.

Examples

use dilla_renderer::attribute::Attribute;
use minijinja::value::Value;
use serde_json::json;

let mut attribute = Attribute::new();

attribute.add_attr_from_jinja("class".into(), Value::from_iter(vec!["foo", "bar"]));
// Note: style as manual input must include formatting.
attribute.add_attr_from_jinja("style".into(), [("--var-1:", "#222;"), ("--var-2:", "#333;")].into_iter().collect());
attribute.add_attr_from_jinja("data-id".into(), Value::from(123));

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_attribute("style".into()));
assert!(attribute.has_class("foo".into()));
assert!(attribute.has_class("bar".into()));
assert!(!attribute.has_class("other".into()));

assert!(attribute.has_attribute("data-id".into()));
assert!(!attribute.has_attribute("data-unknown".into()));

pub fn add_attr_from_serde(&mut self, values: &Value)

Add attributes from an iterable serde_json::Value serialized as [minijinja::value]. This is used for component and element attributes management as we are working with serde_json::value.

Arguments

• values - A serde_json::Value reference representing the attributes to be added.

Examples

use dilla_renderer::attribute::Attribute;
use serde_json::{json, Map, Value};

let mut attribute = Attribute::new();
let mut serde_attrs = Map::new();
serde_attrs.insert(
  "class".into(),
  json!(["foo", "bar"]),
);
serde_attrs.insert(
  "data-id".into(),
  Value::from(123),
);
attribute.add_attr_from_serde(&Value::from(serde_attrs));

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_class("foo".into()));
assert!(attribute.has_class("bar".into()));
assert!(!attribute.has_class("other".into()));
assert!(attribute.has_attribute("data-id".into()));
assert!(!attribute.has_attribute("unknown".into()));

pub fn merge_attrs_from_jinja(&mut self, values: &Value)

Merges attributes from a minijinja Value map into the current struct.

This takes a minijinja Value that is a Map and extracts any string keys and values, merging them into the existing attributes of this struct.

If an attribute already exists, the new values are appended to the existing Vec of values. Otherwise a new attribute is added with the given values.

Arguments

• values - The minijinja Value map to extract attributes from

Examples

use dilla_renderer::attribute::Attribute;
use minijinja::value::Value;

let mut attribute = Attribute::new();
let jinja_attrs = Value::from_iter(vec![
  ("class", Value::from_iter(vec!["foo", "bar"])),
  ("data-id", Value::from("123")),
]);
attribute.add_attrs_from_jinja(&jinja_attrs);

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_class("foo".into()));
assert!(attribute.has_class("bar".into()));
assert_eq!(attribute.get_attr("data-id".into()), &vec!["123".to_string()]);

let merge_attrs = Value::from_iter(vec![
  ("class", Value::from_iter(vec!["alpha", "bar"])),
  ("data-id", Value::from("456")),
  ("data-new", Value::from("new")),
]);
attribute.merge_attrs_from_jinja(&merge_attrs);

assert!(attribute.has_attribute("class".into()));
assert!(attribute.has_class("foo".into()));
assert!(attribute.has_class("bar".into()));
assert!(attribute.has_class("alpha".into()));
assert!(attribute.has_attribute("data-id".into()));
assert_eq!(attribute.get_attr("data-id".into()), &vec!["456".to_string()]);
assert!(attribute.has_attribute("data-new".into()));

pub fn remove_attr_by_name(&mut self, name: &str)

Removes the attribute with the specified name from the element.

Arguments

• name - A string slice representing the name of the attribute to be removed.

Example

use dilla_renderer::attribute::Attribute;

let mut attribute = Attribute::new();
attribute.add_attr("class", vec!["foo"]);
assert!(attribute.has_attribute("class".into()));

attribute.remove_attr_by_name("class");
assert!(!attribute.has_attribute("class".into()));

pub fn remove_class_by_name(&mut self, class: &str)

Removes the attribute with the specified name from a minijinja::value::Value. This is used in context of filter |remove_class

Arguments

• name - A string slice representing the name of the attribute to be checked.
• values - A minijinja::value::Value representing the attributes to be removed from the name.

Example

use dilla_renderer::attribute::Attribute;
use minijinja::value::Value;

let mut attribute = Attribute::new();
attribute.add_attr("class", vec!["foo", "bar"]);

attribute.remove_class_by_name("bar".into());

assert!(attribute.has_class("foo".into()));
assert!(!attribute.has_class("bar".into()));

attribute.add_attr("class", vec!["some", "other"]);
attribute.remove_class_by_name("foo".into());
attribute.remove_class_by_name("some".into());

assert!(!attribute.has_class("foo".into()));
assert!(!attribute.has_class("some".into()));
assert!(attribute.has_class("other".into()));

pub fn has_class(&self, class: Value) -> bool

Check if the element has a specific class name under the ‘class’ attribute. This is used in context of filter |has_class

Arguments

• class - A minijinja::value::Value representing the class name to check.

Returns

• bool: true if the attribute has the specified class, false otherwise.

Example

use dilla_renderer::attribute::Attribute;

let mut attribute = Attribute::new();
attribute.add_attr("class", vec!["container"]);
assert!(attribute.has_class("container".into()));
assert!(!attribute.has_class("row".into()));

pub fn has_attribute(&self, name: Value) -> bool

Checks if the given attribute name exists. This is used in context of filter |has_attribute

Arguments

• name: The name of the attribute to check.

Returns

• bool: true if the attribute exists, false otherwise.

Example

use dilla_renderer::attribute::Attribute;

let mut attribute = Attribute::new();
attribute.add_attr("foo", vec!["bar"]);
assert!(attribute.has_attribute("foo".into()));
assert!(!attribute.has_attribute("bar".into()));

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Attribute

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Attribute

fn default() -> Attribute

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Attribute

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Attribute

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Attribute> for Value

fn from(attribute: Attribute) -> Self

Converts to this type from the input type.

impl From<Attribute> for Value

fn from(attribute: Attribute) -> Self

Converts to this type from the input type.

impl From<Value> for Attribute

fn from(v: Value) -> Self

Converts to this type from the input type.

impl Object for Attribute

fn call_method( &self, _state: &State<'_, '_>, name: &str, args: &[Value] ) -> Result<Value, Error>

Called when the engine tries to call a method on the object.

fn kind(&self) -> ObjectKind<'_>

Describes the kind of an object.

fn call(&self, state: &State<'_, '_>, args: &[Value]) -> Result<Value, Error>

Called when the object is invoked directly.

impl Serialize for Attribute

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.