xforge 0.2.1 → 0.3.1

data/CHANGES

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

data/README

@@ -30,7 +30,11 @@ Download and install XForge with the following.
 
 == Usage
 
-See XForge, Rake::XForge::Release and Rake::XForge::NewsPublisher.
+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. 
 
 ---
 

data/Rakefile

@@ -24,7 +24,7 @@ require 'rake/rdoctask'
 #
 # REMEMBER TO KEEP PKG_VERSION IN SYNC WITH CHANGELOG
 PKG_NAME = "xforge"
-PKG_VERSION = "0.2.1"
+PKG_VERSION = "0.3.1"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',
@@ -48,7 +48,7 @@ rd = Rake::RDocTask.new("rdoc") do |rdoc|
 #  rdoc.template = 'doc/jamis.rb'
   rdoc.title    = "XForge"
   rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'TODO', 'CHANGES')
+  rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'CHANGES')
   rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
   rdoc.rdoc_files.exclude('doc/**/*_attrs.rdoc')
 end
@@ -117,7 +117,7 @@ task :todo do
   egrep /#.*(FIXME|TODO|TBD)/
 end
 
-task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news]
+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']

data/lib/scm_web/view_cvs.rb

@@ -42,6 +42,7 @@ module ScmWeb
 
       project_unix_name = project.unix_name
       revision = options[:revision]
+      previous_revision = options[:previous_revision]
       eval("\"#{uri_spec}\"", binding)
     end
   end

data/lib/tracker/jira.rb

@@ -0,0 +1,2 @@
+require 'tracker/jira/host'
+require 'tracker/jira/project'

data/lib/tracker/jira/host.rb

@@ -0,0 +1,40 @@
+require 'xmlrpc/client'
+
+module Tracker
+  module Jira
+    class Host
+      JIRA_API = "jira1"
+      
+      attr_reader :uri
+      
+      def initialize(uri, username, password)
+        @uri, @username, @password = uri, username, password
+      end
+
+      def project(identifier)
+        Project.new(self, identifier)
+      end
+      
+      def login
+        client = XMLRPC::Client.new2("#{uri}/rpc/xmlrpc")
+        token = client.call("#{JIRA_API}.login", @username, @password)
+        Session.new(client, token)
+      end
+      
+    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 = "#{Host::JIRA_API}.#{sym.to_s}"
+        @client.call(xmlrpc_method, *token_args)
+      end
+    end
+  end
+end

data/lib/tracker/jira/project.rb

@@ -0,0 +1,41 @@
+module Tracker
+  module Jira
+    class Project
+      def initialize(host, identifier)
+        @host, @identifier = host, identifier
+      end
+
+      def identifier_regexp
+        /([A-Z]+-[\d]+)/
+      end
+
+      def identifier_examples
+        ["DC-420", "PICO-12"]
+      end
+
+      def uri
+        "#{@host.uri}/browse/#{@identifier}"
+      end
+      
+      def issue(issue_identifier)
+        session = @host.login
+        begin
+          issue = session.getIssue(issue_identifier)
+          Issue.new("#{@host.uri}/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.summary}</a>" : issue_identifier
+        end
+      end
+
+    end
+  end
+end

data/lib/tracker/trac.rb

@@ -0,0 +1 @@
+require 'tracker/trac/project'

data/lib/tracker/trac/project.rb

@@ -0,0 +1,37 @@
+module Tracker
+  module Trac
+    class Project
+      def initialize(uri)
+        @uri = uri
+      end
+      
+      def identifier_regexp
+        /#(\d+)/
+      end
+
+      def identifier_examples
+        ["#1926", "#1446"]
+      end
+      
+      def issue(issue_identifier)
+        issue_uri = "#{@uri}/ticket/#{issue_identifier}"
+        begin
+          html = open(issue_uri) { |data| data.read }
+          summary = html[/Ticket ##{issue_identifier}\s*<\/h1>\s*<h2>([^<]*)<\/h2>/n, 1]
+          Issue.new(issue_uri, summary)
+        rescue OpenURI::HTTPError
+          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.summary}</a>" : "\##{issue_identifier}"
+        end
+      end
+
+    end
+  end
+end

data/lib/tracker/xforge.rb

@@ -0,0 +1,2 @@
+require 'tracker/xforge/base'
+require 'tracker/xforge/rubyforge'

data/lib/tracker/xforge/base.rb

@@ -0,0 +1,84 @@
+module Tracker
+  module XForge
+    # TODO: rename to Project
+    class Base
+      attr_reader :uri, :project
+
+      def identifier_regexp
+        /#(\d+)/
+      end
+      
+      # Examples of what will be recognised as issue identifiers in #markup
+      def identifier_examples
+        ["#1462", "#872"]
+      end
+
+      def initialize(uri, project)
+        @uri, @project = uri, 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.summary}</a>" : "\##{issue_identifier}"
+        end
+      end
+
+      class SubTracker
+        attr_reader :uri
+
+        def initialize(rubyforge, atid)
+          @rubyforge = rubyforge
+          @atid = atid
+          # FIXME: This will only show open items.
+          @uri = "#{rubyforge.uri}&atid=#{atid}&func=browse"
+        end
+
+        def issue(identifier)
+          html = open(uri) { |data| data.read }
+
+          regexp = /<a href=\"\/tracker\/index.php\?func=detail&aid=#{identifier}&group_id=\d+&atid=\d+\">(.*)<\/a>/
+          if(html =~ regexp)
+            issue_uri = @rubyforge.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(uri) { |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 = /\/tracker\/\?atid=(\d+)&group_id=\d*&func=browse/.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

data/lib/tracker/xforge/rubyforge.rb

@@ -0,0 +1,6 @@
+module Tracker
+  module XForge
+    class RubyForge < Base
+    end
+  end
+end

data/lib/xforge.rb

@@ -6,6 +6,8 @@ require 'xforge/project'
 require 'xforge/session'
 require 'xforge/xfile'
 require 'scm_web/view_cvs'
-require 'tracker/rubyforge'
 require 'tracker/issue'
+require 'tracker/xforge'
+require 'tracker/jira'
+require 'tracker/trac'
 require 'rake/contrib/xforge'

data/lib/xforge/project.rb

@@ -76,7 +76,7 @@ module XForge
     end
     
     def tracker
-      @tracker ||= Tracker::RubyForge.new(group_id_uri("tracker"), self)
+      @tracker ||= @host.tracker(self)
     end
   end
 

data/lib/xforge/rubyforge.rb

@@ -1,12 +1,14 @@
 module XForge
   class RubyForge < Host
     VIEW_CVS = "http://rubyforge.org/cgi-bin/viewcvs.cgi/"
-    PATH_CVSROOT = "\#{path}?cvsroot=\#{project_unix_name}"
+    CVSROOT = "?cvsroot=\#{project_unix_name}"
+    PATH_CVSROOT = "\#{path}#{CVSROOT}"
     PATH_CVSROOT_REV = "#{PATH_CVSROOT}&rev=\#{revision}"
     
     OVERVIEW = "#{VIEW_CVS}#{PATH_CVSROOT}"
-    RAW = "#{VIEW_CVS}*checkout*/#{PATH_CVSROOT_REV}"
-    HTML = "#{VIEW_CVS}#{PATH_CVSROOT_REV}&content-type=text/vnd.viewcvs-markup"
+    RAW      = "#{VIEW_CVS}*checkout*/#{PATH_CVSROOT_REV}"
+    HTML     = "#{VIEW_CVS}#{PATH_CVSROOT_REV}&content-type=text/vnd.viewcvs-markup"
+    DIFF     = "#{VIEW_CVS}\#{path}.diff#{CVSROOT}&r1=\#{previous_revision}&r2=\#{revision}"
     
     def initialize
       super('rubyforge.org')
@@ -26,7 +28,7 @@ module XForge
 
     def scm_web(project)
       module_regexp = /href=\"(\w+)\/\?cvsroot=#{project.unix_name}/
-      ::ScmWeb::ViewCvs.new({:overview => OVERVIEW, :raw => RAW, :html => HTML}, project, module_regexp)
+      ::ScmWeb::ViewCvs.new({:overview => OVERVIEW, :raw => RAW, :html => HTML, :diff => DIFF}, project, module_regexp)
     end
 
     # Regexp used to find projects' home page
@@ -35,5 +37,8 @@ module XForge
       /<a href=\"(\w*:\/\/[^\"]*)\"><img src=\"\/themes\/osx\/images\/ic\/home/
     end
 
+    def tracker(project)
+      Tracker::XForge::RubyForge.new(project.group_id_uri("tracker"), project)
+    end
   end
 end

data/lib/xforge/sourceforge.rb

@@ -5,8 +5,9 @@ module XForge
     REV = "rev=\#{revision}"
 
     OVERVIEW = "#{VIEW_CVS}#{PROJECT_PATH}"
-    RAW = "#{VIEW_CVS}*checkout*/#{PROJECT_PATH}?#{REV}"
-    HTML = "#{OVERVIEW}?#{REV}&view=markup"
+    RAW      = "#{VIEW_CVS}*checkout*/#{PROJECT_PATH}?#{REV}"
+    HTML     = "#{OVERVIEW}?#{REV}&view=markup"
+    DIFF     = "#{OVERVIEW}?r1=\#{previous_revision}&r2=\#{revision}"
 
     def initialize
       super("sourceforge.net")
@@ -26,7 +27,7 @@ module XForge
 
     def scm_web(project)
       module_regexp = /viewcvs\.py\/#{project.unix_name}\/(\w+)\//
-      ::ScmWeb::ViewCvs.new({:overview => OVERVIEW, :raw => RAW, :html => HTML}, project, module_regexp)
+      ::ScmWeb::ViewCvs.new({:overview => OVERVIEW, :raw => RAW, :html => HTML, :diff => DIFF}, project, module_regexp)
     end
 
     # Regexp used to find projects' home page

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: xforge
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2005-08-14 00:00:00 -04:00
+  version: 0.3.1
+date: 2005-08-15 00:00:00 -04:00
 summary: Ruby based make-like utility.
 require_paths: 
   - lib
@@ -42,7 +42,14 @@ files:
   - lib/rake/contrib/xforge/release.rb
   - lib/scm_web/view_cvs.rb
   - lib/tracker/issue.rb
-  - lib/tracker/rubyforge.rb
+  - lib/tracker/jira.rb
+  - lib/tracker/trac.rb
+  - lib/tracker/xforge.rb
+  - lib/tracker/jira/host.rb
+  - lib/tracker/jira/project.rb
+  - lib/tracker/trac/project.rb
+  - lib/tracker/xforge/base.rb
+  - lib/tracker/xforge/rubyforge.rb
   - lib/xforge/host.rb
   - lib/xforge/project.rb
   - lib/xforge/rubyforge.rb
@@ -61,7 +68,6 @@ rdoc_options:
 extra_rdoc_files: 
   - README
   - MIT-LICENSE
-  - TODO
   - CHANGES
 executables: []
 extensions: []

data/lib/tracker/rubyforge.rb

@@ -1,63 +0,0 @@
-module Tracker
-  class RubyForge
-    attr_reader :uri, :project
-        
-    def initialize(uri, project)
-      @uri, @project = uri, project
-    end
-    
-    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
-    
-    class SubTracker
-      attr_reader :uri
-      
-      def initialize(rubyforge, atid)
-        @rubyforge = rubyforge
-        @atid = atid
-        # FIXME: This will only show open items.
-        @uri = "#{rubyforge.uri}&atid=#{atid}&func=browse"
-      end
-      
-      def issue(identifier)
-        html = open(uri) { |data| data.read }
-
-        regexp = /<a href=\"\/tracker\/index.php\?func=detail&aid=#{identifier}&group_id=\d+&atid=\d+\">(.*)<\/a>/
-        if(html =~ regexp)
-          issue_uri = @rubyforge.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(uri) { |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 = /\/tracker\/\?atid=(\d+)&group_id=\d*&func=browse/.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