xforge 0.3.5 → 0.4.0

data/CHANGES

@@ -1,5 +1,39 @@
 = XForge Changelog
 
+== 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.

data/Rakefile

@@ -7,7 +7,7 @@
 # MIT-LICENSE for details.
 
 $:.unshift('lib')
-require 'xforge'
+require 'meta_project'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'rake/contrib/xforge'
@@ -24,7 +24,7 @@ require 'rake/rdoctask'
 #
 # REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
 PKG_NAME = "xforge"
-PKG_VERSION = "0.3.5"
+PKG_VERSION = "0.4.0"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',
@@ -114,7 +114,7 @@ end
 
 desc "Look for TODO and FIXME tags in the code"
 task :todo do
-  egrep /#.*(FIXME|TODO|TBD)/
+  egrep /#.*(FIXME|TODO|TBD|DEPRECATED)/
 end
 
 task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news, :tag]
@@ -135,7 +135,7 @@ task :release_files => [:gem] do
     "pkg/#{PKG_FILE_NAME}.gem"
   ]
 
-  Rake::XForge::Release.new(PKG_NAME) do |release|
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.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']
@@ -151,7 +151,7 @@ task :publish_news => [:gem] do
     "pkg/#{PKG_FILE_NAME}.gem"
   ]
 
-  Rake::XForge::NewsPublisher.new(PKG_NAME) do |news|
+  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |news|
     # Never hardcode user name and password in the Rakefile!
     news.user_name = ENV['RUBYFORGE_USER']
     news.password = ENV['RUBYFORGE_PASSWORD']

data/lib/meta_project.rb

@@ -0,0 +1,6 @@
+require 'meta_project/project_analyzer'
+require 'meta_project/project'
+require 'meta_project/tracker'
+require 'meta_project/scm_web'
+require 'meta_project/version_parser'
+require 'rake/contrib/xforge'

data/lib/meta_project/project.rb

@@ -0,0 +1,4 @@
+require 'meta_project/project/base'
+require 'meta_project/project/xforge'
+require 'meta_project/project/trac'
+require 'meta_project/project/codehaus'

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.rb

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

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/trac.rb

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

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/xforge.rb

@@ -0,0 +1,5 @@
+require 'meta_project/project/xforge/xforge_base'
+require 'meta_project/project/xforge/session'
+require 'meta_project/project/xforge/xfile'
+require 'meta_project/project/xforge/ruby_forge'
+require 'meta_project/project/xforge/source_forge'

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

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

@@ -0,0 +1,162 @@
+require 'net/http'
+require 'open-uri'
+
+module MetaProject
+  module Project
+    module XForge
+
+      # A Session object allows authenticated interaction with a Project, such as releasing files.
+      #
+      # A Session object can be obtained via Project.login
+      #
+      class Session
+
+        # Simple enumeration of processors. Used from Session.release
+        class Processor
+          I386           = 1000
+          IA64           = 6000
+          ALPHA          = 7000
+          ANY            = 8000
+          PPC            = 2000
+          MIPS           = 3000
+          SPARC          = 4000
+          ULTRA_SPARC    = 5000
+          OTHER_PLATFORM = 9999
+        end
+
+        BOUNDARY = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor"
+
+        def initialize(host, project, cookie) # :nodoc:
+          @host = host
+          @project = project
+          @headers = { "Cookie" => cookie }
+        end
+
+        # The package_id of our project
+        def package_id
+          unless(@package_id)
+            release_uri = "http://#{@host}/frs/admin/?group_id=#{@project.group_id}"
+            release_data = open(release_uri, @headers) { |data| data.read }
+            @package_id = release_data[/[?&]package_id=(\d+)/, 1]
+            raise "Couldn't get package_id" unless @package_id
+          end
+          @package_id
+        end
+
+        # Creates a new release containing the files specified by +filenames+ (Array) and named +release_name+.
+        # Optional parameters are +processor+ (which should be one of the Processor constants), +release_notes+,
+        # +release_changes+ and +preformatted+ which will appear on the releas page of the associated project.
+        #
+        def release(release_name, filenames, release_notes="", release_changes="", preformatted=true, processor=Processor::ANY)
+          release_date = Time.now.strftime("%Y-%m-%d %H:%M")
+          release_id = nil
+
+          puts "About to release '#{release_name}'"
+          puts "Files:"
+          puts "  " + filenames.join("\n  ")
+          puts "\nRelease Notes:\n"
+          puts release_notes
+          puts "\nRelease Changes:\n"
+          puts release_changes
+          puts "\nRelease Settings:\n"
+          puts "Preformatted: #{preformatted}"
+          puts "Processor: #{processor}"
+          puts "\nStarting release..."
+
+          xfiles = filenames.collect{|filename| XFile.new(filename)}      
+          xfiles.each_with_index do |xfile, i|
+            first_file = i==0
+            puts "Releasing #{xfile.basename}..."
+
+            release_response = Net::HTTP.start(@host, 80) do |http|
+              query_hash = if first_file then
+                {
+                  "group_id" => @project.group_id,
+                  "package_id" => package_id,
+                  "type_id" => xfile.bin_type_id,
+                  "processor_id" => processor,
+
+                  "release_name" => release_name,
+                  "release_date" => release_date,
+                  "release_notes" => release_notes,
+                  "release_changes" => release_changes,
+                  "preformatted" => preformatted ? "1" : "0",
+                  "submit" => "1"
+                }
+              else
+                {
+                  "group_id" => @project.group_id,
+                  "package_id" => package_id,
+                  "type_id" => xfile.bin_type_id,
+                  "processor_id" => processor,
+
+                  "step2" => "1",
+                  "release_id" => release_id,
+                  "submit" => "Add This File"
+                }
+              end
+
+              query = query(query_hash)
+
+              data = [
+                "--" + BOUNDARY,
+                "Content-Disposition: form-data; name=\"userfile\"; filename=\"#{xfile.basename}\"",
+                "Content-Type: application/octet-stream",
+                "Content-Transfer-Encoding: binary",
+                "", xfile.data, ""
+                ].join("\x0D\x0A")
+
+              headers = @headers.merge(
+                "Content-Type" => "multipart/form-data; boundary=#{BOUNDARY}"
+              )
+
+              target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php"
+              http.post(target + query, data, headers)
+            end
+
+            if first_file then
+              release_id = release_response.body[/release_id=(\d+)/, 1]
+              raise("Couldn't get release id") unless release_id
+            end
+          end
+          puts "Done!"
+        end
+    
+        def publish_news(subject, details)
+          puts "About to publish news"
+          puts "Subject: '#{subject}'"
+          puts "Details:"
+          puts details
+          puts ""
+      
+          release_response = Net::HTTP.start(@host.name, 80) do |http|
+            query_hash = {
+              "group_id" => @project.group_id,
+              "package_id" => package_id,
+              "post_changes" => "y",
+              "summary" => subject,
+              "details" => details
+            }
+      
+            target = "/news/submit.php"
+            headers = @headers.merge(
+              "Content-Type" => "multipart/form-data"
+            )
+            http.post(target + query(query_hash), "", headers)
+
+          end
+          puts "Done!"
+        end
+
+      private
+  
+        def query(query_hash)
+          "?" + query_hash.map do |(name, value)|
+            [name, URI.encode(value.to_s)].join("=")
+          end.join("&")
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'meta_project/tracker/xforge'
+
+module MetaProject
+  module Project
+    module XForge
+      class SourceForge < XForgeBase
+
+        def initialize(unix_name, cvs_mod=nil)
+          super("sourceforge.net", unix_name, cvs_mod)
+        end
+
+        def tracker_class
+          ::MetaProject::Tracker::XForge::SourceForgeTracker
+        end
+
+      protected
+
+        def create_cvs(unix_name, mod)
+          RSCM::Cvs.new(":pserver:anonymous@cvs.sourceforge.net:/cvsroot/#{unix_name}", mod)
+        end
+
+        def create_view_cvs(unix_name, mod)
+          view_cvs = "http://cvs.sourceforge.net/viewcvs.py/"
+          unix_name_mod = "#{unix_name}/#{mod}"
+          project_path = "#{unix_name_mod}/\#{path}"
+          rev = "rev=\#{revision}"
+
+          overview = "#{view_cvs}#{unix_name_mod}/"
+          history  = "#{view_cvs}#{project_path}"
+          raw      = "#{view_cvs}*checkout*/#{project_path}?#{rev}"
+          html     = "#{history}?#{rev}&view=markup"
+          diff     = "#{history}?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*:\/\/[^\"]*)\">&nbsp;Project Home Page<\/A>/
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module MetaProject
+  module Project
+    module XForge
+
+      class XFile # :nodoc:
+
+        # extension => [mime_type, rubyforge_bin_type_id, rubyforge_src_type_id]
+        FILE_TYPES = {
+          ".deb"  => ["application/octet-stream", 1000],
+
+          # all of these can be source or binary
+          ".rpm"  => ["application/octet-stream", 2000, 5100],
+          ".zip"  => ["application/octet-stream", 3000, 5000],
+          ".bz2"  => ["application/octet-stream", 3100, 5010],
+          ".gz"   => ["application/octet-stream", 3110, 5020],
+          ".jpg"  => ["application/octet-stream", 8000],
+          ".jpeg" => ["application/octet-stream", 8000],
+          ".txt"  => ["text/plain", 8100, 8100],
+          ".html" => ["text/html", 8200, 8200],
+          ".pdf"  => ["application/octet-stream", 8300],
+          ".ebuild"  => ["application/octet-stream", 1300],
+          ".exe"  => ["application/octet-stream", 1100],
+          ".dmg"  => ["application/octet-stream", 1200],
+          ".gem"  => ["application/octet-stream", 1400],
+          ".sig"  => ["application/octet-stream", 8150]
+        }
+        FILE_TYPES.default = ["application/octet-stream", 9999, 5900] # default to "other", "other source"
+
+        attr_reader :basename, :ext, :content_type, :bin_type_id, :src_type_id
+
+        def initialize(filename)
+          @filename = filename
+          @basename = File.basename(filename)
+          @ext = File.extname(filename)
+          @content_type = FILE_TYPES[@ext][0]
+          @bin_type_id = FILE_TYPES[@ext][1]
+        end
+
+        def data
+          File.open(@filename, "rb") { |file| file.read }
+        end
+      end
+    end
+  end
+end