Skip to content

refactor(spring-keycloak-example): reorganize package structure for c… #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igorcampos-dev merged 1 commit into from
Aug 17, 2025
Merged

refactor(spring-keycloak-example): reorganize package structure for c… #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion spring-keycloak-example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Includes a minimal setup for running a Spring Boot application secured by Keyclo

- **Port:** `8083`

- **Spring Profile:** `OIDC`
- **Spring Profile:** `OIDC` (this profile active module 'oidcAuth')
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Aug 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix grammar/clarity for the OIDC profile note

Current phrasing is awkward and spacing around the bullet list becomes inconsistent. Tighten the sentence and keep it minimal.

Apply this diff:

-- **Spring Profile:** `OIDC` (this profile active module 'oidcAuth')
+- **Spring Profile:** `OIDC` (activates module `oidcAuth`)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Spring Profile:** `OIDC` (this profile active module 'oidcAuth')
- **Spring Profile:** `OIDC` (activates module `oidcAuth`)
🧰 Tools
🪛 LanguageTool

[grammar] ~28-~28: Make sure you are using the right part of speech
Context: ...Spring Profile:* OIDC (this profile active module 'oidcAuth') - **Backup keycloak...

(QB_NEW_EN_OTHER_ERROR_IDS_21)

[grammar] ~28-~28: Use correct spacing
Context: ... (this profile active module 'oidcAuth') - Backup keycloak: `oidc_auth_db_backup....

(QB_NEW_EN_OTHER_ERROR_IDS_5)


- **Backup keycloak:** `oidc_auth_db_backup.sql`

Expand Down
2 changes: 1 addition & 1 deletion ...io/example/config/OIDCSecurityConfig.java → ...e/oidcAuth/config/OIDCSecurityConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.io.example.config;
package com.io.example.oidcAuth.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
Expand Down
2 changes: 1 addition & 1 deletion ...xample/controller/OIDCHomeController.java → ...dcAuth/controller/OIDCHomeController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.io.example.controller;
package com.io.example.oidcAuth.controller;
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Aug 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Avoid mixed-case package segments; prefer all-lowercase

oidcAuth breaks common Java package naming conventions and can surprise tooling/IDEs and case-sensitive filesystems. Recommend renaming to all-lowercase (e.g., oidcauth).

Apply this diff here (and mirror the rename across the oidcAuth packages/directories):

-package com.io.example.oidcAuth.controller;
+package com.io.example.oidcauth.controller;

Note: This requires updating the directory name and adjusting imports/package lines for classes under com.io.example.oidcAuth.*.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
package com.io.example.oidcAuth.controller;
package com.io.example.oidcauth.controller;
🤖 Prompt for AI Agents 
In
spring-keycloak-example/src/main/java/com/io/example/oidcAuth/controller/OIDCHomeController.java
around line 1, the package segment `oidcAuth` uses mixed case which violates
Java package naming conventions; rename the package segment to all-lowercase
(e.g., `oidcauth`) and propagate that change across the project: rename the
directory `oidcAuth` to `oidcauth`, update the `package` declaration in this
file and every other file under `com.io.example.oidcAuth.*`, fix all imports and
fully-qualified references, update any resource paths, build files (pom/gradle),
tests, and configuration (e.g., Spring component scans) accordingly, and perform
the renames with git mv or IDE refactor to preserve history and then run a full
build/tests to verify.


import org.springframework.context.annotation.Profile;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
Expand Down
2 changes: 1 addition & 1 deletion ...example/config/DefaultSecurityConfig.java → ...tandard/config/DefaultSecurityConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.io.example.config;
package com.io.example.standard.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
Expand Down
2 changes: 1 addition & 1 deletion ...ple/controller/DefaultHomeController.java → ...ard/controller/DefaultHomeController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.io.example.controller;
package com.io.example.standard.controller;

import org.springframework.context.annotation.Profile;
import org.springframework.web.bind.annotation.GetMapping;
Expand Down