VersionCheck 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2012-09-28
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/versioncheck.rb
+test/test_versioncheck.rb

data/README.txt

@@ -0,0 +1,77 @@
+= versioncheck
+
+* http://rubyforge.org/projects/versioncheck/
+
+== DESCRIPTION:
+
+VersionCheck is a ruby class provides tests against a packages  version 
+so we can determine if our code is running in the version we want
+or is running on a version later than the version we need.
+
+Special initializer, VersionCheck.rubyversion, sets up VersionCheck instance 
+we can use to check against current Ruby major,minor,update and patch level.
+
+== FEATURES/PROBLEMS:
+
+
+== SYNOPSIS:
+
+require 'rubygems'
+require 'versioncheck'
+vc = VersionCheck.new(major,minor,update,build)
+
+#to conditionally run code based on having exactly the version x,y
+if vc.have_version?(x,y)
+ ...
+end
+
+#to conditionally run code based on having at least the given version x,y
+if vc.have_at_least_version?(x,y)
+ ...
+end
+
+rb_vc = VersionCheck.rubyversion #Equivalent to VersionCheck.new with RubyVersion and patchlevel  as params
+#Check the ruby version is at least version 1.9
+if rb_vc.have_at_least_version?("1.9") 
+ ...
+end
+
+#Check the ruby version is at least version 1.8.6
+if rb_vc.have_at_least_version?("1.8.6") 
+ ...
+end
+
+
+
+== REQUIREMENTS:
+
+* require 'rubygems'
+
+== INSTALL:
+
+* sudo gem install versioncheck
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+#require './lib/versioncheck.rb'
+Hoe.plugin :minitest
+
+Hoe.spec 'VersionCheck' do 
+  self.rubyforge_name = 'versionchecker'
+  developer 'Rob Burrowes', 'r.burrowes@auckland.ac.nz'
+  #extra_deps << 'whatevs' 
+end
+

data/lib/versioncheck.rb

@@ -0,0 +1,110 @@
+#VersionCheck is a ruby class provides tests against a packages  version 
+#so we can determine if our code is running in the version we want
+#or is running on a version later than the version we need.
+#
+#Naming convention used:
+#  RUBY_VERSION 1.8.7 patch level 249
+#  is Rubyvesion.major = 1, VersionCheck.minor = 8, VersionCheck.update = 7
+#  VersionCheck.build = 249 or VersionCheck.patchlevel = 249
+#
+#Special initializer, VersionCheck.rubyversion, sets up VersionCheck instance 
+#we can use to check against current Ruby major,minor,update and patch level.
+
+class VersionCheck
+  VERSION = '1.0.0' #version of class VersionCheck
+  
+  attr_accessor :major, :minor, :update, :build
+  alias patchlevel build
+  
+  #Set up the version we are going to check against.
+  def initialize(major,minor=0,update=0,build=0)
+    if major.class == Float
+      major = major.to_s
+    end
+    if major.class == String
+      major,minor,update = major.split('.').collect { |x| x.to_i }
+    end
+    @major = major != nil ? major.to_i : 0
+    @minor = minor != nil ? minor.to_i : 0
+    @update = update != nil ? update.to_i : 0 
+    @build = build != nil ? build.to_i : 0
+  end    
+  
+  #Short cut to setting up VersionCheck against current RUBY_VERSION and RUBY_PATCHLEVEL
+  def self.rubyversion
+    major,minor,update = RUBY_VERSION.split('.').collect { |i| i.to_i }
+    self.new(major,minor,update, RUBY_PATCHLEVEL.to_i)
+  end
+  
+  #have_version tests that the versien of RUBY is the one we want.
+  #Returns true if match to arguments is exact, otherwise false.
+  #  If update and build are not specified, they are not tested for.
+  #Can take:
+  #  a single float argument. 
+  #   e.g. VersionCheck.have_version?(1.8)      Tests for version 1.8 with any update or build version
+  #  a single string argument. 
+  #   e.g. VersionCheck.have_version?("1")      Tests for version 1 with any minor, update or build version
+  #   e.g. VersionCheck.have_version?("1.8")    Tests for version 1.8 with any update or build version
+  #        VersionCheck.have_version?("1.8.7")  Tests for version 1.8.7 with and build version
+  #  Integer arguments major, minor, update and build
+  #   e.g. VersionCheck.have_version?(1)         Tests for version 1 with any minor, update or build version
+  #        VersionCheck.have_version?(1,8)       Tests for version 1.8 with any update or build version
+  #        VersionCheck.have_version?(1,8,7)     Tests for version 1.8.7 with and build version
+  #        VersionCheck.have_version?(1,8,7,249) Test for 1.8.7 build 249
+  def have_version?(major, minor = nil, update = nil, build = nil)
+    if major.class == Float
+      major = major.to_s
+    end
+    if major.class == String
+      major,minor,update = major.split('.').collect { |x| x.to_i }
+    end
+    if major == @major
+      return false if minor != nil && minor != @minor
+      return false if update != nil && update != @update
+      return false if build != nil && build !=  @build
+      return true
+    else
+      return false
+    end
+  end
+
+  #have_at_least_version tests that the versien of RUBY is newer than the one we want.
+  #major, minor, update and build are integers. 
+  #If update and or build are missing, then any update or build version
+  #will return true, as long as the major and minor numbers match, 
+  #or the running Ruby verion major.minor numbers are for a newer version.
+  def have_at_least_version?(major, minor = nil, update = nil, build = nil)
+    if major.class == Float
+      major = major.to_s
+    end
+    if major.class == String
+      major,minor,update = major.split('.').collect { |x| x.to_i }
+    end
+    if major == @major #Could true
+      if minor != nil #Being asked to test minor level
+        if minor == @minor #Could be true
+          if update != nil #Being asked to test update level
+            if update == @update #Could be true
+              if build != nil #Being asked to test the build version
+                return build <= @build #have at least the required patch level.
+              end
+              return true #update was equal
+            end
+            return update < @update #current version is newer
+          end
+          return true #major and minor was equal.
+        end
+        return minor < @minor #true if current version is newer
+      end
+      return true #major was equal.
+    end
+    return major < @major #true, if current version is newer
+  end
+
+  #to_s returns the current Ruby version and build as a string.
+  def to_s
+    "#{@major}.#{@minor}.#{@update} Build #{@build}"
+  end
+  
+  
+end

data/test/test_versioncheck.rb

@@ -0,0 +1,177 @@
+require 'rubygems'
+require 'minitest/autorun'
+require "versioncheck"
+
+#Self fulfilling prophecy
+CURRENT_VERSION_MAJOR, CURRENT_VERSION_MINOR, CURRENT_VERSION_UPDATE = RUBY_VERSION.split('.').collect { |i| i.to_i }
+CURRENT_VERSION_BUILD = RUBY_PATCHLEVEL.to_i
+
+#Easier to see what is going wrong if tests run in order. There is no order interaction possible anyway
+MiniTest::Unit::TestCase.i_suck_and_my_tests_are_order_dependent!
+puts MiniTest::Unit::TestCase.test_order #Tests run in alpha order, which is why the have A. and 1. markers in the lines
+
+describe VersionCheck do
+  
+  before do
+    @rubyversion = VersionCheck.new(CURRENT_VERSION_MAJOR, CURRENT_VERSION_MINOR, CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD)
+  end
+
+  describe "A. When asking if we have this version, against the same version parameters" do
+    #Current Version test
+    it "1. has current major version, when passing parameters as integers" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR).must_equal true
+    end
+
+    it "2. has current major and minor version, when passing parameters as integers" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR).must_equal true
+    end
+
+    it "3. has current major, minor and update version, when passing parameters as integers" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE).must_equal true
+    end
+
+    it "4. has current major, minor, update and build version, when passing parameters as integers" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD).must_equal true
+    end
+
+    it "5. has current major and minor version, when passing parameters as a String" do
+      @rubyversion.have_version?("#{CURRENT_VERSION_MAJOR}.#{CURRENT_VERSION_MINOR}").must_equal true
+    end
+
+    it "6. has current major, minor and update version, when passing parameters as a String" do
+      @rubyversion.have_version?("#{CURRENT_VERSION_MAJOR}.#{CURRENT_VERSION_MINOR}.#{CURRENT_VERSION_UPDATE}").must_equal true
+    end
+
+    it "7. has current major and minor version, when passing parameters as a Float" do
+      @rubyversion.have_version?("#{CURRENT_VERSION_MAJOR}.#{CURRENT_VERSION_MINOR}".to_f).must_equal true
+    end
+  end
+
+  describe "B. When asking if we have this version against a later version" do
+  #We assume that we don't need to repeat these for the different input methods, as the above tests checked that they worked.
+  
+    it "1. doesn't match later major  version" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR - 1).must_equal false
+    end
+
+    it "2. doesn't match later major and minor version" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR - 1).must_equal false
+    end
+
+    it "3. doen't match later major, minor and update version" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE - 1).must_equal false
+    end
+    
+    it "4. doen't match later major, minor, update, build version" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD - 1).must_equal false
+    end
+  end
+
+  describe "C.When asking if we have this version, against an earlier version" do
+
+    it "1. doesn't match earlier major version, when given as integers" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR + 1).must_equal false
+    end
+  
+    it "2. doesn't match earlier major and minor version" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR + 1).must_equal false
+    end
+
+    it "3. doen't match earlier major, minor and update version, when given as integers" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE + 1).must_equal false
+    end
+  
+    it "4. doen't match earlier major, minor, update, build version" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD + 1).must_equal false
+    end
+  end
+  
+  describe "D: Check current version using have_at_least_version?" do
+  #Newer Version Tests against current version
+    it "1. has at least major, when given as integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR).must_equal true
+    end
+  
+    it "2. has at least major and minor version, when given as integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR).must_equal true
+    end
+
+    it "3. has at least major, minor and update version, when given as integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE).must_equal true
+    end
+
+    it "4. has at least major, minor, update and build version, when given as integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD).must_equal true
+    end
+
+    it "5. has at least major version, when given as a String" do
+      @rubyversion.have_at_least_version?("#{CURRENT_VERSION_MAJOR}").must_equal true
+    end
+
+    it "6. has at least major and minor version, when given as a String" do
+      @rubyversion.have_at_least_version?("#{CURRENT_VERSION_MAJOR}.#{CURRENT_VERSION_MINOR}").must_equal true
+    end
+
+    it "7. has at least major, minor and update version, when given as String" do
+      @rubyversion.have_at_least_version?("#{CURRENT_VERSION_MAJOR}.#{CURRENT_VERSION_MINOR}.#{CURRENT_VERSION_UPDATE}").must_equal true
+    end
+
+    it "8. has at least major and minor version, when given as a Float" do
+      @rubyversion.have_at_least_version?("#{CURRENT_VERSION_MAJOR}.#{CURRENT_VERSION_MINOR}".to_f).must_equal true
+    end
+  end
+
+  describe "E: Check next version, against current version, using have_at_least_version? " do
+    #Newer Version Tests against previous and later versions
+    it "1. has at least major version, when given as larger integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR + 1).must_equal false #We asked for version after the one we have
+    end
+
+    it "2. has at least major and minor version, when given as larger integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR + 1).must_equal false  #We asked for version after the one we have
+    end
+
+    it "3. has at least major, minor and update version, when given as larger integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE + 1).must_equal false  #We asked for version after the one we have
+    end
+
+    it "4. has at least major, minor, update and build version, when given as larger integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD + 1).must_equal false  #We asked for version after the one we have
+    end
+  end
+
+  describe "F: Check previous version against current version, usig have_at_least_version?" do
+    it "1. doesn't have at least the major version, when given as smaller integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR - 1).must_equal true
+    end
+  
+    it "2. doesn't have at least major and minor version, when given as smaller integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR - 1).must_equal true
+    end
+
+    it "3. doesn't have at least major, minor and update version, when given as smaller bintegers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE - 1).must_equal true
+    end
+
+    it "4. doesn't have at least major, minor, update and build version, when given as smaller integers" do
+      @rubyversion.have_at_least_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD - 1).must_equal true
+    end
+  end
+end
+
+describe VersionCheck, "Ruby version initilized for you" do
+  
+  before do
+    @rubyversion = VersionCheck.rubyversion
+  end
+
+  describe "A. When asking if we have this version, against the same version parameters" do
+    #Current Version test
+
+    it "1. has current major, minor, update and build version, when passing parameters as integers" do
+      @rubyversion.have_version?(CURRENT_VERSION_MAJOR,CURRENT_VERSION_MINOR,CURRENT_VERSION_UPDATE, CURRENT_VERSION_BUILD).must_equal true
+    end
+
+  end
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: VersionCheck
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rob Burrowes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 3
+        - 5
+        version: "3.5"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  type: :development
+  version_requirements: *id003
+description: |-
+  VersionCheck is a ruby class provides tests against a packages  version 
+  so we can determine if our code is running in the version we want
+  or is running on a version later than the version we need.
+  
+  Special initializer, VersionCheck.rubyversion, sets up VersionCheck instance 
+  we can use to check against current Ruby major,minor,update and patch level.
+email: 
+- r.burrowes@auckland.ac.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/versioncheck.rb
+- test/test_versioncheck.rb
+- .gemtest
+homepage: http://rubyforge.org/projects/versioncheck/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: versionchecker
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: VersionCheck is a ruby class provides tests against a packages  version  so we can determine if our code is running in the version we want or is running on a version later than the version we need
+test_files: 
+- test/test_versioncheck.rb