git-version-bump 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org/'
+
+gemspec

data/README.md

@@ -0,0 +1,82 @@
+Maintain your program versions entirely within git.  No local files
+required!
+
+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.
+
+
+# Usage
+
+In your `Rakefile`, add the following line:
+
+    require 'git-version-bump/rake-tasks'
+
+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)
+
+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.
+
+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
+'git-version-bump'` and use the following methods:
+
+    GVB.version            # Return the entire version string
+    GVB.major_version      # Return just the 'major' portion of the version
+    GVB.minor_version      # Return just the 'minor' portion of the version
+    GVB.patch_version      # Return just the 'patch' portion of the version
+    GVB.internal_revision  # Return "internal revision" information, or nil
+    GVB.date               # Return the date of the most recent commit, or
+                           # today's date if the tree is dirty
+
+The "internal revision" is set when the tree is dirty, or when the latest
+git commit doesn't correspond with a tag.  In that case, the internal
+revision will describe, in the manner of `git describe`, the full details of
+the version of the code in use.  This information will be part of the
+version string provided by `gvb_version`.
+
+If any of these methods are called when there isn't a tag or other version
+information available, the version will be assumed to be `0.0.0.1.ENOTAG`
+with a date of `1970-01-01`.
+
+
+## In your gemspec
+
+Typically, you want to encode your version and commit date into your
+gemspec, like this:
+
+    Gem::Specification.new do |s|
+      s.version = GVB.version
+      s.date    = GVB.date
+      
+      ...
+    end
+
+The beauty of this method is that whenever you run a `rake build`, you'll
+get a gem which is *accurately* versioned for the current state of your
+repository.  No more wondering if the `foobar-1.2.3` gem installed on your
+system was built from pristine sources, or with that experimental patch you
+were trying out...
+
+
+## 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
+`VERSION` constant somewhere in your gem's namespace.  That, too, is simple
+to do:
+
+    require 'git-version-bump'
+    
+    class Foobar
+      VERSION = GVB.version
+    end
+
+This will work correctly inside your git tree, and also in your installed
+gem.  Magical!

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler'
+require_relative 'lib/git-version-bump/rake-tasks'
+
+begin
+	Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+	$stderr.puts e.message
+	$stderr.puts "Run `bundle install` to install missing gems"
+	exit e.status_code
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rd|
+	rd.main = "README.md"
+	rd.title = 'git-version-bump'
+	rd.rdoc_files.include("README.md", "lib/**/*.rb")
+end

data/git-version-bump.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/git-version-bump', __FILE__)
+
+Gem::Specification.new do |s|
+	s.name = "git-version-bump"
+
+	s.version = GVB.version
+	s.date    = GVB.date
+
+	s.platform = Gem::Platform::RUBY
+
+	s.homepage = "http://theshed.hezmatt.org/git-version-bump"
+	s.summary = "Manage your app version entirely via git tags"
+	s.authors = ["Matt Palmer"]
+
+	s.extra_rdoc_files = ["README.md"]
+	s.files = `git ls-files`.split("\n")
+	
+	s.add_development_dependency 'rake'
+	s.add_development_dependency 'bundler'
+	s.add_development_dependency 'rdoc'
+end

data/lib/git-version-bump.rb

@@ -0,0 +1,138 @@
+module GitVersionBump
+	def self.version
+		git_ver = `git describe --dirty --match='v[0-9]*.[0-9]*.*[0-9]' 2>/dev/null`.
+		            strip.
+		            gsub(/^v/, '').
+		            gsub('-', '.')
+		
+		# If git returned success, then it gave us a described version.
+		# Success!
+		return git_ver if $? == 0
+
+		# git failed us; we're either not in a git repo or else we've never
+		# tagged anything before.
+		
+		# Are we in a git repo with no tags?  If so, dump out our
+		# super-special version and be done with it.
+		system("git status >/dev/null 2>&1")
+		return "0.0.0.1.ENOTAG" if $? == 0
+
+		# We're not in a git repo.  This means that we need to get version
+		# information out of rubygems, given only the filename of who called
+		# us.  This takes a little bit of effort.
+
+		if spec = GVB.caller_gemspec
+			return spec.version.to_s
+		else
+			# If we got here, something went *badly* wrong -- presumably, we
+			# 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 called from mysterious, non-gem location."
+		end
+	end
+	
+	def self.major_version
+		ver = GVB.version
+		v   = ver.split('.')[0]
+		
+		unless v =~ /^[0-9]+$/
+			raise ArgumentError,
+			        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
+		end
+		
+		return v.to_i
+	end
+	
+	def self.minor_version
+		ver = GVB.version
+		v   = ver.split('.')[1]
+		
+		unless v =~ /^[0-9]+$/
+			raise ArgumentError,
+			        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
+		end
+		
+		return v.to_i
+	end
+	
+	def self.patch_version
+		ver = GVB.version
+		v   = ver.split('.')[2]
+		
+		unless v =~ /^[0-9]+$/
+			raise ArgumentError,
+			        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
+		end
+		
+		return v.to_i
+	end
+	
+	def self.internal_revision
+		GVB.version.split('.', 4)[3].to_s
+	end
+	
+	def self.date
+		# Are we in a git tree?
+		system("git status >/dev/null 2>&1")
+		if $? == 0
+			# Yes, we're in git.
+			
+			if GVB.dirty_tree?
+				return Time.now.strftime("%F")
+			else
+				# Clean tree.  Date of last commit is needed.
+				return `git show --format=format:%ad --date=short | head -n 1`.strip
+			end
+		else
+			# Not in git; time to hit the gemspecs
+			if spec = GVB.caller_gemspec
+				return spec.version.to_s
+			else
+				raise RuntimeError,
+					  "GVB.date called from mysterious, non-gem location."
+			end
+		end
+	end
+	
+	def self.tag_version(v)
+		if GVB.dirty_tree?
+			puts "You have uncommitted files.  Refusing to tag a dirty tree."
+		else
+			puts "Tagging version #{v}..."
+			system("git tag -a -m 'Version v#{v}' v#{v}")
+		end
+	end
+	
+	def self.caller_gemspec
+		# First up, who called us?  Because this method gets called from other
+		# methods within this file, we can't just look at Gem.location_of_caller,
+		# but instead we need to parse the whole caller stack ourselves.
+		caller_file = caller.
+		                map  { |l| l.split(':')[0] }.
+		                find { |l| l != __FILE__ }
+		
+		# Next we grovel through all the loaded gems to try and find the gem
+		# that contains the caller's file.
+		Gem.loaded_specs.values.each do |spec|
+			if Dir.
+				  glob(spec.lib_dirs_glob).
+				  find { |d| caller_file.index(d) == 0 }
+				# The caller_file is in this
+				# gem!  Woohoo!
+				return spec
+			end
+		end
+
+		nil
+	end
+
+	def self.dirty_tree?
+		# Are we in a dirty, dirty tree?
+		system("! git diff --no-ext-diff --quiet --exit-code || ! git diff-index --cached --quiet HEAD")
+
+		$? == 0
+	end
+end
+
+GVB = GitVersionBump

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

@@ -0,0 +1,26 @@
+require_relative '../git-version-bump'
+
+namespace :version do
+	namespace :bump do
+   	desc "bump major version (x.y.z -> x+1.0.0)"
+   	task :major do
+			GVB.tag_version "#{GVB.major_version + 1}.0.0"
+
+			puts "Version is now #{GVB.version}"
+		end
+		
+   	desc "bump minor version (x.y.z -> x.y+1.0)"
+   	task :minor do
+			GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version+1}.0"
+
+			puts "Version is now #{GVB.version}"
+		end
+		
+    	desc "bump patch version (x.y.z -> x.y.z+1)"
+		task :patch do
+			GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version}.#{GVB.patch_version+1}"
+
+			puts "Version is now #{GVB.version}"
+		end
+	end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: git-version-bump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Palmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- git-version-bump.gemspec
+- lib/git-version-bump.rb
+- lib/git-version-bump/rake-tasks.rb
+homepage: http://theshed.hezmatt.org/git-version-bump
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4544833629882770877
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4544833629882770877
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Manage your app version entirely via git tags
+test_files: []