meta_project 0.4.12 → 0.4.13

data/MIT-LICENSE

@@ -1,21 +1,21 @@
-Copyright (c) 2005 Aslak Hellesoy
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
+Copyright (c) 2005 Aslak Hellesoy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README

@@ -1,126 +1,130 @@
-= MetaProject 0.4.12
-
-MetaProject (formerly XForge) is a library that allows interaction with various project hosting servers, issue trackers, SCMs and SCM browsers through a common API.
-
-MetaProject also includes is a Quick Release System (QRS) for [RubyForge, SourceForge and other SourceForge clones] (commonly referred to as XForge throughout the documentation) as well as RAA and Freshmeat. QRS support for other hosts is in the pipe.
-
-== Feature overview
-
-=== RSCM related
-
-* Obtain preconfigured RSCM:http://rscm.rubyforge.org objects.
-
-=== SCM browser related
-
-* Obtain preconfigured SCM browser proxy objects that can generate various links with a simple API.
-
-* Treat files in the SCM browser just as stdlib Pathname object (only a subset is provided)
-
-=== QRS related
-
-* QRS: Create/Upload new releases (with multiple files if desired).
-
-* Rake integration (use the QRS from Rake scripts).
-
-* Publish XForge news items for a project.
-
-* Publish on RAA (SOAP under the hood)
-
-* Publish on Freshmeat (XMLRPC under the hood)
-
-=== Issue tracker related
-
-* Close and comment on issues
-
-* Recognise issue ids and create links in e.g. SCM commit messages
-
-* Patois parsing, a DSL for issue and release management.
-
-=== XForge related
-
-* Look up XForge projects by unix name (no need to worry about group_id or package_id).
-
-* Also see QRS related
-
-* Query home page URLs for a project.
-
-== Download/Installation
-
-The latest version of MetaProject can be found at
-
-* http://rubyforge.org/project/showfiles.php?group_id=801
-
-Download and install MetaProject with the following.
-
-   gem install meta_project
-
-(You may need administrative privileges (sudo) for this).
-
-== Usage
-
-=== QRS
-
-MetaProject itself is released with MetaProject's QRS Rake tasks, so check out MetaProject's own Rakefile (http://tinyurl.com/a23u5) and CHANGES (http://tinyurl.com/9qxxf) files for the best examples on how to use it. 
-
-XForge can parse release summary and changes from CHANGES if you format it the way XForge's own CHANGES is formatted. Also make sure your Rakefile's PKG_VERSION is in sync with the latest version specified in the CHANGES file.
-
-=== Other parts of the API
-
-If you're writing an application that interacts with MetaProject, please refer to the RDoc API and the RSpec:http://rspec.rubyforge.org specifications in the CVS source tree (kinda like unit tests, just better.) 
-
----
-
-== FAQ
-
-=== I don't have a CHANGES file that MetaProject's Rake tasks understands. How do I disable it?
-When using the Rake tasks Rake::XForge::Release and Rake::XForge::NewsPublisher, you can omit parsing
-of the CHANGES file by telling the task to omit it. In this case, you also have to specify +release_notes+
-and +release_changes+ to the task. Example:
-
-  task :release_files => [:gem] do
-    release_files = FileList[
-      "pkg/#{PKG_FILE_NAME}.gem"
-    ]
-
-    Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('xforge')) do |release|
-      # If you omit user_name and/or password, you'll be prompted at the command line.
-      release.user_name = ENV['RUBYFORGE_USER']
-      release.password = ENV['RUBYFORGE_PASSWORD']
-      release.files = release_files.to_a
-      release.release_name = "MetaProject #{PKG_VERSION}"
-      
-      # The code below is for disabling parsing of CHANGES
-      release.changes_file = nil
-      release.release_notes = "This is release notes. They will show up at the release summary"
-      release.release_changes = ["This is", "a list of String", "and will also show up", "under the release summary"]
-    end
-  end
-
-== Credits
-
-(In alphabetical order)
-
-[<b>Aslak Hellesoy</b>] Creator and main contributor of this project.
-
-[<b>Austin Ziegler</b>] Bugfixes and documentation improvements for XForge release code.
-
-[<b>David Heinemeier Hansson</b>] For the HTTP POST code and the idea to parse XForge ids from project pages.
-
-[<b>Jim Weirich</b>] For Rake and feedback on some problems with the Rake tasks.
-
-[<b>Thomas Leitner</b>] For Freshmeat and RAA support.
-
-== Support
-
-The MetaProject homepage is http://xforge.rubyforge.org.  You can find the MetaProject
-RubyForge page at http://rubyforge.org/projects/xforge.
-
-Feel free to submit patches, bug reports or feature requests via MetaProject's issue tracker on RubyForge.
-
-For discussions and questions, please use the mailing list: http://rubyforge.org/mail/?group_id=801
-
-== License
-
-MetaProject is available under an MIT-style license.
-
-:include: MIT-LICENSE
+= MetaProject 0.4.13
+
+MetaProject (formerly XForge) is a library that allows interaction with various project hosting servers, issue trackers, SCMs and SCM browsers through a common API.
+
+MetaProject also includes is a Quick Release System (QRS) for [RubyForge, SourceForge and other SourceForge clones] (commonly referred to as XForge throughout the documentation) as well as RAA and Freshmeat. QRS support for other hosts is in the pipe.
+
+== Feature overview
+
+=== RSCM related
+
+* Obtain preconfigured RSCM:http://rscm.rubyforge.org objects.
+
+=== SCM browser related
+
+* Obtain preconfigured SCM browser proxy objects that can generate various links with a simple API.
+
+* Treat files in the SCM browser just as stdlib Pathname object (only a subset is provided)
+
+=== QRS related
+
+* QRS: Create/Upload new releases (with multiple files if desired).
+
+* Rake integration (use the QRS from Rake scripts).
+
+* Publish XForge news items for a project.
+
+* Publish on RAA (SOAP under the hood)
+
+* Publish on Freshmeat (XMLRPC under the hood)
+
+=== Issue tracker related
+
+* Close and comment on issues
+
+* Recognise issue ids and create links in e.g. SCM commit messages
+
+* Patois parsing, a DSL for issue and release management.
+
+=== XForge related
+
+* Look up XForge projects by unix name (no need to worry about group_id or package_id).
+
+* Also see QRS related
+
+* Query home page URLs for a project.
+
+== Screen Scraping
+
+MetaProject uses <a href="http://www.catb.org/~esr/jargon/html/S/screen-scraping.html">screen scraping</a> heavily. This is a last-resort technique which is only used when there is no other approach (XML-RPC/SOAP/REST) to retrieve data more reliably. As a result, some of the functionality might break if the HTML of the hosts MetaProject scrapes data from changes. If you think MetaProject is misbehaving because of changed HTML on some external system that MetaProject interacts with, please file a bug report in MetaProject's bug tracker on RubyForge.
+
+== Download/Installation
+
+The latest version of MetaProject can be found at
+
+* http://rubyforge.org/project/showfiles.php?group_id=801
+
+Download and install MetaProject with the following.
+
+   gem install meta_project
+
+(You may need administrative privileges (sudo) for this).
+
+== Usage
+
+=== QRS
+
+MetaProject itself is released with MetaProject's QRS Rake tasks, so check out MetaProject's own Rakefile (http://tinyurl.com/a23u5) and CHANGES (http://tinyurl.com/9qxxf) files for the best examples on how to use it. 
+
+XForge can parse release summary and changes from CHANGES if you format it the way XForge's own CHANGES is formatted. Also make sure your Rakefile's PKG_VERSION is in sync with the latest version specified in the CHANGES file.
+
+=== Other parts of the API
+
+If you're writing an application that interacts with MetaProject, please refer to the RDoc API and the RSpec:http://rspec.rubyforge.org specifications in the CVS source tree (kinda like unit tests, just better.) 
+
+---
+
+== FAQ
+
+=== I don't have a CHANGES file that MetaProject's Rake tasks understands. How do I disable it?
+When using the Rake tasks Rake::XForge::Release and Rake::XForge::NewsPublisher, you can omit parsing
+of the CHANGES file by telling the task to omit it. In this case, you also have to specify +release_notes+
+and +release_changes+ to the task. Example:
+
+  task :release_files => [:gem] do
+    release_files = FileList[
+      "pkg/#{PKG_FILE_NAME}.gem"
+    ]
+
+    Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('xforge')) do |release|
+      # If you omit user_name and/or password, you'll be prompted at the command line.
+      release.user_name = ENV['RUBYFORGE_USER']
+      release.password = ENV['RUBYFORGE_PASSWORD']
+      release.files = release_files.to_a
+      release.release_name = "MetaProject #{PKG_VERSION}"
+      
+      # The code below is for disabling parsing of CHANGES
+      release.changes_file = nil
+      release.release_notes = "This is release notes. They will show up at the release summary"
+      release.release_changes = ["This is", "a list of String", "and will also show up", "under the release summary"]
+    end
+  end
+
+== Credits
+
+(In alphabetical order)
+
+[<b>Aslak Hellesoy</b>] Creator and main contributor of this project.
+
+[<b>Austin Ziegler</b>] Bugfixes and documentation improvements for XForge release code.
+
+[<b>David Heinemeier Hansson</b>] For the HTTP POST code and the idea to parse XForge ids from project pages.
+
+[<b>Jim Weirich</b>] For Rake and feedback on some problems with the Rake tasks.
+
+[<b>Thomas Leitner</b>] For Freshmeat and RAA support.
+
+== Support
+
+The MetaProject homepage is http://xforge.rubyforge.org.  You can find the MetaProject
+RubyForge page at http://rubyforge.org/projects/xforge.
+
+Feel free to submit patches, bug reports or feature requests via MetaProject's issue tracker on RubyForge.
+
+For discussions and questions, please use the mailing list: http://rubyforge.org/mail/?group_id=801
+
+== License
+
+MetaProject is available under an MIT-style license.
+
+:include: MIT-LICENSE

data/Rakefile

@@ -1,152 +1,152 @@
-# Rakefile for MetaProject
-
-# Copyright 2005 by Aslak Hellesoy (aslak.hellesoy@gmail.org)
-# All rights reserved.
-
-# This file is may be distributed under an MIT style license.  See
-# MIT-LICENSE for details.
-
-$:.unshift('lib')
-require 'meta_project'
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-require 'rake/contrib/xforge'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-# Versioning scheme: MAJOR.MINOR.PATCH
-# MAJOR bumps when API is broken backwards
-# MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
-# -OR when a new release is made and propaganda is sent out.
-# PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
-# Later DamageControl can bump PATCH automatically.
-#
-# REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
-PKG_NAME = "meta_project"
-PKG_VERSION = "0.4.12"
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-PKG_FILES = FileList[
-  '[A-Z]*',
-  'lib/**/*.rb', 
-  'doc/**/*'
-]
-
-task :default => [:gem]
-
-desc "Execute RSpec specifications (rspec gem must be installed)"
-task :spec do
-  ruby 'behaviours/suite.rb'
-end
-
-# Create a task to build the RDOC documentation tree.
-rd = Rake::RDocTask.new("rdoc") do |rdoc|
-  rdoc.rdoc_dir = 'html'
-#  rdoc.template = 'kilmer'
-#  rdoc.template = 'css2'
-#  rdoc.template = 'doc/jamis.rb'
-  rdoc.title    = "MetaProject"
-  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'CHANGES')
-  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
-  rdoc.rdoc_files.exclude('doc/**/*_attrs.rdoc')
-end
-
-# ====================================================================
-# Create a task that will package the Rake software into distributable
-# tar, zip and gem files.
-
-spec = Gem::Specification.new do |s|
-  
-  #### Basic information.
-
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  s.summary = "Ruby based make-like utility."
-  s.description = <<-EOF
-    MetaProject (formerly XForge) is a library that allows interaction with various project hosting servers, issue trackers, scms and scm browsers.  
-  EOF
-
-  s.files = PKG_FILES.to_a
-  s.require_path = 'lib'
-  s.autorequire = 'meta_project'
-
-  #### Documentation and testing.
-
-  s.has_rdoc = true
-  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-  s.rdoc_options <<
-    '--title' <<  'MetaProject' <<
-    '--main' << 'README' <<
-    '--line-numbers'
-
-  #### Author and project details.
-
-  s.author = "Aslak Hellesoy"
-  s.email = "aslak.hellesoy@gmail.com"
-  s.homepage = "http://xforge.rubyforge.org"
-  s.rubyforge_project = "xforge"
-end
-
-desc "Build Gem"
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
-
-# Support Tasks ------------------------------------------------------
-
-desc "Look for TODO and FIXME tags in the code"
-task :todo do
-  Pathname.new(File.dirname(__FILE__)).egrep(/#.*(FIXME|TODO|TBD|DEPRECATED)/) do |match|
-    puts match
-  end
-end
-
-task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news, :tag]
-
-task :verify_env_vars do
-  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
-  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
-end
-
-task :publish_doc => [:rdoc] do
-  publisher = Rake::RubyForgePublisher.new('xforge', ENV['RUBYFORGE_USER'])
-  publisher.upload
-end
-
-desc "Release files on RubyForge"
-task :release_files => [:gem] do
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem"
-  ]
-
-  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('xforge')) do |release|
-    # Never hardcode user name and password in the Rakefile!
-    release.user_name = ENV['RUBYFORGE_USER']
-    release.password = ENV['RUBYFORGE_PASSWORD']
-    release.files = release_files.to_a
-    release.release_name = "MetaProject #{PKG_VERSION}"
-    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
-  end
-end
-
-desc "Publish news on RubyForge"
-task :publish_news => [:gem] do
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem"
-  ]
-
-  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new('xforge')) do |news|
-    # Never hardcode user name and password in the Rakefile!
-    news.user_name = ENV['RUBYFORGE_USER']
-    news.password = ENV['RUBYFORGE_PASSWORD']
-  end
-end
-
-desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
-task :tag do
-  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
-  puts "Tagging CVS with [#{reltag}]"
-  sh %{cvs tag #{reltag}}
-end
+# Rakefile for MetaProject
+
+# Copyright 2005 by Aslak Hellesoy (aslak.hellesoy@gmail.org)
+# All rights reserved.
+
+# This file is may be distributed under an MIT style license.  See
+# MIT-LICENSE for details.
+
+$:.unshift('lib')
+require 'meta_project'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/xforge'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+# Versioning scheme: MAJOR.MINOR.PATCH
+# MAJOR bumps when API is broken backwards
+# MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
+# -OR when a new release is made and propaganda is sent out.
+# PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
+# Later DamageControl can bump PATCH automatically.
+#
+# REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
+PKG_NAME = "meta_project"
+PKG_VERSION = "0.4.13"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  'lib/**/*.rb', 
+  'doc/**/*'
+]
+
+task :default => [:gem]
+
+desc "Execute RSpec specifications (rspec gem must be installed)"
+task :spec do
+  ruby 'behaviours/suite.rb'
+end
+
+# Create a task to build the RDOC documentation tree.
+rd = Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'html'
+#  rdoc.template = 'kilmer'
+#  rdoc.template = 'css2'
+#  rdoc.template = 'doc/jamis.rb'
+  rdoc.title    = "MetaProject"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'CHANGES')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+  rdoc.rdoc_files.exclude('doc/**/*_attrs.rdoc')
+end
+
+# ====================================================================
+# Create a task that will package the Rake software into distributable
+# tar, zip and gem files.
+
+spec = Gem::Specification.new do |s|
+  
+  #### Basic information.
+
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Ruby library for interacting with project hosting servers, scms and issue trackers."
+  s.description = <<-EOF
+    MetaProject (formerly XForge) is a library that allows interaction with various project hosting servers, issue trackers, scms and scm browsers.  
+  EOF
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+  s.autorequire = 'meta_project'
+
+  #### Documentation and testing.
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+  s.rdoc_options <<
+    '--title' <<  'MetaProject' <<
+    '--main' << 'README' <<
+    '--line-numbers'
+
+  #### Author and project details.
+
+  s.author = "Aslak Hellesoy"
+  s.email = "aslak.hellesoy@gmail.com"
+  s.homepage = "http://xforge.rubyforge.org"
+  s.rubyforge_project = "xforge"
+end
+
+desc "Build Gem"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+# Support Tasks ------------------------------------------------------
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  Pathname.new(File.dirname(__FILE__)).egrep(/#.*(FIXME|TODO|TBD|DEPRECATED)/) do |match|
+    puts match
+  end
+end
+
+task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news, :tag]
+
+task :verify_env_vars do
+  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
+end
+
+task :publish_doc do
+  publisher = Rake::RubyForgePublisher.new('xforge', ENV['RUBYFORGE_USER'])
+  publisher.upload
+end
+
+desc "Release files on RubyForge"
+task :release_files => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('xforge')) do |release|
+    # Never hardcode user name and password in the Rakefile!
+    release.user_name = ENV['RUBYFORGE_USER']
+    release.password = ENV['RUBYFORGE_PASSWORD']
+    release.files = release_files.to_a
+    release.release_name = "MetaProject #{PKG_VERSION}"
+    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
+  end
+end
+
+desc "Publish news on RubyForge"
+task :publish_news => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new('xforge')) do |news|
+    # Never hardcode user name and password in the Rakefile!
+    news.user_name = ENV['RUBYFORGE_USER']
+    news.password = ENV['RUBYFORGE_PASSWORD']
+  end
+end
+
+desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
+task :tag do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  puts "Tagging CVS with [#{reltag}]"
+  sh %{cvs tag #{reltag}}
+end