Struct lmake_lines_of_code::AppObject

pub struct AppObject {}

An object to implement methods rather than functions.
The methods are always defined in Traits, to be testable/mockable.
Traits don't have access to fields, only to methods.

Implementations

impl AppObject

pub fn git_remote_output(&self) -> Result<String>

pub fn regex_capture(&self, output: String) -> Result<String>

returns a Result. in the case of error the calling fn will return empty string.

pub fn to_string_as_md_table(&self, v: &LinesOfCode) -> String

Returns a string with the code for a markdown table with count of lines.

Some websites render a beautiful table, but others render ugly tables. Use badges instead.

Example

use lmake_lines_of_code::*;

let app = AppObject{};
let v = app.workspace_or_project_count_lines();
let badges = app.to_string_as_md_table(&v);

println!("{}", badges);

pub fn to_string_as_shield_badges(&self, v: &LinesOfCode, link: &str) -> String

Returns a string with the markdown code for 4 shield badges.

Every badge has the link to the url given as first CLI argument or automatically finds out the github git remote repository url.

Example

use lmake_lines_of_code::*;

let app = AppObject{};
let v = app.workspace_or_project_count_lines();
let badges = app.to_string_as_shield_badges(&v,"");

println!("{}", badges);

impl AppObject

pub fn new() -> AppObject

Constructor of the object that has all the public methods.
No fields needed for now.

pub fn main(&self, link: &str) -> String

Runs all the public methods. It is called by the CLI main fn.

pub fn text_to_include(&self, link: &str) -> String

Trait Implementations

impl TraitCountLines for AppObject

fn workspace_or_project_count_lines(&self) -> LinesOfCode

Returns the struct LinesOfCode for 4 types of lines: code, doc comments, comments, test and examples. Automatically detects if this is a workspace or single rust project.

Example

use lmake_lines_of_code::*;

let app = AppObject{};
let v = app.workspace_or_project_count_lines();
dbg!(&v);

fn process_git_remote(&self) -> String

Return the string for link for badges like: https://github.com/LucianoBestia/lmake_lines_of_code/.
Get the output string after $ git remote -v.
Then finds out the link to the repository with regex.
Returns empty string if something goes wrong: no git, no remote,...