No commit activity in last 3 years
No release in over 3 years
Parse Git Remote URI into Useful object.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Git::Remote::Parser

Build Status

Usage

This gem can parse remote urls into Git::Remote::Parser::Result object:

> parser = Git::Remote::Parser.new
=> #<Git::Remote::Parser:0x007ffd5c0d4718>

> result = parser.parse "git@github.com:torvalds/linux.git"
=> #<Git::Remote::Parser::Result:0x007fb11b82fc70 @protocol=nil, @username="git", @host="github.com", @owner="torvalds", @repo="linux", @html_url="https://github.com/torvalds/linux">

> result.host
=> "github.com"

> result.owner
=> "torvalds"

> result.repo
=> "linux"

> result.html_url
=> "https://github.com/torvalds/linux"

> result.to_h
=> {:protocol=>nil, :username=>"git", :host=>"github.com", :owner=>"torvalds", :repo=>"linux", :html_url=>"https://github.com/torvalds/linux"}

Tested work for these Git providers:

  • GitHub

    Examples:

    • https://github.com/torvalds/linux.git
    • git@github.com:torvalds/linux.git
  • Gitlab

    Examples:

    • https://gitlab.com/gitlab-org/gitlab-ce.git
    • git@gitlab.com:gitlab-org/gitlab-ce.git
  • Bitbucket

    Examples:

    • https://JuanitoFatas@bitbucket.org/ged/ruby-pg
    • ssh://hg@bitbucket.org/ged/ruby-pg
    • and legacy host bitbucket.com

Installation

Add this line to your application's Gemfile:

gem 'git-remote-parser'

# or double quote if you prefer:

gem "git-remote-parser"

And then execute:

$ bundle

Or install it yourself as:

$ gem install git-remote-parser

Contributing

See CONTRIBUTING.md

License

The gem is available as open source under the terms of the MIT License.