versus 0.1.0

data/.index

@@ -0,0 +1,45 @@
+---
+type: ruby
+revision: 2013
+sources:
+- Index.yml
+authors:
+- name: trans
+  email: transfire@gmail.com
+- name: postmodern
+  website: http://trans.github.com
+organizations: []
+requirements:
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: homepage
+  uri: http://dotruby.github.com
+  label: Homepage
+- type: source
+  uri: http://github.com/dotruby/version
+  label: Source Code
+repositories: []
+categories: []
+paths:
+  load:
+  - lib
+copyrights:
+- holder: Rubyworks
+  year: 2011
+  license: BSD-2-Clause
+name: versus
+title: Versus
+version: 0.1.0
+summary: Best-of-breed Version Class Library
+description: The Versus gem provides a solid Version class along with supporting functionality,
+  such as version constratints and version dependency resolution.
+date: '2013-01-05'

data/.yardopts

@@ -0,0 +1,7 @@
+--title Versus
+--output-dir doc
+--private
+--protected
+lib/
+-
+[A-Z]*.md

data/HISTORY.md

@@ -0,0 +1,11 @@
+# RELEASE HISTORY
+
+## 0.1.0 / 2013-01-05
+
+While the code is beening sitting around on my hard drive for nearly
+a year, finally, yes finally, we have settled on a gem name to release
+it under.
+
+Changes:
+
+* Finally a first release.

data/Index.yml

@@ -0,0 +1,37 @@
+---
+name:
+  versus
+
+version:
+  0.1.0
+
+title:
+  Versus
+
+summary: 
+  Best-of-breed Version Class Library
+
+description:
+  The Versus gem provides a solid Version class along with supporting
+  functionality, such as version constratints and version dependency
+  resolution.
+
+requirements:
+  - qed (test)
+  - ae  (test)
+
+authors:
+  - name: trans
+    email: transfire@gmail.com
+  - name: postmodern
+    website: 'http://trans.github.com'
+
+resources:
+  homepage: http://dotruby.github.com
+  source: http://github.com/dotruby/version
+
+copyrights: 
+  - year: 2011
+    holder: Rubyworks
+    license: BSD-2-Clause
+

data/LICENSE.txt

@@ -0,0 +1,23 @@
+BSD-2-Clause License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,46 @@
+[Homepage](http://rubyworks.github.com/versus) /
+[Report Issue](http://github.com/rubyworks/versus) /
+[Source Code](http://github.com/rubyworks/versus)
+( )
+
+
+# [Versus](http://rubyworks.github.com/versus)
+
+*A Best-of-Breed Version Class Library*
+
+The Versus gem is a best-of-breed Version class library, providing classes
+for a number of version related requirements, form `Version::Number` to
+`Version::Resolution`.
+
+
+## Overview
+
+The primary class of the Versus gem is the `Version::Number` class. It does
+exactly what one would expect, by taking a version literal and giving it a
+versitle interface to query and manipulate.
+
+```ruby
+    v = Version::Number.new('1.2.0')
+    v.major  #=> 1
+    v.minor  #=> 2
+    v.patch  #=> 0
+```
+
+
+## Documentation
+
+Versus uses QED to provided tested [demonstrations](http://). This provides a end-user 
+acceptance testing while also providing very readable documentation.
+
+For API documentation checkout the YARD generated docs at [RubyDoc.Info](http://rubydoc.info/gems/versus/frames).
+
+
+## Copyrights
+
+Versus is copyrighted open source software.
+
+    Copyright 2011 Rubyworks
+
+Versus can be modified and redistributed in accordance with the
+[BSD-2-Clause](http://spdx.org/licenses/bsd-2-clause) License.
+

data/demo/applique/ae.rb

@@ -0,0 +1,5 @@
+require 'ae'
+require 'ae/should'
+require 'ae/check'
+
+include AE::Check

data/demo/applique/main.rb

@@ -0,0 +1 @@
+require 'versus'

data/demo/constraint/02_initialize.md

@@ -0,0 +1,44 @@
+## Version::Constraint#initialize
+
+The Constraint class models a single version equality
+or inequality. It consists of the operator and the version
+number.
+
+    c = Version::Constraint.new(['>=', '1.0'])
+
+    c.operator == '>='
+    c.number   == '1.0'
+
+### Using []
+
+    c = Version::Constraint['>=', '1.0']
+
+    c.operator == '>='
+    c.number   == '1.0'
+
+### String Parsing
+
+The constraint constructor can also parse strings.
+
+    check do |mp|
+      mp.each do |str, (op, num)|
+        c = Version::Constraint.new(str)
+        c.operator.should    == op
+        c.number.to_s.should == num
+      end
+    end
+
+    ok '1.2.3'    => ['==', '1.2.3']
+    ok '= 4.6.2'  => ['==', '4.6.2']
+    ok '== 5.1.1' => ['==', '5.1.1']
+    ok '>= 2.3.4' => ['>=', '2.3.4']
+    ok '> 3.4.5'  => ['>',  '3.4.5']
+    ok '<= 2.3.4' => ['<=', '2.3.4']
+    ok '< 3.4.5'  => ['<',  '3.4.5']
+
+Suffix notations are also parsable.
+
+    ok '1.2+'     => ['>=', '1.2']
+    ok '1.3-'     => ['<' , '1.3']
+    ok '2.8~'     => ['=~', '2.8']
+

data/demo/constraint/04_to_proc.md

@@ -0,0 +1,11 @@
+## Version::Constraint#to_proc
+
+A version constraint object can be converter into a Proc object
+for making version comparisions.
+
+    cv = Version::Constraint['>', '1.0.0']
+    cp = cv.to_proc
+
+    cp.call('1.1.1')  #=> true
+
+

data/demo/constraint/09_to_gem_version.md

@@ -0,0 +1,10 @@
+## Version#to_gem_version
+
+Since RubyGems supporst a more limited version constrain format, the
+Constraint class provides the `#to_gem_version` method to produce
+a string representation of the constraint that RubyGems can understand.
+
+    version = Version::Constraint.parse('1.2~')
+
+    version.to_gem_version.should == "~> 1.2"
+

data/demo/number/02_initialize.md

@@ -0,0 +1,14 @@
+## Version::Number#initialize
+
+A version number is composed of segments.
+
+    v = Version::Number.new(1,2,3,'alpha',4)
+
+There a few alternative initializers. The most consice is [].
+
+    v = Version::Number[1,2,3,'beta',4]
+
+The #new constructor can also take a string representation of the version.
+
+    v = Version::Number.new('1.2.3rc1')
+

data/demo/number/03_parse.md

@@ -0,0 +1,23 @@
+## Version::Number.parse
+
+The `parse` method ...
+
+A String
+
+    v = Version::Number.parse('1.2.3')
+
+    v.to_s.assert == '1.2.3'
+
+An Array
+
+    v = Version::Number.parse([1,2,3])
+
+    v.to_s.assert == '1.2.3'
+
+Another Version::Number object
+
+    v1 = Version::Number.parse('2.5.6')
+    v2 = Version::Number.parse(v1)
+
+    v2.to_s.assert == '2.5.6'
+

data/demo/number/04_crush.md

@@ -0,0 +1,17 @@
+## Version::Number#crush?
+
+A version can be represented as a string in one of two ways --either
+as a strict point seprated tuple or *crushed* where string segements
+are merged with the following numerical segement.
+
+The Version::Number class will automatically reqcognize a *crushed*
+version if a segment of the version tuple is provided as such.
+
+    v = Version::Number.new(1,2,3,'alpha4')
+
+    v.assert.crush?
+
+The output result of a crushed version.
+
+    v.to_s.assert == '1.2.3alpha4'
+

data/demo/number/05_build.md

@@ -0,0 +1,23 @@
+## Version::Number#build
+
+The `build` method ...
+
+    v = Version::Number[1,2,3]
+
+    v.build.should == nil
+
+
+    v = Version::Number[1,2,3,'pre']
+
+    v.build.should == 'pre'
+
+
+    v = Version::Number[1,2,3,'pre',2]
+
+    v.build.should == 'pre.2'
+
+
+    v = Version::Number[1,2,3,'20101020']
+
+    v.build.should == '20101020'
+

data/demo/number/06_cmp.md

@@ -0,0 +1,100 @@
+## Version::Number#<=>
+
+The inclusion of Comparable mixin into the Version class
+along with the definition of #<=>, provides the class with
+all the common inequality methods.
+
+### Equality
+
+    check do |n1, n2|
+      v1 = Version::Number.parse(n1)
+      v2 = Version::Number.parse(n2)
+      v1 == v2
+    end
+
+    ok  '1.0.0', '1.0.0'
+    ok  '1.0.0', '1.0'
+
+### Greater-Than
+
+    check do |n1, n2|
+      v1 = Version::Number.parse(n1)
+      v2 = Version::Number.parse(n2)
+      v1 > v2
+    end
+
+    ok '1.0.1', '1.0.0'
+    ok '1.1.0', '1.0.0'
+    ok '2.0.0', '1.0.0'
+    ok '1.1',   '1.0.0'
+    ok '1.0.0', '1.0.0.rc.3'
+
+    no '1.0.0', '1.0.0'
+
+### Less-Than
+
+    check do |n1, n2|
+      v1 = Version::Number.parse(n1)
+      v2 = Version::Number.parse(n2)
+      v1 < v2
+    end
+
+    ok '1.0.1', '1.0.2'
+    ok '1.1.0', '1.2.0'
+    ok '2.0.0', '2.1.0'
+    ok '1.2.3', '2.0.0'
+    ok '1.2.3', '2.0'
+    ok '1.1',   '1.2.0'
+    ok '1.0.0.rc.2', '1.0.0'
+
+    no '1.0.0', '1.0.0'
+
+### Greater-Than-Or-Equal
+
+    check do |n1, n2|
+      v1 = Version::Number.parse(n1)
+      v2 = Version::Number.parse(n2)
+      v1 >= v2
+    end
+
+    ok '1.0.1', '1.0.0'
+    ok '1.1.0', '1.0.0'
+    ok '2.0.0', '1.0.0'
+    ok '1.1',   '1.0.0'
+    ok '1.0.0', '1.0.0.rc.3'
+    ok '1.0.0', '1.0.0'
+
+### Less-Than-Or-Equal
+
+    check do |n1, n2|
+      v1 = Version::Number.parse(n1)
+      v2 = Version::Number.parse(n2)
+      v1 <= v2
+    end
+
+    ok '1.0.1', '1.0.2'
+    ok '1.1.0', '1.2.0'
+    ok '2.0.0', '2.1.0'
+    ok '1.1',   '1.2.0'
+    ok '1.0.0', '1.0.0'
+
+    ok '1.0.0.rc.2', '1.0.0'
+
+### Approximate Constraint
+
+    check do |n1, n2|
+      v1 = Version::Number.parse(n1)
+      v2 = Version::Number.parse(n2)
+      v1 =~ v2
+    end
+
+    ok '1.0.0', '1.0'
+    ok '1.0.2', '1.0'
+    ok '2.1.1', '2.1'
+
+    no '1.1.0', '1.2.0'
+    no '1.1.0', '2.0'
+
+    # TODO: Should this be ok ?
+    no '1.0.0.rc.2', '1.0'
+

data/demo/number/07_segments.md

@@ -0,0 +1,51 @@
+## Version::Number Segments
+
+A version number is divided up into segements, or *points*.
+Some of the points have names. THe first three are widely known
+as the *major*, *minor* and *patch* numbers, respectively.
+
+    v = Version::Number[1,2,3]
+
+    v.major.assert == 1
+    v.minor.assert == 2
+    v.patch.assert == 3
+  
+The Version::Number class also recognizes state, or status.
+
+    v = Version::Number[1,2,3,'beta',4]
+
+    v.state.assert  == 'beta'
+    v.status.assert == 'beta'
+
+From the state on is considered the *build* portion of the version.
+
+    v.build.assert == 'beta.4'
+
+The *build number* is the number directly following the state.
+
+    v.build_number.assert == 4
+
+While it is not recommended, technically the Version::Number class
+can handle an arbitrarily long tuple.
+
+    v = Version::Number[1,2,3,4,5,6,'beta',7]
+
+    v.major.assert == 1
+    v.minor.assert == 2
+    v.patch.assert == 3
+
+    v.state.assert == 'beta'
+
+However, there are no recognized names for the segments between
+the third, patch entry and the state entry.
+
+Short version can also be used.
+
+    v = Version::Number[1,'rc',7]
+
+    v.major.assert == 1
+    v.minor.assert == nil
+    v.patch.assert == nil
+
+    v.state.assert == 'rc'
+