hoe 1.12.2 → 2.0.0

data/lib/hoe/clean.rb

@@ -0,0 +1,36 @@
+##
+# Clean plugin for hoe.
+#
+# === Tasks Provided:
+#
+# clean::              Clean up all the extras.
+
+module Hoe::Clean
+  Hoe.plugin :clean # activate globally, fine for general purpose tasks
+
+  ##
+  # Optional: An array of file patterns to delete on clean.
+
+  attr_accessor :clean_globs
+
+  ##
+  # Initialize variables for plugin.
+
+  def initialize_clean
+    self.clean_globs ||= %w(diff diff.txt email.txt ri deps .source_index
+                            *.gem **/*~ **/.*~ **/*.rbc coverage*)
+  end
+
+  ##
+  # Define tasks for plugin.
+
+  def define_clean_tasks
+    desc 'Clean up all the extras.'
+    task :clean => [ :clobber_docs, :clobber_package ] do
+      clean_globs.each do |pattern|
+        files = Dir[pattern]
+        rm_rf files, :verbose => true unless files.empty?
+      end
+    end
+  end
+end

data/lib/hoe/debug.rb

@@ -0,0 +1,68 @@
+##
+# Debug plugin for hoe.
+#
+# === Tasks Provided:
+#
+# check_manifest::     Verify the manifest.
+# config_hoe::         Create a fresh ~/.hoerc file.
+# debug_gem::          Show information about the gem.
+
+module Hoe::Debug
+  Hoe.plugin :debug
+
+  # :stopdoc:
+
+  DIFF = if Hoe::WINDOZE
+           'diff.exe'
+         else
+           if system("gdiff", __FILE__, __FILE__)
+             'gdiff' # solaris and kin suck
+           else
+             'diff'
+           end
+         end unless defined? DIFF
+
+  # :startdoc:
+
+  ##
+  # Define tasks for plugin.
+
+  def define_debug_tasks
+    desc 'Create a fresh ~/.hoerc file.'
+    task :config_hoe do
+      with_config do |config, path|
+        File.open(path, "w") do |f|
+          YAML.dump(Hoe::DEFAULT_CONFIG.merge(config), f)
+        end
+
+        editor = ENV['EDITOR'] || 'vi'
+        system "#{editor} #{path}" if ENV['SHOW_EDITOR'] != 'no'
+      end
+    end
+
+    desc 'Verify the manifest.'
+    task :check_manifest => :clean do
+      f = "Manifest.tmp"
+      require 'find'
+      files = []
+      with_config do |config, _|
+        exclusions = config["exclude"]
+        abort "exclude entry missing from .hoerc. Aborting." if exclusions.nil?
+        Find.find '.' do |path|
+          next unless File.file? path
+          next if path =~ exclusions
+          files << path[2..-1]
+        end
+        files = files.sort.join "\n"
+        File.open f, 'w' do |fp| fp.puts files end
+        system "#{DIFF} -du Manifest.txt #{f}"
+        rm f
+      end
+    end
+
+    desc 'Show information about the gem.'
+    task :debug_gem do
+      puts spec.to_ruby
+    end
+  end
+end

data/lib/hoe/deps.rb

@@ -0,0 +1,169 @@
+require 'rubygems/remote_fetcher'
+
+##
+# Deps plugin for hoe.
+#
+# === Tasks Provided:
+#
+# check_extra_deps::   Install missing dependencies.
+# deps:email::         Print a contact list for gems dependent on this gem
+# deps:fetch::         Fetch all the dependent gems of this gem into tarballs
+# deps:list::          List all the dependent gems of this gem
+
+module Hoe::Deps
+  Hoe.plugin :deps
+
+  ##
+  # The main rubygems repository.
+
+  GEMURL = URI.parse 'http://gems.rubyforge.org'
+
+  ##
+  # Define tasks for plugin.
+
+  def define_deps_tasks
+    namespace :deps do
+      desc "List all the dependent gems of this gem"
+      task :list do
+        gems = self.get_gems_by_name
+        gem  = gems[self.name]
+
+        abort "Couldn't find gem: #{self.name}" unless gem
+
+        deps = self.dependent_upon self.name
+        max  = deps.map { |s| s.full_name.size }.max
+
+        puts "  dependents:"
+        unless deps.empty? then
+          deps.sort_by { |spec| spec.full_name }.each do |spec|
+            vers = spec.dependencies.find {|s| s.name == name }.requirement_list
+            puts "    %-*s - %s" % [max, spec.full_name, vers.join(", ")]
+          end
+        else
+          puts "    none"
+        end
+      end
+
+      desc "Print a contact list for gems dependent on this gem"
+      task :email do
+        gems = self.get_gems_by_name
+        gem  = gems[self.name]
+
+        abort "Couldn't find gem: #{self.name}" unless gem
+
+        deps = self.dependent_upon self.name
+
+        email = deps.map { |s| s.email }.flatten.sort.uniq
+        email = email.map { |s| s.split(/,\s*/) }.flatten.sort.uniq
+
+        email.map! { |s| # don't you people realize how easy this is?
+          s.gsub(/ at | _at_ |\s*(atmark|@nospam@|-at?-|@at?@|<at?>|\[at?\]|\(at?\))\s*/i, '@').gsub(/\s*(dot|\[d(ot)?\]|\.dot\.)\s*/i, '.').gsub(/\s+com$/, '.com')
+        }
+
+        bad, good = email.partition { |e| e !~ /^[\w.+-]+\@[\w.+-]+$/ }
+
+        warn "Rejecting #{bad.size} email. I couldn't unmunge them." unless
+          bad.empty?
+
+        puts good.join(", ")
+      end
+
+      desc "Fetch all the dependent gems of this gem into tarballs"
+      task :fetch do
+        gems = self.get_gems_by_name
+        gem  = gems[self.name]
+        deps = self.dependent_upon self.name
+
+        mkdir "deps" unless File.directory? "deps"
+        Dir.chdir "deps" do
+          begin
+            deps.sort_by { |spec| spec.full_name }.each do |spec|
+              full_name = spec.full_name
+              tgz_name  = "#{full_name}.tgz"
+              gem_name  = "#{full_name}.gem"
+
+              next if File.exist? tgz_name
+              FileUtils.rm_rf [full_name, gem_name]
+
+              begin
+                warn "downloading #{full_name}"
+                Gem::RemoteFetcher.fetcher.download(spec, GEMURL, Dir.pwd)
+                FileUtils.mv "cache/#{gem_name}", '.'
+              rescue Gem::RemoteFetcher::FetchError
+                warn "  failed"
+                next
+              end
+
+              warn "converting #{gem_name} to tarball"
+
+              system "gem unpack #{gem_name} 2> /dev/null"
+              system "gem spec -l #{gem_name} > #{full_name}/gemspec.rb"
+              system "tar zmcf #{tgz_name} #{full_name}"
+              FileUtils.rm_rf [full_name, gem_name, "cache"]
+            end
+          ensure
+            FileUtils.rm_rf "cache"
+          end
+        end
+      end
+    end
+
+    desc 'Install missing dependencies.'
+    task :check_extra_deps do
+      # extra_deps = [["rubyforge", ">= 1.0.0"], ["rake", ">= 0.8.1"]]
+      extra_deps.each do |dep|
+        begin
+          gem(*dep)
+        rescue Gem::LoadError
+          install_gem(*dep)
+        end
+      end
+    end
+  end
+
+  ##
+  # Return the rubygems source index.
+
+  def get_source_index
+    @@index ||= nil
+
+    return @@index if @@index
+
+    dump = unless File.exist? '.source_index' then
+             url = GEMURL + "Marshal.#{Gem.marshal_version}.Z"
+             dump = Gem::RemoteFetcher.fetcher.fetch_path url
+             dump = Gem.inflate dump
+             open '.source_index', 'wb' do |io| io.write dump end
+             dump
+           else
+             open '.source_index', 'rb' do |io| io.read end
+           end
+
+    @@index = Marshal.load dump
+  end
+
+  ##
+  # Return the latest rubygems.
+
+  def get_latest_gems
+    @@cache ||= get_source_index.latest_specs
+  end
+
+  ##
+  # Return a hash of the latest rubygems keyed by name.
+
+  def get_gems_by_name
+    @@by_name ||= Hash[*get_latest_gems.map { |gem|
+                         [gem.name, gem, gem.full_name, gem]
+                       }.flatten]
+  end
+
+  ##
+  # Return all the dependencies on the named rubygem.
+
+  def dependent_upon name
+    get_latest_gems.find_all { |gem|
+      gem.dependencies.any? { |dep| dep.name == name }
+    }
+  end
+end

data/lib/hoe/flay.rb

@@ -0,0 +1,35 @@
+##
+# Flay plugin for hoe.
+#
+# === Tasks Provided:
+#
+# flay::               Analyze for code duplication.
+
+module Hoe::Flay
+  Hoe.plugin :flay
+
+  ##
+  # Optional: flay threshold to determine threshold failure. [default: 1200-100]
+
+  attr_accessor :flay_threshold
+
+  ##
+  # Initialize variables for plugin.
+
+  def initialize_flay
+    self.flay_threshold ||= timebomb 1200, 100  # 80% of average :(
+  end
+
+  ##
+  # Define tasks for plugin.
+
+  def define_flay_tasks
+    begin
+      require 'flay'
+      require 'flay_task'
+      FlayTask.new :flay, self.flay_threshold
+    rescue Exception
+      # skip
+    end
+  end
+end

data/lib/hoe/flog.rb

@@ -0,0 +1,35 @@
+##
+# Flog plugin for hoe.
+#
+# === Tasks Provided:
+#
+# flog::               Analyze code complexity.
+
+module Hoe::Flog
+  Hoe.plugin :flog
+
+  ##
+  # Optional: flog threshold to determine threshold failure. [default: 1500-200]
+
+  attr_accessor :flog_threshold
+
+  ##
+  # Initialize variables for plugin.
+
+  def initialize_flog
+    self.flog_threshold ||= timebomb 1500, 1000 # 80% of average :(
+  end
+
+  ##
+  # Define tasks for plugin.
+
+  def define_flog_tasks
+    begin
+      require 'flog'
+      require 'flog_task'
+      FlogTask.new :flog, self.flog_threshold
+    rescue Exception
+      # skip
+    end
+  end
+end

data/lib/hoe/inline.rb

@@ -0,0 +1,58 @@
+##
+# Hoe allows bundling of pre-compiled extensions in the +package+ task.
+#
+# To create a package for your current platform:
+#
+#   rake package INLINE=1
+#
+# This will force Hoe analize your +Inline+ already compiled
+# extensions and include them in your gem.
+#
+# If somehow you need to force a specific platform:
+#
+#   rake package INLINE=1 FORCE_PLATFORM=mswin32
+#
+# This will set the +Gem::Specification+ platform to the one indicated in
+# +FORCE_PLATFORM+ (instead of default Gem::Platform::CURRENT)
+
+module Hoe::Inline
+
+  ##
+  # Define tasks for plugin.
+
+  def define_inline_tasks
+    if ENV['INLINE'] then
+      s.platform = ENV['FORCE_PLATFORM'] || Gem::Platform::CURRENT
+
+      # Try collecting Inline extensions for +name+
+      if defined?(Inline) then
+        directory 'lib/inline'
+
+        dlext = Config::CONFIG['DLEXT']
+
+        Inline.registered_inline_classes.each do |cls|
+          name = cls.name # TODO: what about X::Y::Z?
+          # name of the extension is CamelCase
+          alternate_name = if name =~ /[A-Z]/ then
+                             name.gsub(/([A-Z])/, '_\1').downcase.sub(/^_/, '')
+                           elsif name =~ /_/ then
+                             name.capitalize.gsub(/_([a-z])/) { $1.upcase }
+                           end
+          extensions = Dir.chdir(Inline::directory) {
+            Dir["Inline_{#{name},#{alternate_name}}_*.#{dlext}"]
+          }
+
+          extensions.each do |ext|
+            # add the inlined extension to the spec files
+            s.files += ["lib/inline/#{ext}"]
+
+            # include the file in the tasks
+            file "lib/inline/#{ext}" => ["lib/inline"] do
+              cp File.join(Inline::directory, ext), "lib/inline"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hoe/package.rb

@@ -0,0 +1,83 @@
+##
+# Package plugin for hoe.
+#
+# === Tasks Provided:
+#
+# install_gem::        Install the package as a gem.
+# release::            Package and upload the release to rubyforge.
+
+module Hoe::Package
+  Hoe.plugin :package
+
+  ##
+  # Optional: Should package create a tarball? [default: true]
+
+  attr_accessor :need_tar
+
+  ##
+  # Optional: Should package create a zipfile? [default: false]
+
+  attr_accessor :need_zip
+
+  ##
+  # Initialize variables for plugin.
+
+  def initialize_package
+    self.need_tar ||= true
+    self.need_zip ||= false
+  end
+
+  ##
+  # Define tasks for plugin.
+
+  def define_package_tasks
+    Rake::GemPackageTask.new spec do |pkg|
+      pkg.need_tar = @need_tar
+      pkg.need_zip = @need_zip
+    end
+
+    desc 'Install the package as a gem.'
+    task :install_gem => [:clean, :package, :check_extra_deps] do
+      install_gem Dir['pkg/*.gem'].first
+    end
+
+    desc 'Package and upload the release to rubyforge.'
+    task :release => [:clean, :package] do |t|
+      v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+      abort "Versions don't match #{v} vs #{version}" if v != version
+      pkg = "pkg/#{name}-#{version}"
+
+      if $DEBUG then
+        puts "release_id = rf.add_release #{rubyforge_name.inspect}, #{name.inspect}, #{version.inspect}, \"#{pkg}.tgz\""
+        puts "rf.add_file #{rubyforge_name.inspect}, #{name.inspect}, release_id, \"#{pkg}.gem\""
+      end
+
+      rf = RubyForge.new.configure
+      puts "Logging in"
+      rf.login
+
+      c = rf.userconfig
+      c["release_notes"] = description if description
+      c["release_changes"] = changes if changes
+      c["preformatted"] = true
+
+      files = [(@need_tar ? "#{pkg}.tgz" : nil),
+               (@need_zip ? "#{pkg}.zip" : nil),
+               "#{pkg}.gem"].compact
+
+      puts "Releasing #{name} v. #{version}"
+      rf.add_release rubyforge_name, name, version, *files
+    end
+  end
+
+  ##
+  # Install the named gem.
+
+  def install_gem name, version = nil
+    gem_cmd = Gem.default_exec_format % 'gem'
+    sudo    = 'sudo '                  unless Hoe::WINDOZE
+    local   = '--local'                unless version
+    version = "--version '#{version}'" if     version
+    sh "#{sudo}#{gem_cmd} install #{local} #{name} #{version}"
+  end
+end