From 2ecdc572770608c8b6b89c0ac46bb2f437a41a72 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Tue, 28 Mar 2017 21:49:28 +0200 Subject: [PATCH] #1147 Rename limbo segment configurations / remove inaccurate comments --- docs/config.md | 12 +++++------ .../DistributedFilesPersistenceHandler.java | 2 +- .../limbo/persistence/SegmentNameBuilder.java | 2 +- ...entConfiguration.java => SegmentSize.java} | 4 ++-- .../settings/properties/LimboSettings.java | 13 +++++------- ...istributedFilesPersistenceHandlerTest.java | 2 +- .../persistence/SegmentNameBuilderTest.java | 20 +++++++++---------- ...gurationTest.java => SegmentSizeTest.java} | 8 ++++---- 8 files changed, 29 insertions(+), 34 deletions(-) rename src/main/java/fr/xephi/authme/data/limbo/persistence/{SegmentConfiguration.java => SegmentSize.java} (97%) rename src/test/java/fr/xephi/authme/data/limbo/persistence/{SegmentConfigurationTest.java => SegmentSizeTest.java} (84%) diff --git a/docs/config.md b/docs/config.md index 12568519e..9c8a52bd7 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,5 +1,5 @@ - + ## AuthMe Configuration The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder, @@ -458,18 +458,16 @@ limbo: # INDIVIDUAL_FILES: each player data in its own file, # DISTRIBUTED_FILES: distributes players into different files based on their UUID, see below type: 'INDIVIDUAL_FILES' - # This setting only affects DISTRIBUTED_FILES persistence. The segment file + # This setting only affects DISTRIBUTED_FILES persistence. The distributed file # persistence attempts to reduce the number of files by distributing players into various # buckets based on their UUID. This setting defines into how many files the players should # be distributed. Possible values: ONE, FOUR, EIGHT, SIXTEEN, THIRTY_TWO, SIXTY_FOUR, # ONE_TWENTY for 128, TWO_FIFTY for 256. # For example, if you expect 100 non-logged in players, setting to SIXTEEN will average - # 6.25 players per file (100 / 16). If you set to ONE, only one file will be used and the - # entries will be kept in memory, reducing the number of times we read from the file. - # This may deliver different results in terms of performance. + # 6.25 players per file (100 / 16). # Note: if you change this setting all data will be migrated. If you have a lot of data, # change this setting only on server restart, not with /authme reload. - segmentDistribution: 'SIXTEEN' + distributionSize: 'SIXTEEN' # Whether the player is allowed to fly: RESTORE, ENABLE, DISABLE. # RESTORE sets back the old property from the player. restoreAllowFlight: 'RESTORE' @@ -509,4 +507,4 @@ To change settings on a running server, save your changes to config.yml and use --- -This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Tue Mar 28 21:38:52 CEST 2017 +This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Tue Mar 28 21:48:52 CEST 2017 diff --git a/src/main/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandler.java b/src/main/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandler.java index 78f321ef6..bbacd6c55 100644 --- a/src/main/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandler.java +++ b/src/main/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandler.java @@ -52,7 +52,7 @@ class DistributedFilesPersistenceHandler implements LimboPersistenceHandler { .setPrettyPrinting() .create(); - segmentNameBuilder = new SegmentNameBuilder(settings.getProperty(LimboSettings.SEGMENT_DISTRIBUTION)); + segmentNameBuilder = new SegmentNameBuilder(settings.getProperty(LimboSettings.DISTRIBUTION_SIZE)); convertOldDataToCurrentSegmentScheme(); deleteEmptyFiles(); diff --git a/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilder.java b/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilder.java index 4709d8db8..24e0737d3 100644 --- a/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilder.java +++ b/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilder.java @@ -18,7 +18,7 @@ class SegmentNameBuilder { * * @param partition the segment configuration */ - SegmentNameBuilder(SegmentConfiguration partition) { + SegmentNameBuilder(SegmentSize partition) { this.length = partition.getLength(); this.distribution = partition.getDistribution(); this.prefix = "seg" + partition.getTotalSegments() + "-"; diff --git a/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentConfiguration.java b/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentSize.java similarity index 97% rename from src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentConfiguration.java rename to src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentSize.java index 1503fc5cd..0e290ceaa 100644 --- a/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentConfiguration.java +++ b/src/main/java/fr/xephi/authme/data/limbo/persistence/SegmentSize.java @@ -33,7 +33,7 @@ package fr.xephi.authme.data.limbo.persistence; * Where possible, prefer a length of 1 (no string concatenation required) or a distribution of * 16 (no remapping of the characters required). */ -public enum SegmentConfiguration { +public enum SegmentSize { /** 1. */ ONE(1, 1), @@ -65,7 +65,7 @@ public enum SegmentConfiguration { private final int distribution; private final int length; - SegmentConfiguration(int distribution, int length) { + SegmentSize(int distribution, int length) { this.distribution = distribution; this.length = length; } diff --git a/src/main/java/fr/xephi/authme/settings/properties/LimboSettings.java b/src/main/java/fr/xephi/authme/settings/properties/LimboSettings.java index bfd033e5f..b934f2f6e 100644 --- a/src/main/java/fr/xephi/authme/settings/properties/LimboSettings.java +++ b/src/main/java/fr/xephi/authme/settings/properties/LimboSettings.java @@ -8,7 +8,7 @@ import com.google.common.collect.ImmutableMap; import fr.xephi.authme.data.limbo.AllowFlightRestoreType; import fr.xephi.authme.data.limbo.WalkFlySpeedRestoreType; import fr.xephi.authme.data.limbo.persistence.LimboPersistenceType; -import fr.xephi.authme.data.limbo.persistence.SegmentConfiguration; +import fr.xephi.authme.data.limbo.persistence.SegmentSize; import java.util.Map; @@ -31,21 +31,18 @@ public final class LimboSettings implements SettingsHolder { newProperty(LimboPersistenceType.class, "limbo.persistence.type", LimboPersistenceType.INDIVIDUAL_FILES); @Comment({ - "This setting only affects DISTRIBUTED_FILES persistence. The segment file", + "This setting only affects DISTRIBUTED_FILES persistence. The distributed file", "persistence attempts to reduce the number of files by distributing players into various", "buckets based on their UUID. This setting defines into how many files the players should", "be distributed. Possible values: ONE, FOUR, EIGHT, SIXTEEN, THIRTY_TWO, SIXTY_FOUR,", "ONE_TWENTY for 128, TWO_FIFTY for 256.", "For example, if you expect 100 non-logged in players, setting to SIXTEEN will average", - "6.25 players per file (100 / 16). If you set to ONE, only one file will be used and the", - "entries will be kept in memory, reducing the number of times we read from the file.", - "This may deliver different results in terms of performance.", + "6.25 players per file (100 / 16).", "Note: if you change this setting all data will be migrated. If you have a lot of data,", "change this setting only on server restart, not with /authme reload." }) - public static final Property SEGMENT_DISTRIBUTION = - newProperty(SegmentConfiguration.class, "limbo.persistence.segmentDistribution", - SegmentConfiguration.SIXTEEN); + public static final Property DISTRIBUTION_SIZE = + newProperty(SegmentSize.class, "limbo.persistence.distributionSize", SegmentSize.SIXTEEN); @Comment({ "Whether the player is allowed to fly: RESTORE, ENABLE, DISABLE.", diff --git a/src/test/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandlerTest.java b/src/test/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandlerTest.java index caeae15bc..cdc845fbd 100644 --- a/src/test/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandlerTest.java +++ b/src/test/java/fr/xephi/authme/data/limbo/persistence/DistributedFilesPersistenceHandlerTest.java @@ -90,7 +90,7 @@ public class DistributedFilesPersistenceHandlerTest { @BeforeInjecting public void setUpClasses() throws IOException { - given(settings.getProperty(LimboSettings.SEGMENT_DISTRIBUTION)).willReturn(SegmentConfiguration.SIXTEEN); + given(settings.getProperty(LimboSettings.DISTRIBUTION_SIZE)).willReturn(SegmentSize.SIXTEEN); dataFolder = temporaryFolder.newFolder(); playerDataFolder = new File(dataFolder, "playerdata"); playerDataFolder.mkdir(); diff --git a/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilderTest.java b/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilderTest.java index 64843db85..d5cf31a9d 100644 --- a/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilderTest.java +++ b/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentNameBuilderTest.java @@ -5,13 +5,13 @@ import org.junit.Test; import java.util.HashSet; import java.util.Set; -import static fr.xephi.authme.data.limbo.persistence.SegmentConfiguration.EIGHT; -import static fr.xephi.authme.data.limbo.persistence.SegmentConfiguration.FOUR; -import static fr.xephi.authme.data.limbo.persistence.SegmentConfiguration.ONE; -import static fr.xephi.authme.data.limbo.persistence.SegmentConfiguration.SIXTEEN; -import static fr.xephi.authme.data.limbo.persistence.SegmentConfiguration.SIXTY_FOUR; -import static fr.xephi.authme.data.limbo.persistence.SegmentConfiguration.THIRTY_TWO; -import static fr.xephi.authme.data.limbo.persistence.SegmentConfiguration.TWO_FIFTY; +import static fr.xephi.authme.data.limbo.persistence.SegmentSize.EIGHT; +import static fr.xephi.authme.data.limbo.persistence.SegmentSize.FOUR; +import static fr.xephi.authme.data.limbo.persistence.SegmentSize.ONE; +import static fr.xephi.authme.data.limbo.persistence.SegmentSize.SIXTEEN; +import static fr.xephi.authme.data.limbo.persistence.SegmentSize.SIXTY_FOUR; +import static fr.xephi.authme.data.limbo.persistence.SegmentSize.THIRTY_TWO; +import static fr.xephi.authme.data.limbo.persistence.SegmentSize.TWO_FIFTY; import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.hasSize; import static org.junit.Assert.assertThat; @@ -23,11 +23,11 @@ public class SegmentNameBuilderTest { /** * Checks that using a given segment size really produces as many segments as defined. - * E.g. if we partition with {@link SegmentConfiguration#EIGHT} we expect eight different buckets. + * E.g. if we partition with {@link SegmentSize#EIGHT} we expect eight different buckets. */ @Test public void shouldCreatePromisedSizeOfSegments() { - for (SegmentConfiguration part : SegmentConfiguration.values()) { + for (SegmentSize part : SegmentSize.values()) { // Perform this check only for `length` <= 5 because the test creates all hex numbers with `length` digits. if (part.getLength() <= 5) { checkTotalSegmentsProduced(part); @@ -35,7 +35,7 @@ public class SegmentNameBuilderTest { } } - private void checkTotalSegmentsProduced(SegmentConfiguration part) { + private void checkTotalSegmentsProduced(SegmentSize part) { // given SegmentNameBuilder nameBuilder = new SegmentNameBuilder(part); Set encounteredSegments = new HashSet<>(); diff --git a/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentConfigurationTest.java b/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentSizeTest.java similarity index 84% rename from src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentConfigurationTest.java rename to src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentSizeTest.java index 34d23723d..1cc34693c 100644 --- a/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentConfigurationTest.java +++ b/src/test/java/fr/xephi/authme/data/limbo/persistence/SegmentSizeTest.java @@ -12,9 +12,9 @@ import static org.hamcrest.Matchers.greaterThan; import static org.junit.Assert.fail; /** - * Test for {@link SegmentConfiguration}. + * Test for {@link SegmentSize}. */ -public class SegmentConfigurationTest { +public class SegmentSizeTest { @Test public void shouldHaveDistributionThatIsPowerOf2() { @@ -22,7 +22,7 @@ public class SegmentConfigurationTest { Set allowedDistributions = ImmutableSet.of(1, 2, 4, 8, 16); // when / then - for (SegmentConfiguration entry : SegmentConfiguration.values()) { + for (SegmentSize entry : SegmentSize.values()) { if (!allowedDistributions.contains(entry.getDistribution())) { fail("Distribution must be a power of 2 and within [1, 16]. Offending item: " + entry); } @@ -35,7 +35,7 @@ public class SegmentConfigurationTest { Set segmentTotals = new HashSet<>(); // when / then - for (SegmentConfiguration entry : SegmentConfiguration.values()) { + for (SegmentSize entry : SegmentSize.values()) { int totalSegments = entry.getTotalSegments(); assertThat(entry + " must have a positive segment size", totalSegments, greaterThan(0));