NyaaCore init

Author: RecursiveG

.travis.yml

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 NyaaCat Community
+Copyright (c) 2017 NyaaCat Community
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,23 +1,29 @@
-## nyaautils
+## NyaaCore
+Common library used for all NyaaCat plugin.  
+Provides infrastructures to simplify plugin development.
 
-Gaming utilities/helpers for NyaaCat Minecraft Server
+Current version: Minecraft 1.11.2
 
-Detailed function manual please refer to [Wiki](https://github.com/NyaaCat/nyaautils/wiki).
+## Component List
 
-[![Build Status](https://travis-ci.org/NyaaCat/nyaautils.svg?branch=master)](https://travis-ci.org/NyaaCat/nyaautils)
+- Annotation based command dispatcher
+- Annotation based configuration serializer
+- Annotation based database serializer
+- JSON message builder
+- Server side I18n support
 
 ## Use as dependency in Gradle
 
 ```
 repositories {
     maven {
-        name 'nyaa'
-        url 'https://raw.githubusercontent.com/NyaaCat/nyaautils/maven-repo'
+        name 'NyaaCore'
+        url 'https://raw.githubusercontent.com/NyaaCat/NyaaCore/maven-repo'
     }
 }
 
 dependencies {
-    compile('cat.nyaa:nyaautils:2.0-SNAPSHOT') {
+    compile('cat.nyaa:nyaacore:2.0-SNAPSHOT') {
         transitive = false
     }
 }

README.md

@@ -6,6 +6,7 @@ plugins {
 
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
+archivesBaseName = 'NyaaCore-mc1.11.2'
 
 repositories {
     jcenter()
@@ -50,19 +51,3 @@ dependencies {
 compileJava {
     options.compilerArgs += ["-Xplugin:NyaaUtilsLangAnnotationProcessor"]
 }
-
-publishing {
-    publications {
-        mavenJava(MavenPublication) {
-            groupId "cat.nyaa"
-            artifactId "nyaautils"
-            version '2.0-SNAPSHOT'
-            from components.java
-        }
-    }
-    repositories {
-        maven {
-            url "$buildDir/repo"
-        }
-    }
-}

build.gradle

@@ -1,5 +1,6 @@
-package cat.nyaa.utils;
+package cat.nyaa.nyaacore;
 
+import cat.nyaa.nyaacore.configuration.ISerializable;
 import org.bukkit.ChatColor;
 import org.bukkit.enchantments.Enchantment;
 import org.bukkit.inventory.ItemStack;

manually_deploy_repo.sh

@@ -1,4 +1,4 @@
-package cat.nyaa.utils;
+package cat.nyaa.nyaacore;
 
 import org.bukkit.Bukkit;
 import org.bukkit.Material;

src/main/java/cat/nyaa/utils/BasicItemMatcher.java renamed to src/main/java/cat/nyaa/nyaacore/BasicItemMatcher.java

@@ -1,6 +1,5 @@
-package cat.nyaa.utils;
+package cat.nyaa.nyaacore;
 
-import cat.nyaa.nyaautils.NyaaUtils;
 import org.bukkit.ChatColor;
 import org.bukkit.configuration.ConfigurationSection;
 import org.bukkit.configuration.file.YamlConfiguration;
@@ -16,53 +15,70 @@
 import java.util.Map;
 
 public abstract class Internationalization {
-    private final String DEFAULT_LANGUAGE = "en_US";
-    private final Map<String, String> map = new HashMap<>();
-    // internal language keys will only be loaded from NyaaUtils
-    // but share across all dependent plugins
-    // TODO do not depend on NyaaUtils
-    // TODO HEH load before NU ?!
+    /**
+     * Use English as default & fallback language
+     */
+    private static final String DEFAULT_LANGUAGE = "en_US";
+    /**
+     * Internal language map is loaded and should only be loaded by {@link NyaaCoreLoader#onLoad()}
+     * Once it's loaded, it cannot be reloaded or modified.
+     * The internal map will be shared across all plugins using {@link Internationalization}
+     */
     private final static Map<String, String> internalMap = new HashMap<>();
+    /**
+     * Per-plugin language map used by {@link Internationalization}
+     * This map has a higher priority than {@link this#internalMap}
+     * So it's possible to overwrite some internal language keys here.
+     */
+    private final Map<String, String> map = new HashMap<>();
 
+    /**
+     * Dependent plugins should provide the "main" class instance
+     * So that language files could be loaded automatically
+     *
+     * @return the plugin class instance
+     */
     protected abstract JavaPlugin getPlugin();
 
+    /**
+     * @return the language to be loaded into {@link this#map}
+     */
     protected abstract String getLanguage();
 
+
+    /**
+     * Reset then load per-plugin language map
+     * Based on {@link this#getPlugin()} and {@link this#getLanguage()}
+     */
     public void load() {
+        map.clear();
         String language = getLanguage();
         JavaPlugin plugin = getPlugin();
         if (language == null) language = DEFAULT_LANGUAGE;
-        // internal map
-        if (plugin instanceof NyaaUtils) {
-            loadInternalMap((NyaaUtils) plugin, language);
-        }
         // language map
         loadLanguageMap(plugin, language);
         // save (probably) modified language file back to disk
-        saveLanguageMap(plugin, language);
+        saveLanguageMap();
 
         plugin.getLogger().info(get("internal.info.using_language", language));
     }
 
-    private void loadInternalMap(NyaaUtils plugin, String language) {
-        internalMap.clear();
-        boolean forceJar = System.getProperty("nyaautils.i18n.loadFromDisk", "true").equals("false");
-        if (!forceJar) { // load from disk
-            File localLangFile = new File(plugin.getDataFolder(), language + ".yml");
-            if (localLangFile.exists()) {
-                ConfigurationSection section = YamlConfiguration.loadConfiguration(localLangFile);
-                loadLanguageSection(internalMap, section.getConfigurationSection("internal"), "internal.", false);
+    /**
+     * Load per-plugin language map
+     * Based on {@link this#getPlugin()} and {@link this#getLanguage()}
+     */
+    public void saveLanguageMap() {
+        JavaPlugin plugin = getPlugin();
+        String language = getLanguage();
+        File localLangFile = new File(plugin.getDataFolder(), language + ".yml");
+        try {
+            YamlConfiguration yaml = new YamlConfiguration();
+            for (String key : map.keySet()) {
+                yaml.set(key, map.get(key));
             }
-        }
-        InputStream stream = plugin.getResource("lang/" + language + ".yml");
-        if (stream != null) {
-            ConfigurationSection section = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
-            loadLanguageSection(internalMap, section.getConfigurationSection("internal"), "internal.", false);
-        }
-        stream = plugin.getResource("lang/" + DEFAULT_LANGUAGE + ".yml");
-        if (stream != null) {
-            ConfigurationSection section = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
-            loadLanguageSection(internalMap, section.getConfigurationSection("internal"), "internal.", false);
+            yaml.save(localLangFile);
+        } catch (IOException ex) {
+            plugin.getLogger().warning("Cannot save language file: " + language + ".yml");
         }
     }
 
@@ -87,24 +103,6 @@ private void loadLanguageMap(JavaPlugin plugin, String language) {
             loadLanguageSection(map, YamlConfiguration.loadConfiguration(new InputStreamReader(stream)), "", true);
     }
 
-    private void saveLanguageMap(JavaPlugin plugin, String language) {
-        File localLangFile = new File(plugin.getDataFolder(), language + ".yml");
-        try {
-            YamlConfiguration yaml = new YamlConfiguration();
-            for (String key : map.keySet()) {
-                yaml.set(key, map.get(key));
-            }
-            if (plugin instanceof NyaaUtils) {  // save internal section if is NyaaUtils
-                for (String key : internalMap.keySet()) {
-                    yaml.set(key, internalMap.get(key));
-                }
-            }
-            yaml.save(localLangFile);
-        } catch (IOException ex) {
-            plugin.getLogger().warning("Cannot save language file: " + language + ".yml");
-        }
-    }
-
     /**
      * add all language items from section into language map recursively
      * existing items won't be overwritten
@@ -113,7 +111,7 @@ private void saveLanguageMap(JavaPlugin plugin, String language) {
      * @param prefix         used in recursion to determine the proper prefix
      * @param ignoreInternal ignore keys prefixed with `internal'
      */
-    private void loadLanguageSection(Map<String, String> map, ConfigurationSection section, String prefix, boolean ignoreInternal) {
+    private static void loadLanguageSection(Map<String, String> map, ConfigurationSection section, String prefix, boolean ignoreInternal, JavaPlugin plugin) {
         if (map == null || section == null || prefix == null) return;
         for (String key : section.getKeys(false)) {
             String path = prefix + key;
@@ -122,13 +120,49 @@ private void loadLanguageSection(Map<String, String> map, ConfigurationSection s
                     map.put(path, ChatColor.translateAlternateColorCodes('&', section.getString(key)));
                 }
             } else if (section.isConfigurationSection(key)) {
-                loadLanguageSection(map, section.getConfigurationSection(key), path + ".", ignoreInternal);
+                loadLanguageSection(map, section.getConfigurationSection(key), path + ".", ignoreInternal, plugin);
             } else {
-                getPlugin().getLogger().warning("Skipped language section: " + path);
+                plugin.getLogger().warning("Skipped language section: " + path);
             }
         }
     }
 
+    private void loadLanguageSection(Map<String, String> map, ConfigurationSection section, String prefix, boolean ignoreInternal) {
+        loadLanguageSection(map, section, prefix, ignoreInternal, getPlugin());
+    }
+
+
+    /**
+     * Load the internal map
+     * should only be called from {@link NyaaCoreLoader#onLoad()}
+     *
+     * @param plugin the NyaaCore plugin
+     */
+    static void loadInternalMap(NyaaCoreLoader plugin) {
+        loadInternalMap(plugin, DEFAULT_LANGUAGE);
+    }
+
+    private static void loadInternalMap(NyaaCoreLoader plugin, String language) {
+        internalMap.clear();
+        boolean forceJar = System.getProperty("nyaautils.i18n.loadFromDisk", "true").equals("false");
+        if (!forceJar) { // load from disk
+            File localLangFile = new File(plugin.getDataFolder(), language + ".yml");
+            if (localLangFile.exists()) {
+                ConfigurationSection section = YamlConfiguration.loadConfiguration(localLangFile);
+                loadLanguageSection(internalMap, section.getConfigurationSection("internal"), "internal.", false, plugin);
+            }
+        }
+        InputStream stream = plugin.getResource("lang/" + language + ".yml");
+        if (stream != null) {
+            ConfigurationSection section = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
+            loadLanguageSection(internalMap, section.getConfigurationSection("internal"), "internal.", false, plugin);
+        }
+        stream = plugin.getResource("lang/" + DEFAULT_LANGUAGE + ".yml");
+        if (stream != null) {
+            ConfigurationSection section = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
+            loadLanguageSection(internalMap, section.getConfigurationSection("internal"), "internal.", false, plugin);
+        }
+    }
 
     public String get(@LangKey String key, Object... para) {
         String val = map.get(key);
@@ -141,9 +175,9 @@ public String get(@LangKey String key, Object... para) {
             }
             return keyBuilder.toString();
         } else {
-            try{
+            try {
                 return String.format(val, para);
-            } catch (IllegalFormatConversionException e){
+            } catch (IllegalFormatConversionException e) {
                 e.printStackTrace();
                 getPlugin().getLogger().warning("Corrupted language key: " + key);
                 getPlugin().getLogger().warning("val: " + val);
@@ -161,9 +195,4 @@ public String get(@LangKey String key, Object... para) {
     public boolean hasKey(String key) {
         return map.containsKey(key) || internalMap.containsKey(key);
     }
-
-    public void reset() {
-        if (getPlugin() instanceof NyaaUtils) internalMap.clear();
-        map.clear();
-    }
 }