GitCloneUrl
Easy to parse git repository-ish url.
- Parse by URI.parse
git://github.com/schacon/ticgit.githttps://github.com/schacon/ticgit.git
- Parse by URI::SshGit
[email protected]:schacon/ticgit.git
require 'git_clone_url'
git_url = 'git://github.com/schacon/ticgit.git'
ssh_url = '[email protected]:schacon/ticgit.git'
https_url = 'https://github.com/schacon/ticgit.git'
https_url_with_userinfo = 'https://user:[email protected]/schacon/ticgit.git'
GitCloneUrl.parse(git_url)
#=> #<URI::Generic git://github.com/schacon/ticgit.git>
#=> {scheme: 'git', host: 'github.com', path: '/schacon/ticgit.git' }
GitCloneUrl.parse(ssh_url)
#=> #<URI::SshGit::Generic [email protected]:schacon/ticgit.git>
#=> {scheme: nil, user: 'git', userinfo: 'git', host: 'github.com', path: 'schacon/ticgit.git' }
GitCloneUrl.parse(https_url)
#=> #<URI::HTTPS https://github.com/schacon/ticgit.git>
#=> {scheme: 'https', host: 'github.com', path: '/schacon/ticgit.git'}
GitCloneUrl.parse(https_url_with_userinfo)
#=> #<URI::HTTPS https://user:[email protected]/schacon/ticgit.git>
#=> {scheme: 'https', userinfo: 'user:pass', user: 'user', password: 'pass',
# host: 'github.com', path: '/schacon/ticgit.git'}
Motivation
URI.parse and Addressable::URI.parse
can parse https protocol, git protocol and ssh protocol(ssh://[email protected]...),
but they can not parse [email protected]:foo/bar.git pattern of ssh protocol.
# URI
url = URI.parse('[email protected]:schacon/ticgit.git')
URI::InvalidURIError: bad URI(is not URI?): [email protected]:schacon/ticgit.git
# Addressable
url = Addressable::URI.parse('[email protected]:schacon/ticgit.git')
#=> #<Addressable::URI:0x3fedf48fb430 URI:[email protected]:schacon/ticgit.git>
url.path #=> "schacon/ticgit.git"
url.scheme #=> "[email protected]"
url.host #=> nil
url.userinfo #=> nil
url.user #=> nil
url.port #=> nil
API
GitCloneUrl.parse(git_url) -> URI::*
Return URI namespaced object.
E.g. URI::Generic, URI::HTTPS and URI::SshGit::Generic.
See: class URI::Generic, class URI::HTTPS and URI::SshGit.
git_url
Required
Type: string
Git repository-ish url.
Installation
Add this line to your application's Gemfile:
gem 'git_clone_url'
And then execute:
$ bundle
Or install it yourself as:
$ gem install git_clone_url
Development
After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
- Fork it ( https://github.com/packsaddle/ruby-git_clone_url/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request