packageurl-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e48cdeff19115a2dbca64c93e81d7cd4de3a45946927157eeba40388de8ec04f
+  data.tar.gz: e94e269df648bade8528f547cfaca06c7e29d8fa23b9f318122d313665da796f
+SHA512:
+  metadata.gz: 92f391f396e54dd47e408cac234d5e4982d5ec91418d0ddb1198d07bc7d58cbea59e7323221f973f54bed72ce78e351c861bdd075ff83940d17cb5290da68fc3
+  data.tar.gz: 4d8e28fbfad4fed559ac1592ba5dc1d38b76f653508409b209b9febd03b5927bef281a36aa830945971bc75eb49a2cf1bc2e45ec2413c2b5444bb8e2f0eca446

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "3.0"]
+
+    env:
+      RUBYOPT: "-W:no-experimental"
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec
+      - name: Perform type check
+        run: bundle exec steep check
+      - name: Lint
+        run: bundle exec rubocop
+      - name: Check documentation coverage
+        run: bundle exec yard stats --list-undoc

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.vscode/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 500
+Metrics/MethodLength:
+  Max: 100
+Metrics/ParameterLists:
+  Max: 7
+Metrics/PerceivedComplexity:
+  Max: 15
+Style/ConditionalAssignment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v0.0.1] - 2021-12-09
+
+Initial release.
+
+[unreleased]: https://github.com/package-url/packageurl-ruby/releases/tag/v0.1.0...main
+[v0.1.0]: https://github.com/package-url/packageurl-ruby/releases/tag/v0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler', '~> 2.0'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.23.0'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.6.0'
+gem 'steep', '~> 0.46.0'
+gem 'yard', '~> 0.9.0'

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    packageurl-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    ffi (1.15.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (1.7.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    steep (0.46.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 1.2.0)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    yard (0.9.26)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  packageurl-ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.23.0)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.6.0)
+  steep (~> 0.46.0)
+  yard (~> 0.9.0)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -0,0 +1,67 @@
+# packageurl-ruby
+
+![CI][ci badge]
+
+A Ruby implementation of the [package url specification][purl-spec].
+
+## Requirements
+
+- Ruby 2.7+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'packageurl-ruby'
+```
+
+And then execute:
+
+```console
+$ bundle install
+```
+
+Or install it yourself as:
+
+```console
+$ gem install packageurl-ruby
+```
+
+## Usage
+
+```ruby
+require 'packageurl-ruby'
+
+purl = PackageURL.parse("pkg:gem/rails@6.1.4")
+purl.type # "gem"
+purl.name # "rails"
+purl.version # "6.1.4"
+
+# supports pattern matching with hashes and arrays
+case purl
+in type: 'gem', name: 'rails'
+  puts 'Yay! You’re on Rails!'
+in ['pkg', 'gem', *]
+  puts '🦊🗯 "Ruby is easy to read"'
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `rake spec` to run the tests. 
+You can also 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`, 
+which will create a git tag for the version, 
+push git commits and the created tag, 
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+[ci badge]: https://github.com/mattt/packageurl-ruby/workflows/CI/badge.svg
+[purl-spec]: https://github.com/package-url/purl-spec

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :steep do
+  task :check do
+    system 'steep check'
+  end
+end
+
+task default: %i[spec steep:check]

data/Steepfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+
+  library 'uri'
+
+  configure_code_diagnostics do |config|
+    config[Steep::Diagnostic::Ruby::UnsupportedSyntax] = :hint
+    config[Steep::Diagnostic::Ruby::MethodDefinitionMissing] = :hint
+  end
+end
+
+target :test do
+  signature 'sig'
+
+  check 'test'
+
+  library 'uri'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'package_url'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/package_url/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class PackageURL
+  # :nodoc:
+  VERSION = '0.1.0'
+end

data/lib/package_url.rb

@@ -0,0 +1,358 @@
+# frozen_string_literal: true
+
+require_relative 'package_url/version'
+
+require 'uri'
+
+# A package URL, or _purl_, is a URL string used to
+# identify and locate a software package in a mostly universal and uniform way
+# across programing languages, package managers, packaging conventions, tools,
+# APIs and databases.
+#
+# A purl is a URL composed of seven components:
+#
+# ```
+# scheme:type/namespace/name@version?qualifiers#subpath
+# ```
+#
+# For example,
+# the package URL for this Ruby package at version 0.1.0 is
+# `pkg:ruby/mattt/packageurl-ruby@0.1.0`.
+class PackageURL
+  # Raised when attempting to parse an invalid package URL string.
+  # @see #parse
+  class InvalidPackageURL < ArgumentError; end
+
+  # The URL scheme, which has a constant value of `"pkg"`.
+  def scheme
+    'pkg'
+  end
+
+  # The package type or protocol, such as `"gem"`, `"npm"`, and `"github"`.
+  attr_reader :type
+
+  # A name prefix, specific to the type of package.
+  # For example, an npm scope, a Docker image owner, or a GitHub user.
+  attr_reader :namespace
+
+  # The name of the package.
+  attr_reader :name
+
+  # The version of the package.
+  attr_reader :version
+
+  # Extra qualifying data for a package, specific to the type of package.
+  # For example, the operating system or architecture.
+  attr_reader :qualifiers
+
+  # An extra subpath within a package, relative to the package root.
+  attr_reader :subpath
+
+  # Constructs a package URL from its components
+  # @param type [String] The package type or protocol.
+  # @param namespace [String] A name prefix, specific to the type of package.
+  # @param name [String] The name of the package.
+  # @param version [String] The version of the package.
+  # @param qualifiers [Hash] Extra qualifying data for a package, specific to the type of package.
+  # @param subpath [String] An extra subpath within a package, relative to the package root.
+  def initialize(type:, name:, namespace: nil, version: nil, qualifiers: nil, subpath: nil)
+    raise ArgumentError, 'type is required' if type.nil? || type.empty?
+    raise ArgumentError, 'name is required' if name.nil? || name.empty?
+
+    @type = type.downcase
+    @namespace = namespace
+    @name = name
+    @version = version
+    @qualifiers = qualifiers
+    @subpath = subpath
+  end
+
+  # Creates a new PackageURL from a string.
+  # @param [String] string The package URL string.
+  # @raise [InvalidPackageURL] If the string is not a valid package URL.
+  # @return [PackageURL]
+  def self.parse(string)
+    components = {}
+
+    # Split the purl string once from right on '#'
+    # - The left side is the remainder
+    # - Strip the right side from leading and trailing '/'
+    # - Split this on '/'
+    # - Discard any empty string segment from that split
+    # - Discard any '.' or '..' segment from that split
+    # - Percent-decode each segment
+    # - UTF-8-decode each segment if needed in your programming language
+    # - Join segments back with a '/'
+    # - This is the subpath
+    case string.rpartition('#')
+    in String => remainder, separator, String => subpath unless separator.empty?
+      components[:subpath] = subpath.split('/').select do |segment|
+        !segment.empty? && segment != '.' && segment != '..'
+      end.compact.join('/')
+
+      string = remainder
+    else
+      components[:subpath] = nil
+    end
+
+    # Split the remainder once from right on '?'
+    # - The left side is the remainder
+    # - The right side is the qualifiers string
+    # - Split the qualifiers on '&'. Each part is a key=value pair
+    # - For each pair, split the key=value once from left on '=':
+    # - The key is the lowercase left side
+    # - The value is the percent-decoded right side
+    # - UTF-8-decode the value if needed in your programming language
+    # - Discard any key/value pairs where the value is empty
+    # - If the key is checksums,
+    #   split the value on ',' to create a list of checksums
+    # - This list of key/value is the qualifiers object
+    case string.rpartition('?')
+    in String => remainder, separator, String => qualifiers unless separator.empty?
+      components[:qualifiers] = {}
+
+      qualifiers.split('&').each do |pair|
+        case pair.partition('=')
+        in String => key, separator, String => value unless separator.empty?
+          key = key.downcase
+          value = URI.decode_www_form_component(value)
+          next if value.empty?
+
+          case key
+          when 'checksums'
+            components[:qualifiers][key] = value.split(',')
+          else
+            components[:qualifiers][key] = value
+          end
+        else
+          next
+        end
+      end
+
+      string = remainder
+    else
+      components[:qualifiers] = nil
+    end
+
+    # Split the remainder once from left on ':'
+    # - The left side lowercased is the scheme
+    # - The right side is the remainder
+    case string.partition(':')
+    in 'pkg', separator, String => remainder unless separator.empty?
+      string = remainder
+    else
+      raise InvalidPackageURL, 'invalid or missing "pkg:" URL scheme'
+    end
+
+    # Strip the remainder from leading and trailing '/'
+    # - Split this once from left on '/'
+    # - The left side lowercased is the type
+    # - The right side is the remainder
+    string = string.delete_suffix('/')
+    case string.partition('/')
+    in String => type, separator, remainder unless separator.empty?
+      components[:type] = type
+
+      string = remainder
+    else
+      raise InvalidPackageURL, 'invalid or missing package type'
+    end
+
+    # Split the remainder once from right on '@'
+    # - The left side is the remainder
+    # - Percent-decode the right side. This is the version.
+    # - UTF-8-decode the version if needed in your programming language
+    # - This is the version
+    case string.rpartition('@')
+    in String => remainder, separator, String => version unless separator.empty?
+      components[:version] = URI.decode_www_form_component(version)
+
+      string = remainder
+    else
+      components[:version] = nil
+    end
+
+    # Split the remainder once from right on '/'
+    # - The left side is the remainder
+    # - Percent-decode the right side. This is the name
+    # - UTF-8-decode this name if needed in your programming language
+    # - Apply type-specific normalization to the name if needed
+    # - This is the name
+    case string.rpartition('/')
+    in String => remainder, separator, String => name unless separator.empty?
+      components[:name] = URI.decode_www_form_component(name)
+
+      # Split the remainder on '/'
+      # - Discard any empty segment from that split
+      # - Percent-decode each segment
+      # - UTF-8-decode the each segment if needed in your programming language
+      # - Apply type-specific normalization to each segment if needed
+      # - Join segments back with a '/'
+      # - This is the namespace
+      components[:namespace] = remainder.split('/').map { |s| URI.decode_www_form_component(s) }.compact.join('/')
+    in _, _, String => name
+      components[:name] = URI.decode_www_form_component(name)
+      components[:namespace] = nil
+    end
+
+    new(type: components[:type],
+        name: components[:name],
+        namespace: components[:namespace],
+        version: components[:version],
+        qualifiers: components[:qualifiers],
+        subpath: components[:subpath])
+  end
+
+  # Returns a hash containing the
+  # scheme, type, namespace, name, version, qualifiers, and subpath components
+  # of the package URL.
+  def to_h
+    {
+      scheme: scheme,
+      type: @type,
+      namespace: @namespace,
+      name: @name,
+      version: @version,
+      qualifiers: @qualifiers,
+      subpath: @subpath
+    }
+  end
+
+  # Returns a string representation of the package URL.
+  # Package URL representations are created according to the instructions from
+  # https://github.com/package-url/purl-spec/blob/0b1559f76b79829e789c4f20e6d832c7314762c5/PURL-SPECIFICATION.rst#how-to-build-purl-string-from-its-components.
+  def to_s
+    # Start a purl string with the "pkg:" scheme as a lowercase ASCII string
+    purl = 'pkg:'
+
+    # Append the type string to the purl as a lowercase ASCII string
+    # Append '/' to the purl
+
+    purl += @type
+    purl += '/'
+
+    # If the namespace is not empty:
+    # - Strip the namespace from leading and trailing '/'
+    # - Split on '/' as segments
+    # - Apply type-specific normalization to each segment if needed
+    # - UTF-8-encode each segment if needed in your programming language
+    # - Percent-encode each segment
+    # - Join the segments with '/'
+    # - Append this to the purl
+    # - Append '/' to the purl
+    # - Strip the name from leading and trailing '/'
+    # - Apply type-specific normalization to the name if needed
+    # - UTF-8-encode the name if needed in your programming language
+    # - Append the percent-encoded name to the purl
+    #
+    # If the namespace is empty:
+    # - Apply type-specific normalization to the name if needed
+    # - UTF-8-encode the name if needed in your programming language
+    # - Append the percent-encoded name to the purl
+    case @namespace
+    in String => namespace unless namespace.empty?
+      segments = []
+      @namespace.delete_prefix('/').delete_suffix('/').split('/').each do |segment|
+        next if segment.empty?
+
+        segments << URI.encode_www_form_component(segment)
+      end
+      purl += segments.join('/')
+
+      purl += '/'
+      purl += URI.encode_www_form_component(@name.delete_prefix('/').delete_suffix('/'))
+    else
+      purl += URI.encode_www_form_component(@name)
+    end
+
+    # If the version is not empty:
+    # - Append '@' to the purl
+    # - UTF-8-encode the version if needed in your programming language
+    # - Append the percent-encoded version to the purl
+    case @version
+    in String => version unless version.empty?
+      purl += '@'
+      purl += URI.encode_www_form_component(@version)
+    else
+      nil
+    end
+
+    # If the qualifiers are not empty and not composed only of key/value pairs
+    # where the value is empty:
+    # - Append '?' to the purl
+    # - Build a list from all key/value pair:
+    # - discard any pair where the value is empty.
+    # - UTF-8-encode each value if needed in your programming language
+    # - If the key is checksums and this is a list of checksums
+    #   join this list with a ',' to create this qualifier value
+    # - create a string by joining the lowercased key,
+    #   the equal '=' sign and the percent-encoded value to create a qualifier
+    # - sort this list of qualifier strings lexicographically
+    # - join this list of qualifier strings with a '&' ampersand
+    # - Append this string to the purl
+    case @qualifiers
+    in Hash => qualifiers unless qualifiers.empty?
+      list = []
+      qualifiers.each do |key, value|
+        next if value.empty?
+
+        case [key, value]
+        in 'checksums', Array => checksums
+          list << "#{key.downcase}=#{checksums.join(',')}"
+        else
+          list << "#{key.downcase}=#{URI.encode_www_form_component(value)}"
+        end
+      end
+
+      unless list.empty?
+        purl += '?'
+        purl += list.sort.join('&')
+      end
+    else
+      nil
+    end
+
+    # If the subpath is not empty and not composed only of
+    # empty, '.' and '..' segments:
+    # - Append '#' to the purl
+    # - Strip the subpath from leading and trailing '/'
+    # - Split this on '/' as segments
+    # - Discard empty, '.' and '..' segments
+    # - Percent-encode each segment
+    # - UTF-8-encode each segment if needed in your programming language
+    # - Join the segments with '/'
+    # - Append this to the purl
+    case @subpath
+    in String => subpath unless subpath.empty?
+      segments = []
+      subpath.delete_prefix('/').delete_suffix('/').split('/').each do |segment|
+        next if segment.empty? || segment == '.' || segment == '..'
+
+        segments << URI.encode_www_form_component(segment)
+      end
+
+      unless segments.empty?
+        purl += '#'
+        purl += segments.join('/')
+      end
+    else
+      nil
+    end
+
+    purl
+  end
+
+  # Returns an array containing the
+  # scheme, type, namespace, name, version, qualifiers, and subpath components
+  # of the package URL.
+  def deconstruct
+    [scheme, @type, @namespace, @name, @version, @qualifiers, @subpath]
+  end
+
+  # Returns a hash containing the
+  # scheme, type, namespace, name, version, qualifiers, and subpath components
+  # of the package URL.
+  def deconstruct_keys(_keys)
+    to_h
+  end
+end

data/packageurl-ruby.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/package_url/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'packageurl-ruby'
+  spec.version       = PackageURL::VERSION
+  spec.authors       = ['Mattt']
+  spec.email         = ['mattt@me.com']
+
+  spec.summary       = 'Ruby implementation of the package url spec'
+  spec.description   = <<-DESCRIPTION
+    A package URL, or purl, is a URL string used to
+    identify and locate a software package in a mostly universal and uniform way
+    across programing languages, package managers, packaging conventions,
+    tools, APIs and databases.
+  DESCRIPTION
+
+  spec.homepage = 'https://github.com/package-url/packageurl-ruby'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+end

data/sig/package_url.rbs

@@ -0,0 +1,44 @@
+# A package URL, or _purl_, is a URL string used to identify and locate a software package
+# in a mostly universal and uniform way across
+# programing languages, package managers, packaging conventions, tools, APIs and databases.
+#
+# A purl is a URL composed of seven components:
+#
+# ```
+# scheme:type/namespace/name@version?qualifiers#subpath
+# ```
+#
+# For example,
+# the package URL for this Ruby package at version 0.1.0 is
+# `pkg:ruby/mattt/packageurl-ruby@0.1.0`.
+class PackageURL
+  VERSION: String
+
+  def scheme: () -> String
+  attr_reader type: String
+  attr_reader namespace: String?
+  attr_reader name: String?
+  attr_reader version: String?
+  attr_reader qualifiers: Hash[String, String]?
+  attr_reader subpath: String?
+
+  def initialize: (type: String `type`, 
+                   ?namespace: String? namespace, 
+                   name: String name, 
+                   ?version: String? version, 
+                   ?qualifiers: Hash[String, String]? qualifiers, 
+                   ?subpath: String? subpath) -> void
+                
+  def self.parse: (String string) -> PackageURL?
+
+  def to_h: () -> { scheme: String, type: String, namespace: String?, name: String?, version: String?, qualifiers: Hash[String, String]?, subpath: String? }
+
+  # Returns a string representation of the package URL.
+  # Package URL representations are created according to the instructions provided at
+  # https://github.com/package-url/purl-spec/blob/0b1559f76b79829e789c4f20e6d832c7314762c5/PURL-SPECIFICATION.rst#how-to-build-purl-string-from-its-components.
+  def to_s: () -> String
+
+  def deconstruct: () -> Array[String | Hash[String, String] | nil]
+
+  def deconstruct_keys: (Array[Symbol] keys) -> { scheme: String, type: String, namespace: String?, name: String?, version: String?, qualifiers: Hash[String, String]?, subpath: String? }
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: packageurl-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-10 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      A package URL, or purl, is a URL string used to
+      identify and locate a software package in a mostly universal and uniform way
+      across programing languages, package managers, packaging conventions,
+      tools, APIs and databases.
+email:
+- mattt@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- Steepfile
+- bin/console
+- bin/setup
+- lib/package_url.rb
+- lib/package_url/version.rb
+- packageurl-ruby.gemspec
+- sig/package_url.rbs
+homepage: https://github.com/package-url/packageurl-ruby
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Ruby implementation of the package url spec
+test_files: []