Merge remote-tracking branch 'origin/master'

Author: JanHolger

README.md

@@ -3,6 +3,14 @@
 JWS Object Relational Mapping
 </p>
 
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/JavaWebStack/ORM/Maven%20Deploy/master)
+![GitHub](https://img.shields.io/github/license/JavaWebStack/ORM)
+![Maven metadata URL](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.javawebstack.org%2Forg%2Fjavawebstack%2FORM%2Fmaven-metadata.xml)
+![GitHub contributors](https://img.shields.io/github/contributors/JavaWebStack/ORM)
+![Lines of code](https://img.shields.io/tokei/lines/github/JavaWebStack/ORM)
+![Discord](https://img.shields.io/discord/815612319378833408?color=%237289DA&label=discord)
+![Twitter Follow](https://img.shields.io/twitter/follow/JavaWebStack?style=social) 
+
 ## Introduction
 When it came to using an ORM Lib in java I used ORMLite before. It worked quite well, but I didn't like the query builder.
 
@@ -11,7 +19,7 @@ Another thing was that I wanted to have control over the JDBC Wrapper to have a
 I finally decided to make an own ORM that fits my needs and here it is.
 
 ## Documentation
-Docs for version 2 will follow as soon as version 2 is fully stable.
+You can find the current docs on our [website](https://docs.javawebstack.org/framework/orm). This is a work-in-progress project though so it's not yet complete.
 
 ### Example usage 
 

pom.xml

@@ -53,6 +53,11 @@
             <version>8.0.22</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.atteo</groupId>
+            <artifactId>evo-inflector</artifactId>
+            <version>1.2.2</version>
+        </dependency>
         <dependency>
             <groupId>org.reflections</groupId>
             <artifactId>reflections</artifactId>

src/main/java/org/javawebstack/orm/TableInfo.java

@@ -1,5 +1,6 @@
 package org.javawebstack.orm;
 
+import org.atteo.evo.inflector.English;
 import org.javawebstack.orm.annotation.*;
 import org.javawebstack.orm.exception.ORMConfigurationException;
 import org.javawebstack.orm.util.Helper;
@@ -45,10 +46,7 @@ public TableInfo(Class<? extends Model> model, ORMConfig config) throws ORMConfi
             Table table = model.getDeclaredAnnotationsByType(Table.class)[0];
             tableName = table.value();
         } else {
-            tableName = Helper.toSnakeCase(model.getSimpleName());
-            tableName += tableName.endsWith("ss") ? "es" : "s";
-            if (tableName.endsWith("ys"))
-                tableName = tableName.substring(0, tableName.length() - 2) + "ies";
+            tableName = Helper.toSnakeCase(English.plural(model.getSimpleName()));
         }
         if (model.isAnnotationPresent(MorphType.class)) {
             morphType = model.getDeclaredAnnotationsByType(MorphType.class)[0].value();

src/test/java/org/javawebstack/orm/test/automigrate/DefaultSizeTest.java

@@ -56,7 +56,7 @@ public class DefaultSizeTest extends ORMTestCase {
     final static String columnNameString = "string";
 
     // Not renaming the table name as this is not focus of the test
-    final static String tableNameCharArray = "just_char_arraies";
+    final static String tableNameCharArray = "just_char_arrays";
     final static String columnNameCharArray = "char_array";
 
     final static String tableNameDatatype = "datatypes";

src/test/java/org/javawebstack/orm/test/querybuilding/FromClauseTest.java

@@ -0,0 +1,74 @@
+package org.javawebstack.orm.test.querybuilding;
+
+import org.atteo.evo.inflector.English;
+import org.javawebstack.orm.Model;
+import org.javawebstack.orm.ORM;
+import org.javawebstack.orm.Repo;
+import org.javawebstack.orm.exception.ORMConfigurationException;
+import org.javawebstack.orm.test.ORMTestCase;
+import org.javawebstack.orm.test.shared.models.tablenames.*;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+/**
+ * The focus does not lie on a correct plural with this test, therefore we are only testing it sample-wise.
+ * For tests see the library that is used in TableInfo: https://github.com/atteo/evo-inflector
+ */
+class FromClauseTest extends ORMTestCase {
+
+    @Test
+    void testOneWordSAppendixPlural() throws ORMConfigurationException {
+        String query = getBaseQuery(Word.class);
+        assertTrue(query.contains("FROM `words`"));
+    }
+
+    @Test
+    void testTwoWordsBecomeSnakeCases() throws ORMConfigurationException {
+        String query = getBaseQuery(TwoWord.class);
+        assertTrue(query.contains("FROM `two_words`"));
+    }
+
+    @Test
+    void testThreeWordBecomeSnakeCases() throws ORMConfigurationException {
+        String query = getBaseQuery(ThreeWordClass.class);
+        assertTrue(query.contains("FROM `three_word_classes`"));
+    }
+
+    @Test
+    void testIrregularWordPlural() throws ORMConfigurationException {
+        String query = getBaseQuery(Mouse.class);
+        assertTrue(query.contains("FROM `mice`"));
+    }
+
+    /*
+     * Error / Not Closer Specified Cases
+     */
+    @Test
+    void testOneWordAlreadyInPluralDoesntWork() throws ORMConfigurationException {
+        String query = getBaseQuery(Words.class);
+        // Should try to find a non-sense plural and not map to itself as plural; for the purpose of
+        // not breaking existing code
+        assertFalse(query.contains("FROM `words`"));
+    }
+
+    @Test
+    void testOverwrittenTableName() throws ORMConfigurationException {
+        String query = getBaseQuery(OverwritteTableName.class);
+        assertTrue(query.contains("FROM `oVer_writtenValue`"));
+    }
+
+    /*
+     * Boiler Code Reduction Funtions
+     */
+
+    /**
+     * Gets the generated base query for a model when only calling .query() on it.
+     * @return
+     */
+    private String getBaseQuery(Class<? extends Model> clazz) throws ORMConfigurationException {
+        ORM.register(clazz, sql());
+        return Repo.get(clazz).query().getQueryString().getQuery();
+    }
+}

src/test/java/org/javawebstack/orm/test/querybuilding/GeneralRemark.md

@@ -0,0 +1,3 @@
+# General Remark About The Methodology used
+In the encapsulation via ´´ will be assumed. If this quotation is removed the SQL query can behave differently, which is why it must be a stable aspect.
+Also they are required to use reserved keyword.

src/test/java/org/javawebstack/orm/test/shared/models/OnlyIdModel.java

@@ -0,0 +1,12 @@
+package org.javawebstack.orm.test.shared.models.tablenames;
+
+import org.javawebstack.orm.Model;
+import org.javawebstack.orm.annotation.Column;
+
+/**
+ * This class' name has an irregular plural (mice) and is here for this purpose.
+ */
+public class Mouse extends Model {
+    @Column
+    int id;
+}

src/test/java/org/javawebstack/orm/test/shared/models/tablenames/Mouse.java

@@ -0,0 +1,14 @@
+package org.javawebstack.orm.test.shared.models.tablenames;
+
+import org.javawebstack.orm.Model;
+import org.javawebstack.orm.annotation.Column;
+import org.javawebstack.orm.annotation.Table;
+
+/**
+ * This class overwrites the model name to a seemingly random word to test multiple cases at once.
+ */
+@Table("oVer_writtenValue")
+public class OverwritteTableName extends Model {
+    @Column
+    int id;
+}

src/test/java/org/javawebstack/orm/test/shared/models/tablenames/OverwritteTableName.java

@@ -0,0 +1,10 @@
+# Purposes of classes in this package
+
+These classes are designed to cover different that can occur with the table names. For example - but not limited to:
+
+- class with a single word name
+- class with irregular plural
+- class with an already plural name
+
+
+Since the focus is on their name they will usually only contain the - to date - required id field.