hoe 1.12.2 → 2.0.0

data/lib/hoe/publish.rb

@@ -0,0 +1,182 @@
+##
+# Publish plugin for hoe.
+#
+# === Tasks Provided:
+#
+# announce::           Create news email file and post to rubyforge.
+# email::              Generate email announcement file.
+# post_blog::          Post announcement to blog.
+# post_news::          Post announcement to rubyforge.
+# publish_docs::       Publish RDoc to RubyForge.
+# ridocs::             Generate ri locally for testing.
+#
+# === Extra Configuration Options:
+#
+# publish_on_announce:: Run +publish_docs+ when you run +release+.
+# blogs::               An array of hashes of blog settings.
+
+module Hoe::Publish
+  Hoe.plugin :publish
+
+  ##
+  # *Optional*: An array of the project's blog categories. Defaults to project name.
+
+  attr_accessor :blog_categories
+
+  ##
+  # Optional: Name of RDoc destination directory on Rubyforge. [default: +name+]
+
+  attr_accessor :remote_rdoc_dir
+
+  ##
+  # Optional: Flags for RDoc rsync. [default: "-av --delete"]
+
+  attr_accessor :rsync_args
+
+  Hoe::DEFAULT_CONFIG["publish_on_announce"] = true
+  Hoe::DEFAULT_CONFIG["blog"] = [
+                                 {
+                                   "user"     => "user",
+                                   "password" => "password",
+                                   "url"      => "url",
+                                   "blog_id"  => "blog_id",
+                                   "extra_headers" => {
+                                     "mt_convert_breaks" => "markdown"
+                                   },
+                                 }
+                                ]
+
+  ##
+  # Initialize variables for plugin.
+
+  def initialize_publish
+    self.blog_categories ||= [self.name]
+    self.remote_rdoc_dir ||= self.name
+    self.rsync_args      ||= '-av --delete'
+  end
+
+  ##
+  # Define tasks for plugin.
+
+  def define_publish_tasks
+    Rake::RDocTask.new(:docs) do |rd|
+      rd.main = readme_file
+      rd.options << '-d' if (`which dot` =~ /\/dot/) unless
+        ENV['NODOT'] || Hoe::WINDOZE
+      rd.rdoc_dir = 'doc'
+
+      rd.rdoc_files += spec.require_paths
+      rd.rdoc_files += spec.extra_rdoc_files
+
+      title = "#{name}-#{version} Documentation"
+      title = "#{rubyforge_name}'s " + title if rubyforge_name != name
+
+      rd.options << "-t" << title
+    end
+
+    desc 'Generate ri locally for testing.'
+    task :ridocs => :clean do
+      sh %q{ rdoc --ri -o ri . }
+    end
+
+    desc 'Publish RDoc to RubyForge.'
+    task :publish_docs => [:clean, :docs] do
+      config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+      host = "#{config["username"]}@rubyforge.org"
+
+      remote_dir = "/var/www/gforge-projects/#{rubyforge_name}/#{remote_rdoc_dir}"
+      local_dir = 'doc'
+
+      sh %{rsync #{rsync_args} #{local_dir}/ #{host}:#{remote_dir}}
+    end
+
+    # no doco for this one
+    task :publish_on_announce do
+      with_config do |config, _|
+        Rake::Task['publish_docs'].invoke if config["publish_on_announce"]
+      end
+    end
+
+    desc 'Generate email announcement file.'
+    task :email do
+      require 'rubyforge'
+      subject, title, body, urls = announcement
+
+      File.open("email.txt", "w") do |mail|
+        mail.puts "Subject: [ANN] #{subject}"
+        mail.puts
+        mail.puts title
+        mail.puts
+        mail.puts urls
+        mail.puts
+        mail.puts body
+        mail.puts
+        mail.puts urls
+      end
+      puts "Created email.txt"
+    end
+
+    desc 'Post announcement to blog.'
+    task :post_blog do
+      require 'xmlrpc/client'
+
+      with_config do |config, path|
+        break unless config['blogs']
+
+        subject, title, body, urls = announcement
+        body += "\n\n#{urls}"
+
+        config['blogs'].each do |site|
+          server = XMLRPC::Client.new2(site['url'])
+          content = site['extra_headers'].merge(:title => title,
+                                                :description => body,
+                                                :categories => blog_categories)
+
+          result = server.call('metaWeblog.newPost',
+                               site['blog_id'],
+                               site['user'],
+                               site['password'],
+                               content,
+                               true)
+        end
+      end
+    end
+
+    desc 'Post announcement to rubyforge.'
+    task :post_news do
+      require 'rubyforge'
+      subject, title, body, urls = announcement
+
+      rf = RubyForge.new.configure
+      rf.login
+      rf.post_news(rubyforge_name, subject, "#{title}\n\n#{body}")
+      puts "Posted to rubyforge"
+    end
+
+    desc 'Create news email file and post to rubyforge.'
+    task :announce => [:email, :post_news, :post_blog, :publish_on_announce ]
+  end
+
+  def announcement # :nodoc:
+    changes = self.changes.rdoc_to_markdown
+    subject = "#{name} #{version} Released"
+    title   = "#{name} version #{version} has been released!"
+    body    = "#{description}\n\nChanges:\n\n#{changes}".rdoc_to_markdown
+    urls    = Array(url).map { |s| "* <#{s.strip.rdoc_to_markdown}>" }.join("\n")
+
+    return subject, title, body, urls
+  end
+end
+
+class ::Rake::SshDirPublisher # :nodoc:
+  attr_reader :host, :remote_dir, :local_dir
+end
+
+class String
+  ##
+  # Very basic munge from rdoc to markdown format.
+
+  def rdoc_to_markdown
+    self.gsub(/^mailto:/, '').gsub(/^(=+)/) { "#" * $1.size }
+  end
+end

data/lib/hoe/rake.rb

@@ -0,0 +1,44 @@
+module Rake
+  module TaskManager
+    ##
+    # This gives us access to the tasks already defined in rake.
+    def all_tasks
+      @tasks
+    end
+  end
+
+  ##
+  # Simple shortcut for Rake.application.all_tasks
+  def self.all_tasks
+    Rake.application.all_tasks
+  end
+
+  ##
+  # Hooks into rake and allows us to clear out a task by name or
+  # regexp. Use this if you want to completely override a task instead
+  # of extend it.
+  def self.clear_tasks(*tasks)
+    tasks.flatten.each do |name|
+      case name
+      when Regexp then
+        all_tasks.delete_if { |k,_| k =~ name }
+      else
+        all_tasks.delete(name)
+      end
+    end
+  end
+
+  ##
+  # Removes the last action added to a task. Use this when two
+  # libraries define the same task and you only want one of the
+  # actions.
+  #
+  #   require 'hoe'
+  #   require 'tasks/rails'
+  #   Rake.undo("test") # rolls out rails' test task
+  def self.undo(*names)
+    names.each do |name|
+      all_tasks[name].actions.delete_at(-1)
+    end
+  end
+end unless Rake.respond_to? :all_tasks

data/lib/hoe/rcov.rb

@@ -0,0 +1,44 @@
+##
+# RCov plugin for hoe.
+#
+# === Tasks Provided:
+#
+# rcov::               Analyze code coverage with tests
+
+module Hoe::RCov
+  Hoe.plugin :rcov
+
+  ##
+  # Define tasks for plugin.
+
+  def define_rcov_tasks
+    begin # take a whack at defining rcov tasks
+      require 'rcov/rcovtask'
+
+      Rcov::RcovTask.new do |t|
+        pattern = ENV['PATTERN'] || 'test/test_*.rb'
+
+        t.test_files = FileList[pattern]
+        t.verbose = true
+        t.rcov_opts << "--no-color"
+        t.rcov_opts << "--save coverage.info"
+        t.rcov_opts << "-x ^/"
+      end
+
+      # this is for my emacs rcov overlay stuff on emacswiki.
+      task :rcov_overlay do
+        path = ENV["FILE"]
+        rcov, eol = Marshal.load(File.read("coverage.info")).last[path], 1
+        puts rcov[:lines].zip(rcov[:coverage]).map { |line, coverage|
+          bol, eol = eol, eol + line.length
+          [bol, eol, "#ffcccc"] unless coverage
+        }.compact.inspect
+      end
+    rescue LoadError
+      # skip
+      task :clobber_rcov # in case rcov didn't load
+    end
+  end
+end
+
+task :clean => :clobber_rcov

data/lib/hoe/signing.rb

@@ -0,0 +1,119 @@
+##
+# Signing plugin for hoe.
+#
+# === Tasks Provided:
+#
+# generate_key::       Generate a key for signing your gems.
+#
+# === Extra Configuration Options:
+#
+# signing_key_file::    Signs your gems with this private key.
+# signing_cert_file::   Signs your gem with this certificate.
+#
+# === Usage:
+#
+# Run the 'generate_key' task.  This will:
+#
+# 1. Configure your ~/.hoerc.
+# 2. Generate a signing key and certificate.
+# 3. Install the private key and public certificate files into ~/.gem.
+# 4. Upload the certificate to RubyForge.
+#
+# Hoe will now generate signed gems when the package task is run.  If you have
+# multiple machines you build gems on, be sure to install your key and
+# certificate on each machine.
+#
+# Keep your private key secret!  Keep your private key safe!
+#
+# To make sure your gems are signed run:
+#
+#   rake package; tar tf pkg/yourproject-1.2.3.gem
+#
+# If your gem is signed you will see:
+#
+#   data.tar.gz
+#   data.tar.gz.sig
+#   metadata.gz
+#   metadata.gz.sig
+
+module Hoe::Signing
+  Hoe.plugin :signing
+
+  Hoe::DEFAULT_CONFIG["signing_key_file"]  = "~/.gem/gem-private_key.pem"
+  Hoe::DEFAULT_CONFIG["signing_cert_file"] = "~/.gem/gem-public_cert.pem"
+
+  ##
+  # Define tasks for plugin.
+
+  def define_signing_tasks
+    signing_key = nil
+    cert_chain = []
+
+    with_config do |config, path|
+      break unless config['signing_key_file'] and config['signing_cert_file']
+      key_file = File.expand_path config['signing_key_file'].to_s
+      signing_key = key_file if File.exist? key_file
+
+      cert_file = File.expand_path config['signing_cert_file'].to_s
+      cert_chain << cert_file if File.exist? cert_file
+    end
+
+    if signing_key and cert_chain then
+      spec.signing_key = signing_key
+      spec.cert_chain = cert_chain
+    end
+
+    desc 'Generate a key for signing your gems.'
+    task :generate_key do
+      email = Array(spec.email)
+      abort "No email in your gemspec" if email.nil? or email.empty?
+
+      key_file = with_config { |config, _| config['signing_key_file'] }
+      cert_file = with_config { |config, _| config['signing_cert_file'] }
+
+      if key_file.nil? or cert_file.nil? then
+        ENV['SHOW_EDITOR'] ||= 'no'
+        Rake::Task['config_hoe'].invoke
+
+        key_file = with_config { |config, _| config['signing_key_file'] }
+        cert_file = with_config { |config, _| config['signing_cert_file'] }
+      end
+
+      key_file = File.expand_path key_file
+      cert_file = File.expand_path cert_file
+
+      unless File.exist? key_file or File.exist? cert_file then
+        warn "NOTICE: using #{email.first} for certificate" if email.size > 1
+
+        sh "gem cert --build #{email.first}"
+        mv "gem-private_key.pem", key_file, :verbose => true
+        mv "gem-public_cert.pem", cert_file, :verbose => true
+
+        puts "Installed key and certificate."
+
+        rf = RubyForge.new.configure
+        rf.login
+
+        cert_package = "#{rubyforge_name}-certificates"
+
+        begin
+          rf.lookup 'package', cert_package
+        rescue
+          rf.create_package rubyforge_name, cert_package
+        end
+
+        begin
+          rf.lookup('release', cert_package)['certificates']
+          rf.add_file rubyforge_name, cert_package, 'certificates', cert_file
+        rescue
+          rf.create_package rubyforge_name, cert_package
+          rf.add_release rubyforge_name, cert_package, 'certificates', cert_file
+        end
+
+        puts "Uploaded certificate to release \"certificates\" in package #{cert_package}"
+      else
+        puts "Keys already exist: #{key_file} and #{cert_file}"
+      end
+    end
+  end
+end

data/lib/hoe/test.rb

@@ -0,0 +1,140 @@
+##
+# Test plugin for hoe.
+#
+# === Tasks Provided:
+#
+# audit::              Run ZenTest against the package.
+# default::            Run the default task(s).
+# multi::              Run the test suite using multiruby.
+# test::               Run the test suite.
+# test_deps::          Show which test files fail when run alone.
+
+module Hoe::Test
+  Hoe.plugin :test # activate globally, fine for general purpose tasks
+
+  ##
+  # Configuration for the supported test frameworks for test task.
+
+  SUPPORTED_TEST_FRAMEWORKS = {
+    :testunit => "test/unit",
+    :minitest => "minitest/autorun",
+  }
+
+  ##
+  # Used to add flags to test_unit (e.g., -n test_borked).
+  #
+  # eg FILTER="-n test_blah"
+
+  FILTER = ENV['FILTER'] || ENV['TESTOPTS']
+
+  ##
+  # Optional: Array of incompatible versions for multiruby filtering.
+  # Used as a regex.
+
+  attr_accessor :multiruby_skip
+
+  ##
+  # Optional: What test library to require [default: :testunit]
+
+  attr_accessor :testlib
+
+  ##
+  # Optional: RSpec dirs. [default: %w(spec lib)]
+
+  attr_accessor :rspec_dirs
+
+  ##
+  # Optional: RSpec options. [default: []]
+
+  attr_accessor :rspec_options
+
+  ##
+  # Initialize variables for plugin.
+
+  def initialize_test
+    self.multiruby_skip ||= []
+    self.testlib        ||= :testunit
+    self.rspec_dirs     ||= %w(spec lib)
+    self.rspec_options  ||= []
+  end
+
+  ##
+  # Define tasks for plugin.
+
+  def define_test_tasks
+    default_tasks = []
+
+    if File.directory? "test" then
+      desc 'Run the test suite. Use FILTER or TESTOPTS to add flags/args.'
+      task :test do
+        ruby make_test_cmd
+      end
+
+      desc 'Run the test suite using multiruby.'
+      task :multi do
+        ruby make_test_cmd(:multi)
+      end
+
+      desc 'Show which test files fail when run alone.'
+      task :test_deps do
+        tests = Dir["test/**/test_*.rb"]  +  Dir["test/**/*_test.rb"]
+
+        paths = ['bin', 'lib', 'test'].join(File::PATH_SEPARATOR)
+        null_dev = Hoe::WINDOZE ? '> NUL 2>&1' : '&> /dev/null'
+
+        tests.each do |test|
+          if not system "ruby -I#{paths} #{test} #{null_dev}" then
+            puts "Dependency Issues: #{test}"
+          end
+        end
+      end
+
+      default_tasks << :test
+    end
+
+    if File.directory? "spec" then
+      begin
+        require 'spec/rake/spectask'
+
+        desc "Run all specifications"
+        Spec::Rake::SpecTask.new(:spec) do |t|
+          t.libs = self.rspec_dirs
+          t.spec_opts = self.rspec_options
+        end
+      rescue LoadError
+        # do nothing
+      end
+      default_tasks << :spec
+    end
+
+    desc 'Run the default task(s).'
+    task :default => default_tasks
+
+    desc 'Run ZenTest against the package.'
+    task :audit do
+      libs = %w(lib test ext).join(File::PATH_SEPARATOR)
+      sh "zentest -I=#{libs} #{spec.files.grep(/^(lib|test)/).join(' ')}"
+    end
+  end
+
+  ##
+  # Generate the test command-line.
+
+  def make_test_cmd multi = false # :nodoc:
+    framework = SUPPORTED_TEST_FRAMEWORKS[testlib]
+    raise "unsupported test framework #{testlib}" unless framework
+
+    tests = ["rubygems", framework] +
+      test_globs.map { |g| Dir.glob(g) }.flatten
+    tests.map! {|f| %(require "#{f}")}
+
+    cmd = "#{Hoe::RUBY_FLAGS} -e '#{tests.join("; ")}' #{FILTER}"
+
+    if multi then
+      ENV['EXCLUDED_VERSIONS'] = multiruby_skip.join ":"
+      cmd = "-S multiruby #{cmd}"
+    end
+
+    cmd
+  end
+end