https://github.com/rk0cc/jogu

A Java object which holding Git repository URL address
https://github.com/rk0cc/jogu

alternative-ssh git git-repository git-url https java maven maven-jo parser remote-repository repository ssh uri url

Last synced: about 5 hours ago
JSON representation

A Java object which holding Git repository URL address

• Host: GitHub
• URL: https://github.com/rk0cc/jogu
• Owner: rk0cc
• License: wtfpl
• Created: 2021-12-30T13:51:31.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-01T07:07:01.000Z (over 1 year ago)
• Last Synced: 2024-05-01T16:16:44.119Z (7 months ago)
• Topics: alternative-ssh, git, git-repository, git-url, https, java, maven, maven-jo, parser, remote-repository, repository, ssh, uri, url
• Language: Java
• Homepage:
• Size: 140 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Java Object of Git (Repository) URL - JOGU

[![Test](https://github.com/rk0cc/jogu/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/rk0cc/jogu/actions/workflows/test.yml)

[![CodeQL](https://github.com/rk0cc/jogu/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/rk0cc/jogu/actions/workflows/codeql.yml)

[![Maven Central](https://img.shields.io/maven-central/v/xyz.rk0cc.jogu/jogu.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22xyz.rk0cc.jogu%22%20AND%20a:%22jogu%22)

[![Official Javadoc](https://img.shields.io/badge/Official%20Javadoc-in%20osp.rk0cc.xyz-green)](https://osp.rk0cc.xyz/javadoc/jogu/jogu/1.1.0/)

[![Alternate Javadoc](https://javadoc.io/badge2/xyz.rk0cc.jogu/jogu/javadoc.svg)](https://javadoc.io/doc/xyz.rk0cc.jogu/jogu)

![GitHub Sponsors](https://img.shields.io/github/sponsors/rk0cc)

This Java library allows parsing Git repository URL addresses to an actual

object with validation included.

## Java provides URL and URI to handle these URL already, why create this package?

Yes, most Git repository URL can be parse URL or URI without issue. However, alternative form of SSH URL not.

Alternative SSH address is reference as "SSH" in public git repository which supposed to be invalid technically since it missed protocol and

not a port number after the colon. Thus, inheriting URL or URI is disallowed since they are marked as final class. As a result, create new object

which replicate how original URL or URI did with incompatable format supported.

## Supported protocol of Git repository URL

Most remote protocol are supported in this library.

| Protocol format name       |             Example             | Supported in this library |

|:---------------------------|:-------------------------------:|:-------------------------:|

| HTTPS protocol             |  `https://example.com/foo.git`  |    :white_check_mark:     |

| Git protocol               |   `git://example.com/foo.git`   |    :white_check_mark:     |

| SSH protocol (Legit)       | `ssh://[email protected]/foo.git` |    :white_check_mark:     |

| SSH protocol (Alternative) |    `[email protected]:foo.git`    |    :white_check_mark:     |

| File protocol              |    `file:///path/to/foo.git`    |            :x:            |

Jogu does not support file protocol since it rarely uses and worthless when making actual request under local directory.

## Install

Using Maven 3:

```xml

    

        xyz.rk0cc.jogu

        jogu

        1.1.2

    

```

## Usage

Get `GitRepositoryURL` without specific implemented type uses:

```java

GitRepositoryURL gurl = GitRepositoryURL.parse("git://example.com/foo.git");

```

Get `GitRepositoryURL` with specific implemented type uses:

```java

GitGitRepositoryURL gurl = GitRepositoryURL.parse("git://example.com/foo.git", GitGitRepositoryURL.class);

```

## Setup

* JDK 17 (or above)

* Maven

## License

WTFPL 2.0