module Hoe::Package

Package plugin for hoe.

Tasks Provided:¶ ↑

install_gem: Install the package as a gem.
prerelease: Hook for pre-release actions like sanity checks.
postrelease: Hook for post-release actions like release announcements.
release: Package and upload the release.

Attributes

need_tar[RW]

Optional: Should package create a tarball? [default: true]

need_zip[RW]

Optional: Should package create a zipfile? [default: false]

Public Instance Methods

define_package_tasks() click to toggle source

Define tasks for plugin.

# File lib/hoe/package.rb, line 42
def define_package_tasks
  prerelease_version

  Gem::PackageTask.new spec do |pkg|
    pkg.need_tar = @need_tar
    pkg.need_zip = @need_zip
  end

  desc "Install the package as a gem. (opt. NOSUDO=1)"
  task :install_gem => [:clean, :package, :check_extra_deps] do
    install_gem Dir["pkg/*.gem"].first
  end

  desc "Package and upload; Requires VERSION=x.y.z (optional PRE=a.1)"
  task :release => [:prerelease, :release_to, :postrelease]

  # no doco, invisible hook
  task :prerelease do
    abort "Fix your version before you release" if spec.version.to_s =~ /borked/
  end

  # no doco, invisible hook
  task :release_to

  # no doco, invisible hook
  task :postrelease

  desc "Sanity checks for release"
  task :release_sanity do
    v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"

    pre = ENV["PRERELEASE"] || ENV["PRE"]
    v += ".#{pre}" if pre

    c = changes[/\d\S+/]

    abort "Versions don't match: %s vs %s" % [v, version] if v != version
    abort "Versions don't match %s: %s vs %s" % [history_file, v, c] if v != c
  end
end

initialize_package() click to toggle source

Initialize variables for plugin.

# File lib/hoe/package.rb, line 34
def initialize_package
  self.need_tar ||= false
  self.need_zip ||= false
end

install_gem(name, version = nil, rdoc = true) click to toggle source

Install the named gem.

# File lib/hoe/package.rb, line 94
def install_gem name, version = nil, rdoc = true
  should_not_sudo = Hoe::WINDOZE || ENV["NOSUDO"] || File.writable?(Gem.dir)
  null_dev = Hoe::WINDOZE ? "> NUL 2>&1" : "> /dev/null 2>&1"

  sudo    = "sudo "                  unless should_not_sudo
  local   = "--local"                unless version
  version = "--version '#{version}'" if     version

  cmd  = "#{sudo}gem install #{local} #{name} #{version}"
  cmd += " --no-document" unless rdoc
  cmd += " #{null_dev}" unless Rake.application.options.trace

  result = sh cmd
  Gem::Specification.reset
  result
end

pkg_path() click to toggle source

Returns the path used for packaging. Convenience method for those that need to write a package hook.

# File lib/hoe/package.rb, line 87
def pkg_path
  "pkg/#{spec.full_name}"
end