Gradle Config Plugin

This plugin helps you to easily handle variant specific settings with yaml format.

Usage

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "com.sjcqs.android:config:1.1.0"
  }
}


apply plugin: 'com.android.application'
apply plugin: "com.sjcqs.android.config"

Build script snippet for new, incubating, plugin mechanism introduced in Gradle 2.1:

plugins {
  id "com.sjcqs.android.config" version "1.1.0"
}

Settings class

The entries in config yaml will be available in Settings class as static members:

Settings.entry

Nested entries are supported:

Settings.entry.some_entry

Config files

Config entries are generated from:

config/default.yml
config/default_secret.yml
config/${dimension}.yml
config/${productFlavor}.yml
config/${productFlavor}_secret.yml
config/${buildType}.yml
config/${buildType}_secret.yml

Entries are generated using the current build variant. There are merged and the lower one overwrites upper one deeply. Left-most flavors dimensions overwrite the others ones.

Example:

build.gradle

flavorDimensions "brand", "environment" 
productFlavors {
        brand1 {
            dimension "brand"
            // ...
        }
        brand2 {
            dimension "brand"
            // ...
        }
        stubs {
            dimension "environment"
            // ...
        }
        preprod {
            dimension "environment"
            // ...
        }
        prod {
            dimension "environment"
            // ...
        }
    }

config/

// default.yml
section_1:
  entry_1: "Hello"
  entry_2: "world"
entry_3: 94
section_2:
  entry_1: "John"
  entry_2: "Doe" 
entry_4: "Some value"
// brand1.yml
section_1:
  entry_2: "tom"
// brand2.yml
section_2:
  entry_1: "Jane"
// stubs.yml
entry_3: 24
section_1:
  entry_2: "Pete"
// debug.yml
section_2:
  entry_1: "Paul"
  entry_2: "Johson"
// brand1StubsDebug.yml
entry_3: 42

On compilation the following Settings will be generated for brand1StubsDebug build variant.

Settings.section_1.entry_1; // => Hello in default.yml
Settings.section_1.entry_2; // => Pete ovewritten by brand1.yml
Settings.entry_3; // => 42 overwritten by brand1StubsDebug.yml
Settings.section_2.entry_1; // => Paul overwritten by debug.yml
Settings.section_2.entry_2; // => Johnson overwritter by debug.yml
Settings.entry_4; // => Some value original value

The purpose of loading settings files with suffix _secret is to avoid to commit the secret files to remote repository. If you want to use this feature, don't forget to include those files to your .gitignore:

*_secret.yml

Accessing Configuration Settings

Consider the following config files.

config/default.yml

size: 1
server: google.com

config/debug.yml

size: 2
server: google.com
section:
  size: 3
  servers: [ {name: yahoo.com}, {name: amazon.com} ]

Notice that the variant specific config entries overwrite the common entries.

Settings.size   // => 2
Settings.server // => google.com

Notice that object member notation is maintained even in nested entries.

Settings.section.size // => 3

Notice array notation and object member notation is maintained.

Settings.section.servers.get(0).name // => yahoo.com
Settings.section.servers.get(1).name // => amazon.com

Type

Consider this config file:

string_entry: string
int_entry: 1
double_entry: 1.0
date_entry: 2001-11-23 15:03:17
list_entry:
  - 1
  - 2
failed_list_entry:
  - 1
  - 'test'
object_entry:
  entry_a: 1
  entry_b: 2
list_of_map_entry:
  - a: 'a1'
    b: 'b1'
  - a: 'a2'
    b: 'b2'

The snakeyaml library this plugin uses provides the following basic type conversions:

Integer i = Settings.int_entry;
String s = Settings.string_entry;
Double d = Settings.double_entry;
Date da = Settings.date_entry;
List<Integer> list = Settings.list_entry;

The list with mixed type elements are not supported and throw an exception.

Error:Execution failed for task ':app:generateDevDebugSettings'.
> Not supported list with mixed type: [class java.lang.Integer, class java.lang.String]

The nested map entries are converted a generated class to achieve dot access.

Settings.ObjectEntry oe = Settings.object_entry;
Integer entryA = object_entry.entry_a;
Integer entryB = object_entry.entry_b;

Also, the list of map are supported.

List<Settings.ListOfMapEntryElement> entries = Settings.list_of_map_entry;

Known issues

Not found Settings class

Sometimes Android Studio does not detect generated Settings class. When you fact to this problem, Refresh all Gradle projects in the right pane of Android Studio may be helpful.

License

Copyright 2018 sjcqs
Copyright 2017 Polidea
Copyright 2015 Takuya Miyamoto

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

    http://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.

sjcqs/gradle-config