git-version-bump 0.7.0 → 0.8.0

data/README.md

@@ -1,14 +1,44 @@
 Maintain your program versions entirely within git.  No local files
-required!
+required!  All versioning information is stored using git tags.
 
-This gem contains a set of Rake tasks and associated code to manage the
-versioning of your code via git tags.  No in-repo file is required to store
-your version, which reduces unnecessary duplication of information.
+This gem contains a command-line tool and set of Rake tasks to increment
+and display your version numbers via git tags, and some associated Ruby code to use
+inside a gemspec or your program to retrieve the current version number, for
+use in builds and at runtime.
 
 
 # Usage
 
-In your `Rakefile`, add the following line:
+Most of your day-to-day usage of `git-version-bump` will be via the command
+line.  When you bump a version, a new tag will be created representing the newly
+incremented version number at the current commit.  If no tags currently
+exist, the previous version will be taken to be `0.0.0` and then incremented
+accordingly.
+
+
+## On the command line
+
+Pretty damned trivial:
+
+    git version-bump <major|minor|patch|show>
+
+You can also shorten the specifier to any unique substring:
+
+    git version-bump ma
+    git version-bump mi
+    git version-bump p
+    git version-bump s
+
+I recommend adding an alias to your `~/.gitconfig` file, for less typing:
+
+    [alias]
+        vb = version-bump
+
+
+## In your `Rakefile`
+
+If you'd like to have access to the version-bumping goodness via `rake`, add
+the following line to your `Rakefile`:
 
     require 'git-version-bump/rake-tasks'
 
@@ -17,15 +47,14 @@ You will now have the following rake tasks available:
     rake version:bump:major  # bump major version (x.y.z -> x+1.0.0)
     rake version:bump:minor  # bump minor version (x.y.z -> x.y+1.0)
     rake version:bump:patch  # bump patch version (x.y.z -> x.y.z+1)
+    rake version:bump:show   # Print current version number
 
 (Since `version:bump:major` is a lot of typing, there are also shortcuts:
 `v:b:major`, `v:b:maj`, `v:b:minor`, `v:b:min`, `v:b:patch`, `v:b:pat`, and
 `v:b:p`)
 
-By running any of those, a new tag will be created representing the newly
-incremented version number at the current commit.  If no tags currently
-exist, the previous version will be taken to be `0.0.0` and then incremented
-accordingly.
+
+## In your Ruby code
 
 To get access to this version information in your code (such as in your
 `gemspec`, or the definition of a `::VERSION` constant), you can `require
@@ -50,7 +79,7 @@ information available, the version will be assumed to be `0.0.0.1.ENOTAG`
 with a date of `1970-01-01`.
 
 
-## In your gemspec
+### In your gemspec
 
 Typically, you want to encode your version and commit date into your
 gemspec, like this:
@@ -69,10 +98,10 @@ system was built from pristine sources, or with that experimental patch you
 were trying out...
 
 
-## In your gem
+### In your gem
 
 If, like me, you're one of those people who likes to be able to easily see
-what version of a library I'm running, then you probably like to define a
+what version of a library you're running, then you probably like to define a
 `VERSION` constant somewhere in your gem's namespace.  That, too, is simple
 to do:
 

data/bin/git-version-bump

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'git-version-bump'
+
+if ARGV[0].nil? or
+   ARGV[0].empty? or
+   ARGV[0] == '-h' or
+   ARGV[0] == '--help'
+	$stderr.puts <<-EOF.gsub(/^\t\t/, '')
+		Usage: git version-bump <major|minor|patch>
+
+		'major': x.y.z -> x+1.0.0
+		'minor': x.y.z -> x.y+1.0
+		'patch': x.y.z -> x.y.z+1
+	EOF
+end
+
+if ARGV[0].nil? or ARGV[0].empty?
+	exit 1
+elsif ARGV[0] == '-h' or ARGV[0] == '--help'
+	exit 0
+end
+
+case ARGV[0].downcase
+	when /^maj?o?r?$/
+		GVB.tag_version "#{GVB.major_version + 1}.0.0"
+	when /^min?o?r?$/
+		GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version+1}.0"
+	when /^pa?t?c?h?$/
+		GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version}.#{GVB.patch_version+1}"
+	when /^sh?o?w?$/
+		puts GVB.version
+		exit 0
+	else
+		$stderr.puts "Unknown argument: #{ARGV[0]}.  Try --help."
+		exit 1
+end
+
+puts "Version is now #{GVB.version}."

data/git-version-bump.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |s|
 
 	s.extra_rdoc_files = ["README.md"]
 	s.files = `git ls-files`.split("\n")
-	
+	s.executables = ["git-version-bump"]
+
 	s.add_development_dependency 'rake'
 	s.add_development_dependency 'bundler'
 	s.add_development_dependency 'rdoc'

data/lib/git-version-bump.rb

@@ -34,6 +34,10 @@ module GitVersionBump
 	end
 
 	def self.version(gem = nil)
+		@version_cache ||= {}
+
+		return @version_cache[gem] if @version_cache[gem]
+
 		git_ver = `git describe --dirty='.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}' --match='v[0-9]*.[0-9]*.*[0-9]' 2>/dev/null`.
 		            strip.
 		            gsub(/^v/, '').
@@ -66,7 +70,7 @@ module GitVersionBump
 			# weren't called from within a loaded gem, and so we've got *no*
 			# idea what's going on.  Time to bail!
 			raise RuntimeError,
-					  "GVB.version(#{gem.inspect}) called from mysterious, non-gem location."
+					  "GVB.version(#{gem.inspect}) failed.  Is git installed?"
 		end
 	end
 

data/lib/git-version-bump/rake-tasks.rb

@@ -22,6 +22,11 @@ namespace :version do
 
 			puts "Version is now #{GVB.version}"
 		end
+
+		desc "Print current version"
+		task :show do
+			puts GVB.version
+		end
 	end
 end
 
@@ -36,5 +41,9 @@ namespace :v do
 		task :patch => "version:bump:patch"
 		task :pat   => "version:bump:patch"
 		task :p     => "version:bump:patch"
+
+		task :show  => "version:bump:show"
+		task :sh    => "version:bump:show"
+		task :s     => "version:bump:show"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-version-bump
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,7 +61,8 @@ dependencies:
         version: '0'
 description: 
 email: 
-executables: []
+executables:
+- git-version-bump
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -70,6 +71,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/git-version-bump
 - git-version-bump.gemspec
 - lib/git-version-bump.rb
 - lib/git-version-bump/rake-tasks.rb
@@ -87,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3517451086153522705
+      hash: -3956615801826870030
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3517451086153522705
+      hash: -3956615801826870030
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23