docker_distribution 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 021cf69a8cf9e64b6b76e760c4799618223d4a0ddd9fe725e93fcec9597b83f7
+  data.tar.gz: e6d343476659fe83acefe2bd3639f57fe05adf97393462ae0e99f892733a09c5
+SHA512:
+  metadata.gz: c3f465e02c2460adbf79ffd76c046c99907d88085b9ce1ddd5c3f66592a689df85a0c31f01d43f3ac6eb8ff69238378720a9ddebe44298346f5246974d66493c
+  data.tar.gz: cc34f6053e2b17f0a9f433271391b02dfb4ce3cf21cc22658e4362c0031dbb2ef38e2d650d373fc0ed5067d60f2938433c78495ffaf865da407968f192d7ca8d

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require:
+ - rubocop-minitest
+
+AllCops:
+  Exclude:
+    - bin/*
+    - docker_distribution.gemspec
+    - test/*/**
+  SuggestExtensions: false
+  NewCops: disable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 140
+
+Metrics/ClassLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at partos0511@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:3.0.2-alpine3.14
+
+RUN apk update && apk upgrade && apk add bash curl-dev ruby-dev build-base git curl
+
+RUN mkdir -p /gem
+WORKDIR /gem
+
+COPY . /gem
+
+RUN bundle install --jobs 4
+
+ENV PATH /gem/bin:$PATH

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13"
+
+gem "minitest", "~> 5"
+gem "minitest-power_assert"
+
+gem "rubocop", "~> 1"
+
+gem "rubocop-minitest", "~> 0"
+
+gem "awesome_print"
+gem "byebug"
+
+gem "warning"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    docker_distribution (0.1.0)
+      digest (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    byebug (11.1.3)
+    digest (3.1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    minitest-power_assert (0.3.1)
+      minitest
+      power_assert (>= 1.1)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    power_assert (2.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.22.1)
+      rubocop (>= 0.90, < 2.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+    warning (1.3.0)
+
+PLATFORMS
+  x86_64-linux-musl
+
+DEPENDENCIES
+  awesome_print
+  byebug
+  docker_distribution!
+  minitest (~> 5)
+  minitest-power_assert
+  rake (~> 13)
+  rubocop (~> 1)
+  rubocop-minitest (~> 0)
+  warning
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Artem Petrov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,9 @@
+.PHONY: test lint
+
+test:
+	bundle exec rake test
+
+lint:
+	bundle exec rubocop -A
+
+

data/README.md

@@ -0,0 +1,108 @@
+# DockerDistribution
+
+Implementation of OCI Distribution Specification on Ruby. Implementation copied from Golang version which used in Docker Cli and Kubectl Cli.
+
+[OCI Distribution Specification](https://github.com/opencontainers/distribution-spec)
+
+[Golang implementation](https://github.com/docker/distribution/tree/main/reference)
+
+
+## Installation
+
+```
+gem install docker_distribution
+```
+
+## Usage
+
+### Reference
+* Add description from implementation comments
+```
+DockerDistribution::Reference.parse(image_name)
+DockerDistribution::Reference.parse_named(str)
+DockerDistribution::Reference.with_name(name)
+DockerDistribution::Reference.with_tag(named, tag)
+DockerDistribution::Reference.with_digest(named, digest)
+DockerDistribution::Reference.split_domain(name)
+DockerDistribution::Reference.split_hostname(named)
+```
+
+### Normalize
+* Add description from implementation comments
+```
+DockerDistribution::Normalize.parse_normalized_named(str)
+DockerDistribution::Normalize.parse_docker_ref(ref)
+DockerDistribution::Normalize.split_docker_domain(name)
+DockerDistribution::Normalize.familiarize_name(repo)
+DockerDistribution::Normalize.tag_name_only(ref)
+DockerDistribution::Normalize.parse_any_reference(ref)
+DockerDistribution::Normalize.parse_any_reference_with_set(ref, digest_set)
+```
+
+### Regexp
+* Add description from implementation comments
+```
+DockerDistribution::Regexp.alpha_numeric
+DockerDistribution::Regexp.separator
+DockerDistribution::Regexp.name_component
+DockerDistribution::Regexp.domain_name_component
+DockerDistribution::Regexp.ipv6address
+DockerDistribution::Regexp.domain_name
+DockerDistribution::Regexp.host
+DockerDistribution::Regexp.domain
+DockerDistribution::Regexp.domain_regexp
+DockerDistribution::Regexp.tag
+DockerDistribution::Regexp.tag_regexp
+DockerDistribution::Regexp.anchored_tag
+DockerDistribution::Regexp.anchored_tag_regexp
+DockerDistribution::Regexp.digest_pat
+DockerDistribution::Regexp.digest_regexp
+DockerDistribution::Regexp.anchored_digest
+DockerDistribution::Regexp.anchored_digest_regexp
+DockerDistribution::Regexp.name_pat
+DockerDistribution::Regexp.name_regexp
+DockerDistribution::Regexp.anchored_name
+DockerDistribution::Regexp.anchored_name_regexp
+DockerDistribution::Regexp.reference_pat
+DockerDistribution::Regexp.reference_regexp
+DockerDistribution::Regexp.identifier
+DockerDistribution::Regexp.identifier_regexp
+DockerDistribution::Regexp.short_identifier
+DockerDistribution::Regexp.short_identifier_regexp
+DockerDistribution::Regexp.anchored_identifier
+DockerDistribution::Regexp.anchored_identifier_regexp
+DockerDistribution::Regexp.anchored_short_identifier
+DockerDistribution::Regexp.anchored_short_identifier_regexp
+```
+
+### Digest
+* Add description from implementation comments
+```
+DockerDistribution::Digest.parse(digest_string)
+```
+
+## Examples
+...
+
+More examples in tests
+
+## Development
+```
+docker-compose build gem
+docker-compose run --rm gem bash
+bundle install
+...
+make test
+make lint
+```
+
+## Release
+1. [Read this](https://guides.rubygems.org/publishing/)
+2. Make sure you logged in into Rubygems
+3. Update version accoring [semver](https://semver.org/)
+4. `gem build docker_distribution.gemspec`
+5. `gem push docker_distribution-[version].gem`
+
+## Todo
+- Finish readme description / examples / installation guide / development guide / examples / ruby version support
+- Add correct workflow in github to run tests and linters in docker env

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/docker-compose.yml

@@ -0,0 +1,26 @@
+version: '3.9'
+
+x-shared-environment: &shared-environment
+  BUNDLE_PATH: /bundle_cache
+  GEM_HOME: /bundle_cache
+  GEM_PATH: /bundle_cache
+  RUBYGEMS_API_KEY: ${RUBYGEMS_API_KEY}
+
+services:
+  gem:
+    build: .
+    environment: *shared-environment
+    volumes:
+      - .:/gem:cached
+      - ~/.ssh:/root/.ssh
+      - ~/.bash_history:/root/.bash_history
+      - bundle_cache:/bundle_cache
+    command: bash
+
+  bundle_cache:
+    image: busybox
+    volumes:
+      - bundle_cache:/bundle_cache
+
+volumes:
+  bundle_cache:

data/lib/docker_distribution/canonical_reference.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DockerDistribution
+  class CanonicalReference
+    extend ::Forwardable
+    def_delegators :repository, :name, :domain, :path
+
+    attr_accessor :repository, :digest
+
+    def initialize(repository, digest)
+      @repository = repository
+      @digest = digest
+    end
+
+    def to_s
+      [repository.name, digest].join("@")
+    end
+
+    def to_h
+      {
+        repository: name,
+        domain: domain,
+        path: path,
+        digest: digest
+      }
+    end
+
+    def familiar
+      self.class.new(Normalize.familiarize_name(self), digest)
+    end
+  end
+end

data/lib/docker_distribution/digest.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module DockerDistribution
+  class Digest
+    DEFAULT_ALGORITHM = "sha256"
+    attr_accessor :digest_string, :encoded, :algorithm_type
+
+    #  Parse parses digest_string and returns the validated digest object. An error will
+    #  be raised if the format is invalid.
+    def self.parse!(digest_string)
+      dgst = new(digest_string)
+      dgst.validate!
+      dgst
+    end
+
+    def initialize(digest_string)
+      @digest_string = digest_string
+      @algorithm_type, @encoded = digest_string.index(":") ? digest_string.split(":") : [DEFAULT_ALGORITHM, digest_string]
+    end
+
+    def digest
+      [algorithm_type, encoded].compact.join(":")
+    end
+
+    def to_s
+      digest
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def validate!
+      index = digest_string.index(":")
+      raise DigestInvalidFormat if index.nil? || index + 1 == digest_string.length
+
+      raise DigestInvalidLength if algorithm.block_length != encoded.length
+
+      return true if Regexp.anchored_encoded_regexp(algorithm_type.upcase).match?(encoded)
+
+      raise DigestInvalidFormat
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def algorithm
+      send(:Digest, algorithm_type.upcase).new
+    rescue NameError, LoadError
+      raise DigestUnsupported
+    end
+  end
+end

data/lib/docker_distribution/digest_reference.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerDistribution
+  class DigestReference
+    attr_accessor :digest
+
+    def initialize(digest)
+      @digest = digest
+    end
+
+    def to_s
+      digest
+    end
+
+    def to_h
+      { digest: digest }
+    end
+  end
+end

data/lib/docker_distribution/digest_set.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module DockerDistribution
+  class DigestSet
+    attr_writer :entries
+
+    def initialize(digest_strings)
+      @entries = digest_strings.map { |digest_string| Digest.new(digest_string) }
+    end
+
+    def entries
+      @entries ||= []
+    end
+
+    def add(digest_string)
+      @entries << Digest.new(digest_string)
+    end
+
+    def lookup!(digest_string)
+      raise DigestNotFound if entries.length.zero?
+
+      search_func, encoded, alg = parse!(digest_string)
+
+      entry = search(search_func, encoded, alg)
+      entry.digest
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def parse!(digest_string)
+      dgst = Digest.parse!(digest_string)
+      alg = dgst.algorithm_type
+      encoded = dgst.encoded
+      search_func = lambda do |i|
+        return entries[i].algorithm_type >= dgst.algorithm_type if entries[i].encoded == encoded
+
+        entries[i].encoded >= encoded
+      end
+      [search_func, encoded, alg]
+    rescue DigestInvalidFormat
+      alg = Digest::DEFAULT_ALGORITHM
+      encoded = digest_string
+      search_func = lambda do |i|
+        entries[i].encoded >= digest_string
+      end
+      [search_func, encoded, alg]
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def search(search_func, encoded, alg)
+      idx = entries.each_with_index.filter_map { |_el, i| i if search_func.call(i) }.first || entries.length
+      raise DigestNotFound if idx == entries.length || !check_short_match(entries[idx].algorithm_type, entries[idx].encoded, alg.to_s,
+                                                                          encoded)
+      return entries[idx] if entries[idx].algorithm_type == alg && entries[idx].encoded == encoded
+
+      raise DigestAmbiguous if idx + 1 < entries.length && check_short_match(entries[idx + 1].algorithm_type, entries[idx + 1].encoded,
+                                                                             alg.to_s, encoded)
+
+      entries[idx]
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def check_short_match(alg, encoded, short_alg, short_encoded)
+      if encoded.length == short_encoded.length
+        return false if encoded != short_encoded
+
+        return false if short_alg.length.positive? && alg != short_alg
+      end
+
+      return false unless encoded.start_with?(short_encoded)
+
+      return false if short_alg.length.positive? && alg != short_alg
+
+      true
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/docker_distribution/errors.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DockerDistribution
+  # NameEmpty is raised for empty, invalid repository names.
+  class NameEmpty < StandardError; end
+  # ReferenceInvalidFormat represents an error while trying to parse a string as a reference.
+  class ReferenceInvalidFormat < StandardError; end
+  # TagInvalidFormat represents an error while trying to parse a string as a tag.
+  class TagInvalidFormat < StandardError; end
+  # DigestError raised when something wrong with Digest
+  class DigestError < StandardError; end
+  # DigestInvalidLength raised when digest has invalid length.
+  class DigestInvalidLength < DigestError; end
+  # DigestInvalidFormat raised when digest format invalid.
+  class DigestInvalidFormat < DigestError; end
+  # DigestUnsupported raised when the digest algorithm is unsupported.
+  class DigestUnsupported < DigestError; end
+  # DigestNotFound raised when the digest set not found
+  class DigestNotFound < DigestError; end
+  # DigestAmbiguous raised when the digest set has two same digests
+  class DigestAmbiguous < DigestError; end
+  #  NameContainsUppercase is raised for invalid repository names that contain uppercase characters.
+  class NameContainsUppercase < StandardError; end
+  # NameTooLong is raised when a repository name is longer than 255 symbols.
+  class NameTooLong < StandardError; end
+  # NameNotCanonical is raised when a name is not canonical.
+  class NameNotCanonical < StandardError; end
+  # # ParseNormalizedNamedError is raised when a parse normalized error failed
+  class ParseNormalizedNamedError < StandardError; end
+end

data/lib/docker_distribution/helpers.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module DockerDistribution
+  class Helpers
+    class << self
+      def familiar_name(named)
+        return named.familiar.name if named.respond_to?(:familiar)
+
+        named.name
+      end
+
+      def familiar_string(named)
+        return named.familiar.to_s if named.respond_to?(:familiar)
+
+        named.to_s
+      end
+
+      def familiar_match(pattern, ref)
+        string_match = File.fnmatch(pattern, familiar_string(ref), File::FNM_PATHNAME)
+        name_match = File.fnmatch(pattern, familiar_name(ref), File::FNM_PATHNAME)
+
+        string_match || name_match
+      end
+
+      def tagged?(ref)
+        ref.respond_to?(:tag)
+      end
+
+      def canonical?(ref)
+        ref.respond_to?(:digest)
+      end
+
+      def named?(ref)
+        ref.respond_to?(:name)
+      end
+
+      def familiar?(ref)
+        ref.respond_to?(:familiar)
+      end
+
+      def name_only?(ref)
+        named?(ref) && !tagged?(ref) && !canonical?(ref)
+      end
+
+      def normalized_named?(ref)
+        named?(ref) && familiar?(ref)
+      end
+
+      def from(str, index)
+        str[index..]
+      end
+
+      def to(str, index)
+        str[0...index]
+      end
+
+      def empty?(object)
+        object == "" || object.nil?
+      end
+    end
+  end
+end