xforge 0.3.5 → 0.4.0

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

@@ -0,0 +1,76 @@
+require 'net/http'
+require 'net/https'
+require 'open-uri'
+
+module MetaProject
+  module Project
+    module XForge
+      class XForgeBase < Base
+
+        def initialize(host, unix_name, cvs_mod)
+          @host = host
+          @unix_name = unix_name
+
+          @tracker = tracker_class.new(group_id_uri("tracker"), self)
+
+          unless(cvs_mod.nil?)
+            @scm = create_cvs(unix_name, cvs_mod)
+            @scm_web = create_view_cvs(unix_name, cvs_mod)
+          end
+        end
+
+        def to_yaml_properties
+          ["@host", "@unix_name"]
+        end
+
+        # Logs in and returns a Session
+        def login(user_name, password)
+          http = Net::HTTP.new(@host, 80)
+
+          login_response = http.start do |http|
+            data = [
+              "login=1",
+              "form_loginname=#{user_name}",
+              "form_pw=#{password}"
+            ].join("&")
+            http.post("/account/login.php", data)
+          end
+
+          cookie = login_response["set-cookie"]
+          raise "Login failed" unless cookie
+          Session.new(@host, self, cookie)
+        end
+
+        # The group_id of this project
+        def group_id
+          unless(@group_id)
+            regexp = /stats\/[?&]group_id=(\d+)/
+            html = open(project_uri) { |data| data.read }
+            @group_id = html[regexp, 1]
+            raise "Couldn't get group_id" unless @group_id
+          end
+          @group_id
+        end
+
+        def project_uri
+          "http://#{@host}/projects/#{@unix_name}/"
+        end
+
+        def group_id_uri(path, postfix="")
+          "http://#{@host}/#{path}/?group_id=#{group_id}#{postfix}"
+        end
+
+        # The home page of this project
+        def home_page
+          unless(@home_page)
+            html = open(project_uri) { |data| data.read }
+            @home_page = html[home_page_regexp, 1]
+            raise "Couldn't get home_page" unless @home_page
+          end
+          @home_page
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/project_analyzer.rb

@@ -0,0 +1,36 @@
+module MetaProject
+  module ProjectAnalyzer
+    # Creates a project from an scm web url. The project has a +tracker+, +scm+ and +scm_web+.
+    def project_from_scm_web(url, options=nil)
+      # RubyForge
+      if(url =~ /http:\/\/rubyforge.org\/cgi-bin\/viewcvs.cgi\/(.*)[\/]?\?cvsroot=(.*)/)
+        unix_name = $2
+        mod = $1[-1..-1] == "/" ? $1[0..-2] : $1
+        return Project::XForge::RubyForge.new(unix_name, mod)
+      end
+
+      # SourceForge
+      if(url =~ /http:\/\/cvs.sourceforge.net\/viewcvs.py\/([^\/]*)\/(.*)/)
+        unix_name = $1
+        mod = $2[-1..-1] == "/" ? $2[0..-2] : $2
+        return Project::XForge::SourceForge.new(unix_name, mod)
+      end
+
+      # Trac
+      if(url =~ /(http:\/\/.*)\/browser\/(.*)/)
+        trac_base_url = $1
+        svn_path = $2[-1..-1] == "/" ? $2[0..-2] : $2
+        return Project::Trac::TracProject.new(trac_base_url, options[:svn_root_url], svn_path)
+      end
+      
+      # Codehaus SVN
+      if(url =~ /http:\/\/svn.(.*).codehaus.org\/(.*)/)
+        svn_id = $1
+        svn_path = $2[-1..-1] == "/" ? $2[0..-2] : $2
+        return Project::Codehaus::CodehausProjectSvn.new(svn_id, svn_path, options[:jira_id])
+      end
+
+    end
+    
+  end
+end

data/lib/meta_project/scm_web.rb

@@ -0,0 +1,53 @@
+module MetaProject
+  
+  # An ScmWeb instance is capable of generating URLs to various files and diffs
+  # in an online scm web interface.
+  class ScmWeb
+
+    # The variables to use in +uri_specs+ are:
+    #
+    # * path
+    # * revision
+    # * previous_revision
+    #
+    def initialize(overview_spec, history_spec, raw_spec, html_spec, diff_spec)
+      @overview_spec, @history_spec, @raw_spec, @html_spec, @diff_spec = overview_spec, history_spec, raw_spec, html_spec, diff_spec
+    end
+
+    def overview
+      file_uri(nil, nil, @overview_spec)
+    end
+
+    def history(path)
+      file_uri(path, nil, @history_spec)
+    end
+
+    def raw(path, revision)
+      file_uri(path, revision, @raw_spec)
+    end
+
+    def html(path, revision)
+      file_uri(path, revision, @html_spec)
+    end
+
+    def diff(path, revision, previous_revision)
+      file_uri(path, revision, @diff_spec, previous_revision)
+    end
+
+  private
+
+    # Returns the file URI for +path+. Valid options are:
+    #
+    # * :type => ["overview"|"html"|"diff"|"raw"]
+    # * :revision
+    # * :previous_revision
+    def file_uri(path="", revision=nil, spec=@overview_spec, previous_revision=nil)
+      begin
+        eval("\"#{spec}\"", binding)
+      rescue NameError
+        raise "Couldn't evaluate '#{spec}'"
+      end
+    end
+
+  end
+end

data/lib/meta_project/tracker.rb

@@ -0,0 +1,6 @@
+require 'meta_project/tracker/base'
+require 'meta_project/tracker/digit_issues'
+require 'meta_project/tracker/issue'
+require 'meta_project/tracker/trac'
+require 'meta_project/tracker/xforge'
+require 'meta_project/tracker/jira'

data/lib/meta_project/tracker/base.rb

@@ -0,0 +1,18 @@
+module MetaProject
+  module Tracker
+
+    # Tracker objects are responsible for interacting with issue trackers (bug trackers).
+    # They know how to recognise issue identifiers in strings (typically from SCM commit
+    # messages) and turn these into HTML links that point to the associated issue on an
+    # issue tracker installation running somewhere else.
+    class Base
+      def self.classes
+        [
+          ::Tracker::Jira::JiraProject,
+          ::Tracker::XForge::RubyForgeProject,
+          ::Tracker::Trac::TracProject
+        ]
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/digit_issues.rb

@@ -0,0 +1,24 @@
+module MetaProject
+  module Tracker
+    # This module should be included by trackers that follow a digit-based issue scheme
+    module DigitIssues
+      def identifier_regexp
+        /#(\d+)/
+      end
+
+      def identifier_examples
+        ["#1926", "#1446"]
+      end
+
+      # TODO: find a way to extract just the issue summaries so they can be stored in dc as an array
+      # embedded in the revision object. that way we don't alter the original commit message
+      def markup(text)
+        text.gsub(identifier_regexp) do |match|
+          issue_identifier = $1
+          issue = issue(issue_identifier)
+          issue ? "<a href=\"#{issue.uri}\">#{issue.summary}</a>" : "\##{issue_identifier}"
+        end
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/issue.rb

@@ -0,0 +1,11 @@
+module MetaProject
+  module Tracker
+    class Issue
+      attr_reader :uri, :summary
+    
+      def initialize(uri, summary)
+        @uri, @summary = uri, summary
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/jira.rb

@@ -0,0 +1 @@
+require 'meta_project/tracker/jira/jira_tracker'

data/lib/meta_project/tracker/jira/jira_tracker.rb

@@ -0,0 +1,68 @@
+require 'xmlrpc/client'
+
+module MetaProject
+  module Tracker
+    module Jira
+      class JiraTracker
+        JIRA_API = "jira1"
+      
+        def initialize(rooturl=nil, identifier=nil, username=nil, password=nil)
+          @rooturl, @identifier, @username, @password = rooturl, identifier, username, password
+        end
+
+        def identifier_regexp
+          /([A-Z]+-[\d]+)/
+        end
+
+        def identifier_examples
+          ["DC-420", "PICO-12"]
+        end
+
+        def overview
+          "#{@rooturl}/browse/#{@identifier}"
+        end
+
+        def issue(issue_identifier)
+          session = login
+          begin
+            issue = session.getIssue(issue_identifier)
+            Issue.new("#{@rooturl}/browse/#{issue_identifier}", issue["summary"])
+          rescue XMLRPC::FaultException
+            # Probably bad issue number
+            nil
+          end
+        end
+
+        def markup(text)
+          text.gsub(identifier_regexp) do |match|
+            issue_identifier = $1
+            issue = issue(issue_identifier)
+            issue ? "<a href=\"#{issue.uri}\">#{issue_identifier}: #{issue.summary}</a>" : issue_identifier
+          end
+        end
+
+      private
+      
+        def login
+          client = XMLRPC::Client.new2("#{@rooturl}/rpc/xmlrpc")
+          token = client.call("#{JIRA_API}.login", @username, @password)
+          Session.new(client, token)
+        end
+      
+        # This wrapper around XMLRPC::Client that allows simpler method calls
+        # via method_missing and doesn't require to manage the token
+        class Session
+          def initialize(client, token)
+            @client, @token = client, token
+          end
+
+          def method_missing(sym, args, &block)
+            token_args = [@token] << args
+            xmlrpc_method = "#{JIRA_API}.#{sym.to_s}"
+            @client.call(xmlrpc_method, *token_args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/trac.rb

@@ -0,0 +1 @@
+require 'meta_project/tracker/trac/trac_tracker'

data/lib/meta_project/tracker/trac/trac_tracker.rb

@@ -0,0 +1,29 @@
+module MetaProject
+  module Tracker
+    module Trac
+      class TracTracker < ::MetaProject::Tracker::Base
+        include ::MetaProject::Tracker::DigitIssues
+
+        def initialize(trac_base_url)
+          @trac_base_url = trac_base_url
+        end
+        
+        def overview
+          "#{@trac_base_url}/report"
+        end
+
+        def issue(issue_identifier)
+          issue_uri = "#{@trac_base_url}/ticket/#{issue_identifier}"
+          begin
+            html = open(issue_uri) { |data| data.read }
+            summary = html[/Ticket ##{issue_identifier}\s*<\/h1>\s*<h2>([^<]*)<\/h2>/n, 1]
+            ::MetaProject::Tracker::Issue.new(issue_uri, summary)
+          rescue OpenURI::HTTPError
+            nil
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/xforge.rb

@@ -0,0 +1,3 @@
+require 'meta_project/tracker/xforge/xforge_tracker'
+require 'meta_project/tracker/xforge/ruby_forge_tracker'
+require 'meta_project/tracker/xforge/source_forge_tracker'

data/lib/meta_project/tracker/xforge/ruby_forge_tracker.rb

@@ -0,0 +1,17 @@
+module MetaProject
+  module Tracker
+    module XForge
+      class RubyForgeTracker < XForgeTracker
+
+        def subtracker_regexp
+          /\/tracker\/\?atid=(\d+)&group_id=\d*&func=browse/
+        end
+
+        def issue_regexp(identifier)
+          /<a href=\"\/tracker\/index.php\?func=detail&aid=#{identifier}&group_id=\d+&atid=\d+\">([^<]*)<\/a>/
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/xforge/source_forge_tracker.rb

@@ -0,0 +1,17 @@
+module MetaProject
+  module Tracker
+    module XForge
+      class SourceForgeTracker < XForgeTracker
+        
+        def subtracker_regexp
+          /\/tracker\/\?atid=(\d+)&amp;group_id=\d*&amp;func=browse/
+        end
+
+        def issue_regexp(identifier)
+          /<a href=\"\/tracker\/index.php\?func=detail&amp;aid=#{identifier}&amp;group_id=\d+&amp;atid=\d+\">([^<]*)<\/a>/
+        end
+
+      end
+    end
+  end
+end

data/lib/meta_project/tracker/xforge/xforge_tracker.rb

@@ -0,0 +1,83 @@
+require 'meta_project/tracker/base'
+require 'meta_project/tracker/digit_issues'
+require 'meta_project/tracker/issue'
+
+module MetaProject
+  module Tracker
+    module XForge
+      class XForgeTracker < Base
+        include ::MetaProject::Tracker::DigitIssues
+
+        attr_accessor :overview, :project
+
+        # TODO: don't pass in project!! pass in hostname and id!
+        def initialize(overview, project)
+          @overview, @project = overview, project
+        end
+
+        # Finds an Issue by +identifier+
+        def issue(identifier)
+          sub_trackers = atids.collect {|atid| SubTracker.new(self, atid)}
+          sub_trackers.each do |sub_tracker|
+            issue = sub_tracker.issue(identifier)
+            return issue unless issue.nil?
+          end
+          nil
+        end
+
+        def markup(text)
+          text.gsub(identifier_regexp) do |match|
+            issue_identifier = $1
+            issue = issue(issue_identifier)
+            issue ? "<a href=\"#{issue.uri}\">\##{issue_identifier}: #{issue.summary}</a>" : "\##{issue_identifier}"
+          end
+        end
+
+        class SubTracker
+          attr_reader :uri
+
+          def initialize(tracker, atid)
+            @tracker = tracker
+            @atid = atid
+            # FIXME: This will only show open items.
+            @uri = "#{tracker.overview}&atid=#{atid}&func=browse"
+          end
+
+          def issue(identifier)
+            html = open(uri) { |data| data.read }
+
+            regexp = @tracker.issue_regexp(identifier)
+            if(html =~ regexp)
+              issue_uri = @tracker.project.group_id_uri("tracker/index.php", "&atid=#{@atid}&func=detail&aid=#{identifier}")
+              return Issue.new(issue_uri, $1)
+            end
+            nil
+          end
+        end
+
+      private
+
+        # The ids of the subtrackers
+        def atids
+          html = open(overview) { |data| data.read }
+
+          # TODO: there has to be a better way to extract the atids from the HTML!
+          atids = []
+          offset = 0
+          look_for_atid = true
+          while(look_for_atid)
+            match_data = subtracker_regexp.match(html[offset..-1])
+            if(match_data)
+              offset += match_data.begin(1)
+              atids << match_data[1]
+            else
+              look_for_atid = false
+            end
+          end
+          atids
+        end
+
+      end
+    end
+  end
+end