Class: Bundler::GemHelper

### Home Classes Methods

### In Files

- lib/bundler/gem_helper.rb

### Parent

Object

### Methods

- ::gemspec
- ::install_tasks
- ::new
- #already_tagged?
- #build_gem
- #built_gem_path
- #clean?
- #committed?
- #gem_push?
- #git_push
- #guard_clean
- #install
- #install_gem
- #name
- #perform_git_push
- #release_gem
- #rubygem_push
- #sh
- #sh_with_code
- #tag_version
- #version
- #version_tag

### Included Modules

- Rake::DSL

### Files

- bundle
- bundle-config
- bundle-config.txt
- bundle-exec
- bundle-exec.txt
- bundle-install
- bundle-install.txt
- bundle-package
- bundle-package.txt
- bundle-platform
- bundle-platform.txt
- bundle-update
- bundle-update.txt
- bundle.txt
- gemfile.5.txt
- Executable
- Gemfile

### Class/Module Index

Quicksearch

- Bundler
- Bundler::BundlerError
- Bundler::CLI
- Bundler::Definition
- Bundler::DepProxy
- Bundler::Dependency
- Bundler::Deployment
- Bundler::Deprecate
- Bundler::DeprecatedError
- Bundler::Dsl
- Bundler::EndpointSpecification
- Bundler::Env
- Bundler::Environment
- Bundler::Fetcher
- Bundler::Fetcher::CertificateFailureError
- Bundler::Fetcher::FallbackError
- Bundler::Fetcher::SSLError
- Bundler::GemHelper
- Bundler::GemHelpers
- Bundler::GemInstaller
- Bundler::GemNotFound
- Bundler::GemfileError
- Bundler::GemfileNotFound
- Bundler::GemspecError
- Bundler::GitError
- Bundler::Graph
- Bundler::Graph::GraphVizClient
- Bundler::HTTPError
- Bundler::Index
- Bundler::Injector
- Bundler::InstallError
- Bundler::InstallHookError
- Bundler::Installer
- Bundler::InvalidOption
- Bundler::InvalidSpecSet
- Bundler::LazySpecification
- Bundler::LockfileError
- Bundler::LockfileParser
- Bundler::MarshalError
- Bundler::MatchPlatform
- Bundler::PathError
- Bundler::ProductionError
- Bundler::RemoteSpecification
- Bundler::Resolver
- Bundler::Resolver::SpecGroup
- Bundler::RubyDsl
- Bundler::RubyVersion
- Bundler::RubyVersionMismatch
- Bundler::RubygemsIntegration
- Bundler::RubygemsIntegration::AlmostModern
- Bundler::RubygemsIntegration::Ancient
- Bundler::RubygemsIntegration::Future
- Bundler::RubygemsIntegration::Gem
- Bundler::RubygemsIntegration::Gem::SourceIndex
- Bundler::RubygemsIntegration::Legacy
- Bundler::RubygemsIntegration::Modern
- Bundler::RubygemsIntegration::Transitional
- Bundler::Runtime
- Bundler::SecurityError
- Bundler::Settings
- Bundler::SharedHelpers
- Bundler::SimilarityDetector
- Bundler::Source
- Bundler::Source::Git
- Bundler::Source::Git::GitProxy
- Bundler::Source::Path
- Bundler::Source::Path::Installer
- Bundler::Source::Rubygems
- Bundler::SpecSet
- Bundler::SystemRubyVersion
- Bundler::UI
- Bundler::UI::RGProxy
- Bundler::UI::Shell
- Bundler::VersionConflict
- Gem
- Gem::Dependency
- Gem::Platform
- Gem::Requirement
- Gem::Specification
- Object

No matching classes.

# Bundler::GemHelper

### Attributes

instance[RW]

set when install'd.

base[R]
gemspec[R]
spec_path[R]

### Public Class Methods

gemspec(&block) click to toggle source

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

install_tasks(opts = {}) click to toggle source

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

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

    # File lib/bundler/gem_helper.rb, line 26
    def initialize(base = nil, name = nil)
      Bundler.ui = UI::Shell.new
      @base = (base ||= Dir.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

### Public Instance Methods

build_gem() click to toggle source

    # File lib/bundler/gem_helper.rb, line 56
    def build_gem
      file_name = nil
      sh("gem build -V '#{spec_path}'") { |out, code|
        file_name = File.basename(built_gem_path)
        FileUtils.mkdir_p(File.join(base, 'pkg'))
        FileUtils.mv(built_gem_path, 'pkg')
        Bundler.ui.confirm "#{name} #{version} built to pkg/#{file_name}."
      }
      File.join(base, 'pkg', file_name)
    end

install() click to toggle source

    # File lib/bundler/gem_helper.rb, line 35
    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 "Create tag #{version_tag} and build and push #{name}-#{version}.gem to Rubygems"
      task 'release' => 'build' do
        release_gem(built_gem_path)
      end

      GemHelper.instance = self
    end

install_gem(built_gem_path=nil) click to toggle source

    # File lib/bundler/gem_helper.rb, line 67
    def install_gem(built_gem_path=nil)
      built_gem_path ||= build_gem
      out, _ = sh_with_code("gem install '#{built_gem_path}' --local")
      raise "Couldn't install gem, run `gem install #{built_gem_path}' for more detailed output" unless out[/Successfully installed/]
      Bundler.ui.confirm "#{name} (#{version}) installed."
    end

release_gem(built_gem_path=nil) click to toggle source

    # File lib/bundler/gem_helper.rb, line 74
    def release_gem(built_gem_path=nil)
      guard_clean
      built_gem_path ||= build_gem
      tag_version { git_push } unless already_tagged?
      rubygem_push(built_gem_path) if gem_push?
    end

### Protected Instance Methods

already_tagged?() click to toggle source

    # File lib/bundler/gem_helper.rb, line 107
    def already_tagged?
      if sh('git tag').split(/\n/).include?(version_tag)
        Bundler.ui.confirm "Tag #{version_tag} has already been created."
        true
      end
    end

built_gem_path() click to toggle source

    # File lib/bundler/gem_helper.rb, line 91
    def built_gem_path
      Dir[File.join(base, "#{name}-*.gem")].sort_by{|f| File.mtime(f)}.last
    end

clean?() click to toggle source

    # File lib/bundler/gem_helper.rb, line 118
    def clean?
      sh_with_code("git diff --exit-code")[1] == 0
    end

committed?() click to toggle source

    # File lib/bundler/gem_helper.rb, line 122
    def committed?
      sh_with_code("git diff-index --quiet --cached HEAD")[1] == 0
    end

gem_push?() click to toggle source

    # File lib/bundler/gem_helper.rb, line 166
    def gem_push?
      ! %{n no nil false off 0}.include?(ENV['gem_push'].to_s.downcase)
    end

git_push() click to toggle source

    # File lib/bundler/gem_helper.rb, line 95
    def git_push
      perform_git_push
      perform_git_push ' --tags'
      Bundler.ui.confirm "Pushed git commits and tags."
    end

guard_clean() click to toggle source

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

name() click to toggle source

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

perform_git_push(options = '') click to toggle source

    # File lib/bundler/gem_helper.rb, line 101
    def perform_git_push(options = '')
      cmd = "git push #{options}"
      out, code = sh_with_code(cmd)
      raise "Couldn't git push. `#{cmd}' failed with the following output:\n\n#{out}\n" unless code == 0
    end

rubygem_push(path) click to toggle source

    # File lib/bundler/gem_helper.rb, line 82
    def rubygem_push(path)
      if Pathname.new("~/.gem/credentials").expand_path.exist?
        sh("gem push '#{path}'")
        Bundler.ui.confirm "Pushed #{name} #{version} to rubygems.org."
      else
        raise "Your rubygems.org credentials aren't set. Run `gem push` to set them."
      end
    end

sh(cmd, &block) click to toggle source

    # File lib/bundler/gem_helper.rb, line 148
    def sh(cmd, &block)
      out, code = sh_with_code(cmd, &block)
      code == 0 ? out : raise(out.empty? ? "Running `#{cmd}' failed. Run this command directly for more detailed output." : out)
    end

sh_with_code(cmd, &block) click to toggle source

    # File lib/bundler/gem_helper.rb, line 153
    def sh_with_code(cmd, &block)
      cmd << " 2>&1"
      outbuf = ''
      Bundler.ui.debug(cmd)
      Dir.chdir(base) {
        outbuf = `#{cmd}`
        if $? == 0
          block.call(outbuf) if block
        end
      }
      [outbuf, $?]
    end

tag_version() click to toggle source

    # File lib/bundler/gem_helper.rb, line 126
    def tag_version
      sh "git tag -a -m \"Version #{version}\" #{version_tag}"
      Bundler.ui.confirm "Tagged #{version_tag}."
      yield if block_given?
    rescue
      Bundler.ui.error "Untagging #{version_tag} due to error."
      sh_with_code "git tag -d #{version_tag}"
      raise
    end

version() click to toggle source

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

version_tag() click to toggle source

    # File lib/bundler/gem_helper.rb, line 140
    def version_tag
      "v#{version}"
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.