https://github.com/resourcepool/little-bob

A simple human name and sentence generator in your language
https://github.com/resourcepool/little-bob

first fortune generator java language library name nickname sentence sentence-generator

Last synced: 3 months ago
JSON representation

A simple human name and sentence generator in your language

• Host: GitHub
• URL: https://github.com/resourcepool/little-bob
• Owner: resourcepool
• License: other
• Created: 2017-01-22T16:24:27.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-30T20:39:35.000Z (about 8 years ago)
• Last Synced: 2024-05-28T15:22:59.204Z (8 months ago)
• Topics: first, fortune, generator, java, language, library, name, nickname, sentence, sentence-generator
• Language: Java
• Size: 935 KB
• Stars: 6
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Little bob

A simple human name and sentence generator in your language.

Make up names, nicknames, and find sample textual content for your applications, using the provided dictionaries.

The name is a tribute to the "Le petit Robert" Dictionaries.

## What it does

Lorem Ipsum is sooooooo 2016.

With Little Bob, you can generate lots of FullNames (given name, surname, nickname, gender) and Fortune sayings and quotes, in the language of your choice.

Current supported languages: **FRENCH, ENGLISH**

## Compatibility / Setup

The sources are compatible with JDK 6+.

To use the library with maven, add these lines to your **pom.xml** file:

```xml

 io.resourcepool

 little-bob

 1.0

```

## API / Sample use

### Fortune

For starters, initialize your generator (ideally as a class attribute):

```java

FortuneGenerator generator = new SimpleFortuneGenerator();

```

Generate a fortune in any language:

```java

Fortune f = generator.nextFortune();

```

Generate a fortune in a specific language:

```java

Fortune f = generator.nextFortune(Language.FRENCH);

```

Generate a list of 100 fortunes in any language:

```java

List f = generator.nextFortunes(100);

```

Generate a list of 100 fortunes in FRENCH

```java

Query q = Query.builder()

               .count(100)

               .languages(Language.FRENCH)

               .build();

List f = generator.nextFortunes(q);

```

Example:

```java

public class Main {

  

  public static void main(String[] args){

    FortuneGenerator generator = new SimpleFortuneGenerator();

    // Generate one fortune in any language

    Fortune f = generator.nextFortune();

    System.out.println("Fortune of the day:");

    System.out.println(f.text);    

    System.out.println("That fortune is from:");

    System.out.println(f.source);

    

    // Generate one fortune in French

    f = generator.nextFortune(Language.FRENCH);

    System.out.println("French Fortune of the day:");

    System.out.println(f.text);    

    System.out.println("That french fortune is from:");

    System.out.println(f.source);

    

    // Generate 100 fortunes in English or French

    List fortunes = generator.nextFortunes(

      Query.builder()

           .count(100)

           .languages(Language.ENGLISH, Language.FRENCH)

           .build()

    );

  }

}

```

### Names

For starters, initialize your generator (ideally as a class attribute):

```java

NameGenerator generator = new SimpleNameGenerator();

```

Generate a name in any language:

```java

// Full name (given name, surname, nickname, gender)

FullName fn = generator.nextName();

// Given name (given name, nickname, gender)

GivenName gn = generator.nextGivenName();

// Nickname

String nick = generator.nextNickname();

// Surname

String surname = generator.nextSurname();

```

Generate a list of 100 names in any language:

```java

List fns = generator.nextNames(100);

```

Generate a list of 100 names in FRENCH

```java

Query q = Query.builder()

               .count(100)

               .languages(Language.FRENCH)

               .build();

List f = generator.nextNames(q);

```

Example:

```java

public class Main {

  

  public static void main(String[] args){

    FortuneGenerator generator = new SimpleFortuneGenerator();

    // Generate one name in any language

    FullName fn = generator.nextName();

    System.out.println("The murderer has a name:");

    System.out.println(fn.givenName + " " + fn.surname);    

    System.out.println(Gender.MALE.equals(fn.gender) ? "He" : "She" + " goes by the alias:");

    System.out.println(fn.nickname);

    

    // Generate 100 names in English or French

    List accomplices = generator.nextNames(

      Query.builder()

           .count(100)

           .languages(Language.ENGLISH, Language.FRENCH)

           .build()

    );

  }

}

```

## License

This project is licensed under the **Apache 2.0 License**.

## Contributions

We welcome any contributions via Issues and/or Pull-requests