Merge pull request #90 from 05nelsonm/2.0.0

2.0.0

Author: 05nelsonm

README.md

@@ -36,16 +36,21 @@ The following exception is an additional permission under section 7 of the
 GNU General Public License, version 3 (“GPLv3”).  
 
 "The Interfaces" is henceforth defined as Application Programming Interfaces  
-that are publicly available classes/functions/etc (ie: do not contain the  
-visibility modifiers `internal`, `private`, `protected`, or are within  
-classes/functions/etc that contain the aforementioned visibility modifiers)  
-to TorOnionProxyLibrary-Android users that are needed to implement  
-TorOnionProxyLibrary-Android and reside in ONLY the following modules:  
+needed to implement TorOnionProxyLibrary-Android, as listed below:  
 
- - topl-core-base  
- - topl-service  
+ - From the `topl-core-base` module:  
+     - All Classes/methods/variables  
 
-The following are excluded from "The Interfaces":  
+ - From the `topl-service-base` module:  
+     - All Classes/methods/variables  
+
+ - From the `topl-service` module:  
+     - The TorServiceController class and it's contained classes/methods/variables  
+     - The ServiceNotification.Builder class and it's contained classes/methods/variables  
+     - The BackgroundManager.Builder class and it's contained classes/methods/variables  
+     - The BackgroundManager.Companion class and it's contained methods/variables  
+
+The following code is excluded from "The Interfaces":  
 
   - All other code  
 

build.gradle

@@ -1,5 +1,3 @@
-apply plugin: 'org.jetbrains.dokka'
-
 buildscript {
     apply from: "$rootDir/gradle/dependencies.gradle"
 
@@ -9,24 +7,73 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath deps.androidGradlePlugin
-        classpath deps.kotlin.dokka
-        classpath deps.kotlin.gradlePlugin
-        classpath deps.mavenPublish
+        classpath plugin.androidGradle
+        classpath plugin.kotlin.dokka
+        classpath plugin.kotlin.gradle
+        classpath plugin.mavenPublish
+        classpath plugin.gradleVersions
     }
 }
 
 allprojects  {
     repositories {
         google()
         jcenter()
+//        maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
     }
 
     tasks.withType(Test) {
         maxHeapSize = "4096m"
     }
 }
 
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}
+
+////////////////////////////////////////////////////////////////////////////
+/// Gradle Versions: https://github.com/ben-manes/gradle-versions-plugin ///
+////////////////////////////////////////////////////////////////////////////
+
+apply plugin: 'com.github.ben-manes.versions'
+
+def isNonStable = { String version ->
+    def stableKeyword = ['RELEASE', 'FINAL', 'GA'].any { it -> version.toUpperCase().contains(it) }
+    def regex = /^[0-9,.v-]+(-r)?$/
+    return !stableKeyword && !(version ==~ regex)
+}
+
+tasks.named("dependencyUpdates").configure {
+    checkForGradleUpdate = true
+
+    // Example 1: reject all non stable versions
+    rejectVersionIf {
+        isNonStable(candidate.version)
+    }
+
+    // Example 2: disallow release candidates as upgradable versions from stable versions
+    rejectVersionIf {
+        isNonStable(candidate.version) && !isNonStable(currentVersion)
+    }
+
+    // Example 3: using the full syntax
+    resolutionStrategy {
+        componentSelection {
+            all {
+                if (isNonStable(candidate.version) && !isNonStable(currentVersion)) {
+                    reject('Release candidate')
+                }
+            }
+        }
+    }
+}
+
+//////////////////////////////////////////////
+/// Dokka: https://github.com/Kotlin/dokka ///
+//////////////////////////////////////////////
+
+apply plugin: 'org.jetbrains.dokka'
+
 // Dokka's configuration.externalDocumentationLink.url setting for connecting methods/variables
 // in each module is quarky, especially when relying on Mkdocs to generate a website using the
 // Markdown files that are created. the `externalDocumentationLink.url` setting requires a
@@ -37,7 +84,3 @@ task fixDokkaDocLinks(type: Exec) {
     workingDir "$rootDir"
     commandLine "scripts/fix_dokka_doc_external_links.sh"
 }
-
-task clean(type: Delete) {
-  delete rootProject.buildDir
-}

docs/changelog.md

@@ -25,7 +25,7 @@
 ## Version 1.0.0-alpha02 (2020-08-03)
  - API breaking changes were made to `TorServiceController.Builder`. See the following to update:
      - [TorServiceController.Builder](./topl-service/io.matthewnelson.topl_service/-tor-service-controller/-builder/index.md)
-     - [TorServiceEventBroadcaster](./topl-service/io.matthewnelson.topl_service.service.components.onionproxy.model/-tor-service-event-broadcaster/index.md)
+     - [TorServiceEventBroadcaster](./topl-service-base/io.matthewnelson.topl_service_base/-tor-service-event-broadcaster/index.md)
  - Added ability to hide the notification
      - NOTE: Will be shown when user swipes the application out of recent's tray (required).
  - Service now starts via `Context.startService` + `Context.bindService` instead of starting

docs/documentation.md

@@ -2,12 +2,16 @@
 
 ## [topl-service](./topl-service/index.md)
 
+## [topl-service-base](./topl-service-base/index.md)
+
 ## [topl-core-base](./topl-core-base/index.md)
 
-<!-- Hold off linking to docs until release -->
+<!-- Hold off linking to docs until refactor is complete -->
 <!-- ## [topl-core](./topl-core/io.matthewnelson.topl_core/index.md) -->
 
 !!! Info
     Documentation here only includes **Public** methods/classes, meaning links to non-public
     methods/classes are broken. You can view all methods/classes from the Project View in
-    Android Studio via: `Project/External Libraries/io.matthewnelson.topl_android:topl_*@arr`
+    Android Studio via: `Project/External Libraries/io.matthewnelson.topl_android:topl_*@arr`
+
+## [Migrations](./migration.md)

docs/get_started.md

@@ -17,7 +17,7 @@ Get Started
  - **torrc file**:
     - Not needed
     - Your application's `torrc` file gets created for you based on what you have stored in 
-    [TorServicePrefs](./topl-service/io.matthewnelson.topl_service.prefs/-tor-service-prefs/index.md). 
+    [TorServicePrefs](./topl-service-base/io.matthewnelson.topl_service_base/-tor-service-prefs/index.md). 
     If nothing is in `TorServicePrefs` for that particular setting, then it will fall back on 
     your static/default [TorSettings](./topl-core-base/io.matthewnelson.topl_core_base/-tor-settings/index.md) 
     that you supply upon initialization of `TorServiceController.Builder`.  
@@ -56,9 +56,7 @@ Get Started
 ## Implementation - Step 2: topl-service
  - In your Application module's `build.gradle` file, add the following to the `dependencies` block:
      ```groovy
-     def topl_android_version = "{{ topl_android.release }}"
-     implementation "io.matthewnelson.topl-android:topl-core-base:$topl_android_version"
-     implementation "io.matthewnelson.topl-android:topl-service:$topl_android_version"
+     implementation "io.matthewnelson.topl-android:topl-service:{{ topl_android.release }}"
      ```
  
  - Create a new class which extends [TorSettings](./topl-core-base/io.matthewnelson.topl_core_base/-tor-settings/index.md)
@@ -87,9 +85,7 @@ Get Started
    
  - In your Application module's `build.gradle` file, add (or modify) the following in the `dependencies` block:
      ```groovy
-     def topl_android_version = "{{ topl_android.next_release }}-SNAPSHOT"
-     implementation 'io.matthewnelson.topl-android:topl-core-base:$topl_android_version'
-     implementation 'io.matthewnelson.topl-android:topl-service:$topl_android_version'
+     implementation 'io.matthewnelson.topl-android:topl-service:{{ topl_android.next_release }}-SNAPSHOT'
      ```
 
     !!! Warning

docs/index.md

@@ -68,16 +68,21 @@ The following exception is an additional permission under section 7 of the
 GNU General Public License, version 3 (“GPLv3”).  
 
 "The Interfaces" is henceforth defined as Application Programming Interfaces  
-that are publicly available classes/functions/etc (ie: do not contain the  
-visibility modifiers `internal`, `private`, `protected`, or are within  
-classes/functions/etc that contain the aforementioned visibility modifiers)  
-to TorOnionProxyLibrary-Android users that are needed to implement  
-TorOnionProxyLibrary-Android and reside in ONLY the following modules:  
+needed to implement TorOnionProxyLibrary-Android, as listed below:  
 
- - topl-core-base  
- - topl-service  
+ - From the `topl-core-base` module:  
+     - All Classes/methods/variables  
 
-The following are excluded from "The Interfaces":  
+ - From the `topl-service-base` module:  
+     - All Classes/methods/variables  
+
+ - From the `topl-service` module:  
+     - The TorServiceController class and it's contained classes/methods/variables  
+     - The ServiceNotification.Builder class and it's contained classes/methods/variables  
+     - The BackgroundManager.Builder class and it's contained classes/methods/variables  
+     - The BackgroundManager.Companion class and it's contained methods/variables  
+
+The following code is excluded from "The Interfaces":  
 
   - All other code  
 

docs/migration.md

@@ -0,0 +1,11 @@
+# Migration
+
+## Migrating from 1.0.0 to 2.0.0
+ - Your Application's `TorSettings` class needs to now extend
+ [ApplicationDefaultTorSettings](./topl-service-base/io.matthewnelson.topl_service_base/-application-default-tor-settings/index.md)
+ - Remove and re-import class paths, as all non-Builder classes were moved to the
+ `topl-service-base` module
+ - The `topl-core-base` dependency is no longer required as it is automatically provided with
+ `topl-service`. If you have a `Tor` module, other module's depending on it need only
+ import the `topl-service-base` module now as all visible classes/abstractions have been moved there.
+ - The `TorServiceController.getServiceTorSettings` no longer requires context

docs/releasing.md

@@ -31,8 +31,8 @@ extra:
 
 - Generate the Dokka docs
 ```
-rm -rf docs/topl-core docs/topl-core-base docs/topl-service
-./gradlew topl-core-base:dokka topl-core:dokka topl-service:dokka
+rm -rf docs/topl-core docs/topl-core-base docs/topl-service-base docs/topl-service
+./gradlew topl-core-base:dokka topl-core:dokka topl-service-base:dokka topl-service:dokka
 ```
 
 - Fix Dokka doc links

docs/topl-core-base/io.matthewnelson.topl_core_base/-base-consts/-broadcast-type/-d-e-b-u-g.md

@@ -2,4 +2,4 @@
 
 # DEBUG
 
-`const val DEBUG: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core-base/src/main/java/io/matthewnelson/topl_core_base/BaseConsts.kt#L93)
+`const val DEBUG: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core-base/src/main/java/io/matthewnelson/topl_core_base/BaseConsts.kt#L98)

docs/topl-core-base/io.matthewnelson.topl_core_base/-base-consts/-broadcast-type/-e-r-r-o-r.md

@@ -2,4 +2,4 @@
 
 # ERROR
 
-`const val ERROR: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core-base/src/main/java/io/matthewnelson/topl_core_base/BaseConsts.kt#L94)
+`const val ERROR: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core-base/src/main/java/io/matthewnelson/topl_core_base/BaseConsts.kt#L99)