semver_check 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a788698d2408013afa250c7bb1b15d6db802abecb51d4809c4a71952c90da500
-  data.tar.gz: a46a370c61e3470815ceeb7ddefc1f8049c17b83feaec5829fdd4aa6fb3e2cd8
+  metadata.gz: c0beaf52c8261fbe56e672991ce08cfe4fb7ec93da4cdb6f18f729e3d9ccd9bb
+  data.tar.gz: ecec76c30f606258d7c5544587409b46bb89b4743fd3e94cb0787205062c43a6
 SHA512:
-  metadata.gz: 4cfb9ba6a08f638cf26338ed6e1e499d655d155d278c51b13edba1a6eb4c2520cf2aff422e67f5220676dd650c5da4a6de71320cbb39b38ffc4a845c6d5fe561
-  data.tar.gz: c48338806955d42f6ed67d32bebb5a924aa567d9fbb82682a176e66350341e6982c9c12f844f1aaa327836e35ecc6021c43b65062ad2ff664af5fc2740e0db4c
+  metadata.gz: d353ba6864a640cb0b2de68bcc85374709b210488455ac903022557df8b746e1d23d38b51cea78ca62bcf3205a5f52906c308914f4f7364c7bdd00bfe3d012f0
+  data.tar.gz: b305f2fac503a4d9273a928a73cb1f39804ed654012de7223ff6e5ec3a9a34ad75f76770235439b62e3da3095c660a01e739c65c020980762d509928322e0975

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.1] - [0.1.4] - 2022-12-26
+
+- Small performance improvements
+
 ## [0.1.0] - 2022-12-25
 
 - Initial release

data/README.md

@@ -1,6 +1,6 @@
 # SemverCheck
 
-TODO: Delete this and the text above, and describe your gem
+A simple gem containing one class `SemverCheck::Compare` to compare SemVer strings.
 
 ## Installation
 
@@ -14,7 +14,19 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+The Compare class includes the Comparable module, so all methods from there and in addition != are available.
+
+```ruby
+SemverCheck::Compare.new("1.2.3") < SemverCheck::Compare.new("1.2.4") # true
+SemverCheck::Compare.new("1.2.3") > SemverCheck::Compare.new("1.2.2") # true
+SemverCheck::Compare.new("1.2.3") <= SemverCheck::Compare.new("1.2.3") # true
+SemverCheck::Compare.new("1.2.3") >= SemverCheck::Compare.new("1.2.3") # true
+# works also with prerelease
+SemverCheck::Compare.new("1.2.3-alpha") < SemverCheck::Compare.new("1.2.3-beta") # true
+SemverCheck::Compare.new("1.2.3-alpha.2") > SemverCheck::Compare.new("1.2.3-alpha.1") # true
+```
+
+You get the idea. If you wanna know more check out the [test/test_compare.rb](https://github.com/the-pulli/semver_check/blob/main/test/test_compare.rb) file.
 
 ## Development
 
@@ -24,7 +36,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/semver_check.
+Bug reports and pull requests are welcome on GitHub at https://github.com/the-pulli/semver_check.
 
 ## License
 

data/lib/semver_check/version.rb

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

data/lib/semver_check.rb

@@ -23,16 +23,16 @@ module SemverCheck
                   \Z/x
 
     MAPPING_TABLE = [
-      %w[n 1],
-      %w[sn 1],
-      %w[ssn 1],
-      %w[o -1],
-      %w[so -1],
-      %w[sso -1],
-      %w[sss 0]
+      ["n", 1],
+      ["sn", 1],
+      ["ssn", 1],
+      ["o", -1],
+      ["so", -1],
+      ["sso", -1],
+      ["sss", 0]
     ].freeze
 
-    ORDER = %i[major minor patch prerelease].freeze
+    VERSION_PARTS = %i[major minor patch].freeze
 
     attr_reader :version
 
@@ -57,7 +57,7 @@ module SemverCheck
     private
 
     def comparison(other)
-      comparison = ORDER.take(3).map do |part|
+      comparison = VERSION_PARTS.map do |part|
         if @version[part] == other.version[part]
           "s"
         elsif @version[part] > other.version[part]
@@ -106,7 +106,7 @@ module SemverCheck
     def match(comparison)
       MAPPING_TABLE.find do |m|
         comparison.start_with?(m.first)
-      end.last.to_i
+      end.last
     end
 
     def prepare_version(version)
@@ -115,7 +115,7 @@ module SemverCheck
 
       version = version.named_captures.transform_keys(&:to_sym)
       # convert major, minor and patch to int
-      ORDER.first(3).each { |part| version[part] = version[part].to_i }
+      VERSION_PARTS.each { |part| version[part] = version[part].to_i }
       version
     end
   end

data/semver_check.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/semver_check/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "semver_check"
+  spec.version = SemverCheck::VERSION
+  spec.authors = ["PuLLi"]
+  spec.email = ["the@pulli.dev"]
+
+  spec.summary = "Little gem to compare two SemVer strings."
+  spec.description = "Fun project to compare two SemVer strings with a bit of regex magic."
+  spec.homepage = "https://github.com/the-pulli/semver_check"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/the-pulli/semver_check"
+  spec.metadata["changelog_uri"] = "https://github.com/the-pulli/semver_check/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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semver_check
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - PuLLi
@@ -24,6 +24,7 @@ files:
 - Rakefile
 - lib/semver_check.rb
 - lib/semver_check/version.rb
+- semver_check.gemspec
 - sig/semver_check.rbs
 homepage: https://github.com/the-pulli/semver_check
 licenses:
@@ -32,7 +33,7 @@ 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
+  changelog_uri: https://github.com/the-pulli/semver_check/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: