Class: Octokit::Repository

Relationships & Source Files
Inherits:	Object
Defined in:	lib/octokit/repository.rb

Overview

Class to parse GitHub repository owner and name from URLs and to generate URLs

Constant Summary

ABS_URI_REGEXP =

Ruby 3.4+

# File 'lib/octokit/repository.rb', line 84

if URI.const_defined?(:RFC2396_PARSER) # Ruby 3.4+
  URI::RFC2396_PARSER.regexp.fetch(:ABS_URI)
else
  URI::RFC2396_Parser.new.regexp.fetch(:ABS_URI)
end

NAME_WITH_OWNER_PATTERN =
# File 'lib/octokit/repository.rb', line 9
```
%r{\A[\w.-]+/[\w.-]+\z}i.freeze
```

Class Method Summary

.from_url(url) ⇒ Repository

Instantiate from a GitHub repository URL.
.new(repo) ⇒ Repository constructor
.path(repo) ⇒ String

Get the api path for a repo.

Instance Attribute Summary

#id rw
#name (also: #repo) rw
#owner (also: #user, #username) rw
#repo readonly

Alias for #name.
#user readonly

Alias for #owner.
#username readonly

Alias for #owner.

Instance Method Summary

#id_api_path ⇒ String
#named_api_path ⇒ String
#path ⇒ String
#slug ⇒ String (also: #to_s)

Repository owner/name.
#to_s

Alias for #slug.
#url ⇒ String

Repository URL based on Octokit::Client#web_endpoint
#raise_invalid_repository!(repo) private
#validate_owner_and_name!(repo) private

Constructor Details

.new(repo) ⇒ `Repository`

Raises:

(Octokit::InvalidRepository) —
if the repository has an invalid format

[ GitHub ]

# File 'lib/octokit/repository.rb', line 23


def initialize(repo)
  case repo
  when Integer
    @id = repo
  when NAME_WITH_OWNER_PATTERN
    @owner, @name = repo.split('/')
  when Repository
    @owner = repo.owner
    @name = repo.name
  when Hash
    @name = repo[:repo] || repo[:name]
    @owner = repo[:owner] || repo[:user] || repo[:username]
  else
    raise_invalid_repository!(repo)
  end
  validate_owner_and_name!(repo) if @owner && @name
end

Class Method Details

.from_url(url) ⇒ `Repository`

Instantiate from a GitHub repository URL

[ GitHub ]

# File 'lib/octokit/repository.rb', line 14


def self.from_url(url)
  new URI.parse(url).path[1..]
         .gsub(%r{^repos/}, '')
         .split('/', 3)[0..1]
         .join('/')
end

.path(repo) ⇒ `String`

Get the api path for a repo

Parameters:

repo (Integer, String, Hash, Repository) —
A GitHub repository.

Returns:

(String) —
Api path.

[ GitHub ]

# File 'lib/octokit/repository.rb', line 58


def self.path(repo)
  new(repo).path
end

Instance Attribute Details

#id (rw)

[ GitHub ]

# File 'lib/octokit/repository.rb', line 7


attr_accessor :owner, :name, :id

#name (rw) Also known as: #repo

[ GitHub ]

# File 'lib/octokit/repository.rb', line 7


attr_accessor :owner, :name, :id

#owner (rw) Also known as: #user, #username

[ GitHub ]

# File 'lib/octokit/repository.rb', line 7


attr_accessor :owner, :name, :id

#repo (readonly)

Alias for #name.

[ GitHub ]

# File 'lib/octokit/repository.rb', line 80


alias repo name

#user (readonly)

Alias for #owner.

[ GitHub ]

# File 'lib/octokit/repository.rb', line 78


alias user owner

#username (readonly)

Alias for #owner.

[ GitHub ]

# File 'lib/octokit/repository.rb', line 79


alias username owner

Instance Method Details

#id_api_path ⇒ `String`

Returns:

(String) —
Api path for id identified repos

[ GitHub ]

# File 'lib/octokit/repository.rb', line 68


def id_api_path
  "repositories/#{@id}"
end

#named_api_path ⇒ `String`

Returns:

(String) —
Api path for owner/name identified repos

[ GitHub ]

# File 'lib/octokit/repository.rb', line 63


def named_api_path
  "repos/#{slug}"
end

#path ⇒ `String`

Returns:

(String) —
Repository API path

[ GitHub ]

# File 'lib/octokit/repository.rb', line 49


def path
  return named_api_path if @owner && @name

  id_api_path if @id
end

#raise_invalid_repository!(repo) (private)

Raises:

(Octokit::InvalidRepository)

[ GitHub ]

# File 'lib/octokit/repository.rb', line 96


def raise_invalid_repository!(repo)
  msg = "#{repo.inspect} is invalid as a repository identifier. " \
        'Use the user/repo (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys.'
  raise Octokit::InvalidRepository, msg
end

#slug ⇒ `String` Also known as: #to_s

Repository owner/name

[ GitHub ]

# File 'lib/octokit/repository.rb', line 43


def slug
  "#{@owner}/#{@name}"
end

#to_s

Alias for #slug.

[ GitHub ]

# File 'lib/octokit/repository.rb', line 46


alias to_s slug

#url ⇒ `String`

Repository URL based on Octokit::Client#web_endpoint

[ GitHub ]

# File 'lib/octokit/repository.rb', line 74


def url
  "#{Octokit.web_endpoint}#{slug}"
end

#validate_owner_and_name!(repo) (private)

[ GitHub ]

# File 'lib/octokit/repository.rb', line 90


def validate_owner_and_name!(repo)
  if @owner.include?('/') || @name.include?('/') || !url.match?(ABS_URI_REGEXP)
    raise_invalid_repository!(repo)
  end
end

Class: Octokit::Repository

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(repo) ⇒ Repository

Class Method Details

.from_url(url) ⇒ Repository

.path(repo) ⇒ String

Instance Attribute Details

#id (rw)

#name (rw) Also known as: #repo

#owner (rw) Also known as: #user, #username

#repo (readonly)

#user (readonly)

#username (readonly)

Instance Method Details

#id_api_path ⇒ String

#named_api_path ⇒ String

#path ⇒ String

#raise_invalid_repository!(repo) (private)

#slug ⇒ String Also known as: #to_s

#to_s

#url ⇒ String

#validate_owner_and_name!(repo) (private)

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

.new(repo) ⇒ `Repository`

.from_url(url) ⇒ `Repository`

.path(repo) ⇒ `String`

#id_api_path ⇒ `String`

#named_api_path ⇒ `String`

#path ⇒ `String`

#slug ⇒ `String` Also known as: #to_s

#url ⇒ `String`