diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..8441d56 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,19 @@ +name: CI + +on: + push: + branches: [ "**" ] + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + cache: gradle + - name: Run tests + run: ./gradlew test diff --git a/.gitignore b/.gitignore index 4dd449d..a86cbbe 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ -/target +# Gradle +.gradle/ +build/ ################# ## Eclipse @@ -171,7 +173,4 @@ pip-log.txt !/.idea/codeStyles !/.idea/modules.iml !/.idea/modules/*.iml -!/.idea/codeStyleSettings.xml - -/project/target -/project/project/target \ No newline at end of file +!/.idea/codeStyleSettings.xml \ No newline at end of file diff --git a/README.md b/README.md index 709f389..1db9dae 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,4 @@ gives access to the mother and father names, so it could generate matronymics an Building -------- -Get [SBT][1] and run `sbt package`. - -[1]: http://www.scala-sbt.org/download.html \ No newline at end of file +Requires Java 17+. Run `./gradlew build` to compile and test. \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..630db82 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,23 @@ +plugins { + kotlin("jvm") version "2.0.21" +} + +group = "uk.co.halfninja" +version = "0.3" + +repositories { + mavenCentral() +} + +dependencies { + testImplementation("org.junit.jupiter:junit-jupiter:5.10.2") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +tasks.test { + useJUnitPlatform() +} + +kotlin { + jvmToolchain(17) +} diff --git a/build.sbt b/build.sbt deleted file mode 100644 index 63ac747..0000000 --- a/build.sbt +++ /dev/null @@ -1,23 +0,0 @@ -organization := "uk.co.halfninja" -name := "random-name-generator" -version := "0.3-warwick" -scalaVersion := "2.13.0-M5" -crossScalaVersions := Seq("2.11.12", "2.12.8", "2.13.0-M5") - -libraryDependencies ++= Seq( - "org.scalatest" %% "scalatest" % "3.0.6-SNAP6" % "test" -) - -val WarwickSnapshots: MavenRepository = "Nexus Snapshots" at "https://mvn.elab.warwick.ac.uk/nexus/repository/public-snapshots" -val WarwickReleases: MavenRepository = "Nexus Releases" at "https://mvn.elab.warwick.ac.uk/nexus/repository/public-releases" - -credentials += Credentials(Path.userHome / ".ivy2" / ".credentials") -publishTo := { - if (isSnapshot.value) Some(WarwickSnapshots) - else Some(WarwickReleases) -} - -// Fix publishing on SBT 1.x -// https://github.com/sbt/sbt/issues/3570 -updateOptions := updateOptions.value.withGigahorse(false) - diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d997cfc Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..dbc3ce4 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..0262dcb --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/b631911858264c0b6e4d6603d677ff5218766cee/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..e509b2d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,93 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/pom.xml b/pom.xml deleted file mode 100644 index a64a6d6..0000000 --- a/pom.xml +++ /dev/null @@ -1,38 +0,0 @@ - - 4.0.0 - - uk.co.halfninja - random-name-generator - 1.0-SNAPSHOT - jar - Random Name Generator - https://github.com/halfninja/random-name-generator - - - package - - - org.apache.maven.plugins - maven-compiler-plugin - 2.5.1 - - 1.5 - 1.5 - - - - - - - - com.novocode - junit-interface - 0.8 - test - - - - \ No newline at end of file diff --git a/project/build.properties b/project/build.properties deleted file mode 100644 index c0bab04..0000000 --- a/project/build.properties +++ /dev/null @@ -1 +0,0 @@ -sbt.version=1.2.8 diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..a570a3a --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "random-name-generator" diff --git a/src/main/kotlin/uk/co/halfninja/randomnames/CompositeNameGenerator.kt b/src/main/kotlin/uk/co/halfninja/randomnames/CompositeNameGenerator.kt new file mode 100644 index 0000000..addafd9 --- /dev/null +++ b/src/main/kotlin/uk/co/halfninja/randomnames/CompositeNameGenerator.kt @@ -0,0 +1,45 @@ +package uk.co.halfninja.randomnames + +import java.util.Random + +/** + * A NameGenerator that picks between a list of delegate generators. + * It is immutable so you create an empty one with newGenerator() and + * then build a list of generators using withGenerator(), which + * returns a fresh generator each time. + */ +class CompositeNameGenerator(val entries: List) : NameGenerator { + + private val totalWeighting = entries.sumOf { it.weighting } + + /** + * Pick a random NameGenerator from the possible ones, weighted by + * their weighting. + */ + private fun pickGenerator(): NameGenerator = pickGenerator(Randomness.random()) + private fun pickGenerator(seed: Long): NameGenerator = pickGenerator(Randomness.random(seed)) + private fun pickGenerator(random: Random): NameGenerator { + var choice = random.nextInt(totalWeighting) + return entries.first { entry -> + val found = choice < entry.weighting + if (!found) choice -= entry.weighting + found + }.generator + } + + override fun generate(gender: Gender): Name = pickGenerator().generate(gender) + override fun generate(gender: Gender, seed: Long): Name = pickGenerator(seed).generate(gender, seed) + override fun generate(gender: Gender, mother: Name, father: Name): Name = pickGenerator().generate(gender, mother, father) + override fun generate(gender: Gender, mother: Name, father: Name, seed: Long): Name = pickGenerator(seed).generate(gender, mother, father, seed) + + fun withGenerator(id: String, generator: NameGenerator, weight: Int): CompositeNameGenerator { + require(weight >= 1) { "Weight must be at least 1" } + return CompositeNameGenerator(entries + Entry(id, generator, weight)) + } + + data class Entry(val id: String, val generator: NameGenerator, val weighting: Int) + + companion object { + fun newGenerator() = CompositeNameGenerator(emptyList()) + } +} diff --git a/src/main/kotlin/uk/co/halfninja/randomnames/EnglishlikeNameGenerator.kt b/src/main/kotlin/uk/co/halfninja/randomnames/EnglishlikeNameGenerator.kt new file mode 100644 index 0000000..f5fe0b3 --- /dev/null +++ b/src/main/kotlin/uk/co/halfninja/randomnames/EnglishlikeNameGenerator.kt @@ -0,0 +1,64 @@ +package uk.co.halfninja.randomnames + +import java.util.Random + +class EnglishlikeNameGenerator : NameGenerator { + + override fun generate(gender: Gender): Name = generate(gender, Randomness.random()) + override fun generate(gender: Gender, seed: Long): Name = generate(gender, Randomness.random(seed)) + + private fun generate(gender: Gender, random: Random): Name { + val firstName = when (gender) { + is Gender.Male -> Randomness.random(MaleGivenNames, random) + is Gender.Female -> Randomness.random(FemaleGivenNames, random) + is Gender.Nonspecific -> throw IllegalArgumentException("Non-specific genders are not supported") + } + + val baseFamilyName = Randomness.random(LastNames, random) + val roll = random.nextInt(15) + val familyName = when { + roll == 0 && !baseFamilyName.endsWith("on") -> baseFamilyName + "son" + roll == 1 && !baseFamilyName.endsWith("on") -> baseFamilyName + "ton" + roll == 2 -> Randomness.random(MaleGivenNames, random) + roll == 3 -> baseFamilyName + "-" + Randomness.random(LastNames, random) + roll == 4 -> baseFamilyName + "ford" + roll == 5 -> baseFamilyName + "ham" + else -> baseFamilyName + } + + return Name(firstName, familyName) + } + + override fun generate(gender: Gender, mother: Name, father: Name): Name = + generate(gender, mother, father, Randomness.random()) + + override fun generate(gender: Gender, mother: Name, father: Name, seed: Long): Name = + generate(gender, mother, father, Randomness.random(seed)) + + private fun generate(gender: Gender, @Suppress("UNUSED_PARAMETER") mother: Name, @Suppress("UNUSED_PARAMETER") father: Name, random: Random): Name { + // TODO inherit surname + return generate(gender, random) + } + + companion object { + val MaleGivenNames = listOf( + "David", "James", "Andrew", "John", "Michael", "Paul", "Matthew", "Mark", "Chris", "Richard", + "Tom", "Alex", "Daniel", "Peter", "Ben", "Robert", "Christopher", "Thomas", "Stephen", "Adam", + "Simon", "Jonathan", "Ian", "Jack", "Sam", "Martin", "Matt", "George", "Nick", "Joe" + ) + + val FemaleGivenNames = listOf( + "Sarah", "Emma", "Laura", "Rachel", "Helen", "Claire", "Emily", "Hannah", "Rebecca", "Sophie", + "Charlotte", "Anna", "Lucy", "Amy", "Catherine", "Jennifer", "Katie", "Jane", "Kate", "Elizabeth", + "Julie", "Louise", "Susan", "Maria", "Karen", "Caroline", "Alison", "Lisa", "Nicola", "Jessica" + ) + + val LastNames = listOf( + "Smith", "Jones", "Patel", "Williams", "Brown", "Davies", "Taylor", "Lee", "Evans", "Harris", "Shah", + "White", "Wilson", "Johnson", "Khan", "Clarke", "Thomas", "Lewis", "Roberts", "Walker", "Thompson", + "Wright", "Edwards", "Davis", "Moore", "Ward", "Chan", "Cooper", "Green", "Robinson", "King", "Turner", + "Jackson", "Wood", "Hughes", "Martin", "Baker", "Hall", "Bennett", "Mitchell", "Shaw", "Hill", "Clark", + "Parker", "Watson", "Scott", "James", "Wong", "Morris", "Cox" + ) + } +} diff --git a/src/main/kotlin/uk/co/halfninja/randomnames/Gender.kt b/src/main/kotlin/uk/co/halfninja/randomnames/Gender.kt new file mode 100644 index 0000000..3160d29 --- /dev/null +++ b/src/main/kotlin/uk/co/halfninja/randomnames/Gender.kt @@ -0,0 +1,7 @@ +package uk.co.halfninja.randomnames + +sealed class Gender { + object Male : Gender() + object Female : Gender() + object Nonspecific : Gender() +} diff --git a/src/main/kotlin/uk/co/halfninja/randomnames/Name.kt b/src/main/kotlin/uk/co/halfninja/randomnames/Name.kt new file mode 100644 index 0000000..bf1b914 --- /dev/null +++ b/src/main/kotlin/uk/co/halfninja/randomnames/Name.kt @@ -0,0 +1,16 @@ +package uk.co.halfninja.randomnames + +data class Name( + val givenName: String, + val familyName: String, + val middleNames: List = emptyList(), + val quotedName: String? = null +) { + override fun toString(): String = + listOfNotNull( + givenName, + quotedName?.let { "\"$it\"" }, + *middleNames.toTypedArray(), + familyName + ).joinToString(" ") +} diff --git a/src/main/kotlin/uk/co/halfninja/randomnames/NameGenerator.kt b/src/main/kotlin/uk/co/halfninja/randomnames/NameGenerator.kt new file mode 100644 index 0000000..9a3d4c5 --- /dev/null +++ b/src/main/kotlin/uk/co/halfninja/randomnames/NameGenerator.kt @@ -0,0 +1,8 @@ +package uk.co.halfninja.randomnames + +interface NameGenerator { + fun generate(gender: Gender): Name + fun generate(gender: Gender, seed: Long): Name + fun generate(gender: Gender, mother: Name, father: Name): Name + fun generate(gender: Gender, mother: Name, father: Name, seed: Long): Name +} diff --git a/src/main/kotlin/uk/co/halfninja/randomnames/NameGenerators.kt b/src/main/kotlin/uk/co/halfninja/randomnames/NameGenerators.kt new file mode 100644 index 0000000..2df373e --- /dev/null +++ b/src/main/kotlin/uk/co/halfninja/randomnames/NameGenerators.kt @@ -0,0 +1,8 @@ +package uk.co.halfninja.randomnames + +object NameGenerators { + fun standardGenerator() = + CompositeNameGenerator + .newGenerator() + .withGenerator("englishlike", EnglishlikeNameGenerator(), 1) +} diff --git a/src/main/kotlin/uk/co/halfninja/randomnames/Randomness.kt b/src/main/kotlin/uk/co/halfninja/randomnames/Randomness.kt new file mode 100644 index 0000000..114395c --- /dev/null +++ b/src/main/kotlin/uk/co/halfninja/randomnames/Randomness.kt @@ -0,0 +1,9 @@ +package uk.co.halfninja.randomnames + +import java.util.Random + +object Randomness { + fun random(): Random = Random() + fun random(seed: Long): Random = Random(seed) + fun random(strings: List, random: Random): String = strings[random.nextInt(strings.size)] +} diff --git a/src/main/scala/uk/co/halfninja/randomnames/CompositeNameGenerator.scala b/src/main/scala/uk/co/halfninja/randomnames/CompositeNameGenerator.scala deleted file mode 100644 index 3f93a81..0000000 --- a/src/main/scala/uk/co/halfninja/randomnames/CompositeNameGenerator.scala +++ /dev/null @@ -1,46 +0,0 @@ -package uk.co.halfninja.randomnames - -import uk.co.halfninja.randomnames.Randomness._ - -/** - * A NameGenerator that picks between a list of delegate generators. - * It is immutable so you create an empty one with newGenerator and - * then build a list of generators using withGenerator(), which - * returns a fresh generator each time. - */ -class CompositeNameGenerator(val entries: Seq[CompositeNameGenerator.Entry]) extends NameGenerator { - - final val totalWeighting = entries.foldLeft(0) { (acc, entry) => acc + entry.weighting } - - /** - * Pick a random NameGenerator from the possible ones, weighted by - * their weighting. - */ - private def pickGenerator(): NameGenerator = pickGenerator(random()) - private def pickGenerator(seed: Long): NameGenerator = pickGenerator(random(seed)) - private def pickGenerator(random: JRandom): NameGenerator = { - var choice = random.nextInt(totalWeighting) - entries.find { entry => - val found = choice < entry.weighting - if (!found) choice -= entry.weighting - found - }.head.generator - } - - override def generate(gender: Gender) = pickGenerator().generate(gender) - override def generate(gender: Gender, seed: Long) = pickGenerator(seed).generate(gender, seed) - override def generate(gender: Gender, mother: Name, father: Name) = pickGenerator().generate(gender, mother, father) - override def generate(gender: Gender, mother: Name, father: Name, seed: Long) = pickGenerator(seed).generate(gender, mother, father, seed) - - def withGenerator(string: String, generator: NameGenerator, weight: Int) = { - if (weight < 1) throw new IllegalArgumentException("Weight must be at least 1") - new CompositeNameGenerator(entries :+ CompositeNameGenerator.Entry(string, generator, weight)) - } - -} - -object CompositeNameGenerator { - case class Entry(id: String, generator: NameGenerator, weighting: Int) - - def newGenerator() = new CompositeNameGenerator(Seq.empty) -} \ No newline at end of file diff --git a/src/main/scala/uk/co/halfninja/randomnames/EnglishlikeNameGenerator.scala b/src/main/scala/uk/co/halfninja/randomnames/EnglishlikeNameGenerator.scala deleted file mode 100644 index 949b8f0..0000000 --- a/src/main/scala/uk/co/halfninja/randomnames/EnglishlikeNameGenerator.scala +++ /dev/null @@ -1,61 +0,0 @@ -package uk.co.halfninja.randomnames - -class EnglishlikeNameGenerator extends NameGenerator { - import EnglishlikeNameGenerator._ - import Randomness.JRandom - - override def generate(gender: Gender): Name = generate(gender, Randomness.random()) - override def generate(gender: Gender, seed: Long): Name = generate(gender, Randomness.random(seed)) - private def generate(gender: Gender, random: JRandom): Name = { - val firstName = gender match { - case Gender.male => Randomness.random(MaleGivenNames, random) - case Gender.female => Randomness.random(FemaleGivenNames, random) - case _ => throw new IllegalArgumentException("Non-specific genders are not supported") - } - - val baseFamilyName = Randomness.random(LastNames, random) - val familyName = random.nextInt(15) match { - case 0 if !baseFamilyName.endsWith("on") => baseFamilyName + "son" - case 1 if !baseFamilyName.endsWith("on") => baseFamilyName + "ton" - case 2 => Randomness.random(MaleGivenNames, random) - case 3 => baseFamilyName + "-" + Randomness.random(LastNames, random) - case 4 => baseFamilyName + "ford" - case 5 => baseFamilyName + "ham" - case _ => baseFamilyName - } - - Name(firstName, familyName) - } - - override def generate(gender: Gender, mother: Name, father: Name): Name = generate(gender, mother, father, Randomness.random()) - override def generate(gender: Gender, mother: Name, father: Name, seed: Long): Name = generate(gender, mother, father, Randomness.random(seed)) - private def generate(gender: Gender, mother: Name, father: Name, random: JRandom): Name = { - // TODO inherit surname - generate(gender, random) - } - -} - -object EnglishlikeNameGenerator { - - val MaleGivenNames = Seq( - "David", "James", "Andrew", "John", "Michael", "Paul", "Matthew", "Mark", "Chris", "Richard", - "Tom", "Alex", "Daniel", "Peter", "Ben", "Robert", "Christopher", "Thomas", "Stephen", "Adam", - "Simon", "Jonathan", "Ian", "Jack", "Sam", "Martin", "Matt", "George", "Nick", "Joe" - ) - - val FemaleGivenNames = Seq( - "Sarah", "Emma", "Laura", "Rachel", "Helen", "Claire", "Emily", "Hannah", "Rebecca", "Sophie", - "Charlotte", "Anna", "Lucy", "Amy", "Catherine", "Jennifer", "Katie", "Jane", "Kate", "Elizabeth", - "Julie", "Louise", "Susan", "Maria", "Karen", "Caroline", "Alison", "Lisa", "Nicola", "Jessica" - ) - - val LastNames = Seq( - "Smith", "Jones", "Patel", "Williams", "Brown", "Davies", "Taylor", "Lee", "Evans", "Harris", "Shah", - "White", "Wilson", "Johnson", "Khan", "Clarke", "Thomas", "Lewis", "Roberts", "Walker", "Thompson", - "Wright", "Edwards", "Davis", "Moore", "Ward", "Chan", "Cooper", "Green", "Robinson", "King", "Turner", - "Jackson", "Wood", "Hughes", "Martin", "Baker", "Hall", "Bennett", "Mitchell", "Shaw", "Hill", "Clark", - "Parker", "Watson", "Scott", "James", "Wong", "Morris", "Cox" - ) - -} \ No newline at end of file diff --git a/src/main/scala/uk/co/halfninja/randomnames/Gender.scala b/src/main/scala/uk/co/halfninja/randomnames/Gender.scala deleted file mode 100644 index 513cb5c..0000000 --- a/src/main/scala/uk/co/halfninja/randomnames/Gender.scala +++ /dev/null @@ -1,9 +0,0 @@ -package uk.co.halfninja.randomnames - -sealed trait Gender - -object Gender { - case object male extends Gender - case object female extends Gender - case object nonspecific extends Gender -} diff --git a/src/main/scala/uk/co/halfninja/randomnames/Name.scala b/src/main/scala/uk/co/halfninja/randomnames/Name.scala deleted file mode 100644 index 9bca39b..0000000 --- a/src/main/scala/uk/co/halfninja/randomnames/Name.scala +++ /dev/null @@ -1,15 +0,0 @@ -package uk.co.halfninja.randomnames - -case class Name(val givenName: String, val familyName: String, val middleNames: Seq[String], val quotedName: String) { - - override def toString = - (Seq(givenName) ++ - (Option(quotedName).map { n => '"' + n + '"' }.toSeq) ++ - middleNames ++ - Seq(familyName)).mkString(" ") - -} - -object Name { - def apply(givenName: String, familyName: String) = new Name(givenName, familyName, Seq.empty, null) -} \ No newline at end of file diff --git a/src/main/scala/uk/co/halfninja/randomnames/NameGenerator.scala b/src/main/scala/uk/co/halfninja/randomnames/NameGenerator.scala deleted file mode 100644 index e9055a2..0000000 --- a/src/main/scala/uk/co/halfninja/randomnames/NameGenerator.scala +++ /dev/null @@ -1,8 +0,0 @@ -package uk.co.halfninja.randomnames - -trait NameGenerator { - def generate(gender: Gender): Name - def generate(gender: Gender, seed: Long): Name - def generate(gender: Gender, mother: Name, father: Name): Name - def generate(gender: Gender, mother: Name, father: Name, seed: Long): Name -} \ No newline at end of file diff --git a/src/main/scala/uk/co/halfninja/randomnames/NameGenerators.scala b/src/main/scala/uk/co/halfninja/randomnames/NameGenerators.scala deleted file mode 100644 index b6caad1..0000000 --- a/src/main/scala/uk/co/halfninja/randomnames/NameGenerators.scala +++ /dev/null @@ -1,8 +0,0 @@ -package uk.co.halfninja.randomnames - -object NameGenerators { - def standardGenerator() = - CompositeNameGenerator - .newGenerator() - .withGenerator("englishlike", new EnglishlikeNameGenerator, 1) -} diff --git a/src/main/scala/uk/co/halfninja/randomnames/Randomness.scala b/src/main/scala/uk/co/halfninja/randomnames/Randomness.scala deleted file mode 100644 index 4e5a968..0000000 --- a/src/main/scala/uk/co/halfninja/randomnames/Randomness.scala +++ /dev/null @@ -1,11 +0,0 @@ -package uk.co.halfninja.randomnames - -import java.util.Random - -object Randomness { - type JRandom = java.util.Random - - def random() = new JRandom - def random(seed: Long) = new JRandom(seed) - def random(strings: Seq[String], random: JRandom): String = strings(random.nextInt(strings.size)) -} diff --git a/src/test/kotlin/uk/co/halfninja/randomnames/EnglishlikeNameGeneratorTest.kt b/src/test/kotlin/uk/co/halfninja/randomnames/EnglishlikeNameGeneratorTest.kt new file mode 100644 index 0000000..274efc3 --- /dev/null +++ b/src/test/kotlin/uk/co/halfninja/randomnames/EnglishlikeNameGeneratorTest.kt @@ -0,0 +1,45 @@ +package uk.co.halfninja.randomnames + +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.Test + +class EnglishlikeNameGeneratorTest { + + /** + * Not actually testing anything here.. just printing things out. + * Fun! + */ + @Test + fun `generation of names works`() { + val generator = NameGenerators.standardGenerator() + repeat(10) { + println(generator.generate(Gender.Male)) + println(generator.generate(Gender.Female)) + } + } + + @Test + fun `seeded name generation returns expected names`() { + val generator = NameGenerators.standardGenerator() + assertEquals("Matthew Baker", generator.generate(Gender.Male, 1234567).toString()) + assertEquals("Sam Greenton", generator.generate(Gender.Male, 1234568).toString()) + assertEquals("Richard Robertsford", generator.generate(Gender.Male, 1234569).toString()) + assertEquals("Jack Patel", generator.generate(Gender.Male, 1234570).toString()) + assertEquals("Chris Shaw", generator.generate(Gender.Male, 1234571).toString()) + assertEquals("Matt Hughes", generator.generate(Gender.Male, 1234572).toString()) + assertEquals("Daniel Edwards", generator.generate(Gender.Male, 1234573).toString()) + assertEquals("Martin Taylor", generator.generate(Gender.Male, 1234574).toString()) + assertEquals("Tom Watson-Thompson", generator.generate(Gender.Male, 1234575).toString()) + assertEquals("Alex Brown", generator.generate(Gender.Male, 1234576).toString()) + assertEquals("Emily Baker", generator.generate(Gender.Female, 1234567).toString()) + assertEquals("Karen Greenton", generator.generate(Gender.Female, 1234568).toString()) + assertEquals("Sophie Robertsford", generator.generate(Gender.Female, 1234569).toString()) + assertEquals("Maria Patel", generator.generate(Gender.Female, 1234570).toString()) + assertEquals("Rebecca Shaw", generator.generate(Gender.Female, 1234571).toString()) + assertEquals("Alison Hughes", generator.generate(Gender.Female, 1234572).toString()) + assertEquals("Lucy Edwards", generator.generate(Gender.Female, 1234573).toString()) + assertEquals("Caroline Taylor", generator.generate(Gender.Female, 1234574).toString()) + assertEquals("Charlotte Watson-Thompson", generator.generate(Gender.Female, 1234575).toString()) + assertEquals("Anna Brown", generator.generate(Gender.Female, 1234576).toString()) + } +} diff --git a/src/test/scala/uk/co/halfninja/randomnames/EnglishlikeNameGeneratorTest.scala b/src/test/scala/uk/co/halfninja/randomnames/EnglishlikeNameGeneratorTest.scala deleted file mode 100644 index eb549ea..0000000 --- a/src/test/scala/uk/co/halfninja/randomnames/EnglishlikeNameGeneratorTest.scala +++ /dev/null @@ -1,46 +0,0 @@ -package uk.co.halfninja.randomnames - -import org.scalatest._ -import org.scalatest.Matchers._ - -class EnglishlikeNameGeneratorTest extends FunSuite { - - /** - * Not actually testing anything here.. just printing things out. - * Fun! - */ - test("Generation of names works") { - val generator = NameGenerators.standardGenerator() - (1 to 10).foreach { i => - println(generator.generate(Gender.male)) - println(generator.generate(Gender.female)) - } - } - - test("Seeded name generation returns expected names") { - val generator = NameGenerators.standardGenerator() - (1 to 10).foreach { i => - generator.generate(Gender.male, 1234567).toString() should be ("Matthew Baker") - generator.generate(Gender.male, 1234568).toString() should be ("Sam Greenton") - generator.generate(Gender.male, 1234569).toString() should be ("Richard Robertsford") - generator.generate(Gender.male, 1234570).toString() should be ("Jack Patel") - generator.generate(Gender.male, 1234571).toString() should be ("Chris Shaw") - generator.generate(Gender.male, 1234572).toString() should be ("Matt Hughes") - generator.generate(Gender.male, 1234573).toString() should be ("Daniel Edwards") - generator.generate(Gender.male, 1234574).toString() should be ("Martin Taylor") - generator.generate(Gender.male, 1234575).toString() should be ("Tom Watson-Thompson") - generator.generate(Gender.male, 1234576).toString() should be ("Alex Brown") - generator.generate(Gender.female, 1234567).toString() should be ("Emily Baker") - generator.generate(Gender.female, 1234568).toString() should be ("Karen Greenton") - generator.generate(Gender.female, 1234569).toString() should be ("Sophie Robertsford") - generator.generate(Gender.female, 1234570).toString() should be ("Maria Patel") - generator.generate(Gender.female, 1234571).toString() should be ("Rebecca Shaw") - generator.generate(Gender.female, 1234572).toString() should be ("Alison Hughes") - generator.generate(Gender.female, 1234573).toString() should be ("Lucy Edwards") - generator.generate(Gender.female, 1234574).toString() should be ("Caroline Taylor") - generator.generate(Gender.female, 1234575).toString() should be ("Charlotte Watson-Thompson") - generator.generate(Gender.female, 1234576).toString() should be ("Anna Brown") - } - } - -}