semverly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea5a5be7cba05dc9e3324dbddfbd6335fba33eb2
+  data.tar.gz: ba3de76ced529808388e3fab10cc9822a569aa6d
+SHA512:
+  metadata.gz: 4251076bd8a77b7d1f7bdc05183522e2421d0a5c69fa0331fc1239325d8a2c038041d201c77c0564d88d9095efdfc32eab527fb6a9e33c2a8fcf128d39f71579
+  data.tar.gz: 850412ea9b74f49c75301a03055a272bb533d9a021ea72ff6892a1f75f6a513122a4d952ec34c8b01b60d0aac2f5ec86eb53f1b0b161811d4fa86e9cabdfd98e

data/lib/semverly.rb

@@ -0,0 +1 @@
+require 'semverly/sem_ver'

data/lib/semverly/sem_ver.rb

@@ -0,0 +1,115 @@
+# The SemVer class provides parsing and sorting for version strings that
+# comply with the {Semantic Versioning 2.0.0}[http://semver.org/] specification.
+class SemVer
+  include Comparable
+
+  # The major version (_x_ in +x.y.z+).
+  attr_accessor :major
+
+  # The minor version (_y_ in +x.y.z+).
+  attr_accessor :minor
+
+  # The patch version (_z_ in +x.y.z+).
+  attr_accessor :patch
+
+  # Pre-release version tag (optional).
+  attr_accessor :prerelease
+
+  # Version metadata (optional).
+  attr_accessor :metadata
+
+  # Creates a new SemVer instance.
+  #
+  # Initialization requires at least one argument: the major version number.
+  # The minor and patch versions are optional and are +0+ if not supplied. The
+  # prerelease and metadata parts are also optional and blank if not supplied.
+  def initialize(major, minor = 0, patch = 0, prerelease = nil, metadata = nil)
+    self.major = major
+    self.minor = minor
+    self.patch = patch
+    self.prerelease = prerelease
+    self.metadata = metadata
+  end
+
+  # Parses a SemVer-compliant string into its component parts.
+  #
+  # @param string [String] the version identifier to parse
+  # @return [SemVer] A +SemVer+ instance or +nil+ if the string is not SemVer compliant.
+  def self.parse(string)
+    re = Regexp.new('\Av?(?<major>\d+)
+                         (\.(?<minor>\d+))?
+                         (\.(?<patch>\d+))?
+                         (-(?<prerelease>[0-9A-Za-z.-]+))?
+                         (\+(?<metadata>[0-9A-Za-z.-]+))?\z', Regexp::EXTENDED)
+    matches = re.match(string)
+    return nil if matches.nil?
+
+    major = matches['major'].to_i
+    minor = matches['minor'].to_i
+    patch = matches['patch'].to_i
+
+    if prerelease = matches['prerelease']
+      return nil if prerelease.split('.').any? { |part| part.nil? || part == '' }
+    end
+
+    if metadata = matches['metadata']
+      return nil if metadata.split('.').any? { |part| part.nil? || part == '' }
+    end
+
+    new(major, minor, patch, prerelease, metadata)
+  end
+
+  # Generates a version string from SemVer parts.
+  #
+  # @return [String] The version identifier.
+  def to_s
+    s = "#{major}.#{minor}.#{patch}"
+    s << "-#{prerelease}" unless prerelease.nil?
+    s << "+#{metadata}" unless metadata.nil?
+    s
+  end
+
+  # Compares two SemVer versions.
+  #
+  # @param other [SemVer] another +SemVer+ instance to compare with the receiver
+  # @return [Fixnum] -1, 0 or +1 depending on if this instance is less than, equal to or greater than +other+.
+  def <=>(other)
+    result = [self.major, self.minor, self.patch] <=> [other.major, other.minor, other.patch]
+    result = compare_prerelease(other) if result == 0
+    result
+  end
+
+  private
+
+  def compare_prerelease(other)
+    return 0 if prerelease.nil? && other.prerelease.nil?
+    return -1 if other.prerelease.nil?
+    return 1 if prerelease.nil?
+
+    my_parts = prerelease.split('.')
+    other_parts = other.prerelease.split('.')
+
+    loop do
+      my_part = my_parts.shift
+      other_part = other_parts.shift
+
+      return 0 if my_part.nil? && other_part.nil?
+      return -1 if my_part.nil?
+      return 1 if other_part.nil?
+
+      mine_numeric = my_part =~ /\A\d+\z/
+      other_numeric = other_part =~ /\A\d+\z/
+      if mine_numeric && other_numeric
+        result = my_part.to_i <=> other_part.to_i
+        return result unless result == 0
+      elsif mine_numeric
+        return -1
+      elsif other_numeric
+        return 1
+      else
+        result = my_part <=> other_part
+        return result unless result == 0
+      end
+    end
+  end
+end

data/spec/sem_ver_spec.rb

@@ -0,0 +1,253 @@
+shared_examples 'parsing' do
+  context 'without pre-release or metadata' do
+    context 'with major, minor and patch' do
+      subject { SemVer.parse("#{prefix}1.2.3") }
+
+      it 'has major version 1' do
+        expect(subject.major).to eq(1)
+      end
+
+      it 'has minor version 2' do
+        expect(subject.minor).to eq(2)
+      end
+
+      it 'has patch version 3' do
+        expect(subject.patch).to eq(3)
+      end
+    end
+
+    context 'without patch' do
+      subject { SemVer.parse("#{prefix}1.2") }
+
+      it 'has major version 1' do
+        expect(subject.major).to eq(1)
+      end
+
+      it 'has minor version 2' do
+        expect(subject.minor).to eq(2)
+      end
+
+      it 'has patch version 0' do
+        expect(subject.patch).to eq(0)
+      end
+    end
+
+    context 'without minor or patch' do
+      subject { SemVer.parse("#{prefix}1") }
+
+      it 'has major version 1' do
+        expect(subject.major).to eq(1)
+      end
+
+      it 'has minor version 0' do
+        expect(subject.minor).to eq(0)
+      end
+
+      it 'has patch version 0' do
+        expect(subject.patch).to eq(0)
+      end
+    end
+  end
+
+  context 'with pre-release' do
+    subject { SemVer.parse("#{prefix}1.2.3-beta.1")}
+
+    it 'has major version 1' do
+      expect(subject.major).to eq(1)
+    end
+
+    it 'has minor version 2' do
+      expect(subject.minor).to eq(2)
+    end
+
+    it 'has patch version 3' do
+      expect(subject.patch).to eq(3)
+    end
+
+    it 'has pre-release beta.1' do
+      expect(subject.prerelease).to eq('beta.1')
+    end
+  end
+
+  context 'with metadata' do
+    subject { SemVer.parse("#{prefix}1.2.3+abc123")}
+
+    it 'has major version 1' do
+      expect(subject.major).to eq(1)
+    end
+
+    it 'has minor version 2' do
+      expect(subject.minor).to eq(2)
+    end
+
+    it 'has patch version 3' do
+      expect(subject.patch).to eq(3)
+    end
+
+    it 'has metadata abc123' do
+      expect(subject.metadata).to eq('abc123')
+    end
+  end
+
+  context 'with pre-release and metadata' do
+    subject { SemVer.parse("#{prefix}1.2.3-beta.1+abc123")}
+
+    it 'has major version 1' do
+      expect(subject.major).to eq(1)
+    end
+
+    it 'has minor version 2' do
+      expect(subject.minor).to eq(2)
+    end
+
+    it 'has patch version 3' do
+      expect(subject.patch).to eq(3)
+    end
+
+    it 'has pre-release beta.1' do
+      expect(subject.prerelease).to eq('beta.1')
+    end
+
+    it 'has metadata abc123' do
+      expect(subject.metadata).to eq('abc123')
+    end
+  end
+end
+
+describe SemVer do
+  describe '.new' do
+    subject { SemVer.new(1) }
+
+    it 'has major version 1' do
+      expect(subject.major).to eq(1)
+    end
+
+    it 'has minor version 0' do
+      expect(subject.minor).to eq(0)
+    end
+
+    it 'has minor version 0' do
+      expect(subject.patch).to eq(0)
+    end
+
+    it 'is not a pre-release' do
+      expect(subject.prerelease).to be_nil
+    end
+
+    it 'has no metadata' do
+      expect(subject.metadata).to be_nil
+    end
+  end
+
+  describe '.parse' do
+    context 'with a version prefix' do
+      let(:prefix) { 'v' }
+      include_examples 'parsing'
+    end
+
+    context 'without a version prefix' do
+      let(:prefix) { '' }
+      include_examples 'parsing'
+    end
+
+    context 'with a non-SemVer compliant string' do
+      {
+        'non-numeric major, minor and patch parts' => 'a.b.c',
+        'invalid characters in pre-release' => '1.2.3-this/that',
+        'blank identifier in pre-release' => '1.2.3-this..that',
+        'invalid characters in metadata' => '1.2.3+this/that',
+        'blank identifier in metadata' => '1.2.3+this..that'
+      }.each do |description, string|
+        it "returns nil with #{description}" do
+          expect(SemVer.parse(string)).to be_nil
+        end
+      end
+    end
+  end
+
+  describe '#to_s' do
+    context 'without pre-release or metadata' do
+      it 'returns a properly formatted string' do
+        semver = SemVer.new(1, 2, 3)
+        expect(semver.to_s).to eq('1.2.3')
+      end
+    end
+
+    context 'with pre-release' do
+      it 'returns a properly formatted string' do
+        semver = SemVer.new(1, 2, 3, 'beta')
+        expect(semver.to_s).to eq('1.2.3-beta')
+      end
+    end
+
+    context 'with metadata' do
+      it 'returns a properly formatted string' do
+        semver = SemVer.new(1, 2, 3, nil, 'abc123')
+        expect(semver.to_s).to eq('1.2.3+abc123')
+      end
+    end
+
+    context 'with pre-release and metadata' do
+      it 'returns a properly formatted string' do
+        semver = SemVer.new(1, 2, 3, 'beta', 'abc123')
+        expect(semver.to_s).to eq('1.2.3-beta+abc123')
+      end
+    end
+  end
+
+  describe 'sorting' do
+    it 'sorts the major version numerically' do
+      first = SemVer.new(1)
+      second = SemVer.new(2)
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'sorts the minor version numerically' do
+      first = SemVer.new(1, 1)
+      second = SemVer.new(1, 2)
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'sorts the patch version numerically' do
+      first = SemVer.new(1, 1, 1)
+      second = SemVer.new(1, 1, 2)
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'sorts pre-release versions before release' do
+      first = SemVer.new(1, 0, 0, 'beta')
+      second = SemVer.new(1, 0, 0)
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'sorts pre-release parts with only digits numerically' do
+      first = SemVer.new(1, 0, 0, 'beta.2')
+      second = SemVer.new(1, 0, 0, 'beta.10')
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'sorts pre-release parts with letters lexically' do
+      first = SemVer.new(1, 0, 0, 'alpha')
+      second = SemVer.new(1, 0, 0, 'beta')
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'sorts numeric pre-release parts before non-numeric' do
+      first = SemVer.new(1, 0, 0, 'alpha.1')
+      second = SemVer.new(1, 0, 0, 'alpha.beta')
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'sorts fewer pre-release parts before more' do
+      first = SemVer.new(1, 0, 0, 'alpha')
+      second = SemVer.new(1, 0, 0, 'alpha.1')
+      expect(first <=> second).to eq(-1)
+    end
+
+    it 'does not consider metadata when sorting' do
+      first = SemVer.new(1, 0, 0, nil, 'foo')
+      second = SemVer.new(1, 0, 0, nil, 'bar')
+      expect(first <=> second).to eq(0)
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: semverly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Parses and compares version strings that comply with Semantic Versioning
+  2.0 (http://semver.org/)
+email: steve@lightyearsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/semverly/sem_ver.rb
+- lib/semverly.rb
+- spec/sem_ver_spec.rb
+homepage: http://github.com/lightyear/semverly
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Semantic Versioning parsing and comparison
+test_files:
+- spec/sem_ver_spec.rb
+has_rdoc: