Skip to content

Commit

Permalink
Enhance maintainability by using dynamic package name (#196)
Browse files Browse the repository at this point in the history
  • Loading branch information
QubitPi authored Jan 22, 2025
1 parent f9e040e commit 51857ad
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 7 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ https://uel.java.net/
https://www.openapis.org/
https://jcp.org/*
http://localhost:8080/*
https://github.com/QubitPi/fast-ws/blob/master/FastWS-Project-intellij-code-style.xml
https://*/ci-cd.yaml
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ FastWS
======

![Java Version Badge][Java Version Badge]
[![GitHub Workflow Status][GitHub Workflow Status]](https://github.com/QubitPi/fast-ws/actions/workflows/ci-cd.yml)
[![GitHub Workflow Status][GitHub Workflow Status]](https://github.com/QubitPi/fast-ws/actions/workflows/ci-cd.yaml)
[![Apache License Badge]][Apache License, Version 2.0]

__FastWS__ is a [JSR 370] webservice template that lets us spin up Java webservice quickly through [GitHub templates].
Expand Down Expand Up @@ -69,7 +69,7 @@ The use and distribution terms for [fast-ws]() are covered by the [Apache Licens
[Documentation]: https://fastws.qubitpi.org/

[GitHub templates]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository#about-template-repositories
[GitHub Workflow Status]: https://img.shields.io/github/actions/workflow/status/QubitPi/fast-ws/ci-cd.yml?branch=master&logo=github&style=for-the-badge
[GitHub Workflow Status]: https://img.shields.io/github/actions/workflow/status/QubitPi/fast-ws/ci-cd.yaml?branch=master&logo=github&style=for-the-badge

[Java Version Badge]: https://img.shields.io/badge/Java-17-brightgreen?style=for-the-badge&logo=OpenJDK&logoColor=white
[fast-ws]: https://fastws.qubitpi.org/
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ service.

#### Docusaurus Blogs Relative Linking is Treated False-Negative by CI Markdown Link check

[CI check for Markdown link](../.github/workflows/ci-cd.yml) (`markdown-link-check`) is turned on and it's not smart
[CI check for Markdown link](../.github/workflows/ci-cd.yaml) (`markdown-link-check`) is turned on and it's not smart
enough to detect relative linking by Docusaurus. The workaround is to disable the link check at the relevant line. For
example:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ If tabs still come out at 2 spaces when hitting TAB or Enter, not 4 spaces, try:
("Settings | Editor | Code Style") have priority (will overwrite) over your IDE settings.

[Docker]: https://github.com/QubitPi/fast-ws/blob/master/Dockerfile
[Docker-based integration tests]: https://github.com/QubitPi/fast-ws/blob/master/src/test/groovy/com/qubitpi/ws/jersey/template/DockerITSpec.groovy
[Docker-based integration tests]: https://github.com/QubitPi/fast-ws/blob/master/src/test/groovy/com/qubitpi/fastws/DockerITSpec.groovy

[jcabi-mysql]: https://mysql.jcabi.com/
[fast-ws Dockerfile]: https://github.com/QubitPi/fast-ws/blob/master/Dockerfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package com.qubitpi.fastws.application;

import com.qubitpi.fastws.web.endpoints.DataServlet;
import com.qubitpi.fastws.web.filters.CorsFilter;

import org.glassfish.hk2.utilities.Binder;
Expand All @@ -32,7 +33,7 @@
@ApplicationPath("v1")
public class ResourceConfig extends org.glassfish.jersey.server.ResourceConfig {

private static final String ENDPOINT_PACKAGE = "com.qubitpi.fastws.web.endpoints";
private static final String ENDPOINT_PACKAGE = DataServlet.class.getPackage().getName();

/**
* DI Constructor that allows for finer dependency injection control.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
*/
package com.qubitpi.fastws

import com.qubitpi.fastws.resource.TestEndpoint

import org.eclipse.jetty.server.Server
import org.glassfish.jersey.server.ResourceConfig

Expand All @@ -26,7 +28,7 @@ import spock.lang.Specification
class JettyServerFactorySpec extends Specification {

static final int PORT = 8080
static final String ENDPOINT_RESOURCE_PACKAGE = "com.qubitpi.fastws.resource"
static final String ENDPOINT_RESOURCE_PACKAGE = TestEndpoint.class.getPackage().getName()

/**
* DI constructor.
Expand Down

0 comments on commit 51857ad

Please sign in to comment.