ruby-libversion 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2aaf113a6cb56ae52674d46944ae80b6f563ff7c4652a510c1c0f32bccd6ada
-  data.tar.gz: d7601cfdbf8412d5a8e59177881b1b985a077ddd537eda12e980ec8a93dc8fbc
+  metadata.gz: 8aed1ad2e15370a06bc24ac5669f418ea96964c6bc6cdd65398281fc25c10cd5
+  data.tar.gz: 8f2df4487bce8cad0191339051a9ffb22812043ba3ace992470370521c5b5887
 SHA512:
-  metadata.gz: 4cbc1439eff77ecda561b19e5eba5d3dc5729f813fba77794f3d24e3a351ac0c98f26d56b6b26bd3e2c9453dd0b3b133e05897e7ac15628833c9e8f2bfa36b0c
-  data.tar.gz: 3a83fdde12a0e61efddd341b181c8d33465cb869594df76d382aa0040f5b5a790b947f180bc387d15ed74f25092f31b4a902b076cbe3e79aef6e34928bb33244
+  metadata.gz: 03670010cfb23c20b9d863b7af8820471761ae93a5226451ade2970197a2fdbff803489ce849c5a2adfadddd48618c71dd039ddd55a81a6fd9f848810c206dca
+  data.tar.gz: 93fa1af30f55b561e3aaad4c42f383fe40aeabad965535bce6b87ac862c270719e1ca39d3b2b34d17f165529a56bf0e36081db8a0f8de5369feaac6e8ebba0dd

data/.github/workflows/rubocop.yml

@@ -0,0 +1,16 @@
+name: Rubocop
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v5
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+      - name: Install rubocop
+        run: gem install rubocop
+      - name: Run rubocop
+        run: rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v5
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+      - name: Install dependencies
+        run: gem install rake-compiler
+      - name: Build and install ruby-libversion (Ruby fallback)
+        run: |
+          gem build ruby-libversion
+          gem install -l ruby-libversion
+      - name: Run tests (Ruby fallback)
+        run: rake test
+      - name: Install libversion  # Hopefully this will get added as an Ubuntu/Debian package.
+        working-directory: ${{ runner.temp }}
+        run: |
+          git clone --depth 1 -b 3.0.3 https://github.com/repology/libversion
+          cd libversion
+          mkdir build
+          cd build
+          cmake .. -DCMAKE_INSTALL_PREFIX=/usr
+          make -j "$(nproc)"
+          sudo make install
+      - name: Build and install ruby-libversion (native extension)
+        run: |
+          gem build ruby-libversion
+          gem install -l ruby-libversion
+      - name: Run tests (native extension)
+        run: rake test

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  NewCops: enable
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+# TODO: Find out what ruby version we actually require and then remove this.
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: False
+
+Style/Documentation:
+  Enabled: False
+
+Style/FrozenStringLiteralComment:
+  Enabled: False
+
+Style/MutableConstant:
+  Enabled: False
+
+Style/RedundantReturn:
+  Enabled: False
+
+Style/RedundantSelf:
+  Enabled: False

data/ext/libversion/extconf.rb

@@ -2,4 +2,14 @@ require 'mkmf'
 
 pkg_config('libversion')
 
-create_makefile 'ruby_libversion'
+# If $libs is still empty, we weren't able to find the library, so we don't build the extension.
+if $libs.empty? # rubocop:disable Style/GlobalVars
+  # Create a dummy Makefile, to satisfy Gem::Installer#install
+  # You would think mkmf's dummy_makefile method would do this, but apparently not.
+  File.write 'Makefile', <<~EOF
+    .PHONY: install
+    install:
+  EOF
+else
+  create_makefile 'ruby_libversion'
+end

data/lib/ruby_libversion.rb

@@ -0,0 +1,121 @@
+# This is a pure Ruby implementation of libversion, used as a fallback when the C extension is not available.
+
+class VersionComponent
+  attr_accessor :component, :rank
+
+  # Store the ranks in order, so that we can compare their indexes to determine which is greater.
+  RANK_ORDERING = %i[lower_bound pre_release zero post_release nonzero letter_suffix upper_bound]
+
+  def initialize(components, flags)
+    # While we pass in a nil component to let determine_rank know we want padding, we set the actual value to 0 when we store it.
+    @component = components[1].nil? ? '0' : components[1]
+
+    @rank = determine_rank(components, flags)
+  end
+
+  def determine_rank(components, flags)
+    # If the current component is nil, it is padding.
+    if components[1].nil?
+      # When we are passed the lower bound flag, all padding is the lower_bound rank.
+      if flags == Libversion::VERSIONFLAG_LOWER_BOUND
+        return :lower_bound
+      # When we are passed the upper bound flag, all padding is the upper_bound rank.
+      elsif flags == Libversion::VERSIONFLAG_UPPER_BOUND
+        return :upper_bound
+      # If we have not been passed either bound flag, all padding is the zero rank.
+      else
+        return :zero
+      end
+    end
+
+    # If the current component starts with a pre-release keyword (case insensitive), it is the pre_release rank.
+    return :pre_release if components[1].downcase.start_with?('alpha', 'beta', 'rc', 'pre')
+
+    # If the current component is an integer and has a value of zero, it is the zero rank.
+    return :zero if Integer(components[1], exception: false)&.zero?
+
+    # If the current component starts with a post-release keyword (case insensitive), or if the current component
+    # starts with 'p' (case insensitive) and we were given the VERSIONFLAG_P_IS_PATCH flag, it is the post_release rank.
+    return :post_release if components[1].start_with?('post', 'patch', 'pl', 'errata') || (flags == Libversion::VERSIONFLAG_P_IS_PATCH && components[1][0]&.downcase == 'p')
+
+    # If the current component is an integer and has a nonzero value, it is the nonzero rank.
+    return :nonzero if Integer(components[1], exception: false)&.nonzero?
+
+    # If the previous component is an integer, the current component is alphabetic, and the next component is not an integer, the current component is the letter_suffix rank.
+    return :letter_suffix unless Integer(components[0], exception: false).nil? || components[1].match?(/[^[:alpha:]]/) || !Integer(components[2], exception: false).nil?
+
+    # If we were given the VERSIONFLAG_ANY_IS_PATCH flag, any remaining alphabetic component is of the post_release rank.
+    return :post_release if flags == Libversion::VERSIONFLAG_ANY_IS_PATCH
+
+    # Otherwise, any remaining alphabetic component is of the pre_release rank.
+    return :pre_release
+  end
+
+  def <=>(other)
+    # Compare the rank of both components, and return the result unless they have the same rank.
+    rank_comparison = RANK_ORDERING.index(self.rank) <=> RANK_ORDERING.index(other.rank)
+    return rank_comparison unless rank_comparison.zero?
+
+    # If both components are alphabetic, return the case-insensitive comparison of their first letters.
+    return self.component[0].downcase <=> other.component[0].downcase if [self, other].none? { _1.component.match?(/[^[:alpha:]]/) }
+
+    # If we are still here, return the integer comparison of both components.
+    return self.component.to_i <=> other.component.to_i
+  end
+
+  def empty?
+    @component.empty?
+  end
+end
+
+module Libversion
+  VERSIONFLAG_P_IS_PATCH = 1
+  VERSIONFLAG_ANY_IS_PATCH = 2
+  VERSIONFLAG_LOWER_BOUND = 4
+  VERSIONFLAG_UPPER_BOUND = 8
+
+  def self.version_compare4(v1, v2, v1_flags, v2_flags)
+    # Parse the raw version strings into an array of VersionComponents.
+    v1_components = parse_version_string(v1, v1_flags)
+    v2_components = parse_version_string(v2, v2_flags)
+
+    # Pad each version so that they are the same length prior to zipping and comparison.
+    # We add additional padding to support lower and upper bounds even when the versions have an equal number of components.
+    v1_components.fill(VersionComponent.new([nil, nil, nil], v1_flags), v1_components.size, v2_components.size)
+    v2_components.fill(VersionComponent.new([nil, nil, nil], v2_flags), v2_components.size, v1_components.size)
+
+    # Zip the components together for ease of comparison.
+    zipped_components = v1_components.zip(v2_components)
+
+    # Iterate over the zipped components, comparing them and returning the first nonzero result we receive.
+    (0...zipped_components.size).each do |i|
+      comparison_result = zipped_components[i][0] <=> zipped_components[i][1]
+      return comparison_result unless comparison_result.zero?
+    end
+
+    # If we got here, every component was equal, and thus the versions are equal.
+    return 0
+  end
+
+  def self.version_compare2(v1, v2)
+    version_compare4(v1, v2, 0, 0)
+  end
+
+  private_class_method def self.parse_version_string(version_string, version_flags)
+    # Separate the version string into all-alphabetic and all-numeric components, with all other characters treated as separators.
+    # Separators are recorded as empty strings, with consecutive separators being squeezed into a single empty string.
+    version_raw_components = version_string.scan(/[[:alpha:]]+|[[:digit:]]+|[^[:alnum:]]+/).map { _1.match?(/[^[:alnum:]]/) ? '' : _1 }
+    # Pad the raw components with nil values so that every real component gets a turn at the centre of the tuple we pass to VersionComponent.new
+    version_raw_components.prepend(nil)
+    version_raw_components.append(nil)
+
+    # Loop over the raw components in groups of 3 (so we have the information for checking letter_suffix), storing the center component
+    # and its rank as a VersionComponent in version_components.
+    version_components = []
+    version_raw_components.each_cons(3) { version_components << VersionComponent.new(_1, version_flags) }
+    # Clean up any excess empty version components.
+    version_components.reject!(&:empty?)
+
+    return version_components
+  end
+end

data/ruby-libversion.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |spec|
   spec.name       = 'ruby-libversion'
   spec.summary    = 'Ruby bindings for libversion'
-  spec.version    = '1.0.0'
+  spec.version    = '1.1.0'
   spec.license    = 'MIT'
   spec.author     = 'Maximilian Downey Twiss'
-  spec.email      = 'creatorsmithmdt@.com'
+  spec.email      = 'creatorsmithmdt@gmail.com'
   spec.homepage   = 'https://github.com/Zopolis4/ruby-libversion'
   spec.files      = `git ls-files`.split("\n")
   spec.extensions = 'ext/libversion/extconf.rb'

data/test/test_ruby_libversion.rb

@@ -4,7 +4,7 @@ require 'ruby_libversion'
 # These test cases are taken from here:
 # https://github.com/repology/libversion/blob/master/tests/compare_test.c
 # The copyright notice from that file is reproduced here:
-# Copyright (c)) 2017-2018 Dmitry Marakasov <amdmi3@amdmi3.ru>
+# Copyright (c) 2017-2018 Dmitry Marakasov <amdmi3@amdmi3.ru>
 class RubyLibversionTest < Minitest::Test
   def test_equality
     assert_equal(0, Libversion.version_compare2('0', '0'))

metadata

@@ -1,36 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: ruby-libversion
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Maximilian Downey Twiss
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
-email: creatorsmithmdt@.com
+email: creatorsmithmdt@gmail.com
 executables: []
 extensions:
 - ext/libversion/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - LICENSE
 - README.md
 - Rakefile
 - ext/libversion/extconf.rb
 - ext/libversion/libversion.c
 - lib/libversion.rb
+- lib/ruby_libversion.rb
 - ruby-libversion.gemspec
 - test/test_ruby_libversion.rb
 homepage: https://github.com/Zopolis4/ruby-libversion
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,8 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Ruby bindings for libversion
 test_files: []