bake-gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1c7d8822f1ce438e1b1c38e0fe70c84b3f4990f74ded28e55a94d48263e1cfe
+  data.tar.gz: d5c5244785a1e77c1b92424496b974fc1cc2f8f6620b90686177301f1c759990
+SHA512:
+  metadata.gz: ab506f4ecdf9fca06c12206dc141416def87993bdf325a926e55c6816d5182a084b2c59b8cc9f1cd3dda6b63360612eb9a98078ef645ce885cf8f687cde078c0
+  data.tar.gz: cc5d3f181ececf3f864c419ffe78921731cb150cc768d4662d58e5f142ec65d5c754a04516fc101d204eab1ff825227a7c766c00b6ced47da778e7caeec0574a

data/bake/gem.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative '../lib/bake/gem/helper'
+require_relative '../lib/bake/gem/shell'
+
+include Bake::Gem::Shell
+
+def initialize(context)
+	super(context)
+	
+	@helper = Bake::Gem::Helper.new(context.root)
+end
+
+attr :helper
+
+# List all the files that will be included in the gem:
+def files
+	@helper.gemspec.files.each do |path|
+		$stdout.puts path
+	end
+end
+
+# Build the gem into the pkg directory.
+def build
+	@helper.build_gem
+end
+
+# Build and install the gem into system gems.
+# @parameter local [Boolean] only use locally available caches.
+def install(local: false)
+	path = @helper.build_gem
+	
+	arguments = []
+	arguments << "--local" if local
+	
+	@helper.install_gem(*arguments, path: path)
+end
+
+def release(tag: true)
+	@helper.guard_clean
+	
+	version = @helper.gemspec.version
+	
+	if tag
+		system("git", "tag", "v#{version}")
+		system("git", "push")
+	end
+	
+	path = @helper.build_gem
+	@helper.push_gem(path: path)
+end

data/bake/gem/branch.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative '../../lib/bake/gem/shell'
+
+include Bake::Gem::Shell
+
+# Increment the patch number of the current version.
+def patch
+	commit([nil, nil, 1], message: "Bump patch version.")
+end
+
+# Increment the minor number of the current version.
+def minor
+	commit([nil, 1, 0], message: "Bump minor version.")
+end
+
+# Increment the major number of the current version.
+def major
+	commit([1, 0, 0], message: "Bump major version.")
+end
+
+# Increments the version and commits the changes into a new branch.
+#
+# @parameter bump [Array(Integer | Nil)] the version bump to apply before publishing, e.g. `0,1,0` to increment minor version number.
+# @parameter message [String] the git commit message to use.
+def commit(bump, message: "Bump version.")
+	release = context.lookup('gem:release')
+	helper = release.instance.helper
+	gemspec = helper.gemspec
+	
+	# helper.guard_clean
+	
+	version_path = context.lookup('gem:version:increment').call(bump, message: message)
+	
+	if version_path
+		system("git", "checkout", "-b", "release-v#{gemspec.version}")
+		system("git", "add", version_path, chdir: context.root)
+		system("git", "commit", "-m", message, chdir: context.root)
+	else
+		raise "Could not find version number!"
+	end
+end

data/bake/gem/version.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative '../../lib/bake/gem/shell'
+
+include Bake::Gem::Shell
+
+# Increment the patch number of the current version.
+def patch
+	commit([nil, nil, 1], message: "Bump patch version.")
+end
+
+# Increment the minor number of the current version.
+def minor
+	commit([nil, 1, 0], message: "Bump minor version.")
+end
+
+# Increment the major number of the current version.
+def major
+	commit([1, 0, 0], message: "Bump major version.")
+end
+
+# Scans the files listed in the gemspec for a file named `version.rb`. Extracts the VERSION constant and updates it according to the version bump.
+#
+# @parameter bump [Array(Integer | Nil)] the version bump to apply before publishing, e.g. `0,1,0` to increment minor version number.
+# @parameter message [String] the git commit message to use.
+def increment(bump, message: "Bump version.")
+	release = context.lookup('gem:release')
+	helper = release.instance.helper
+	gemspec = helper.gemspec
+	
+	helper.update_version(bump) do |version|
+		version_string = version.join('.')
+		
+		Console.logger.info(self) {"Updated version to #{version_string}"}
+		
+		# Ensure that any subsequent tasks use the correct version!
+		gemspec.version = ::Gem::Version.new(version_string)
+	end
+end
+
+# Increments the version and commits the changes on the current branch.
+#
+# @parameter bump [Array(Integer | Nil)] the version bump to apply before publishing, e.g. `0,1,0` to increment minor version number.
+# @parameter message [String] the git commit message to use.
+def commit(bump, message: "Bump version.")
+	helper.guard_clean
+	
+	version_path = increment(bump, message: message)
+	
+	if version_path
+		system("git", "add", version_path, chdir: context.root)
+		system("git", "commit", "-m", message, chdir: context.root)
+	else
+		raise "Could not find version number!"
+	end
+end

data/lib/bake/gem.rb

@@ -0,0 +1,8 @@
+require "bake/gem/version"
+
+module Bake
+  module Gem
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/bake/gem/helper.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'rubygems'
+require 'rubygems/package'
+
+require_relative 'shell'
+
+module Bake
+	module Gem
+		class Helper
+			include Shell
+			
+			def initialize(root = Dir.pwd, gemspec: nil)
+				@root = root
+				@gemspec = gemspec || self.find_gemspec
+			end
+			
+			attr :gemspec
+			
+			def version_path
+				@gemspec&.files.grep(/lib(.*?)version.rb/).first
+			end
+			
+			VERSION_PATTERN = /VERSION = ['"](?<value>\d+\.\d+\.\d+)(?<pre>.*?)['"]/
+			
+			def update_version(bump)
+				return unless version_path = self.version_path
+				
+				lines = File.readlines(version_path)
+				version = nil
+				
+				lines.each do |line|
+					if match = line.match(VERSION_PATTERN)
+						version = match[:value].split(/\./).map(&:to_i)
+						bump.each_with_index do |increment, index|
+							if increment == 1
+								version[index] += 1
+							elsif increment == 0
+								version[index] = 0
+							end
+						end
+						
+						line.sub!(match[:value], version.join('.'))
+					end
+				end
+				
+				if version
+					yield version if block_given?
+					
+					File.write(version_path, lines.join)
+					
+					return version_path
+				end
+			end
+			
+			def guard_clean
+				lines = readlines("git", "status", "--porcelain")
+				
+				if lines.any?
+					raise "Repository has uncommited changes!\n#{lines.join('')}"
+				end
+			end
+			
+			# @parameter root [String] The root path for package files.
+			# @returns [String] The path to the built gem package.
+			def build_gem(root: "pkg")
+				# Ensure the output directory exists:
+				FileUtils.mkdir_p("pkg")
+				
+				output_path = File.join('pkg', @gemspec.file_name)
+				
+				::Gem::Package.build(@gemspec, false, false, output_path)
+			end
+			
+			def install_gem(*arguments, path: @gemspec.file_name)
+				system("gem", "install", path, *arguments)
+			end
+			
+			def push_gem(*arguments, path: @gemspec.file_name)
+				system("gem", "push", path, *arguments)
+			end
+			
+			private
+			
+			def find_gemspec(glob = "*.gemspec")
+				paths = Dir.glob(glob, base: @root).sort
+				
+				if paths.size > 1
+					raise "Multiple gemspecs found: #{paths}, please specify one!"
+				end
+				
+				if path = paths.first
+					return ::Gem::Specification.load(path)
+				end
+			end
+		end
+	end
+end

data/lib/bake/gem/shell.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Bake
+	module Gem
+		module Shell
+			def system(*arguments, **options)
+				Console.logger.info(self, Console::Event::Spawn.for(*arguments, **options))
+				
+				begin
+					pid = Process.spawn(*arguments, **options)
+					yield if block_given?
+				ensure
+					pid, status = Process.wait2(pid) if pid
+					
+					unless status.success?
+						raise "Failed to execute #{arguments}: #{status}!"
+					end
+				end
+			end
+			
+			def execute(*arguments, **options)
+				Console.logger.info(self, Console::Event::Spawn.for(*arguments, **options))
+				
+				IO.pipe do |input, output|
+					pid = Process.spawn(*arguments, out: output, **options)
+					output.close
+					
+					begin
+						yield input
+					ensure
+						pid, status = Process.wait2(pid)
+						
+						unless status.success?
+							raise "Failed to execute #{arguments}: #{status}!"
+						end
+					end
+				end
+			end
+			
+			def readlines(*arguments, **options)
+				execute(*arguments, **options) do |output|
+					return output.readlines
+				end
+			end
+		end
+	end
+end

data/lib/bake/gem/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Bake
+	module Gem
+		VERSION = "0.1.0"
+	end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: bake-gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-16 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bake/gem.rb
+- bake/gem/branch.rb
+- bake/gem/version.rb
+- lib/bake/gem.rb
+- lib/bake/gem/helper.rb
+- lib/bake/gem/shell.rb
+- lib/bake/gem/version.rb
+homepage: https://github.com/ioquatix/bake-gem
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Release management for Ruby gems.
+test_files: []