Skip to content

Commit 72543b0

Browse files
bgalekbgalek
committed
initial version
0 parents  commit 72543b0

19 files changed

+953
-0
lines changed

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Ignore Gradle project-specific cache directory
2+
.gradle
3+
4+
# Ignore Gradle build output directory
5+
build

‎.travis.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
language: java
2+
3+
jdk:
4+
- openjdk9
5+
- openjdk11
6+
- openjdk12
7+
8+
script:
9+
- "./gradlew build --scan -s"
10+
- "./gradlew jacocoTestReport"
11+
- "./gradlew sonarqube -Dsonar.login=$SONAR_TOKEN -Dsonar.projectKey=bgalek_friendly-names -Dsonar.organization=bgalek-github -Dsonar.host.url=https://sonarcloud.io"
12+
13+
before_cache:
14+
- rm -f $HOME/.gradle/caches/modules-2/modules-2.lock
15+
- rm -fr $HOME/.gradle/caches/*/plugin-resolution/
16+
17+
cache:
18+
directories:
19+
- $HOME/.gradle/caches/
20+
- $HOME/.gradle/wrapper/
21+
22+
after_success:
23+
- bash <(curl -s https://codecov.io/bash)

‎LICENSE

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Friendly name
2+
> Simple and lightweight library that creates friendly names using nouns and adjectives.
3+
4+
![Travis (.org)](https://img.shields.io/travis/bgalek/friendly-names.svg?style=flat-square)
5+
![Codecov](https://img.shields.io/codecov/c/github/bgalek/friendly-names.svg?style=flat-square)
6+
![GitHub Release Date](https://img.shields.io/github/release-date/bgalek/friendly-names.svg?style=flat-square)
7+
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/bgalek/friendly-names.svg?style=flat-square)
8+
![Scrutinizer code quality](https://img.shields.io/scrutinizer/g/bgalek/friendly-names.svg?style=flat-square)
9+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bgalek_friendly-names&metric=alert_status)](https://sonarcloud.io/dashboard?id=bgalek_friendlyname)
10+
11+
## Usage
12+
13+
Add library dependency:
14+
```groovy
15+
compile "com.github.bgalek.security.utils:friendlynames:1.0.0"
16+
```
17+
18+
You can use this library generate user-friendly names:
19+
20+
```java
21+
FriendlyNames.defaultDictionary(Locale.forLanguageTag("pl-PL")).random()
22+
23+
honorowa-mariola
24+
```
25+
26+
```java
27+
FriendlyNames.defaultDictionary().stream().limit(10).forEach(System.out::println)
28+
29+
little-virgie
30+
strong-rachel
31+
military-wes
32+
black-lenard
33+
clear-nelia
34+
important-hans
35+
good-lessie
36+
hard-roxann
37+
real-madelaine
38+
easy-mariela
39+
```
40+
41+
You can provide your own set of *nouns* and *adjectives*
42+
43+
```java
44+
var dictionary = new FriendlyNamesDictionary(Set.of("noun"), Set.of("adjective"))
45+
FriendlyNames.customDictionary(dictionary).random()
46+
47+
noun-adjective
48+
```
49+
50+
## Features
51+
52+
- infinite stream of name combinations
53+
- thread safe
54+
- easy to use/extend

‎build.gradle.kts

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
plugins {
2+
`java-library`
3+
`maven-publish`
4+
signing
5+
jacoco
6+
id("pl.allegro.tech.build.axion-release") version "1.10.0"
7+
id("com.adarshr.test-logger") version "1.6.0"
8+
id("org.sonarqube") version "2.8"
9+
}
10+
11+
repositories {
12+
jcenter()
13+
mavenCentral()
14+
}
15+
16+
dependencies {
17+
testImplementation("org.junit.jupiter:junit-jupiter:5.6.0")
18+
}
19+
20+
group = "com.github.bgalek.utils"
21+
version = scmVersion.version
22+
23+
configure<JavaPluginConvention> {
24+
sourceCompatibility = JavaVersion.VERSION_1_9
25+
targetCompatibility = JavaVersion.VERSION_1_9
26+
}
27+
28+
tasks.jar {
29+
manifest {
30+
attributes(mapOf("Implementation-Title" to project.name, "Implementation-Version" to project.version))
31+
}
32+
}
33+
34+
tasks.test {
35+
useJUnitPlatform()
36+
testLogging {
37+
events("passed", "skipped", "failed")
38+
}
39+
}
40+
41+
tasks.register<Jar>("sourcesJar") {
42+
from(sourceSets.main.get().allJava)
43+
archiveClassifier.set("sources")
44+
}
45+
46+
tasks.register<Jar>("javadocJar") {
47+
from(tasks.javadoc)
48+
archiveClassifier.set("javadoc")
49+
}
50+
51+
jacoco {
52+
toolVersion = "0.8.5"
53+
reportsDir = file("$buildDir/reports/jacoco")
54+
}
55+
56+
tasks.jacocoTestReport {
57+
reports {
58+
xml.isEnabled = true
59+
xml.destination = file("$buildDir/reports/jacoco/report.xml")
60+
csv.isEnabled = false
61+
html.isEnabled = false
62+
}
63+
}
64+
65+
publishing {
66+
publications {
67+
create<MavenPublication>("sonatype") {
68+
artifactId = "friendly-names"
69+
from(components["java"])
70+
artifact(tasks["sourcesJar"])
71+
artifact(tasks["javadocJar"])
72+
versionMapping {
73+
usage("java-api") {
74+
fromResolutionOf("runtimeClasspath")
75+
}
76+
usage("java-runtime") {
77+
fromResolutionResult()
78+
}
79+
}
80+
pom {
81+
name.set("friendly-names")
82+
description.set("Simple and lightweight library that creates friendly names using nouns and adjectives")
83+
url.set("https://github.com/bgalek/friendly-names/")
84+
licenses {
85+
license {
86+
name.set("The Apache License, Version 2.0")
87+
url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
88+
}
89+
}
90+
developers {
91+
developer {
92+
id.set("bgalek")
93+
name.set("Bartosz Gałek")
94+
email.set("[email protected]")
95+
}
96+
}
97+
scm {
98+
connection.set("scm:git:git://github.com/bgalek/friendly-names.git")
99+
developerConnection.set("scm:git:ssh://github.com:bgalek/friendly-names.git")
100+
url.set("https://github.com/bgalek/friendly-names/")
101+
}
102+
}
103+
}
104+
}
105+
repositories {
106+
maven {
107+
credentials {
108+
username = project.properties["ossrhUsername"] as String?
109+
password = project.properties["ossrhPassword"] as String?
110+
}
111+
val releasesRepoUrl = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
112+
val snapshotsRepoUrl = uri("https://oss.sonatype.org/content/repositories/snapshots/")
113+
url = if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl
114+
}
115+
}
116+
}
117+
118+
signing {
119+
useGpgCmd()
120+
sign(publishing.publications["sonatype"])
121+
}
122+
123+
tasks.javadoc {
124+
if (JavaVersion.current().isJava9Compatible) {
125+
(options as StandardJavadocDocletOptions).addBooleanOption("html5", true)
126+
}
127+
}

‎gradle/wrapper/gradle-wrapper.jar

57.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)