version 0.5.0

data/Rakefile

@@ -0,0 +1,38 @@
+$: << 'lib'
+
+require 'version'
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+spec = Gem::Specification.new do |s|
+  s.name    = 'version'
+  s.author  = 'Stephen Touset'
+  s.email   = 'stephen@touset.org'
+  s.summary = 'simple version-number encapsulation'
+  s.version = '0.5.0'
+  s.files   = FileList['[A-Z]*', 'lib/**/*.rb', 'spec/**/*']
+  
+  s.add_development_dependency 'rspec'
+end
+
+Rake::GemPackageTask.new(spec) do |gem|
+  gem.need_tar = true
+end
+
+Rake::RDocTask.new do |doc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  doc.title    = 'emcien-engine #{version}'
+  doc.rdoc_dir = 'doc'
+  doc.rdoc_files.include('README*')
+  doc.rdoc_files.include('lib/**/*.rb')
+end
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/ext/array.rb

@@ -0,0 +1,8 @@
+class Array
+  #
+  # Converts the Array into a version number.
+  #
+  def to_version
+    Version.new *self
+  end
+end

data/lib/ext/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  #
+  # Converts the Hash into a version number.
+  #
+  def to_version
+    Version.new *self.values_at(:major, :minor, :revision, :rest)
+  end
+end

data/lib/ext/string.rb

@@ -0,0 +1,8 @@
+class String
+  #
+  # Converts the String into a version number.
+  #
+  def to_version
+    Version.new *self.split(%r{\.})
+  end
+end

data/lib/rake/version_task.rb

@@ -0,0 +1,2 @@
+require 'rake'
+

data/lib/version.rb

@@ -0,0 +1,149 @@
+require 'ext/array'
+require 'ext/hash'
+require 'ext/string'
+
+#
+# Encodes version-numbering logic into a convenient class.
+#
+class Version
+  include Comparable
+  
+  #
+  # Creates a new version number, with a +major+ version number, +minor+
+  # revision number, +revision+ number, and optionally more (unnamed)
+  # version components.
+  #
+  def initialize(major, minor = 0, revision = nil, *rest)
+    self.components = []
+    
+    self.major     = major
+    self.minor     = minor
+    self.revision  = revision
+    
+    rest.each.with_index {|v, i| self[3 + i] = v }
+  end
+  
+  #
+  # For +major+, +minor+, and +revision+, make a helper method that gets and
+  # sets each based on accessing indexes.
+  #--
+  # TODO: make these rdoc-capable
+  #++
+  #
+  [ :major, :minor, :revision ].each.with_index do |component, i|
+    define_method(:"#{component}")  {    self[i]          }
+    define_method(:"#{component}=") {|v| self[i] = v.to_s }
+  end
+  
+  #
+  # Retrieves the component of the Version at +index+.
+  #
+  def [](index)
+    self.components[index]
+  end
+  
+  #
+  # Set the component of the Version at +index+ to +value+. Zeroes out any
+  # trailing components.
+  #
+  # If +index+ is greater than the length of the version number, pads the
+  # version number with zeroes until +index+.
+  #--
+  # TODO: rewrite sanely
+  #++
+  def []=(index, value)
+    self.resize!(index) and return if value.nil? || value.empty?
+    
+    if index < self.length
+      length = self.length - index
+      zeroes = Array.new(length, 0)
+      
+      self.components[index, length] = zeroes
+      self.components[index]         = value
+    else
+      length = index - self.length
+      zeroes = Array.new(length, 0)
+      
+      self.components += zeroes
+      self.components << value
+    end
+  end
+  
+  #
+  # Resizes the Version to +length+, removing any trailing components. Is a
+  # no-op if +length+ is greater than its current length.
+  #
+  def resize!(length)
+    self.components = self.components[0, length]
+    self
+  end
+  
+  #
+  # Bumps the version number. Pass +index+ to bump a component other than the
+  # least-significant part. Set +trim+ to true if you want the version to be
+  # resized to only large enough to contain the index.
+  #
+  #    "1.0.4a".bump!          # => "1.0.4b"
+  #    "1.0.4b".bump!(1, true) # => "1.2"
+  #
+  def bump!(index = self.length - 1, trim = false)
+    self.resize!(index + 1) if trim
+    self[index] = (self[index] || -1).succ
+    self
+  end
+  
+  #
+  # Returns the current length of the version number.
+  #
+  def length
+    self.components.length
+  end
+  
+  #
+  # Compares a Version against any +other+ object that responds to
+  # +to_version+.
+  #
+  def <=>(other)
+    self.to_a <=> other.to_version.to_a
+  end
+  
+  #
+  # Converts the version number into an array of its components.
+  #
+  def to_a
+    self.components
+  end
+  
+  #
+  # Converts the version number into a hash of its components.
+  #
+  def to_hash
+    { :major    => self.major,
+      :minor    => self.minor,
+      :revision => self.revision,
+      :rest     => self.length > 3 ? self.components.drop(3) : nil }
+  end
+  
+  #
+  # The canonical representation of a version number.
+  #
+  def to_s
+    self.components.join('.')
+  end
+  
+  #
+  # Returns +self+.
+  #
+  def to_version
+    self
+  end
+  
+  #
+  # Aliased from +to_s+.
+  #
+  alias inspect to_s
+  
+  protected
+  
+  attr_accessor :components
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'emcien-engine'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: version
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Stephen Touset
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: stephen@touset.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/ext/array.rb
+- lib/ext/hash.rb
+- lib/ext/string.rb
+- lib/rake/version_task.rb
+- lib/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: simple version-number encapsulation
+test_files: []
+