class Juwelier::Tasks

Rake tasks for managing your gem.

Here's a basic usage example:

Juwelier::Tasks.new do |gem|
  gem.name = "juwelier"
  gem.summary = "Simple and opinionated helper for creating RubyGem projects on GitHub"
  gem.email = "fred.mitchell@gmx.com"
  gem.homepage = "http://github.com/flajann2/juwelier"
  gem.description = "Simple and opinionated helper for creating RubyGem projects on GitHub"
  gem.authors = ["Fred Mitchell"]
end

The block variable gem is actually a Gem::Specification, so you can do anything you would normally do with a Gem::Specification. For more details, see the official gemspec reference: guides.rubygems.org/specification-reference

In addition, it provides reasonable defaults for several values. See Juwelier::Specification for more details.

Attributes

gemspec[RW]
gemspec_building_block[RW]
juwelier[RW]

Public Class Methods

new(gemspec = nil, &gemspec_building_block) click to toggle source
# File lib/juwelier/tasks.rb, line 42
def initialize(gemspec = nil, &gemspec_building_block)
  @gemspec = gemspec || Gem::Specification.new
  self.gemspec_building_block = gemspec_building_block

  Rake.application.juwelier_tasks = self
  define
end

Private Instance Methods

define() click to toggle source
# File lib/juwelier/tasks.rb, line 80
def define
  task :version_required do
    if juwelier.expects_version_file? && !juwelier.version_file_exists?
      abort "Expected VERSION or VERSION.yml to exist. Use 'rake version:write' to create an initial one."
    end
  end

  task :gemspec_required do
    if ! File.exist?(juwelier.gemspec_helper.path)
      abort "Expected #{juwelier.gemspec_helper.path} to exist. See 'rake gemspec:write' to create it"
    end
  end


  desc "Build gem into pkg/"
  task :build do
    juwelier.build_gem
  end



  desc "Build and install gem using `gem install`"
  task :install => [:build] do
    juwelier.install_gem
  end

  desc "Displays the current version"
  task :version => :version_required do
    $stdout.puts "Current version: #{juwelier.version}"
  end

  desc "Release gem"
  task :release => :clean do
  end

  desc "Generate and validate gemspec"
  task :gemspec => ['gemspec:generate', 'gemspec:validate']

  namespace :gemspec do
    desc "Validates the gemspec on the filesystem"
    task :validate => :gemspec_required do
      juwelier.validate_gemspec
    end

    desc "Regenerate the gemspec on the filesystem"
    task :generate => :version_required do
      juwelier.write_gemspec
    end

    desc "Display the gemspec for debugging purposes, as juwelier knows it (not from the filesystem)"
    task :debug do
      # TODO move to a command
      juwelier.gemspec_helper.spec.version ||= begin
                                                juwelier.version_helper.refresh
                                                juwelier.version_helper.to_s
                                              end

      puts juwelier.gemspec_helper.to_ruby
    end

    desc "Regenerate and validate gemspec, and then commits and pushes to git"
    task :release do
      juwelier.release_gemspec(release_args)
    end
  end

  task :release => 'gemspec:release'


  unless yield_gemspec_set_version?
    namespace :version do
      desc "Writes out an explicit version. Respects the following environment variables, or defaults to 0: MAJOR, MINOR, PATCH. Also recognizes BUILD, which defaults to nil"
      task :write do
        major, minor, patch, build = ENV['MAJOR'].to_i, ENV['MINOR'].to_i, ENV['PATCH'].to_i, (ENV['BUILD'] || nil )
        juwelier.write_version(major, minor, patch, build, :announce => false, :commit => false)
        $stdout.puts "Updated version: #{juwelier.version}"
      end

      namespace :bump do
        desc "Bump the major version by 1"
        task :major => [:version_required, :version] do
          juwelier.bump_major_version
          $stdout.puts "Updated version: #{juwelier.version}"
        end

        desc "Bump the a minor version by 1"
        task :minor => [:version_required, :version] do
          juwelier.bump_minor_version
          $stdout.puts "Updated version: #{juwelier.version}"
        end

        desc "Bump the patch version by 1"
        task :patch => [:version_required, :version] do
          juwelier.bump_patch_version
          $stdout.puts "Updated version: #{juwelier.version}"
        end
      end
    end
  end


  namespace :git do
    desc "Tag and push release to git. (happens by default with `rake release`)"
    task :release do
      juwelier.release_to_git(release_args)
    end
  end

  task :release => 'git:release'

  unless File.exist?('Gemfile')
    desc "Check that runtime and development dependencies are installed"
    task :check_dependencies do
      juwelier.check_dependencies
    end

    namespace :check_dependencies do
      desc "Check that runtime dependencies are installed"
      task :runtime  do
        juwelier.check_dependencies(:runtime)
      end

      desc"Check that development dependencies are installed"
      task :development do
        juwelier.check_dependencies(:development)
      end
    end
  end

  desc "Start IRB with all runtime dependencies loaded"
  task :console, [:script] do |t,args|
    # TODO move to a command
    dirs = ['ext', 'lib'].select { |dir| File.directory?(dir) }

    original_load_path = $LOAD_PATH

    cmd = if File.exist?('Gemfile')
            require 'bundler'
            Bundler.setup(:default)
          end

    # add the project code directories
    $LOAD_PATH.unshift(*dirs)

    # clear ARGV so IRB is not confused
    ARGV.clear

    require 'irb'

    # set the optional script to run
    IRB.conf[:SCRIPT] = args.script
    IRB.start

    # return the $LOAD_PATH to it's original state
    $LOAD_PATH.reject! { |path| !(original_load_path.include?(path)) }
  end

end
release_args() click to toggle source
# File lib/juwelier/tasks.rb, line 71
def release_args
  args = {}
  args[:remote] = ENV['REMOTE']
  args[:branch] = ENV['BRANCH']
  args[:local_branch] = ENV['LOCAL_BRANCH']
  args[:remote_branch] = ENV['REMOTE_BRANCH']
  return args
end
yield_gemspec_set_version?() click to toggle source
# File lib/juwelier/tasks.rb, line 60
def yield_gemspec_set_version?
  yielded_gemspec = @gemspec.dup
  yielded_gemspec.extend(Juwelier::Specification)
  yielded_gemspec.files = FileList[]
  yielded_gemspec.extra_rdoc_files = FileList[]

  gemspec_building_block.call(yielded_gemspec) if gemspec_building_block

  ! yielded_gemspec.version.nil?
end