deb_version 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0eec3bd476766475cb472300c628c1ef1cf3b34141ef696e75df6a636d99952
-  data.tar.gz: ae81bf2ff31ea9e2667a16ca7792346d0cac487ddfe01c998b7f3b08342b4416
+  metadata.gz: da683bbad0561bf83d9e53fb06c0c15b4e91f7a0d965a9896f9b2488b0aa075a
+  data.tar.gz: '061307976f05755c2a8aa14f3f25a9138b944f1385e30b85d30a4eea4f8edc90'
 SHA512:
-  metadata.gz: 669966c3f74b9dd259e96c6c57b2dc56bdd3ea7785c0e0066ff7699fb62c730e871c9c8ce7b719b4e36060c198cc49363e04f31a99203280d31df9dadaf87458
-  data.tar.gz: 86c3ddb2b9f14393773bde364578287c573fc352c33517cbbd4736b5c0683ba89bb7847aeaaac702d43230f4a1bee4c80fd41837b81bb2f5bb265a53cbf96cca
+  metadata.gz: e1ce022f6a242e528c54c818dee4689c49881f32457d0113804327f749dffb91a78b1f55e160e3fb2f750f90b017dd25652af29da59761626a47adfb0a939800
+  data.tar.gz: 567f056f47116d4eb68dadff2038041a5c9df017a541ccc0811dbd3be5f250876074aa8b49e7da497656a1de5c138bfbd5e1f6b6d33b2a9fceaf5a3a3f2dbaa3

data/.rubocop.yml

@@ -12,7 +12,11 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+Metrics/MethodLength:
+  Max: 20
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.0
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: false

data/Gemfile.lock

@@ -8,6 +8,7 @@ GEM
   specs:
     ast (2.4.2)
     json (2.6.3)
+    json (2.6.3-java)
     minitest (5.18.0)
     parallel (1.23.0)
     parser (3.2.2.1)
@@ -36,6 +37,10 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  universal-java-1.8
+  universal-java-11
+  x86_64-darwin
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -1,4 +1,4 @@
-# Debian Version
+# Debian Version (Ruby)
 
 A port of "Debian Version" comparison function to Ruby. This is based on 
 [Debian Policy Manual v4.6.20, Section 5.6.12](https://www.debian.org/doc/debian-policy/ch-controlfields.html#version).
@@ -7,22 +7,20 @@ It adapts some of the code from https://github.com/FauxFaux/deb-version and http
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add deb_version
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install deb_version
 
 ## Usage
 
 ```ruby
 require 'deb_version'
-v1 = DebVersion::DebianVersion.new("1.3~rc2")
-v2 = DebVersion::DebianVersion.new("1.3")
+v1 = DebVersion.new("1.3~rc2")
+v2 = DebVersion.new("1.3")
 v1 < v2 # true
 ```
 
@@ -32,6 +30,10 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 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).
 
+Run `bundle exec rake rubocop` to check for style violations.
+
+Run `bundle exec rake test` to run tests.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/captn3m0/ruby-deb-version. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/captn3m0/ruby-deb-version/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -11,4 +11,4 @@ Minitest::TestTask.create(:test) do |t|
   t.test_globs = ["test.rb"]
 end
 
-task :default => :test
+task default: :test

data/deb_version.gemspec

@@ -21,15 +21,16 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git all-debian-versions.lst test.rb])
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git all-debian-versions.lst
+                                                             test.rb])
     end
   end
-  
+
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "minitest", "~> 5.18"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rubocop", "~> 1.21"
-  spec.add_development_dependency "minitest", "~> 5.18"
   spec.add_development_dependency "rubocop-minitest", "~> 0.31.0"
   spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
 

data/lib/deb_version/compare.rb

@@ -1,86 +1,98 @@
 # frozen_string_literal: true
 
-module DebVersion
-  class DebianVersion
-    attr_reader :epoch, :upstream_version, :debian_revision
+# Debian Version comparison class
+# This is based on the Python deb-pkg-tools implementation
+# https://github.com/xolox/python-deb-pkg-tools
+class DebVersion
+  attr_reader :epoch, :upstream_version, :debian_revision
 
-    include Comparable
+  include Comparable
 
-    def initialize(version)
-      @version = version
-      @epoch = 0
-      @debian_revision = ""
+  def initialize(version)
+    @version = version
+    @epoch = 0
+    @debian_revision = ""
 
-      if @version.include? ":"
-        @epoch, @version = @version.split(":")
-        @epoch = @epoch.to_i
-      end
-
-      if @version.include? "-"
-        @upstream_version, _, @debian_revision = @version.rpartition("-")
-      else
-        @upstream_version = @version
-      end
+    if @version.include? ":"
+      @epoch, @version = @version.split(":")
+      @epoch = @epoch.to_i
     end
 
-    def to_a
-      [@epoch, @upstream_version, @debian_revision]
+    if @version.include? "-"
+      @upstream_version, _, @debian_revision = @version.rpartition("-")
+    else
+      @upstream_version = @version
     end
+  end
 
-    def get_digit_prefix(characters)
-      value = 0
-      value = (value * 10) + characters.shift.to_i while characters && DebVersion::DIGITS.include?(characters[0])
-      value
-    end
+  # Convert to an array of [epoch, upstream_version, debian_revision]
+  # Helpful for printing and debugging
+  def to_a
+    [@epoch, @upstream_version, @debian_revision]
+  end
 
-    def get_non_digit_prefix(characters)
-      prefix = []
-      prefix << characters.shift while characters.size.positive? && !DebVersion::DIGITS.include?(characters[0])
-      prefix
-    end
+  # Internal method to get the largest digit prefix
+  def get_digit_prefix(characters)
+    value = 0
+    value = (value * 10) + characters.shift.to_i while characters && DebVersion::DIGITS.include?(characters[0])
+    value
+  end
+
+  # Internal method to get the largest non-digit prefix
+  def get_non_digit_prefix(characters)
+    prefix = []
+    prefix << characters.shift while characters.size.positive? && !DebVersion::DIGITS.include?(characters[0])
+    prefix
+  end
 
-    def compare_strings(version1, version2)
-      v1 = version1.chars
-      v2 = version2.chars
-      while !v1.empty? || !v2.empty?
-        p1 = get_non_digit_prefix(v1)
-        p2 = get_non_digit_prefix(v2)
-        if p1 != p2
-          loop do
-            c1 = p1.shift
-            c2 = p2.shift
-            break if c1.nil? && c2.nil?
+  # Compare strings as per https://www.debian.org/doc/debian-policy/ch-controlfields.html#version
+  # Section 5.6.12
+  # This is used to compare upstream_version as well as debian_revision
+  # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
+  def compare_strings(version1, version2)
+    v1 = version1.chars
+    v2 = version2.chars
+    while !v1.empty? || !v2.empty?
+      p1 = get_non_digit_prefix(v1)
+      p2 = get_non_digit_prefix(v2)
+      if p1 != p2
+        loop do
+          c1 = p1.shift
+          c2 = p2.shift
+          break if c1.nil? && c2.nil?
 
-            o1 = DebVersion::ORDER_MAPPING.fetch(c1 || "")
-            o2 = DebVersion::ORDER_MAPPING.fetch(c2 || "")
-            if o1 < o2
-              return -1
-            elsif o1 > o2
-              return 1
-            end
+          o1 = DebVersion::ORDER_MAPPING.fetch(c1 || "")
+          o2 = DebVersion::ORDER_MAPPING.fetch(c2 || "")
+          if o1 < o2
+            return -1
+          elsif o1 > o2
+            return 1
           end
         end
-        d1 = get_digit_prefix(v1)
-        d2 = get_digit_prefix(v2)
-        if d1 < d2
-          return -1
-        elsif d1 > d2
-          return 1
-        end
       end
-      0
+      d1 = get_digit_prefix(v1)
+      d2 = get_digit_prefix(v2)
+      if d1 < d2
+        return -1
+      elsif d1 > d2
+        return 1
+      end
     end
+    0
+  end
+  # rubocop:enable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
 
-    def <=>(other)
-      return epoch <=> other.epoch if epoch != other.epoch
+  # Compare two versions
+  # using all 3 parts
+  def <=>(other)
+    return epoch <=> other.epoch if epoch != other.epoch
 
-      result = compare_strings(upstream_version, other.upstream_version)
+    result = compare_strings(upstream_version, other.upstream_version)
 
-      return result if result != 0
+    return result if result != 0
 
-      return compare_strings(debian_revision, other.debian_revision) if debian_revision || other.debian_revision
+    return compare_strings(debian_revision, other.debian_revision) if debian_revision || other.debian_revision
 
-      0
-    end
+    0
   end
 end

data/lib/deb_version/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module DebVersion
-  VERSION = "0.1.0"
+class DebVersion
+  VERSION = "1.0.0"
 end

data/lib/deb_version.rb

@@ -3,20 +3,23 @@
 require_relative "deb_version/version"
 require_relative "deb_version/compare"
 
-# Main Module for the gem
-module DebVersion
+# Constants for the DebVersion class
+class DebVersion
   class Error < StandardError; end
   # String of ASCII characters which are considered punctuation characters in the C locale:
   # Except for ~
   # Already sorted
   PUNCTUATION = "!\"\#$%&'()*+,-./:;<=>?@[]^_`{|}".chars
+  DIGITS = ("0".."9").to_a
+
+  # Sorted list of characters used by Debian Version sort.
+  # see https://www.debian.org/doc/debian-policy/ch-controlfields.html#version
   SORT_LIST = ["~", ""] + ("A"..."Z").to_a + ("a"..."z").to_a + PUNCTUATION
 
   mapping = {}
   SORT_LIST.each_with_index do |char, index|
     mapping[char] = index
   end
+  # Set it to a constant
   ORDER_MAPPING = mapping
-
-  DIGITS = ("0".."9").to_a
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: deb_version
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nemo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-07 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.18'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement