KMVUnion.RandomProvider 1.1.0

RandomProvider

This is lightweight package allows generating random data for your project based on predefined configurations.

Current version contains following randomizers:

• StringRandomizer - serves for generating random string values in your project;
• TextRandomizer - provides possibility to generate random text (multi lines string data).

StringRandomizer

String randomizer serves for generating random string values based on predefined configuration. You can configure string length, symbols cases, and a set of symbols that could be used for generating a particular value. Also, you can exclude some set symbols.

Configuration methods

Before starting configuration and using StringRandomizer you should add using KMVUnion.RandomProvider.StringRandomizer; into using section of your class.

For configuring randomizer you can use some or all methods from the interface KMVUnion.RandomProvider.StringRandomizer.IStringRandomizerBuilder. Method Build(); returns an instance of the StringRandomizer. It must be called finally.

Length configuration

You can choose one of two options:

Generate exact length for whole generated values.

var randomizer = new StringRandomizerBuilder()
    ...
    .WithExactLength(7) // All generated strings will have a length exact 7  
    ...
    .Build();

Generate length from the range. In this case, each generated value will have a length from the previously configured range.

var randomizer = new StringRandomizerBuilder()
    ...
    // Using this configuration generated strings will have a length  from the range 3..10
    .WithMinLength(3)
    .WithMaxLength(10)
    ...
    .Build();

Configuration a template of symbols

For generating a random value, we need to have a template of the symbols list. We can provide it by adding an array of symbols.

var randomizer = new StringRandomizerBuilder()
    ...
    .SetAllowedSymbols(new char[3]{'a','b','c'}) // template includes only three possible symbols 'a', 'b' and 'c'
    ...
    .Build();

Another approach for configuration templates is adding a string that contains the required symbols for configuration.

var randomizer = new StringRandomizerBuilder()
    ...
    .SetAllowedSymbolsFromString("defg") // template includes four symbols 'd', 'e', 'f' and 'g'
    ...
    .Build();

You can use any of these techniques or combine them. In the following case, one approach complements another one.

var randomizer = new StringRandomizerBuilder()
    ...
    //In this case template will be configured by set of symbols 'a', 'b', 'c', 'd', 'e', 'f' and 'g'
    .SetAllowedSymbols(new char[3]{'a','b','c'})
    .SetAllowedSymbolsFromString("defg") 
    ...
    .Build();

Also, you can exclude some symbols from the template. For doing this, you can use two methods for configuration:

• SetDeniedSymbols(char[] symbols) - excludes symbols from the array, if such exist.
• SetDeniedSymbolsFromString(string templateString) - excludes symbols from the string, if such exist.

Those methods also can complement each other if it is needed.

var randomizer = new StringRandomizerBuilder()
    ...
    .SetAllowedSymbols(...)
    .SetAllowedSymbolsFromString(...) 
    ...
    //In this case from template will be excluded the set of symbols 'x', 'y', 'z', '_', '3', '#' and '.'
    .SetDeniedSymbols(new char[3]{'x','y','z'})
    .SetDeniedSymbolsFromString("_3#.") 
    ...
    .Build();

Symbol cases configuration

The property SymbolCases is responsible for the configuration output cases of the symbols. It could be one from the fourth:

• None - use symbols exact in the same cases as these are in the template.
• Lower - all symbols will be converted in the lower case
• Upper - result will be converted into the upper case
• Mixed - for this configuration result string will include symbols in upper and lower cases approximately in a proportion of 50/50.

By default, the symbol case setting is None.

You can set the setting via the method WithSymbolsCases of the StringRandomizerBuilder class.

var randomizer = new StringRandomizerBuilder()
    ...
    .WithSymbolsCases(SymbolCases.Lower) // result contains symbols only in the lower case
    ...
    .Build();

Get random data methods

There are a few methods that you could use for generating random string values:

Examples

Example 1 Use predefined characters for the generating random string value

using KMVUnion.RandomProvider.StringRandomizer;
...
//Configuration
var randomizer = new StringRandomizerBuilder()
    .SetAllowedSymbols(new[] { '1', 'G', 'h', 'l', '5', 'a', 'B', 'C', 'D', 'e', 'f' })
    .WithExactLength(7)
    .Build();
...
//Generating value
var value = randomizer.GetValue();

Result:

"FDFggBF"

Example 2 Use predefined string as a template for generating random string value

using KMVUnion.RandomProvider.StringRandomizer;
...
//Configuration
var randomizer = new StringRandomizerBuilder()
    .SetAllowedSymbolsFromString("This is a string that will be used as a template for generating random string value.")
    .SetDeniedSymbolsFromString("w ta")
    .WithMinLength(3)
    .WithMaxLength(10)
    .WithSymbolsCases(SymbolCases.Lower)
    .Build();
...
//Generating value
var value = randomizer.GetValue();

Result:

"viosrnbu"

Example 3 Use a predefined randomizer for generating a random strings collection

using KMVUnion.RandomProvider.StringRandomizer;
...
//Configuration
var randomizer = new StringRandomizerBuilder()
    .SetAllowedSymbols(new[] { '1', 'G', 'h', 'l', '5', 'a', 'B', 'C', 'D', 'e', 'f' })
    .WithExactLength(7)
    .Build();
...
//Generating collection of 3 random string values.
var values = randomizer.GetValues(3);

Result:

["lCh1l5B","D5Cl1BD","AC1hDg5"]

Example 4 Although configuration contains a range of lengths from 3 to 10, we can get the random string value of exact length that is different from the initial randomizer configuration.

using KMVUnion.RandomProvider.StringRandomizer;
...
//Configuration
var randomizer = new StringRandomizerBuilder()
    .SetAllowedSymbolsFromString("This is a string that will be used as a template for generating random string value.")
    .WithMinLength(3)
    .WithMaxLength(10)
    .WithSymbolsCases(SymbolCases.Lower)
    .Build();
...
//Generating value
var value = randomizer.GetValue(20);

TextRandomizer

Text randomizer allows you to generate random text values. These text values could have different representations based on the randomizer configuration.

Configuration

Before starting configuration and using StringRandomizer you should add using KMVUnion.RandomProvider.TextRandomizer; into using section of your class.

For configuring a randomizer you can use a set of methods KMVUnion.RandomProvider.TextRandomizer.ITextRandomizerBuilder. Method Build(); returns an instance of the TextRandomizer. It must be called finally.

Configuration a template of symbols

For generating a random value, we need to have a template list of symbols. We can provide it by adding an array of symbols.

var randomizer = new TextRandomizerBuilder()
    ...
    .SetAllowedSymbols(new char[3]{'a','b','c'}) // template includes only three symbols 'a', 'b' and 'c'
    ...
    .Build();

Another approach for the configuration of a template is adding a string that contains the required symbols.

var randomizer = new TextRandomizerBuilder()
    ...
    .SetAllowedSymbolsFromString("defg") // template includes four symbols 'd', 'e', 'f' and 'g'
    ...
    .Build();

You can use any of these approaches or combine them. In the following case, you can see one approach complements another.

var randomizer = new TextRandomizerBuilder()
    ...
    //In this case template will be configured by range of symbols 'a', 'b', 'c', 'd', 'e', 'f' and 'g'
    .SetAllowedSymbols(new char[3]{'a','b','c'})
    .SetAllowedSymbolsFromString("defg") 
    ...
    .Build();

Also, you can exclude some symbols from the template. For doing this, you can use one of the two methods or both of them:

• SetDeniedSymbols(char[] symbols) - excludes symbols represented in the array if such exist in the allowed symbols.
• SetDeniedSymbolsFromString(string templateString) - excludes symbols represented in the string if such exist in the allowed symbols.

Those methods also can complement each other if it is needed.

var randomizer = new TextRandomizerBuilder()
    ...
    .SetAllowedSymbols(...)
    .SetAllowedSymbolsFromString(...) 
    ...
    //In this case from template will be excluded the set of symbols 'x', 'y', 'z', '_', '3', '#' and '.'
    .SetDeniedSymbols(new char[3]{'x','y','z'})
    .SetDeniedSymbolsFromString("_3#.") 
    ...
    .Build();

Text aligning configuration

The property TextAlign is responsible for the configuration text-align mode of the generated value. It could be one from the fourth:

• Left - Align text from the left;
• Center - Align text to the center;
• Right - Align text from the right;
• Justify - Justify text.

By default, text align mode is Left.

You can change the setting via calling WithTextAlign method of the TextRandomizerBuilder class.

var randomizer = new TextRandomizerBuilder()
    ...
    .WithTextAlign(SymbolCases.Center) // result text aligns in the center of the row
    ...
    .Build();

Get random data methods

Some methods are generating random text values. This text could be one of three different types:

• Noisy - This type builds text that consists of random symbols without any gaps.

Example:

       Ehh1gAlEECDgD5l1hEBFgDAgl5ECFh
       FFABDFEADhFAFBFlDgEDDBEgElFglg
       ChgCFhBEFCA5C1EAhDhBBBgE1C5C55
       hlC1FDAAgD

• Wordy - Text of this type contains pseudo words, that are built by random symbols. At the same time, such text does not have sentences.

Example:

        DBF1llC1D A1CA15Bl EECBChF lhhh1CAgCFD
        DCgDggChC Bg5h51h lEBBgECh BhFhBA5F
        lACBC5FgE15

• Sentences - Such text contains sentences that start from the capital symbols and contains one random symbol from the set ('.', '!', '?') at the end of each sentence.

Example:

        Gcaamdgkl AADmkll ADBChgmDDE lCAChkEBAm ll EClBhDE EDhm ggBkkgEgBl? Cgfecfdh
        FgCADmCEEmB BAABggDEBD BAFmAgE! A gDDgBlDgECB lEmBBlF gDFDCAED BhgDgmlkDh
        mhklDEAB EkgBChCDCC. 

Examples

Example 1 Generating noisy text with aligning text from the right side.

using KMVUnion.RandomProvider.TextRandomizer;
...
//Configuration
var randomizer = new TextRandomizerBuilder()
            .SetAllowedSymbols(new[] { '1', 'G', 'h', 'l', '5', 'a', 'B', 'C', 'D', 'e', 'f' })                        
            .WithRowLength(30)
            .WithTextAlign(TextAlign.Right)
            .Build();
...
var result = randomizer.GetNoisyText(100);

Result:

ElEg1BEBDCgBCChDEhCEAg5DhE1hll
Cg1hl1lBB5EFDgFlgBlE115lgAEAhA
BhD5FBEEgD5CDBEl5E5Dllg1llFF5g
                    ggFB15hhCC

Example 2 Generating wordy text with aligning text from the left side.

using KMVUnion.RandomProvider.TextRandomizer;
...
//Configuration
var randomizer = new TextRandomizerBuilder()
            .SetAllowedSymbols(new[] { '1', 'G', 'h', 'l', '5', 'a', 'B', 'C', 'D', 'e', 'f' })
            .WithRowLength(40)
            .WithTextAlign(TextAlign.Left)
            .Build();
...
//Generating wordy text
var result = randomizer.GetWordyText(40);

Result:

g5BglD1A1 F hAF5gBg5 51E1lDC DgD1AAA
Agh D1EClB15B ll1hlC5Cggh FCFEghF
EF1BC55hF 1hl1AFBhlF F5l lh1DF51 5EgA
FDAh5AEhD BFDCAlhD h EABBll51DlB
Dl5AFDgE5D 15lg1l1E BClD1lDAABh
51BgE1g5 1B ElA5DADg ACDEBEF
FlFlhC1AAF1 FBA551lg1h BC1Ehg5lD
EAgD1F5BEC F1BhF DAFCAll A5EB FDDA5A1AB
BCE51FlAAC l1Eg1Dg 5A5FC1FF1hC
ElFlh1CCBF Cg5DClBh5gl g1DF5AhB gEEllCl

Example 3 Generating wordy text with aligning in the justify mode.

using KMVUnion.RandomProvider.TextRandomizer;
...
//Configuration
var randomizer = new TextRandomizerBuilder()
            .SetAllowedSymbols(new[] { '1', 'G', 'h', 'l', '5', 'a', 'B', 'C', 'D', 'e', 'f' })
            .WithRowLength(40)
            .WithTextAlign(TextAlign.Justify)
            .Build();
...
// Generating wordy text
var result = randomizer.GetWordyText(40);

Result:

ABCFgFFB5E 1hECCBF1F 1 FhDlAF5   F1AhhAB
lD    5F1l11DDFB    FlCEFACgC    1hCgg5A
FEEE51Dg5FF Bg1DgE1hFh DEAh151AB   ECg5B
EhFDEl1   BFlCBAAB   EAFABCB    FECAB1C1
gFD5E1CCACE  CB  DEEFD1EACFC   ghhFFhCBh
DgC1AED5DFh 1DFDD1hE5FC F5ADCDFhg  EAhBl
hF1E5FF      l5Dl511gBBD      lDAglBgll1
5CDCEE1AFC  FD1BB5EEg  FBCDAEF  5DFBCFCC
CD51ChgAh   AFEDg1hFA   DAEgDBFFAgC    h
1gDFhlD5   hl   1A1hlFl1h     5hAFhghF51

Example 4 Generating text consists of sentences with aligning text in the center.

using KMVUnion.RandomProvider.TextRandomizer;
...
//Configuration
var randomizer = new TextRandomizerBuilder()
            .SetAllowedSymbols(new[] { 'k', 'G', 'h', 'l', 'M', 'a', 'B', 'C', 'D', 'e', 'f' })
            .WithRowLength(80)
            .WithTextAlign(TextAlign.Center)
            .Build();
...
//Generating text contained pseudo sentences.
var result = randomizer.GetSentencesText(40);

Result:

   Flglfdg FA CgFggghBFg mgmAkFCBBl kEhEkhlBEmm glFAlhEEDAA BEm BmF BkDhhhBkAl
     kBECAggAAB kkECkDgCFEm BAlAFgDC. Akbdffhfbll kChE mAhmhkCEE FFBEBCDA Eg
 DhkmADAE hECDEhCA hFBBEADg lClChAm DFAgABlEBh. Gflbamcfgh BhFklBFCkm EBEkFCBAhF
 AlDCChgA AhChAlAl mEhFBDlA lEglmDmD? Aldldelmece DlEhEChDkk ABEEBglDBm lmEFkFmh
                  F AgAm kgFmClFlg CDFBAgmC llBgglk gDBCg hAmAl?