meta_project 0.4.1

data/CHANGES

@@ -0,0 +1,178 @@
+= XForge Changelog
+
+== Version 0.4.1
+
+This version renames xforge to meta_project. This is because the scope of this project
+has grown beyond SourceForge clones.
+
+* renamed gem
+
+== Version 0.4.0
+
+This release of XForge completely reorganises classes and modules into a more
+coherent API for accessing projects' issue trackers, scms and scm browsers. The toplevel
+namespace is now MetaProject.
+
+The new ScmWeb class now supports *any* scm browser through its flexible
+configuration options.
+
+In order to easily gather information from various hosting services, XForge comes with a ProjectAnalyzer
+class, which given an scm browser URL will discover the associated issue tracker, preconfigured scm_web,
+project home page and of course, an RSCM object.
+
+Supported project sources:
+- RubyForge.org
+- SourceForge.org
+- Codehaus.org
+- Trac projects
+
+Supported issue trackers:
+- RubyForge.org
+- SourceForge.org
+- JIRA
+- Trac projects
+
+Supported SCM browsers:
+- *Any* scm browser through its flexible configuration options.
+
+Supported SCMs:
+- Any SCM implemented in the <a href="http://rscm.rubyforge.org/">RSCM</a> project.
+
+The QRS Rake tasks for releasing files and news on RubyForge has changed slightly. Please refer to XForge's
+own Rakefile for details.
+
+== Version 0.3.5
+
+This is a bugfix release that fixes some bugs in ViewCvs.
+
+* Changed the way the server path of RSCM::Cvs objects are initialised from ViewCvs to fix a subtle bug.
+* Factored out generic file_uri to ScmWeb::FileUri.
+* Fixed bug in RubyForge's recognition of modules in ViewCvs.
+
+== Version 0.3.4
+
+This release simplifies ViewCvs configuration
+
+* Removed project_unix_name from ViewCvs' uri_specs
+* Tuned how XForge::Project is YAMLed, to avoid backreferences
+* Renamed some Tracker classes to be prefixed with the module name. This was to ease DamageControl integration.
+
+== Version 0.3.3
+
+This is a minor refactoring release
+
+* Decoupled Trac::Project from RSCM::Subversion
+* Made Tracker::ViewCvs use Strings as values instead of symbols (to make it easier to post from a web form)
+
+== Version 0.3.2
+
+This release adds more support for other issue trackers ans scm browsers.
+
+* Fixed #2242
+* Added a lot of tracker and scm_web classes (factored out from DamageControl)
+* Decoupled view_cvs from rubyforge/sourceforge
+
+== Version 0.3.1
+
+This XForge release adds initial support for Trac and JIRA.
+
+* Added support for formatting of text containing issue identifiers
+* Refactored trackers into other modules
+* Added support for JIRA issue tracker
+* Added support for Trac's issue tracker
+* Added support for diff URLs on SourceForge and RubyForge
+
+== Version 0.2.1
+
+This XForge release adds support for tracker meta info
+
+* Added Project.tracker method
+* Require Rake tasks from toplevel xforge.rb
+
+== Version 0.2.0
+
+First stable release of the XForge QRS.
+
+* Renamed Project.name to Project.unix_name
+* Wrote better documentation
+* Included CVS tagging in the Rakefile
+
+== Version 0.1.9
+
+This release adds more functionality for news publishing
+
+* Added Session.publish_news
+
+== Version 0.1.8
+
+This release adds more functionality for RubyForge projects' home page
+
+* Added Project.home_page_uri and Project.project_uri
+
+== Version 0.1.7
+
+Updated README
+
+== Version 0.1.6
+
+This release of XForge improves scm browser capabilities.
+
+* Added ViewCvs.uri(path, options) method to get an URI to a file on the web
+* Added an rspec suite
+* Added logic for parsing top-level CVS modules
+* Made Rake Release task use RubyForge by default
+
+== Version 0.1.5
+
+This release of XForge adds functionality to access scm browsers (ViewCvs) and RSCM objects.
+
+* Refactored classes into separate files
+* Added Project.scm_web to access a ViewCvs object 
+* Added ViewCvs.scms to access an array of RSCM::Cvs
+
+== Version 0.1.4
+
+This is the first functional release of XForge, a Ruby library and Rake task to automate release of
+files on RubyForge and other SourceForge clones.
+
+It's as simple as this:
+
+require 'xforge'
+
+desc "Create a new release on RubyForge"
+task :publish_files => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+
+  Rake::XForge::Release.new(PKG_NAME) 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 = "XForge #{PKG_VERSION}"
+    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
+  end
+end
+
+* Added logic for parsing of CHANGES files and include it in the release notes when publishing.
+* Wrote some proper release notes for once.
+
+== Version 0.1.3
+
+* Added logic for parsing of CHANGES files and include it in the release notes when publishing.
+
+== Version 0.1.2
+
+This release is a minor release with fixes in the Rake script.
+
+* Fixed RDoc for gem
+* Cleaned up documentation
+
+== Version 0.1.1
+
+* Rakefile: Don't include old gems in release.
+
+== Version 0.1
+
+* Added support for file releases

data/MIT-LICENSE

@@ -0,0 +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.
+

data/README

@@ -0,0 +1,64 @@
+= XForge
+
+XForge is a Quick Release System (QRS) for RubyForge, SourceForge and other SourceForge clones. XForge also allows users to query SCM information and other metadata about hosted projects.
+
+XForge has the following features:
+
+* Look up projects by unix name (no need to worry about group_id or package_id).
+
+* Create/Upload new releases (with multiple files if desired).
+
+* Rake integration (use XForge from Rake scripts).
+
+* Query SCM meta information (using RSCM - http://rscm.rubyforge.org).
+
+* Publish news items about a project.
+
+* Query home page URLs for a project.
+
+== Download/Installation
+
+The latest version of XForge can be found at
+
+* http://rubyforge.org/project/showfiles.php?group_id=801
+
+Download and install XForge with the following.
+
+   gem install xforge
+
+(You may need administrative privileges for this).
+
+== Usage
+
+XForge itself is released with XForge. so check out XForge'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.
+
+If you're writing an application that interacts with XForge, check out the RDoc API. 
+
+---
+
+== Credits
+
+[<b>Aslak Hellesoy</b>] Maintainer of this project.
+
+[<b>David Heinemeier Hansson</b>] For the HTTP POST code and the idea to parse ids from project pages.
+
+[<b>Jim Weirich</b>] For Rake, making XForge easier to use from Ruby build scripts.
+
+== Support
+
+The XForge homepage is http://xforge.rubyforge.org.  You can find the XForge
+RubyForge page at http://rubyforge.org/projects/xforge.
+
+Feel free to submit patches, bug reports or feature requests via XForge's issue tracker on RubyForge.
+
+For other information, feel free to ask on the ruby-talk mailing list
+(which is mirrored to comp.lang.ruby) or contact
+aslak hellesoy gmail com.
+
+== License
+
+XForge is available under an MIT-style license.
+
+:include: MIT-LICENSE

data/Rakefile

@@ -0,0 +1,166 @@
+# 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.1"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  'lib/**/*.rb', 
+  'doc/**/*'
+]
+
+task :default => [:gem]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['**/*_test.rb']
+  t.verbose = true
+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
+task :gem => [:test]
+
+# Support Tasks ------------------------------------------------------
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+        count += 1
+        if line =~ pattern
+          puts "#{fn}:#{count}:#{line}"
+        end
+      end
+    end
+  end
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /#.*(FIXME|TODO|TBD|DEPRECATED)/
+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(PKG_NAME, 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

data/TODO

@@ -0,0 +1,9 @@
+= XForge Project -- To Do List
+
+Send suggestions for this list to mailto:aslak.hellesoy@gmail.org.
+
+=== To Do
+* Retrieve SCM info as RSCM objects
+* Retrieve tracker info
+
+(moved DONE list to CHANGES file)

data/doc/base_attrs.rdoc

@@ -0,0 +1,2 @@
+* user_name
+* password

data/lib/meta_project/project/base.rb

@@ -0,0 +1,7 @@
+module MetaProject
+  module Project
+    class Base
+      attr_reader :scm, :scm_web, :tracker
+    end
+  end
+end

data/lib/meta_project/project/codehaus/codehaus_project_svn.rb

@@ -0,0 +1,26 @@
+module MetaProject
+  module Project
+    module Codehaus
+      class CodehausProjectSvn < Base
+
+        def initialize(project_id, svn_path, jira_id)
+          @scm = RSCM::Subversion.new("svn://svn.#{project_id}.codehaus.org/#{project_id}/scm/#{svn_path}", svn_path)
+          @tracker = ::MetaProject::Tracker::Jira::JiraTracker.new("http://jira.codehaus.org", jira_id)
+
+          overview  = "http://svn.#{project_id}.codehaus.org/#{svn_path}/"
+          history   = "#{overview}\#{path}"
+          raw       = "#{history}?rev=\#{revision}"
+          html       = "#{raw}&view=markup"
+          # http://svn.picocontainer.codehaus.org/java/picocontainer/trunk/container/project.xml?r1=2220&r2=2234&p1=java/picocontainer/trunk/container/project.xml&p2=java/picocontainer/trunk/container/project.xml
+          diff      = "#{history}?r1=\#{previous_revision}&r2=\#{revision}&p1=#{svn_path}/\#{path}&p2=#{svn_path}/\#{path}"
+          @scm_web = ScmWeb.new(overview, history, raw, html, diff)
+        end
+
+        def home_page
+          "http://#{@project_id}.codehaus.org/"
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/project/codehaus.rb

@@ -0,0 +1 @@
+require 'meta_project/project/codehaus/codehaus_project_svn'

data/lib/meta_project/project/trac/trac_project.rb

@@ -0,0 +1,26 @@
+module MetaProject
+  module Project
+    module Trac
+      class TracProject < Base
+
+        def initialize(trac_base_url, svn_root_url, svn_path)
+          @trac_base_url = trac_base_url
+          @scm = RSCM::Subversion.new("#{svn_root_url}#{svn_path}", svn_path)
+          @tracker = ::MetaProject::Tracker::Trac::TracTracker.new(trac_base_url)
+
+          overview  = "#{trac_base_url}/browser/#{svn_path}/"
+          history   = "#{trac_base_url}/log/#{svn_path}/\#{path}"
+          html      = "#{trac_base_url}/file/#{svn_path}/\#{path}?rev=\#{revision}"
+          raw       = "#{html}&format=txt"
+          diff      = "#{trac_base_url}/changeset/\#{revision}"
+          @scm_web = ScmWeb.new(overview, history, raw, html, diff)
+        end
+        
+        def home_page
+          "#{@trac_base_url}/wiki"
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/project/trac.rb

@@ -0,0 +1 @@
+require 'meta_project/project/trac/trac_project'

data/lib/meta_project/project/xforge/ruby_forge.rb

@@ -0,0 +1,46 @@
+require 'meta_project/tracker/xforge'
+
+module MetaProject
+  module Project
+    module XForge
+      class RubyForge < XForgeBase
+
+        def initialize(unix_name, cvs_mod=nil)
+          super("rubyforge.org", unix_name, cvs_mod)
+        end
+
+        def tracker_class
+          ::MetaProject::Tracker::XForge::RubyForgeTracker
+        end
+
+      protected
+
+        def create_cvs(unix_name, mod)
+          RSCM::Cvs.new(":pserver:anonymous@rubyforge.org:/var/cvs/#{unix_name}", mod)
+        end
+
+        def create_view_cvs(unix_name, mod)
+          view_cvs = "http://rubyforge.org/cgi-bin/viewcvs.cgi/"
+          cvsroot = "?cvsroot=#{unix_name}"
+          path_cvs_root = "#{mod}/\#{path}#{cvsroot}"
+          path_cvs_root_rev = "#{path_cvs_root}&rev=\#{revision}"
+
+          overview = "#{view_cvs}#{mod}/#{cvsroot}"
+          history  = "#{view_cvs}#{path_cvs_root}"
+          raw      = "#{view_cvs}*checkout*/#{path_cvs_root_rev}"
+          html     = "#{view_cvs}#{path_cvs_root_rev}&content-type=text/vnd.viewcvs-markup"
+          diff     = "#{view_cvs}#{mod}/\#{path}.diff#{cvsroot}&r1=\#{previous_revision}&r2=\#{revision}"
+
+          ScmWeb.new(overview, history, raw, html, diff)
+        end
+        
+        # Regexp used to find projects' home page
+        def home_page_regexp
+          # This seems a little volatile
+          /<a href=\"(\w*:\/\/[^\"]*)\"><img src=\"\/themes\/osx\/images\/ic\/home/
+        end        
+
+      end
+    end
+  end
+end