technicalpickles/jeweler

View on GitHub
lib/jeweler.rb

Summary

Maintainability
A
3 hrs
Test Coverage
require 'pathname'
require 'date'
require 'jeweler/version'

# A Jeweler helps you craft the perfect Rubygem. Give him a gemspec, and he takes care of the rest.
#
# See Jeweler::Tasks for examples of how to get started. Additionally, resources are available on the wiki:
#
# * http://wiki.github.com/technicalpickles/jeweler/create-a-new-project
# * http://wiki.github.com/technicalpickles/jeweler/configure-an-existing-project
class Jeweler
  require 'jeweler/errors'
  require 'rubygems/user_interaction'
  require 'rubygems/package'

  autoload :Generator,      'jeweler/generator'

  autoload :Commands,       'jeweler/commands'

  autoload :VersionHelper,  'jeweler/version_helper'
  autoload :GemSpecHelper,  'jeweler/gemspec_helper'

  autoload :Tasks,          'jeweler/tasks'
  autoload :RubygemsDotOrgTasks, 'jeweler/rubygems_dot_org_tasks'
  autoload :GemcutterTasks, 'jeweler/gemcutter_tasks'
  autoload :RubyforgeTasks, 'jeweler/rubyforge_tasks'
  autoload :Specification,  'jeweler/specification'

  attr_reader :gemspec, :gemspec_helper, :version_helper
  attr_accessor :base_dir, :output, :repo, :commit

  def initialize(gemspec, base_dir = '.')
    raise(GemspecError, "Can't create a Jeweler with a nil gemspec") if gemspec.nil?

    @gemspec = gemspec
    @gemspec.extend(Specification)
    @gemspec.set_jeweler_defaults(base_dir, git_base_dir)

    @base_dir       = base_dir
    @repo           = Git.open(git_base_dir) if in_git_repo?
    @version_helper = Jeweler::VersionHelper.new(base_dir)
    @output         = $stdout
    @commit         = true
    @gemspec_helper = GemSpecHelper.new(gemspec, base_dir)
  end

  # Major version, as defined by the gemspec's Version module.
  # For 1.5.3, this would return 1.
  def major_version
    @version_helper.major
  end

  # Minor version, as defined by the gemspec's Version module.
  # For 1.5.3, this would return 5.
  def minor_version
    @version_helper.minor
  end

  # Patch version, as defined by the gemspec's Version module.
  # For 1.5.3, this would return 5.
  def patch_version
    @version_helper.patch
  end

  # Human readable version, which is used in the gemspec.
  def version
    @gemspec.version || @version_helper.to_s
  end

  # Writes out the gemspec
  def write_gemspec
    Jeweler::Commands::WriteGemspec.build_for(self).run
  end

  # Validates the project's gemspec from disk in an environment similar to how
  # GitHub would build from it. See http://gist.github.com/16215
  def validate_gemspec
    Jeweler::Commands::ValidateGemspec.build_for(self).run
  end

  # is the project's gemspec from disk valid?
  def valid_gemspec?
    gemspec_helper.valid?
  end

  # Build a gem using the project's latest Gem::Specification
  def build_gem
    Jeweler::Commands::BuildGem.build_for(self).run
  end

  # Install a previously built gem
  def install_gem
    Jeweler::Commands::InstallGem.build_for(self).run
  end

  # Bumps the patch version.
  #
  # 1.5.1 -> 1.5.2
  def bump_patch_version
    Jeweler::Commands::Version::BumpPatch.build_for(self).run
  end

  # Bumps the minor version.
  #
  # 1.5.1 -> 1.6.0
  def bump_minor_version
    Jeweler::Commands::Version::BumpMinor.build_for(self).run
  end

  # Bumps the major version.
  #
  # 1.5.1 -> 2.0.0
  def bump_major_version
    Jeweler::Commands::Version::BumpMajor.build_for(self).run
  end

  # Bumps the version, to the specific major/minor/patch version, writing out the appropriate version.rb, and then reloads it.
  def write_version(major, minor, patch, build, _options = {})
    command = Jeweler::Commands::Version::Write.build_for(self)
    command.major = major
    command.minor = minor
    command.patch = patch
    command.build = build

    command.run
  end

  def release_gemspec(args)
    Jeweler::Commands::ReleaseGemspec.build_for(self).run(args)
  end

  def release_to_git(args)
    Jeweler::Commands::ReleaseToGit.build_for(self).run(args)
  end

  def release_gem_to_rubygems
    Jeweler::Commands::ReleaseToRubygems.build_for(self).run
  end

  def release_gem_to_rubyforge
    # no-op
  end

  def setup_rubyforge
    # no-op
  end

  def check_dependencies(type = nil)
    command = Jeweler::Commands::CheckDependencies.build_for(self)
    command.type = type

    command.run
  end

  def git_base_dir(base_dir = nil)
    base_dir = if base_dir
                 File.dirname(base_dir)
               else
                 File.expand_path(self.base_dir || '.')
               end
    return nil if base_dir == File.dirname('/')
    return base_dir if File.exist?(File.join(base_dir, '.git'))
    git_base_dir(base_dir)
  end

  def in_git_repo?
    git_base_dir
  end

  def version_file_exist?
    File.exist?(@version_helper.plaintext_path) || File.exist?(@version_helper.yaml_path)
  end

  def expects_version_file?
    gemspec.version.nil?
  end
end