hoe 1.2.0 → 1.2.1

data/History.txt

@@ -1,11 +1,25 @@
-= 1.2.0 2007-02-13
+== 1.2.1 / 2007-05-21
+
+* 8 minor enhancements:
+  * Allow for spaces in filenames in manifest. Thanks to Aaron Patterson.
+  * Allow rsync flags to be set.
+  * Allow rdoc destination directory to be set.
+  * Deal with bad line-endings. Stupid windoze users... :(
+  * Added WINDOZE check for diff.exe and look for gdiff first.
+  * Use gdiff if available, diff otherwise. Allows to work on borked Solaris.
+  * Move RDoc to attr* from big 'ol chunk at the top of the class.
+  * Basic conversion of history/urls from rdoc to markdown.
+* 1 bug fixes:
+  * Fixed executables regexp to /^bin/.
+
+== 1.2.0 / 2007-02-13
 
 * Added more support for ext dirs.
 * Added a simple config file (yaml). Use 'rake config_hoe' to edit.
 * Added post_blog task (thanks Aaron!), configured via config_hoe.
 * Announce task now posts to your blogs and/or publishes API depending on config.
 
-= 1.1.7 2007-01-10
+== 1.1.7 / 2007-01-10
 
 * extra_deps is now self-healing, and ensures no (direct) cycles.
 * cleans check_manifest for CVS projects.
@@ -13,22 +27,22 @@
 * Now uses rsync for publish_docs. YAY for fast!
 * Bug #7193 fix spelling of 'synopsys'.  Submitted by Jacob Atzen.
 
-= 1.1.6 2006-11-29
+== 1.1.6 / 2006-11-29
 
 * Fix release to work correctly with need_zip and need_tar.
 
-= 1.1.5 2006-11-29
+== 1.1.5 / 2006-11-29
 
 * Reduced check_manifest dependencies to just diff for windows.
 * Don't use default author in summary, description or changes.
 
-= 1.1.4 2006-11-12
+== 1.1.4 / 2006-11-12
 
 * Added need_tar and need_zip to customize package requirements. Stupid windoze.
 * Extended spec_extras to take procs as values. Passes in named parameter.
 * Removed test from require_paths. I thought I already parameterized this. :/
 
-= 1.1.3 2006-11-09
+== 1.1.3 / 2006-11-09
 
 * Added test_deps, now you can automatically discover test dependency ommisions.
 * Added ext support! Build C extensions with hoe!
@@ -37,7 +51,7 @@
 * Fixed doco and automated updating of it.
 * Added rdoc_pattern. Go doco go!
 
-= 1.1.2 2006-10-22
+== 1.1.2 / 2006-10-22
 
 * Added -d and -t flags to sow to make dev or trunk subdirs for p4 and svn projects.
 * Added install_gem to further test gem builds.
@@ -45,17 +59,17 @@
 * Removed demo.rb from clean_globs. I'm torn on this one.
 * Fixed bug in install rule.
 
-= 1.1.1 2006-10-11
+== 1.1.1 / 2006-10-11
 
 * Fixed minor problem with subject of email.
 * Fixed problem in test.
 
-= 1.1.0 2006-10-04
+== 1.1.0 / 2006-10-04
 
 * Added sow, a command-line tool for quickly creating new projects.
 * Added check_manifest task
 
-= 1.0.5 2006-10-03
+== 1.0.5 / 2006-10-03
 
 * Doco cleanup.
 * Removed Manifest.txt from rdoc and added title.
@@ -66,11 +80,11 @@
 * Added email and rubyforge news announcement tasks.
 * Url attribute may now be an array of urls.
 
-= 1.0.4 2006-09-23
+== 1.0.4 / 2006-09-23
 
 * Damnit... I messed up. There is no rubygems gem to be dependent upon. Duh.
 
-= 1.0.3 2006-09-23
+== 1.0.3 / 2006-09-23
 
 * Added debug_gem rule.
 * Added lots of doco.
@@ -83,12 +97,12 @@
 * Renamed upload to publish_docs.
 * publish_docs is now smart about subprojects and missing subdirectories.
 
-= 1.0.2 2006-09-20
+== 1.0.2 / 2006-09-20
 
 * Wee little tests.
 * Fixed up gemspec's require_paths.
 
-= 1.0.1 2006-09-20
+== 1.0.1 / 2006-09-20
 
 * Finally got deployment straightened out. Maybe. Some might be on rubyforge.org.
 * Added default description and summary.
@@ -96,6 +110,6 @@
 * Improved gemspec debugging.
 * Swapped gem with tgz in deploy... we'd rather screw up on tgz
 
-= 1.0.0 2006-09-19
+== 1.0.0 / 2006-09-19
 
 * Birthday!

data/README.txt

@@ -1,7 +1,8 @@
 Hoe
-    http://rubyforge.org/projects/seattlerb/
-    http://seattlerb.rubyforge.org/hoe/
-    ryand-ruby@zenspider.com
+
+* http://rubyforge.org/projects/seattlerb/
+* http://seattlerb.rubyforge.org/hoe/
+* mailto:ryand-ruby@zenspider.com
 
 == DESCRIPTION:
 
@@ -20,6 +21,7 @@ Tasks Provided:
 * default          - Run the default tasks
 * docs             - Build the docs HTML Files
 * email            - Generate email announcement file.
+* gem              - Build the gem file only.
 * install          - Install the package. Uses PREFIX and RUBYLIB
 * install_gem      - Install the package as a gem
 * multi            - Run the test suite using multiruby

data/Rakefile

@@ -6,7 +6,7 @@ Hoe.new("hoe", Hoe::VERSION) do |p|
   p.rubyforge_name = "seattlerb"
   p.summary = "Hoe is a way to write Rakefiles much easier and cleaner."
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.url = p.paragraphs_of('README.txt', 1).first.gsub(/^\* /, '').split(/\n/)
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
 end
 

data/bin/sow

@@ -55,7 +55,7 @@ Dir.chdir project do
     "bin/#{file_name}" => "",
     "lib/#{file_name}.rb" => "class #{klass}\n  VERSION = '1.0.0'\nend",
     "test/test_#{file_name}.rb" => "",
-    "Rakefile" => "# -*- ruby -*-\n\nrequire 'rubygems'\nrequire 'hoe'\nrequire './lib/#{file_name}.rb'\n\nHoe.new('#{project}', #{klass}::VERSION) do |p|\n  p.rubyforge_name = \'#{group}\'\n  # p.summary = '#{X}'\n  # p.description = p.paragraphs_of('README.txt', 2..5).join(\"\\n\\n\")\n  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\\n/)[1..-1]\n  p.changes = p.paragraphs_of('History.txt', 0..1).join(\"\\n\\n\")\nend\n\n# vim: syntax=Ruby\n"
+    "Rakefile" => "# -*- ruby -*-\n\nrequire 'rubygems'\nrequire 'hoe'\nrequire './lib/#{file_name}.rb'\n\nHoe.new('#{project}', #{klass}::VERSION) do |p|\n  p.rubyforge_name = \'#{group}\'\n  # p.author = '#{X}'\n  # p.email = '#{X}'\n  # p.summary = '#{X}'\n  # p.description = p.paragraphs_of('README.txt', 2..5).join(\"\\n\\n\")\n  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\\n/)[1..-1]\n  p.changes = p.paragraphs_of('History.txt', 0..1).join(\"\\n\\n\")\nend\n\n# vim: syntax=Ruby\n"
   }
 
   files["Manifest.txt"] = files.keys.sort.join("\n")

data/lib/hoe.rb

@@ -42,6 +42,7 @@ require 'rubyforge'
 # * default          - Run the default tasks
 # * docs             - Build the docs HTML Files
 # * email            - Generate email announcement file.
+# * gem              - Build the gem file only.
 # * install          - Install the package. Uses PREFIX and RUBYLIB
 # * install_gem      - Install the package as a gem
 # * multi            - Run the test suite using multiruby
@@ -55,81 +56,189 @@ require 'rubyforge'
 # * test_deps        - Show which test files fail when run alone.
 # * uninstall        - Uninstall the package.
 #
-# === Attributes
-#
-# The attributes that you can provide inside the new block above are:
-#
-# ==== Mandatory
-#
-# * name        - The name of the release.
-# * version     - The version. Don't hardcode! use a constant in the project.
-#
-# ==== Damn Good to Set
-#
-# * author      - The author of the package. (can be array of authors)
-# * changes     - A description of the release's latest changes.
-# * description - A description of the project.
-# * email       - The author's email address. (can be array of urls)
-# * summary     - A short summary of the project.
-# * url         - The url of the project.
-#
-# ==== Optional
-#
-# * clean_globs    - An array of file patterns to delete on clean.
-# * extra_deps     - An array of rubygem dependencies.
-# * need_tar       - Should package create a tarball? [default: true]
-# * need_zip       - Should package create a zipfile? [default: false]
-# * rdoc_pattern   - A regexp to match documentation files against the manifest.
-# * rubyforge_name - The name of the rubyforge project. [default: name.downcase]
-# * spec_extras    - A hash of extra values to set in the gemspec.
-# * test_globs     - An array of test file patterns [default: test/**/test_*.rb]
-#
-# === Environment Variables
-#
-# * FILTER     - Used to add flags to test_unit (e.g., -n test_borked)
-# * PREFIX     - Used to specify a custom install location (for rake install).
-# * RUBY_DEBUG - Used to add extra flags to RUBY_FLAGS.
-# * RUBY_FLAGS - Used to specify flags to ruby [has smart default].
-
 class Hoe
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 
-  rubyprefix = Config::CONFIG['prefix']
+  ruby_prefix = Config::CONFIG['prefix']
   sitelibdir = Config::CONFIG['sitelibdir']
 
-  PREFIX = ENV['PREFIX'] || rubyprefix
-  RUBYLIB = if PREFIX == rubyprefix then
-              sitelibdir
-            else
-              File.join(PREFIX, sitelibdir[rubyprefix.size..-1])
-            end
+  ##
+  # Used to specify a custom install location (for rake install).
+
+  PREFIX = ENV['PREFIX'] || ruby_prefix
+
+  ##
+  # Used to add extra flags to RUBY_FLAGS.
+
   RUBY_DEBUG = ENV['RUBY_DEBUG']
-  RUBY_FLAGS = ENV['RUBY_FLAGS'] ||
-    "-w -I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}" +
+
+  default_ruby_flags = "-w -I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}" +
     (RUBY_DEBUG ? " #{RUBY_DEBUG}" : '')
+
+  ##
+  # Used to specify flags to ruby [has smart default].
+
+  RUBY_FLAGS = ENV['RUBY_FLAGS'] || default_ruby_flags
+
+  ##
+  # Used to add flags to test_unit (e.g., -n test_borked).
+
   FILTER = ENV['FILTER'] # for tests (eg FILTER="-n test_blah")
 
-  attr_accessor :author, :bin_files, :changes, :clean_globs, :description, :email, :extra_deps, :lib_files, :name, :need_tar, :need_zip, :rdoc_pattern, :rubyforge_name, :spec, :spec_extras, :summary, :test_files, :test_globs, :url, :version
+  # :stopdoc:
+
+  RUBYLIB = if PREFIX == ruby_prefix then
+              sitelibdir
+            else
+              File.join(PREFIX, sitelibdir[ruby_prefix.size..-1])
+            end
+
+  WINDOZE = /win32/ =~ RUBY_PLATFORM unless defined? WINDOZE
+
+  DIFF = if WINDOZE
+           'diff.exe'
+         else
+           if system("gdiff", __FILE__, __FILE__)
+             'gdiff' # solaris and kin suck
+           else
+             'diff'
+           end
+         end unless defined? DIFF
+
+  # :startdoc:
+
+  ##
+  # *Recommended*: The author(s) of the package. (can be array)
+  # Really. Set this or we'll tease you.
+
+  attr_accessor :author
+
+  ##
+  # Populated automatically from the manifest. List of executables.
+
+  attr_accessor :bin_files # :nodoc:
+
+  ##
+  # *Recommended*: A description of the release's latest changes.
+
+  attr_accessor :changes
+
+  ##
+  # Optional: An array of file patterns to delete on clean.
+
+  attr_accessor :clean_globs
+
+  ##
+  # *Recommended*: A description of the project.
+
+  attr_accessor :description
+
+  ##
+  # *Recommended*: The author's email address(es). (can be array)
+
+  attr_accessor :email
+
+  ##
+  # Optional: An array of rubygem dependencies.
+
+  attr_accessor :extra_deps
+
+  ##
+  # Populated automatically from the manifest. List of library files.
+
+  attr_accessor :lib_files # :nodoc:
+
+  ##
+  # *MANDATORY*: The name of the release.
+
+  attr_accessor :name
+
+  ##
+  # Optional: Should package create a tarball? [default: true]
+
+  attr_accessor :need_tar
 
-  def initialize(name, version)
+  ##
+  # Optional: Should package create a zipfile? [default: false]
+
+  attr_accessor :need_zip
+
+  ##
+  # Optional: A regexp to match documentation files against the manifest.
+
+  attr_accessor :rdoc_pattern
+
+  ##
+  # 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
+
+  ##
+  # Optional: The name of the rubyforge project. [default: name.downcase]
+
+  attr_accessor :rubyforge_name
+
+  ##
+  # The Gem::Specification.
+
+  attr_accessor :spec # :nodoc:
+
+  ##
+  # Optional: A hash of extra values to set in the gemspec. Value may be a proc.
+
+  attr_accessor :spec_extras
+
+  ##
+  # *Recommended*: A short summary of the project.
+
+  attr_accessor :summary
+
+  ##
+  # Populated automatically from the manifest. List of tests.
+
+  attr_accessor :test_files # :nodoc:
+
+  ##
+  # Optional: An array of test file patterns [default: test/**/test_*.rb]
+
+  attr_accessor :test_globs
+
+  ##
+  # *Recommended*: The url(s) of the project. (can be array)
+
+  attr_accessor :url
+
+  ##
+  # *MANDATORY*: The version. Don't hardcode! use a constant in the project.
+
+  attr_accessor :version
+
+  def initialize(name, version) # :nodoc:
     self.name = name
     self.version = version
 
     # Defaults
-    self.rubyforge_name = name.downcase
-    self.url = "http://www.zenspider.com/ZSS/Products/#{name}/"
     self.author = "Ryan Davis"
-    self.email = "ryand-ruby@zenspider.com"
-    self.clean_globs = %w(diff diff.txt email.txt ri *.gem **/*~)
-    self.test_globs = ['test/**/test_*.rb']
     self.changes = "The author was too lazy to write a changeset"
+    self.clean_globs = %w(diff diff.txt email.txt ri *.gem **/*~)
     self.description = "The author was too lazy to write a description"
-    self.summary = "The author was too lazy to write a summary"
-    self.rdoc_pattern = /^(lib|bin)|txt$/
+    self.email = "ryand-ruby@zenspider.com"
     self.extra_deps = []
-    self.spec_extras = {}
     self.need_tar = true
     self.need_zip = false
+    self.rdoc_pattern = /^(lib|bin)|txt$/
+    self.remote_rdoc_dir = name
+    self.rsync_args = '-av --delete'
+    self.rubyforge_name = name.downcase
+    self.spec_extras = {}
+    self.summary = "The author was too lazy to write a summary"
+    self.test_globs = ['test/**/test_*.rb']
+    self.url = "http://www.zenspider.com/ZSS/Products/#{name}/"
 
     yield self if block_given?
 
@@ -152,7 +261,7 @@ class Hoe
     define_tasks
   end
 
-  def define_tasks
+  def define_tasks # :nodoc:
     desc 'Run the default tasks'
     task :default => :test
 
@@ -200,12 +309,15 @@ class Hoe
         s.add_dependency(*dep)
       end
 
-      s.files = File.read("Manifest.txt").split
-      s.executables = s.files.grep(/bin/) { |f| File.basename(f) }
+      s.files = File.read("Manifest.txt").delete("\r").split(/\n/)
+      s.executables = s.files.grep(/^bin/) { |f| File.basename(f) }
 
       s.bindir = "bin"
       dirs = Dir['{lib,ext}']
       s.require_paths = dirs unless dirs.empty?
+
+      s.rdoc_options = ['--main', 'README.txt']
+      s.extra_rdoc_files = s.files.grep(/txt$/)
       s.has_rdoc = true
 
       if test ?f, "test/test_all.rb" then
@@ -317,13 +429,15 @@ class Hoe
       sh %q{ rdoc --ri -o ri . }
     end
 
-    desc 'Publish RDoc to RubyForge'
+    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}/#{name}"
+
+      remote_dir = "/var/www/gforge-projects/#{rubyforge_name}/#{remote_rdoc_dir}"
       local_dir = 'doc'
-      sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
+
+      sh %{rsync #{rsync_args} #{local_dir}/ #{host}:#{remote_dir}}
     end
 
     # no doco for this one
@@ -338,7 +452,7 @@ class Hoe
     ############################################################
     # Misc/Maintenance:
 
-    def with_config(create=false)
+    def with_config(create=false) # :nodoc:
       require 'yaml'
       rc = File.expand_path("~/.hoerc")
 
@@ -419,6 +533,9 @@ class Hoe
 
       with_config do |config, path|
         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,
@@ -459,18 +576,19 @@ class Hoe
       end
       files = files.sort.join "\n"
       File.open f, 'w' do |fp| fp.puts files end
-      system "diff -du Manifest.txt #{f}"
+      system "#{DIFF} -du Manifest.txt #{f}"
       rm f
     end
 
   end # end define
 
-  def announcement
-    urls = "  " + Array(url).map {|s| s.strip}.join("\n  ")
+  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}"
+    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
@@ -489,21 +607,28 @@ class Hoe
   end
 
   ##
-  # Reads a file at +path+ and spits out an array of the +paragraphs+ specified
+  # Reads a file at +path+ and spits out an array of the +paragraphs+ specified.
   #
   #   changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  #   summary, *description = p.paragraphs_of('Readme.txt', 3, 3..8)
+  #   summary, *description = p.paragraphs_of('README.txt', 3, 3..8)
 
   def paragraphs_of(path, *paragraphs)
-    file = File.read(path)
-    file.split(/\n\n+/).values_at(*paragraphs)
+    File.read(path).delete("\r").split(/\n\n+/).values_at(*paragraphs)
   end
 end
 
+# :enddoc:
+
 class ::Rake::SshDirPublisher # :nodoc:
   attr_reader :host, :remote_dir, :local_dir
 end
 
+class String
+  def rdoc_to_markdown
+    self.gsub(/^mailto:/, '').gsub(/^(=+)/) { "#" * $1.size }
+  end
+end
+
 if $0 == __FILE__ then
   out = `rake -T | egrep -v "redocs|repackage|clobber|trunk"`
   puts out.gsub(/\#/, '-').gsub(/^rake /, '# * ')

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.0.9
 specification_version: 1
 name: hoe
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
-date: 2007-02-13 00:00:00 -08:00
+  version: 1.2.1
+date: 2007-05-21 00:00:00 -07:00
 summary: Hoe is a way to write Rakefiles much easier and cleaner.
 require_paths: 
 - lib
 email: ryand-ruby@zenspider.com
-homepage: "    http://rubyforge.org/projects/seattlerb/"
+homepage: http://rubyforge.org/projects/seattlerb/
 rubyforge_project: seattlerb
-description: "Hoe is a simple rake/rubygems helper for project Rakefiles. It generates all the usual tasks for projects including rdoc generation, testing, packaging, and deployment.  Tasks Provided:  * announce         - Generate email announcement file and post to rubyforge. * audit            - Run ZenTest against the package * check_manifest   - Verify the manifest * clean            - Clean up all the extras * config_hoe       - Create a fresh ~/.hoerc file * debug_gem        - Show information about the gem. * default          - Run the default tasks * docs             - Build the docs HTML Files * email            - Generate email announcement file. * install          - Install the package. Uses PREFIX and RUBYLIB * install_gem      - Install the package as a gem * multi            - Run the test suite using multiruby * package          - Build all the packages * post_blog        - Post announcement to blog. * post_news        - Post announcement to rubyforge. * publish_docs     - Publish RDoc to RubyForge * release          - Package and upload the release to rubyforge. * ridocs           - Generate ri locally for testing * test             - Run the test suite. Use FILTER to add to the command line. * test_deps        - Show which test files fail when run alone. * uninstall        - Uninstall the package.  See class rdoc for help. Hint: ri Hoe"
+description: "== DESCRIPTION:  Hoe is a simple rake/rubygems helper for project Rakefiles. It generates all the usual tasks for projects including rdoc generation, testing, packaging, and deployment.  Tasks Provided:  * announce         - Generate email announcement file and post to rubyforge. * audit            - Run ZenTest against the package * check_manifest   - Verify the manifest * clean            - Clean up all the extras * config_hoe       - Create a fresh ~/.hoerc file * debug_gem        - Show information about the gem. * default          - Run the default tasks * docs             - Build the docs HTML Files * email            - Generate email announcement file. * gem              - Build the gem file only. * install          - Install the package. Uses PREFIX and RUBYLIB * install_gem      - Install the package as a gem * multi            - Run the test suite using multiruby * package          - Build all the packages * post_blog        - Post announcement to blog. * post_news        - Post announcement to rubyforge. * publish_docs     - Publish RDoc to RubyForge * release          - Package and upload the release to rubyforge. * ridocs           - Generate ri locally for testing * test             - Run the test suite. Use FILTER to add to the command line. * test_deps        - Show which test files fail when run alone. * uninstall        - Uninstall the package."
 autorequire: 
 default_executable: 
 bindir: bin
@@ -38,10 +38,13 @@ files:
 - test/test_hoe.rb
 test_files: 
 - test/test_hoe.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
 executables: 
 - sow
 extensions: []
@@ -56,7 +59,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.0
+        version: 0.4.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -65,5 +68,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.1
+        version: 0.7.2
     version: