semver_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4217ffcec4eca63ed8280bb221b7cf0fa8ab1dc545b85f4d51799aa3f4bdf997
+  data.tar.gz: ccfc6d8d567321e919f4c629cfaddd7935b8dda165020046bf643bf2ddf274de
+SHA512:
+  metadata.gz: a0f7f029ea74293af76697b6b5e37a7897636de5059a792657f6e1963817cf7829f1d4ab2d306aa5d29f9e43aaca144e968d6407f2e407c46ef20fff010a98ba
+  data.tar.gz: 0c67e78f29bca2d694b0e662ad262178730d013af78c65e6bce4e4f1f7e52ae37a4b3c1cd1b332ab064f460d099e20b85b766dd8abb9d6f381cd4eb011083d80

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in semver_check.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 PuLLi
+
+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/README.md

@@ -0,0 +1,31 @@
+# SemverCheck
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add semver_check
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install semver_check
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/semver_check.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: :test

data/lib/semver_check/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SemverCheck
+  VERSION = "0.1.0"
+end

data/lib/semver_check.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative "semver_check/version"
+
+# SemverCheck module
+module SemverCheck
+  # Class to compare SemVer strings
+  class Compare
+    include Comparable
+
+    SEMVER_PATTERN = /\A
+                    (?<semver>
+                      (?<major>0|[1-9]\d*)
+                      \.
+                      (?<minor>0|[1-9]\d*)
+                      \.
+                      (?<patch>0|[1-9]\d*)
+                      (?:-(?<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)
+                        (?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)
+                      )?
+                      (?:\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?
+                    )
+                  \Z/x
+
+    INT_RESULT = {
+      n: 1,
+      o: -1,
+      s: 0
+    }.freeze
+
+    MAPPING_TABLE = [
+      %w[n[nso]{2} n],
+      %w[sn[nso]{1} n],
+      %w[ssn n],
+      %w[o[nso]{2} o],
+      %w[so[nso]{1} o],
+      %w[sso o],
+      %w[sss s]
+    ].freeze
+
+    ORDER = %i[major minor patch prerelease].freeze
+
+    attr_reader :version
+
+    def initialize(version)
+      @version = prepare_version(version)
+    end
+
+    def <=>(other)
+      return nil unless other.is_a? Compare
+
+      comparison(other)
+    end
+
+    def !=(other)
+      [-1, 1].include?(self.<=>(other))
+    end
+
+    def to_s
+      @version[:semver]
+    end
+
+    private
+
+    def comparison(other)
+      comparison = ORDER.take(3).map do |part|
+        if @version[part] == other.version[part]
+          "s"
+        elsif @version[part] > other.version[part]
+          "n"
+        else
+          "o"
+        end
+      end.join
+      prerelease_sort(other, comparison)
+    end
+
+    def prerelease_sort(other, comparison)
+      v_pre = @version[:prerelease].nil? ? "" : @version[:prerelease]
+      o_pre = other.version[:prerelease].nil? ? "" : other.version[:prerelease]
+      version_compare = match(comparison)
+      if version_compare.zero?
+        sorted = [v_pre, o_pre].sort.reverse
+        if (v_pre == sorted.last && v_pre != o_pre && v_pre != "") || (v_pre != "" && o_pre == "")
+          -1
+        elsif (v_pre == sorted.first && v_pre != o_pre) || (v_pre == "" && o_pre != "")
+          1
+        else
+          0
+        end
+      else
+        version_compare
+      end
+    end
+
+    def match(comparison)
+      result = MAPPING_TABLE.map do |m|
+        m[1] if comparison.match?(/\A#{m[0]}\Z/)
+      end.compact
+
+      raise "Too many results" if result.length > 1
+
+      INT_RESULT[result.first.to_sym]
+    end
+
+    def prepare_version(version)
+      version = version.match(SEMVER_PATTERN)
+      raise ArgumentError, "No proper Semantic Versioning given" if version.nil?
+
+      version = version.named_captures.transform_keys(&:to_sym)
+      # convert major, minor and patch to int
+      ORDER.take(3).each { |part| version[part] = version[part].to_i }
+      version
+    end
+  end
+end

data/sig/semver_check.rbs

@@ -0,0 +1,4 @@
+module SemverCheck
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: semver_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PuLLi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-25 00:00:00.000000000 Z
+dependencies: []
+description: Fun project to compare two SemVer strings with a bit of regex magic.
+email:
+- the@pulli.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/semver_check.rb
+- lib/semver_check/version.rb
+- sig/semver_check.rbs
+homepage: https://github.com/the-pulli/semver_check
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/the-pulli/semver_check
+  source_code_uri: https://github.com/the-pulli/semver_check
+  changelog_uri: https://github.com/the-pulli/semver_check/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Little gem to compare two SemVer strings.
+test_files: []