Home Classes Methods

In Files

bundler/gem_helper.rb

Parent

Object

Methods

::gemspec
::install_tasks
::new
::tag_prefix=
#allowed_push_host
#already_tagged?
#build_checksum
#build_gem
#built_gem_path
#clean?
#committed?
#current_branch
#default_remote
#gem_command
#gem_key
#gem_push?
#gem_push_host
#git_push
#guard_clean
#install
#install_gem
#name
#perform_git_push
#rubygem_push
#sh
#sh_with_input
#sh_with_status
#tag_version
#version
#version_tag

Class/Module Index

Bundler::GemHelper

Attributes

instance[RW]

set when install'd.

base[R]

gemspec[R]

spec_path[R]

tag_prefix[W]

Public Class Methods

gemspec(&block) click to toggle source

 
               # File bundler/gem_helper.rb, line 22
def gemspec(&block)
  gemspec = instance.gemspec
  block.call(gemspec) if block
  gemspec
end

install_tasks(opts = {}) click to toggle source

 
               # File bundler/gem_helper.rb, line 14
def install_tasks(opts = {})
  new(opts[:dir], opts[:name]).install
end

new(base = nil, name = nil) click to toggle source

 
               # File bundler/gem_helper.rb, line 33
def initialize(base = nil, name = nil)
  @base = File.expand_path(base || SharedHelpers.pwd)
  gemspecs = name ? [File.join(@base, "#{name}.gemspec")] : Gem::Util.glob_files_in_dir("{,*}.gemspec", @base)
  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)
  @tag_prefix = ""
end

tag_prefix=(prefix) click to toggle source

 
               # File bundler/gem_helper.rb, line 18
def tag_prefix=(prefix)
  instance.tag_prefix = prefix
end

Public Instance Methods

build_checksum(built_gem_path = nil) click to toggle source

 
               # File bundler/gem_helper.rb, line 108
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"
  checksum = Digest::SHA512.new.hexdigest(built_gem_path.to_s)
  target = File.join(base, "checksums", file_name)
  File.write(target, checksum)
  Bundler.ui.confirm "#{name} #{version} checksum written to checksums/#{file_name}."
end

build_gem() click to toggle source

 
               # File bundler/gem_helper.rb, line 86
def build_gem
  file_name = nil
  sh([*gem_command, "build", "-V", spec_path]) do
    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

install() click to toggle source

 
               # File bundler/gem_helper.rb, line 42
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 "Generate SHA512 checksum if #{name}-#{version}.gem into the checksums directory."
  task "build:checksum" => "build" do
    build_checksum(built_gem_path)
  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

install_gem(built_gem_path = nil, local = false) click to toggle source

 
               # File bundler/gem_helper.rb, line 97
def install_gem(built_gem_path = nil, local = false)
  built_gem_path ||= build_gem
  cmd = [*gem_command, "install", built_gem_path.to_s]
  cmd << "--local" if local
  _, status = sh_with_status(cmd)
  unless status.success?
    raise "Couldn't install gem, run `gem install #{built_gem_path}' for more detailed output"
  end
  Bundler.ui.confirm "#{name} (#{version}) installed."
end

Protected Instance Methods

allowed_push_host() click to toggle source

 
               # File bundler/gem_helper.rb, line 152
def allowed_push_host
  @gemspec.metadata["allowed_push_host"] if @gemspec.respond_to?(:metadata)
end

already_tagged?() click to toggle source

 
               # File bundler/gem_helper.rb, line 171
def already_tagged?
  return false unless sh(%w[git tag]).split(/\n/).include?(version_tag)
  Bundler.ui.confirm "Tag #{version_tag} has already been created."
  true
end

built_gem_path() click to toggle source

 
               # File bundler/gem_helper.rb, line 129
def built_gem_path
  Gem::Util.glob_files_in_dir("#{name}-*.gem", base).sort_by {|f| File.mtime(f) }.last
end

clean?() click to toggle source

 
               # File bundler/gem_helper.rb, line 181
def clean?
  sh_with_status(%w[git diff --exit-code])[1].success?
end

committed?() click to toggle source

 
               # File bundler/gem_helper.rb, line 185
def committed?
  sh_with_status(%w[git diff-index --quiet --cached HEAD])[1].success?
end

current_branch() click to toggle source

 
               # File bundler/gem_helper.rb, line 147
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
end

default_remote() click to toggle source

 
               # File bundler/gem_helper.rb, line 140
def default_remote
  remote_for_branch, status = sh_with_status(%W[git config --get branch.#{current_branch}.remote])
  return "origin" unless status.success?

  remote_for_branch.strip
end

gem_command() click to toggle source

 
               # File bundler/gem_helper.rb, line 245
def gem_command
  ENV["GEM_COMMAND"]&.shellsplit || ["gem"]
end

gem_key() click to toggle source

 
               # File bundler/gem_helper.rb, line 237
def gem_key
  Bundler.settings["gem.push_key"].to_s.downcase if Bundler.settings["gem.push_key"]
end

gem_push?() click to toggle source

 
               # File bundler/gem_helper.rb, line 241
def gem_push?
  !%w[n no nil false off 0].include?(ENV["gem_push"].to_s.downcase)
end

gem_push_host() click to toggle source

 
               # File bundler/gem_helper.rb, line 156
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

git_push(remote = nil) click to toggle source

 
               # File bundler/gem_helper.rb, line 133
def git_push(remote = nil)
  remote ||= default_remote
  perform_git_push "#{remote} refs/heads/#{current_branch}"
  perform_git_push "#{remote} refs/tags/#{version_tag}"
  Bundler.ui.confirm "Pushed git commits and release tag."
end

guard_clean() click to toggle source

 
               # File bundler/gem_helper.rb, line 177
def guard_clean
  clean? && committed? || raise("There are files that need to be committed first.")
end

name() click to toggle source

 
               # File bundler/gem_helper.rb, line 207
def name
  gemspec.name
end

perform_git_push(options = "") click to toggle source

 
               # File bundler/gem_helper.rb, line 164
def perform_git_push(options = "")
  cmd = "git push #{options}"
  out, status = sh_with_status(cmd.shellsplit)
  return if status.success?
  raise "Couldn't git push. `#{cmd}' failed with the following output:\n\n#{out}\n"
end

rubygem_push(path) click to toggle source

 
               # File bundler/gem_helper.rb, line 121
def rubygem_push(path)
  cmd = [*gem_command, "push", path]
  cmd << "--key" << gem_key if gem_key
  cmd << "--host" << allowed_push_host if allowed_push_host
  sh_with_input(cmd)
  Bundler.ui.confirm "Pushed #{name} #{version} to #{gem_push_host}"
end

sh(cmd, &block) click to toggle source

 
               # File bundler/gem_helper.rb, line 218
def sh(cmd, &block)
  out, status = sh_with_status(cmd, &block)
  unless status.success?
    cmd = cmd.shelljoin if cmd.respond_to?(:shelljoin)
    raise(out.empty? ? "Running `#{cmd}` failed. Run this command directly for more detailed output." : out)
  end
  out
end

sh_with_input(cmd) click to toggle source

 
               # File bundler/gem_helper.rb, line 211
def sh_with_input(cmd)
  Bundler.ui.debug(cmd)
  SharedHelpers.chdir(base) do
    abort unless Kernel.system(*cmd)
  end
end

sh_with_status(cmd, &block) click to toggle source

 
               # File bundler/gem_helper.rb, line 227
def sh_with_status(cmd, &block)
  Bundler.ui.debug(cmd)
  SharedHelpers.chdir(base) do
    outbuf = IO.popen(cmd, :err => [:child, :out], &:read)
    status = $?
    block.call(outbuf) if status.success? && block
    [outbuf, status]
  end
end

tag_version() click to toggle source

 
               # File bundler/gem_helper.rb, line 189
def tag_version
  sh %W[git tag -m Version\ #{version} #{version_tag}]
  Bundler.ui.confirm "Tagged #{version_tag}."
  yield if block_given?
rescue RuntimeError
  Bundler.ui.error "Untagging #{version_tag} due to error."
  sh_with_status %W[git tag -d #{version_tag}]
  raise
end

version() click to toggle source

 
               # File bundler/gem_helper.rb, line 199
def version
  gemspec.version
end

version_tag() click to toggle source

 
               # File bundler/gem_helper.rb, line 203
def version_tag
  "#{@tag_prefix}v#{version}"
end