Class: Git::GitAltURI

Inherits:
Addressable::URI
  • Object
show all
Defined in:
lib/git/url.rb

Overview

The URI for git's alternative scp-like syntax

This class is necessary to ensure that #to_s returns the same string that was passed to the initializer.

Instance Method Summary collapse

Constructor Details

#initialize(user:, host:, path:) ⇒ GitAltURI

Create a new GitAltURI object

Examples:

uri = Git::GitAltURI.new(user: 'james', host: 'github.com', path: 'james/ruby-git')
uri.to_s #=> '[email protected]/james/ruby-git'

Parameters:

  • user (String, nil) —

    the user from the URL or nil

  • host (String) —

    the host from the URL

  • path (String) —

    the path from the URL



96
97
98
 
# File 'lib/git/url.rb', line 96

def initialize(user:, host:, path:)
  super(scheme: 'git-alt', user: user, host: host, path: path)
end

Instance Method Details

#to_s ⇒ String

Convert the URI to a String

Addressible::URI forces path to be absolute by prepending a '/' to the path. This method removes the '/' when converting back to a string since that is what is expected by git. The following is a valid git URL:

[email protected]:ruby-git/ruby-git.git

and the following (with the initial '/'' in the path) is NOT a valid git URL:

[email protected]:/ruby-git/ruby-git.git

Examples:

uri = Git::GitAltURI.new(user: 'james', host: 'github.com', path: 'james/ruby-git')
uri.path #=> '/james/ruby-git'
uri.to_s #=> '[email protected]:james/ruby-git'

Returns:

  • (String) —

    the URI as a String



119
120
121
122
123
124
125
 
# File 'lib/git/url.rb', line 119

def to_s
  if user
    "#{user}@#{host}:#{path[1..-1]}"
  else
    "#{host}:#{path[1..-1]}"
  end
end