Change group ID to 'org.qubitpi.athena' (#56)

QubitPi · Jan 12, 2024 · e9ab19d · e9ab19d
1 parent 098d72a
commit e9ab19d
Show file tree

Hide file tree

Showing 197 changed files with 1,570 additions and 1,544 deletions.
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -39,18 +39,18 @@ jobs:
       - uses: actionshub/markdownlint@main
         with:
           filesToIgnoreRegex: "docs/node_modules\\/.*"
-  markdown-link-check:
-    name: Markdown Link Check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: gaurav-nelson/github-action-markdown-link-check@v1
-        with:
-          use-verbose-mode: "yes"
+#  markdown-link-check:
+#    name: Markdown Link Check
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: actions/checkout@v3
+#      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+#        with:
+#          use-verbose-mode: "yes"
 
   tests:
     name: Unit & Integration Tests
-    needs: [yaml-lint, markdown-lint, markdown-link-check]
+    needs: [yaml-lint, markdown-lint]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

diff --git a/Athena-Project-intellij-code-style.xml b/Athena-Project-intellij-code-style.xml
@@ -9,7 +9,7 @@
       <emptyLine />
       <package name="" withSubpackages="true" static="true" />
       <emptyLine />
-      <package name="com.qubitpi" withSubpackages="true" static="false" />
+      <package name="org.qubitpi" withSubpackages="true" static="false" />
       <emptyLine />
       <package name="com" withSubpackages="true" static="false" />
       <emptyLine />
@@ -38,7 +38,7 @@
         <emptyLine />
         <package name="" withSubpackages="true" static="true" />
         <emptyLine />
-        <package name="com.qubitpi" withSubpackages="true" static="false" />
+        <package name="org.qubitpi" withSubpackages="true" static="false" />
         <emptyLine />
         <package name="com" withSubpackages="true" static="false" />
         <emptyLine />

diff --git a/athena-core/pom.xml b/athena-core/pom.xml
@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
 
     <parent>
-        <groupId>com.qubitpi.athena</groupId>
+        <groupId>org.qubitpi.athena</groupId>
         <artifactId>athena-parent-pom</artifactId>
         <version>1.0-SNAPSHOT</version>
     </parent>
@@ -26,7 +26,7 @@
     <dependencies>
         <!-- Local module dependencies -->
         <dependency>
-            <groupId>com.qubitpi.athena</groupId>
+            <groupId>org.qubitpi.athena</groupId>
             <artifactId>athena-system-config</artifactId>
         </dependency>
 

diff --git a/...na/application/AbstractBinderFactory.java → ...na/application/AbstractBinderFactory.java b/...na/application/AbstractBinderFactory.java → ...na/application/AbstractBinderFactory.java
@@ -13,17 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.application;
-
-import com.qubitpi.athena.config.SystemConfig;
-import com.qubitpi.athena.config.SystemConfigFactory;
-import com.qubitpi.athena.file.identifier.FileIdGenerator;
-import com.qubitpi.athena.file.identifier.FileNameAndUploadedTimeBasedIdGenerator;
-import com.qubitpi.athena.filestore.FileStore;
-import com.qubitpi.athena.metadata.MetaData;
-import com.qubitpi.athena.metastore.MetaStore;
-import com.qubitpi.athena.web.graphql.JacksonParser;
-import com.qubitpi.athena.web.graphql.JsonDocumentParser;
+package org.qubitpi.athena.application;
+
+import org.qubitpi.athena.config.SystemConfig;
+import org.qubitpi.athena.config.SystemConfigFactory;
+import org.qubitpi.athena.file.identifier.FileIdGenerator;
+import org.qubitpi.athena.file.identifier.FileNameAndUploadedTimeBasedIdGenerator;
+import org.qubitpi.athena.filestore.FileStore;
+import org.qubitpi.athena.metadata.MetaData;
+import org.qubitpi.athena.metastore.MetaStore;
+import org.qubitpi.athena.web.graphql.JacksonParser;
+import org.qubitpi.athena.web.graphql.JsonDocumentParser;
 
 import org.glassfish.hk2.api.TypeLiteral;
 import org.glassfish.hk2.utilities.Binder;

diff --git a/...tpi/athena/application/BinderFactory.java → ...tpi/athena/application/BinderFactory.java b/...tpi/athena/application/BinderFactory.java → ...tpi/athena/application/BinderFactory.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.application;
+package org.qubitpi.athena.application;
 
 import org.glassfish.hk2.utilities.Binder;
 

diff --git a/...pi/athena/application/ResourceConfig.java → ...pi/athena/application/ResourceConfig.java b/...pi/athena/application/ResourceConfig.java → ...pi/athena/application/ResourceConfig.java
@@ -13,11 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.application;
+package org.qubitpi.athena.application;
 
-import com.qubitpi.athena.config.ErrorMessageFormat;
-import com.qubitpi.athena.config.SystemConfig;
-import com.qubitpi.athena.config.SystemConfigFactory;
+import static org.qubitpi.athena.config.ErrorMessageFormat.CONFIG_NOT_FOUND;
+
+import org.qubitpi.athena.config.SystemConfig;
+import org.qubitpi.athena.config.SystemConfigFactory;
 
 import org.glassfish.hk2.utilities.Binder;
 import org.glassfish.jersey.media.multipart.MultiPartFeature;
@@ -37,16 +38,16 @@ public class ResourceConfig extends org.glassfish.jersey.server.ResourceConfig {
 
     private static final Logger LOG = LoggerFactory.getLogger(ResourceConfig.class);
 
-    private static final String ATHENA_ENDPOINT_PACKAGE = "com.qubitpi.athena.web.endpoints";
+    private static final String ATHENA_ENDPOINT_PACKAGE = "org.qubitpi.athena.web.endpoints";
 
     private static final String RESOURCE_BINDER_KEY = "resource_binder";
     private static final SystemConfig SYSTEM_CONFIG = SystemConfigFactory.getInstance();
 
     private final String bindingFactory = SYSTEM_CONFIG.getStringProperty(
             SYSTEM_CONFIG.getPackageVariableName(RESOURCE_BINDER_KEY)
     ).orElseThrow(() -> {
-        LOG.error(ErrorMessageFormat.CONFIG_NOT_FOUND.logFormat(RESOURCE_BINDER_KEY));
-        return new IllegalStateException(ErrorMessageFormat.CONFIG_NOT_FOUND.format());
+        LOG.error(CONFIG_NOT_FOUND.logFormat(RESOURCE_BINDER_KEY));
+        return new IllegalStateException(CONFIG_NOT_FOUND.format());
     });
 
     /**

diff --git a/...in/java/com/qubitpi/athena/file/File.java → ...in/java/org/qubitpi/athena/file/File.java b/...in/java/com/qubitpi/athena/file/File.java → ...in/java/org/qubitpi/athena/file/File.java
@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.file;
+package org.qubitpi.athena.file;
 
-import com.qubitpi.athena.metadata.MetaData;
+import org.qubitpi.athena.metadata.MetaData;
 
 import jakarta.validation.constraints.NotNull;
 import net.jcip.annotations.Immutable;

diff --git a/...hena/file/identifier/FileIdGenerator.java → ...hena/file/identifier/FileIdGenerator.java b/...hena/file/identifier/FileIdGenerator.java → ...hena/file/identifier/FileIdGenerator.java
@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.file.identifier;
+package org.qubitpi.athena.file.identifier;
 
-import com.qubitpi.athena.file.File;
+import org.qubitpi.athena.file.File;
 
 import java.util.function.Function;
 

diff --git a/...eNameAndUploadedTimeBasedIdGenerator.java → ...eNameAndUploadedTimeBasedIdGenerator.java b/...eNameAndUploadedTimeBasedIdGenerator.java → ...eNameAndUploadedTimeBasedIdGenerator.java
@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.file.identifier;
+package org.qubitpi.athena.file.identifier;
 
-import com.qubitpi.athena.file.File;
+import org.qubitpi.athena.file.File;
 
 import jakarta.validation.constraints.NotNull;
 import net.jcip.annotations.Immutable;

diff --git a/...m/qubitpi/athena/filestore/FileStore.java → ...g/qubitpi/athena/filestore/FileStore.java b/...m/qubitpi/athena/filestore/FileStore.java → ...g/qubitpi/athena/filestore/FileStore.java
@@ -13,10 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.filestore;
+package org.qubitpi.athena.filestore;
 
-import com.qubitpi.athena.file.File;
-import com.qubitpi.athena.metadata.MetaData;
+import org.qubitpi.athena.file.File;
+import org.qubitpi.athena.metadata.MetaData;
+
+import org.qubitpi.athena.metastore.MetaStore;
 
 import jakarta.validation.constraints.NotNull;
 import net.jcip.annotations.NotThreadSafe;
@@ -34,8 +36,8 @@ public interface FileStore {
      * Persists a file into object storage database.
      * <p>
      * Note that calling this method does NOT automatically update the managed metadata of this file in
-     * {@link com.qubitpi.athena.metastore.MetaStore}. The metadata must be saved separately using
-     * {@link com.qubitpi.athena.metastore.MetaStore#saveMetaData(String, MetaData)}.
+     * {@link MetaStore}. The metadata must be saved separately using
+     * {@link MetaStore#saveMetaData(String, MetaData)}.
      * <p>
      * The implementation does NOT have to be thread-safe. {@link FileStore} assumes that it is the callers'
      * responsibilities to implement the thread safety themselves.

diff --git a/...com/qubitpi/athena/metadata/FileType.java → ...org/qubitpi/athena/metadata/FileType.java b/...com/qubitpi/athena/metadata/FileType.java → ...org/qubitpi/athena/metadata/FileType.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.metadata;
+package org.qubitpi.athena.metadata;
 
 /**
  * The athena representations of the file extension.

diff --git a/...com/qubitpi/athena/metadata/MetaData.java → ...org/qubitpi/athena/metadata/MetaData.java b/...com/qubitpi/athena/metadata/MetaData.java → ...org/qubitpi/athena/metadata/MetaData.java
@@ -13,11 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.metadata;
+package org.qubitpi.athena.metadata;
 
-import static com.qubitpi.athena.config.ErrorMessageFormat.MISSING_MAP_KEY;
+import static org.qubitpi.athena.config.ErrorMessageFormat.MISSING_MAP_KEY;
 
 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
+import org.qubitpi.athena.file.File;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -31,7 +32,7 @@
 import java.util.Objects;
 
 /**
- * {@link MetaData} is provides information about {@link com.qubitpi.athena.file.File}, but not the content of the file.
+ * {@link MetaData} is provides information about {@link File}, but not the content of the file.
  * <p>
  * {@link MetaData} offers the ability to make uploaded metadata and metadata from GraphQL {@link ExecutionResult}
  * type-safe.

diff --git a/...m/qubitpi/athena/metastore/MetaStore.java → ...g/qubitpi/athena/metastore/MetaStore.java b/...m/qubitpi/athena/metastore/MetaStore.java → ...g/qubitpi/athena/metastore/MetaStore.java
@@ -13,10 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.metastore;
+package org.qubitpi.athena.metastore;
 
-import com.qubitpi.athena.file.File;
-import com.qubitpi.athena.metadata.MetaData;
+import org.qubitpi.athena.file.File;
+import org.qubitpi.athena.metadata.MetaData;
+
+import org.qubitpi.athena.filestore.FileStore;
 
 import graphql.ExecutionResult;
 import jakarta.validation.constraints.NotNull;
@@ -64,7 +66,7 @@ public interface MetaStore {
      * responsibilities to implement the thread safety themselves.
      *
      * @param fileId  The ID of the file that has already been uploaded to object storage. The value of the ID must be
-     * the return value of {@link com.qubitpi.athena.filestore.FileStore#upload(File)} so that the corresponding
+     * the return value of {@link FileStore#upload(File)} so that the corresponding
      * metadata can be retrieved later by calling {@link #getMetaData(String, List)}
      * @param metaData  The metadata object that is going to be saved into database
      *

diff --git a/...tpi/athena/web/endpoints/FileServlet.java → ...tpi/athena/web/endpoints/FileServlet.java b/...tpi/athena/web/endpoints/FileServlet.java → ...tpi/athena/web/endpoints/FileServlet.java
@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.web.endpoints;
+package org.qubitpi.athena.web.endpoints;
 
-import com.qubitpi.athena.file.File;
-import com.qubitpi.athena.filestore.FileStore;
-import com.qubitpi.athena.metadata.MetaData;
-import com.qubitpi.athena.metastore.MetaStore;
+import org.qubitpi.athena.file.File;
+import org.qubitpi.athena.filestore.FileStore;
+import org.qubitpi.athena.metadata.MetaData;
+import org.qubitpi.athena.metastore.MetaStore;
 
 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
 import org.glassfish.jersey.media.multipart.FormDataParam;

diff --git a/...tpi/athena/web/endpoints/MetaServlet.java → ...tpi/athena/web/endpoints/MetaServlet.java b/...tpi/athena/web/endpoints/MetaServlet.java → ...tpi/athena/web/endpoints/MetaServlet.java
@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.web.endpoints;
+package org.qubitpi.athena.web.endpoints;
 
-import static com.qubitpi.athena.config.ErrorMessageFormat.INVALID_GRAPHQL_REQUEST;
+import static org.qubitpi.athena.config.ErrorMessageFormat.INVALID_GRAPHQL_REQUEST;
 
-import com.qubitpi.athena.metastore.MetaStore;
-import com.qubitpi.athena.web.graphql.JsonDocumentParser;
+import org.qubitpi.athena.metastore.MetaStore;
+import org.qubitpi.athena.web.graphql.JsonDocumentParser;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

diff --git a/...tpi/athena/web/graphql/JacksonParser.java → ...tpi/athena/web/graphql/JacksonParser.java b/...tpi/athena/web/graphql/JacksonParser.java → ...tpi/athena/web/graphql/JacksonParser.java
@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.web.graphql;
+package org.qubitpi.athena.web.graphql;
 
-import static com.qubitpi.athena.config.ErrorMessageFormat.INVALID_GRAPHQL_REQUEST;
-import static com.qubitpi.athena.config.ErrorMessageFormat.JSON_DESERIALIZATION_ERROR;
+import static org.qubitpi.athena.config.ErrorMessageFormat.INVALID_GRAPHQL_REQUEST;
+import static org.qubitpi.athena.config.ErrorMessageFormat.JSON_DESERIALIZATION_ERROR;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.qubitpi.athena.metadata.MetaData;
+import org.qubitpi.athena.metadata.MetaData;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

diff --git a/...thena/web/graphql/JsonDocumentParser.java → ...thena/web/graphql/JsonDocumentParser.java b/...thena/web/graphql/JsonDocumentParser.java → ...thena/web/graphql/JsonDocumentParser.java
@@ -13,15 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.web.graphql;
+package org.qubitpi.athena.web.graphql;
+
+import org.qubitpi.athena.web.endpoints.MetaServlet;
 
 import jakarta.validation.constraints.NotNull;
 
 import java.util.Collections;
 import java.util.List;
 
 /**
- * {@link JsonDocumentParser} is used exclusively by {@link com.qubitpi.athena.web.endpoints.MetaServlet} and is
+ * {@link JsonDocumentParser} is used exclusively by {@link MetaServlet} and is
  * responsible for extracting metadata request info from POST request body, such as file ID and metadata fields that
  * client is asking for.
  * <p>

diff --git a/...lication/AbstractBinderFactorySpec.groovy → ...lication/AbstractBinderFactorySpec.groovy b/...lication/AbstractBinderFactorySpec.groovy → ...lication/AbstractBinderFactorySpec.groovy
@@ -13,19 +13,19 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.application
+package org.qubitpi.athena.application
 
-import com.qubitpi.athena.file.identifier.FileIdGenerator
-import com.qubitpi.athena.file.identifier.FileNameAndUploadedTimeBasedIdGenerator
-import com.qubitpi.athena.filestore.FileStore
-import com.qubitpi.athena.filestore.TestFileStore
-import com.qubitpi.athena.metastore.MetaStore
-import com.qubitpi.athena.metastore.TestMetaStore
-import com.qubitpi.athena.web.graphql.JacksonParser
-import com.qubitpi.athena.web.graphql.JsonDocumentParser
+import org.qubitpi.athena.file.identifier.FileIdGenerator
+import org.qubitpi.athena.file.identifier.FileNameAndUploadedTimeBasedIdGenerator
+import org.qubitpi.athena.filestore.FileStore
+import org.qubitpi.athena.metastore.MetaStore
+import org.qubitpi.athena.web.graphql.JacksonParser
+import org.qubitpi.athena.web.graphql.JsonDocumentParser
 
 import org.glassfish.hk2.api.DynamicConfiguration
 import org.glassfish.hk2.utilities.Binder
+import org.qubitpi.athena.filestore.TestFileStore
+import org.qubitpi.athena.metastore.TestMetaStore
 
 import graphql.schema.DataFetcher
 import spock.lang.Shared

diff --git a/...a/application/MockingBinderFactory.groovy → ...a/application/MockingBinderFactory.groovy b/...a/application/MockingBinderFactory.groovy → ...a/application/MockingBinderFactory.groovy
@@ -13,10 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.application
+package org.qubitpi.athena.application
 
-import static com.qubitpi.athena.application.ResourceConfigSpec.getBinder
-import static com.qubitpi.athena.application.ResourceConfigSpec.getClicker
+import static ResourceConfigSpec.getBinder
+import static ResourceConfigSpec.getClicker
 
 import org.glassfish.hk2.utilities.Binder
 

diff --git a/...ena/application/ResourceConfigSpec.groovy → ...ena/application/ResourceConfigSpec.groovy b/...ena/application/ResourceConfigSpec.groovy → ...ena/application/ResourceConfigSpec.groovy
@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.qubitpi.athena.application
+package org.qubitpi.athena.application
 
-import com.qubitpi.athena.config.SystemConfig
-import com.qubitpi.athena.config.SystemConfigFactory
 
 import org.glassfish.hk2.utilities.Binder
+import org.qubitpi.athena.config.SystemConfig
+import org.qubitpi.athena.config.SystemConfigFactory
 
 import spock.lang.Specification