From 1aa071570298271a789b7675c8828c9520a7fa9c Mon Sep 17 00:00:00 2001 From: fastily Date: Fri, 31 Mar 2017 00:36:30 -0700 Subject: [PATCH] update genArtifacts, readme, light refactor This also marks the 1.3.0 release --- README.md | 19 ++----------------- ToDo.md | 4 +++- build.gradle | 18 +----------------- genArtifacts.sh | 16 +++++++++++----- src/main/java/fastily/jwiki/core/WQuery.java | 2 +- .../java/fastily/jwiki/dwrap/RCEntry.java | 2 +- src/main/java/fastily/jwiki/util/FSystem.java | 7 +------ src/main/java/fastily/jwiki/util/WikiGen.java | 2 +- 8 files changed, 21 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 61daf36..86be53f 100644 --- a/README.md +++ b/README.md @@ -13,21 +13,6 @@ jwiki is a simple Java client library wrapping the [MediaWiki](https://www.media * [Recipe Book/Cheatsheet](https://github.com/fastily/jwiki/wiki/Recipe-Book) * [Javadocs](https://fastily.github.io/jwiki/docs/jwiki/) -### Example Code -```java -import fastily.jwiki.core.Wiki; - -//Edit a Wikipedia page by replacing its text with text of your choosing. -public class JwikiExample -{ - public static void main(String[] args) throws Throwable - { - Wiki wiki = new Wiki("Username", "Password", "en.wikipedia.org"); // login - wiki.edit("Wikipedia:Sandbox", "SomeText", "EditSummary"); // edit - } -} -``` - ### Download jwiki is available via [bintray/jcenter](https://bintray.com/fastily/maven/jwiki) @@ -36,14 +21,14 @@ Maven: fastily jwiki - 1.2.1 + 1.3.0 pom ``` Gradle: ```groovy -compile 'fastily:jwiki:1.2.1' +compile 'fastily:jwiki:1.3.0' ``` ### Minimum Requirements diff --git a/ToDo.md b/ToDo.md index e0ff286..ca4be4d 100644 --- a/ToDo.md +++ b/ToDo.md @@ -11,4 +11,6 @@ * May want to back color log with log4j * Could cached Wiki objects be keyed by HttpUrl? -* Fix purge() \ No newline at end of file +* Fix purge() + +* WikiGen needs refactor \ No newline at end of file diff --git a/build.gradle b/build.gradle index 1b2c966..ba42682 100644 --- a/build.gradle +++ b/build.gradle @@ -1,9 +1,8 @@ apply plugin: 'java-library' apply plugin: 'eclipse' apply plugin: 'maven' -// apply plugin: 'maven-publish' -version="1.2.2" +version="1.3.0" description="jwiki build script" group="fastily" @@ -12,21 +11,6 @@ compileJava { targetCompatibility = "1.8" } -/*publishing { - publications { - mavenJava(MavenPublication) { - from components.java - } - } - - model { - tasks.generatePomFileForMavenCustomPublication { - destination = file("$buildDir/generated-pom.xml") - } -} -} -*/ - repositories { jcenter() } diff --git a/genArtifacts.sh b/genArtifacts.sh index dde3ae7..f26cfa5 100644 --- a/genArtifacts.sh +++ b/genArtifacts.sh @@ -2,16 +2,22 @@ #: Generates Maven artifacts for jwiki. #: -#: PRECONDITION: gradle build succeeded. Minimum gradle version >= 3.0 -#: -#: Tested on OS X 10.11.6 +#: Tested on macOS 10.12.4 #: Author: Fastily -version="1.2.2" +version="1.3.0" name="jwiki" outputDir="build/artifacts" -cd "${0%/*}" +cd "${0%/*}" &> /dev/null + +gradle clean build -x test + +if ! gradle writeNewPom genJavadoc ; then + printf "ERROR: Build Failed\n" + exit 1 +fi + mkdir -p "$outputDir" ## Copy sources diff --git a/src/main/java/fastily/jwiki/core/WQuery.java b/src/main/java/fastily/jwiki/core/WQuery.java index 87a4a26..d58b23a 100644 --- a/src/main/java/fastily/jwiki/core/WQuery.java +++ b/src/main/java/fastily/jwiki/core/WQuery.java @@ -15,7 +15,7 @@ * @author Fastily * */ -public class WQuery +class WQuery { /** * Default parameters for getting category size info diff --git a/src/main/java/fastily/jwiki/dwrap/RCEntry.java b/src/main/java/fastily/jwiki/dwrap/RCEntry.java index 08bf461..12f5ec3 100644 --- a/src/main/java/fastily/jwiki/dwrap/RCEntry.java +++ b/src/main/java/fastily/jwiki/dwrap/RCEntry.java @@ -15,7 +15,7 @@ public class RCEntry extends DataEntry { /** - * The type of entry this RCEntry represents (e.g. log, edit, new) + * The type of entry this RCEntry represents (ex: log, edit, new) */ public final String type; diff --git a/src/main/java/fastily/jwiki/util/FSystem.java b/src/main/java/fastily/jwiki/util/FSystem.java index e31d341..86b5d65 100644 --- a/src/main/java/fastily/jwiki/util/FSystem.java +++ b/src/main/java/fastily/jwiki/util/FSystem.java @@ -21,12 +21,7 @@ public final class FSystem * The default separator for pathnames by OS. For Windows it is '\' for Mac/Unix it is '/' */ public static final String psep = FileSystems.getDefault().getSeparator(); - - /** - * The user's home directory. - */ - public static final String home = System.getProperty("user.home"); - + /** * All static methods, no constructors allowed. */ diff --git a/src/main/java/fastily/jwiki/util/WikiGen.java b/src/main/java/fastily/jwiki/util/WikiGen.java index 7506555..33e3fc6 100644 --- a/src/main/java/fastily/jwiki/util/WikiGen.java +++ b/src/main/java/fastily/jwiki/util/WikiGen.java @@ -33,7 +33,7 @@ public final class WikiGen /** * An additional location to save credentials under. */ - private static final String homefmt = FSystem.home + FSystem.psep; + private static final String homefmt = System.getProperty("user.home") + FSystem.psep; /** * The default WikiGen object created at run time.