Class: QB::Package

Inherits:

Util::Resource

• Object
• NRSER::Meta::Props::Base
• Util::Resource
• QB::Package

Defined in:

lib/qb/package.rb,
lib/qb/package/version.rb

Overview

Common properties and methods of package resources, aimed at packages represented as directories in projects.

Direct Known Subclasses

Gem

Defined Under Namespace

Classes: Gem, Version

Instance Attribute Summary

• #name ⇒ String readonly

  The string name the package goes by.

• #ref_path ⇒ String | Pathname^? readonly

  User-provided path value used to construct the resource instance, if any.

• #root_path ⇒ Pathname readonly

  Absolute path to the gem's root directory.

• #version ⇒ QB::Package::Version readonly

  Version of the package.

Instance Attribute Details

#name ⇒ String (readonly)

The string name the package goes by.

Returns:

• (String) —

  Non-empty string.

# File 'lib/qb/package.rb', line 92

prop  :name, type: t.non_empty_str

#ref_path ⇒ String | Pathname^? (readonly)

User-provided path value used to construct the resource instance, if any.

This may not be the same as a root path for the resource, such as with resource classes that can be constructed from any path inside the directory, like a Repo::Git.

Returns:

• (String | Pathname) —

  If the resource instance was constructed based on a path argument.

• (nil) —

  If the resource instance was not constructed based on a path argument.

# File 'lib/qb/package.rb', line 67

prop  :ref_path, type: t.maybe( t.dir_path )

#root_path ⇒ Pathname (readonly)

Absolute path to the gem's root directory.

Returns:

• (Pathname)

# File 'lib/qb/package.rb', line 75

prop  :root_path, type: t.dir_path

#version ⇒ QB::Package::Version (readonly)

Version of the package.

Returns:

• (QB::Package::Version)

# File 'lib/qb/package.rb', line 83

prop  :version, type: QB::Package::Version