semi_semantic 1.0.0

data/README.md

@@ -0,0 +1,58 @@
+semi-semantic
+=============
+
+A Ruby library for parsing/formatting/comparing semi-semantic versions.
+
+### Why not just use Semantic Versioning?
+The purpose of this library is to _support, but not require_ semantic versioning.
+
+### How is this different than Semantic Versioning?
+Unlike SemVer, Semi-Semantic does not define exactly how it must be used. 
+
+Semi-Semantic...
+- Allows unlimited version segment components separated by periods (accessed by array index).
+    - Does not have named concept of 'major', 'minor', or 'patch' versions.
+- Supports underscores, to allow compatibility with ruby gem conventions and timestamps.
+
+### Usage
+
+```Ruby
+require 'semi_semantic/version'
+...
+version_string = '1.0.2-alpha.1+build.10'
+version = SemiSemantic::Version.parse(version_string)
+
+p version.release.to_s
+# '1.0.2'
+
+p version.pre_release.to_s
+# 'alpha.1'
+
+p version.post_release.to_s
+# 'build.10'
+
+# increment post-release number
+p SemiSemantic::Version.new(version.release, version.pre_release, version.post_release.increment)
+# '1.0.2-alpha.1+build.11'
+
+# increment pre-release number
+p SemiSemantic::Version.new(version.release, version.pre_release.increment)
+# '1.0.2-alpha.2'
+
+# increment release number
+p SemiSemantic::Version.new(version.release.increment)
+# '1.0.3'
+
+# increment 'major' release number
+p SemiSemantic::Version.new(version.release.increment(0))
+# '2.0.0'
+
+# increment 'minor' release number
+p SemiSemantic::Version.new(version.release.increment(1))
+# '1.1.0'
+
+# increment second most least significant release number
+p SemiSemantic::Version.new(version.release.increment(-2))
+# '1.1.0'
+
+```

data/lib/semi_semantic/parse_error.rb

@@ -0,0 +1,3 @@
+module SemiSemantic
+  class ParseError < StandardError; end
+end

data/lib/semi_semantic/version.rb

@@ -0,0 +1,73 @@
+require 'semi_semantic/parse_error'
+require 'semi_semantic/version_segment'
+
+module SemiSemantic
+  class Version
+    include Comparable
+
+    PRE_RELEASE_PREFIX = '-'
+    POST_RELEASE_PREFIX = '+'
+
+    attr_reader :release, :pre_release, :post_release, :segments
+
+    # Parses a semi-semantic version string into up to three segments
+    # Raises a ParseError if the string format is invalid
+    # Raises an ArgumentError if version_string is nil
+    def self.parse(version_string)
+      raise ArgumentError.new 'Invalid Version String: nil' if version_string.nil?
+      raise ArgumentError.new "Invalid Version String: '#{version_string}'" if version_string == ''
+      matches = /^(?<release>[0-9A-Za-z_\.]+)(\-(?<pre_release>[0-9A-Za-z_\-\.]+))?(\+(?<post_release>[0-9A-Za-z_\-\.]+))?$/.match(version_string)
+      raise ParseError.new "Invalid Version Format: '#{version_string}'" if matches.nil?
+
+      release = VersionSegment.parse matches[:release]
+      pre_release = nil
+      if matches[:pre_release]
+        pre_release = VersionSegment.parse matches[:pre_release]
+      end
+      post_release = nil
+      if matches[:post_release]
+        post_release = VersionSegment.parse matches[:post_release]
+      end
+      self.new(release, pre_release, post_release)
+    end
+
+    def initialize(release, pre_release=nil, post_release=nil)
+      raise ArgumentError.new 'Invalid Release: nil' if release.nil?
+      @release = release
+      @pre_release = pre_release
+      @post_release = post_release
+
+      @segments = [release]
+      @segments << pre_release unless pre_release.nil?
+      @segments << post_release unless post_release.nil?
+    end
+
+    def <=>(other)
+      result = (@release <=> other.release)
+      return result unless result == 0
+
+      unless @pre_release.nil? && other.pre_release.nil?
+        return 1 if @pre_release.nil?
+        return -1 if other.pre_release.nil?
+        result = (@pre_release <=> other.pre_release)
+        return result unless result == 0
+      end
+
+      unless @post_release.nil? && other.post_release.nil?
+        return -1 if @post_release.nil?
+        return 1 if other.post_release.nil?
+        result = (@post_release <=> other.post_release)
+        return result unless result == 0
+      end
+
+      0
+    end
+
+    def to_s
+      str = @release.to_s
+      str += PRE_RELEASE_PREFIX + @pre_release.to_s unless @pre_release.nil?
+      str += POST_RELEASE_PREFIX + @post_release.to_s unless @post_release.nil?
+      str
+    end
+  end
+end

data/lib/semi_semantic/version_segment.rb

@@ -0,0 +1,88 @@
+require 'semi_semantic/parse_error'
+
+module SemiSemantic
+  class VersionSegment
+    include Comparable
+
+    #TODO: immutable?
+    attr_reader :components
+
+    # Converts a string into a VersionCluster
+    # Raises a ParseError if the string format is invalid
+    # Raises an ArgumentError if version_string is nil
+    def self.parse(component_string)
+      raise ArgumentError.new 'Invalid Version Component String: nil' if component_string.nil?
+      self.new(component_string.split('.').map do |v|
+        if v.match(/\A[0-9]+\z/)
+          v.to_i
+        elsif v.match(/\A[0-9A-Za-z_\-]+\z/)
+          v
+        else
+          raise ParseError.new 'Invalid Version Component Format: Requires alphanumerics and hyphens only'
+        end
+      end)
+    end
+
+    # Construction can throw ArgumentError, but does no parsing or type-conversion
+    def initialize(components)
+      raise ArgumentError.new 'Invalid Version Components: nil' if components.nil?
+      raise ArgumentError.new "Invalid Version Components: #{components}" if components.empty? || components.include?('')
+      @components = components
+    end
+
+    def <=>(other)
+      a = @components
+      b = other.components
+      if a.size > b.size
+        comparison = a[0...b.size] <=> b
+        return comparison unless comparison == 0
+        a[b.size..-1].each {|v| return 1 unless v == 0 }
+        0
+      elsif a.size < b.size
+        comparison = a <=> b[0...a.size]
+        return comparison unless comparison == 0
+        b[a.size..-1].each {|v| return -1 unless v == 0 }
+        0
+      else
+        a <=> b
+      end
+    end
+
+    # Returns a copy of the VersionCluster with the integer at the provided index incremented by one.
+    # Raises a TypeError if the value at that index is not an integer.
+    def increment(index=-1)
+      value = @components[index]
+      raise TypeError.new "'#{value}' is not an integer" unless value.is_a? Integer
+
+      copy = Array.new @components
+      copy[index] = value + 1
+
+      while index < copy.size && index != -1
+        index += 1
+        value = copy[index]
+        if value.is_a? Integer
+          copy[index] = 0
+        end
+      end
+
+      self.class.new copy
+    end
+
+    # Returns a copy of the VersionCluster with the integer at the provided index decremented by one.
+    # Raises a TypeError if the value at that index is not an integer.
+    # Raises a RangeError if the value is zero or less
+    def decrement(index=-1)
+      value = @components[index]
+      raise TypeError.new "'#{value}' is not an integer" unless value.is_a? Integer
+      raise RangeError.new "'#{value}' is zero or less" unless value > 0
+
+      copy = Array.new @components
+      copy[index] = value - 1
+      self.class.new copy
+    end
+
+    def to_s
+      @components.join('.')
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: semi_semantic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pivotal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+description: ! 'Semi Semantic
+
+  120471'
+email: support@cloudfoundry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/semi_semantic/parse_error.rb
+- lib/semi_semantic/version.rb
+- lib/semi_semantic/version_segment.rb
+- README.md
+homepage: https://github.com/pivotal-cf-experimental/semi_semantic
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Semi Semantic
+test_files: []