git-version-bump 0.18.0 → 0.18.0.7.g2e0c3c4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ff2d2ad4a6b5c8ea81891a9004d97507f4d9075081638034e319cd9ddccb81
-  data.tar.gz: ea24000b5f002ae3f3369cd41bff4b31c91c7dfd32a88d1ae45cfa6ce0648114
+  metadata.gz: 32795b930c87e8796ae34c50d42703165e8dc083d4fa4e6cd19763f49f71d78a
+  data.tar.gz: bdf0755443972b724acb3be0cf0b677cc5a698f52533ec9afe8c47dd35ec5553
 SHA512:
-  metadata.gz: 837115664720c3e410e3f07b9111a81bad5451fcf81ca76c4b6255d387a4ce802098c2fe178157eaddf01fb5d67cc62dd744027f73f8c5c387e34fb363ecb840
-  data.tar.gz: 1f9b8a018b2c8d54bd0eea72d65578d6fe28f799a32579e2397e22ffddcce2335c530d0db5ba96627e1987d0133407a58f9141477eb6e3cbe29b74ffc2ba8754
+  metadata.gz: 3e97d8fd061b44c0f841c435f303930eacf1834acfb555c3b69f5ab7cfc918b678fa452e4f5ce1b8b0b780d5f01546226791a0fa45ad6985fc252d7c9cd63d5e
+  data.tar.gz: 82f01e33ed949be7ad11a544a24a44383e8f01896b67ff242c955287ea7ea51987e43c7afb9727afd026c63bce78bf0d06b3729016c8af5e4ca429d4ed832d53

data/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: "Release to RubyGems"
+on:
+  push:
+    branch: [main]
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    name: "Upload gem"
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Install ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+
+      - name: Workaround for https://github.com/actions/checkout/issues/290
+        run: |
+          git fetch --force --tags
+
+      - name: Do The Needful
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          bundle exec rake release:rubygem_push

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

@@ -1,8 +1,33 @@
 module GitVersionBump
-	VERSION = GVB.version
-	MAJOR_VERSION = GVB.major_version
-	MINOR_VERSION = GVB.minor_version
-	PATCH_VERSION = GVB.patch_version
-	INTERNAL_REVISION = GVB.internal_revision
-	DATE = GVB.date
+	def self.VERSION
+		GVB.version
+	end
+
+	def self.MAJOR_VERSION
+		GVB.major_version
+	end
+
+	def self.MINOR_VERSION
+		GVB.minor_version
+	end
+
+	def self.PATCH_VERSION
+		GVB.patch_version
+	end
+
+	def self.INTERNAL_REVISION
+		GVB.internal_revision
+	end
+
+	def self.DATE
+		GVB.date
+	end
+
+	def self.const_missing(c)
+		if self.respond_to?(c) && c =~ /\A[A-Z_]+\z/
+			public_send c
+		else
+			super
+		end
+	end
 end

data/lib/git-version-bump.rb

@@ -15,34 +15,21 @@ module GitVersionBump
 	end
 
 	VERSION_TAG_GLOB = 'v[0-9]*.[0-9]*.*[0-9]'
+	private_constant :VERSION_TAG_GLOB
 
 	DEVNULL = Gem.win_platform? ? "NUL" : "/dev/null"
+	private_constant :DEVNULL
 
-	def self.version(use_local_git=false, include_lite_tags=false)
-		git_cmd = ["git", "-C", git_dir(use_local_git), "describe", "--dirty=.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}", "--match=#{VERSION_TAG_GLOB}"]
-		git_cmd << "--tags" if include_lite_tags
-
-		begin
-			run_command(git_cmd, "getting current version descriptor").
-			            strip.
-			            gsub(/^v/, '').
-			            gsub('-', '.')
-		rescue CommandFailure
-			# 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, try to use the gemspec
-			# and if that fails then abort
-			begin
-				gem_version(use_local_git)
-			rescue VersionUnobtainable
-				"0.0.0.1.ENOTAG"
-			end
+	def self.version(use_local_dir=false, include_lite_tags=false)
+		if use_local_dir
+			repo_version(true, include_lite_tags)
+		else
+			gem_version || repo_version(false, include_lite_tags)
 		end
 	end
 
-	def self.major_version(use_local_git=false, include_lite_tags=false)
-		ver = version(use_local_git, include_lite_tags)
+	def self.major_version(use_local_dir=false, include_lite_tags=false)
+		ver = version(use_local_dir, include_lite_tags)
 		v   = ver.split('.')[0]
 
 		unless v =~ /^[0-9]+$/
@@ -53,8 +40,8 @@ module GitVersionBump
 		return v.to_i
 	end
 
-	def self.minor_version(use_local_git=false, include_lite_tags=false)
-		ver = version(use_local_git, include_lite_tags)
+	def self.minor_version(use_local_dir=false, include_lite_tags=false)
+		ver = version(use_local_dir, include_lite_tags)
 		v   = ver.split('.')[1]
 
 		unless v =~ /^[0-9]+$/
@@ -65,8 +52,8 @@ module GitVersionBump
 		return v.to_i
 	end
 
-	def self.patch_version(use_local_git=false, include_lite_tags=false)
-		ver = version(use_local_git, include_lite_tags)
+	def self.patch_version(use_local_dir=false, include_lite_tags=false)
+		ver = version(use_local_dir, include_lite_tags)
 		v   = ver.split('.')[2]
 
 		unless v =~ /^[0-9]+$/
@@ -77,34 +64,15 @@ module GitVersionBump
 		return v.to_i
 	end
 
-	def self.internal_revision(use_local_git=false, include_lite_tags=false)
-		version(use_local_git, include_lite_tags).split('.', 4)[3].to_s
+	def self.internal_revision(use_local_dir=false, include_lite_tags=false)
+		version(use_local_dir, include_lite_tags).split('.', 4)[3].to_s
 	end
 
-	def self.date(use_local_git=false)
-		# Are we in a git tree?
-		begin
-			try_command(["git", "-C", git_dir(use_local_git), "status"])
-
-			if dirty_tree?(git_dir(use_local_git))
-				Time.now.strftime("%F")
-			else
-				# Clean tree.  Date of last commit is needed.
-				(run_command(["git", "-C", git_dir(use_local_git), "show", "--no-show-signature", "--format=format:%cd", "--date=short"], "getting date of last commit").lines.first || "").strip
-			end
-		rescue CommandFailure
-			# Presumably not in a git tree
-			if use_local_git
-				raise RuntimeError,
-				      "GVB.date(use_local_git=true) called from non-git location"
-			end
-
-			if spec = caller_gemspec
-				spec.date.strftime("%F")
-			else
-				raise RuntimeError,
-				      "GVB.date called from mysterious, non-gem location."
-			end
+	def self.date(use_local_dir=false, include_lite_tags = false)
+		if use_local_dir
+			repo_date(true, include_lite_tags)
+		else
+			gem_date || repo_date(false, include_lite_tags)
 		end
 	end
 
@@ -186,46 +154,47 @@ module GitVersionBump
 	# version.  Since hashes are hex, we're boned.  Sorry about that.  Don't
 	# make builds off a branch, basically.
 	#
-	def self.commit_date_version(use_local_git = false)
-		commit_dates = run_command(["git", "-C", git_dir(use_local_git), "log", "--no-show-signature", "--format=%at"], "getting dates of all commits").
+	def self.commit_date_version(use_local_dir = false)
+		if use_local_dir
+			commit_date_version_string(true)
+		else
+			gem_version || commit_date_version_string(false)
+		end
+	end
+
+	def self.commit_date_version_string(use_local_dir = false)
+		commit_dates = run_command(["git", "-C", git_dir(use_local_dir).to_s, "log", "--no-show-signature", "--format=%at"], "getting dates of all commits").
 		               split("\n").
 		               map { |l| Time.at(Integer(l)).strftime("%Y%m%d") }
 
-		if $? == 0
-			# We got a log; calculate our version number and we're done.
-			version_date = commit_dates.first
-			commit_count = commit_dates.select { |d| d == version_date }.length - 1
-			dirty_suffix = if dirty_tree?
-				".dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}"
-			else
-				""
-			end
-
-			return "0.#{version_date}.#{commit_count}#{dirty_suffix}"
+		version_date = commit_dates.first
+		commit_count = commit_dates.select { |d| d == version_date }.length - 1
+		dirty_suffix = if dirty_tree?
+			".dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}"
+		else
+			""
 		end
 
-		# git failed us; either we're not in a git repo or else it's a git
-		# repo that's not got any commits.
-
-		# Are we in a git repo with no commits?  If so, try to use the gemspec
-		# and if that fails then abort
-		begin
-			return gem_version(use_local_git)
-		rescue VersionUnobtainable
+		return "0.#{version_date}.#{commit_count}#{dirty_suffix}"
+	rescue CommandFailure => ex
+		p :GVB_CDVS_CMD_FAIL, ex.output if debug?
+		if ex.output =~ /fatal: your current branch .* does not have any commits yet/
 			return "0.0.0.1.ENOCOMMITS"
+		else
+			raise VersionUnobtainable, "Could not get commit date-based version from git repository at #{git_dir(use_local_dir)}"
 		end
 	end
 
-	private
-
 	def self.git_available?
 		try_command(["git", "--version"])
 	end
+	private_class_method :git_available?
 
 	def self.dirty_tree?(dir='.')
 		# Are we in a dirty, dirty tree?
-		! run_command(["git", "-C", dir, "status", "--porcelain"], "checking for tree cleanliness").empty?
+		! run_command(["git", "-C", dir.to_s, "status", "--porcelain"], "checking for tree cleanliness").empty?
 	end
+	private_class_method :dirty_tree?
 
 	# Execute a command, specified as an array.
 	#
@@ -245,7 +214,7 @@ module GitVersionBump
 			p :GVB_CMD, desc, cmd
 		end
 
-		out, status = Open3.capture2e(*cmd)
+		out, status = Open3.capture2e({"LC_MESSAGES" => "C"}, *cmd)
 
 		if status.exitstatus != 0
 			raise CommandFailure.new("Failed while #{desc}", out, status.exitstatus)
@@ -253,6 +222,7 @@ module GitVersionBump
 			out
 		end
 	end
+	private_class_method :run_command
 
 	# Execute a command, and return whether it succeeded or failed.
 	#
@@ -264,6 +234,7 @@ module GitVersionBump
 			false
 		end
 	end
+	private_class_method :try_command
 
 	def self.caller_file
 		# Who called us?  Because this method gets called from other methods
@@ -275,8 +246,9 @@ module GitVersionBump
 		  map(&:path).
 		  tap { |c| p :CALLER_LOCATIONS, c if debug? }.
 		  find { |l| l != __FILE__ }
-		).realpath.to_s rescue nil
+		).realpath rescue nil
 	end
+	private_class_method :caller_file
 
 	def self.caller_gemspec
 		cf = caller_file or return nil
@@ -302,54 +274,75 @@ module GitVersionBump
 				end
 			end.compact!
 
-			if search_dirs.find { |d| cf.index(d) == 0 }
+			if search_dirs.find { |d| cf.to_s.index(d) == 0 }
 				return spec
 			end
 		end
 
-		raise VersionUnobtainable,
-		      "Unable to find gemspec for caller file #{cf}"
+		if debug?
+			p :GVB_NO_GEMSPEC, cf
+		end
+
+		nil
 	end
+	private_class_method :caller_gemspec
 
-	def self.gem_version(use_local_git = false)
-		if use_local_git
-			raise VersionUnobtainable,
-			      "Unable to determine version from local git repo.  This should never happen."
-		end
+	def self.gem_version
+		caller_gemspec&.version&.to_s
+	end
+	private_class_method :gem_version
 
-		if spec = 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!
-			if git_available?
-				raise VersionUnobtainable,
-				      "GVB.version(#{use_local_git.inspect}) failed, and I really don't know why."
+	def self.gem_date
+		caller_gemspec&.date&.strftime("%F")
+	end
+	private_class_method :gem_version
+
+	def self.repo_version(use_local_dir, include_lite_tags)
+		git_cmd = ["git", "-C", git_dir(use_local_dir).to_s, "describe", "--dirty=.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}", "--match=#{VERSION_TAG_GLOB}"]
+		git_cmd << "--tags" if include_lite_tags
+
+		begin
+			run_command(git_cmd, "getting current version descriptor").
+			            strip.
+			            gsub(/^v/, '').
+			            gsub('-', '.')
+		rescue CommandFailure => ex
+			p :GVB_REPO_VERSION_FAILURE, ex.output if debug?
+			if ex.output =~ /fatal: No names found, cannot describe anything/
+				# aka "no tags, bro"
+				"0.0.0.1.ENOTAG"
 			else
-				raise VersionUnobtainable,
-				      "GVB.version(#{use_local_git.inspect}) failed; perhaps you need to install git?"
+				raise VersionUnobtainable, "Could not get version from gemspec or git repository at #{git_dir(use_local_dir)}"
 			end
 		end
 	end
+	private_class_method :repo_version
 
-	def self.git_dir(use_local_git = false)
-		if use_local_git
-			unless git_available?
-				raise RuntimeError,
-				      "Cannot use git-version-bump with use_local_git, as git is not installed"
-			end
+	def self.repo_date(use_local_dir, include_lite_tags)
+		if dirty_tree?(git_dir(use_local_dir))
+			Time.now.strftime("%F")
+		else
+			# Clean tree.  Date of last commit is needed.
+			(run_command(["git", "-C", git_dir(use_local_dir).to_s, "show", "--no-show-signature", "--format=format:%cd", "--date=short"], "getting date of last commit").lines.first || "").strip
+		end
+	rescue CommandFailure
+		raise VersionUnobtainable, "Could not get commit date from git repository at #{git_dir(use_local_dir)}"
+	end
+	private_class_method :repo_date
 
+	def self.git_dir(use_local_dir = false)
+		if use_local_dir
 			Dir.pwd
 		else
-			File.dirname(caller_file) rescue nil || Dir.pwd
-		end.tap { |d| p :GVB_GIT_DIR, use_local_git, d if debug? }
+			caller_file&.dirname || Dir.pwd
+		end.tap { |d| p :GVB_GIT_DIR, use_local_dir, d if debug? }
 	end
 	private_class_method :git_dir
 
 	def self.debug?
 		ENV.key?("GVB_DEBUG")
 	end
+	private_class_method :debug?
 end
 
 GVB = GitVersionBump unless defined? GVB

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-version-bump
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.0.7.g2e0c3c4
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-release
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/release.yml"
 - ".gitignore"
 - Gemfile
 - LICENCE
@@ -98,11 +99,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Manage your app version entirely via git tags