2018-11-02 19:07:56 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2019-06-01 05:49:40 -04:00
|
|
|
require_relative "../bundler"
|
2019-04-14 02:01:35 -04:00
|
|
|
require "shellwords"
|
2018-11-02 19:07:56 -04:00
|
|
|
|
|
|
|
module Bundler
|
|
|
|
class GemHelper
|
|
|
|
include Rake::DSL if defined? Rake::DSL
|
|
|
|
|
|
|
|
class << self
|
|
|
|
# set when install'd.
|
|
|
|
attr_accessor :instance
|
|
|
|
|
|
|
|
def install_tasks(opts = {})
|
|
|
|
new(opts[:dir], opts[:name]).install
|
|
|
|
end
|
|
|
|
|
2020-06-22 06:41:13 -04:00
|
|
|
def tag_prefix=(prefix)
|
|
|
|
instance.tag_prefix = prefix
|
|
|
|
end
|
|
|
|
|
2018-11-02 19:07:56 -04:00
|
|
|
def gemspec(&block)
|
|
|
|
gemspec = instance.gemspec
|
|
|
|
block.call(gemspec) if block
|
|
|
|
gemspec
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
attr_reader :spec_path, :base, :gemspec
|
|
|
|
|
2020-06-22 06:41:13 -04:00
|
|
|
attr_writer :tag_prefix
|
|
|
|
|
2018-11-02 19:07:56 -04:00
|
|
|
def initialize(base = nil, name = nil)
|
2020-05-08 01:19:04 -04:00
|
|
|
@base = File.expand_path(base || SharedHelpers.pwd)
|
2020-10-15 00:20:25 -04:00
|
|
|
gemspecs = name ? [File.join(@base, "#{name}.gemspec")] : Gem::Util.glob_files_in_dir("{,*}.gemspec", @base)
|
2018-11-02 19:07:56 -04:00
|
|
|
raise "Unable to determine name from existing gemspec. Use :name => 'gemname' in #install_tasks to manually set it." unless gemspecs.size == 1
|
|
|
|
@spec_path = gemspecs.first
|
|
|
|
@gemspec = Bundler.load_gemspec(@spec_path)
|
2020-06-22 06:41:13 -04:00
|
|
|
@tag_prefix = ""
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def install
|
|
|
|
built_gem_path = nil
|
|
|
|
|
|
|
|
desc "Build #{name}-#{version}.gem into the pkg directory."
|
|
|
|
task "build" do
|
|
|
|
built_gem_path = build_gem
|
|
|
|
end
|
|
|
|
|
2021-04-14 23:47:04 -04:00
|
|
|
desc "Generate SHA512 checksum if #{name}-#{version}.gem into the checksums directory."
|
|
|
|
task "build:checksum" => "build" do
|
|
|
|
build_checksum(built_gem_path)
|
|
|
|
end
|
|
|
|
|
2018-11-02 19:07:56 -04:00
|
|
|
desc "Build and install #{name}-#{version}.gem into system gems."
|
|
|
|
task "install" => "build" do
|
|
|
|
install_gem(built_gem_path)
|
|
|
|
end
|
|
|
|
|
|
|
|
desc "Build and install #{name}-#{version}.gem into system gems without network access."
|
|
|
|
task "install:local" => "build" do
|
|
|
|
install_gem(built_gem_path, :local)
|
|
|
|
end
|
|
|
|
|
|
|
|
desc "Create tag #{version_tag} and build and push #{name}-#{version}.gem to #{gem_push_host}\n" \
|
|
|
|
"To prevent publishing in RubyGems use `gem_push=no rake release`"
|
|
|
|
task "release", [:remote] => ["build", "release:guard_clean",
|
|
|
|
"release:source_control_push", "release:rubygem_push"] do
|
|
|
|
end
|
|
|
|
|
|
|
|
task "release:guard_clean" do
|
|
|
|
guard_clean
|
|
|
|
end
|
|
|
|
|
|
|
|
task "release:source_control_push", [:remote] do |_, args|
|
|
|
|
tag_version { git_push(args[:remote]) } unless already_tagged?
|
|
|
|
end
|
|
|
|
|
2021-09-23 05:54:09 -04:00
|
|
|
task "release:rubygem_push" => "build" do
|
2018-11-02 19:07:56 -04:00
|
|
|
rubygem_push(built_gem_path) if gem_push?
|
|
|
|
end
|
|
|
|
|
|
|
|
GemHelper.instance = self
|
|
|
|
end
|
|
|
|
|
|
|
|
def build_gem
|
|
|
|
file_name = nil
|
2020-05-08 01:19:04 -04:00
|
|
|
sh([*gem_command, "build", "-V", spec_path]) do
|
2018-11-02 19:07:56 -04:00
|
|
|
file_name = File.basename(built_gem_path)
|
|
|
|
SharedHelpers.filesystem_access(File.join(base, "pkg")) {|p| FileUtils.mkdir_p(p) }
|
|
|
|
FileUtils.mv(built_gem_path, "pkg")
|
|
|
|
Bundler.ui.confirm "#{name} #{version} built to pkg/#{file_name}."
|
|
|
|
end
|
|
|
|
File.join(base, "pkg", file_name)
|
|
|
|
end
|
|
|
|
|
|
|
|
def install_gem(built_gem_path = nil, local = false)
|
|
|
|
built_gem_path ||= build_gem
|
2020-05-08 01:19:04 -04:00
|
|
|
cmd = [*gem_command, "install", built_gem_path.to_s]
|
|
|
|
cmd << "--local" if local
|
2021-08-25 05:40:01 -04:00
|
|
|
sh(cmd)
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler.ui.confirm "#{name} (#{version}) installed."
|
|
|
|
end
|
|
|
|
|
2021-04-14 23:47:04 -04:00
|
|
|
def build_checksum(built_gem_path = nil)
|
|
|
|
built_gem_path ||= build_gem
|
|
|
|
SharedHelpers.filesystem_access(File.join(base, "checksums")) {|p| FileUtils.mkdir_p(p) }
|
|
|
|
file_name = "#{File.basename(built_gem_path)}.sha512"
|
|
|
|
require "digest/sha2"
|
2022-01-03 10:24:58 -05:00
|
|
|
checksum = ::Digest::SHA512.file(built_gem_path).hexdigest
|
2021-04-14 23:47:04 -04:00
|
|
|
target = File.join(base, "checksums", file_name)
|
2022-01-03 10:56:54 -05:00
|
|
|
File.write(target, checksum + "\n")
|
2021-04-14 23:47:04 -04:00
|
|
|
Bundler.ui.confirm "#{name} #{version} checksum written to checksums/#{file_name}."
|
|
|
|
end
|
|
|
|
|
2020-10-15 00:20:25 -04:00
|
|
|
protected
|
2018-11-02 19:07:56 -04:00
|
|
|
|
|
|
|
def rubygem_push(path)
|
2020-05-08 01:19:04 -04:00
|
|
|
cmd = [*gem_command, "push", path]
|
2019-12-14 05:49:16 -05:00
|
|
|
cmd << "--key" << gem_key if gem_key
|
|
|
|
cmd << "--host" << allowed_push_host if allowed_push_host
|
|
|
|
sh_with_input(cmd)
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler.ui.confirm "Pushed #{name} #{version} to #{gem_push_host}"
|
|
|
|
end
|
|
|
|
|
|
|
|
def built_gem_path
|
2020-10-15 00:20:25 -04:00
|
|
|
Gem::Util.glob_files_in_dir("#{name}-*.gem", base).sort_by {|f| File.mtime(f) }.last
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
2020-10-15 00:20:25 -04:00
|
|
|
def git_push(remote = nil)
|
|
|
|
remote ||= default_remote
|
2021-11-08 18:52:49 -05:00
|
|
|
sh("git push #{remote} refs/heads/#{current_branch}".shellsplit)
|
|
|
|
sh("git push #{remote} refs/tags/#{version_tag}".shellsplit)
|
2020-10-15 00:20:25 -04:00
|
|
|
Bundler.ui.confirm "Pushed git commits and release tag."
|
|
|
|
end
|
|
|
|
|
|
|
|
def default_remote
|
2021-02-01 10:17:16 -05:00
|
|
|
remote_for_branch, status = sh_with_status(%W[git config --get branch.#{current_branch}.remote])
|
|
|
|
return "origin" unless status.success?
|
2020-10-15 00:20:25 -04:00
|
|
|
|
2021-02-01 10:17:16 -05:00
|
|
|
remote_for_branch.strip
|
|
|
|
end
|
2020-10-15 00:20:25 -04:00
|
|
|
|
2021-02-01 10:17:16 -05:00
|
|
|
def current_branch
|
|
|
|
# We can replace this with `git branch --show-current` once we drop support for git < 2.22.0
|
|
|
|
sh(%w[git rev-parse --abbrev-ref HEAD]).gsub(%r{\Aheads/}, "").strip
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def allowed_push_host
|
|
|
|
@gemspec.metadata["allowed_push_host"] if @gemspec.respond_to?(:metadata)
|
|
|
|
end
|
|
|
|
|
|
|
|
def gem_push_host
|
|
|
|
env_rubygems_host = ENV["RUBYGEMS_HOST"]
|
|
|
|
env_rubygems_host = nil if
|
|
|
|
env_rubygems_host && env_rubygems_host.empty?
|
|
|
|
|
|
|
|
allowed_push_host || env_rubygems_host || "rubygems.org"
|
|
|
|
end
|
|
|
|
|
|
|
|
def already_tagged?
|
2019-04-14 02:01:35 -04:00
|
|
|
return false unless sh(%w[git tag]).split(/\n/).include?(version_tag)
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler.ui.confirm "Tag #{version_tag} has already been created."
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
|
|
|
def guard_clean
|
|
|
|
clean? && committed? || raise("There are files that need to be committed first.")
|
|
|
|
end
|
|
|
|
|
|
|
|
def clean?
|
2019-04-14 02:01:35 -04:00
|
|
|
sh_with_status(%w[git diff --exit-code])[1].success?
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def committed?
|
2019-04-14 02:01:35 -04:00
|
|
|
sh_with_status(%w[git diff-index --quiet --cached HEAD])[1].success?
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def tag_version
|
2019-04-14 02:01:35 -04:00
|
|
|
sh %W[git tag -m Version\ #{version} #{version_tag}]
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler.ui.confirm "Tagged #{version_tag}."
|
|
|
|
yield if block_given?
|
|
|
|
rescue RuntimeError
|
|
|
|
Bundler.ui.error "Untagging #{version_tag} due to error."
|
2019-04-14 02:01:35 -04:00
|
|
|
sh_with_status %W[git tag -d #{version_tag}]
|
2018-11-02 19:07:56 -04:00
|
|
|
raise
|
|
|
|
end
|
|
|
|
|
|
|
|
def version
|
|
|
|
gemspec.version
|
|
|
|
end
|
|
|
|
|
|
|
|
def version_tag
|
2020-06-22 06:41:13 -04:00
|
|
|
"#{@tag_prefix}v#{version}"
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def name
|
|
|
|
gemspec.name
|
|
|
|
end
|
|
|
|
|
2019-06-11 05:45:09 -04:00
|
|
|
def sh_with_input(cmd)
|
|
|
|
Bundler.ui.debug(cmd)
|
|
|
|
SharedHelpers.chdir(base) do
|
|
|
|
abort unless Kernel.system(*cmd)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-11-02 19:07:56 -04:00
|
|
|
def sh(cmd, &block)
|
2019-04-14 02:01:35 -04:00
|
|
|
out, status = sh_with_status(cmd, &block)
|
|
|
|
unless status.success?
|
2021-08-25 08:49:49 -04:00
|
|
|
raise("Running `#{cmd.shelljoin}` failed with the following output:\n\n#{out}\n")
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
out
|
|
|
|
end
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
def sh_with_status(cmd, &block)
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler.ui.debug(cmd)
|
|
|
|
SharedHelpers.chdir(base) do
|
2019-04-14 02:01:35 -04:00
|
|
|
outbuf = IO.popen(cmd, :err => [:child, :out], &:read)
|
|
|
|
status = $?
|
|
|
|
block.call(outbuf) if status.success? && block
|
2018-11-02 19:07:56 -04:00
|
|
|
[outbuf, status]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def gem_key
|
|
|
|
Bundler.settings["gem.push_key"].to_s.downcase if Bundler.settings["gem.push_key"]
|
|
|
|
end
|
|
|
|
|
|
|
|
def gem_push?
|
|
|
|
!%w[n no nil false off 0].include?(ENV["gem_push"].to_s.downcase)
|
|
|
|
end
|
2019-12-14 05:49:16 -05:00
|
|
|
|
|
|
|
def gem_command
|
2020-05-08 01:19:04 -04:00
|
|
|
ENV["GEM_COMMAND"]&.shellsplit || ["gem"]
|
2019-12-14 05:49:16 -05:00
|
|
|
end
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
end
|