2018-11-02 19:07:56 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2019-06-01 05:49:40 -04:00
|
|
|
require_relative "vendored_thor" unless defined?(Thor)
|
|
|
|
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
|
|
|
|
|
|
|
|
def gemspec(&block)
|
|
|
|
gemspec = instance.gemspec
|
|
|
|
block.call(gemspec) if block
|
|
|
|
gemspec
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
attr_reader :spec_path, :base, :gemspec
|
|
|
|
|
|
|
|
def initialize(base = nil, name = nil)
|
|
|
|
Bundler.ui = UI::Shell.new
|
|
|
|
@base = (base ||= SharedHelpers.pwd)
|
|
|
|
gemspecs = name ? [File.join(base, "#{name}.gemspec")] : Dir[File.join(base, "{,*}.gemspec")]
|
|
|
|
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)
|
|
|
|
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
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
task "release:rubygem_push" do
|
|
|
|
rubygem_push(built_gem_path) if gem_push?
|
|
|
|
end
|
|
|
|
|
|
|
|
GemHelper.instance = self
|
|
|
|
end
|
|
|
|
|
|
|
|
def build_gem
|
|
|
|
file_name = nil
|
Fix some bundler specs (#2380)
* These seem to consistenly pass already
* Show actual command when running `make test-bundler`
Current the setup command that installs the necessary gems for testing
bundler was printed, but not the actual command that runs the tests.
That was a bit confusing.
* Borrow trick from setproctitle specs
* A title that long doesn't get set sometimes
No idea why, but the test doesn't need that the title is that long.
* Fix most gem helper spec ruby-core failures
* Fix the rest of the gem helper failures
* Fix version spec by improving the assertion
* Remove unnecessary `BUNDLE_RUBY` environment var
We can use `RUBY` when necessary, and `BUNDLE_RUBY` is not a good name
because bundler considers `BUNDLE_*` variables as settings.
* Rename `BUNDLE_GEM` to `GEM_COMMAND`
This is more descriptive I think, and also friendlier for bundler
because `BUNDLE_` env variables are interpreted by bundler as settings,
and this is not a bundler setting.
This fixes one bundler spec failure in config specs against ruby-core.
* Fix quality spec when run in core
Use the proper path helper.
* Fix dummy lib builder to never load default gems
If a dummy library is named as a default gem, when requiring the library
from its executable, the default gem would be loaded when running from
core, because in core all default gems share path with bundler, and thus
they are always in the $LOAD_PATH. We fix the issue by loading lib
relatively inside dummy lib executables.
* More exact assertions
Sometimes I have the problem that I do some "print debugging" inside
specs, and suddently the spec passes. This happens when the assertion is
too relaxed, and the things I print make it match, specially when they
are simple strings like "1.0" than can be easily be part of gem paths
that I print for debugging.
I fix this by making a more exact assertion.
* Detect the correct shebang when ENV["RUBY"] is set
* Relax assertion
So that the spec passes even if another paths containing "ext" are in
the load path. This works to fix a ruby-core issue, but it's a better
assertion in general. We just want to know that the extension path was
added.
* Use folder structure independent path helper
It should fix this spec for ruby-core.
* Fix the last failing spec on ruby-core
* Skip `bundle open <default_gem>` spec when no default gems
2019-08-19 20:46:31 -04:00
|
|
|
gem = ENV["GEM_COMMAND"] ? ENV["GEM_COMMAND"] : "gem"
|
|
|
|
sh("#{gem} build -V #{spec_path}".shellsplit) 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
|
Fix some bundler specs (#2380)
* These seem to consistenly pass already
* Show actual command when running `make test-bundler`
Current the setup command that installs the necessary gems for testing
bundler was printed, but not the actual command that runs the tests.
That was a bit confusing.
* Borrow trick from setproctitle specs
* A title that long doesn't get set sometimes
No idea why, but the test doesn't need that the title is that long.
* Fix most gem helper spec ruby-core failures
* Fix the rest of the gem helper failures
* Fix version spec by improving the assertion
* Remove unnecessary `BUNDLE_RUBY` environment var
We can use `RUBY` when necessary, and `BUNDLE_RUBY` is not a good name
because bundler considers `BUNDLE_*` variables as settings.
* Rename `BUNDLE_GEM` to `GEM_COMMAND`
This is more descriptive I think, and also friendlier for bundler
because `BUNDLE_` env variables are interpreted by bundler as settings,
and this is not a bundler setting.
This fixes one bundler spec failure in config specs against ruby-core.
* Fix quality spec when run in core
Use the proper path helper.
* Fix dummy lib builder to never load default gems
If a dummy library is named as a default gem, when requiring the library
from its executable, the default gem would be loaded when running from
core, because in core all default gems share path with bundler, and thus
they are always in the $LOAD_PATH. We fix the issue by loading lib
relatively inside dummy lib executables.
* More exact assertions
Sometimes I have the problem that I do some "print debugging" inside
specs, and suddently the spec passes. This happens when the assertion is
too relaxed, and the things I print make it match, specially when they
are simple strings like "1.0" than can be easily be part of gem paths
that I print for debugging.
I fix this by making a more exact assertion.
* Detect the correct shebang when ENV["RUBY"] is set
* Relax assertion
So that the spec passes even if another paths containing "ext" are in
the load path. This works to fix a ruby-core issue, but it's a better
assertion in general. We just want to know that the extension path was
added.
* Use folder structure independent path helper
It should fix this spec for ruby-core.
* Fix the last failing spec on ruby-core
* Skip `bundle open <default_gem>` spec when no default gems
2019-08-19 20:46:31 -04:00
|
|
|
gem = ENV["GEM_COMMAND"] ? ENV["GEM_COMMAND"] : "gem"
|
|
|
|
cmd = "#{gem} install #{built_gem_path}"
|
|
|
|
cmd += " --local" if local
|
|
|
|
out, status = sh_with_status(cmd.shellsplit)
|
2019-04-14 02:01:35 -04:00
|
|
|
unless status.success? && out[/Successfully installed/]
|
|
|
|
raise "Couldn't install gem, run `gem install #{built_gem_path}' for more detailed output"
|
|
|
|
end
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler.ui.confirm "#{name} (#{version}) installed."
|
|
|
|
end
|
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
def rubygem_push(path)
|
2019-04-14 02:01:35 -04:00
|
|
|
gem_command = %W[gem push #{path}]
|
|
|
|
gem_command << "--key" << gem_key if gem_key
|
|
|
|
gem_command << "--host" << allowed_push_host if allowed_push_host
|
2018-11-02 19:07:56 -04:00
|
|
|
unless allowed_push_host || Bundler.user_home.join(".gem/credentials").file?
|
|
|
|
raise "Your rubygems.org credentials aren't set. Run `gem push` to set them."
|
|
|
|
end
|
2019-06-11 05:45:09 -04:00
|
|
|
sh_with_input(gem_command)
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler.ui.confirm "Pushed #{name} #{version} to #{gem_push_host}"
|
|
|
|
end
|
|
|
|
|
|
|
|
def built_gem_path
|
|
|
|
Dir[File.join(base, "#{name}-*.gem")].sort_by {|f| File.mtime(f) }.last
|
|
|
|
end
|
|
|
|
|
|
|
|
def git_push(remote = "")
|
|
|
|
perform_git_push remote
|
|
|
|
perform_git_push "#{remote} --tags"
|
|
|
|
Bundler.ui.confirm "Pushed git commits and tags."
|
|
|
|
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 perform_git_push(options = "")
|
|
|
|
cmd = "git push #{options}"
|
2019-04-14 02:01:35 -04:00
|
|
|
out, status = sh_with_status(cmd)
|
|
|
|
return if status.success?
|
|
|
|
cmd = cmd.shelljoin if cmd.respond_to?(:shelljoin)
|
|
|
|
raise "Couldn't git push. `#{cmd}' failed with the following output:\n\n#{out}\n"
|
2018-11-02 19:07:56 -04:00
|
|
|
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
|
|
|
|
"v#{version}"
|
|
|
|
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?
|
|
|
|
cmd = cmd.shelljoin if cmd.respond_to?(:shelljoin)
|
2018-11-02 19:07:56 -04:00
|
|
|
raise(out.empty? ? "Running `#{cmd}` failed. Run this command directly for more detailed output." : out)
|
|
|
|
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
|
|
|
|
end
|
|
|
|
end
|