clubobsidian / wrappy

A wrapper for configurate

wrappy

A wrapper to simplify the usage of configurate.

Supported formats

• Yaml
• Json
• Hocon
• XML

Build Artifacts

Build artifacts are hosted via Jitpack.

Setting up as a dependency

Gradle

repositories {
	mavenCentral()
	maven { url 'https://jitpack.io' }
}

compile 'com.github.clubobsidian:wrappy:4.1.0'

Maven

<repositories>
	<repository>
		<id>jitpack.io</id>
		<url>https://jitpack.io</url>
	</repository>
</repositories>

<dependency>
	<groupId>com.github.clubobsidian</groupId>
	<artifactId>wrappy</artifactId>
	<version>4.1.0</version>
</dependency>

Dependencies

• configurate
  • Yaml
  • Json
  • Hocon
  • XML

Development

Eclipse

1. Git clone the project
2. Generate eclipse files with gradlew eclipse
3. Import project
4. Right click project -> Add gradle nature

Intellij

1. Git clone the project
2. Generate intellij files with gradlew idea
3. Import project

Building

gradlew build

wrappy's Issues

Add Bukkit extension

Use http library for retrieving remote configs

Use something like https://github.com/square/okhttp, this does have a kotlin standard library dependency so we might end up using something else

Git support

ClubObsidian/DynamicGui#36

Add more serializers

There are many more types that configurate supports out of the box we should support these
https://github.com/SpongePowered/Configurate/blob/7486a00e71af8866bf5187d9838c6d46a440379a/configurate-core/src/main/java/ninja/leaping/configurate/objectmapping/serialize/TypeSerializers.java

Bind fields to config values

Bind fields to config values, part of #17

Throw better error if holder is null when injecting

[02:18:59] [Server thread/ERROR]: Error occurred while enabling HazardousStats v1.0.0-SNAPSHOT (Is it up to date?)
java.lang.NullPointerException: Cannot invoke "Object.getClass()" because "this.injectInto" is null
	at com.github.hazardousmc.stats.shaded.wrappy.inject.ConfigurationInjector.inject(ConfigurationInjector.java:44) ~[HazardousStats-1.0.0-SNAPSHOT.jar:?]
	at com.github.hazardousmc.stats.shaded.wrappy.inject.ConfigurationInjector.inject(ConfigurationInjector.java:60) ~[HazardousStats-1.0.0-SNAPSHOT.jar:?]
	at com.github.hazardousmc.stats.shaded.wrappy.inject.ConfigurationInjector.inject(ConfigurationInjector.java:60) ~[HazardousStats-1.0.0-SNAPSHOT.jar:?]
	at com.github.hazardousmc.stats.shaded.wrappy.ConfigurationSection.inject(ConfigurationSection.java:271) ~[HazardousStats-1.0.0-SNAPSHOT.jar:?]
	at com.github.hazardousmc.stats.shaded.wrappy.ConfigurationSection.inject(ConfigurationSection.java:266) ~[HazardousStats-1.0.0-SNAPSHOT.jar:?]
	at com.github.hazardousmc.stats.HazardousStatsPlugin.onEnable(HazardousStatsPlugin.java:55) ~[HazardousStats-1.0.0-SNAPSHOT.jar:?]
	at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:287) ~[paper-api-1.20.4-R0.1-SNAPSHOT.jar:?]
	at io.papermc.paper.plugin.manager.PaperPluginInstanceManager.enablePlugin(PaperPluginInstanceManager.java:188) ~[paper-1.20.4.jar:git-Paper-430]
	at io.papermc.paper.plugin.manager.PaperPluginManagerImpl.enablePlugin(PaperPluginManagerImpl.java:104) ~[paper-1.20.4.jar:git-Paper-430]
	at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:507) ~[paper-api-1.20.4-R0.1-SNAPSHOT.jar:?]
	at org.bukkit.craftbukkit.v1_20_R3.CraftServer.enablePlugin(CraftServer.java:639) ~[paper-1.20.4.jar:git-Paper-430]
	at org.bukkit.craftbukkit.v1_20_R3.CraftServer.enablePlugins(CraftServer.java:550) ~[paper-1.20.4.jar:git-Paper-430]
	at net.minecraft.server.MinecraftServer.loadWorld0(MinecraftServer.java:671) ~[paper-1.20.4.jar:git-Paper-430]
	at net.minecraft.server.MinecraftServer.loadLevel(MinecraftServer.java:431) ~[paper-1.20.4.jar:git-Paper-430]
	at net.minecraft.server.dedicated.DedicatedServer.initServer(DedicatedServer.java:309) ~[paper-1.20.4.jar:git-Paper-430]
	at net.minecraft.server.MinecraftServer.runServer(MinecraftServer.java:1131) ~[paper-1.20.4.jar:git-Paper-430]
	at net.minecraft.server.MinecraftServer.lambda$spin$0(MinecraftServer.java:319) ~[paper-1.20.4.jar:git-Paper-430]
	at java.lang.Thread.run(Thread.java:1583) ~[?:?]
	```

Add path to configuration section

Allow the configuration section be aware of it's "name" that is parsed from the config. Root should always be null as "root" may be ambiguous.

Full path would be better.

Jdk10+ travis builds fail

Jdk10+ travis builds fail due to a certificate error when accessing sponge repos. Should be investigated.

Auto reloading based on file changes

Use filewatcher

Comments in yaml files while saving

Add support for comments in yaml files while saving. Configurate will likely need to be forked or changes will need to be made in upstream. Snakeyaml should be investigated further to see if this is even possible.

Create a way to save a config as a different file

It would be very useful if you are able to save a configuration as a different file.

Would be very useful if you load a configuration from a url to use as a default config file then save it as a file.

Wrappy creates an empty file if you load a nonexisting file

By default, Wrappy creates an empty config file if the file doesn't exist. I believe that it should only do that when you save a config to prevent bloat with certain applications.

createSection

Add an option to configuration to create a configuration section with a given path.

Rewrite the way configurations are loaded

Rewrite configuration to support

• External serializers
• Builder pattern
• Make code more dry

Rewrite tests

Rewrite test so that each tests is run on each individual configuration format. This may be able to be done with junit runners or something similar.

Use md5 hashing for comparing remote files

Add a method to delete a config file from the config object

Would be very convenient in certain applications where you wouldn't know the root folder location.

Compare md5 from stream when loading from URL

Compare md5 hash when loading from a stream instead of having a temporary file location.

Switch to github actions

Refer to https://github.com/ClubObsidian/DynamicGuiParser

Backup local file support

ClubObsidian/DynamicGui#35

JDK 11+ Builds failing due to codecov

JDK 11+ builds are failing on travis due to codecov, should be investigated to ensure compatibility on jdk 11+.