semver-string 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab6e9b795fc2232aac580c9c5950f6e9091e663c5675bc30c264f599c7a0bac2
+  data.tar.gz: 83c393f0951e5b8ea6980ef15f8036ae634242c26c34e6a1cb262f01e659266b
+SHA512:
+  metadata.gz: 0eef77d8973cf20c4932f1b4229d4272003bd9e4544aed31c38ed7d4fe699267f57c802ac5469eb71019ee1c3b313d0a517d4c3be7c2a60803e22882e276e72c
+  data.tar.gz: 1e5a5e8397e88f216f2fab1c995b77e5d6cd94d7e74aebaeddcba1830af55e03ecbf2b0db7bee5499bf41ead906de8f20f3742d8280b6a1e6d5b07b47879dfed

data/lib/semver-string.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'semver/string'

data/lib/semver/comparator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Semver
+  # @api private
+  class Comparator
+
+    # @param [Semver::String] left
+    # @param [Semver::String] right
+    def compare(left:, right:)
+      parts(left) <=> parts(right)
+    end
+
+    def parts(semver)
+      [semver.major, semver.minor, semver.patch] + pre_release(semver)
+    end
+
+    def pre_release(semver)
+      if semver.pre_release
+        [-1] + pre_release_identifiers(semver)
+      else
+        [1]
+      end
+    end
+
+    def pre_release_identifiers(semver)
+      semver.pre_release.split('.').map { |value| Identifier.new(value) }
+    end
+
+  end
+end

data/lib/semver/identifier.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Semver
+  # @api private
+  class Identifier
+
+    # @param [String, Integer] value
+    def initialize(value)
+      @value = value
+    end
+
+    # @return [String, Integer]
+    attr_reader :value
+
+    # @return [Integer] Returns -1, 0, or 1.
+    def <=>(other)
+      if other.value.is_a?(value.class)
+        value <=> other.value
+      elsif value.is_a?(Integer)
+        -1
+      else
+        1
+      end
+    end
+
+    # @param [String] value
+    def self.new(value)
+      identifier = allocate
+      identifier.send(:initialize, value =~ /^\d+$/ ? value.to_i : value)
+      identifier
+    end
+
+  end
+end

data/lib/semver/invalid_format_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Semver
+  # Thrown when parsing a string that is not valid
+  # [semver 2.0](https://semver.org/spec/v2.0.0.html).
+  class InvalidFormatError < StandardError
+
+    def initialize(value)
+      msg = 'invalid format, expected semver string, e.g. ' \
+        + '1.2.3, 1.2.3-rc.1, 1.2.3.alpha+1234567890, got :' \
+        + value.inspect
+      super(msg)
+    end
+
+  end
+end

data/lib/semver/parser.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Semver
+  # @api private
+  class Parser
+
+    PATTERN = %r{^
+      (0|[1-9]\d*)\. # major
+      (0|[1-9]\d*)\. # minor
+      (0|[1-9]\d*)   # patch
+      (-             # pre release
+        (0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)
+        (\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*
+      )?
+      (\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)? # build metadata
+    $}x
+
+    def parse(string)
+      matches = PATTERN.match(string.to_s)
+      raise InvalidFormatError, string unless matches
+      {
+        major: matches[1].to_i,
+        minor: matches[2].to_i,
+        patch: matches[3].to_i,
+        pre_release: left_chop(matches[4]),
+        build_metadata: left_chop(matches[8]),
+      }
+    end
+
+    private
+
+    def left_chop(value)
+      value ? value[1..-1] : nil
+    end
+
+  end
+end

data/lib/semver/string.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative 'comparator'
+require_relative 'identifier'
+require_relative 'invalid_format_error'
+require_relative 'parser'
+
+module Semver
+  # A helper class for working with semantic versioning strings.
+  #
+  # ~~~
+  # version = Semver::String.new('1.2.3-alpha+build-123')
+  #
+  # version.major #=> 1
+  # version.major #=> 2
+  # version.patch #=> 3
+  # version.pre_release #=> alpha
+  # version.build_metadata #=> build-123
+  # version.to_s #=> "1.2.3-alpha+build-123"
+  # ~~~
+  class String
+
+    # @param [String] string
+    # @return [Version]
+    def self.parse(string)
+      semver = allocate
+      semver.send(:initialize, Parser.new.parse(string))
+      semver
+    end
+
+    # @param [Integer] major
+    # @param [Integer] minor
+    # @param [Integer] patch
+    # @param [String,nil] pre_release
+    # @param [String,nil] build_metadata
+    def initialize(
+      major:,
+      minor:,
+      patch:,
+      pre_release: nil,
+      build_metadata: nil
+    )
+      @major = major
+      @minor = minor
+      @patch = patch
+      @pre_release = pre_release
+      @build_metadata = build_metadata
+      @string = format_string
+    end
+
+    # @return [Integer]
+    attr_reader :major
+
+    # @return [Integer]
+    attr_reader :minor
+
+    # @return [Integer]
+    attr_reader :patch
+
+    # @return [String, nil]
+    attr_reader :pre_release
+
+    # @return [String, nil]
+    attr_reader :build_metadata
+
+    # @return [String]
+    def to_str
+      @string
+    end
+    alias to_s to_str
+
+    # @return [Boolean]
+    # @api private
+    def eql?(other)
+      if other.is_a?(Semver::String)
+        to_str == other.to_str
+      else
+        false
+      end
+    end
+
+    # @return [Boolean] Returns `true` if the string value of the
+    #   two objects are equal.
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    # See section #11 of https://semver.org/spec/v2.0.0.html
+    # @return [Integer] Returns -1, 0, or 1.
+    def <=>(other)
+      Comparator.new.compare(left: self, right: other)
+    end
+
+    private
+
+    def format_string
+      string = [major, minor, patch].join('.')
+      string += "-#{pre_release}" if pre_release
+      string += "+#{build_metadata}" if build_metadata
+      string
+    end
+
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: semver-string
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- The Incognito Coder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-20 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- theincognitocoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/semver-string.rb
+- lib/semver/comparator.rb
+- lib/semver/identifier.rb
+- lib/semver/invalid_format_error.rb
+- lib/semver/parser.rb
+- lib/semver/string.rb
+homepage: https://github.com/theincognitocoder/semver-string
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/theincognitocoder/semver-string/issues
+  changelog_uri: https://github.com/theincognitocoder/semver-string/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/github/theincognitocoder/semver-string/master
+  homepage_uri: https://github.com/theincognitocoder/semver-string
+  mailing_list_uri: https://gitter.im/theincognitocoder/semver-string
+  source_code_uri: https://github.com/theincognitocoder/semver-string
+  wiki_uri: https://github.com/theincognitocoder/semver-string/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Semver v2.0 version strings in Ruby.
+test_files: []