Merge pull request #38 from ynqa/v0.5.1/dev

v0.5.1

README.md

@@ -11,7 +11,7 @@ Put the package in your `Cargo.toml`.
 
 ```toml
 [dependencies]
-promkit = "0.5.0"
+promkit = "0.5.1"
 ```
 
 ## Features

promkit/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "promkit"
-version = "0.5.0"
+version = "0.5.1"
 authors = ["ynqa <un.pensiero.vano@gmail.com>"]
 edition = "2021"
 description = "A toolkit for building your own interactive command-line tools"

promkit/src/core/checkbox.rs

@@ -1,4 +1,4 @@
-use std::{collections::HashSet, fmt, iter::FromIterator};
+use std::{collections::HashSet, fmt};
 
 use crate::{core::listbox::Listbox, grapheme::StyledGraphemes};
 
@@ -16,20 +16,23 @@ pub struct Checkbox {
     picked: HashSet<usize>,
 }
 
-impl<T: fmt::Display> FromIterator<T> for Checkbox {
-    /// Creates a `Checkbox` from an iterator of items
-    /// that implement the `Display` trait.
-    /// Each item is added to the listbox,
-    /// and the set of picked indices is initialized as empty.
-    fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
+impl Checkbox {
+    /// Creates a new `Checkbox` from a vector of `fmt::Display`.
+    pub fn from_displayable<E: fmt::Display, I: IntoIterator<Item = E>>(items: I) -> Self {
         Self {
-            listbox: Listbox::from_iter(iter),
+            listbox: Listbox::from_displayable(items),
+            picked: HashSet::new(),
+        }
+    }
+
+    /// Creates a new `Checkbox` from a vector of `StyledGraphemes`.
+    pub fn from_styled_graphemes(items: Vec<StyledGraphemes>) -> Self {
+        Self {
+            listbox: Listbox::from_styled_graphemes(items),
             picked: HashSet::new(),
         }
     }
-}
 
-impl Checkbox {
     /// Creates a `Checkbox` from an iterator of tuples where the first element
     /// implements the `Display` trait and the second element is a bool indicating
     /// if the item is picked (selected).
@@ -61,7 +64,7 @@ impl Checkbox {
             .collect::<HashSet<usize>>();
 
         Self {
-            listbox: Listbox::from_iter(listbox_items),
+            listbox: Listbox::from_displayable(listbox_items),
             picked: picked_indices,
         }
     }

promkit/src/core/listbox.rs

@@ -1,4 +1,4 @@
-use std::{fmt, iter::FromIterator};
+use std::fmt;
 
 use crate::{core::cursor::Cursor, grapheme::StyledGraphemes};
 
@@ -20,23 +20,24 @@ impl Default for Listbox {
     }
 }
 
-impl<T: fmt::Display> FromIterator<T> for Listbox {
-    /// Creates a `Listbox` from an iterator of items
-    /// that implement the `Display` trait.
-    /// Each item is converted to a `String`
-    /// and collected into a `Vec<String>`.
-    fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
+impl Listbox {
+    /// Creates a new `Listbox` from a vector of `fmt::Display`.
+    pub fn from_displayable<E: fmt::Display, I: IntoIterator<Item = E>>(items: I) -> Self {
         Self(Cursor::new(
-            iter.into_iter()
+            items
+                .into_iter()
                 .map(|e| StyledGraphemes::from(format!("{}", e)))
                 .collect(),
             0,
             false,
         ))
     }
-}
 
-impl Listbox {
+    /// Creates a new `Listbox` from a vector of `StyledGraphemes`.
+    pub fn from_styled_graphemes(items: Vec<StyledGraphemes>) -> Self {
+        Self(Cursor::new(items, 0, false))
+    }
+
     /// Returns a reference to the vector of items in the listbox.
     pub fn items(&self) -> &Vec<StyledGraphemes> {
         self.0.contents()

promkit/src/core/text_editor.rs

@@ -101,7 +101,7 @@ impl TextEditor {
             let pos = self.position();
             self.0
                 .contents_mut()
-                .replace_range(pos..pos + 1, &ch.to_string());
+                .replace_range(pos..pos + 1, ch.to_string());
             self.forward();
         }
     }

promkit/src/lib.rs

@@ -11,21 +11,21 @@
 //!
 //! ```toml
 //! [dependencies]
-//! promkit = "0.5.0"
+//! promkit = "0.5.1"
 //! ```
 //!
 //! ## Features
 //!
 //! - Support cross-platform both UNIX and Windows owing to [crossterm](https://github.com/crossterm-rs/crossterm)
 //! - Various building methods
 //!   - Preset; Support for quickly setting up a UI by providing simple parameters.
-//!     - [Readline](https://github.com/ynqa/promkit/tree/v0.5.0#readline)
-//!     - [Confirm](https://github.com/ynqa/promkit/tree/v0.5.0#confirm)
-//!     - [Password](https://github.com/ynqa/promkit/tree/v0.5.0#password)
-//!     - [Select](https://github.com/ynqa/promkit/tree/v0.5.0#select)
-//!     - [QuerySelect](https://github.com/ynqa/promkit/tree/v0.5.0#queryselect)
-//!     - [Checkbox](https://github.com/ynqa/promkit/tree/v0.5.0#checkbox)
-//!     - [Tree](https://github.com/ynqa/promkit/tree/v0.5.0#tree)
+//!     - [Readline](https://github.com/ynqa/promkit/tree/v0.5.1#readline)
+//!     - [Confirm](https://github.com/ynqa/promkit/tree/v0.5.1#confirm)
+//!     - [Password](https://github.com/ynqa/promkit/tree/v0.5.1#password)
+//!     - [Select](https://github.com/ynqa/promkit/tree/v0.5.1#select)
+//!     - [QuerySelect](https://github.com/ynqa/promkit/tree/v0.5.1#queryselect)
+//!     - [Checkbox](https://github.com/ynqa/promkit/tree/v0.5.1#checkbox)
+//!     - [Tree](https://github.com/ynqa/promkit/tree/v0.5.1#tree)
 //!   - Combining various UI components.
 //!     - They are provided with the same interface, allowing users to choose and
 //!       assemble them according to their preferences.
@@ -39,7 +39,7 @@
 //!
 //! ## Examples/Demos
 //!
-//! See [here](https://github.com/ynqa/promkit/tree/v0.5.0#examplesdemos)
+//! See [here](https://github.com/ynqa/promkit/tree/v0.5.1#examplesdemos)
 //!
 //! ## Why *promkit*?
 //!

promkit/src/preset/checkbox.rs

@@ -29,7 +29,7 @@ impl Checkbox {
     /// # Arguments
     ///
     /// * `items` - An iterator over items
-    /// that implement the `Display` trait, to be used as options.
+    ///   that implement the `Display` trait, to be used as options.
     pub fn new<T: Display, I: IntoIterator<Item = T>>(items: I) -> Self {
         Self {
             title_state: text::State {
@@ -39,7 +39,7 @@ impl Checkbox {
                     .build(),
             },
             checkbox_state: checkbox::State {
-                checkbox: checkbox::Checkbox::from_iter(items),
+                checkbox: checkbox::Checkbox::from_displayable(items),
                 cursor: String::from("❯ "),
                 active_mark: '☒',
                 inactive_mark: '☐',

promkit/src/preset/listbox.rs

@@ -28,7 +28,7 @@ impl Listbox {
     /// # Arguments
     ///
     /// * `items` - An iterator over items
-    /// that implement the `Display` trait, to be used as options.
+    ///   that implement the `Display` trait, to be used as options.
     pub fn new<T: Display, I: IntoIterator<Item = T>>(items: I) -> Self {
         Self {
             title_state: text::State {
@@ -38,7 +38,7 @@ impl Listbox {
                     .build(),
             },
             listbox_state: listbox::State {
-                listbox: listbox::Listbox::from_iter(items),
+                listbox: listbox::Listbox::from_displayable(items),
                 cursor: String::from("❯ "),
                 active_item_style: Some(StyleBuilder::new().fgc(Color::DarkCyan).build()),
                 inactive_item_style: Some(StyleBuilder::new().build()),

promkit/src/preset/query_selector.rs

@@ -1,4 +1,4 @@
-use std::{cell::RefCell, fmt::Display, iter::FromIterator};
+use std::{cell::RefCell, fmt::Display};
 
 use crate::{
     crossterm::style::{Attribute, Attributes, Color, ContentStyle},
@@ -37,10 +37,10 @@ impl QuerySelector {
     /// # Arguments
     ///
     /// * `items` - An iterator over items that implement the `Display` trait,
-    /// to be used as options in the list box.
+    ///   to be used as options in the list box.
     /// * `filter` - A function that takes the current input
-    /// from the text editor and the list of items,
-    /// returning a filtered list of items to display.
+    ///   from the text editor and the list of items,
+    ///   returning a filtered list of items to display.
     pub fn new<T, I>(items: I, filter: render::Filter) -> Self
     where
         T: Display,
@@ -66,7 +66,7 @@ impl QuerySelector {
                 lines: Default::default(),
             },
             listbox_state: listbox::State {
-                listbox: Listbox::from_iter(items),
+                listbox: Listbox::from_displayable(items),
                 cursor: String::from("❯ "),
                 active_item_style: Some(StyleBuilder::new().fgc(Color::DarkCyan).build()),
                 inactive_item_style: Some(StyleBuilder::new().build()),

promkit/src/preset/query_selector/render.rs

@@ -71,7 +71,7 @@ impl crate::Renderer for Renderer {
                     .map(|e| e.to_string())
                     .collect(),
             );
-            self.listbox_snapshot.after_mut().listbox = Listbox::from_iter(list);
+            self.listbox_snapshot.after_mut().listbox = Listbox::from_displayable(list);
         }
         signal
     }

promkit/src/preset/readline.rs

@@ -61,7 +61,7 @@ impl Default for Readline {
             },
             suggest: Default::default(),
             suggest_state: listbox::State {
-                listbox: Listbox::from_iter(Vec::<String>::new()),
+                listbox: Listbox::from_displayable(Vec::<String>::new()),
                 cursor: String::from("❯ "),
                 active_item_style: Some(
                     StyleBuilder::new()

promkit/src/preset/readline/keymap.rs

@@ -93,7 +93,7 @@ pub fn default(
                     .text_without_cursor()
                     .to_string();
                 if let Some(candidates) = suggest.prefix_search(text) {
-                    suggest_after_mut.listbox = Listbox::from_iter(candidates);
+                    suggest_after_mut.listbox = Listbox::from_displayable(candidates);
                     text_editor_after_mut
                         .texteditor
                         .replace(&suggest_after_mut.listbox.get().to_string());
@@ -279,7 +279,7 @@ pub fn on_suggest(
         }
 
         _ => {
-            suggest_after_mut.listbox = Listbox::from_iter(Vec::<String>::new());
+            suggest_after_mut.listbox = Listbox::from_displayable(Vec::<String>::new());
 
             renderer.keymap.borrow_mut().switch("default");
         }

promkit/src/validate.rs

@@ -25,11 +25,11 @@ impl<T: ?Sized> ValidatorManager<T> {
     /// # Arguments
     ///
     /// * `validator` - A function that takes a reference
-    /// to an input of type `T` and returns a boolean
-    /// indicating whether the input passes the validation.
+    ///   to an input of type `T` and returns a boolean
+    ///   indicating whether the input passes the validation.
     /// * `error_message_generator` - A function that takes a reference
-    /// to an input of type `T` and returns a `String`
-    /// that describes the validation error.
+    ///   to an input of type `T` and returns a `String`
+    ///   that describes the validation error.
     ///
     /// # Returns
     ///
@@ -47,7 +47,7 @@ impl<T: ?Sized> ValidatorManager<T> {
     /// # Arguments
     ///
     /// * `input` - A reference
-    /// to the input of type `T` to be validated.
+    ///   to the input of type `T` to be validated.
     ///
     /// # Returns
     ///
@@ -63,7 +63,7 @@ impl<T: ?Sized> ValidatorManager<T> {
     /// # Arguments
     ///
     /// * `input` - A reference to the input of type `T`
-    /// for which to generate an error message.
+    ///   for which to generate an error message.
     ///
     /// # Returns
     ///