version 0.7.1 → 0.8.0

data/History.rdoc

@@ -1,3 +1,13 @@
+=== Version 0.8.0 / (unreleased)
+
+* bug fixes
+  * fixed README documentation to properly reflect is_versioned
+  * put core class extensions in a subdirectory of version, to avoid filename
+    collisions with other gems
+
+* enhancements
+  * Added Version.current method (closes #2)
+
 === Version 0.7.1 / 2010-02-05
 
 * bug fixes

data/README.rdoc

@@ -32,7 +32,8 @@ You're all set up.
   $ rake version:bump:minor           # => 0.2.0
   $ rake version:bump:revision        # => 0.2.1
   $ rake version:bump:major           # => 1.0.0
-  $ cat VERSION                       # => 1.0.0
+  $ rake version:bump:minor           # => 1.0.1
+  $ cat VERSION                       # => 1.0.1
   
 Version also supports a .yml VERSION file. See the VersionTask rdoc for
 details.
@@ -40,15 +41,19 @@ details.
 === Library Versioning
 
 Version lets you automatically keep an in-class VERSION constant in sync with
-the contents of the version file on disk.
+the contents of the version file on disk. Version also provides a class-level
++current+ method which lets you get the current version without setting a
+class-level constant.
 
   require 'version'
   
+  Version.current # => 1.0.1
+  
   class Foo
-    Version()
+    is_versioned
   end
   
-  Foo::VERSION # => 1.0.0
+  Foo::VERSION # => 1.0.1
   
 The Class::Version method takes a filename parameter if you use a different
 location for the VERSION file. See the Class::Version rdoc for details.

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/lib/version.rb

@@ -1,7 +1,9 @@
-require 'ext/array'
-require 'ext/class'
-require 'ext/hash'
-require 'ext/string'
+require 'version/ext/array'
+require 'version/ext/class'
+require 'version/ext/hash'
+require 'version/ext/string'
+
+require 'pathname'
 
 #
 # Encodes version-numbering logic into a convenient class.
@@ -9,6 +11,39 @@ require 'ext/string'
 class Version
   include Comparable
   
+  #
+  # Searches through the parent directories of the calling method and looks
+  # for a VERSION or VERSION.yml file to parse out the current version. Pass
+  #
+  # Pass a filename to +path+ to override autodetection, or pass a directory
+  # name as +path+ to autodetect within a given directory
+  #
+  def self.current(path = nil)
+    # if path is nil, detect automatically; if path is a directory, detect
+    # automatically in the directory; if path is a filename, use it directly
+    path = path ? Pathname.new(path) : self.version_file(caller.first)
+    path = self.version_file(path) unless path.file?
+            
+    raise 'no VERSION or VERSION.yml found' unless path
+    
+    case path.extname
+      when ''      then path.read.strip.to_version
+      when '.yml'  then YAML::load(path.read).to_version
+    end
+  end
+  
+  #
+  # Attempts to detect the version file for the passed +filename+. Looks up
+  # the directory hierarchy for a file named VERSION or VERSION.yml. Returns
+  # a Pathname for the file if found, otherwise nil.
+  #
+  def self.version_file(filename)
+    Pathname(filename).dirname.expand_path.ascend do |d|
+      break d.join('VERSION')     if d.join('VERSION').exist?
+      break d.join('VERSION.yml') if d.join('VERSION.yml').exist?
+    end
+  end
+  
   #
   # Creates a new version number, with a +major+ version number, +minor+
   # revision number, +revision+ number, and optionally more (unnamed)

data/lib/{ext → version/ext}/array.rb

@@ -1,3 +1,5 @@
+require 'version'
+
 class Array
   #
   # Converts the Array into a version number.

data/lib/version/ext/class.rb

@@ -0,0 +1,11 @@
+require 'version'
+
+class Class
+  #
+  # Automagically sets a VERSION constant in the current class according to
+  # the results of Version.current.
+  #
+  def is_versioned
+    const_set :VERSION, Version.current(File.dirname(caller.first))
+  end
+end

data/lib/{ext → version/ext}/hash.rb

@@ -1,3 +1,5 @@
+require 'version'
+
 class Hash
   #
   # Converts the Hash into a version number.

data/lib/{ext → version/ext}/string.rb

@@ -1,3 +1,5 @@
+require 'version'
+
 class String
   #
   # Converts the String into a version number.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: version
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors: 
 - Stephen Touset
@@ -36,11 +36,11 @@ files:
 - README.rdoc
 - TODO.rdoc
 - VERSION
-- lib/ext/array.rb
-- lib/ext/class.rb
-- lib/ext/hash.rb
-- lib/ext/string.rb
 - lib/rake/version_task.rb
+- lib/version/ext/array.rb
+- lib/version/ext/class.rb
+- lib/version/ext/hash.rb
+- lib/version/ext/string.rb
 - lib/version.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/lib/ext/class.rb

@@ -1,29 +0,0 @@
-require 'pathname'
-
-class Class
-  #
-  # Automagically sets a VERSION constant in the current class, populated by
-  # the Version in +filename+. Attempts to guess the filename of the VERSION
-  # file by looking for VERSION or VERSION.yml files in the directories above
-  # the caller
-  #
-  def is_versioned(filename = nil)
-    # attempt to guess the filename if none given
-    if filename.nil?
-      filename = Pathname.new(caller.first).dirname.expand_path.ascend do |d|        
-        break d.join('VERSION')     if d.join('VERSION').exist?
-        break d.join('VERSION.yml') if d.join('VERSION.yml').exist?
-      end
-    end
-    
-    raise 'no VERSION or VERSION.yml found' unless filename
-    
-    path     = Pathname.new(filename)
-    contents = path.read
-    
-    const_set :VERSION, case path.extname
-      when ''      then contents.strip.to_version
-      when '.yml'  then YAML::load(contents).to_version
-    end
-  end
-end